scorm_engine 0.7.3 → 0.9.0

data/spec/fixtures/vcr/ScormEngine_Api_Endpoints_Registrations_Configuration/_put_registration_configuration_setting/results/persists_the_changes.yml

@@ -7,32 +7,42 @@ http_interactions:
       encoding: US-ASCII
       string: ''
     headers:
-      Content-Type:
-      - application/json
       User-Agent:
-      - ScormEngine Ruby Gem 0.1.0
+      - ScormEngine Ruby Gem 0.8.2
       Authorization:
       - Basic <BASIC_AUTH>
   response:
     status:
       code: 200
-      message: ''
+      message: OK
     headers:
       content-type:
       - application/json
-      date:
-      - Wed, 25 Jul 2018 22:10:12 GMT
-      server:
-      - nginx
       content-length:
       - '14'
       connection:
-      - Close
+      - close
+      date:
+      - Tue, 10 Nov 2020 22:58:37 GMT
+      p3p:
+      - CP="NOI"
+      server:
+      - Apache
+      x-xss-protection:
+      - 1; mode=block
+      x-cache:
+      - Miss from cloudfront
+      via:
+      - 1.1 8c71f944838e56d18361877af4839d5f.cloudfront.net (CloudFront)
+      x-amz-cf-pop:
+      - SLC50-C1
+      x-amz-cf-id:
+      - r40MEfXi2Ky5WM-Ug9lViGm6tTms7LiPS07vDqoeaRl4G0PvD0rSzg==
     body:
       encoding: UTF-8
       string: '{"value":"81"}'
     http_version: 
-  recorded_at: Wed, 25 Jul 2018 22:10:12 GMT
+  recorded_at: Tue, 10 Nov 2020 22:58:37 GMT
 - request:
     method: put
     uri: https://<SCORM_ENGINE_HOST>/ScormEngineInterface/api/v1/ScormEngineGemTesting-default/registrations/testing-golf-explained-registration-1/configuration/PlayerStatusRollupModeThresholdScore
@@ -40,28 +50,40 @@ http_interactions:
       encoding: UTF-8
       string: '{"value":"82"}'
     headers:
-      Content-Type:
-      - application/json
       User-Agent:
-      - ScormEngine Ruby Gem 0.1.0
+      - ScormEngine Ruby Gem 0.8.2
       Authorization:
       - Basic <BASIC_AUTH>
+      Content-Type:
+      - application/json
   response:
     status:
       code: 204
-      message: ''
+      message: No Content
     headers:
+      connection:
+      - close
       date:
-      - Wed, 25 Jul 2018 22:10:12 GMT
+      - Tue, 10 Nov 2020 22:58:37 GMT
+      p3p:
+      - CP="NOI"
       server:
-      - nginx
-      connection:
-      - Close
+      - Apache
+      x-xss-protection:
+      - 1; mode=block
+      x-cache:
+      - Miss from cloudfront
+      via:
+      - 1.1 784c61a450d9d48ba54eb73f4a51e6db.cloudfront.net (CloudFront)
+      x-amz-cf-pop:
+      - SLC50-C1
+      x-amz-cf-id:
+      - lzKWSYxDo1mdzTJ9cEwCWNYsn3G5LyncyeFu5ypNWRiI1Nr1ImOkqQ==
     body:
       encoding: UTF-8
       string: ''
     http_version: 
-  recorded_at: Wed, 25 Jul 2018 22:10:12 GMT
+  recorded_at: Tue, 10 Nov 2020 22:58:37 GMT
 - request:
     method: get
     uri: https://<SCORM_ENGINE_HOST>/ScormEngineInterface/api/v1/ScormEngineGemTesting-default/registrations/testing-golf-explained-registration-1/configuration/PlayerStatusRollupModeThresholdScore
@@ -69,30 +91,40 @@ http_interactions:
       encoding: US-ASCII
       string: ''
     headers:
-      Content-Type:
-      - application/json
       User-Agent:
-      - ScormEngine Ruby Gem 0.1.0
+      - ScormEngine Ruby Gem 0.8.2
       Authorization:
       - Basic <BASIC_AUTH>
   response:
     status:
       code: 200
-      message: ''
+      message: OK
     headers:
       content-type:
       - application/json
-      date:
-      - Wed, 25 Jul 2018 22:10:13 GMT
-      server:
-      - nginx
       content-length:
       - '14'
       connection:
-      - Close
+      - close
+      date:
+      - Tue, 10 Nov 2020 22:58:37 GMT
+      p3p:
+      - CP="NOI"
+      server:
+      - Apache
+      x-xss-protection:
+      - 1; mode=block
+      x-cache:
+      - Miss from cloudfront
+      via:
+      - 1.1 42388efa0b39dd5e33d371d553418dbf.cloudfront.net (CloudFront)
+      x-amz-cf-pop:
+      - SLC50-C1
+      x-amz-cf-id:
+      - m_aNNMbyqPsaKRoAbzCMw1_N7jB4S3_JkBdkff_VlFcIKxR-2Hzu9g==
     body:
       encoding: UTF-8
       string: '{"value":"82"}'
     http_version: 
-  recorded_at: Wed, 25 Jul 2018 22:10:13 GMT
+  recorded_at: Tue, 10 Nov 2020 22:58:37 GMT
 recorded_with: VCR 4.0.0

data/spec/fixtures/vcr/ScormEngine_Api_Endpoints_Registrations_LaunchHistory/_get_registration_launch_history/fails_when_registration_does_not_exist.yml

@@ -7,32 +7,40 @@ http_interactions:
       encoding: US-ASCII
       string: ''
     headers:
-      Content-Type:
-      - application/json
       User-Agent:
-      - ScormEngine Ruby Gem 0.1.0
+      - ScormEngine Ruby Gem 0.8.2
       Authorization:
       - Basic <BASIC_AUTH>
   response:
     status:
       code: 404
-      message: ''
+      message: Not Found
     headers:
       content-type:
       - application/json
-      date:
-      - Fri, 27 Jul 2018 23:29:58 GMT
-      server:
-      - nginx
-      vary:
-      - Accept-Encoding
       content-length:
-      - '78'
+      - '65'
       connection:
-      - Close
+      - close
+      date:
+      - Tue, 10 Nov 2020 22:57:34 GMT
+      p3p:
+      - CP="NOI"
+      server:
+      - Apache
+      x-xss-protection:
+      - 1; mode=block
+      x-cache:
+      - Error from cloudfront
+      via:
+      - 1.1 94fe3b4b13cd22608780ecba80f5ca65.cloudfront.net (CloudFront)
+      x-amz-cf-pop:
+      - SLC50-C1
+      x-amz-cf-id:
+      - Z_hmzRhoz8f6wgrMt5qTs6o43BqSG0KzORNq73edjnymllT6EDst0g==
     body:
-      encoding: ASCII-8BIT
-      string: '{"message":"External Registration ID ''reg-does-not-exist''"}'
+      encoding: UTF-8
+      string: '{"message":"Registration ID ''reg-does-not-exist'' does not exist"}'
     http_version: 
-  recorded_at: Fri, 27 Jul 2018 23:29:58 GMT
+  recorded_at: Tue, 10 Nov 2020 22:57:35 GMT
 recorded_with: VCR 4.0.0

data/spec/fixtures/vcr/ScormEngine_Api_Endpoints_Registrations_LaunchHistory/_get_registration_launch_history/is_successful.yml

@@ -7,48 +7,40 @@ http_interactions:
       encoding: US-ASCII
       string: ''
     headers:
-      Content-Type:
-      - application/json
       User-Agent:
-      - ScormEngine Ruby Gem 0.1.0
+      - ScormEngine Ruby Gem 0.8.2
       Authorization:
       - Basic <BASIC_AUTH>
   response:
     status:
       code: 200
-      message: ''
+      message: OK
     headers:
       content-type:
       - application/json
-      date:
-      - Fri, 27 Jul 2018 23:29:55 GMT
-      server:
-      - nginx
-      vary:
-      - Accept-Encoding
       content-length:
-      - '321'
+      - '20'
       connection:
-      - Close
+      - close
+      date:
+      - Tue, 10 Nov 2020 22:57:35 GMT
+      p3p:
+      - CP="NOI"
+      server:
+      - Apache
+      x-xss-protection:
+      - 1; mode=block
+      x-cache:
+      - Miss from cloudfront
+      via:
+      - 1.1 7a609f410daa3b15339ef0cc23dbb296.cloudfront.net (CloudFront)
+      x-amz-cf-pop:
+      - SLC50-C1
+      x-amz-cf-id:
+      - mGgWJgrKb-04tMZh0gamYF2jMpDDomnNG_RCoLwmz938XhnisInq_Q==
     body:
-      encoding: ASCII-8BIT
-      string: '{"launchHistory":[{"id":"testing-golf-explained-registration-1","instanceId":0.0,"launchTime":"07/25/2018
-        20:41:26 PM","launchTimeUtc":"07/25/2018 20:41:26 PM","exitTime":"07/25/2018
-        20:41:36 PM","exitTimeUtc":"07/25/2018 20:41:36 PM","completionStatus":"Incomplete","successStatus":"Failed","totalSecondsTracked
-        ":25.7,"lastRuntimeUpdate":"07/25/2018 20:41:36 PM","lastRuntimeUpdateUtc":"07/25/2018
-        20:41:36 PM"},{"id":"testing-golf-explained-registration-1","instanceId":0.0,"launchTime":"07/25/2018
-        20:02:14 PM","launchTimeUtc":"07/25/2018 20:02:14 PM","exitTime":"07/25/2018
-        20:02:24 PM","exitTimeUtc":"07/25/2018 20:02:24 PM","completionStatus":"Incomplete","successStatus":"Failed","totalSecondsTracked
-        ":19.3,"lastRuntimeUpdate":"07/25/2018 20:02:24 PM","lastRuntimeUpdateUtc":"07/25/2018
-        20:02:24 PM"},{"id":"testing-golf-explained-registration-1","instanceId":0.0,"launchTime":"07/25/2018
-        20:02:02 PM","launchTimeUtc":"07/25/2018 20:02:02 PM","exitTime":"07/25/2018
-        20:02:14 PM","exitTimeUtc":"07/25/2018 20:02:14 PM","completionStatus":"Incomplete","successStatus":"Failed","totalSecondsTracked
-        ":13.94,"lastRuntimeUpdate":"07/25/2018 20:02:14 PM","lastRuntimeUpdateUtc":"07/25/2018
-        20:02:14 PM"},{"id":"testing-golf-explained-registration-1","instanceId":0.0,"launchTime":"07/25/2018
-        20:01:49 PM","launchTimeUtc":"07/25/2018 20:01:49 PM","exitTime":"07/25/2018
-        20:01:59 PM","exitTimeUtc":"07/25/2018 20:01:59 PM","completionStatus":"Incomplete","successStatus":"Failed","totalSecondsTracked
-        ":6.77,"lastRuntimeUpdate":"07/25/2018 20:01:59 PM","lastRuntimeUpdateUtc":"07/25/2018
-        20:01:59 PM"}]}'
+      encoding: UTF-8
+      string: '{"launchHistory":[]}'
     http_version: 
-  recorded_at: Fri, 27 Jul 2018 23:29:55 GMT
+  recorded_at: Tue, 10 Nov 2020 22:57:36 GMT
 recorded_with: VCR 4.0.0

data/spec/fixtures/vcr/ScormEngine_Api_Endpoints_Registrations_LaunchHistory/_get_registration_launch_history/returns_an_array_of_registration_launch_histories.yml

@@ -7,48 +7,40 @@ http_interactions:
       encoding: US-ASCII
       string: ''
     headers:
-      Content-Type:
-      - application/json
       User-Agent:
-      - ScormEngine Ruby Gem 0.1.0
+      - ScormEngine Ruby Gem 0.8.2
       Authorization:
       - Basic <BASIC_AUTH>
   response:
     status:
       code: 200
-      message: ''
+      message: OK
     headers:
       content-type:
       - application/json
-      date:
-      - Fri, 27 Jul 2018 23:29:56 GMT
-      server:
-      - nginx
-      vary:
-      - Accept-Encoding
       content-length:
-      - '321'
+      - '20'
       connection:
-      - Close
+      - close
+      date:
+      - Tue, 10 Nov 2020 22:57:36 GMT
+      p3p:
+      - CP="NOI"
+      server:
+      - Apache
+      x-xss-protection:
+      - 1; mode=block
+      x-cache:
+      - Miss from cloudfront
+      via:
+      - 1.1 ec99de6a8df96b4e008b942ab98e6595.cloudfront.net (CloudFront)
+      x-amz-cf-pop:
+      - SLC50-C1
+      x-amz-cf-id:
+      - hYt9UJ6CvCcSUeM2YDx903U1mq8Do7gqevakWTL2RG8ue_pNLBCd6A==
     body:
-      encoding: ASCII-8BIT
-      string: '{"launchHistory":[{"id":"testing-golf-explained-registration-1","instanceId":0.0,"launchTime":"07/25/2018
-        20:41:26 PM","launchTimeUtc":"07/25/2018 20:41:26 PM","exitTime":"07/25/2018
-        20:41:36 PM","exitTimeUtc":"07/25/2018 20:41:36 PM","completionStatus":"Incomplete","successStatus":"Failed","totalSecondsTracked
-        ":25.7,"lastRuntimeUpdate":"07/25/2018 20:41:36 PM","lastRuntimeUpdateUtc":"07/25/2018
-        20:41:36 PM"},{"id":"testing-golf-explained-registration-1","instanceId":0.0,"launchTime":"07/25/2018
-        20:02:14 PM","launchTimeUtc":"07/25/2018 20:02:14 PM","exitTime":"07/25/2018
-        20:02:24 PM","exitTimeUtc":"07/25/2018 20:02:24 PM","completionStatus":"Incomplete","successStatus":"Failed","totalSecondsTracked
-        ":19.3,"lastRuntimeUpdate":"07/25/2018 20:02:24 PM","lastRuntimeUpdateUtc":"07/25/2018
-        20:02:24 PM"},{"id":"testing-golf-explained-registration-1","instanceId":0.0,"launchTime":"07/25/2018
-        20:02:02 PM","launchTimeUtc":"07/25/2018 20:02:02 PM","exitTime":"07/25/2018
-        20:02:14 PM","exitTimeUtc":"07/25/2018 20:02:14 PM","completionStatus":"Incomplete","successStatus":"Failed","totalSecondsTracked
-        ":13.94,"lastRuntimeUpdate":"07/25/2018 20:02:14 PM","lastRuntimeUpdateUtc":"07/25/2018
-        20:02:14 PM"},{"id":"testing-golf-explained-registration-1","instanceId":0.0,"launchTime":"07/25/2018
-        20:01:49 PM","launchTimeUtc":"07/25/2018 20:01:49 PM","exitTime":"07/25/2018
-        20:01:59 PM","exitTimeUtc":"07/25/2018 20:01:59 PM","completionStatus":"Incomplete","successStatus":"Failed","totalSecondsTracked
-        ":6.77,"lastRuntimeUpdate":"07/25/2018 20:01:59 PM","lastRuntimeUpdateUtc":"07/25/2018
-        20:01:59 PM"}]}'
+      encoding: UTF-8
+      string: '{"launchHistory":[]}'
     http_version: 
-  recorded_at: Fri, 27 Jul 2018 23:29:56 GMT
+  recorded_at: Tue, 10 Nov 2020 22:57:36 GMT
 recorded_with: VCR 4.0.0

data/spec/scorm_engine/api/endpoints/about_spec.rb

@@ -7,7 +7,7 @@ RSpec.describe ScormEngine::Api::Endpoints::About do
     end
 
     it "knows the version" do
-      expect(subject.result.version).to eq "2017.1.47.1282"
+      expect(subject.result.version).to eq "20.1.12.336"
     end
 
     it "knows the platform" do

data/spec/scorm_engine/api/endpoints/configuration_spec.rb

@@ -0,0 +1,82 @@
+RSpec.describe ScormEngine::Api::Endpoints::Configuration do
+  describe "#get_app_configuration" do
+    let(:subject) { scorm_engine_client.get_app_configuration }
+
+    it "is successful" do
+      expect(subject.success?).to eq true
+    end
+
+    it "returns settings and values" do
+      expect(subject.result.UserCountReportLookBackDays).to be_truthy
+      expect(subject.result["UserCountReportDaysBetweenReports"]).to be_truthy
+    end
+
+    describe "includeMetadata" do
+      let(:subject) { scorm_engine_client.get_app_configuration(includeMetadata: true) }
+
+      it "is successful" do
+        expect(subject.success?).to eq true
+      end
+
+      it "returns metadata in raw_response when included in options" do
+        expect(subject.raw_response.body["settingItems"].first["metadata"]).to_not be_nil
+      end
+    end
+  end
+
+  describe "#post_app_configuration" do
+    let(:subject) { scorm_engine_client }
+    let(:response) {
+      subject.post_app_configuration(
+        settings: { "UserCountReportLookBackDays" => "90",
+                    "UserCountReportDaysBetweenReports" => 20 }
+      )
+    }
+
+    it "is successful" do
+      expect(response.success?).to eq true
+    end
+
+    it "persists the settings" do
+      response # trigger the api
+      configuration = subject.get_app_configuration.result
+      expect(configuration["UserCountReportLookBackDays"]).to eq "90"
+      expect(configuration["UserCountReportDaysBetweenReports"]).to eq "20"
+
+      subject.post_app_configuration(
+        settings: { "UserCountReportLookBackDays" => "365",
+                    "UserCountReportDaysBetweenReports" => 30 }
+      )
+
+      sleep 3 # there seems to be a delay between posting new values and when they're updated frd
+
+      configuration = subject.get_app_configuration.result
+      expect(configuration["UserCountReportLookBackDays"]).to eq "365"
+      expect(configuration["UserCountReportDaysBetweenReports"]).to eq "30"
+    end
+
+    it "fails when settings are invalid" do
+      response = subject.post_app_configuration(settings: { "NonExistentSettingTotesBogus" => "YES" })
+      expect(response.success?).to eq false
+      expect(response.status).to eq 400
+      expect(response.message).to match(/NonExistentSettingTotesBogus is not a valid setting ID/)
+    end
+  end
+
+  describe "#delete_app_configuration" do
+    let(:subject) { scorm_engine_client }
+    let(:response) {
+      subject.delete_app_configuration(setting_id: "UserCountReportLookBackDays")
+    }
+
+    it "is successful" do
+      expect(response.success?).to eq true
+    end
+    it "fails when settings are invalid" do
+      response = subject.delete_app_configuration(setting_id: "NonExistentSettingTotesBogus")
+      expect(response.success?).to eq false
+      expect(response.status).to eq 400
+      expect(response.message).to match(/NonExistentSettingTotesBogus/)
+    end
+  end
+end

data/spec/scorm_engine/api/endpoints/courses/configuration_spec.rb

@@ -29,7 +29,7 @@ RSpec.describe ScormEngine::Api::Endpoints::Courses::Configuration do
       response = subject.get_course_configuration(course_id: "nonexistent-course")
       expect(response.success?).to eq false
       expect(response.status).to eq 404
-      expect(response.message).to match(/External Package ID 'nonexistent-course'/)
+      expect(response.message).to match(/'nonexistent-course'/)
       expect(response.result).to eq nil
     end
   end
@@ -68,14 +68,14 @@ RSpec.describe ScormEngine::Api::Endpoints::Courses::Configuration do
       response = subject.post_course_configuration(course_id: "nonexistent-course", settings: {})
       expect(response.success?).to eq false
       expect(response.status).to eq 404
-      expect(response.message).to match(/External Package ID 'nonexistent-course'/)
+      expect(response.message).to match(/'nonexistent-course'/)
     end
 
     it "fails when settings are invalid" do
       response = subject.post_course_configuration(course_id: "testing-golf-explained", settings: { "NonExistentSettingTotesBogus" => "YES" })
       expect(response.success?).to eq false
       expect(response.status).to eq 400
-      expect(response.message).to match(/No configuration setting found with id.*NonExistentSettingTotesBogus/)
+      expect(response.message).to match(/NonExistentSettingTotesBogus/)
     end
   end
 
@@ -99,7 +99,7 @@ RSpec.describe ScormEngine::Api::Endpoints::Courses::Configuration do
       response = subject.get_course_configuration_setting(course_id: "nonexistent-course", setting_id: "PlayerStatusRollupModeThresholdScore")
       expect(response.success?).to eq false
       expect(response.status).to eq 404
-      expect(response.message).to match(/External Package ID 'nonexistent-course'/)
+      expect(response.message).to match(/'nonexistent-course'/)
       expect(response.result).to eq nil
     end
 
@@ -133,7 +133,7 @@ RSpec.describe ScormEngine::Api::Endpoints::Courses::Configuration do
       response = subject.put_course_configuration_setting(course_id: "nonexistent-course", setting_id: "PlayerStatusRollupModeThresholdScore", value: "42")
       expect(response.success?).to eq false
       expect(response.status).to eq 404
-      expect(response.message).to match(/External Package ID 'nonexistent-course'/)
+      expect(response.message).to match(/'nonexistent-course'/)
     end
 
     it "fails when setting_id is invalid" do