Rhapsody Gem

A Ruby interface to the Rhapsody API.

Installation

Add this line to your application's Gemfile:

gem 'rhapsody'

And then execute:

$ bundle

Or install it yourself as:

$ gem install rhapsody

Usage

Setting up a client

A client prepares you to make calls to Rhapsody API. Here is an example code for setting up a client using implicit method.

require 'rhapsody'

options = {
  api_key: 'API_KEY',
  api_secret: 'API_SECRET',
}

client = Rhapsody::Client.new(options)

Getting an access token

Password grant

client_hash = {
  api_key: 'API_KEY',
  api_secret: 'API_SECRET',
  username: 'USERNAME',
  password: 'PASSWORD'
}

client = Rhapsody::Client.new(client_hash)
client.password_grant

client.authentication.access_token # => returns access_token
client.authentication.refresh_token
client.authentication.expires_in

OAuth 2

client_hash = {
  api_key: 'API_KEY',
  api_secret: 'API_SECRET',
  redirect_uri: 'REDIRECT_URI',
  auth_code: 'AUTH_CODE'
}

client = Rhapsody::Client.new(client_hash)
client.connect

client.authentication.access_token # => returns access_token
client.authentication.refresh_token
client.authentication.expires_in

Development

Running tests

Rhapsody gem uses RSpec and FactoryGirl.

1. Get the API key and API secret from Rhapsody Developers site.

2. Create a file called config.yml in spec directory.

3. Add the following with the correct API key and API secret

config_variables:
  API_KEY: 'API_KEY'
  API_SECRET: 'API_SECRET'
  USERNAME: 'USERNAME'
  PASSWORD: 'PASSWORD'
  REDIRECT_URI: 'REDIRECT_URI'

1. $ bundle install

2. $ rspec

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/rhapsody.

License

The gem is available as open source under the terms of the MIT License.