scorm_engine 0.7.0 → 0.8.1

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

@@ -45,7 +45,7 @@ RSpec.describe ScormEngine::Api::Endpoints::Courses::Import do
     describe "successful imports" do
       it "works with a :url" do
         against_real_scorm_engine do
-          import = import_course(client: subject, course_id: "testing-url-123", url: "https://github.com/phallstrom/scorm_engine/raw/master/spec/fixtures/zip/RuntimeBasicCalls_SCORM20043rdEdition.zip")
+          import = import_course(client: subject, course_id: "testing-url-123", url: "https://github.com/instructure-bridge/scorm_engine/raw/master/spec/fixtures/zip/RuntimeBasicCalls_SCORM20043rdEdition.zip")
           aggregate_failures do
             expect(import.success?).to eq true
             expect(import.result.complete?).to eq true

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

@@ -271,7 +271,7 @@ RSpec.describe ScormEngine::Api::Endpoints::Dispatches do
     end
 
     it "works when type is SCORM12" do
-      response = subject.get_dispatch_zip(dispatch_id: dispatch_options[:dispatch_id], type: "scorm12")
+      response = subject.get_dispatch_zip(dispatch_id: dispatch_options[:dispatch_id], type: "scorm12".freeze)
       aggregate_failures do
         expect(response.success?).to eq true
         expect(response.result.type).to eq "SCORM12"
@@ -323,4 +323,50 @@ RSpec.describe ScormEngine::Api::Endpoints::Dispatches do
       end
     end
   end
+
+  describe "#get_dispatch_registration_count" do
+    before do
+      subject.delete_dispatch_registration_count(dispatch_id: dispatch_options[:dispatch_id])
+    end
+
+    let(:response) { subject.get_dispatch_registration_count(dispatch_id: dispatch_options[:dispatch_id]) }
+
+    it "is successful" do
+      expect(response.success?).to eq true
+    end
+
+    describe "results" do
+      it "sucessfully creates the dispatch attributes" do
+        dispatch = response.result
+        aggregate_failures do
+          expect(dispatch.id).to eq dispatch_options[:dispatch_id]
+          expect(dispatch.registration_count).to eq 0
+          expect(dispatch.last_reset_at).to be_a(Time)
+        end
+      end
+    end
+
+    it "fails when id is invalid" do
+      response = subject.get_dispatch_registration_count(dispatch_id: "nonexistent-dispatch")
+      aggregate_failures do
+        expect(response.success?).to eq false
+        expect(response.status).to eq 404
+        expect(response.message).to match(/No dispatches found with ID: nonexistent-dispatch/)
+        expect(response.result).to eq nil
+      end
+    end
+  end
+
+  describe "#delete_dispatch_registration_count" do
+    let(:response) { subject.delete_dispatch_registration_count(dispatch_id: dispatch_options[:dispatch_id]) }
+
+    it "is successful" do
+      expect(response.success?).to eq true
+    end
+
+    it "succeeds even when id is invalid" do
+      response = subject.delete_dispatch_registration_count(dispatch_id: "nonexistent-dispatch")
+      expect(response.success?).to eq true
+    end
+  end
 end

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

@@ -0,0 +1,126 @@
+#
+# NOTE: This spec will only run if a real scorm engine is available!
+#       This is because the results returned expose sensitive information
+#       and we'd rather they not get cached to VCR fixtures.
+#
+RSpec.describe ScormEngine::Api::Endpoints::Tenants::Configuration do
+  around do |example|
+    if scorm_engine_is_available?
+      VCR.turned_off do
+        example.run
+      end
+    else
+      warn "Not running because SCORM engine is not truly available."
+    end
+  end
+
+  let(:subject) { scorm_engine_client }
+
+  describe "#get_tenant_configuration" do
+    let(:response) { subject.get_tenant_configuration }
+
+    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?("ApiPostbackTimeoutSeconds")).to be_truthy
+          expect(settings.key?("ApiUseSignedLaunchLinks")).to be_truthy
+        end
+      end
+    end
+  end
+
+  describe "#post_tenant_configuration" do
+    let(:response) {
+      subject.post_tenant_configuration(
+        settings: { "ApiPostbackTimeoutSeconds" => "15",
+                    "ApiUseSignedLaunchLinks" => "true" }
+      )
+    }
+
+    it "is successful" do
+      expect(response.success?).to eq true
+    end
+
+    it "persists the settings" do
+      response # trigger the api
+      sleep 30
+
+      configuration = subject.get_tenant_configuration.result
+      expect(configuration.settings["ApiPostbackTimeoutSeconds"]).to eq "15"
+      expect(configuration.settings["ApiUseSignedLaunchLinks"]).to eq "true"
+
+      subject.post_tenant_configuration(
+        settings: { "ApiPostbackTimeoutSeconds" => "20",
+                    "ApiUseSignedLaunchLinks" => "false" }
+      )
+      sleep 30
+
+      configuration = subject.get_tenant_configuration.result
+      expect(configuration.settings["ApiPostbackTimeoutSeconds"]).to eq "20"
+      expect(configuration.settings["ApiUseSignedLaunchLinks"]).to eq "false"
+    end
+
+    it "fails when settings are invalid" do
+      response = subject.post_tenant_configuration(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_tenant_configuration_setting" do
+    let(:response) {
+      subject.put_tenant_configuration_setting(setting_id: "ApiPostbackTimeoutSeconds", value: 42)
+      sleep 30
+      subject.get_tenant_configuration_setting(setting_id: "ApiPostbackTimeoutSeconds")
+    }
+
+    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 setting_id is invalid" do
+      response = subject.get_tenant_configuration_setting(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/)
+      expect(response.result).to eq nil
+    end
+  end
+
+  describe "#put_tenant_configuration_setting" do
+    let(:response) { subject.put_tenant_configuration_setting(setting_id: "ApiPostbackTimeoutSeconds", value: 99) }
+
+    it "is successful" do
+      expect(response.success?).to eq true
+    end
+
+    describe "results" do
+      it "persists the changes" do
+        response # trigger the api
+        subject.put_tenant_configuration_setting(setting_id: "ApiPostbackTimeoutSeconds", value: 100)
+        new_response = subject.get_tenant_configuration_setting(setting_id: "ApiPostbackTimeoutSeconds")
+        expect(new_response.result).to eq "100"
+      end
+    end
+
+    it "fails when setting_id is invalid" do
+      response = subject.get_tenant_configuration_setting(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

data/spec/scorm_engine/faraday/connection_spec.rb

@@ -8,14 +8,32 @@ RSpec.describe ScormEngine::Faraday::Connection do
   end
 
   describe "#base_uri" do
-    let(:uri) { scorm_engine_client.base_uri }
+    {
+      1 => "https://scorm.engine/ScormEngineInterface/api/v1/",
+      2 => "https://scorm.engine/ScormEngineInterface/api/v2/",
+    }.each do |version, expected_url|
+      context "with version #{version}" do
+        let(:uri) { scorm_engine_client.base_uri(version: version) }
 
-    it "returns a URI::HTTPS instance" do
-      expect(uri).to be_a(URI::HTTPS)
+        it "returns a URI::HTTPS instance" do
+          expect(uri).to be_a(URI::HTTPS)
+        end
+
+        it "is correct given the configuration" do
+          expect(uri.to_s).to eq expected_url
+        end
+      end
     end
+  end
+
+  describe "#connection" do
+    describe "version" do
+      it "passes on to #base_uri" do
+        client = ScormEngine::Client.new(tenant: "test")
 
-    it "is correct given the configuration" do
-      expect(uri.to_s).to eq "https://scorm.engine/ScormEngineInterface/api/v1/"
+        expect(client).to receive(:base_uri).with(version: 2).and_call_original
+        client.send(:connection, { version: 2 })
+      end
     end
   end
 end

data/spec/scorm_engine/models/dispatch_registration_count_spec.rb

@@ -0,0 +1,42 @@
+RSpec.describe ScormEngine::Models::DispatchRegistrationCount do
+  describe ".new_from_api" do
+    describe ":id" do
+      it "is set" do
+        dispatch = described_class.new_from_api(
+          "id" => "dispatch-id"
+        )
+        expect(dispatch.id).to eq "dispatch-id"
+      end
+    end
+
+    describe ":registration_count" do
+      it "is set" do
+        dispatch = described_class.new_from_api(
+          "registrationCount" => "456"
+        )
+        expect(dispatch.registration_count).to eq 456
+      end
+
+      it "is set to zero when not an integer" do
+        dispatch = described_class.new_from_api(
+          "registrationCount" => "oops"
+        )
+        expect(dispatch.registration_count).to eq 0
+      end
+    end
+
+    describe ":last_reset_at" do
+      it "is set" do
+        dispatch = described_class.new_from_api(
+          "lastResetTime" => "2018-05-24T08:09:10Z"
+        )
+        expect(dispatch.last_reset_at).to eq Time.new(2018, 5, 24, 8, 9, 10, 0)
+      end
+
+      it "is set to nil if blank" do
+        dispatch = described_class.new_from_api({})
+        expect(dispatch.last_reset_at).to eq nil
+      end
+    end
+  end
+end

data/spec/scorm_engine/models/tenant_configuration_spec.rb

@@ -0,0 +1,16 @@
+RSpec.describe ScormEngine::Models::TenantConfiguration do
+  describe ".new_from_api" do
+    describe ":settings" do
+      it "a hash built from configurationItems" do
+        config = described_class.new_from_api(
+          "configurationItems" => [
+            { "id" => "Foo", "value" => "YES" },
+            { "id" => "Bar", "value" => "123" },
+          ]
+        )
+        expect(config.settings["Foo"]).to eq "YES"
+        expect(config.settings["Bar"]).to eq "123"
+      end
+    end
+  end
+end

data/spec/support/scorm_engine.rb

@@ -49,7 +49,7 @@ module ScormEngineHelpers
     if options[:pathname]
       import_options[:pathname] = options[:pathname]
     else
-      import_options[:url] = "https://github.com/phallstrom/scorm_engine/raw/master/spec/fixtures/zip/#{options[:key]}.zip"
+      import_options[:url] = "https://github.com/instructure-bridge/scorm_engine/raw/master/spec/fixtures/zip/#{options[:key]}.zip"
     end
 
     import = options[:client].post_course_import(import_options)

data/spec/support/vcr.rb

@@ -18,6 +18,7 @@ end
 INSERTED_CASSETTES = Set.new
 module CassetteReporter
   def insert_cassette(name, options = {})
+    return unless VCR.turned_on?
     INSERTED_CASSETTES << VCR::Cassette.new(name, options).file
     super
   end

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: scorm_engine
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.1
 platform: ruby
 authors:
 - Philip Hallstrom
+- Mel Green
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-10-04 00:00:00.000000000 Z
+date: 2020-09-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -16,14 +17,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.12.2
+        version: '0.12'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.12.2
+        version: '0.12'
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
   requirement: !ruby/object:Gem::Requirement
@@ -86,14 +87,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -128,14 +129,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '2.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '2.3'
 - !ruby/object:Gem::Dependency
   name: vcr
   requirement: !ruby/object:Gem::Requirement
@@ -164,9 +165,10 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
-description: Ruby Client for Rustici's SCORM Engine 2017.1 API
+description: Ruby Client for Rustici's SCORM Engine 2017.1 & 20.1 API
 email:
 - phallstrom@instructure.com
+- mgreen@instructure.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -176,6 +178,7 @@ files:
 - lib/scorm_engine.rb
 - lib/scorm_engine/api/endpoints.rb
 - lib/scorm_engine/api/endpoints/about.rb
+- lib/scorm_engine/api/endpoints/configuration.rb
 - lib/scorm_engine/api/endpoints/courses.rb
 - lib/scorm_engine/api/endpoints/courses/configuration.rb
 - lib/scorm_engine/api/endpoints/courses/import.rb
@@ -185,6 +188,7 @@ files:
 - lib/scorm_engine/api/endpoints/registrations.rb
 - lib/scorm_engine/api/endpoints/registrations/configuration.rb
 - lib/scorm_engine/api/endpoints/registrations/launch_history.rb
+- lib/scorm_engine/api/endpoints/tenants/configuration.rb
 - lib/scorm_engine/client.rb
 - lib/scorm_engine/configuration.rb
 - lib/scorm_engine/faraday/connection.rb
@@ -196,6 +200,7 @@ files:
 - lib/scorm_engine/models/course_import.rb
 - lib/scorm_engine/models/destination.rb
 - lib/scorm_engine/models/dispatch.rb
+- lib/scorm_engine/models/dispatch_registration_count.rb
 - lib/scorm_engine/models/dispatch_zip.rb
 - lib/scorm_engine/models/learner.rb
 - lib/scorm_engine/models/registration.rb
@@ -203,6 +208,7 @@ files:
 - lib/scorm_engine/models/registration_configuration.rb
 - lib/scorm_engine/models/registration_launch_history.rb
 - lib/scorm_engine/models/registration_runtime_interaction.rb
+- lib/scorm_engine/models/tenant_configuration.rb
 - lib/scorm_engine/response.rb
 - lib/scorm_engine/utils.rb
 - lib/scorm_engine/version.rb
@@ -214,6 +220,11 @@ files:
 - spec/fixtures/vcr/ScormEngine_Api_Endpoints_About/_get_about_user_count/is_successful.yml
 - spec/fixtures/vcr/ScormEngine_Api_Endpoints_About/_get_about_user_count/tracks_combined_counts.yml
 - spec/fixtures/vcr/ScormEngine_Api_Endpoints_About/_get_about_user_count/tracks_per_tenantcounts.yml
+- spec/fixtures/vcr/ScormEngine_Api_Endpoints_Configuration/_get_app_configuration/is_successful.yml
+- spec/fixtures/vcr/ScormEngine_Api_Endpoints_Configuration/_get_app_configuration/returns_settings_and_values.yml
+- spec/fixtures/vcr/ScormEngine_Api_Endpoints_Configuration/_post_app_configuration/fails_when_settings_are_invalid.yml
+- spec/fixtures/vcr/ScormEngine_Api_Endpoints_Configuration/_post_app_configuration/is_successful.yml
+- spec/fixtures/vcr/ScormEngine_Api_Endpoints_Configuration/_post_app_configuration/persists_the_settings.yml
 - spec/fixtures/vcr/ScormEngine_Api_Endpoints_Courses/_delete_course/fails_when_id_is_invalid.yml
 - spec/fixtures/vcr/ScormEngine_Api_Endpoints_Courses/_delete_course/works.yml
 - spec/fixtures/vcr/ScormEngine_Api_Endpoints_Courses/_get_course_detail/fails_when_id_is_invalid.yml
@@ -276,11 +287,17 @@ files:
 - spec/fixtures/vcr/ScormEngine_Api_Endpoints_Destinations/_put_destination/results/sucessfully_creates_the_destination_attributes.yml
 - spec/fixtures/vcr/ScormEngine_Api_Endpoints_Dispatches/_delete_dispatch/returns_success_even_when_id_is_invalid.yml
 - spec/fixtures/vcr/ScormEngine_Api_Endpoints_Dispatches/_delete_dispatch/works.yml
+- spec/fixtures/vcr/ScormEngine_Api_Endpoints_Dispatches/_delete_dispatch_registration_count/is_successful.yml
+- spec/fixtures/vcr/ScormEngine_Api_Endpoints_Dispatches/_delete_dispatch_registration_count/succeeds_even_when_id_is_invalid.yml
 - spec/fixtures/vcr/ScormEngine_Api_Endpoints_Dispatches/_get_dispatch/fails_when_id_is_invalid.yml
 - spec/fixtures/vcr/ScormEngine_Api_Endpoints_Dispatches/_get_dispatch/is_successful.yml
 - spec/fixtures/vcr/ScormEngine_Api_Endpoints_Dispatches/_get_dispatch/results/sucessfully_creates_the_dispatch_attributes.yml
 - spec/fixtures/vcr/ScormEngine_Api_Endpoints_Dispatches/_get_dispatch_enabled/is_false_when_disabled.yml
 - spec/fixtures/vcr/ScormEngine_Api_Endpoints_Dispatches/_get_dispatch_enabled/is_true_when_enabled.yml
+- spec/fixtures/vcr/ScormEngine_Api_Endpoints_Dispatches/_get_dispatch_registration_count/fails_when_id_is_invalid.yml
+- spec/fixtures/vcr/ScormEngine_Api_Endpoints_Dispatches/_get_dispatch_registration_count/is_successful.yml
+- spec/fixtures/vcr/ScormEngine_Api_Endpoints_Dispatches/_get_dispatch_registration_count/results/sucessfully_creates_the_dispatch_attributes.yml
+- spec/fixtures/vcr/ScormEngine_Api_Endpoints_Dispatches/_get_dispatch_registration_count/when_dispatch_has_registrations/knows_it_s_registration_count.yml
 - spec/fixtures/vcr/ScormEngine_Api_Endpoints_Dispatches/_get_dispatch_zip/fails_given_an_invalid_id.yml
 - spec/fixtures/vcr/ScormEngine_Api_Endpoints_Dispatches/_get_dispatch_zip/fails_given_an_invalid_type.yml
 - spec/fixtures/vcr/ScormEngine_Api_Endpoints_Dispatches/_get_dispatch_zip/works.yml
@@ -351,6 +368,7 @@ files:
 - spec/fixtures/zip/Non-working SCORM.zip
 - spec/fixtures/zip/RuntimeBasicCalls_SCORM20043rdEdition.zip
 - spec/scorm_engine/api/endpoints/about_spec.rb
+- spec/scorm_engine/api/endpoints/configuration_spec.rb
 - spec/scorm_engine/api/endpoints/courses/configuration_spec.rb
 - spec/scorm_engine/api/endpoints/courses/import_spec.rb
 - spec/scorm_engine/api/endpoints/courses_spec.rb
@@ -360,6 +378,7 @@ files:
 - spec/scorm_engine/api/endpoints/registrations/configuration_spec.rb
 - spec/scorm_engine/api/endpoints/registrations/launch_history_spec.rb
 - spec/scorm_engine/api/endpoints/registrations_spec.rb
+- spec/scorm_engine/api/endpoints/tenants/configuration_spec.rb
 - spec/scorm_engine/configuration_spec.rb
 - spec/scorm_engine/faraday/connection_spec.rb
 - spec/scorm_engine/models/base_spec.rb
@@ -367,6 +386,7 @@ files:
 - spec/scorm_engine/models/course_import_spec.rb
 - spec/scorm_engine/models/course_spec.rb
 - spec/scorm_engine/models/destination_spec.rb
+- spec/scorm_engine/models/dispatch_registration_count_spec.rb
 - spec/scorm_engine/models/dispatch_spec.rb
 - spec/scorm_engine/models/dispatch_zip_spec.rb
 - spec/scorm_engine/models/learner_spec.rb
@@ -374,6 +394,7 @@ files:
 - spec/scorm_engine/models/registration_launch_history_spec.rb
 - spec/scorm_engine/models/registration_runtime_interaction_spec.rb
 - spec/scorm_engine/models/registration_spec.rb
+- spec/scorm_engine/models/tenant_configuration_spec.rb
 - spec/scorm_engine/utils_spec.rb
 - spec/scorm_engine/version_spec.rb
 - spec/scorm_engine_spec.rb
@@ -382,7 +403,7 @@ files:
 - spec/support/scorm_engine_client.rb
 - spec/support/scorm_engine_configuration.rb
 - spec/support/vcr.rb
-homepage: https://github.com/phallstrom/scorm_engine
+homepage: https://github.com/instructure-bridge/scorm_engine
 licenses:
 - MIT
 metadata: {}
@@ -402,8 +423,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 2.7.6.2
 signing_key: 
 specification_version: 4
-summary: Ruby Client for Rustici's SCORM Engine 2017.1 API
+summary: Ruby Client for Rustici's SCORM Engine API
 test_files: []