openstax_exchange 0.1.0 → 0.2.0

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

@@ -100,7 +100,8 @@ RSpec.shared_examples "exchange client api v1" do
         answer_string   = 'answer_string'
 
         response = OpenStax::Exchange.record_multiple_choice_answer(
-          identifier, resource_string, trial, answer_string)
+          identifier, resource_string, trial, answer_string
+        )
 
         expect(response['identifier']).to eq(identifier)
         expect(response['resource']).to eq(resource_string)
@@ -121,13 +122,15 @@ RSpec.shared_examples "exchange client api v1" do
 
         expect {
           response = OpenStax::Exchange.record_multiple_choice_answer(
-            identifier1, resource_string, trial, answer_string)
+            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)
+            identifier2, resource_string, trial, answer_string
+          )
         }.to_not raise_error
         expect(response['identifier']).to eq(identifier2)
       end
@@ -145,13 +148,15 @@ RSpec.shared_examples "exchange client api v1" do
 
         expect {
           response = OpenStax::Exchange.record_multiple_choice_answer(
-            identifier, resource_string1, trial, answer_string)
+            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)
+            identifier, resource_string2, trial, answer_string
+          )
         }.to_not raise_error
         expect(response['resource']).to eq(resource_string2)
       end
@@ -169,13 +174,15 @@ RSpec.shared_examples "exchange client api v1" do
 
         expect {
           response = OpenStax::Exchange.record_multiple_choice_answer(
-            identifier, resource_string, trial1, answer_string)
+            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)
+            identifier, resource_string, trial2, answer_string
+          )
         }.to_not raise_error
         expect(response['trial']).to eq(trial2)
       end
@@ -191,17 +198,22 @@ RSpec.shared_examples "exchange client api v1" do
         answer_string   = 'answer_string'
         answer_string_2 = 'another_string'
 
+        response = nil
         expect {
           response = OpenStax::Exchange.record_multiple_choice_answer(
             identifier, resource_string, trial, answer_string
           )
         }.to_not raise_error
 
+        expect(response['answer']).to eq answer_string
+
         expect {
           response = OpenStax::Exchange.record_multiple_choice_answer(
             identifier, resource_string, trial, answer_string_2
           )
         }.to_not raise_error
+
+        expect(response['answer']).to eq answer_string_2
       end
     end
     context "invalid resource string" do
@@ -216,7 +228,165 @@ RSpec.shared_examples "exchange client api v1" do
 
         expect {
           response = OpenStax::Exchange.record_multiple_choice_answer(
-            identifier, resource_string, trial, answer_string)
+            identifier, resource_string, trial, answer_string
+          )
+        }.to raise_error(OpenStax::Exchange::ClientError)
+      end
+    end
+  end
+
+  describe "#record_grade" do
+    context "success" do
+      it "records the exercise grade for the given identifier" do
+        identifier = OpenStax::Exchange.create_identifiers.write
+
+        # must have the form of a "trusted resource"
+        # (Exchange app/routines/find_or_create_resource_from_url.rb:35)
+        resource_string = 'https://exercises-dev1.openstax.org/api/exercises/123@1'
+        trial           = '1'
+        grade_string    = '1.0'
+        grader_string   = 'openstax'
+
+        response = OpenStax::Exchange.record_grade(
+          identifier, resource_string, trial, grade_string, grader_string
+        )
+
+        expect(response['identifier']).to eq(identifier)
+        expect(response['resource']).to eq(resource_string)
+        expect(response['trial']).to eq(trial)
+        expect(response['grade']).to eq(grade_string)
+        expect(response['grader']).to eq(grader_string)
+      end
+      it "allows grades for distinct identifiers to be saved" do
+        identifier1 = OpenStax::Exchange.create_identifiers.write
+        identifier2 = OpenStax::Exchange.create_identifiers.write
+
+        # must have the form of a "trusted resource"
+        # (Exchange app/routines/find_or_create_resource_from_url.rb:35)
+        resource_string = 'https://exercises-dev1.openstax.org/api/exercises/123@1'
+        trial           = '1'
+        grade_string    = '1.0'
+        grader_string   = 'openstax'
+
+        response = nil
+
+        expect {
+          response = OpenStax::Exchange.record_grade(
+            identifier1, resource_string, trial, grade_string, grader_string
+          )
+        }.to_not raise_error
+        expect(response['identifier']).to eq(identifier1)
+
+        expect {
+          response = OpenStax::Exchange.record_grade(
+            identifier2, resource_string, trial, grade_string, grader_string
+          )
+        }.to_not raise_error
+        expect(response['identifier']).to eq(identifier2)
+      end
+      it "allows grades for distinct resources to be saved" do
+        identifier = OpenStax::Exchange.create_identifiers.write
+
+        # must have the form of a "trusted resource"
+        # (Exchange app/routines/find_or_create_resource_from_url.rb:35)
+        resource_string1 = 'https://exercises-dev1.openstax.org/api/exercises/12@1'
+        resource_string2 = 'https://exercises-dev1.openstax.org/api/exercises/123@1'
+        trial            = '1'
+        grade_string     = '1.0'
+        grader_string    = 'openstax'
+
+        response = nil
+
+        expect {
+          response = OpenStax::Exchange.record_grade(
+            identifier, resource_string1, trial, grade_string, grader_string
+          )
+        }.to_not raise_error
+        expect(response['resource']).to eq(resource_string1)
+
+        expect {
+          response = OpenStax::Exchange.record_grade(
+            identifier, resource_string2, trial, grade_string, grader_string
+          )
+        }.to_not raise_error
+        expect(response['resource']).to eq(resource_string2)
+      end
+      it "allows grades for distinct trials to be saved" do
+        identifier = OpenStax::Exchange.create_identifiers.write
+
+        # must have the form of a "trusted resource"
+        # (Exchange app/routines/find_or_create_resource_from_url.rb:35)
+        resource_string = 'https://exercises-dev1.openstax.org/api/exercises/123@1'
+        trial1          = '1'
+        trial2          = '2'
+        grade_string    = '1.0'
+        grader_string   = 'openstax'
+
+        response = nil
+
+        expect {
+          response = OpenStax::Exchange.record_grade(
+            identifier, resource_string, trial1, grade_string, grader_string
+          )
+        }.to_not raise_error
+        expect(response['trial']).to eq(trial1)
+
+        expect {
+          response = OpenStax::Exchange.record_grade(
+            identifier, resource_string, trial2, grade_string, grader_string
+          )
+        }.to_not raise_error
+        expect(response['trial']).to eq(trial2)
+      end
+    end
+    context "duplicate (identifer,resource,trial) triplet" do
+      it "records the new grade" do
+        identifier = OpenStax::Exchange.create_identifiers.write
+
+        # must have the form of a "trusted resource"
+        # (Exchange app/routines/find_or_create_resource_from_url.rb:35)
+        resource_string = 'https://exercises-dev1.openstax.org/api/exercises/123@1'
+        trial           = '1'
+        grade_string    = '0.0'
+        grade_string_2  = '1.0'
+        grader_string   = 'openstax'
+        grader_string_2 = 'tutor'
+
+        response = nil
+        expect {
+          response = OpenStax::Exchange.record_grade(
+            identifier, resource_string, trial, grade_string, grader_string
+          )
+        }.to_not raise_error
+
+        expect(response['grade']).to eq grade_string
+        expect(response['grader']).to eq grader_string
+
+        expect {
+          response = OpenStax::Exchange.record_grade(
+            identifier, resource_string, trial, grade_string_2, grader_string_2
+          )
+        }.to_not raise_error
+
+        expect(response['grade']).to eq grade_string_2
+        expect(response['grader']).to eq grader_string_2
+      end
+    end
+    context "invalid resource string" do
+      it "raises an exception" do
+        identifier = OpenStax::Exchange.create_identifiers.write
+
+        # must have the form of a "trusted resource"
+        # (Exchange app/routines/find_or_create_resource_from_url.rb:35)
+        resource_string = 'https://example.com/api/exercises/123@1'
+        trial           = '1'
+        grade_string    = '1.0'
+        grader_string   = 'openstax'
+
+        expect {
+          response = OpenStax::Exchange.record_grade(
+            identifier, resource_string, trial, grade_string, grader_string
+          )
         }.to raise_error(OpenStax::Exchange::ClientError)
       end
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: openstax_exchange
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-30 00:00:00.000000000 Z
+date: 2015-05-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oauth2
@@ -173,6 +173,12 @@ files:
 - spec/cassettes/OpenStax_Exchange_RealClient/behaves_like_exchange_client_api_v1/_initialize/invalid_platform_id/raises_an_exception.yml
 - spec/cassettes/OpenStax_Exchange_RealClient/behaves_like_exchange_client_api_v1/_initialize/invalid_platform_secret/raises_an_exception.yml
 - spec/cassettes/OpenStax_Exchange_RealClient/behaves_like_exchange_client_api_v1/_initialize/success/initializes_the_authentication_token.yml
+- spec/cassettes/OpenStax_Exchange_RealClient/behaves_like_exchange_client_api_v1/_record_grade/duplicate_identifer_resource_trial_triplet/records_the_new_grade.yml
+- spec/cassettes/OpenStax_Exchange_RealClient/behaves_like_exchange_client_api_v1/_record_grade/invalid_resource_string/raises_an_exception.yml
+- spec/cassettes/OpenStax_Exchange_RealClient/behaves_like_exchange_client_api_v1/_record_grade/success/allows_grades_for_distinct_identifiers_to_be_saved.yml
+- spec/cassettes/OpenStax_Exchange_RealClient/behaves_like_exchange_client_api_v1/_record_grade/success/allows_grades_for_distinct_resources_to_be_saved.yml
+- spec/cassettes/OpenStax_Exchange_RealClient/behaves_like_exchange_client_api_v1/_record_grade/success/allows_grades_for_distinct_trials_to_be_saved.yml
+- spec/cassettes/OpenStax_Exchange_RealClient/behaves_like_exchange_client_api_v1/_record_grade/success/records_the_exercise_grade_for_the_given_identifier.yml
 - spec/cassettes/OpenStax_Exchange_RealClient/behaves_like_exchange_client_api_v1/_record_multiple_choice_answer/duplicate_identifer_resource_trial_triplet/records_the_new_answer.yml
 - spec/cassettes/OpenStax_Exchange_RealClient/behaves_like_exchange_client_api_v1/_record_multiple_choice_answer/invalid_resource_string/raises_an_exception.yml
 - spec/cassettes/OpenStax_Exchange_RealClient/behaves_like_exchange_client_api_v1/_record_multiple_choice_answer/success/allows_answers_with_distinct_identifiers_to_be_saved.yml
@@ -199,7 +205,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1294391747361924928
+      hash: 911800936954346073
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -208,7 +214,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1294391747361924928
+      hash: 911800936954346073
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23.2
@@ -224,6 +230,12 @@ test_files:
 - spec/cassettes/OpenStax_Exchange_RealClient/behaves_like_exchange_client_api_v1/_initialize/invalid_platform_id/raises_an_exception.yml
 - spec/cassettes/OpenStax_Exchange_RealClient/behaves_like_exchange_client_api_v1/_initialize/invalid_platform_secret/raises_an_exception.yml
 - spec/cassettes/OpenStax_Exchange_RealClient/behaves_like_exchange_client_api_v1/_initialize/success/initializes_the_authentication_token.yml
+- spec/cassettes/OpenStax_Exchange_RealClient/behaves_like_exchange_client_api_v1/_record_grade/duplicate_identifer_resource_trial_triplet/records_the_new_grade.yml
+- spec/cassettes/OpenStax_Exchange_RealClient/behaves_like_exchange_client_api_v1/_record_grade/invalid_resource_string/raises_an_exception.yml
+- spec/cassettes/OpenStax_Exchange_RealClient/behaves_like_exchange_client_api_v1/_record_grade/success/allows_grades_for_distinct_identifiers_to_be_saved.yml
+- spec/cassettes/OpenStax_Exchange_RealClient/behaves_like_exchange_client_api_v1/_record_grade/success/allows_grades_for_distinct_resources_to_be_saved.yml
+- spec/cassettes/OpenStax_Exchange_RealClient/behaves_like_exchange_client_api_v1/_record_grade/success/allows_grades_for_distinct_trials_to_be_saved.yml
+- spec/cassettes/OpenStax_Exchange_RealClient/behaves_like_exchange_client_api_v1/_record_grade/success/records_the_exercise_grade_for_the_given_identifier.yml
 - spec/cassettes/OpenStax_Exchange_RealClient/behaves_like_exchange_client_api_v1/_record_multiple_choice_answer/duplicate_identifer_resource_trial_triplet/records_the_new_answer.yml
 - spec/cassettes/OpenStax_Exchange_RealClient/behaves_like_exchange_client_api_v1/_record_multiple_choice_answer/invalid_resource_string/raises_an_exception.yml
 - spec/cassettes/OpenStax_Exchange_RealClient/behaves_like_exchange_client_api_v1/_record_multiple_choice_answer/success/allows_answers_with_distinct_identifiers_to_be_saved.yml