scorm_engine 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4eb559da6c58e1d094b117f7309f63a57fd0ce8420f20f1b29e70db9ced197d5
+  data.tar.gz: a257cbd1dc47e8b30ff8aa23e4b6ec7179dafa476e137ef65ef14652aa62668d
+SHA512:
+  metadata.gz: '0991ec18af0234a57b7d331a270b7149cc02e1d921f1c507d437138c38bb637d044789fb56c8a2e10ab5489585f90a24d34ce5a10a0d4a1cf0b59699aa705640'
+  data.tar.gz: c0312e3e6251c0de3cd92d620211e6a2d47098d7b30aaba3608e190ab347d5d3ffc6ff81d35bee5c25ec2d0c630585d7dfa731ada8d94c9d2cb1f20a90189caa

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/Rakefile

@@ -0,0 +1,13 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require "yard"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec
+
+YARD::Rake::YardocTask.new do |t|
+  t.files = ["lib/**/*.rb"]
+  t.options = []
+  t.stats_options = ["--list-undoc"]
+end

data/lib/scorm_engine.rb

@@ -0,0 +1,13 @@
+require "ostruct"
+require "json"
+
+require "scorm_engine/version"
+require "scorm_engine/utils"
+require "scorm_engine/configuration"
+require "scorm_engine/models"
+require "scorm_engine/api/endpoints"
+require "scorm_engine/client"
+require "scorm_engine/response"
+
+module ScormEngine
+end

data/lib/scorm_engine/api/endpoints.rb

@@ -0,0 +1,50 @@
+require_relative "endpoints/about"
+require_relative "endpoints/courses"
+require_relative "endpoints/courses/configuration"
+require_relative "endpoints/courses/import"
+require_relative "endpoints/ping"
+require_relative "endpoints/registrations"
+require_relative "endpoints/registrations/configuration"
+require_relative "endpoints/registrations/launch_history"
+
+module ScormEngine
+  module Api
+    module Endpoints
+      include About
+      include Courses
+      include Courses::Configuration
+      include Courses::Import
+      include Ping
+      include Registrations
+      include Registrations::Configuration
+      include Registrations::LaunchHistory
+
+      private
+
+      #
+      # Ensure that all of the keys are present in the hash passed and raise an error if not.
+      #
+      # @example
+      #   require_options({foo: 1, bar: {"baz" => 2}}, :foo, [:bar, :baz], :moo)
+      #   # will raise an errror due to lack of :moo
+      #
+      # @param [Hash] haystack
+      #   The option hash in which to search for the given, optionally nested, key[s].
+      #
+      # @param [Array] sets_of_needles
+      #   A splat of keys or array of nested keys to search for.
+      #
+      # @raise [ArgumentError] if any needle isn't found.
+      #
+      def require_options(haystack = {}, *sets_of_needles)
+        sets_of_needles.each { |needles| require_option(haystack, *needles) }
+      end
+
+      def require_option(haystack, *needles)
+        value = needles.reduce(haystack) { |m, o| m[o.to_sym] || m[o.to_s] }
+        return unless value.nil? # || (value.respond_to?(:empty?) && value.empty?)
+        raise ArgumentError, "Required option #{needles.join("/")} missing"
+      end
+    end
+  end
+end

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

@@ -0,0 +1,59 @@
+module ScormEngine
+  module Api
+    module Endpoints
+      module About
+        #
+        # Get back the version and platform of the running instance of Engine
+        #
+        # @see http://rustici-docs.s3.amazonaws.com/engine/2017.1.x/api.html#tenant__about_get
+        #
+        # @return [ScormEngine::Response]
+        #
+        def get_about
+          response = get("about")
+
+          result = OpenStruct.new(response.body)
+
+          Response.new(raw_response: response, result: result)
+        end
+
+        #
+        # Gets the number of users across all tenants.
+        #
+        # @see http://rustici-docs.s3.amazonaws.com/engine/2017.1.x/api.html#tenant__about_userCount_get
+        #
+        # @param [Hash] options
+        #
+        # @option options [DateTime] :before
+        #   Only userCount updated before the specified time (inclusive) are included.
+        #   If a time zone is not specified, the server's time zone will be used.
+        #
+        # @option options [DateTime] :since
+        #   Only userCount updated since the specified time (inclusive) are included.
+        #   If a time zone is not specified, the server's time zone will be used.
+        #
+        # @return [ScormEngine::Response]
+        #
+        def get_about_user_count(options = {})
+          response = get("about/userCount", options)
+
+          result = OpenStruct.new
+          result.total = response.body["combinedTenants"]["total"]
+          result.dispatched = response.body["combinedTenants"]["dispatched"]
+          result.non_dispatched = response.body["combinedTenants"]["nonDispatched"]
+          result.by_tenant = {}
+
+          response.body["byTenant"].each do |tenant|
+            result.by_tenant[tenant["tenantName"]] = OpenStruct.new(
+              total: tenant["total"],
+              dispatched: tenant["dispatched"],
+              non_dispatched: tenant["nonDispatched"]
+            )
+          end
+
+          Response.new(raw_response: response, result: result)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,136 @@
+module ScormEngine
+  module Api
+    module Endpoints
+      module Courses
+
+        #
+        # Get the list of courses
+        #
+        # @see http://rustici-docs.s3.amazonaws.com/engine/2017.1.x/api.html#tenant__courses_get
+        # @see http://rustici-docs.s3.amazonaws.com/engine/2017.1.x/api.html#tenant__courses__courseId__get
+        #
+        # @param [Hash] options
+        #
+        # @option options [String] :course_id
+        #   The ID of the single course to retrieve. If set no other options
+        #   are respected. Note that multiple results may be returned if the
+        #   course has multiple versions.
+        #
+        # @option options [DateTime] :since
+        #   Only courses 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::Course>]
+        #
+        def get_courses(options = {})
+          options = options.dup
+
+          path = "courses"
+          path = "courses/#{options.delete(:course_id)}" if options[:course_id]
+
+          response = get(path, options)
+
+          result = Enumerator.new do |enum|
+            loop do
+              response.success? && response.body["courses"].each do |course|
+                enum << ScormEngine::Models::Course.new_from_api(course)
+              end
+              break if !response.success? || response.body["more"].nil?
+              response = get(response.body["more"])
+            end
+          end
+
+          Response.new(raw_response: response, result: result)
+        end
+
+        #
+        # Delete a course
+        #
+        # @see http://rustici-docs.s3.amazonaws.com/engine/2017.1.x/api.html#tenant__courses__courseId__delete
+        #
+        # @param [Hash] options
+        #
+        # @option options [String] :course_id
+        #   The ID of the course to delete.
+        #
+        # @return [ScormEngine::Response]
+        #
+        def delete_course(options = {})
+          require_options(options, :course_id)
+
+          response = delete("courses/#{options[:course_id]}")
+
+          Response.new(raw_response: response)
+        end
+
+        #
+        # Get the details of a course
+        #
+        # @see http://rustici-docs.s3.amazonaws.com/engine/2017.1.x/api.html#tenant__courses__courseId__detail_get
+        #
+        # @param [Hash] options
+        #
+        # @option options [String] :course_id
+        #   The ID of the course to get.
+        #
+        # @option options [Integer] :version (nil)
+        #   The version of this course to use. If not provided, the latest
+        #   version will be used.
+        #
+        # @return [ScormEngine::Models::Course]
+        #
+        def get_course_detail(options = {})
+          require_options(options, :course_id)
+
+          options = options.dup
+          course_id = options.delete(:course_id)
+
+          response = get("courses/#{course_id}/detail", options)
+
+          result = response.success? && ScormEngine::Models::Course.new_from_api(response.body)
+
+          Response.new(raw_response: response, result: result)
+        end
+
+        #
+        # Returns the launch link to use to preview this course
+        #
+        # @see http://rustici-docs.s3.amazonaws.com/engine/2017.1.x/api.html#tenant__courses__courseId__preview_get
+        #
+        # @param [Hash] options
+        #
+        # @option options [String] :course_id
+        #   The ID of the course to get.
+        #
+        # @option options [Integer] :version (nil)
+        #   The version of this course to use. If not provided, the latest
+        #   version will be used.
+        #
+        # @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_course_preview(options = {})
+          require_options(options, :course_id)
+
+          options = options.dup
+          course_id = options.delete(:course_id)
+          options[:redirectOnExitUrl] = options.delete(:redirect_on_exit_url) if options.key?(:redirect_on_exit_url)
+
+          response = get("courses/#{course_id}/preview", options)
+
+          result = response.success? && response.body["launchLink"]
+
+          Response.new(raw_response: response, result: result)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,146 @@
+#
+# TODO: Consider consolidating this and 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 Courses
+        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__courses__courseId__configuration_get
+          #
+          # @param [Hash] options
+          #
+          # @option options [String] :course_id
+          #   The ID of the course to get.
+          #
+          # @option options [Integer] :version (nil)
+          #   The version of this course to use. If not provided, the latest
+          #   version will be used.
+          #
+          # @return [ScormEngine::Models::CourseConfiguration]
+          #
+          def get_course_configuration(options = {})
+            require_options(options, :course_id)
+
+            options = options.dup
+            course_id = options.delete(:course_id)
+
+            response = get("courses/#{course_id}/configuration", options)
+
+            result = response.success? && ScormEngine::Models::CourseConfiguration.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__courses__courseId__configuration_post
+          #
+          # @param [Hash] options
+          #
+          # @option options [String] :course_id
+          #   The ID of the course to set.
+          #
+          # @option options [Integer] :version (nil)
+          #   The version of this course to use. If not provided, the latest
+          #   version will be used.
+          #
+          # @option options [Hash] :settings
+          #   Key/value pairs of configuration options to set.
+          #
+          # @return [ScormEngine::Response]
+          #
+          def post_course_configuration(options = {})
+            require_options(options, :course_id, :settings)
+
+            options = options.dup
+            course_id = options.delete(:course_id)
+            settings = options.delete(:settings)
+
+            body = { settings: settings.map { |k, v| { "settingId" => k, "value" => v.to_s } } }
+
+            response = post("courses/#{course_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__courses__courseId__configuration__settingId__get
+          #
+          # @param [Hash] options
+          #
+          # @option options [String] :course_id
+          #   The ID of the course to get.
+          #
+          # @option options [String] :setting_id
+          #   The ID of the setting to get.
+          #
+          # @option options [Integer] :version (nil)
+          #   The version of this course to use. If not provided, the latest
+          #   version will be used.
+          #
+          # @return [String]
+          #
+          def get_course_configuration_setting(options = {})
+            require_options(options, :course_id, :setting_id)
+
+            options = options.dup
+            course_id = options.delete(:course_id)
+            setting_id = options.delete(:setting_id)
+
+            response = get("courses/#{course_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__courses__courseId__configuration__settingId__put
+          #
+          # @param [Hash] options
+          #
+          # @option options [String] :course_id
+          #   The ID of the course 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] :version (nil)
+          #   The version of this course to use. If not provided, the latest
+          #   version will be used.
+          #
+          # @return [ScormEngine::Response]
+          #
+          def put_course_configuration_setting(options = {})
+            require_options(options, :course_id, :setting_id)
+
+            options = options.dup
+            course_id = options.delete(:course_id)
+            setting_id = options.delete(:setting_id)
+
+            body = { value: options.delete(:value).to_s }
+
+            response = put("courses/#{course_id}/configuration/#{setting_id}", options, body)
+
+            Response.new(raw_response: response)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,83 @@
+module ScormEngine
+  module Api
+    module Endpoints
+      module Courses
+        module Import
+
+          #
+          # Import a course
+          #
+          # Either the actual contents of the zip file to import may be posted,
+          # or JSON that references the remote location to import from.
+          #
+          # @see http://rustici-docs.s3.amazonaws.com/engine/2017.1.x/api.html#tenant__courses_importJobs_post
+          #
+          # @param [Hash] options
+          #
+          # @option options [String] :url
+          #   URL path to the .zip package representing the course or the manifest file defining the course.
+          #
+          # @option options [String] :course_id
+          #   A unique identifier your application will use to identify the
+          #   course after import. Your application is responsible both for
+          #   generating this unique ID and for keeping track of the ID for later
+          #   use.
+          #
+          # @option options [Boolean] :may_create_new_version (false)
+          #   Is it OK to create a new version of this course? If this is set to
+          #   false and the course already exists, the upload will fail. If true
+          #   and the course already exists then a new version will be created.
+          #   No effect if the course doesn't already exist.
+          #
+          # @option options [String] :name (value of :course)
+          #   A unique identifier that may be used as part of the directory name on disk.
+          #
+          # @return [ScormEngine::Models::CourseImport]
+          #
+          def post_course_import(options = {})
+            require_options(options, :course_id, :url)
+
+            query_params = {
+              course: options[:course_id],
+              mayCreateNewVersion: !!options[:may_create_new_version]
+            }
+
+            body = {
+              url: options[:url],
+              courseName: options[:name] || options[:course_id]
+            }
+
+            response = post("courses/importJobs", query_params, body)
+
+            result = response&.success? && ScormEngine::Models::CourseImport.new_from_api(response.body)
+
+            Response.new(raw_response: response, result: result)
+          end
+
+          #
+          # This method will check the status of a course import.
+          #
+          # @see http://rustici-docs.s3.amazonaws.com/engine/2017.1.x/api.html#tenant__courses_importJobs__importJobId__get
+          #
+          # @param [Hash] options
+          #
+          # @option options [String] :id
+          #   The id of the import to check.
+          #
+          # @return [ScormEngine::Models::CourseImport]
+          #
+          def get_course_import(options = {})
+            require_options(options, :id)
+
+            response = get("courses/importJobs/#{options[:id]}")
+
+            # jobId is not always returned. :why:
+            result = response&.success? && ScormEngine::Models::CourseImport.new_from_api({ "jobId" => options[:id] }.merge(response.body))
+
+            Response.new(raw_response: response, result: result)
+          end
+        end
+      end
+    end
+  end
+end