scorm_engine 0.7.2 → 0.7.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a068e71a4053cf2657b2d017dad3c137bda74798e59f198badb017e2728f397f
-  data.tar.gz: '0494b968c5585104707284aa79014dbd3b4279609705d5eb7ef3823972f9d8e7'
+  metadata.gz: 196bff6485fdd38ce3e44ec9e52434e9f2bea54abfa011d352f27f8ecf871914
+  data.tar.gz: 58386090f8f6a295ac499225ff028a8e06d7db08433cd1bb696341fe33c7a0b8
 SHA512:
-  metadata.gz: 955980d7acc49984f4814c489f83d3451b0ff636fec501f10069e9ca2ba3f54e8507e304c489c3c4cb5a3ef4257df722bf6356c68c6fa0117d08e2500a3936e6
-  data.tar.gz: d3d2eaa33f15c0ad4c13ab708c79c0ad9238e515f2914b292e74926b35e32328573d981679937601bcae6e02590a95093b51e5d701a844d31c2295b0cfee7811
+  metadata.gz: 103cc84797716352274604627f5170b32c2f102af7bee0b12c1a0e83241129bd3b108f10b311303adbe2636f32f135bd3c3507f6ee21cf1bccffc904fea9db82
+  data.tar.gz: fd075fb87cea8faefb90cfba079614d0dee9fe7a2bd2c3200ed96ada9f08d66a21110fdaab47d3a8c64c06e1d68d50e717e64a475f9fac0077e8556e8a2f0c89

data/lib/scorm_engine/api/endpoints.rb

@@ -8,6 +8,7 @@ require_relative "endpoints/ping"
 require_relative "endpoints/registrations"
 require_relative "endpoints/registrations/configuration"
 require_relative "endpoints/registrations/launch_history"
+require_relative "endpoints/tenants/configuration"
 
 module ScormEngine
   module Api
@@ -22,6 +23,7 @@ module ScormEngine
       include Registrations
       include Registrations::Configuration
       include Registrations::LaunchHistory
+      include Tenants::Configuration
 
       private
 

data/lib/scorm_engine/api/endpoints/courses/configuration.rb

@@ -1,5 +1,5 @@
 #
-# TODO: Consider consolidating this and Registrations::Configuration, but only
+# TODO: Consider consolidating this and [Registrations|Tenants]::Configuration, but only
 #       after we're sure they are really 99.9% the same in terms of functionality.
 #
 module ScormEngine

data/lib/scorm_engine/api/endpoints/registrations/configuration.rb

@@ -1,5 +1,5 @@
 #
-# TODO: Consider consolidating this and Courses::Configuration, but only after we're
+# TODO: Consider consolidating this and [Courses|Tenants]::Configuration, but only after we're
 #       sure they are really 99.9% the same in terms of functionality.
 #
 module ScormEngine

data/lib/scorm_engine/api/endpoints/tenants/configuration.rb

@@ -0,0 +1,108 @@
+#
+# TODO: Consider consolidating this and [Courses|Registrations]::Configuration, but only
+#       after we're sure they are really 99.9% the same in terms of functionality.
+#
+module ScormEngine
+  module Api
+    module Endpoints
+      module Tenants
+        module Configuration
+
+          #
+          # Returns the effective value of every setting at this level, as well
+          # as the effective value of any setting at a more specific level.
+          #
+          # @see http://rustici-docs.s3.amazonaws.com/engine/2017.1.x/api.html#tenant__configuration_get
+          #
+          # @return [ScormEngine::Models::TenantConfiguration]
+          #
+          def get_tenant_configuration
+            response = get("configuration")
+
+            result = response.success? ? ScormEngine::Models::TenantConfiguration.new_from_api(response.body) : nil
+
+            Response.new(raw_response: response, result: result)
+          end
+
+          #
+          # Bulk set configuration settings via POST request.
+          #
+          # @see http://rustici-docs.s3.amazonaws.com/engine/2017.1.x/api.html#tenant__configuration_post
+          #
+          # @param [Hash] options
+          #
+          # @option options [Hash] :settings
+          #   Key/value pairs of configuration options to set.
+          #
+          # @return [ScormEngine::Response]
+          #
+          def post_tenant_configuration(options = {})
+            require_options(options, :settings)
+
+            options = options.dup
+            settings = options.delete(:settings)
+
+            body = { settings: settings.map { |k, v| { "settingId" => k, "value" => v.to_s } } }
+
+            response = post("configuration", options, body)
+
+            Response.new(raw_response: response)
+          end
+
+          #
+          # Returns the effective value for this configuration setting for the resource being configured.
+          #
+          # @see http://rustici-docs.s3.amazonaws.com/engine/2017.1.x/api.html#tenant__configuration__settingId__get
+          #
+          # @param [Hash] options
+          #
+          # @option options [String] :setting_id
+          #   The ID of the setting to get.
+          #
+          # @return [String]
+          #
+          def get_tenant_configuration_setting(options = {})
+            require_options(options, :setting_id)
+
+            options = options.dup
+            setting_id = options.delete(:setting_id)
+
+            response = get("configuration/#{setting_id}", options)
+
+            result = response.success? ? response.body["value"] : nil
+
+            Response.new(raw_response: response, result: result)
+          end
+
+          #
+          # Sets the value for this configuration setting, for the resource being configured.
+          #
+          # @see http://rustici-docs.s3.amazonaws.com/engine/2017.1.x/api.html#tenant__configuration__settingId__put
+          #
+          # @param [Hash] options
+          #
+          # @option options [String] :setting_id
+          #   The ID of the setting to set.
+          #
+          # @option options [String] :value ("")
+          #   The value of the setting to set.
+          #
+          # @return [ScormEngine::Response]
+          #
+          def put_tenant_configuration_setting(options = {})
+            require_options(options, :setting_id)
+
+            options = options.dup
+            setting_id = options.delete(:setting_id)
+
+            body = { value: options.delete(:value).to_s }
+
+            response = put("configuration/#{setting_id}", options, body)
+
+            Response.new(raw_response: response)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/scorm_engine/models.rb

@@ -12,3 +12,4 @@ require_relative "models/registration_activity_detail"
 require_relative "models/registration_configuration"
 require_relative "models/registration_launch_history"
 require_relative "models/registration_runtime_interaction"
+require_relative "models/tenant_configuration"

data/lib/scorm_engine/models/tenant_configuration.rb

@@ -0,0 +1,34 @@
+module ScormEngine
+  module Models
+    class TenantConfiguration < Base
+      # @attr
+      #
+      # @return [Hash]
+      attr_accessor :settings
+
+      def self.new_from_api(options = {})
+        this = new
+
+        this.options = options.dup
+        this.settings = get_settings_from_api(options)
+        this
+      end
+
+      #
+      # Extract and normalize the settings from the API options.
+      #
+      # @param [Hash] options
+      #   The API options hash
+      #
+      # @return [Hash]
+      #   A hash of key/value pairs.
+      #
+      def self.get_settings_from_api(options = {})
+        options["configurationItems"].reduce({}) do |m, o|
+          m[o["id"]] = o["value"]
+          m
+        end
+      end
+    end
+  end
+end

data/lib/scorm_engine/version.rb

@@ -1,3 +1,3 @@
 module ScormEngine
-  VERSION = "0.7.2".freeze
+  VERSION = "0.7.3".freeze
 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/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/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,14 @@
 --- !ruby/object:Gem::Specification
 name: scorm_engine
 version: !ruby/object:Gem::Version
-  version: 0.7.2
+  version: 0.7.3
 platform: ruby
 authors:
 - Philip Hallstrom
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-02-15 00:00:00.000000000 Z
+date: 2019-03-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -185,6 +185,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
@@ -204,6 +205,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
@@ -367,6 +369,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
@@ -382,6 +385,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