exchange-ruby

A ruby client for interfacing with the OpenStax Exchange API.

Include the gem in your project:

gem 'openstax_exchange'

Include the following in your script:

require 'openstax_exchange'

NOTE: After changing the client configuration, use:

OpenStax::Exchange.reset!

to ensure that the changes take effect.

Two clients are supported:

• a real client which connects to an actual Exchange server
• a fake client which implements a fake of the Exchange server

By default the real Exchange client will be used. However, the choice can be made explicitly by using the following:

OpenStax::Exchange.use_real_client
OpenStax::Exchange.use_fake_client

Regardless of which client is used, you must configure the client's knowledge of the Exchange server:

OpenStax::Exchange.configure do |config|
  config.client_platform_id     = '123'
  config.client_platform_secret = 'abc' ## do not check real secrets into version control!
  config.client_server_url      = 'http://www.example.com:3000/base/path'
  config.client_api_version     = 'v1'
end

The fake client automatically uses the OpenStax::Exchange.configure client-side settings, but you must also configure the faked client's server settings:

OpenStax::Exchange::FakeClient.configure do |config|
  config.registered_platforms   = {'123' => 'abc'}
  config.server_url             = 'http://www.example.com:3000/base/path'
  config.supported_api_versions = ['v1']
end

The following Exchange API methods are currently supported:

identifier = OpenStax::Exchange.create_identifier

response = OpenStax::Exchange.record_multiple_choice_answer(identifier, resource_uri, trial, answer)

Create a local clone of the repo, and run the following commands:

bundle install
bundle exec rake

The result should be a set of passing specs.

1. Fork it ( https://github.com/[my-github-username]/exchange-ruby/fork )
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create a new Pull Request