openstax_exchange 0.0.0 → 0.0.1

data/spec/cassettes/OpenStax_Exchange_RealClient/behaves_like_exchange_client_api_v1/_record_multiple_choice_answer/success/creates_a_multiple_choice_answer_associated_with_the_given_identifier.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/"e463908024e5712415722596d2aa197d"
+      X-Request-Id:
+      - e0cc9069-fabe-447e-8f39-3ea55a2ae601
+      X-Runtime:
+      - '0.015996'
+      Connection:
+      - close
+      Server:
+      - thin
+    body:
+      encoding: US-ASCII
+      string: ! '{"access_token":"63cf088605315a592d872458afbdd26eb691a7ebd4db117215ebc2cd84829d45","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 63cf088605315a592d872458afbdd26eb691a7ebd4db117215ebc2cd84829d45
+      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/"94c76c22e48adee6850f7f758130929a"
+      Cache-Control:
+      - max-age=0, private, must-revalidate
+      Set-Cookie:
+      - _exercises_session=Y0FCSkN1L21TRkp0S2xJNkxuRGJUZkdNSjJML3F5NVRsdmd4WUlqaTdiczZ2WDRXcE1MTDFhVFFHRmxzL1R5Y0pHRlpRTzJYRzNKSmxnUzZIUFlHR1E9PS0tVFRkTkdBWk9YaGw3Q1A4M29NWmxiUT09--a105cf2f6eb8f7307466b070661c139095608ea5;
+        path=/; HttpOnly
+      - request_method=POST; path=/
+      X-Request-Id:
+      - ecbb2f11-eb79-4f06-91ed-3a511c13e2f3
+      X-Runtime:
+      - '0.040816'
+      Connection:
+      - close
+      Server:
+      - thin
+    body:
+      encoding: US-ASCII
+      string: ! '{"identifier":"3aa2504cbe2e8b8e2f7e3834c6c1324ffcd50b29872bcdbe77d1c3587bd719ae"}'
+    http_version: 
+  recorded_at: Mon, 12 Jan 2015 21:08:52 GMT
+- request:
+    method: post
+    uri: http://localhost:3003/api/events/platforms/multiple_choices
+    body:
+      encoding: UTF-8
+      string: ! '{"identifier":"3aa2504cbe2e8b8e2f7e3834c6c1324ffcd50b29872bcdbe77d1c3587bd719ae","resource":"http://exercises.openstax.org/exercises/1234","trial":"1","answer":"answer_string"}'
+    headers:
+      User-Agent:
+      - Faraday v0.9.0
+      Accept:
+      - application/vnd.exchange.openstax.v1
+      Authorization:
+      - Bearer 63cf088605315a592d872458afbdd26eb691a7ebd4db117215ebc2cd84829d45
+      Content-Type:
+      - application/x-www-form-urlencoded
+  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/"d044e24bdcdf0b2ff8316bbf53e25f14"
+      Cache-Control:
+      - max-age=0, private, must-revalidate
+      Set-Cookie:
+      - _exercises_session=RUdNUXpxRkR1YzRlcE05MFJKV3NRQnJIaUU4RzhHTW9pREtzWUd2TjRiMGdZM2RsZlhmaHZKdlJ1dDRRRi9GUVlkZUo2anBFbkw5ZjErdU1Sb3Q1VVE9PS0tb3NIaTJoQ3djbkpzaWZhU0dkQ3hXUT09--b863b16466f2fc8176a22fa602c21184415f14ed;
+        path=/; HttpOnly
+      - request_method=POST; path=/
+      X-Request-Id:
+      - 3b6c238a-5709-4d7c-a8fe-69c8e96e9669
+      X-Runtime:
+      - '0.086874'
+      Connection:
+      - close
+      Server:
+      - thin
+    body:
+      encoding: US-ASCII
+      string: ! '{"identifier":"3aa2504cbe2e8b8e2f7e3834c6c1324ffcd50b29872bcdbe77d1c3587bd719ae","resource":"http://exercises.openstax.org/exercises/1234","trial":"1","created_at":"2015-01-12T21:08:52.423Z","answer_type":"multiple-choice","answer":"answer_string"}'
+    http_version: 
+  recorded_at: Mon, 12 Jan 2015 21:08:52 GMT
+recorded_with: VCR 2.9.3

data/spec/lib/openstax/exchange/client_configuration_spec.rb

@@ -0,0 +1,58 @@
+require 'spec_helper'
+
+describe OpenStax::Exchange, vcr: VCR_OPTS do
+
+  before(:each) do
+    OpenStax::Exchange.configure do |config|
+      config.client_platform_id     = DEFAULT_CLIENT_PLATFORM_ID
+      config.client_platform_secret = DEFAULT_CLIENT_PLATFORM_SECRET
+      config.client_server_url      = client_server_url
+      config.client_api_version     = DEFAULT_CLIENT_API_VERSION
+    end
+
+    OpenStax::Exchange::FakeClient.configure do |config|
+      config.registered_platforms   = {DEFAULT_CLIENT_PLATFORM_ID => DEFAULT_CLIENT_PLATFORM_SECRET}
+      config.server_url             = client_server_url
+      config.supported_api_versions = [ DEFAULT_CLIENT_API_VERSION ]
+    end
+  end
+
+  context "internal client instance" do
+    it "#client defaults to a real exchange client" do
+      client = OpenStax::Exchange.send(:client)
+      expect(client.is_real_client?).to be_truthy
+    end
+
+    it "#client returns the same client object on successive calls" do
+      client_object_id1 = OpenStax::Exchange.send(:client).object_id
+      client_object_id2 = OpenStax::Exchange.send(:client).object_id
+      expect(client_object_id1).to eq(client_object_id2)
+    end
+
+    it "#reset! causes a new client object to be returned by #client" do
+      client_object_id1 = OpenStax::Exchange.send(:client).object_id
+      OpenStax::Exchange.reset!
+      client_object_id2 = OpenStax::Exchange.send(:client).object_id
+      expect(client_object_id1).to_not eq(client_object_id2)
+    end
+  end
+
+  context "client instance configuration" do
+    before(:each) do
+      OpenStax::Exchange.reset!
+    end
+
+    it "can be configured to use a real exchange client" do
+      OpenStax::Exchange.use_real_client
+      client = OpenStax::Exchange.send(:client)
+      expect(client.is_real_client?).to be_truthy
+    end
+
+    it "can be configured to use a fake exchange client" do
+      OpenStax::Exchange.use_fake_client
+      client = OpenStax::Exchange.send(:client)
+      expect(client.is_real_client?).to be_falsy
+    end
+  end
+
+end

data/spec/lib/openstax/exchange/fake_client_v1_spec.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+
+describe OpenStax::Exchange::FakeClient do
+  before(:each) do
+    OpenStax::Exchange.use_fake_client
+    OpenStax::Exchange::FakeClient.configure do |config|
+      config.registered_platforms   = {DEFAULT_CLIENT_PLATFORM_ID => DEFAULT_CLIENT_PLATFORM_SECRET}
+      config.server_url             = client_server_url
+      config.supported_api_versions = [API_VERSION_V1]
+    end
+  end
+
+  it_behaves_like "exchange client api v1"
+end

data/spec/lib/openstax/exchange/real_client_v1_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+
+describe OpenStax::Exchange::RealClient, vcr: VCR_OPTS do
+  before(:each) do
+    OpenStax::Exchange::use_real_client
+  end
+
+  it_behaves_like "exchange client api v1"
+end

data/spec/lib/openstax/exchange/shared_examples_for_exchange_client_v1.rb

@@ -0,0 +1,208 @@
+require 'spec_helper'
+
+RSpec.shared_examples "exchange client api v1" do
+
+  before(:each) do
+    OpenStax::Exchange.reset!
+    OpenStax::Exchange.configure do |config|
+      config.client_platform_id     = DEFAULT_CLIENT_PLATFORM_ID
+      config.client_platform_secret = DEFAULT_CLIENT_PLATFORM_SECRET
+      config.client_server_url      = client_server_url
+      config.client_api_version     = API_VERSION_V1
+    end
+  end
+
+  describe "#initialize" do
+    context "success" do
+      it "initializes the authentication token" do
+        client = OpenStax::Exchange.send(:client)
+        expect(client.token).to_not be_nil
+      end
+    end
+    context "invalid server" do
+      it "raises an exception" do
+        OpenStax::Exchange.configure do |config|
+          config.client_server_url = client_server_url(host: 'this.is.a.fake.address')
+        end
+        expect {
+          OpenStax::Exchange.send(:client)
+        }.to raise_error(OpenStax::Exchange::ClientError)
+      end
+    end
+    context "invalid port" do
+      it "raises an exception" do
+        OpenStax::Exchange.configure do |config|
+          config.client_server_url = client_server_url(port: 9999)
+        end
+        expect {
+          OpenStax::Exchange.send(:client)
+        }.to raise_error(OpenStax::Exchange::ClientError)
+      end
+    end
+    context "invalid platform id" do
+      it "raises an exception" do
+        OpenStax::Exchange.configure do |config|
+          config.client_platform_id = '999'
+        end
+        expect {
+          OpenStax::Exchange.send(:client)
+        }.to raise_error(OpenStax::Exchange::ClientError)
+      end
+    end
+    context "invalid platform secret" do
+      it "raises an exception" do
+        OpenStax::Exchange.configure do |config|
+          config.client_platform_secret = 'not_the_secret'
+        end
+        expect {
+          OpenStax::Exchange.send(:client)
+        }.to raise_error(OpenStax::Exchange::ClientError)
+      end
+    end
+  end
+
+  describe "#create_identifier" do
+    context "success" do
+      it "creates and returns a new identifier" do
+        identifier = OpenStax::Exchange.create_identifier
+        expect(identifier).to match(/^[a-fA-F0-9]+$/)
+      end
+      it "creates a distinct identifer per invokation" do
+        identifier1 = OpenStax::Exchange.create_identifier
+        identifier2 = OpenStax::Exchange.create_identifier
+        expect(identifier1).to_not eq(identifier2)
+      end
+    end
+  end
+
+  describe "#record_multiple_choice_answer" do
+    context "success" do
+      it "creates a multiple choice answer associated with the given identifier" do
+        identifier = OpenStax::Exchange.create_identifier
+
+        # must have the form of a "trusted resource"
+        # (Exchange app/routines/find_or_create_resource_from_url.rb:35)
+        resource_string = 'http://exercises.openstax.org/exercises/1234'
+        trial           = '1'
+        answer_string   = 'answer_string'
+
+        response = OpenStax::Exchange.record_multiple_choice_answer(
+          identifier, resource_string, trial, answer_string)
+
+        expect(response['identifier']).to eq(identifier)
+        expect(response['resource']).to eq(resource_string)
+        expect(response['trial']).to eq(trial)
+        expect(response['answer']).to eq(answer_string)
+      end
+      it "allows answers with distinct identifiers to be saved" do
+        identifier1 = OpenStax::Exchange.create_identifier
+        identifier2 = OpenStax::Exchange.create_identifier
+
+        # must have the form of a "trusted resource"
+        # (Exchange app/routines/find_or_create_resource_from_url.rb:35)
+        resource_string = 'http://exercises.openstax.org/exercises/1234'
+        trial           = '1'
+        answer_string   = 'answer_string'
+
+        response = nil
+
+        expect {
+          response = OpenStax::Exchange.record_multiple_choice_answer(
+            identifier1, resource_string, trial, answer_string)
+        }.to_not raise_error
+        expect(response['identifier']).to eq(identifier1)
+
+        expect {
+          response = OpenStax::Exchange.record_multiple_choice_answer(
+            identifier2, resource_string, trial, answer_string)
+        }.to_not raise_error
+        expect(response['identifier']).to eq(identifier2)
+      end
+      it "allows answers with distinct resources to be saved" do
+        identifier = OpenStax::Exchange.create_identifier
+
+        # must have the form of a "trusted resource"
+        # (Exchange app/routines/find_or_create_resource_from_url.rb:35)
+        resource_string1 = 'http://exercises.openstax.org/exercises/1234'
+        resource_string2 = 'http://exercises.openstax.org/exercises/3456'
+        trial            = '1'
+        answer_string    = 'answer_string'
+
+        response = nil
+
+        expect {
+          response = OpenStax::Exchange.record_multiple_choice_answer(
+            identifier, resource_string1, trial, answer_string)
+        }.to_not raise_error
+        expect(response['resource']).to eq(resource_string1)
+
+        expect {
+          response = OpenStax::Exchange.record_multiple_choice_answer(
+            identifier, resource_string2, trial, answer_string)
+        }.to_not raise_error
+        expect(response['resource']).to eq(resource_string2)
+      end
+      it "allows answers with distinct trials to be saved" do
+        identifier = OpenStax::Exchange.create_identifier
+
+        # must have the form of a "trusted resource"
+        # (Exchange app/routines/find_or_create_resource_from_url.rb:35)
+        resource_string = 'http://exercises.openstax.org/exercises/1234'
+        trial1          = '1'
+        trial2          = '2'
+        answer_string   = 'answer_string'
+
+        response = nil
+
+        expect {
+          response = OpenStax::Exchange.record_multiple_choice_answer(
+            identifier, resource_string, trial1, answer_string)
+        }.to_not raise_error
+        expect(response['trial']).to eq(trial1)
+
+        expect {
+          response = OpenStax::Exchange.record_multiple_choice_answer(
+            identifier, resource_string, trial2, answer_string)
+        }.to_not raise_error
+        expect(response['trial']).to eq(trial2)
+      end
+    end
+    context "duplicate (identifer,resource,trial) triplet" do
+      it "raises an exception" do
+        identifier = OpenStax::Exchange.create_identifier
+
+        # must have the form of a "trusted resource"
+        # (Exchange app/routines/find_or_create_resource_from_url.rb:35)
+        resource_string = 'http://exercises.openstax.org/exercises/1234'
+        trial           = '1'
+        answer_string   = 'answer_string'
+
+        expect {
+          response = OpenStax::Exchange.record_multiple_choice_answer(
+            identifier, resource_string, trial, answer_string)
+        }.to_not raise_error
+
+        expect {
+          response = OpenStax::Exchange.record_multiple_choice_answer(
+            identifier, resource_string, trial, answer_string)
+        }.to raise_error(OpenStax::Exchange::ClientError)
+      end
+    end
+    context "invalid resource string" do
+      it "raises an exception" do
+        identifier = OpenStax::Exchange.create_identifier
+
+        # must have the form of a "trusted resource"
+        # (Exchange app/routines/find_or_create_resource_from_url.rb:35)
+        resource_string = 'http://example.com/exercises/1234'
+        trial           = '1'
+        answer_string   = 'answer_string'
+
+        expect {
+          response = OpenStax::Exchange.record_multiple_choice_answer(
+            identifier, resource_string, trial, answer_string)
+        }.to raise_error(OpenStax::Exchange::ClientError)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,39 +1,53 @@
-ENV['RAILS_ENV'] ||= 'test'
-
-require File.expand_path('../dummy/config/environment.rb',  __FILE__)
-require 'rspec/rails'
-
-# Requires supporting ruby files with custom matchers and macros, etc,
-Rails.backtrace_cleaner.remove_silencers!
-
-# in spec/support/ and its subdirectories.
-Dir[Rails.root.join("spec/support/**/*.rb")].each { |f| require f }
-
-RSpec.configure do |config|
-  # ## Mock Framework
-  #
-  # If you prefer to use mocha, flexmock or RR, uncomment the appropriate line:
-  #
-  # config.mock_with :mocha
-  # config.mock_with :flexmock
-  # config.mock_with :rr
-
-  # Remove this line if you're not using ActiveRecord or ActiveRecord fixtures
-  # config.fixture_path = "#{::Rails.root}/spec/fixtures"
-
-  # If you're not using ActiveRecord, or you'd prefer not to run each of your
-  # examples within a transaction, remove the following line or assign false
-  # instead of true.
-  config.use_transactional_fixtures = true
-
-  # If true, the base class of anonymous controllers will be inferred
-  # automatically. This will be the default behavior in future versions of
-  # rspec-rails.
-  config.infer_base_class_for_anonymous_controllers = false
-
-  # Run specs in random order to surface order dependencies. If you find an
-  # order dependency and want to debug it, you can fix the order by providing
-  # the seed, which is printed after each run.
-  #     --seed 1234
-  config.order = "random"
+require 'simplecov'
+SimpleCov.start
+
+require 'vcr'
+
+VCR.configure do |c|
+  c.cassette_library_dir = 'spec/cassettes'
+  c.hook_into :webmock
+  c.configure_rspec_metadata!
+  # c.debug_logger = File.open("vcr_log.txt", "w")
+end
+
+accept_header = lambda do |request1, request2|
+  request1.headers['Accept'] == request2.headers['Accept']
+end
+
+authorization_header = lambda do |request1, request2|
+  request1.headers['Authorization'] == request2.headers['Authorization']
+end
+
+VCR_OPTS = {
+  record: :none, ## this should be :none before pushing
+  allow_unused_http_interactions: false,
+  match_requests_on: [:method, :uri, :host, :body, accept_header, authorization_header]
+}
+
+require 'openstax_exchange'
+require 'lib/openstax/exchange/shared_examples_for_exchange_client_v1'
+
+API_VERSION_V1 = 'v1'
+
+DEFAULT_CLIENT_PLATFORM_ID     = '123'
+DEFAULT_CLIENT_PLATFORM_SECRET = 'abc'
+DEFAULT_CLIENT_SERVER_SCHEME   = 'http'
+DEFAULT_CLIENT_SERVER_HOST     = 'localhost'
+DEFAULT_CLIENT_SERVER_PORT     = 3003
+DEFAULT_CLIENT_SERVER_PATH     = nil
+DEFAULT_CLIENT_API_VERSION     = API_VERSION_V1
+
+def client_server_url(options = {})
+  server_scheme = options.fetch(:scheme) { DEFAULT_CLIENT_SERVER_SCHEME }
+  server_host   = options.fetch(:host)   { DEFAULT_CLIENT_SERVER_HOST }
+  server_port   = options.fetch(:port)   { DEFAULT_CLIENT_SERVER_PORT }
+  server_path   = options.fetch(:path)   { DEFAULT_CLIENT_SERVER_PATH }
+
+  url = URI::Generic.build(
+    scheme: server_scheme,
+    host:   server_host,
+    port:   server_port,
+    path:   server_path)
+
+  url.to_s
 end