scorm_engine 0.6.10 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0f641dd96f8aa0bd99d360d711fdd5df21d29256087d2fa3b6379236d31dfb3d
-  data.tar.gz: '088b0d95759b970b4ac6d9254ae6a2837cd14fec77a600b0e37ef4e56f7d9c03'
+  metadata.gz: 96f9e3115cb5345e489c54e9d49ac10dd67b1b2bb7dbd30878a222c5eca3dde5
+  data.tar.gz: a64f2c8ce1dcc564e71d06a020324e947406020e5930f24a5f59b91b377d47c5
 SHA512:
-  metadata.gz: 426200281300e123425f2eebfffcec80fab4963f2489fa3dfa0e8ae56e60919c3cfc59d6a85d7bc97c5ec397ab2ec0f47bb7f5ba1762f4ea3e0cd7c924731706
-  data.tar.gz: 480436fec2288e0a753b92dd7b3d4e15f95aad359e2c69e1d95b5336d0f5a2ce18f0f4f62738388689e137cd275c105a633928631dec4ae6b6779082415454d6
+  metadata.gz: 15dae198e937cfe18146767424e8361a7464372137dda3123a78cabcd87f3b9d0d2da92e566dfa82f942f3955caff1246160311ea403a2afb084fd95f5503ba9
+  data.tar.gz: 189edb44a0f257a82336efdb39e4876b47c16a021cc49d81db2644aac2068167d7b06193e80e52dfc0fc4c1866d1ce635f5f8564c32958cbccab013bb8c46d1b

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

@@ -49,6 +49,11 @@ module ScormEngine
               mayCreateNewVersion: !!options[:may_create_new_version]
             }
 
+            # When loading from a URL, we pass the URL and course name in the
+            # body as JSON. When loading from a file, the file's contents get
+            # placed in the body. In the latter case we can't pass in any other
+            # parameters, because the SCORM server doesn't know how to deal
+            # with multipart bodies and will become confused.
             body = if options[:url]
                      { url: options[:url], courseName: options[:name] || options[:course_id] }
                    elsif options[:pathname]

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

@@ -69,7 +69,7 @@ module ScormEngine
         #
         # @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.
+        #   string, or "none" for no expiration date.
         #
         # @option options [String] :external_config ("")
         #   Serialized external configuration information to include when
@@ -80,18 +80,7 @@ module ScormEngine
         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
+          options = coerce_dispatch_options(options.dup)
 
           body = {
             dispatches: [
@@ -152,22 +141,22 @@ module ScormEngine
         # @option options [String] :course_id
         #   The course ID.
         #
-        # @option options [Boolean] :allow_new_registrations (false)
+        # @option options [Boolean] :allow_new_registrations
         #   If true, then new registrations can be created for this dispatch.
         #
-        # @option options [Boolean] :instanced (false)
+        # @option options [Boolean] :instanced
         #   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)
+        # @option options [Integer] :registration_cap
         #   The maximum number of registrations that can be created for this
         #   dispatch, where '0' means 'unlimited registrations'.
         #
-        # @option options [Date] :expiration_date ("none")
+        # @option options [Date] :expiration_date
         #   The date after which this dispatch will be disabled as an ISO 8601
-        #   string, or \"none\" for no expiration date.
+        #   string, or "none" for no expiration date.
         #
         # @option options [String] :external_config ("")
         #   Serialized external configuration information to include when
@@ -176,7 +165,10 @@ module ScormEngine
         # @return [ScormEngine::Response]
         #
         def put_dispatch(options = {})
-          require_options(options, :dispatch_id, :destination_id, :course_id)
+          require_options(options, :dispatch_id, :destination_id, :course_id,
+                          :allow_new_registrations, :instanced, :registration_cap, :expiration_date)
+
+          options = coerce_dispatch_options(options.dup)
 
           body = {
             destinationId: options[:destination_id],
@@ -297,6 +289,23 @@ module ScormEngine
           Response.new(raw_response: response, result: result)
         end
 
+        private
+
+        def coerce_dispatch_options(options = {})
+          options[:allow_new_registrations] = !!options[:allow_new_registrations]
+          options[:instanced] = !!options[:instanced]
+          options[:registration_cap] = [0, options[:registration_cap].to_i].max
+          options[:expiration_date] = coerce_expiration_date(options[:expiration_date])
+          options
+        end
+
+        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
+          raise(ArgumentError, "Invalid option expiration_date")
+        end
       end
     end
   end

data/lib/scorm_engine/version.rb

@@ -1,3 +1,3 @@
 module ScormEngine
-  VERSION = "0.6.10".freeze
+  VERSION = "0.7.0".freeze
 end

data/spec/fixtures/vcr/ScormEngine_Api_Endpoints_Dispatches/_delete_dispatch/returns_success_even_when_id_is_invalid.yml

@@ -8,7 +8,7 @@ http_interactions:
       string: ''
     headers:
       User-Agent:
-      - ScormEngine Ruby Gem 0.3.0
+      - ScormEngine Ruby Gem 0.6.10
       Authorization:
       - Basic <BASIC_AUTH>
   response:
@@ -17,7 +17,7 @@ http_interactions:
       message: ''
     headers:
       date:
-      - Mon, 20 Aug 2018 23:04:55 GMT
+      - Thu, 04 Oct 2018 21:22:02 GMT
       server:
       - nginx
       connection:
@@ -26,5 +26,5 @@ http_interactions:
       encoding: UTF-8
       string: ''
     http_version: 
-  recorded_at: Mon, 20 Aug 2018 23:04:55 GMT
+  recorded_at: Thu, 04 Oct 2018 21:22:02 GMT
 recorded_with: VCR 4.0.0

data/spec/fixtures/vcr/ScormEngine_Api_Endpoints_Dispatches/_delete_dispatch/works.yml

@@ -8,7 +8,7 @@ http_interactions:
       string: ''
     headers:
       User-Agent:
-      - ScormEngine Ruby Gem 0.3.0
+      - ScormEngine Ruby Gem 0.6.10
       Authorization:
       - Basic <BASIC_AUTH>
   response:
@@ -17,7 +17,7 @@ http_interactions:
       message: ''
     headers:
       date:
-      - Mon, 20 Aug 2018 23:04:51 GMT
+      - Thu, 04 Oct 2018 21:22:04 GMT
       server:
       - nginx
       connection:
@@ -26,5 +26,5 @@ http_interactions:
       encoding: UTF-8
       string: ''
     http_version: 
-  recorded_at: Mon, 20 Aug 2018 23:04:51 GMT
+  recorded_at: Thu, 04 Oct 2018 21:22:04 GMT
 recorded_with: VCR 4.0.0

data/spec/fixtures/vcr/ScormEngine_Api_Endpoints_Dispatches/_get_dispatch/fails_when_id_is_invalid.yml

@@ -8,7 +8,7 @@ http_interactions:
       string: ''
     headers:
       User-Agent:
-      - ScormEngine Ruby Gem 0.3.0
+      - ScormEngine Ruby Gem 0.6.10
       Authorization:
       - Basic <BASIC_AUTH>
   response:
@@ -19,7 +19,7 @@ http_interactions:
       content-type:
       - application/json
       date:
-      - Mon, 20 Aug 2018 23:05:24 GMT
+      - Thu, 04 Oct 2018 21:22:21 GMT
       server:
       - nginx
       vary:
@@ -32,5 +32,5 @@ http_interactions:
       encoding: ASCII-8BIT
       string: '{"message":"No dispatches found with ID: nonexistent-dispatch"}'
     http_version: 
-  recorded_at: Mon, 20 Aug 2018 23:05:24 GMT
+  recorded_at: Thu, 04 Oct 2018 21:22:21 GMT
 recorded_with: VCR 4.0.0

data/spec/fixtures/vcr/ScormEngine_Api_Endpoints_Dispatches/_get_dispatch/is_successful.yml

@@ -2,13 +2,13 @@
 http_interactions:
 - request:
     method: get
-    uri: https://<SCORM_ENGINE_HOST>/ScormEngineInterface/api/v1/ScormEngineGemTesting-default/dispatches/testing-dispatch-id
+    uri: https://<SCORM_ENGINE_HOST>/ScormEngineInterface/api/v1/ScormEngineGemTesting-default/dispatches/testing-dispatch-id-2
     body:
       encoding: US-ASCII
       string: ''
     headers:
       User-Agent:
-      - ScormEngine Ruby Gem 0.3.0
+      - ScormEngine Ruby Gem 0.6.10
       Authorization:
       - Basic <BASIC_AUTH>
   response:
@@ -19,18 +19,18 @@ http_interactions:
       content-type:
       - application/json
       date:
-      - Mon, 20 Aug 2018 23:05:23 GMT
+      - Thu, 04 Oct 2018 21:22:19 GMT
       server:
       - nginx
       vary:
       - Accept-Encoding
       content-length:
-      - '178'
+      - '196'
       connection:
       - Close
     body:
       encoding: ASCII-8BIT
-      string: '{"destinationId":"testing-golf-club","courseId":"testing-golf-explained","allowNewRegistrations":false,"instanced":false,"registrationCap":0,"expirationDate":"none","externalConfig":"scormenginegemtesting-default","enabled":true,"registrationCount":0,"registrationResetDate":"none"}'
+      string: '{"destinationId":"testing-golf-club","courseId":"testing-golf-explained","allowNewRegistrations":false,"instanced":false,"registrationCap":123,"expirationDate":"2018-01-01T00:00:00Z","externalConfig":"scormenginegemtesting-default","enabled":false,"registrationCount":0,"registrationResetDate":"none"}'
     http_version: 
-  recorded_at: Mon, 20 Aug 2018 23:05:23 GMT
+  recorded_at: Thu, 04 Oct 2018 21:22:19 GMT
 recorded_with: VCR 4.0.0

data/spec/fixtures/vcr/ScormEngine_Api_Endpoints_Dispatches/_get_dispatch/results/sucessfully_creates_the_dispatch_attributes.yml

@@ -2,13 +2,13 @@
 http_interactions:
 - request:
     method: get
-    uri: https://<SCORM_ENGINE_HOST>/ScormEngineInterface/api/v1/ScormEngineGemTesting-default/dispatches/testing-dispatch-id
+    uri: https://<SCORM_ENGINE_HOST>/ScormEngineInterface/api/v1/ScormEngineGemTesting-default/dispatches/testing-dispatch-id-2
     body:
       encoding: US-ASCII
       string: ''
     headers:
       User-Agent:
-      - ScormEngine Ruby Gem 0.3.0
+      - ScormEngine Ruby Gem 0.6.10
       Authorization:
       - Basic <BASIC_AUTH>
   response:
@@ -19,18 +19,18 @@ http_interactions:
       content-type:
       - application/json
       date:
-      - Mon, 20 Aug 2018 23:05:26 GMT
+      - Thu, 04 Oct 2018 21:24:05 GMT
       server:
       - nginx
       vary:
       - Accept-Encoding
       content-length:
-      - '178'
+      - '199'
       connection:
       - Close
     body:
       encoding: ASCII-8BIT
-      string: '{"destinationId":"testing-golf-club","courseId":"testing-golf-explained","allowNewRegistrations":false,"instanced":false,"registrationCap":0,"expirationDate":"none","externalConfig":"scormenginegemtesting-default","enabled":true,"registrationCount":0,"registrationResetDate":"none"}'
+      string: '{"destinationId":"testing-golf-club","courseId":"testing-golf-explained","allowNewRegistrations":false,"instanced":false,"registrationCap":123,"expirationDate":"2018-01-01T00:00:00Z","externalConfig":"scormenginegemtesting-default","enabled":true,"registrationCount":0,"registrationResetDate":"none"}'
     http_version: 
-  recorded_at: Mon, 20 Aug 2018 23:05:26 GMT
+  recorded_at: Thu, 04 Oct 2018 21:24:05 GMT
 recorded_with: VCR 4.0.0

data/spec/fixtures/vcr/ScormEngine_Api_Endpoints_Dispatches/_get_dispatch_enabled/is_false_when_disabled.yml

@@ -2,13 +2,13 @@
 http_interactions:
 - request:
     method: put
-    uri: https://<SCORM_ENGINE_HOST>/ScormEngineInterface/api/v1/ScormEngineGemTesting-default/dispatches/testing-dispatch-id/enabled
+    uri: https://<SCORM_ENGINE_HOST>/ScormEngineInterface/api/v1/ScormEngineGemTesting-default/dispatches/testing-dispatch-id-2/enabled
     body:
       encoding: US-ASCII
       string: 'false'
     headers:
       User-Agent:
-      - ScormEngine Ruby Gem 0.3.0
+      - ScormEngine Ruby Gem 0.6.10
       Authorization:
       - Basic <BASIC_AUTH>
       Content-Type:
@@ -19,7 +19,7 @@ http_interactions:
       message: ''
     headers:
       date:
-      - Mon, 20 Aug 2018 23:04:26 GMT
+      - Thu, 04 Oct 2018 21:22:25 GMT
       server:
       - nginx
       connection:
@@ -28,16 +28,16 @@ http_interactions:
       encoding: UTF-8
       string: ''
     http_version: 
-  recorded_at: Mon, 20 Aug 2018 23:04:27 GMT
+  recorded_at: Thu, 04 Oct 2018 21:22:25 GMT
 - request:
     method: get
-    uri: https://<SCORM_ENGINE_HOST>/ScormEngineInterface/api/v1/ScormEngineGemTesting-default/dispatches/testing-dispatch-id/enabled
+    uri: https://<SCORM_ENGINE_HOST>/ScormEngineInterface/api/v1/ScormEngineGemTesting-default/dispatches/testing-dispatch-id-2/enabled
     body:
       encoding: US-ASCII
       string: ''
     headers:
       User-Agent:
-      - ScormEngine Ruby Gem 0.3.0
+      - ScormEngine Ruby Gem 0.6.10
       Authorization:
       - Basic <BASIC_AUTH>
   response:
@@ -48,7 +48,7 @@ http_interactions:
       content-type:
       - application/json
       date:
-      - Mon, 20 Aug 2018 23:04:27 GMT
+      - Thu, 04 Oct 2018 21:22:26 GMT
       server:
       - nginx
       content-length:
@@ -59,5 +59,5 @@ http_interactions:
       encoding: UTF-8
       string: 'false'
     http_version: 
-  recorded_at: Mon, 20 Aug 2018 23:04:27 GMT
+  recorded_at: Thu, 04 Oct 2018 21:22:26 GMT
 recorded_with: VCR 4.0.0

data/spec/fixtures/vcr/ScormEngine_Api_Endpoints_Dispatches/_get_dispatch_enabled/is_true_when_enabled.yml

@@ -2,13 +2,13 @@
 http_interactions:
 - request:
     method: put
-    uri: https://<SCORM_ENGINE_HOST>/ScormEngineInterface/api/v1/ScormEngineGemTesting-default/dispatches/testing-dispatch-id/enabled
+    uri: https://<SCORM_ENGINE_HOST>/ScormEngineInterface/api/v1/ScormEngineGemTesting-default/dispatches/testing-dispatch-id-2/enabled
     body:
       encoding: US-ASCII
       string: 'true'
     headers:
       User-Agent:
-      - ScormEngine Ruby Gem 0.3.0
+      - ScormEngine Ruby Gem 0.6.10
       Authorization:
       - Basic <BASIC_AUTH>
       Content-Type:
@@ -19,7 +19,7 @@ http_interactions:
       message: ''
     headers:
       date:
-      - Mon, 20 Aug 2018 23:04:29 GMT
+      - Thu, 04 Oct 2018 21:22:28 GMT
       server:
       - nginx
       connection:
@@ -28,16 +28,16 @@ http_interactions:
       encoding: UTF-8
       string: ''
     http_version: 
-  recorded_at: Mon, 20 Aug 2018 23:04:29 GMT
+  recorded_at: Thu, 04 Oct 2018 21:22:28 GMT
 - request:
     method: get
-    uri: https://<SCORM_ENGINE_HOST>/ScormEngineInterface/api/v1/ScormEngineGemTesting-default/dispatches/testing-dispatch-id/enabled
+    uri: https://<SCORM_ENGINE_HOST>/ScormEngineInterface/api/v1/ScormEngineGemTesting-default/dispatches/testing-dispatch-id-2/enabled
     body:
       encoding: US-ASCII
       string: ''
     headers:
       User-Agent:
-      - ScormEngine Ruby Gem 0.3.0
+      - ScormEngine Ruby Gem 0.6.10
       Authorization:
       - Basic <BASIC_AUTH>
   response:
@@ -48,7 +48,7 @@ http_interactions:
       content-type:
       - application/json
       date:
-      - Mon, 20 Aug 2018 23:04:29 GMT
+      - Thu, 04 Oct 2018 21:22:28 GMT
       server:
       - nginx
       content-length:
@@ -59,5 +59,5 @@ http_interactions:
       encoding: UTF-8
       string: 'true'
     http_version: 
-  recorded_at: Mon, 20 Aug 2018 23:04:29 GMT
+  recorded_at: Thu, 04 Oct 2018 21:22:28 GMT
 recorded_with: VCR 4.0.0

data/spec/fixtures/vcr/ScormEngine_Api_Endpoints_Dispatches/_get_dispatch_zip/fails_given_an_invalid_id.yml

@@ -8,7 +8,7 @@ http_interactions:
       string: ''
     headers:
       User-Agent:
-      - ScormEngine Ruby Gem 0.6.2
+      - ScormEngine Ruby Gem 0.6.10
       Authorization:
       - Basic <BASIC_AUTH>
   response:
@@ -19,7 +19,7 @@ http_interactions:
       content-type:
       - application/json
       date:
-      - Fri, 24 Aug 2018 21:38:12 GMT
+      - Thu, 04 Oct 2018 21:22:10 GMT
       server:
       - nginx
       vary:
@@ -32,5 +32,5 @@ http_interactions:
       encoding: ASCII-8BIT
       string: '{"message":"No dispatches found with ID: nonexistent-dispatch"}'
     http_version: 
-  recorded_at: Fri, 24 Aug 2018 21:38:12 GMT
+  recorded_at: Thu, 04 Oct 2018 21:22:10 GMT
 recorded_with: VCR 4.0.0

data/spec/fixtures/vcr/ScormEngine_Api_Endpoints_Dispatches/_get_dispatch_zip/fails_given_an_invalid_type.yml

@@ -2,13 +2,13 @@
 http_interactions:
 - request:
     method: get
-    uri: https://<SCORM_ENGINE_HOST>/ScormEngineInterface/api/v1/ScormEngineGemTesting-default/dispatches/testing-dispatch-id/zip?type=OOPS
+    uri: https://<SCORM_ENGINE_HOST>/ScormEngineInterface/api/v1/ScormEngineGemTesting-default/dispatches/testing-dispatch-id-2/zip?type=OOPS
     body:
       encoding: US-ASCII
       string: ''
     headers:
       User-Agent:
-      - ScormEngine Ruby Gem 0.6.2
+      - ScormEngine Ruby Gem 0.6.10
       Authorization:
       - Basic <BASIC_AUTH>
   response:
@@ -19,7 +19,7 @@ http_interactions:
       content-type:
       - application/json
       date:
-      - Fri, 24 Aug 2018 21:38:14 GMT
+      - Thu, 04 Oct 2018 21:22:08 GMT
       server:
       - nginx
       content-length:
@@ -30,5 +30,5 @@ http_interactions:
       encoding: UTF-8
       string: '{"message":"The value ''OOPS'' is not a valid Dispatch Type."}'
     http_version: 
-  recorded_at: Fri, 24 Aug 2018 21:38:14 GMT
+  recorded_at: Thu, 04 Oct 2018 21:22:08 GMT
 recorded_with: VCR 4.0.0