openstax_exchange 0.0.1 → 0.0.2

data/README.md

@@ -1,5 +1,4 @@
-exchange-ruby
-=============
+# exchange-ruby
 
 [![Gem Version](https://badge.fury.io/rb/openstax_exchange.svg)](http://badge.fury.io/rb/openstax_exchange)
 [![Build Status](https://travis-ci.org/openstax/exchange-ruby.svg?branch=master)](https://travis-ci.org/openstax/exchange-ruby)
@@ -7,8 +6,7 @@ exchange-ruby
 
 A ruby client for interfacing with the OpenStax Exchange API.
 
-Usage
------
+## Usage
 
 Include the gem in your project:
 ```rb
@@ -21,16 +19,19 @@ Include the following in your script:
 require 'openstax_exchange'
 ```
 
-Configure the client's knowledge of the Exchange server:
+### Client Configuration
 
+*NOTE:* After changing the client configuration, use:
 ```rb
-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
+OpenStax::Exchange.reset!
 ```
+to ensure that the changes take effect.
+
+#### Choosing the Client
+
+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:
 
@@ -39,7 +40,22 @@ OpenStax::Exchange.use_real_client
 OpenStax::Exchange.use_fake_client
 ```
 
-If using the fake client, configure the faked server settings:
+#### Configuring the Client
+
+Regardless of which client is used, you must configure the client's knowledge of the Exchange server:
+
+```rb
+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
+```
+
+#### Configuring the Fake Client
+
+The fake client automatically uses the `OpenStax::Exchange.configure` client-side settings, but you must also configure the faked client's server settings:
 
 ```rb
 OpenStax::Exchange::FakeClient.configure do |config|
@@ -49,22 +65,16 @@ OpenStax::Exchange::FakeClient.configure do |config|
 end
 ```
 
-After changing the client configuration, use:
-```rb
-OpenStax::Exchange.reset!
-```
-to ensure that the changes take effect.
+### Supported API Methods
 
 The following Exchange API methods are currently supported:
 ```rb
 identifier = OpenStax::Exchange.create_identifier
-```
-```rb
+
 response = OpenStax::Exchange.record_multiple_choice_answer(identifier, resource_uri, trial, answer)
 ```
 
-Running the Specs
------------------
+## Running the Specs
 
 Create a local clone of the repo, and run the following commands:
 ```rb

data/lib/openstax/exchange/version.rb

@@ -1,5 +1,5 @@
 module OpenStax
   module Exchange
-    VERSION = "0.0.1"
+    VERSION = "0.0.2"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: openstax_exchange
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-13 00:00:00.000000000 Z
+date: 2015-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oauth2
@@ -183,7 +183,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 149071873678705480
+      hash: 4392210853823961273
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -192,7 +192,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 149071873678705480
+      hash: 4392210853823961273
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23.2