scorm_engine 0.6.2 → 0.6.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f03bd17c2d3fdd0d6c6327553e3ed8657a7f6c796fa4535944cc003b5cc37335
-  data.tar.gz: c136aefda64d406464d3f88cf8e6e9f4954df53c93fe351b1c03daff64ce3187
+  metadata.gz: 84dbb575f6c280c28cdd591bed82b4d5f208f0a2f8a0d505b2fbbdbb46f37311
+  data.tar.gz: b60cd4cd6e1f823c9da3105e06391d322002230fe42c3e1479a7a7a34ea6d2b0
 SHA512:
-  metadata.gz: 98bdc0ec1d7dd57cdcb8cf64fcf2a64a5eb7a04b5da0763c4ab7c6ac7285b58119c93f8e5450f42bee9ad8c869a9824331ef4d9655b02a25880a2b2dfaa2aaf6
-  data.tar.gz: 7aefdb729d6c36ba334da198026f51f9bfbc78de9c8f65317c314e1e23f530961f4c4315b9654b582120603238990a2c06d7f8b535e05e63be845f9046c8efb7
+  metadata.gz: a908341227a9c67ee3c65b58c2bd0dd2232e9ce014146f866e2c238a404bda7da36c97086211f38a59e274d1d077ca96e599e4880afd9b40156df30f15f4180f
+  data.tar.gz: 89ef5d20c1d7bc5b5652fc2735609e9ed5160fc37cd0d8ff26189f0cf439eff3eda64ba0e4328818850caed8917788bfd6282573c060cfcbc817ba67cd704cd7

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

@@ -280,6 +280,7 @@ module ScormEngine
           options = options.dup
           dispatch_id = options.delete(:dispatch_id)
           options[:type] ||= "SCORM12"
+          options[:type]&.upcase!
 
           response = get("dispatches/#{dispatch_id}/zip", options)
 

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

@@ -242,11 +242,11 @@ module ScormEngine
         #   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")
+        # @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'
+        #   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.
@@ -271,10 +271,10 @@ module ScormEngine
           if options[:post_back]
             body[:postBack] = {
               url: options[:post_back][:url],
-              authType: options[:post_back][:auth_type],
+              authType: options[:post_back][:auth_type]&.upcase,
               userName: options[:post_back][:user_name],
               password: options[:post_back][:password],
-              resultsFormat: options[:post_back][:results_format],
+              resultsFormat: options[:post_back][:results_format]&.upcase,
             }.reject { |_k, v| v.nil? }
           end
 

data/lib/scorm_engine/configuration.rb

@@ -11,7 +11,7 @@ module ScormEngine
 
   class Configuration
     # http://rustici-docs.s3.amazonaws.com/engine/2017.1.x/api.html
-    attr_accessor :host, :path_prefix
+    attr_accessor :protocol, :host, :path_prefix
 
     # http://rustici-docs.s3.amazonaws.com/engine/2017.1.x/Architecture-API.html#api-authentication
     attr_accessor :username, :password
@@ -25,8 +25,9 @@ module ScormEngine
     end
 
     def reset
+      @protocol = ENV.fetch("SCORM_ENGINE_PROTOCOL", "https")
       @host = ENV["SCORM_ENGINE_HOST"]
-      @path_prefix = "/ScormEngineInterface/api/v1/"
+      @path_prefix = ENV.fetch("SCORM_ENGINE_PATH_PREFIX", "/ScormEngineInterface/api/v1/")
 
       @username = ENV["SCORM_ENGINE_USERNAME"]
       @password = ENV["SCORM_ENGINE_PASSWORD"]

data/lib/scorm_engine/faraday/connection.rb

@@ -7,7 +7,7 @@ module ScormEngine
 
       def base_uri
         uri = URI("")
-        uri.scheme = "https" # TODO: Make configurable
+        uri.scheme = ScormEngine.configuration.protocol
         uri.host = ScormEngine.configuration.host
         uri.path = ScormEngine.configuration.path_prefix
         URI(uri.to_s) # convert URI::Generic to URI:HTTPS

data/lib/scorm_engine/models/course.rb

@@ -3,11 +3,40 @@ require "time"
 module ScormEngine
   module Models
     class Course < Base
-      # TODO: Not sure we want this to be settable. Will depend on how we go
-      # about creating/updating records. For now it makes it easier to create
-      # instances from API options hash.
-      attr_accessor :id, :version, :title, :registration_count, :updated, :description,
-                    :scaled_passing_score
+      # @attr
+      # The external identification of this course.
+      # @return [String]
+      attr_accessor :id
+
+      # @attr
+      # The version of this course.
+      # @return [Integer]
+      attr_accessor :version
+
+      # @attr
+      # The title of this course.
+      # @return [String]
+      attr_accessor :title
+
+      # @attr
+      #
+      # @return [Integer]
+      attr_accessor :registration_count
+
+      # @attr
+      #
+      # @return [Time]
+      attr_accessor :updated
+
+      # @attr
+      # The description of this course.
+      # @return [String]
+      attr_accessor :description
+
+      # @attr
+      # The score required of a learner to pass this course.
+      # @return [Integer]
+      attr_accessor :scaled_passing_score
 
       # @attr
       # The course's learning standard.
@@ -32,7 +61,7 @@ module ScormEngine
         this.updated = Time.parse(options["updated"]) if options.key?("updated")
         this.description = options.fetch("metadata", {})["description"]
         this.scaled_passing_score = get_scaled_passing_score_from_api(options)
-        this.course_learning_standard = options["courseLearningStandard"]
+        this.course_learning_standard = options["courseLearningStandard"]&.upcase
         this.web_path = options["webPath"]
 
         this

data/lib/scorm_engine/models/course_configuration.rb

@@ -1,9 +1,9 @@
 module ScormEngine
   module Models
     class CourseConfiguration < Base
-      # TODO: Not sure we want this to be settable. Will depend on how we go
-      # about creating/updating records. For now it makes it easier to create
-      # instances from API options hash.
+      # @attr
+      #
+      # @return [Hash]
       attr_accessor :settings
 
       def self.new_from_api(options = {})

data/lib/scorm_engine/models/course_import.rb

@@ -1,10 +1,26 @@
 module ScormEngine
   module Models
     class CourseImport < Base
-      # TODO: Not sure we want this to be settable. Will depend on how we go
-      # about creating/updating records. For now it makes it easier to create
-      # instances from API options hash.
-      attr_accessor :id, :status, :parser_warnings, :course
+
+      # @attr
+      # The ID of this course import (not the course id)
+      # @return [String]
+      attr_accessor :id
+
+      # @attr
+      #
+      # @return [String] (RUNNING, COMPLETE, ERROR)
+      attr_accessor :status
+
+      # @attr
+      #
+      # @return [Array<String>]
+      attr_accessor :parser_warnings
+
+      # @attr
+      #
+      # @return [ScormEngine::Models::Course]
+      attr_accessor :course
 
       def self.new_from_api(options = {})
         this = new
@@ -12,11 +28,11 @@ module ScormEngine
 
         if options.key?("importResult")
           this.id = options["result"]
-          this.status = options.fetch("importResult", {})["status"]
+          this.status = options.fetch("importResult", {})["status"]&.upcase
           this.parser_warnings = options.fetch("importResult", {})["parserWarnings"]
         else
           this.id = options["jobId"]
-          this.status = options["status"]
+          this.status = options["status"]&.upcase
           this.course = Course.new_from_api(options["course"]) if options.key?("course") # unavailable in error states
         end
 

data/lib/scorm_engine/models/destination.rb

@@ -1,10 +1,15 @@
 module ScormEngine
   module Models
     class Destination < Base
-      # TODO: Not sure we want this to be settable. Will depend on how we go
-      # about creating/updating records. For now it makes it easier to create
-      # instances from API options hash.
-      attr_accessor :id, :name
+      # @attr
+      # The ID of this destination.
+      # @return [String]
+      attr_accessor :id
+
+      # @attr
+      # The name of this destination.
+      # @return [String]
+      attr_accessor :name
 
       def self.new_from_api(options = {})
         this = new

data/lib/scorm_engine/models/dispatch.rb

@@ -3,11 +3,50 @@ require "date"
 module ScormEngine
   module Models
     class Dispatch < Base
-      # TODO: Not sure we want this to be settable. Will depend on how we go
-      # about creating/updating records. For now it makes it easier to create
-      # instances from API options hash.
-      attr_accessor :id, :destination_id, :course_id, :allow_new_registrations,
-                    :instanced, :registration_cap, :expiration_date, :external_config
+      # @attr
+      # The external identification of this dispatch.
+      # @return [String]
+      attr_accessor :id
+
+      # @attr
+      # The external identification of the destination.
+      # @return [String]
+      attr_accessor :destination_id
+
+      # @attr
+      # The external identification of the course.
+      # @return [String]
+      attr_accessor :course_id
+
+      # @attr
+      # If true, then new registrations can be created for this dispatch.
+      # @return [Boolean]
+      attr_accessor :allow_new_registrations
+
+      # @attr
+      # 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.
+      # @return [Boolean]
+      attr_accessor :instanced
+
+      # @attr
+      # The maximum number of registrations that can be created for this
+      # dispatch, where '0' means 'unlimited registrations'.
+      # @return [Integer]
+      attr_accessor :registration_cap
+
+      # @attr
+      # The date after which this dispatch will be disabled as an ISO 8601
+      # string, or "none" for no expiration date.
+      # @return [Time]
+      attr_accessor :expiration_date
+
+      # @attr
+      # Serialized external configuration information to include when launching
+      # the dispatched package.
+      # @return [String]
+      attr_accessor :external_config
 
       def self.new_from_api(options = {})
         this = new

data/lib/scorm_engine/models/dispatch_zip.rb

@@ -1,12 +1,30 @@
 module ScormEngine
   module Models
     class DispatchZip < Base
-      attr_accessor :dispatch_id, :type, :filename, :body
+      # @attr
+      # The external identification of the dispatch.
+      # @return [String]
+      attr_accessor :dispatch_id
+
+      # @attr
+      # The type of ZIP package to generate.
+      # @return [String] (SCORM12, SCORM2004-3RD, AICC)
+      attr_accessor :type
+
+      # @attr
+      #
+      # @return [String]
+      attr_accessor :filename
+
+      # @attr
+      #
+      # @return [String]
+      attr_accessor :body
 
       def initialize(options = {})
         @options = options.dup
         @dispatch_id = options[:dispatch_id]
-        @type = options[:type]
+        @type = options[:type]&.upcase
         @filename = options[:filename]
         @body = options[:body]
       end

data/lib/scorm_engine/models/learner.rb

@@ -1,10 +1,20 @@
 module ScormEngine
   module Models
     class Learner < Base
-      # TODO: Not sure we want this to be settable. Will depend on how we go
-      # about creating/updating records. For now it makes it easier to create
-      # instances from API options hash.
-      attr_accessor :id, :first_name, :last_name
+      # @attr
+      # The external identification of the learner.
+      # @return [String]
+      attr_accessor :id
+
+      # @attr
+      # The learner's first name.
+      # @return [String]
+      attr_accessor :first_name
+
+      # @attr
+      # The learner's last name.
+      # @return [String]
+      attr_accessor :last_name
 
       def self.new_from_api(options = {})
         this = new

data/lib/scorm_engine/models/registration.rb

@@ -1,21 +1,10 @@
-#
-# TODO: Incorporate all the activity props from:
-#   http://rustici-docs.s3.amazonaws.com/engine/2017.1.x/api.html#tenant__registrations__registrationId__progress_get
-#   http://rustici-docs.s3.amazonaws.com/engine/2017.1.x/api.html#tenant__registrations__registrationId__progress_detail_get
-#
-# TODO: Confirmed they are the only values. Integrate them into the model.
-#       registrationCompletion: ["COMPLETED", "INCOMPLETE", "UNKNOWN"]
-#       registrationSuccess: ["Unknown", "Passed", "Failed"]
-#
 module ScormEngine
   module Models
     class Registration < Base
-      # TODO: Not sure we want this to be settable. Will depend on how we go
-      # about creating/updating records. For now it makes it easier to create
-      # instances from API options hash.
-      attr_accessor :id, :instance, :updated,
-        :total_seconds_tracked, :score, :course, :learner, :activity_details,
-        :first_access_date, :last_access_date, :completed_date, :created_date
+      # @attr
+      # The external identification of the registration.
+      # @return [String]
+      attr_accessor :id
 
       # @attr
       # Has this registration been completed?
@@ -37,6 +26,62 @@ module ScormEngine
       # @return [Float] (Unknown Passed Failed)
       attr_accessor :registration_completion_amount
 
+      # @attr
+      # Instance of this registration (typically used for reoccurring training), starts at 0.
+
+      # @return [String]
+      attr_accessor :instance
+
+      # @attr
+      #
+      # @return [Time]
+      attr_accessor :updated
+
+      # @attr
+      # How long the learner spent taking this registration, in seconds.
+      # @return [Integer]
+      attr_accessor :total_seconds_tracked
+
+      # @attr
+      # Scaled score between 0 and 100.
+      # @return [Float]
+      attr_accessor :score
+
+      # @attr
+      #
+      # @return [ScormEngine::Models::Course]
+      attr_accessor :course
+
+      # @attr
+      #
+      # @return [ScormEngine::Models::Learner]
+      attr_accessor :learner
+
+      # @attr
+      #
+      # @return [ScormEngine::Models::RegistrationActivityDetail]
+      attr_accessor :activity_details
+
+      # @attr
+      # Time of the learner's first interaction with this registration.
+      # @return [Time]
+      attr_accessor :first_access_date
+
+      # @attr
+      # Time of the learner's last interaction with this registration.
+      # @return [Time]
+      attr_accessor :last_access_date
+
+      # @attr
+      # Time of the learner's first completion of this registration.
+      # @return [Time]
+      attr_accessor :completed_date
+
+      # @attr
+      # Time of the creation of this registration.
+      # @return [Time]
+      attr_accessor :created_date
+
       def self.new_from_api(options = {})
         this = new
 
@@ -44,9 +89,9 @@ module ScormEngine
         this.id = options["id"]
         this.instance = options["instance"]
         this.updated = Time.parse(options["updated"]) if options.key?("updated")
-        this.registration_completion = options["registrationCompletion"]
-        this.registration_success = options["registrationSuccess"]
-        this.total_seconds_tracked = options["totalSecondsTracked"]
+        this.registration_completion = options["registrationCompletion"]&.upcase
+        this.registration_success = options["registrationSuccess"]&.upcase
+        this.total_seconds_tracked = options["totalSecondsTracked"]&.to_i
         this.first_access_date = Time.parse(options["firstAccessDate"]) if options.key?("firstAccessDate")
         this.last_access_date = Time.parse(options["lastAccessDate"]) if options.key?("lastAccessDate")
         this.created_date = Time.parse(options["createdDate"]) if options.key?("createdDate")
@@ -92,8 +137,8 @@ module ScormEngine
       #   Returns true, false or nil if success status is unknown.
       #
       def passed?
-        return nil if registration_success == "Unknown"
-        registration_success == "Passed"
+        return nil if registration_success == "UNKNOWN"
+        registration_success == "PASSED"
       end
 
       #
@@ -103,8 +148,8 @@ module ScormEngine
       #   Returns true, false or nil if success status is unknown.
       #
       def failed?
-        return nil if registration_success == "Unknown"
-        registration_success == "Failed"
+        return nil if registration_success == "UNKNOWN"
+        registration_success == "FAILED"
       end
 
       #