openstax_exchange 0.0.0 → 0.0.1

data/lib/openstax/exchange/version.rb

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

data/lib/openstax_exchange.rb

@@ -1,112 +1,8 @@
-require 'openstax/exchange/version'
-
-require 'oauth2'
-require 'uri'
-
-module OpenStax
-  module Exchange
-
-    DEFAULT_API_VERSION = :v1
-
-    class << self
-
-      ###########################################################################
-      #
-      # Configuration machinery.
-      #
-      # To configure OpenStax Exchange, put the following code in your
-      # application's initialization logic
-      # (eg. in the config/initializers in a Rails app)
-      #
-      #   OpenStax::Exchange.configure do |config|
-      #     config.<parameter name> = <parameter value>
-      #     ...
-      #   end
-      #
-      
-      def configure
-        yield configuration
-      end
-
-      def configuration
-        @configuration ||= Configuration.new
-      end
-
-      class Configuration
-        # openstax_exchange_url
-        # Base URL for OpenStax Exchange
-        attr_reader :openstax_exchange_url
-
-        # openstax_exchange_platform_id
-        # OAuth client_id received from OpenStax Exchange
-        attr_accessor :openstax_exchange_platform_id
-
-        # openstax_exchange_platform_secret
-        # OAuth client_secret received from OpenStax Exchange
-        attr_accessor :openstax_exchange_platform_secret
-
-        def openstax_exchange_url=(url)
-          url.gsub!(/https|http/,'https') if !(url =~ /localhost/)
-          url = url + "/" if url[url.size-1] != '/'
-          @openstax_exchange_url = url
-        end
-
-        def initialize
-          @openstax_exchange_platform_id = 'SET ME!'
-          @openstax_exchange_platform_secret = 'SET ME!'
-          @openstax_exchange_url = 'https://exchange.openstax.org/'
-          super
-        end
-      end
-
-      # Executes an OpenStax Exchange API call, using the given HTTP method,
-      # API url and request options.
-      # Any options accepted by OAuth2 requests can be used, such as
-      # :params, :body, :headers, etc, plus the :access_token option, which can
-      # be used to manually specify an OAuth access token.
-      # On failure, it can throw Faraday::ConnectionFailed for connection errors
-      # or OAuth2::Error if Exchange returns an HTTP 400 error,
-      # such as 422 Unprocessable Entity.
-      # On success, returns an OAuth2::Response object.
-      def api_call(http_method, url, options = {})
-        version = options.delete(:api_version)
-        unless version.blank?
-          options[:headers] ||= {}
-          options[:headers].merge!({
-            'Accept' => "application/vnd.exchange.openstax.#{version.to_s}"
-          })
-        end
-
-        token_string = options.delete(:access_token)
-        token = token_string.blank? ? client.client_credentials.get_token :
-                  OAuth2::AccessToken.new(client, token_string)
-
-        api_url = URI.join(configuration.openstax_exchange_url, 'api/', url)
-
-        token.request(http_method, api_url, options)
-      end
-
-      # Performs an event search in the Exchange server.
-      # Results are limited to events created by this app.
-      # Takes a query parameter and an optional API version parameter.
-      # API version currently defaults to :v1 (may change in the future).
-      # On failure, throws an Exception, just like api_call.
-      # On success, returns an OAuth2::Response object.
-      def search_events(query, version = DEFAULT_API_VERSION)
-        options = {:params => {:q => query},
-                   :api_version => version}
-        api_call(:get, 'events', options)
-      end
-
-      protected
-
-      def client
-        @client ||= OAuth2::Client.new(configuration.openstax_exchange_platform_id,
-                      configuration.openstax_exchange_platform_secret,
-                      :site => configuration.openstax_exchange_url)
-      end
-
-    end
-
-  end
-end
+require "openstax/exchange/version"
+require "openstax/exchange/exchange"
+require "openstax/exchange/configuration"
+require "openstax/exchange/client_instance"
+require "openstax/exchange/real_client/real_client"
+require "openstax/exchange/fake_client/fake_client"
+require "openstax/exchange/fake_client/configuration"
+require "openstax/exchange/exceptions"

data/spec/cassettes/OpenStax_Exchange/client_instance_configuration/can_be_configured_to_use_a_real_exchange_client.yml

@@ -0,0 +1,48 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: http://123:abc@localhost:3003/oauth/token
+    body:
+      encoding: US-ASCII
+      string: grant_type=client_credentials
+    headers:
+      User-Agent:
+      - Faraday v0.9.0
+      Content-Type:
+      - application/x-www-form-urlencoded
+      Accept:
+      - ! '*/*'
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      X-Frame-Options:
+      - SAMEORIGIN
+      X-Xss-Protection:
+      - 1; mode=block
+      X-Content-Type-Options:
+      - nosniff
+      Cache-Control:
+      - no-store
+      Pragma:
+      - no-cache
+      Content-Type:
+      - application/json; charset=utf-8
+      Etag:
+      - W/"030ffc34c73241d72d05aca483ddd03f"
+      X-Request-Id:
+      - f9eeabfc-3bbc-4194-9f5e-5933e57c1220
+      X-Runtime:
+      - '0.015146'
+      Connection:
+      - close
+      Server:
+      - thin
+    body:
+      encoding: US-ASCII
+      string: ! '{"access_token":"42ad7558a7079e5ffe21572066a090693e5da796fcd64c762ef24c74de196f82","token_type":"bearer"}'
+    http_version: 
+  recorded_at: Mon, 12 Jan 2015 21:08:51 GMT
+recorded_with: VCR 2.9.3

data/spec/cassettes/OpenStax_Exchange/internal_client_instance/_client_defaults_to_a_real_exchange_client.yml

@@ -0,0 +1,48 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: http://123:abc@localhost:3003/oauth/token
+    body:
+      encoding: US-ASCII
+      string: grant_type=client_credentials
+    headers:
+      User-Agent:
+      - Faraday v0.9.0
+      Content-Type:
+      - application/x-www-form-urlencoded
+      Accept:
+      - ! '*/*'
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      X-Frame-Options:
+      - SAMEORIGIN
+      X-Xss-Protection:
+      - 1; mode=block
+      X-Content-Type-Options:
+      - nosniff
+      Cache-Control:
+      - no-store
+      Pragma:
+      - no-cache
+      Content-Type:
+      - application/json; charset=utf-8
+      Etag:
+      - W/"57e1ddda4cd18e6de20628d2f695579f"
+      X-Request-Id:
+      - 849eb09a-9f9f-4c4b-86bc-91ee21d1788c
+      X-Runtime:
+      - '0.016357'
+      Connection:
+      - close
+      Server:
+      - thin
+    body:
+      encoding: US-ASCII
+      string: ! '{"access_token":"3540d986644ae0492996b05dc584a1ec545b66f14099d70a12e8914fad30651a","token_type":"bearer"}'
+    http_version: 
+  recorded_at: Mon, 12 Jan 2015 21:08:51 GMT
+recorded_with: VCR 2.9.3

data/spec/cassettes/OpenStax_Exchange/internal_client_instance/_reset_causes_a_new_client_object_to_be_returned_by_client.yml

@@ -0,0 +1,48 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: http://123:abc@localhost:3003/oauth/token
+    body:
+      encoding: US-ASCII
+      string: grant_type=client_credentials
+    headers:
+      User-Agent:
+      - Faraday v0.9.0
+      Content-Type:
+      - application/x-www-form-urlencoded
+      Accept:
+      - ! '*/*'
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      X-Frame-Options:
+      - SAMEORIGIN
+      X-Xss-Protection:
+      - 1; mode=block
+      X-Content-Type-Options:
+      - nosniff
+      Cache-Control:
+      - no-store
+      Pragma:
+      - no-cache
+      Content-Type:
+      - application/json; charset=utf-8
+      Etag:
+      - W/"8224c57e32a05bf41b410f079e81d6dd"
+      X-Request-Id:
+      - 1a70559c-c97b-4c33-9c33-e0ad700bfee7
+      X-Runtime:
+      - '0.015211'
+      Connection:
+      - close
+      Server:
+      - thin
+    body:
+      encoding: US-ASCII
+      string: ! '{"access_token":"46e1d7f015769193cfb7a5f5691ae601282010d0cfb540b745a810bd9749868f","token_type":"bearer"}'
+    http_version: 
+  recorded_at: Mon, 12 Jan 2015 21:08:51 GMT
+recorded_with: VCR 2.9.3

data/spec/cassettes/OpenStax_Exchange_RealClient/behaves_like_exchange_client_api_v1/_create_identifier/success/creates_a_distinct_identifer_per_invokation.yml

@@ -0,0 +1,146 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: http://123:abc@localhost:3003/oauth/token
+    body:
+      encoding: US-ASCII
+      string: grant_type=client_credentials
+    headers:
+      User-Agent:
+      - Faraday v0.9.0
+      Content-Type:
+      - application/x-www-form-urlencoded
+      Accept:
+      - ! '*/*'
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      X-Frame-Options:
+      - SAMEORIGIN
+      X-Xss-Protection:
+      - 1; mode=block
+      X-Content-Type-Options:
+      - nosniff
+      Cache-Control:
+      - no-store
+      Pragma:
+      - no-cache
+      Content-Type:
+      - application/json; charset=utf-8
+      Etag:
+      - W/"78a764ea7b6f5c5a842411f5857c9fca"
+      X-Request-Id:
+      - 167f3bf7-4087-4a93-a227-e9402d4f10e1
+      X-Runtime:
+      - '0.014904'
+      Connection:
+      - close
+      Server:
+      - thin
+    body:
+      encoding: US-ASCII
+      string: ! '{"access_token":"4b75ee3427beb3b486def357c3d7e6aa97ca948a8bfb7528c0a09913525795d9","token_type":"bearer"}'
+    http_version: 
+  recorded_at: Mon, 12 Jan 2015 21:08:52 GMT
+- request:
+    method: post
+    uri: http://localhost:3003/api/identifiers
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Faraday v0.9.0
+      Accept:
+      - application/vnd.exchange.openstax.v1
+      Authorization:
+      - Bearer 4b75ee3427beb3b486def357c3d7e6aa97ca948a8bfb7528c0a09913525795d9
+      Content-Length:
+      - '0'
+  response:
+    status:
+      code: 201
+      message: Created
+    headers:
+      X-Frame-Options:
+      - SAMEORIGIN
+      X-Xss-Protection:
+      - 1; mode=block
+      X-Content-Type-Options:
+      - nosniff
+      Content-Type:
+      - application/json; charset=utf-8
+      Etag:
+      - W/"827945503ecf81b1c4c910bee932d933"
+      Cache-Control:
+      - max-age=0, private, must-revalidate
+      Set-Cookie:
+      - _exercises_session=c0cyWnNJeUZSUVQ1MVJ6QUdYUjJKakNSbFRweFQwdnovVms3dm42dDRqMFdSSTJwM2dVTU5GelFPNjhSRXdRVkQxYUlNN0Jpek5Nd2RtenlkNUV0VlE9PS0tdkxMWVV4dUgvVFd3YzFTZzJkNUFXQT09--10f51958af22134ccfe27073cd381c0faf434a35;
+        path=/; HttpOnly
+      - request_method=POST; path=/
+      X-Request-Id:
+      - 4911b91c-7fb5-49ec-9f91-0772d50ef84c
+      X-Runtime:
+      - '0.078438'
+      Connection:
+      - close
+      Server:
+      - thin
+    body:
+      encoding: US-ASCII
+      string: ! '{"identifier":"d8626248d8781ea4a079810bbc2414194335fdab7658b7ba2fab8986b80b7b05"}'
+    http_version: 
+  recorded_at: Mon, 12 Jan 2015 21:08:52 GMT
+- request:
+    method: post
+    uri: http://localhost:3003/api/identifiers
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Faraday v0.9.0
+      Accept:
+      - application/vnd.exchange.openstax.v1
+      Authorization:
+      - Bearer 4b75ee3427beb3b486def357c3d7e6aa97ca948a8bfb7528c0a09913525795d9
+      Content-Length:
+      - '0'
+  response:
+    status:
+      code: 201
+      message: Created
+    headers:
+      X-Frame-Options:
+      - SAMEORIGIN
+      X-Xss-Protection:
+      - 1; mode=block
+      X-Content-Type-Options:
+      - nosniff
+      Content-Type:
+      - application/json; charset=utf-8
+      Etag:
+      - W/"8d46bbfacc4812d2aafea6655fc6ea42"
+      Cache-Control:
+      - max-age=0, private, must-revalidate
+      Set-Cookie:
+      - _exercises_session=LzR6d09ZRE1CUjZlR2Jac1FpMlkzeDl2VWFNYTJyQ1NGeGkxWjRxVHdVS095ckpwUFZMcytxUFByOXVJOHoxUFR1d3ozSzNycFBYYVUrOEY3TVU3eVE9PS0tb29QaldpV2lkaWZEZHlRblZjQVBjdz09--c93e2fa442d933cb679336585b1670ebf60fdb09;
+        path=/; HttpOnly
+      - request_method=POST; path=/
+      X-Request-Id:
+      - dca250e2-9c45-4f64-b584-a0f8f264a3f3
+      X-Runtime:
+      - '0.040383'
+      Connection:
+      - close
+      Server:
+      - thin
+    body:
+      encoding: US-ASCII
+      string: ! '{"identifier":"c2e144cf2fa6db7fe45015b20fe117293a75d8c778204507095e03e8fa60ebf9"}'
+    http_version: 
+  recorded_at: Mon, 12 Jan 2015 21:08:52 GMT
+recorded_with: VCR 2.9.3

data/spec/cassettes/OpenStax_Exchange_RealClient/behaves_like_exchange_client_api_v1/_create_identifier/success/creates_and_returns_a_new_identifier.yml

@@ -0,0 +1,97 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: http://123:abc@localhost:3003/oauth/token
+    body:
+      encoding: US-ASCII
+      string: grant_type=client_credentials
+    headers:
+      User-Agent:
+      - Faraday v0.9.0
+      Content-Type:
+      - application/x-www-form-urlencoded
+      Accept:
+      - ! '*/*'
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      X-Frame-Options:
+      - SAMEORIGIN
+      X-Xss-Protection:
+      - 1; mode=block
+      X-Content-Type-Options:
+      - nosniff
+      Cache-Control:
+      - no-store
+      Pragma:
+      - no-cache
+      Content-Type:
+      - application/json; charset=utf-8
+      Etag:
+      - W/"f04b2cfc92d51ad3cc0806eeea34ae39"
+      X-Request-Id:
+      - 0ade458e-d6b6-47ff-88af-36a192d55ed4
+      X-Runtime:
+      - '0.029061'
+      Connection:
+      - close
+      Server:
+      - thin
+    body:
+      encoding: US-ASCII
+      string: ! '{"access_token":"bcf348f1e3d1b3422422671a2c940d59351bad44b3b95ed3b2296c16f57675a2","token_type":"bearer"}'
+    http_version: 
+  recorded_at: Mon, 12 Jan 2015 21:08:52 GMT
+- request:
+    method: post
+    uri: http://localhost:3003/api/identifiers
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Faraday v0.9.0
+      Accept:
+      - application/vnd.exchange.openstax.v1
+      Authorization:
+      - Bearer bcf348f1e3d1b3422422671a2c940d59351bad44b3b95ed3b2296c16f57675a2
+      Content-Length:
+      - '0'
+  response:
+    status:
+      code: 201
+      message: Created
+    headers:
+      X-Frame-Options:
+      - SAMEORIGIN
+      X-Xss-Protection:
+      - 1; mode=block
+      X-Content-Type-Options:
+      - nosniff
+      Content-Type:
+      - application/json; charset=utf-8
+      Etag:
+      - W/"0ca26961ce9d51f60f5a467cfe7ba4c2"
+      Cache-Control:
+      - max-age=0, private, must-revalidate
+      Set-Cookie:
+      - _exercises_session=TnZoWHNTaWdjZmJJUXg2VHdOdERvcTA5a2R6WURqQkJub1FMYlZYdEpKZ3hCQjJiekx2ZVdDL2ZBcWMwOW53Y3lFVHYzWHJYTFlhdW02MUVKMXdZY2c9PS0tQ1VnN1EzSmxad1BjY1d5UVNHR29xdz09--e0ce290be622c8641bdc4072f45e8f23b596a233;
+        path=/; HttpOnly
+      - request_method=POST; path=/
+      X-Request-Id:
+      - 15464bd1-b133-4c40-9e36-17a4b3a43ebc
+      X-Runtime:
+      - '0.047932'
+      Connection:
+      - close
+      Server:
+      - thin
+    body:
+      encoding: US-ASCII
+      string: ! '{"identifier":"e4b89fa467a1f56272ab3d4440cd784b9a8eaa377f55997c74a452c3e084bf69"}'
+    http_version: 
+  recorded_at: Mon, 12 Jan 2015 21:08:52 GMT
+recorded_with: VCR 2.9.3