scorm_engine 0.7.0 → 0.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 96f9e3115cb5345e489c54e9d49ac10dd67b1b2bb7dbd30878a222c5eca3dde5
-  data.tar.gz: a64f2c8ce1dcc564e71d06a020324e947406020e5930f24a5f59b91b377d47c5
+  metadata.gz: 125a0882006861786fcc335c3656cd75b69d832669ae34c9b7e6a93969137580
+  data.tar.gz: f33e66667a0866bf8bf133c6a0a9cddcca990a02e4737fc2c4f7f1ef53ecac6e
 SHA512:
-  metadata.gz: 15dae198e937cfe18146767424e8361a7464372137dda3123a78cabcd87f3b9d0d2da92e566dfa82f942f3955caff1246160311ea403a2afb084fd95f5503ba9
-  data.tar.gz: 189edb44a0f257a82336efdb39e4876b47c16a021cc49d81db2644aac2068167d7b06193e80e52dfc0fc4c1866d1ce635f5f8564c32958cbccab013bb8c46d1b
+  metadata.gz: 2b845922b85e20a822b7d519e1d919ce61333c89da2525a9eb3d37ace034b1e525a53a43a77229eb8804179f25ff541c4afcbd1ccff4851f140cbb48e301ceb6
+  data.tar.gz: d221c2aee2b0761b9ce568bf428c724ba7451224bf74e96a5ad6610ff89e8174fdcf2350b1089ba923f2d3576a9eb2e2aa99edfcf17e781fc709556b9ba37399

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,64 @@
+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
+            response = get("appManagement/configuration")
+
+            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
+      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/dispatches.rb

@@ -272,8 +272,7 @@ module ScormEngine
 
           options = options.dup
           dispatch_id = options.delete(:dispatch_id)
-          options[:type] ||= "SCORM12"
-          options[:type]&.upcase!
+          options[:type] = options[:type]&.upcase || "SCORM12"
 
           response = get("dispatches/#{dispatch_id}/zip", options)
 
@@ -289,6 +288,49 @@ module ScormEngine
           Response.new(raw_response: response, result: result)
         end
 
+        #
+        # Get the registration count and last reset time of a dispatch.
+        #
+        # @see http://rustici-docs.s3.amazonaws.com/engine/2017.1.x.dispatch/api-dispatch.html#tenant__dispatches__dispatchId__registrationCount_get
+        #
+        # @param [Hash] options
+        #
+        # @option options [String] :dispatch_id
+        #   The ID of the dispatch to get.
+        #
+        # @return [ScormEngine::Models::DispatchRegistrationCount]
+        #
+        def get_dispatch_registration_count(options = {})
+          require_options(options, :dispatch_id)
+
+          response = get("dispatches/#{options[:dispatch_id]}/registrationCount")
+
+          # merge options to pick up dispatch_id which isn't passed back in the response
+          result = response.success? ? ScormEngine::Models::DispatchRegistrationCount.new_from_api({ "id" => options[:dispatch_id] }.merge(response.body)) : nil
+
+          Response.new(raw_response: response, result: result)
+        end
+
+        #
+        # Reset the registration count and last reset time of a dispatch.
+        #
+        # @see http://rustici-docs.s3.amazonaws.com/engine/2017.1.x.dispatch/api-dispatch.html#tenant__dispatches__dispatchId__registrationCount_delete
+        #
+        # @param [Hash] options
+        #
+        # @option options [String] :dispatch_id
+        #   The ID of the dispatch to get.
+        #
+        # @return [ScormEngine::Response]
+        #
+        def delete_dispatch_registration_count(options = {})
+          require_options(options, :dispatch_id)
+
+          response = delete("dispatches/#{options[:dispatch_id]}/registrationCount")
+
+          Response.new(raw_response: response)
+        end
+
         private
 
         def coerce_dispatch_options(options = {})
@@ -301,6 +343,7 @@ module ScormEngine
 
         def coerce_expiration_date(date)
           return date if date == "none"
+
           date = date.is_a?(String) ? Date.parse(date) : date
           date&.iso8601 # might be nil
         rescue ArgumentError # unparsable date string

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,28 @@ 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 qualified
+            path = "#{tenant}/#{path}" unless path =~ %r{\Ahttps?://}
+          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

@@ -4,6 +4,7 @@ require_relative "models/course_configuration"
 require_relative "models/course_import"
 require_relative "models/destination"
 require_relative "models/dispatch"
+require_relative "models/dispatch_registration_count"
 require_relative "models/dispatch_zip"
 require_relative "models/learner"
 require_relative "models/registration"
@@ -11,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/dispatch_registration_count.rb

@@ -0,0 +1,49 @@
+require "date"
+
+module ScormEngine
+  module Models
+    class DispatchRegistrationCount < Base
+      # @attr
+      # The external identification of this dispatch.
+      # @return [String]
+      attr_accessor :id
+
+      # @attr
+      # The registration count for this dispatch.
+      # @return [Integer]
+      attr_accessor :registration_count
+
+      # @attr
+      # The date and time of the last count reset, if any.
+      # @return [DateTime]
+      attr_accessor :last_reset_at
+
+      def self.new_from_api(options = {})
+        this = new
+
+        this.options = options.dup
+        this.id = options["id"]
+        this.registration_count = options["registrationCount"].to_i
+        this.last_reset_at = get_last_reset_time(options)
+
+        this
+      end
+
+      #
+      # Extract and normalize the last reset datetime from the API options.
+      #
+      # @param [Hash] options
+      #   The API options hash
+      #
+      # @return [Time]
+      #   a date/time or nil if undefined.
+      #
+      def self.get_last_reset_time(options = {})
+        time = options["lastResetTime"]
+        return if time.nil? || time == "none"
+
+        Time.parse(time)
+      end
+    end
+  end
+end

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