scorm_engine 0.7.1 → 0.7.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0499e8bbb95da53112a9bba9c98534272d25fc99a164bf483c7012aba545b366'
-  data.tar.gz: eb9e248e8628d07d30ba0c8f2d20015cc1eccb3ae8c3d4a53bb9c7c61b47cac4
+  metadata.gz: a068e71a4053cf2657b2d017dad3c137bda74798e59f198badb017e2728f397f
+  data.tar.gz: '0494b968c5585104707284aa79014dbd3b4279609705d5eb7ef3823972f9d8e7'
 SHA512:
-  metadata.gz: b51f47c3284f1c092325c449c65d784c4633a7b29458dbba887e0ab948a89304a43bfde311640c087d8e59183d2cd4de490b9b7bb8868e03ab87ad4d3af3e4eb
-  data.tar.gz: 495d009b94290f634b1427523d460b4b7b3f39b2cb256fc874ea17793eabc9f083b9f01eb296f3e7b3f6cd105bfb5003e2b9a5c10798e6db13cfb667882125e1
+  metadata.gz: 955980d7acc49984f4814c489f83d3451b0ff636fec501f10069e9ca2ba3f54e8507e304c489c3c4cb5a3ef4257df722bf6356c68c6fa0117d08e2500a3936e6
+  data.tar.gz: d3d2eaa33f15c0ad4c13ab708c79c0ad9238e515f2914b292e74926b35e32328573d981679937601bcae6e02590a95093b51e5d701a844d31c2295b0cfee7811

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

@@ -288,6 +288,49 @@ module ScormEngine
           Response.new(raw_response: response, result: result)
         end
 
+        #
+        # Get the registration count and last reset time of a dispatch.
+        #
+        # @see http://rustici-docs.s3.amazonaws.com/engine/2017.1.x.dispatch/api-dispatch.html#tenant__dispatches__dispatchId__registrationCount_get
+        #
+        # @param [Hash] options
+        #
+        # @option options [String] :dispatch_id
+        #   The ID of the dispatch to get.
+        #
+        # @return [ScormEngine::Models::DispatchRegistrationCount]
+        #
+        def get_dispatch_registration_count(options = {})
+          require_options(options, :dispatch_id)
+
+          response = get("dispatches/#{options[:dispatch_id]}/registrationCount")
+
+          # merge options to pick up dispatch_id which isn't passed back in the response
+          result = response.success? ? ScormEngine::Models::DispatchRegistrationCount.new_from_api({ "id" => options[:dispatch_id] }.merge(response.body)) : nil
+
+          Response.new(raw_response: response, result: result)
+        end
+
+        #
+        # Reset the registration count and last reset time of a dispatch.
+        #
+        # @see http://rustici-docs.s3.amazonaws.com/engine/2017.1.x.dispatch/api-dispatch.html#tenant__dispatches__dispatchId__registrationCount_delete
+        #
+        # @param [Hash] options
+        #
+        # @option options [String] :dispatch_id
+        #   The ID of the dispatch to get.
+        #
+        # @return [ScormEngine::Response]
+        #
+        def delete_dispatch_registration_count(options = {})
+          require_options(options, :dispatch_id)
+
+          response = delete("dispatches/#{options[:dispatch_id]}/registrationCount")
+
+          Response.new(raw_response: response)
+        end
+
         private
 
         def coerce_dispatch_options(options = {})
@@ -300,6 +343,7 @@ module ScormEngine
 
         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

data/lib/scorm_engine/models.rb

@@ -4,6 +4,7 @@ require_relative "models/course_configuration"
 require_relative "models/course_import"
 require_relative "models/destination"
 require_relative "models/dispatch"
+require_relative "models/dispatch_registration_count"
 require_relative "models/dispatch_zip"
 require_relative "models/learner"
 require_relative "models/registration"

data/lib/scorm_engine/models/dispatch_registration_count.rb

@@ -0,0 +1,49 @@
+require "date"
+
+module ScormEngine
+  module Models
+    class DispatchRegistrationCount < Base
+      # @attr
+      # The external identification of this dispatch.
+      # @return [String]
+      attr_accessor :id
+
+      # @attr
+      # The registration count for this dispatch.
+      # @return [Integer]
+      attr_accessor :registration_count
+
+      # @attr
+      # The date and time of the last count reset, if any.
+      # @return [DateTime]
+      attr_accessor :last_reset_at
+
+      def self.new_from_api(options = {})
+        this = new
+
+        this.options = options.dup
+        this.id = options["id"]
+        this.registration_count = options["registrationCount"].to_i
+        this.last_reset_at = get_last_reset_time(options)
+
+        this
+      end
+
+      #
+      # Extract and normalize the last reset datetime from the API options.
+      #
+      # @param [Hash] options
+      #   The API options hash
+      #
+      # @return [Time]
+      #   a date/time or nil if undefined.
+      #
+      def self.get_last_reset_time(options = {})
+        time = options["lastResetTime"]
+        return if time.nil? || time == "none"
+
+        Time.parse(time)
+      end
+    end
+  end
+end

data/lib/scorm_engine/version.rb

@@ -1,3 +1,3 @@
 module ScormEngine
-  VERSION = "0.7.1".freeze
+  VERSION = "0.7.2".freeze
 end

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

@@ -0,0 +1,30 @@
+---
+http_interactions:
+- request:
+    method: delete
+    uri: https://<SCORM_ENGINE_HOST>/ScormEngineInterface/api/v1/ScormEngineGemTesting-default/dispatches/testing-dispatch-id-2/registrationCount
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - ScormEngine Ruby Gem 0.7.1
+      Authorization:
+      - Basic <BASIC_AUTH>
+  response:
+    status:
+      code: 204
+      message: ''
+    headers:
+      date:
+      - Fri, 15 Feb 2019 22:00:32 GMT
+      server:
+      - nginx
+      connection:
+      - Close
+    body:
+      encoding: UTF-8
+      string: ''
+    http_version: 
+  recorded_at: Fri, 15 Feb 2019 22:00:32 GMT
+recorded_with: VCR 4.0.0

data/spec/fixtures/vcr/ScormEngine_Api_Endpoints_Dispatches/_delete_dispatch_registration_count/succeeds_even_when_id_is_invalid.yml

@@ -0,0 +1,30 @@
+---
+http_interactions:
+- request:
+    method: delete
+    uri: https://<SCORM_ENGINE_HOST>/ScormEngineInterface/api/v1/ScormEngineGemTesting-default/dispatches/nonexistent-dispatch/registrationCount
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - ScormEngine Ruby Gem 0.7.1
+      Authorization:
+      - Basic <BASIC_AUTH>
+  response:
+    status:
+      code: 204
+      message: ''
+    headers:
+      date:
+      - Fri, 15 Feb 2019 22:00:32 GMT
+      server:
+      - nginx
+      connection:
+      - Close
+    body:
+      encoding: UTF-8
+      string: ''
+    http_version: 
+  recorded_at: Fri, 15 Feb 2019 22:00:32 GMT
+recorded_with: VCR 4.0.0

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

@@ -0,0 +1,63 @@
+---
+http_interactions:
+- request:
+    method: delete
+    uri: https://<SCORM_ENGINE_HOST>/ScormEngineInterface/api/v1/ScormEngineGemTesting-default/dispatches/testing-dispatch-id-2/registrationCount
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - ScormEngine Ruby Gem 0.7.1
+      Authorization:
+      - Basic <BASIC_AUTH>
+  response:
+    status:
+      code: 204
+      message: ''
+    headers:
+      date:
+      - Fri, 15 Feb 2019 22:00:38 GMT
+      server:
+      - nginx
+      connection:
+      - Close
+    body:
+      encoding: UTF-8
+      string: ''
+    http_version: 
+  recorded_at: Fri, 15 Feb 2019 22:00:38 GMT
+- request:
+    method: get
+    uri: https://<SCORM_ENGINE_HOST>/ScormEngineInterface/api/v1/ScormEngineGemTesting-default/dispatches/nonexistent-dispatch/registrationCount
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - ScormEngine Ruby Gem 0.7.1
+      Authorization:
+      - Basic <BASIC_AUTH>
+  response:
+    status:
+      code: 404
+      message: ''
+    headers:
+      content-type:
+      - application/json
+      date:
+      - Fri, 15 Feb 2019 22:00:38 GMT
+      server:
+      - nginx
+      vary:
+      - Accept-Encoding
+      content-length:
+      - '77'
+      connection:
+      - Close
+    body:
+      encoding: ASCII-8BIT
+      string: '{"message":"No dispatches found with ID: nonexistent-dispatch"}'
+    http_version: 
+  recorded_at: Fri, 15 Feb 2019 22:00:39 GMT
+recorded_with: VCR 4.0.0

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

@@ -0,0 +1,63 @@
+---
+http_interactions:
+- request:
+    method: delete
+    uri: https://<SCORM_ENGINE_HOST>/ScormEngineInterface/api/v1/ScormEngineGemTesting-default/dispatches/testing-dispatch-id-2/registrationCount
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - ScormEngine Ruby Gem 0.7.1
+      Authorization:
+      - Basic <BASIC_AUTH>
+  response:
+    status:
+      code: 204
+      message: ''
+    headers:
+      date:
+      - Fri, 15 Feb 2019 22:00:39 GMT
+      server:
+      - nginx
+      connection:
+      - Close
+    body:
+      encoding: UTF-8
+      string: ''
+    http_version: 
+  recorded_at: Fri, 15 Feb 2019 22:00:39 GMT
+- request:
+    method: get
+    uri: https://<SCORM_ENGINE_HOST>/ScormEngineInterface/api/v1/ScormEngineGemTesting-default/dispatches/testing-dispatch-id-2/registrationCount
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - ScormEngine Ruby Gem 0.7.1
+      Authorization:
+      - Basic <BASIC_AUTH>
+  response:
+    status:
+      code: 200
+      message: ''
+    headers:
+      content-type:
+      - application/json
+      date:
+      - Fri, 15 Feb 2019 22:00:39 GMT
+      server:
+      - nginx
+      vary:
+      - Accept-Encoding
+      content-length:
+      - '86'
+      connection:
+      - Close
+    body:
+      encoding: ASCII-8BIT
+      string: '{"registrationCount":0,"lastResetTime":"2019-02-15T22:00:39.000Z"}'
+    http_version: 
+  recorded_at: Fri, 15 Feb 2019 22:00:39 GMT
+recorded_with: VCR 4.0.0

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

@@ -0,0 +1,63 @@
+---
+http_interactions:
+- request:
+    method: delete
+    uri: https://<SCORM_ENGINE_HOST>/ScormEngineInterface/api/v1/ScormEngineGemTesting-default/dispatches/testing-dispatch-id-2/registrationCount
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - ScormEngine Ruby Gem 0.7.1
+      Authorization:
+      - Basic <BASIC_AUTH>
+  response:
+    status:
+      code: 204
+      message: ''
+    headers:
+      date:
+      - Fri, 15 Feb 2019 22:00:41 GMT
+      server:
+      - nginx
+      connection:
+      - Close
+    body:
+      encoding: UTF-8
+      string: ''
+    http_version: 
+  recorded_at: Fri, 15 Feb 2019 22:00:41 GMT
+- request:
+    method: get
+    uri: https://<SCORM_ENGINE_HOST>/ScormEngineInterface/api/v1/ScormEngineGemTesting-default/dispatches/testing-dispatch-id-2/registrationCount
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - ScormEngine Ruby Gem 0.7.1
+      Authorization:
+      - Basic <BASIC_AUTH>
+  response:
+    status:
+      code: 200
+      message: ''
+    headers:
+      content-type:
+      - application/json
+      date:
+      - Fri, 15 Feb 2019 22:00:41 GMT
+      server:
+      - nginx
+      vary:
+      - Accept-Encoding
+      content-length:
+      - '86'
+      connection:
+      - Close
+    body:
+      encoding: ASCII-8BIT
+      string: '{"registrationCount":0,"lastResetTime":"2019-02-15T22:00:41.000Z"}'
+    http_version: 
+  recorded_at: Fri, 15 Feb 2019 22:00:41 GMT
+recorded_with: VCR 4.0.0

data/spec/fixtures/vcr/ScormEngine_Api_Endpoints_Dispatches/_get_dispatch_registration_count/when_dispatch_has_registrations/knows_it_s_registration_count.yml

@@ -0,0 +1,63 @@
+---
+http_interactions:
+- request:
+    method: delete
+    uri: https://<SCORM_ENGINE_HOST>/ScormEngineInterface/api/v1/ScormEngineGemTesting-default/dispatches/testing-dispatch-id-2/registrationCount
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - ScormEngine Ruby Gem 0.7.1
+      Authorization:
+      - Basic <BASIC_AUTH>
+  response:
+    status:
+      code: 204
+      message: ''
+    headers:
+      date:
+      - Fri, 15 Feb 2019 22:00:40 GMT
+      server:
+      - nginx
+      connection:
+      - Close
+    body:
+      encoding: UTF-8
+      string: ''
+    http_version: 
+  recorded_at: Fri, 15 Feb 2019 22:00:40 GMT
+- request:
+    method: get
+    uri: https://<SCORM_ENGINE_HOST>/ScormEngineInterface/api/v1/ScormEngineGemTesting-default/dispatches/testing-dispatch-id-2/registrationCount
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - ScormEngine Ruby Gem 0.7.1
+      Authorization:
+      - Basic <BASIC_AUTH>
+  response:
+    status:
+      code: 200
+      message: ''
+    headers:
+      content-type:
+      - application/json
+      date:
+      - Fri, 15 Feb 2019 22:00:40 GMT
+      server:
+      - nginx
+      vary:
+      - Accept-Encoding
+      content-length:
+      - '86'
+      connection:
+      - Close
+    body:
+      encoding: ASCII-8BIT
+      string: '{"registrationCount":0,"lastResetTime":"2019-02-15T22:00:40.000Z"}'
+    http_version: 
+  recorded_at: Fri, 15 Feb 2019 22:00:40 GMT
+recorded_with: VCR 4.0.0

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

@@ -323,4 +323,50 @@ RSpec.describe ScormEngine::Api::Endpoints::Dispatches do
       end
     end
   end
+
+  describe "#get_dispatch_registration_count" do
+    before do
+      subject.delete_dispatch_registration_count(dispatch_id: dispatch_options[:dispatch_id])
+    end
+
+    let(:response) { subject.get_dispatch_registration_count(dispatch_id: dispatch_options[:dispatch_id]) }
+
+    it "is successful" do
+      expect(response.success?).to eq true
+    end
+
+    describe "results" do
+      it "sucessfully creates the dispatch attributes" do
+        dispatch = response.result
+        aggregate_failures do
+          expect(dispatch.id).to eq dispatch_options[:dispatch_id]
+          expect(dispatch.registration_count).to eq 0
+          expect(dispatch.last_reset_at).to be_a(Time)
+        end
+      end
+    end
+
+    it "fails when id is invalid" do
+      response = subject.get_dispatch_registration_count(dispatch_id: "nonexistent-dispatch")
+      aggregate_failures do
+        expect(response.success?).to eq false
+        expect(response.status).to eq 404
+        expect(response.message).to match(/No dispatches found with ID: nonexistent-dispatch/)
+        expect(response.result).to eq nil
+      end
+    end
+  end
+
+  describe "#delete_dispatch_registration_count" do
+    let(:response) { subject.delete_dispatch_registration_count(dispatch_id: dispatch_options[:dispatch_id]) }
+
+    it "is successful" do
+      expect(response.success?).to eq true
+    end
+
+    it "succeeds even when id is invalid" do
+      response = subject.delete_dispatch_registration_count(dispatch_id: "nonexistent-dispatch")
+      expect(response.success?).to eq true
+    end
+  end
 end

data/spec/scorm_engine/models/dispatch_registration_count_spec.rb

@@ -0,0 +1,42 @@
+RSpec.describe ScormEngine::Models::DispatchRegistrationCount do
+  describe ".new_from_api" do
+    describe ":id" do
+      it "is set" do
+        dispatch = described_class.new_from_api(
+          "id" => "dispatch-id"
+        )
+        expect(dispatch.id).to eq "dispatch-id"
+      end
+    end
+
+    describe ":registration_count" do
+      it "is set" do
+        dispatch = described_class.new_from_api(
+          "registrationCount" => "456"
+        )
+        expect(dispatch.registration_count).to eq 456
+      end
+
+      it "is set to zero when not an integer" do
+        dispatch = described_class.new_from_api(
+          "registrationCount" => "oops"
+        )
+        expect(dispatch.registration_count).to eq 0
+      end
+    end
+
+    describe ":last_reset_at" do
+      it "is set" do
+        dispatch = described_class.new_from_api(
+          "lastResetTime" => "2018-05-24T08:09:10Z"
+        )
+        expect(dispatch.last_reset_at).to eq Time.new(2018, 5, 24, 8, 9, 10, 0)
+      end
+
+      it "is set to nil if blank" do
+        dispatch = described_class.new_from_api({})
+        expect(dispatch.last_reset_at).to eq nil
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: scorm_engine
 version: !ruby/object:Gem::Version
-  version: 0.7.1
+  version: 0.7.2
 platform: ruby
 authors:
 - Philip Hallstrom
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-11-15 00:00:00.000000000 Z
+date: 2019-02-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -196,6 +196,7 @@ files:
 - lib/scorm_engine/models/course_import.rb
 - lib/scorm_engine/models/destination.rb
 - lib/scorm_engine/models/dispatch.rb
+- lib/scorm_engine/models/dispatch_registration_count.rb
 - lib/scorm_engine/models/dispatch_zip.rb
 - lib/scorm_engine/models/learner.rb
 - lib/scorm_engine/models/registration.rb
@@ -276,11 +277,17 @@ files:
 - spec/fixtures/vcr/ScormEngine_Api_Endpoints_Destinations/_put_destination/results/sucessfully_creates_the_destination_attributes.yml
 - spec/fixtures/vcr/ScormEngine_Api_Endpoints_Dispatches/_delete_dispatch/returns_success_even_when_id_is_invalid.yml
 - spec/fixtures/vcr/ScormEngine_Api_Endpoints_Dispatches/_delete_dispatch/works.yml
+- spec/fixtures/vcr/ScormEngine_Api_Endpoints_Dispatches/_delete_dispatch_registration_count/is_successful.yml
+- spec/fixtures/vcr/ScormEngine_Api_Endpoints_Dispatches/_delete_dispatch_registration_count/succeeds_even_when_id_is_invalid.yml
 - spec/fixtures/vcr/ScormEngine_Api_Endpoints_Dispatches/_get_dispatch/fails_when_id_is_invalid.yml
 - spec/fixtures/vcr/ScormEngine_Api_Endpoints_Dispatches/_get_dispatch/is_successful.yml
 - spec/fixtures/vcr/ScormEngine_Api_Endpoints_Dispatches/_get_dispatch/results/sucessfully_creates_the_dispatch_attributes.yml
 - spec/fixtures/vcr/ScormEngine_Api_Endpoints_Dispatches/_get_dispatch_enabled/is_false_when_disabled.yml
 - spec/fixtures/vcr/ScormEngine_Api_Endpoints_Dispatches/_get_dispatch_enabled/is_true_when_enabled.yml
+- spec/fixtures/vcr/ScormEngine_Api_Endpoints_Dispatches/_get_dispatch_registration_count/fails_when_id_is_invalid.yml
+- spec/fixtures/vcr/ScormEngine_Api_Endpoints_Dispatches/_get_dispatch_registration_count/is_successful.yml
+- spec/fixtures/vcr/ScormEngine_Api_Endpoints_Dispatches/_get_dispatch_registration_count/results/sucessfully_creates_the_dispatch_attributes.yml
+- spec/fixtures/vcr/ScormEngine_Api_Endpoints_Dispatches/_get_dispatch_registration_count/when_dispatch_has_registrations/knows_it_s_registration_count.yml
 - spec/fixtures/vcr/ScormEngine_Api_Endpoints_Dispatches/_get_dispatch_zip/fails_given_an_invalid_id.yml
 - spec/fixtures/vcr/ScormEngine_Api_Endpoints_Dispatches/_get_dispatch_zip/fails_given_an_invalid_type.yml
 - spec/fixtures/vcr/ScormEngine_Api_Endpoints_Dispatches/_get_dispatch_zip/works.yml
@@ -367,6 +374,7 @@ files:
 - spec/scorm_engine/models/course_import_spec.rb
 - spec/scorm_engine/models/course_spec.rb
 - spec/scorm_engine/models/destination_spec.rb
+- spec/scorm_engine/models/dispatch_registration_count_spec.rb
 - spec/scorm_engine/models/dispatch_spec.rb
 - spec/scorm_engine/models/dispatch_zip_spec.rb
 - spec/scorm_engine/models/learner_spec.rb