scorm_engine 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 19b624a8b425c5651d2f7e68b7594963df61dbe48fde93b08ed69fc01a5e7011
-  data.tar.gz: 9c470f779c3db4b799d9c7dc71dd1c37160672109362c9fdf352a39c1d66dec7
+  metadata.gz: ba57a4d4caf90f530093fe8825533d1b32f59ebd809979363f5b1faaea2df09f
+  data.tar.gz: 68d0fec6173b12b04d7a734aae2869f1c28c9f3f3848a2bccd237951e26f06ff
 SHA512:
-  metadata.gz: 3021b7b2e610eea43fb0ade3670c0f5ae7439c22cca01f1f7ad6547d6d02533ad68013c6bd51d5ff3caa3c4399e157baf66d17baf1a14d7ee5277ea33c1aaefa
-  data.tar.gz: 2fb5e15db8a311ba060f8239ca84f4a73952b85c683f70165061ac796fb191075a211bf537b5ce6a49453be8055f8ae504e50ca92338214c06bf9162c98a5058
+  metadata.gz: f7c16bfb4b244fbe5fbf0c981d65c00b5fc728c50fce375ffe19d8bfbb94d4e8b9e9f435d92ebde05aa9e96b53059991d24158ff7410a43f04bbf8c70a5c4eca
+  data.tar.gz: 070d20fcc913d2d32d487a08b7bf06adce1bbac5fbe2692f446775e9a61a5e74a0a5758311501e2d21150c4622d4d476e0ceb58a9cfa31673c651f1814e29967

data/lib/scorm_engine/api/endpoints.rb

@@ -2,6 +2,8 @@ require_relative "endpoints/about"
 require_relative "endpoints/courses"
 require_relative "endpoints/courses/configuration"
 require_relative "endpoints/courses/import"
+require_relative "endpoints/destinations"
+require_relative "endpoints/dispatches"
 require_relative "endpoints/ping"
 require_relative "endpoints/registrations"
 require_relative "endpoints/registrations/configuration"
@@ -14,6 +16,8 @@ module ScormEngine
       include Courses
       include Courses::Configuration
       include Courses::Import
+      include Destinations
+      include Dispatches
       include Ping
       include Registrations
       include Registrations::Configuration
@@ -41,10 +45,16 @@ module ScormEngine
       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?)
+        value = needles.reduce(haystack) { |m, o| value_for_key(m, o) }
+        return unless value.nil?
         raise ArgumentError, "Required option #{needles.join("/")} missing"
       end
+
+      def value_for_key(memo, obj)
+        return memo[obj.to_sym] if memo.key?(obj.to_sym)
+        return memo[obj.to_s] if memo.key?(obj.to_s)
+        nil
+      end
     end
   end
 end

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

@@ -0,0 +1,225 @@
+module ScormEngine
+  module Api
+    module Endpoints
+      module Destinations
+
+        #
+        # Get a list of destinations.
+        #
+        # @see http://rustici-docs.s3.amazonaws.com/engine/2017.1.x.dispatch/api-dispatch.html#tenant__destinations_get
+        #
+        # @param [Hash] options
+        #
+        # @option options [String] :course_id
+        #   Limit the results to destinations that have dispatches of the specified course.
+        #
+        # @option options [DateTime] :since
+        #   Only destinations 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::Destination>]
+        #
+        def get_destinations(options = {})
+          options = options.dup
+
+          response = get("destinations", options)
+
+          result = Enumerator.new do |enum|
+            loop do
+              response.success? && response.body["destinations"].each do |destination|
+                enum << ScormEngine::Models::Destination.new_from_api(destination)
+              end
+              break if !response.success? || response.body["more"].nil?
+              response = get(response.body["more"])
+            end
+          end
+
+          Response.new(raw_response: response, result: result)
+        end
+
+        #
+        # Create a destination.
+        #
+        # @see http://rustici-docs.s3.amazonaws.com/engine/2017.1.x.dispatch/api-dispatch.html#tenant__destinations_post
+        #
+        # @param [Hash] options
+        #
+        # @option options [String] :destination_id
+        #   The destination ID.
+        #
+        # @option options [String] :name (:destination_id)
+        #   The destination's name.
+        #
+        # @return [ScormEngine::Response]
+        #
+        def post_destination(options = {})
+          require_options(options, :destination_id)
+
+          options = options.dup
+          options[:name] ||= options[:destination_id]
+
+          body = {
+            destinations: [
+              id: options[:destination_id].to_s,
+              data: {
+                name: options[:name].to_s,
+              },
+            ]
+          }
+
+          response = post("destinations", {}, body)
+
+          Response.new(raw_response: response)
+        end
+
+        #
+        # Get a destination.
+        #
+        # @see http://rustici-docs.s3.amazonaws.com/engine/2017.1.x.dispatch/api-dispatch.html#tenant__destinations__destinationId__get
+        #
+        # @param [Hash] options
+        #
+        # @option options [String] :destination_id
+        #   The ID of the destination to get.
+        #
+        # @return [ScormEngine::Models::Destination]
+        #
+        def get_destination(options = {})
+          require_options(options, :destination_id)
+
+          response = get("destinations/#{options[:destination_id]}")
+
+          # merge options to pick up destination_id which isn't passed back in the response
+          result = response.success? ? ScormEngine::Models::Destination.new_from_api(options.merge(response.body)) : nil
+
+          Response.new(raw_response: response, result: result)
+        end
+
+        #
+        # Update a destination.
+        #
+        # @see http://rustici-docs.s3.amazonaws.com/engine/2017.1.x.dispatch/api-dispatch.html#tenant__destinations__destinationId__put
+        #
+        # @param [Hash] options
+        #
+        # @option options [String] :destination_id
+        #   The destination ID.
+        #
+        # @option options [String] :name
+        #   The destination's new name.
+        #
+        # @return [ScormEngine::Response]
+        #
+        def put_destination(options = {})
+          require_options(options, :destination_id, :name)
+
+          options = options.dup
+
+          body = {
+            name: options[:name],
+          }
+
+          response = put("destinations/#{options[:destination_id]}", {}, body)
+
+          Response.new(raw_response: response)
+        end
+
+        #
+        # Delete a destination.
+        #
+        # Deleting a destination will also delete all dispatches for that
+        # destination.
+        #
+        # @see http://rustici-docs.s3.amazonaws.com/engine/2017.1.x.dispatch/api-dispatch.html#tenant__destinations_delete
+        #
+        # @param [Hash] options
+        #
+        # @option options [String] :destination_id
+        #   The ID of the destination to delete.
+        #
+        # @return [ScormEngine::Response]
+        #
+        def delete_destination(options = {})
+          require_options(options, :destination_id)
+
+          response = delete("destinations/#{options[:destination_id]}")
+
+          Response.new(raw_response: response)
+        end
+
+        #
+        # Enable or disable all related dispatches.
+        #
+        # @see http://rustici-docs.s3.amazonaws.com/engine/2017.1.x.dispatch/api-dispatch.html#tenant__destinations__destinationId__dispatches_enabled_post
+        #
+        # @param [Hash] options
+        #
+        # @option options [String] :destination_id
+        #   The ID of the destination
+        #
+        # @option options [Boolean] :enabled
+        #   The enabledness of all related dispatches
+        #
+        # @return [ScormEngine::Response]
+        #
+        def post_destination_dispatches_enabled(options = {})
+          require_options(options, :destination_id, :enabled)
+
+          body = options[:enabled].to_s
+
+          response = post("destinations/#{options[:destination_id]}/dispatches/enabled", {}, body)
+
+          Response.new(raw_response: response)
+        end
+
+        #
+        # Enable or disable registration instancing.
+        #
+        # @see http://rustici-docs.s3.amazonaws.com/engine/2017.1.x.dispatch/api-dispatch.html#tenant__destinations__destinationId__dispatches_registrationInstancing_post
+        #
+        # @param [Hash] options
+        #
+        # @option options [String] :destination_id
+        #   The ID of the destination to delete.
+        #
+        # @option options [Boolean] :enabled
+        #   The enabledness of the registration instancing
+        #
+        # @return [ScormEngine::Response]
+        #
+        def post_destination_dispatches_registration_instancing(options = {})
+          require_options(options, :destination_id, :enabled)
+
+          body = options[:enabled].to_s
+
+          response = post("destinations/#{options[:destination_id]}/dispatches/registrationInstancing", {}, body)
+
+          Response.new(raw_response: response)
+        end
+
+        #
+        # Get an aggregate count of all related dispatch registrations.
+        #
+        # @see http://rustici-docs.s3.amazonaws.com/engine/2017.1.x.dispatch/api-dispatch.html#tenant__destinations__destinationId__dispatches_registrationCount_get
+        #
+        # @param [Hash] options
+        #
+        # @option options [String] :destination_id
+        #   The ID of the destination to delete.
+        #
+        # @return [Integer]
+        #
+        def get_destination_dispatches_registration_count(options = {})
+          require_options(options, :destination_id)
+
+          response = get("destinations/#{options[:destination_id]}/dispatches/registrationCount")
+
+          result = response.success? ? response.body.to_i : nil
+
+          Response.new(raw_response: response, result: result)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,301 @@
+module ScormEngine
+  module Api
+    module Endpoints
+      module Dispatches
+
+        #
+        # Get a list of dispatches.
+        #
+        # @see http://rustici-docs.s3.amazonaws.com/engine/2017.1.x.dispatch/api-dispatch.html#tenant__dispatches_get
+        #
+        # @param [Hash] options
+        #
+        # @option options [String] :course_id
+        #   Limit the results to dispatches of the specified course.
+        #
+        # @option options [DateTime] :since
+        #   Only dispatches 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::Dispatch>]
+        #
+        def get_dispatches(options = {})
+          options = options.dup
+
+          response = get("dispatches", options)
+
+          result = Enumerator.new do |enum|
+            loop do
+              response.success? && response.body["dispatches"].each do |course|
+                enum << ScormEngine::Models::Dispatch.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
+
+        #
+        # Create a dispatch.
+        #
+        # @see http://rustici-docs.s3.amazonaws.com/engine/2017.1.x.dispatch/api-dispatch.html#tenant__dispatches_post
+        #
+        # @param [Hash] options
+        #
+        # @option options [String] :dispatch_id
+        #   The dispatch ID.
+        #
+        # @option options [String] :destination_id
+        #   The destination ID.
+        #
+        # @option options [String] :course_id
+        #   The course ID.
+        #
+        # @option options [Boolean] :allow_new_registrations (false)
+        #   If true, then new registrations can be created for this dispatch.
+        #
+        # @option options [Boolean] :instanced (false)
+        #   If true, then a new registration instance will be created if the
+        #   client LMS doesn't provide launch data for an existing one.
+        #   Otherwise, the same instance will always be used for the given
+        #   cmi.learner_id.
+        #
+        # @option options [Integer] :registration_cap (0)
+        #   The maximum number of registrations that can be created for this
+        #   dispatch, where '0' means 'unlimited registrations'.
+        #
+        # @option options [Date] :expiration_date ("none")
+        #   The date after which this dispatch will be disabled as an ISO 8601
+        #   string, or \"none\" for no expiration date.
+        #
+        # @option options [String] :external_config ("")
+        #   Serialized external configuration information to include when
+        #   launching the dispatched package.
+        #
+        # @return [ScormEngine::Response]
+        #
+        def post_dispatch(options = {})
+          require_options(options, :dispatch_id, :destination_id, :course_id)
+
+          options = options.dup
+
+          options[:allow_new_registrations] = false unless options[:allow_new_registrations]
+          options[:instanced] = false unless options[:instanced]
+          options[:registration_cap] = [0, options[:registration_cap].to_i].max
+          options[:expiration_date] = begin
+                                        date = options[:expiration_date]
+                                        date = date.is_a?(String) ? Date.parse(date) : date
+                                        date&.iso8601 # might be nil
+                                      rescue ArgumentError
+                                        "none"
+                                      end
+
+          body = {
+            dispatches: [
+              id: options[:dispatch_id],
+              data: {
+                destinationId: options[:destination_id],
+                courseId: options[:course_id],
+                allowNewRegistrations: options[:allow_new_registrations],
+                instanced: options[:instanced],
+                registrationCap: options[:registration_cap],
+                expirationDate: options[:expiration_date],
+                externalConfig: options[:external_config],
+              },
+            ]
+          }
+
+          response = post("dispatches", {}, body)
+
+          Response.new(raw_response: response)
+        end
+
+        #
+        # Get a dispatch.
+        #
+        # @see http://rustici-docs.s3.amazonaws.com/engine/2017.1.x.dispatch/api-dispatch.html#tenant__dispatches__dispatchId__get
+        #
+        # @param [Hash] options
+        #
+        # @option options [String] :dispatch_id
+        #   The ID of the dispatch to get.
+        #
+        # @return [ScormEngine::Models::Dispatch]
+        #
+        def get_dispatch(options = {})
+          require_options(options, :dispatch_id)
+
+          response = get("dispatches/#{options[:dispatch_id]}")
+
+          result = response.success? ? ScormEngine::Models::Dispatch.new_from_api(response.body) : nil
+
+          Response.new(raw_response: response, result: result)
+        end
+
+        #
+        # Update a dispatch.
+        #
+        # @see http://rustici-docs.s3.amazonaws.com/engine/2017.1.x.dispatch/api-dispatch.html#tenant__dispatches__dispatchId__put
+        #
+        # @param [Hash] options
+        #
+        # @option options [String] :dispatch_id
+        #   The dispatch ID.
+        #
+        # @option options [String] :destination_id
+        #   The destination ID.
+        #
+        # @option options [String] :course_id
+        #   The course ID.
+        #
+        # @option options [Boolean] :allow_new_registrations (false)
+        #   If true, then new registrations can be created for this dispatch.
+        #
+        # @option options [Boolean] :instanced (false)
+        #   If true, then a new registration instance will be created if the
+        #   client LMS doesn't provide launch data for an existing one.
+        #   Otherwise, the same instance will always be used for the given
+        #   cmi.learner_id.
+        #
+        # @option options [Integer] :registration_cap (0)
+        #   The maximum number of registrations that can be created for this
+        #   dispatch, where '0' means 'unlimited registrations'.
+        #
+        # @option options [Date] :expiration_date ("none")
+        #   The date after which this dispatch will be disabled as an ISO 8601
+        #   string, or \"none\" for no expiration date.
+        #
+        # @option options [String] :external_config ("")
+        #   Serialized external configuration information to include when
+        #   launching the dispatched package.
+        #
+        # @return [ScormEngine::Response]
+        #
+        def put_dispatch(options = {})
+          require_options(options, :dispatch_id, :destination_id, :course_id)
+
+          body = {
+            destinationId: options[:destination_id],
+            courseId: options[:course_id],
+            allowNewRegistrations: options[:allow_new_registrations],
+            instanced: options[:instanced],
+            registrationCap: options[:registration_cap],
+            expirationDate: options[:expiration_date],
+            externalConfig: options[:external_config],
+          }
+
+          response = put("dispatches/#{options[:dispatch_id]}", {}, body)
+
+          Response.new(raw_response: response)
+        end
+
+        #
+        # Delete a dispatch.
+        #
+        # @see http://rustici-docs.s3.amazonaws.com/engine/2017.1.x.dispatch/api-dispatch.html#tenant__dispatches__dispatchId__delete
+        #
+        # @param [Hash] options
+        #
+        # @option options [String] :dispatch_id
+        #   The ID of the dispatch to delete.
+        #
+        # @return [ScormEngine::Response]
+        #
+        def delete_dispatch(options = {})
+          require_options(options, :dispatch_id)
+
+          response = delete("dispatches/#{options[:dispatch_id]}")
+
+          Response.new(raw_response: response)
+        end
+
+        #
+        # Get the enabled status of a dispatch.
+        #
+        # @see http://rustici-docs.s3.amazonaws.com/engine/2017.1.x.dispatch/api-dispatch.html#tenant__dispatches__dispatchId__enabled_get
+        #
+        # @param [Hash] options
+        #
+        # @option options [String] :dispatch_id
+        #   The ID of the dispatch to delete.
+        #
+        # @return [ScormEngine::Response]
+        #
+        def get_dispatch_enabled(options = {})
+          require_options(options, :dispatch_id)
+
+          response = get("dispatches/#{options[:dispatch_id]}/enabled")
+
+          result = response.success? ? response.body : nil
+
+          Response.new(raw_response: response, result: result)
+        end
+
+        #
+        # Enable or disable the dispatch.
+        #
+        # @see http://rustici-docs.s3.amazonaws.com/engine/2017.1.x.dispatch/api-dispatch.html#tenant__dispatches__dispatchId__enabled_put
+        #
+        # @param [Hash] options
+        #
+        # @option options [String] :dispatch_id
+        #   The ID of the dispatch
+        #
+        # @option options [Boolean] :enabled
+        #   The enabledness of the dispatch
+        #
+        # @return [ScormEngine::Response]
+        #
+        def put_dispatch_enabled(options = {})
+          require_options(options, :dispatch_id, :enabled)
+
+          body = options[:enabled].to_s
+
+          response = put("dispatches/#{options[:dispatch_id]}/enabled", {}, body)
+
+          Response.new(raw_response: response)
+        end
+
+        #
+        # Get the ZIP dispatch package.
+        #
+        # @see http://rustici-docs.s3.amazonaws.com/engine/2017.1.x.dispatch/api-dispatch.html#tenant__dispatches__dispatchId__zip_get
+        #
+        # @param [Hash] options
+        #
+        # @option options [String] :dispatch_id
+        #   The ID of the dispatch to delete.
+        #
+        # @option options [String] :type (SCORM12)
+        #   The type of dispatch package to export (SCORM12, SCORM20043RDEDITION or AICC)
+        #
+        # @return [ScormEngine::Models::DispatchZip]
+        #
+        def get_dispatch_zip(options = {})
+          require_options(options, :dispatch_id)
+
+          options = options.dup
+          dispatch_id = options.delete(:dispatch_id)
+          options[:type] ||= "SCORM12"
+
+          response = get("dispatches/#{dispatch_id}/zip", options)
+
+          result = if response.success?
+                     ScormEngine::Models::DispatchZip.new(
+                       dispatch_id: dispatch_id,
+                       type: options[:type],
+                       filename: response.headers["content-disposition"].match(/; filename="(.*?)"/)&.captures&.first,
+                       body: response.body,
+                     )
+                   end
+
+          Response.new(raw_response: response, result: result)
+        end
+
+      end
+    end
+  end
+end