scorm_engine 0.6.10 → 0.7.0

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

@@ -2,13 +2,13 @@
 http_interactions:
 - request:
     method: delete
-    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:
@@ -17,7 +17,7 @@ http_interactions:
       message: ''
     headers:
       date:
-      - Mon, 20 Aug 2018 23:04:57 GMT
+      - Thu, 04 Oct 2018 21:23:10 GMT
       server:
       - nginx
       connection:
@@ -26,16 +26,16 @@ http_interactions:
       encoding: UTF-8
       string: ''
     http_version: 
-  recorded_at: Mon, 20 Aug 2018 23:04:57 GMT
+  recorded_at: Thu, 04 Oct 2018 21:23:11 GMT
 - request:
     method: post
     uri: https://<SCORM_ENGINE_HOST>/ScormEngineInterface/api/v1/ScormEngineGemTesting-default/dispatches
     body:
       encoding: UTF-8
-      string: '{"dispatches":[{"id":"testing-dispatch-id","data":{"destinationId":"testing-golf-club","courseId":"testing-golf-explained","allowNewRegistrations":false,"instanced":false,"registrationCap":0,"expirationDate":null,"externalConfig":null}}]}'
+      string: '{"dispatches":[{"id":"testing-dispatch-id-2","data":{"destinationId":"testing-golf-club","courseId":"testing-golf-explained","allowNewRegistrations":false,"instanced":false,"registrationCap":123,"expirationDate":"2018-01-01","externalConfig":null}}]}'
     headers:
       User-Agent:
-      - ScormEngine Ruby Gem 0.3.0
+      - ScormEngine Ruby Gem 0.6.10
       Authorization:
       - Basic <BASIC_AUTH>
       Content-Type:
@@ -46,7 +46,7 @@ http_interactions:
       message: ''
     headers:
       date:
-      - Mon, 20 Aug 2018 23:04:57 GMT
+      - Thu, 04 Oct 2018 21:23:11 GMT
       server:
       - nginx
       connection:
@@ -55,5 +55,5 @@ http_interactions:
       encoding: UTF-8
       string: ''
     http_version: 
-  recorded_at: Mon, 20 Aug 2018 23:04:57 GMT
+  recorded_at: Thu, 04 Oct 2018 21:23:11 GMT
 recorded_with: VCR 4.0.0

data/spec/fixtures/vcr/ScormEngine_Api_Endpoints_Dispatches/_post_dispatch/{is_updates_if_same_dispatch_id.yml → updates_if_same_dispatch_id.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.6.6
+      - ScormEngine Ruby Gem 0.6.10
       Authorization:
       - Basic <BASIC_AUTH>
   response:
@@ -19,29 +19,29 @@ http_interactions:
       content-type:
       - application/json
       date:
-      - Mon, 17 Sep 2018 22:04:10 GMT
+      - Thu, 04 Oct 2018 21:23:08 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, 17 Sep 2018 22:04:10 GMT
+  recorded_at: Thu, 04 Oct 2018 21:23:08 GMT
 - request:
     method: post
     uri: https://<SCORM_ENGINE_HOST>/ScormEngineInterface/api/v1/ScormEngineGemTesting-default/dispatches
     body:
       encoding: UTF-8
-      string: '{"dispatches":[{"id":"testing-dispatch-id","data":{"destinationId":"testing-golf-club","courseId":"testing-golf-explained","allowNewRegistrations":false,"instanced":false,"registrationCap":0,"expirationDate":"2030-01-01","externalConfig":null}}]}'
+      string: '{"dispatches":[{"id":"testing-dispatch-id-2","data":{"destinationId":"testing-golf-club","courseId":"testing-golf-explained","allowNewRegistrations":false,"instanced":false,"registrationCap":123,"expirationDate":"2030-01-01","externalConfig":null}}]}'
     headers:
       User-Agent:
-      - ScormEngine Ruby Gem 0.6.6
+      - ScormEngine Ruby Gem 0.6.10
       Authorization:
       - Basic <BASIC_AUTH>
       Content-Type:
@@ -52,7 +52,7 @@ http_interactions:
       message: ''
     headers:
       date:
-      - Mon, 17 Sep 2018 22:04:11 GMT
+      - Thu, 04 Oct 2018 21:23:08 GMT
       server:
       - nginx
       connection:
@@ -61,16 +61,16 @@ http_interactions:
       encoding: UTF-8
       string: ''
     http_version: 
-  recorded_at: Mon, 17 Sep 2018 22:04:11 GMT
+  recorded_at: Thu, 04 Oct 2018 21:23:08 GMT
 - 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.6.6
+      - ScormEngine Ruby Gem 0.6.10
       Authorization:
       - Basic <BASIC_AUTH>
   response:
@@ -81,18 +81,18 @@ http_interactions:
       content-type:
       - application/json
       date:
-      - Mon, 17 Sep 2018 22:04:11 GMT
+      - Thu, 04 Oct 2018 21:23:08 GMT
       server:
       - nginx
       vary:
       - Accept-Encoding
       content-length:
-      - '196'
+      - '198'
       connection:
       - Close
     body:
       encoding: ASCII-8BIT
-      string: '{"destinationId":"testing-golf-club","courseId":"testing-golf-explained","allowNewRegistrations":false,"instanced":false,"registrationCap":0,"expirationDate":"2030-01-01T00:00:00Z","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":"2030-01-01T00:00:00Z","externalConfig":"scormenginegemtesting-default","enabled":true,"registrationCount":0,"registrationResetDate":"none"}'
     http_version: 
-  recorded_at: Mon, 17 Sep 2018 22:04:11 GMT
+  recorded_at: Thu, 04 Oct 2018 21:23:09 GMT
 recorded_with: VCR 4.0.0

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

@@ -2,13 +2,13 @@
 http_interactions:
 - request:
     method: put
-    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: UTF-8
       string: '{"destinationId":"testing-golf-club","courseId":"testing-golf-explained","allowNewRegistrations":false,"instanced":false,"registrationCap":123,"expirationDate":"2018-01-01","externalConfig":null}'
     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:42 GMT
+      - Thu, 04 Oct 2018 21:21:44 GMT
       server:
       - nginx
       connection:
@@ -28,5 +28,5 @@ http_interactions:
       encoding: UTF-8
       string: ''
     http_version: 
-  recorded_at: Mon, 20 Aug 2018 23:04:42 GMT
+  recorded_at: Thu, 04 Oct 2018 21:21:44 GMT
 recorded_with: VCR 4.0.0

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

@@ -2,13 +2,13 @@
 http_interactions:
 - request:
     method: put
-    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: UTF-8
       string: '{"destinationId":"testing-golf-club","courseId":"testing-golf-explained","allowNewRegistrations":false,"instanced":false,"registrationCap":123,"expirationDate":"2018-01-01","externalConfig":null}'
     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:44 GMT
+      - Thu, 04 Oct 2018 21:21:56 GMT
       server:
       - nginx
       connection:
@@ -28,16 +28,16 @@ http_interactions:
       encoding: UTF-8
       string: ''
     http_version: 
-  recorded_at: Mon, 20 Aug 2018 23:04:44 GMT
+  recorded_at: Thu, 04 Oct 2018 21:21:56 GMT
 - 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:
@@ -48,18 +48,18 @@ http_interactions:
       content-type:
       - application/json
       date:
-      - Mon, 20 Aug 2018 23:04:44 GMT
+      - Thu, 04 Oct 2018 21:21:56 GMT
       server:
       - nginx
       vary:
       - Accept-Encoding
       content-length:
-      - '199'
+      - '196'
       connection:
       - Close
     body:
       encoding: ASCII-8BIT
-      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"}'
+      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:04:44 GMT
+  recorded_at: Thu, 04 Oct 2018 21:21:56 GMT
 recorded_with: VCR 4.0.0

data/spec/fixtures/vcr/ScormEngine_Api_Endpoints_Dispatches/_put_dispatch_enabled/fails_when_invalid.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: UTF-8
       string: oops
     headers:
       User-Agent:
-      - ScormEngine Ruby Gem 0.3.0
+      - ScormEngine Ruby Gem 0.6.10
       Authorization:
       - Basic <BASIC_AUTH>
       Content-Type:
@@ -21,7 +21,7 @@ http_interactions:
       content-type:
       - text/plain
       date:
-      - Mon, 20 Aug 2018 23:04:49 GMT
+      - Thu, 04 Oct 2018 21:22:30 GMT
       server:
       - nginx
       content-length:
@@ -32,7 +32,7 @@ http_interactions:
       encoding: UTF-8
       string: |-
         Unrecognized token 'oops': was expecting ('true', 'false' or 'null')
-         at [Source: org.glassfish.jersey.message.internal.ReaderInterceptorExecutor$UnCloseableInputStream@7e3cc9a0; line: 1, column: 9]
+         at [Source: org.glassfish.jersey.message.internal.ReaderInterceptorExecutor$UnCloseableInputStream@57adebb3; line: 1, column: 9]
     http_version: 
-  recorded_at: Mon, 20 Aug 2018 23:04:49 GMT
+  recorded_at: Thu, 04 Oct 2018 21:22:30 GMT
 recorded_with: VCR 4.0.0

data/spec/fixtures/vcr/ScormEngine_Api_Endpoints_Dispatches/_put_dispatch_enabled/works_when_false.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:47 GMT
+      - Thu, 04 Oct 2018 21:22:32 GMT
       server:
       - nginx
       connection:
@@ -28,5 +28,5 @@ http_interactions:
       encoding: UTF-8
       string: ''
     http_version: 
-  recorded_at: Mon, 20 Aug 2018 23:04:47 GMT
+  recorded_at: Thu, 04 Oct 2018 21:22:32 GMT
 recorded_with: VCR 4.0.0

data/spec/fixtures/vcr/ScormEngine_Api_Endpoints_Dispatches/_put_dispatch_enabled/works_when_true.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:46 GMT
+      - Thu, 04 Oct 2018 21:22:34 GMT
       server:
       - nginx
       connection:
@@ -28,5 +28,5 @@ http_interactions:
       encoding: UTF-8
       string: ''
     http_version: 
-  recorded_at: Mon, 20 Aug 2018 23:04:46 GMT
+  recorded_at: Thu, 04 Oct 2018 21:22:34 GMT
 recorded_with: VCR 4.0.0

data/spec/scorm_engine/api/endpoints/dispatches_spec.rb

@@ -15,7 +15,11 @@ RSpec.describe ScormEngine::Api::Endpoints::Dispatches do
   let(:dispatch_options) { {
     destination_id: destination_options[:destination_id],
     course_id: course_options[:course_id],
-    dispatch_id: "testing-dispatch-id",
+    dispatch_id: "testing-dispatch-id-2",
+    allow_new_registrations: false,
+    instanced: false,
+    registration_cap: 123,
+    expiration_date: "2018-01-01",
   } }
 
   before do
@@ -100,9 +104,15 @@ RSpec.describe ScormEngine::Api::Endpoints::Dispatches do
       end
     end
 
-    it "is updates if same dispatch_id" do
+    it "raises ArgumentError when :expiration_date is invalid string" do
+      expect {
+        subject.post_dispatch(dispatch_options.merge(expiration_date: "not-a-parsable-date"))
+      }.to raise_error(ArgumentError, /Invalid option expiration_date/)
+    end
+
+    it "updates if same dispatch_id" do
       response = subject.get_dispatch(dispatch_id: dispatch_options[:dispatch_id])
-      expect(response.result.expiration_date).to eq nil
+      expect(response.result.expiration_date.to_date).to eq Date.new(2018, 1, 1)
 
       response = subject.post_dispatch(dispatch_options.merge(expiration_date: Date.new(2030, 1, 1)))
       aggregate_failures do
@@ -148,7 +158,17 @@ RSpec.describe ScormEngine::Api::Endpoints::Dispatches do
   end
 
   describe "#put_dispatch" do
-    let(:response) { subject.put_dispatch(dispatch_options.merge(allow_new_registrations: false, instanced: false, registration_cap: 123, expiration_date: "2018-01-01")) }
+    let(:response) { subject.put_dispatch(dispatch_options) }
+
+    %i[
+      dispatch_id destination_id course_id allow_new_registrations
+      instanced registration_cap expiration_date
+    ].each do |arg|
+      it "raises ArgumentError when :#{arg} is missing" do
+        dispatch_options.delete(arg)
+        expect { subject.put_dispatch(dispatch_options) }.to raise_error(ArgumentError, /#{arg} missing/)
+      end
+    end
 
     it "is successful" do
       expect(response.success?).to eq true
@@ -243,7 +263,7 @@ RSpec.describe ScormEngine::Api::Endpoints::Dispatches do
         expect(response.status).to eq 200
         expect(response.result.dispatch_id).to eq dispatch_options[:dispatch_id]
         expect(response.result.type).to eq "SCORM12"
-        expect(response.result.filename).to end_with("golf_club_dispatch_testing-dispatch-id.zip")
+        expect(response.result.filename).to end_with("golf_club_dispatch_testing-dispatch-id-2.zip")
 
         zip_contents = Zip::File.open_buffer(StringIO.new(response.result.body)).each_entry.map(&:name)
         expect(zip_contents).to include("blank.html", "configuration.js", "dispatch.html", "goodbye.html") # sampling

data/spec/support/scorm_engine.rb

@@ -92,7 +92,11 @@ module ScormEngineHelpers
   #
   def ensure_dispatch_exists(options = {})
     response = options[:client].get_dispatch(dispatch_id: options[:dispatch_id])
-    options[:client].post_dispatch(options) if response&.result.nil?
+    if response&.result.nil?
+      options[:client].post_dispatch(options)
+    else
+      options[:client].put_dispatch(options)
+    end
   end
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: scorm_engine
 version: !ruby/object:Gem::Version
-  version: 0.6.10
+  version: 0.7.0
 platform: ruby
 authors:
 - Philip Hallstrom
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-09-27 00:00:00.000000000 Z
+date: 2018-10-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -295,7 +295,7 @@ files:
 - spec/fixtures/vcr/ScormEngine_Api_Endpoints_Dispatches/_get_dispatches/results/is_an_enumerator_of_dispatch_models.yml
 - spec/fixtures/vcr/ScormEngine_Api_Endpoints_Dispatches/_get_dispatches/results/sucessfully_creates_the_dispatch_attributes.yml
 - spec/fixtures/vcr/ScormEngine_Api_Endpoints_Dispatches/_post_dispatch/is_successful.yml
-- spec/fixtures/vcr/ScormEngine_Api_Endpoints_Dispatches/_post_dispatch/is_updates_if_same_dispatch_id.yml
+- spec/fixtures/vcr/ScormEngine_Api_Endpoints_Dispatches/_post_dispatch/updates_if_same_dispatch_id.yml
 - spec/fixtures/vcr/ScormEngine_Api_Endpoints_Dispatches/_put_dispatch/is_successful.yml
 - spec/fixtures/vcr/ScormEngine_Api_Endpoints_Dispatches/_put_dispatch/results/sucessfully_creates_the_dispatch_attributes.yml
 - spec/fixtures/vcr/ScormEngine_Api_Endpoints_Dispatches/_put_dispatch_enabled/fails_when_invalid.yml