scorm_engine 0.1.0

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

@@ -0,0 +1,20 @@
+module ScormEngine
+  module Api
+    module Endpoints
+      module Ping
+        #
+        # Get back a message indicating that the API is working.
+        #
+        # @see http://rustici-docs.s3.amazonaws.com/engine/2017.1.x/api.html#tenant__ping_get
+        #
+        # @return [ScormEngine::Response]
+        #
+        def get_ping
+          response = get("ping")
+
+          Response.new(raw_response: response)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,321 @@
+module ScormEngine
+  module Api
+    module Endpoints
+      module Registrations
+
+        #
+        # Gets a list of registrations including a summary of the status of
+        # each registration.
+        #
+        # @note Note the "since" parameter exists to allow
+        #       retreiving only registrations that have changed, and the
+        #       "before" parameter exists to allow retreiving only
+        #       registrations that haven't changed.
+        #
+        # @see http://rustici-docs.s3.amazonaws.com/engine/2017.1.x/api.html#tenant__registrations_get
+        #
+        # @param [Hash] options
+        #
+        # @option options [DateTime] :before ()
+        #   Only registrations updated before the specified ISO 8601 TimeStamp (inclusive)
+        #   are included. If a time zone is not specified, the server's time zone will be
+        #   used.
+        #
+        # @option options [DateTime] :since ()
+        #   Only registrations updated since the specified ISO 8601 TimeStamp (inclusive)
+        #   are included. If a time zone is not specified, the server's time zone will be
+        #   used.
+        #
+        # @option options [String] :course_id ()
+        #   Only registrations for the specified course id will be included.
+        #
+        # @option options [String] :learner_id ()
+        #   Only registrations for the specified learner id will be included.
+        #
+        # @return [Enumerator<ScormEngine::Models::Registration>]
+        #
+        def get_registrations(options = {})
+          options = options.dup
+          options[:courseId] = options.delete(:course_id) if options.key?(:course_id)
+          options[:learnerId] = options.delete(:learner_id) if options.key?(:learner_id)
+
+          response = get("registrations", options)
+
+          result = Enumerator.new do |enum|
+            loop do
+              response.success? && response.body["registrations"].each do |registration|
+                enum << ScormEngine::Models::Registration.new_from_api(registration)
+              end
+              break if !response.success? || response.body["more"].nil?
+              response = get(response.body["more"])
+            end
+          end
+
+          Response.new(raw_response: response, result: result)
+        end
+
+        #
+        # Get all the instances of this the registration specified by the registration ID
+        #
+        # Multiple instances of a registration are created based on the value
+        # you have for the setting "WhenToRestartRegistration". By default,
+        # Engine will "restart" a registration once that registration is
+        # completed and there is a newer version of that registration's package
+        # is available. If both of those conditions are met when the
+        # registration is launched, then Engine will create a new instance for
+        # that registration.
+        #
+        # @see http://rustici-docs.s3.amazonaws.com/engine/2017.1.x/api.html#tenant__registrations__registrationId__instances_get
+        #
+        # @param [Hash] options
+        #
+        # @option options [String] :registration_id
+        #   ID for the registration.
+        #
+        # @option options [DateTime] :before ()
+        #   Only registrations updated before the specified ISO 8601 TimeStamp (inclusive)
+        #   are included. If a time zone is not specified, the server's time zone will be
+        #   used.
+        #
+        # @option options [DateTime] :since ()
+        #   Only registrations updated since the specified ISO 8601 TimeStamp (inclusive)
+        #   are included. If a time zone is not specified, the server's time zone will be
+        #   used.
+        #
+        # @return [Enumerator<ScormEngine::Models::Registration>]
+        #
+        def get_registration_instances(options = {})
+          require_options(options, :registration_id)
+
+          options = options.dup
+          registration_id = options.delete(:registration_id)
+
+          response = get("registrations/#{registration_id}/instances", options)
+
+          result = Enumerator.new do |enum|
+            loop do
+              response.success? && response.body["registrations"].each do |registration|
+                enum << ScormEngine::Models::Registration.new_from_api(registration)
+              end
+              break if !response.success? || response.body["more"].nil?
+              response = get(response.body["more"])
+            end
+          end
+
+          Response.new(raw_response: response, result: result)
+        end
+
+        #
+        # Does this registration exist? You can also use the 'instance'
+        # parameter to check if a particular instance of a registrations
+        # exists.
+        #
+        # @see http://rustici-docs.s3.amazonaws.com/engine/2017.1.x/api.html#tenant__registrations__registrationId__get
+        #
+        # @param [Hash] options
+        #
+        # @option options [String] :registration_id
+        #   ID for the registration.
+        #
+        # @option options [String] :instance ()
+        #   The instance of this registration to use. If not provided, the
+        #   latest instance will be used.
+        #
+        # @return [ScormEngine::Response]
+        #
+        def get_registration_exists(options = {})
+          require_options(options, :registration_id)
+
+          options = options.dup
+          registration_id = options.delete(:registration_id)
+
+          response = get("registrations/#{registration_id}", options)
+
+          result = response.success? && response.body["exists"]
+
+          Response.new(raw_response: response, result: result)
+        end
+
+        #
+        # Get registration summary
+        #
+        # @see http://rustici-docs.s3.amazonaws.com/engine/2017.1.x/api.html#tenant__registrations__registrationId__progress_get
+        # @see http://rustici-docs.s3.amazonaws.com/engine/2017.1.x/api.html#tenant__registrations__registrationId__progress_detail_get
+        #
+        # @param [Hash] options
+        #
+        # @option options [String] :registration_id
+        #   ID for the registration.
+        #
+        # @option options [String] :instance ()
+        #   The instance of this registration to use. If not provided, the
+        #   latest instance will be used.
+        #
+        # @option options [Boolean] :detail (false)
+        #   Whether or not to populate 'activityDetails'.
+        #
+        # @return [ScormEngine::Models::Registration]
+        #
+        def get_registration_progress(options = {})
+          require_options(options, :registration_id)
+
+          options = options.dup
+          registration_id = options.delete(:registration_id)
+          detail = !!options.delete(:detail)
+
+          url = "registrations/#{registration_id}/progress"
+          url += "/detail" if detail
+
+          response = get(url, options)
+
+          result = response.success? && ScormEngine::Models::Registration.new_from_api(response.body)
+
+          Response.new(raw_response: response, result: result)
+        end
+
+        #
+        # Delete a registration.
+        #
+        # @see http://rustici-docs.s3.amazonaws.com/engine/2017.1.x/api.html#tenant__registrations__registrationId__delete
+        #
+        # @param [Hash] options
+        #
+        # @option options [String] :registration_id
+        #   ID for the registration.
+        #
+        # @return [ScormEngine::Response]
+        #
+        def delete_registration(options = {})
+          require_options(options, :registration_id)
+
+          options = options.dup
+          registration_id = options.delete(:registration_id)
+
+          response = delete("registrations/#{registration_id}")
+
+          Response.new(raw_response: response)
+        end
+
+        #
+        # Create a registration.
+        #
+        # @see http://rustici-docs.s3.amazonaws.com/engine/2017.1.x/api.html#tenant__registrations_post
+        #
+        # @param [Hash] options
+        #
+        # @option options [String] :course_id
+        #   The course ID.
+        #
+        # @option options [String] :registration_id
+        #   The registration's ID. Must be unique.
+        #
+        # @option options [String] :learner/:id
+        #   The learner's ID.
+        #
+        # @option options [String] :learner/:first_name
+        #   The learner's first name.
+        #
+        # @option options [String] :learner/:last_name
+        #   The learner's last name.
+        #
+        # @option options [String] :post_back/:url ()
+        #   Specifies an optional override URL for which to post activity and
+        #   status data in real time as the course is completed. By default all
+        #   of these settings are read from your configuration, so only specify
+        #   this if you need to control it on a per-registration basis.
+        #
+        # @option options [String] :post_back/:auth_type ("form")
+        #   Optional parameter to specify how to authorize against the given
+        #   postbackurl, can be 'form' or 'httpbasic'. If form authentication,
+        #   the username and password for authentication are submitted as form
+        #   fields 'username' and 'password', and the registration data as the
+        #   form field 'data'. If HTTP Basic Authentication is used, the
+        #   username and password are placed in the standard Authorization HTTP
+        #   header, and the registration data is the body of the message (sent
+        #   as application/json content type).
+        #
+        # @option options [String] :post_back/:user_name ()
+        #   The user name to be used in authorizing the postback of data to the
+        #   URL specified by postback url.
+        #
+        # @option options [String] :post_back/:password ()
+        #   The password to be used in authorizing the postback of data to the
+        #   URL specified by postback url.
+        #
+        # @option options [String] :post_back/:results_format ("course")
+        #   This parameter allows you to specify a level of detail in the
+        #   information that is posted back while the course is being taken. It
+        #   may be one of three values: 'course' (course summary), 'activity'
+        #   (activity summary), or 'full' (full detail), and is set to 'course'
+        #   by default. The information will be posted as JSON using the same
+        #   schema as what is returned in the /progress and /progress/detail
+        #   endpoints.
+        #
+        # @return [ScormEngine::Response]
+        #
+        def post_registration(options = {})
+          require_options(options, :course_id, :registration_id, [:learner, :id], [:learner, :first_name], [:learner, :last_name])
+
+          options = options.dup
+
+          body = {
+            courseId: options[:course_id],
+            registrationId: options[:registration_id],
+            learner: {
+              id: options[:learner][:id],
+              firstName: options[:learner][:first_name],
+              lastName: options[:learner][:last_name],
+            },
+          }
+
+          if options[:post_back]
+            body[:postBack] = {
+              authType: options[:post_back][:auth_type],
+              userName: options[:post_back][:user_name],
+              password: options[:post_back][:password],
+              resultsFormat: options[:post_back][:results_format],
+            }.reject { |_k, v| v.nil? }
+          end
+
+          response = post("registrations", {}, body)
+
+          Response.new(raw_response: response)
+        end
+      end
+
+      #
+      # Returns the link to use to launch this registration
+      #
+      # @see http://rustici-docs.s3.amazonaws.com/engine/2017.1.x/api.html#tenant__registrations__registrationId__launchLink_get
+      #
+      # @param [Hash] options
+      #
+      # @option options [String] :registration_id
+      #   The ID of the registration.
+      #
+      # @option options [Integer] :expiry (0)
+      #   Number of seconds from now this link will expire in. Use 0 for no
+      #   expiration.
+      #
+      # @option options [String] :redirect_on_exit_url
+      #   The URL the application should redirect to when the learner exits a
+      #   course. If not specified, configured value will be used.
+      #
+      # @return [String]
+      #
+      def get_registration_launch_link(options = {})
+        require_options(options, :registration_id)
+
+        options = options.dup
+        registration_id = options.delete(:registration_id)
+        options[:redirectOnExitUrl] = options.delete(:redirect_on_exit_url) if options.key?(:redirect_on_exit_url)
+
+        response = get("registrations/#{registration_id}/launchLink", options)
+
+        result = response.success? && response.body["launchLink"]
+
+        Response.new(raw_response: response, result: result)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,146 @@
+#
+# TODO: Consider consolidating this and Courses::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 Registrations
+        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__registrations__registrationId__configuration_get
+          #
+          # @param [Hash] options
+          #
+          # @option options [String] :registration_id
+          #   The ID of the registration to get.
+          #
+          # @option options [Integer] :instance (nil)
+          #   The instance of this registration to use. If not provided, the
+          #   latest instance will be used.
+          #
+          # @return [ScormEngine::Models::RegistrationConfiguration]
+          #
+          def get_registration_configuration(options = {})
+            require_options(options, :registration_id)
+
+            options = options.dup
+            registration_id = options.delete(:registration_id)
+
+            response = get("registrations/#{registration_id}/configuration", options)
+
+            result = response.success? && ScormEngine::Models::RegistrationConfiguration.new_from_api(response.body)
+
+            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__registrations__registrationId__configuration_post
+          #
+          # @param [Hash] options
+          #
+          # @option options [String] :registration_id
+          #   The ID of the registration to set.
+          #
+          # @option options [Integer] :instance (nil)
+          #   The instance of this registration to use. If not provided, the
+          #   latest instance will be used.
+          #
+          # @option options [Hash] :settings
+          #   Key/value pairs of configuration options to set.
+          #
+          # @return [ScormEngine::Response]
+          #
+          def post_registration_configuration(options = {})
+            require_options(options, :registration_id, :settings)
+
+            options = options.dup
+            registration_id = options.delete(:registration_id)
+            settings = options.delete(:settings)
+
+            body = { settings: settings.map { |k, v| { "settingId" => k, "value" => v.to_s } } }
+
+            response = post("registrations/#{registration_id}/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__registrations__registrationId__configuration__settingId__get
+          #
+          # @param [Hash] options
+          #
+          # @option options [String] :registration_id
+          #   The ID of the registration to get.
+          #
+          # @option options [String] :setting_id
+          #   The ID of the setting to get.
+          #
+          # @option options [Integer] :instance (nil)
+          #   The instance of this registration to use. If not provided, the
+          #   latest instance will be used.
+          #
+          # @return [String]
+          #
+          def get_registration_configuration_setting(options = {})
+            require_options(options, :registration_id, :setting_id)
+
+            options = options.dup
+            registration_id = options.delete(:registration_id)
+            setting_id = options.delete(:setting_id)
+
+            response = get("registrations/#{registration_id}/configuration/#{setting_id}", options)
+
+            result = response.success? && response.body["value"]
+
+            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__registrations__registrationId__configuration__settingId__put
+          #
+          # @param [Hash] options
+          #
+          # @option options [String] :registration_id
+          #   The ID of the registration to set.
+          #
+          # @option options [String] :setting_id
+          #   The ID of the setting to set.
+          #
+          # @option options [String] :value ("")
+          #   The value of the setting to set.
+          #
+          # @option options [Integer] :instance (nil)
+          #   The instance of this registration to use. If not provided, the
+          #   latest instance will be used.
+          #
+          # @return [ScormEngine::Response]
+          #
+          def put_registration_configuration_setting(options = {})
+            require_options(options, :registration_id, :setting_id)
+
+            options = options.dup
+            registration_id = options.delete(:registration_id)
+            setting_id = options.delete(:setting_id)
+
+            body = { value: options.delete(:value).to_s }
+
+            response = put("registrations/#{registration_id}/configuration/#{setting_id}", options, body)
+
+            Response.new(raw_response: response)
+          end
+        end
+      end
+    end
+  end
+end