Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

A ruby API wrapper for This Is My Jam

tree: 249104b2bf

Fetching latest commit…

Cannot retrieve the latest commit at this time

README.md

Jammed Build History Dependency Status

A Ruby API wrapper for This Is My Jam.

Note: The API for This Is My Jam is stil in beta, so if you'd like to use it please email the Jam team at api@thisismyjam.com to get on their mailing list.

Installation

Add this line to your application's Gemfile:

gem 'jammed'

And then execute:

$ bundle

Or install it yourself as:

$ gem install jammed

Usage

Note: Right now, since the API is in beta, Jammed.new can be called without supplying an API key (it defaults to the beta key). Once individual dev keys are available this will change.

require 'jammed'

jammed = Jammed.new('987bcab01b929eb2c07877b224215c92')

pop_jams = jammed.popular_jams

iftfom_profile = jammed.profile('IFTFOM')
iftfom_likes = jammed.likes('IFTFOM', :show => :current)

iftfom = jammed.user('IFTFOM')
iftfom.profile # same as jammed.profile('IFTFOM')
iftfom.likes(:show => :current) # same as jammed.likes('IFTFOM', :show => :current)
iftfom.likes! #resets cached likes and return all of IFTFOM's like

Also, pagination is not supported at the moment. So, at most you will get the first 60 results for any API call that returns a list. Automatically handling pagination is a first priority for the next release.

Links

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Added some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request
Something went wrong with that request. Please try again.