scorm_engine 0.1.0

data/spec/fixtures/vcr/ScormEngine_Api_Endpoints_Registrations_Configuration/_put_registration_configuration_setting/is_successful.yml

@@ -0,0 +1,65 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://<SCORM_ENGINE_HOST>/ScormEngineInterface/api/v1/ScormEngineGemTesting-default/registrations/testing-golf-explained-registration-1/configuration/PlayerStatusRollupModeThresholdScore
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Content-Type:
+      - application/json
+      User-Agent:
+      - ScormEngine Ruby Gem 0.1.0
+      Authorization:
+      - Basic <BASIC_AUTH>
+  response:
+    status:
+      code: 200
+      message: ''
+    headers:
+      content-type:
+      - application/json
+      date:
+      - Wed, 25 Jul 2018 22:10:07 GMT
+      server:
+      - nginx
+      content-length:
+      - '14'
+      connection:
+      - Close
+    body:
+      encoding: UTF-8
+      string: '{"value":"80"}'
+    http_version: 
+  recorded_at: Wed, 25 Jul 2018 22:10:07 GMT
+- request:
+    method: put
+    uri: https://<SCORM_ENGINE_HOST>/ScormEngineInterface/api/v1/ScormEngineGemTesting-default/registrations/testing-golf-explained-registration-1/configuration/PlayerStatusRollupModeThresholdScore
+    body:
+      encoding: UTF-8
+      string: '{"value":"81"}'
+    headers:
+      Content-Type:
+      - application/json
+      User-Agent:
+      - ScormEngine Ruby Gem 0.1.0
+      Authorization:
+      - Basic <BASIC_AUTH>
+  response:
+    status:
+      code: 204
+      message: ''
+    headers:
+      date:
+      - Wed, 25 Jul 2018 22:10:08 GMT
+      server:
+      - nginx
+      connection:
+      - Close
+    body:
+      encoding: UTF-8
+      string: ''
+    http_version: 
+  recorded_at: Wed, 25 Jul 2018 22:10:08 GMT
+recorded_with: VCR 4.0.0

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

@@ -0,0 +1,98 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://<SCORM_ENGINE_HOST>/ScormEngineInterface/api/v1/ScormEngineGemTesting-default/registrations/testing-golf-explained-registration-1/configuration/PlayerStatusRollupModeThresholdScore
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Content-Type:
+      - application/json
+      User-Agent:
+      - ScormEngine Ruby Gem 0.1.0
+      Authorization:
+      - Basic <BASIC_AUTH>
+  response:
+    status:
+      code: 200
+      message: ''
+    headers:
+      content-type:
+      - application/json
+      date:
+      - Wed, 25 Jul 2018 22:10:12 GMT
+      server:
+      - nginx
+      content-length:
+      - '14'
+      connection:
+      - Close
+    body:
+      encoding: UTF-8
+      string: '{"value":"81"}'
+    http_version: 
+  recorded_at: Wed, 25 Jul 2018 22:10:12 GMT
+- request:
+    method: put
+    uri: https://<SCORM_ENGINE_HOST>/ScormEngineInterface/api/v1/ScormEngineGemTesting-default/registrations/testing-golf-explained-registration-1/configuration/PlayerStatusRollupModeThresholdScore
+    body:
+      encoding: UTF-8
+      string: '{"value":"82"}'
+    headers:
+      Content-Type:
+      - application/json
+      User-Agent:
+      - ScormEngine Ruby Gem 0.1.0
+      Authorization:
+      - Basic <BASIC_AUTH>
+  response:
+    status:
+      code: 204
+      message: ''
+    headers:
+      date:
+      - Wed, 25 Jul 2018 22:10:12 GMT
+      server:
+      - nginx
+      connection:
+      - Close
+    body:
+      encoding: UTF-8
+      string: ''
+    http_version: 
+  recorded_at: Wed, 25 Jul 2018 22:10:12 GMT
+- request:
+    method: get
+    uri: https://<SCORM_ENGINE_HOST>/ScormEngineInterface/api/v1/ScormEngineGemTesting-default/registrations/testing-golf-explained-registration-1/configuration/PlayerStatusRollupModeThresholdScore
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Content-Type:
+      - application/json
+      User-Agent:
+      - ScormEngine Ruby Gem 0.1.0
+      Authorization:
+      - Basic <BASIC_AUTH>
+  response:
+    status:
+      code: 200
+      message: ''
+    headers:
+      content-type:
+      - application/json
+      date:
+      - Wed, 25 Jul 2018 22:10:13 GMT
+      server:
+      - nginx
+      content-length:
+      - '14'
+      connection:
+      - Close
+    body:
+      encoding: UTF-8
+      string: '{"value":"82"}'
+    http_version: 
+  recorded_at: Wed, 25 Jul 2018 22:10:13 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

@@ -0,0 +1,38 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://<SCORM_ENGINE_HOST>/ScormEngineInterface/api/v1/ScormEngineGemTesting-default/registrations/reg-does-not-exist/launchHistory?includeHistoryLog=false
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Content-Type:
+      - application/json
+      User-Agent:
+      - ScormEngine Ruby Gem 0.1.0
+      Authorization:
+      - Basic <BASIC_AUTH>
+  response:
+    status:
+      code: 404
+      message: ''
+    headers:
+      content-type:
+      - application/json
+      date:
+      - Fri, 27 Jul 2018 23:29:58 GMT
+      server:
+      - nginx
+      vary:
+      - Accept-Encoding
+      content-length:
+      - '78'
+      connection:
+      - Close
+    body:
+      encoding: ASCII-8BIT
+      string: '{"message":"External Registration ID ''reg-does-not-exist''"}'
+    http_version: 
+  recorded_at: Fri, 27 Jul 2018 23:29:58 GMT
+recorded_with: VCR 4.0.0

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

@@ -0,0 +1,54 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://<SCORM_ENGINE_HOST>/ScormEngineInterface/api/v1/ScormEngineGemTesting-default/registrations/testing-golf-explained-registration-1/launchHistory?includeHistoryLog=false
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Content-Type:
+      - application/json
+      User-Agent:
+      - ScormEngine Ruby Gem 0.1.0
+      Authorization:
+      - Basic <BASIC_AUTH>
+  response:
+    status:
+      code: 200
+      message: ''
+    headers:
+      content-type:
+      - application/json
+      date:
+      - Fri, 27 Jul 2018 23:29:55 GMT
+      server:
+      - nginx
+      vary:
+      - Accept-Encoding
+      content-length:
+      - '321'
+      connection:
+      - Close
+    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"}]}'
+    http_version: 
+  recorded_at: Fri, 27 Jul 2018 23:29:55 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

@@ -0,0 +1,54 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://<SCORM_ENGINE_HOST>/ScormEngineInterface/api/v1/ScormEngineGemTesting-default/registrations/testing-golf-explained-registration-1/launchHistory?includeHistoryLog=false
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Content-Type:
+      - application/json
+      User-Agent:
+      - ScormEngine Ruby Gem 0.1.0
+      Authorization:
+      - Basic <BASIC_AUTH>
+  response:
+    status:
+      code: 200
+      message: ''
+    headers:
+      content-type:
+      - application/json
+      date:
+      - Fri, 27 Jul 2018 23:29:56 GMT
+      server:
+      - nginx
+      vary:
+      - Accept-Encoding
+      content-length:
+      - '321'
+      connection:
+      - Close
+    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"}]}'
+    http_version: 
+  recorded_at: Fri, 27 Jul 2018 23:29:56 GMT
+recorded_with: VCR 4.0.0

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

@@ -0,0 +1,59 @@
+RSpec.describe ScormEngine::Api::Endpoints::About do
+  describe "#get_about" do
+    let(:subject) { scorm_engine_client.get_about }
+
+    it "is successful" do
+      expect(subject.success?).to eq true
+    end
+
+    it "knows the version" do
+      expect(subject.result.version).to eq "2017.1.44.1251"
+    end
+
+    it "knows the platform" do
+      expect(subject.result.platform).to eq "Java"
+    end
+  end
+
+  describe "#get_about_user_count" do
+    let(:subject) { scorm_engine_client.get_about_user_count }
+
+    it "is successful" do
+      expect(subject.success?).to eq true
+    end
+
+    it "tracks combined counts" do
+      aggregate_failures do
+        expect(subject.result.total).to be >= 1
+        expect(subject.result.dispatched).to be >= 0
+        expect(subject.result.non_dispatched).to be >= 0
+      end
+    end
+
+    it "tracks per tenantcounts" do
+      aggregate_failures do
+        expect(subject.result.by_tenant).to be_a Hash
+        tenant = subject.result.by_tenant[scorm_engine_client.tenant.downcase]
+        expect(tenant.total).to be >= 0
+        expect(tenant.dispatched).to be >= 0
+        expect(tenant.non_dispatched).to be >= 0
+      end
+    end
+
+    it "accepts :before option" do
+      subject = scorm_engine_client.get_about_user_count(before: Time.parse("1901-01-1 00:00:00 UTC"))
+      aggregate_failures do
+        expect(subject.success?).to eq true
+        expect(subject.result.total).to eq 0
+      end
+    end
+
+    it "accepts :since option" do
+      subject = scorm_engine_client.get_about_user_count(since: Time.parse("2031-01-1 00:00:00 UTC"))
+      aggregate_failures do
+        expect(subject.success?).to eq true
+        expect(subject.result.total).to eq 0
+      end
+    end
+  end
+end

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

@@ -0,0 +1,143 @@
+RSpec.describe ScormEngine::Api::Endpoints::Courses::Configuration do
+  let(:subject) { scorm_engine_client }
+
+  before do
+    against_real_scorm_engine do
+      ensure_course_exists(client: subject, course_id: "testing-golf-explained")
+    end
+  end
+
+  describe "#get_course_configuration" do
+    let(:response) { subject.get_course_configuration(course_id: "testing-golf-explained") }
+
+    it "is successful" do
+      expect(response.success?).to eq true
+    end
+
+    describe "results" do
+      it "makes settings available as key/value pairs" do
+        settings = response.result.settings
+        aggregate_failures do
+          # just a sampling
+          expect(settings.key?("PlayerStatusRollupModeValue")).to be_truthy
+          expect(settings.key?("PlayerLaunchType")).to be_truthy
+        end
+      end
+    end
+
+    it "fails when id is invalid" 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'/)
+    end
+  end
+
+  describe "#post_course_configuration" do
+    let(:response) {
+      subject.post_course_configuration(
+        course_id: "testing-golf-explained",
+        settings: { "PlayerCaptureHistoryDetailed" => "NO",
+                    "PlayerStatusRollupModeThresholdScore" => 80 }
+      )
+    }
+
+    it "is successful" do
+      expect(response.success?).to eq true
+    end
+
+    it "persists the settings" do
+      response # trigger the api
+      configuration = subject.get_course_configuration(course_id: "testing-golf-explained").result
+      expect(configuration.settings["PlayerCaptureHistoryDetailed"]).to eq "NO"
+      expect(configuration.settings["PlayerStatusRollupModeThresholdScore"]).to eq "80"
+
+      subject.post_course_configuration(
+        course_id: "testing-golf-explained",
+        settings: { "PlayerCaptureHistoryDetailed" => "YES",
+                    "PlayerStatusRollupModeThresholdScore" => 42 }
+      )
+
+      configuration = subject.get_course_configuration(course_id: "testing-golf-explained").result
+      expect(configuration.settings["PlayerCaptureHistoryDetailed"]).to eq "YES"
+      expect(configuration.settings["PlayerStatusRollupModeThresholdScore"]).to eq "42"
+    end
+
+    it "fails when id is invalid" 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'/)
+    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/)
+    end
+  end
+
+  describe "#get_course_configuration_setting" do
+    let(:response) {
+      subject.put_course_configuration_setting(course_id: "testing-golf-explained", setting_id: "PlayerStatusRollupModeThresholdScore", value: 42)
+      subject.get_course_configuration_setting(course_id: "testing-golf-explained", setting_id: "PlayerStatusRollupModeThresholdScore")
+    }
+
+    it "is successful" do
+      expect(response.success?).to eq true
+    end
+
+    describe "results" do
+      it "returns the value as a string" do
+        expect(response.result).to eq "42"
+      end
+    end
+
+    it "fails when course_id is invalid" 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'/)
+    end
+
+    it "fails when setting_id is invalid" do
+      response = subject.get_course_configuration_setting(course_id: "testing-golf-explained", setting_id: "NonExistentSettingTotesBogus")
+      expect(response.success?).to eq false
+      expect(response.status).to eq 400
+      expect(response.message).to match(/No configuration setting found with id.*NonExistentSettingTotesBogus/)
+    end
+  end
+
+  describe "#put_course_configuration_setting" do
+    let(:value) { subject.get_course_configuration_setting(course_id: "testing-golf-explained", setting_id: "PlayerStatusRollupModeThresholdScore").result }
+    let(:new_value) { (value.to_i + 1).to_s }
+    let(:response) { subject.put_course_configuration_setting(course_id: "testing-golf-explained", setting_id: "PlayerStatusRollupModeThresholdScore", value: new_value) }
+
+    it "is successful" do
+      expect(response.success?).to eq true
+    end
+
+    describe "results" do
+      it "persists the changes" do
+        response # trigger the api
+        new_response = subject.get_course_configuration_setting(course_id: "testing-golf-explained", setting_id: "PlayerStatusRollupModeThresholdScore")
+        expect(new_response.result).to eq new_value
+      end
+    end
+
+    it "fails when course_id is invalid" 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'/)
+    end
+
+    it "fails when setting_id is invalid" do
+      response = subject.get_course_configuration_setting(course_id: "testing-golf-explained", setting_id: "NonExistentSettingTotesBogus", value: "42")
+      expect(response.success?).to eq false
+      expect(response.status).to eq 400
+      expect(response.message).to match(/No configuration setting found with id.*NonExistentSettingTotesBogus/)
+    end
+  end
+end