scorm_engine 0.7.2 → 0.8.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a068e71a4053cf2657b2d017dad3c137bda74798e59f198badb017e2728f397f
-  data.tar.gz: '0494b968c5585104707284aa79014dbd3b4279609705d5eb7ef3823972f9d8e7'
+  metadata.gz: c6dc07764b79c2b24e72ebd15d39f1deb301eb268e2d5ac10eb1771057847e39
+  data.tar.gz: 747ccf82b2a4f489f9aa89fb4b9ac2831aa0771465f58dd8ff5ac314dff722a1
 SHA512:
-  metadata.gz: 955980d7acc49984f4814c489f83d3451b0ff636fec501f10069e9ca2ba3f54e8507e304c489c3c4cb5a3ef4257df722bf6356c68c6fa0117d08e2500a3936e6
-  data.tar.gz: d3d2eaa33f15c0ad4c13ab708c79c0ad9238e515f2914b292e74926b35e32328573d981679937601bcae6e02590a95093b51e5d701a844d31c2295b0cfee7811
+  metadata.gz: 2de6d2331954d65d497165150282dff1a0d7c604464001713ef4610b7f47e7c7f44ab4e40f17b141b6ea78173ea598b4ff636f8300462731a0538bd0fe2ffe24
+  data.tar.gz: 25d76985d84f9150114e2dcbf38de35fdcf5a51e397b64d6df59762fa7495dca52367a8e53e5029ced8822cefeafbc5a506cd6343dae1efcfe93851e125bcaec

data/lib/scorm_engine/api/endpoints.rb

@@ -1,4 +1,5 @@
 require_relative "endpoints/about"
+require_relative "endpoints/configuration"
 require_relative "endpoints/courses"
 require_relative "endpoints/courses/configuration"
 require_relative "endpoints/courses/import"
@@ -8,11 +9,13 @@ 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
     module Endpoints
       include About
+      include Configuration
       include Courses
       include Courses::Configuration
       include Courses::Import
@@ -22,6 +25,7 @@ module ScormEngine
       include Registrations
       include Registrations::Configuration
       include Registrations::LaunchHistory
+      include Tenants::Configuration
 
       private
 

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

@@ -0,0 +1,94 @@
+module ScormEngine
+  module Api
+    module Endpoints
+      module Configuration
+        #
+        # Get the application settings currently configured in Engine.
+        #
+        # @see http://rustici-docs.s3.amazonaws.com/engine/20.1.x/api/apiV2.html#/appManagement/GetApplicationConfiguration
+        #
+        # @param [Hash] options
+        #
+        # @option options [Boolean] :for_tenant
+        #   Indicates whether the configuration effective for the current tenant should be fetched.
+        #   If false or not specified, will return configuration settings for the application in general.
+        #
+        # @return [ScormEngine::Response]
+        #
+        def get_app_configuration(options = {})
+          api_v2(without_tenant: !options.fetch(:for_tenant, false)) do
+            options.delete(:for_tenant)
+
+            response = get("appManagement/configuration", options)
+
+            result = OpenStruct.new
+
+            response.body["settingItems"].each do |setting|
+              result[setting["id"]] = setting["effectiveValue"]
+            end
+
+            Response.new(raw_response: response, result: result)
+          end
+        end
+
+        #
+        # Set one or more application settings in Engine.
+        #
+        # @see http://rustici-docs.s3.amazonaws.com/engine/20.1.x/api/apiV2.html#/appManagement/SetApplicationConfiguration
+        #
+        # @param [Hash] options
+        #
+        # @option [Hash] settings
+        #   The configuration settings to be updated.
+        #
+        # @option options [Boolean] :for_tenant
+        #   Indicates whether the configuration should be set for the current tenant.
+        #   If false or not specified, will update configuration settings for the application in general.
+        #
+        # @return [ScormEngine::Response]
+        #
+        def post_app_configuration(options = {})
+          require_options(options, :settings)
+
+          api_v2(without_tenant: !options.fetch(:for_tenant, false)) do
+            settings = options.delete(:settings)
+
+            body = { settings: settings.map { |k, v| { "settingId" => k, "value" => v.to_s } } }
+
+            response = post("appManagement/configuration", {}, body)
+
+            Response.new(raw_response: response)
+          end
+        end
+
+        #
+        # Deletes the current value for a setting, reverting it to its default value.
+        #
+        # @see http://rustici-docs.s3.amazonaws.com/engine/20.1.x/api/apiV2.html#/appManagement/DeleteApplicationConfigurationSetting
+        #
+        # @param [Hash] options
+        #
+        # @option [String] setting_id
+        #   The ID for the setting to be deleted.
+        #
+        # @option options [Boolean] :for_tenant
+        #   Indicates whether the configuration should be set for the current tenant.
+        #   If false or not specified, will update configuration settings for the application in general.
+        #
+        # @return [ScormEngine::Response]
+        #
+        def delete_app_configuration(options = {})
+          require_options(options, :setting_id)
+
+          api_v2(without_tenant: !options.fetch(:for_tenant, false)) do
+            setting_id = options.delete(:setting_id)
+
+            response = delete("appManagement/configuration/#{setting_id}")
+
+            Response.new(raw_response: response)
+          end
+        end
+      end
+    end
+  end
+end

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/configuration.rb

@@ -10,8 +10,9 @@ module ScormEngine
   end
 
   class Configuration
-    # http://rustici-docs.s3.amazonaws.com/engine/2017.1.x/api.html
-    attr_accessor :protocol, :host, :path_prefix
+    # Legacy v1 API: http://rustici-docs.s3.amazonaws.com/engine/2017.1.x/api.html
+    # Latest v2 API: https://rustici-docs.s3.amazonaws.com/engine/20.1.x/api/apiV2.html
+    attr_accessor :protocol, :host, :path_prefix, :v2_path_prefix
 
     # http://rustici-docs.s3.amazonaws.com/engine/2017.1.x/Architecture-API.html#api-authentication
     attr_accessor :username, :password
@@ -28,6 +29,7 @@ module ScormEngine
       @protocol = ENV.fetch("SCORM_ENGINE_PROTOCOL", "https")
       @host = ENV["SCORM_ENGINE_HOST"]
       @path_prefix = ENV.fetch("SCORM_ENGINE_PATH_PREFIX", "/ScormEngineInterface/api/v1/")
+      @v2_path_prefix = ENV.fetch("SCORM_ENGINE_V2_PATH_PREFIX", "/ScormEngineInterface/api/v2/")
 
       @username = ENV["SCORM_ENGINE_USERNAME"]
       @password = ENV["SCORM_ENGINE_PASSWORD"]

data/lib/scorm_engine/faraday/connection.rb

@@ -5,18 +5,24 @@ module ScormEngine
   module Faraday
     module Connection
 
-      def base_uri
+      def base_uri(version: 1)
         uri = URI("")
         uri.scheme = ScormEngine.configuration.protocol
         uri.host = ScormEngine.configuration.host
-        uri.path = ScormEngine.configuration.path_prefix
+
+        uri.path = if version == 2
+                     ScormEngine.configuration.v2_path_prefix
+                   else
+                     ScormEngine.configuration.path_prefix
+                   end
+
         URI(uri.to_s) # convert URI::Generic to URI:HTTPS
       end
 
       private
 
-      def connection
-        @connection ||= ::Faraday.new(url: base_uri.to_s) do |faraday|
+      def connection(version: 1)
+        @connection ||= ::Faraday.new(url: base_uri(version: version).to_s) do |faraday|
           faraday.headers["User-Agent"] = "ScormEngine Ruby Gem #{ScormEngine::VERSION}"
 
           faraday.basic_auth(ScormEngine.configuration.username, ScormEngine.configuration.password)

data/lib/scorm_engine/faraday/request.rb

@@ -17,15 +17,30 @@ module ScormEngine
         request(:delete, path, options)
       end
 
+      def api_v2(without_tenant: false)
+        @api_version = 2
+        @without_tenant = without_tenant
+
+        yield
+      ensure
+        @api_version = 1
+      end
+
       private
 
       def request(method, path, options, body = nil)
-        # "more" pagination urls are fully qualified
-        path = "#{tenant}/#{path}" unless path =~ %r{\Ahttps?://}
+        connection(version: @api_version).send(method) do |request|
+          if @api_version == 2
+            request.headers["engineTenantName"] = tenant unless @without_tenant
+          else
+            # "more" pagination urls are fully or relatively qualified
+            unless path =~ %r{\Ahttps?://} || path.start_with?(base_uri.path)
+              path = "#{tenant}/#{path}"
+            end
+          end
 
-        options = coerce_options(options)
+          options = coerce_options(options)
 
-        connection.send(method) do |request|
           case method
           when :get, :delete
             request.url(path, options)

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.8.3".freeze
 end

data/spec/fixtures/vcr/ScormEngine_Api_Endpoints_About/_get_about/is_successful.yml

@@ -7,32 +7,41 @@ http_interactions:
       encoding: US-ASCII
       string: ''
     headers:
-      Content-Type:
-      - application/json
       User-Agent:
-      - ScormEngine Ruby Gem 0.2.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, 15 Aug 2018 23:29:16 GMT
-      server:
-      - nginx
-      vary:
-      - Accept-Encoding
       content-length:
-      - '63'
+      - '94'
       connection:
-      - Close
+      - close
+      date:
+      - Tue, 10 Nov 2020 22:57:06 GMT
+      p3p:
+      - CP="NOI"
+      server:
+      - Apache
+      x-xss-protection:
+      - 1; mode=block
+      x-cache:
+      - Miss from cloudfront
+      via:
+      - 1.1 ed42e29cddf5cc10b8ba8ca7b99004ce.cloudfront.net (CloudFront)
+      x-amz-cf-pop:
+      - SLC50-C1
+      x-amz-cf-id:
+      - CvnNxRrtMzgd98IPVo64kWtvyXuDHHB-DgN_VwUiKYHJWAss1NSAUw==
     body:
-      encoding: ASCII-8BIT
-      string: '{"version":"2017.1.47.1282","platform":"Java"}'
+      encoding: UTF-8
+      string: '{"version":"20.1.12.336","platform":"Java","distribution":"Rustici
+        Engine + Rustici Dispatch"}'
     http_version: 
-  recorded_at: Wed, 15 Aug 2018 23:29:16 GMT
+  recorded_at: Tue, 10 Nov 2020 22:57:07 GMT
 recorded_with: VCR 4.0.0