scorm_engine 0.3.0 → 0.4.0

data/lib/scorm_engine/faraday/connection.rb

@@ -8,7 +8,6 @@ module ScormEngine
 
       def connection
         @connection ||= ::Faraday.new(url: base_uri.to_s) do |faraday|
-          faraday.headers["Content-Type"] = "application/json"
           faraday.headers["User-Agent"] = "ScormEngine Ruby Gem #{ScormEngine::VERSION}"
 
           faraday.basic_auth(ScormEngine.configuration.username, ScormEngine.configuration.password)

data/lib/scorm_engine/models.rb

@@ -1,6 +1,9 @@
 require_relative "models/course"
 require_relative "models/course_configuration"
 require_relative "models/course_import"
+require_relative "models/destination"
+require_relative "models/dispatch"
+require_relative "models/dispatch_zip"
 require_relative "models/learner"
 require_relative "models/registration"
 require_relative "models/registration_activity_detail"

data/lib/scorm_engine/models/destination.rb

@@ -0,0 +1,27 @@
+module ScormEngine
+  module Models
+    class Destination
+      attr_accessor :options
+      private :options
+
+      # 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
+
+      def self.new_from_api(options = {})
+        this = new
+
+        this.options = options.dup
+        this.id = options["id"]
+
+        # get_destinations (plural) returns values in a nested 'data' field.
+        # get_destination (singular) does not.
+        data = options["data"] || options
+        this.name = data["name"]
+
+        this
+      end
+    end
+  end
+end

data/lib/scorm_engine/models/dispatch.rb

@@ -0,0 +1,51 @@
+require "date"
+
+module ScormEngine
+  module Models
+    class Dispatch
+      attr_accessor :options
+      private :options
+
+      # 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
+
+      def self.new_from_api(options = {})
+        this = new
+
+        this.options = options.dup
+        this.id = options["id"]
+
+        # get_dispatches (plural) returns values in a nested 'data' field.
+        # get_dispatches (singular) does not.
+        data = options["data"] || options
+        this.destination_id = data["destinationId"]
+        this.course_id = data["courseId"]
+        this.allow_new_registrations = data["allowNewRegistrations"]
+        this.instanced = data["instanced"]
+        this.registration_cap = data["registrationCap"]&.to_i
+        this.expiration_date = get_expiration_date(data)
+        this.external_config = data["externalConfig"]
+
+        this
+      end
+
+      #
+      # Extract and normalize the expiration date from the API options.
+      #
+      # @param [Hash] options
+      #   The API options hash
+      #
+      # @return [Time]
+      #   a date/time or nil if undefined.
+      #
+      def self.get_expiration_date(options = {})
+        expiration_date = options["expirationDate"]
+        return if expiration_date.nil? || expiration_date == "none"
+        Time.parse(expiration_date)
+      end
+    end
+  end
+end

data/lib/scorm_engine/models/dispatch_zip.rb

@@ -0,0 +1,18 @@
+module ScormEngine
+  module Models
+    class DispatchZip
+      attr_accessor :options
+      private :options
+
+      attr_accessor :dispatch_id, :type, :filename, :body
+
+      def initialize(options = {})
+        @options = options.dup
+        @dispatch_id = options[:dispatch_id]
+        @type = options[:type]
+        @filename = options[:filename]
+        @body = options[:body]
+      end
+    end
+  end
+end

data/lib/scorm_engine/version.rb

@@ -1,3 +1,3 @@
 module ScormEngine
-  VERSION = "0.3.0".freeze
+  VERSION = "0.4.0".freeze
 end

data/spec/fixtures/vcr/ScormEngine_Api_Endpoints_Destinations/_delete_destination/raises_ArgumentError_when_destination_id_is_missing.yml

@@ -0,0 +1,32 @@
+---
+http_interactions:
+- request:
+    method: delete
+    uri: https://<SCORM_ENGINE_HOST>/ScormEngineInterface/api/v1/ScormEngineGemTesting-default/destinations/
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Content-Type:
+      - application/json
+      User-Agent:
+      - ScormEngine Ruby Gem 0.3.0
+      Authorization:
+      - Basic <BASIC_AUTH>
+  response:
+    status:
+      code: 204
+      message: ''
+    headers:
+      date:
+      - Mon, 20 Aug 2018 21:19:13 GMT
+      server:
+      - nginx
+      connection:
+      - Close
+    body:
+      encoding: UTF-8
+      string: ''
+    http_version: 
+  recorded_at: Mon, 20 Aug 2018 21:19:13 GMT
+recorded_with: VCR 4.0.0

data/spec/fixtures/vcr/ScormEngine_Api_Endpoints_Destinations/_delete_destination/returns_success_even_when_id_is_invalid.yml

@@ -0,0 +1,32 @@
+---
+http_interactions:
+- request:
+    method: delete
+    uri: https://<SCORM_ENGINE_HOST>/ScormEngineInterface/api/v1/ScormEngineGemTesting-default/destinations/nonexistent-destination
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Content-Type:
+      - application/json
+      User-Agent:
+      - ScormEngine Ruby Gem 0.3.0
+      Authorization:
+      - Basic <BASIC_AUTH>
+  response:
+    status:
+      code: 204
+      message: ''
+    headers:
+      date:
+      - Mon, 20 Aug 2018 21:19:15 GMT
+      server:
+      - nginx
+      connection:
+      - Close
+    body:
+      encoding: UTF-8
+      string: ''
+    http_version: 
+  recorded_at: Mon, 20 Aug 2018 21:19:15 GMT
+recorded_with: VCR 4.0.0

data/spec/fixtures/vcr/ScormEngine_Api_Endpoints_Destinations/_delete_destination/works.yml

@@ -0,0 +1,32 @@
+---
+http_interactions:
+- request:
+    method: delete
+    uri: https://<SCORM_ENGINE_HOST>/ScormEngineInterface/api/v1/ScormEngineGemTesting-default/destinations/destination-to-be-deleted
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Content-Type:
+      - application/json
+      User-Agent:
+      - ScormEngine Ruby Gem 0.3.0
+      Authorization:
+      - Basic <BASIC_AUTH>
+  response:
+    status:
+      code: 204
+      message: ''
+    headers:
+      date:
+      - Mon, 20 Aug 2018 21:19:11 GMT
+      server:
+      - nginx
+      connection:
+      - Close
+    body:
+      encoding: UTF-8
+      string: ''
+    http_version: 
+  recorded_at: Mon, 20 Aug 2018 21:19:11 GMT
+recorded_with: VCR 4.0.0

data/spec/fixtures/vcr/ScormEngine_Api_Endpoints_Destinations/_get_destination/fails_when_id_is_invalid.yml

@@ -0,0 +1,38 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://<SCORM_ENGINE_HOST>/ScormEngineInterface/api/v1/ScormEngineGemTesting-default/destinations/nonexistent-destination
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Content-Type:
+      - application/json
+      User-Agent:
+      - ScormEngine Ruby Gem 0.3.0
+      Authorization:
+      - Basic <BASIC_AUTH>
+  response:
+    status:
+      code: 404
+      message: ''
+    headers:
+      content-type:
+      - application/json
+      date:
+      - Mon, 20 Aug 2018 21:19:02 GMT
+      server:
+      - nginx
+      vary:
+      - Accept-Encoding
+      content-length:
+      - '79'
+      connection:
+      - Close
+    body:
+      encoding: ASCII-8BIT
+      string: '{"message":"No destinations found with ID: nonexistent-destination"}'
+    http_version: 
+  recorded_at: Mon, 20 Aug 2018 21:19:02 GMT
+recorded_with: VCR 4.0.0

data/spec/fixtures/vcr/ScormEngine_Api_Endpoints_Destinations/_get_destination/is_successful.yml

@@ -0,0 +1,38 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://<SCORM_ENGINE_HOST>/ScormEngineInterface/api/v1/ScormEngineGemTesting-default/destinations/testing-golf-club
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Content-Type:
+      - application/json
+      User-Agent:
+      - ScormEngine Ruby Gem 0.3.0
+      Authorization:
+      - Basic <BASIC_AUTH>
+  response:
+    status:
+      code: 200
+      message: ''
+    headers:
+      content-type:
+      - application/json
+      date:
+      - Mon, 20 Aug 2018 21:19:01 GMT
+      server:
+      - nginx
+      vary:
+      - Accept-Encoding
+      content-length:
+      - '40'
+      connection:
+      - Close
+    body:
+      encoding: ASCII-8BIT
+      string: '{"name":"Golf Club"}'
+    http_version: 
+  recorded_at: Mon, 20 Aug 2018 21:19:01 GMT
+recorded_with: VCR 4.0.0

data/spec/fixtures/vcr/ScormEngine_Api_Endpoints_Destinations/_get_destination/results/sucessfully_creates_the_destination_attributes.yml

@@ -0,0 +1,38 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://<SCORM_ENGINE_HOST>/ScormEngineInterface/api/v1/ScormEngineGemTesting-default/destinations/testing-golf-club
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Content-Type:
+      - application/json
+      User-Agent:
+      - ScormEngine Ruby Gem 0.3.0
+      Authorization:
+      - Basic <BASIC_AUTH>
+  response:
+    status:
+      code: 200
+      message: ''
+    headers:
+      content-type:
+      - application/json
+      date:
+      - Mon, 20 Aug 2018 21:19:03 GMT
+      server:
+      - nginx
+      vary:
+      - Accept-Encoding
+      content-length:
+      - '40'
+      connection:
+      - Close
+    body:
+      encoding: ASCII-8BIT
+      string: '{"name":"Golf Club"}'
+    http_version: 
+  recorded_at: Mon, 20 Aug 2018 21:19:03 GMT
+recorded_with: VCR 4.0.0

data/spec/fixtures/vcr/ScormEngine_Api_Endpoints_Destinations/_get_destination_dispatches_registration_count/fails_when_invalid.yml

@@ -0,0 +1,38 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://<SCORM_ENGINE_HOST>/ScormEngineInterface/api/v1/ScormEngineGemTesting-default/destinations/nonexistent-destination/dispatches/registrationCount
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Content-Type:
+      - application/json
+      User-Agent:
+      - ScormEngine Ruby Gem 0.3.0
+      Authorization:
+      - Basic <BASIC_AUTH>
+  response:
+    status:
+      code: 404
+      message: ''
+    headers:
+      content-type:
+      - application/json
+      date:
+      - Mon, 20 Aug 2018 21:19:00 GMT
+      server:
+      - nginx
+      vary:
+      - Accept-Encoding
+      content-length:
+      - '79'
+      connection:
+      - Close
+    body:
+      encoding: ASCII-8BIT
+      string: '{"message":"No destinations found with ID: nonexistent-destination"}'
+    http_version: 
+  recorded_at: Mon, 20 Aug 2018 21:19:00 GMT
+recorded_with: VCR 4.0.0

data/spec/fixtures/vcr/ScormEngine_Api_Endpoints_Destinations/_get_destination_dispatches_registration_count/works.yml

@@ -0,0 +1,36 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://<SCORM_ENGINE_HOST>/ScormEngineInterface/api/v1/ScormEngineGemTesting-default/destinations/testing-golf-club/dispatches/registrationCount
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Content-Type:
+      - application/json
+      User-Agent:
+      - ScormEngine Ruby Gem 0.3.0
+      Authorization:
+      - Basic <BASIC_AUTH>
+  response:
+    status:
+      code: 200
+      message: ''
+    headers:
+      content-type:
+      - application/json
+      date:
+      - Mon, 20 Aug 2018 21:19:01 GMT
+      server:
+      - nginx
+      content-length:
+      - '1'
+      connection:
+      - Close
+    body:
+      encoding: UTF-8
+      string: '0'
+    http_version: 
+  recorded_at: Mon, 20 Aug 2018 21:19:01 GMT
+recorded_with: VCR 4.0.0

data/spec/fixtures/vcr/ScormEngine_Api_Endpoints_Destinations/_get_destinations/_more_option_pagination_/returns_all_the_destinations.yml

@@ -0,0 +1,73 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://<SCORM_ENGINE_HOST>/ScormEngineInterface/api/v1/ScormEngineGemTesting-default/destinations
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Content-Type:
+      - application/json
+      User-Agent:
+      - ScormEngine Ruby Gem 0.3.0
+      Authorization:
+      - Basic <BASIC_AUTH>
+  response:
+    status:
+      code: 200
+      message: ''
+    headers:
+      content-type:
+      - application/json
+      date:
+      - Mon, 20 Aug 2018 21:19:30 GMT
+      server:
+      - nginx
+      vary:
+      - Accept-Encoding
+      content-length:
+      - '287'
+      connection:
+      - Close
+    body:
+      encoding: ASCII-8BIT
+      string: '{"destinations":[{"id":"testing-golf-club","data":{"name":"Golf Club"}},{"id":"destination-to-be-deleted","data":{"name":"destination-to-be-deleted"}},{"id":"paginated-destination-0","data":{"name":"paginated-destination-0"}},{"id":"paginated-destination-1","data":{"name":"paginated-destination-1"}},{"id":"paginated-destination-2","data":{"name":"paginated-destination-2"}},{"id":"paginated-destination-3","data":{"name":"paginated-destination-3"}},{"id":"paginated-destination-4","data":{"name":"paginated-destination-4"}},{"id":"paginated-destination-5","data":{"name":"paginated-destination-5"}},{"id":"paginated-destination-6","data":{"name":"paginated-destination-6"}},{"id":"paginated-destination-7","data":{"name":"paginated-destination-7"}}],"more":"https://<SCORM_ENGINE_HOST>/ScormEngineInterface/api/v1/scormenginegemtesting-default/destinations?configuration=ScormEngineGemTesting-default&more=AAABZVk035AAAAEA"}'
+    http_version: 
+  recorded_at: Mon, 20 Aug 2018 21:19:30 GMT
+- request:
+    method: get
+    uri: https://<SCORM_ENGINE_HOST>/ScormEngineInterface/api/v1/scormenginegemtesting-default/destinations?configuration=ScormEngineGemTesting-default&more=AAABZVk035AAAAEA
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Content-Type:
+      - application/json
+      User-Agent:
+      - ScormEngine Ruby Gem 0.3.0
+      Authorization:
+      - Basic <BASIC_AUTH>
+  response:
+    status:
+      code: 200
+      message: ''
+    headers:
+      content-type:
+      - application/json
+      date:
+      - Mon, 20 Aug 2018 21:19:31 GMT
+      server:
+      - nginx
+      vary:
+      - Accept-Encoding
+      content-length:
+      - '96'
+      connection:
+      - Close
+    body:
+      encoding: ASCII-8BIT
+      string: '{"destinations":[{"id":"paginated-destination-8","data":{"name":"paginated-destination-8"}},{"id":"paginated-destination-9","data":{"name":"paginated-destination-9"}},{"id":"paginated-destination-10","data":{"name":"paginated-destination-10"}}]}'
+    http_version: 
+  recorded_at: Mon, 20 Aug 2018 21:19:31 GMT
+recorded_with: VCR 4.0.0