scorm_engine 0.6.0 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d74269c1ef26c6a9f5666cb0b34eb3030d96d4a94068f9461eb19e9f29f1680d
-  data.tar.gz: 27fd6f294d5fb5253ee040e2b1e096cd4d721561fd749529528d17b46c266bb5
+  metadata.gz: 3f9f09bee2cb90376b11857112525d4f8b684fbf413efe376e4a1e62f13165bf
+  data.tar.gz: 4ddb77b0f64f4f9da50851e79a106acade6e4f6e20a208702bcc0c241f54202f
 SHA512:
-  metadata.gz: 302e041de9c1f187b0cd5948e99291b6a775977bfb436b846a1065034e5b1ab7608867862204a3e3cf36ab786dea0a39e91d0ca6fb5f01acef4afe91c94d13a4
-  data.tar.gz: 73198c298c04155839cbcbe20a99933633d0c8e6e472c638ab4b2bb2c6d4b130e51256ca9ad691b4c32cb572dc20191253bc23ca6d7cf52f7299b0b33d4623f9
+  metadata.gz: d9f07c8575519f7b092ef0c2e035128276a76c6383167446a63559e5d311bc24bb2b2aa9867e7c00b110ec7508194c82aa3ec99c713ac59d1533186118b6db0f
+  data.tar.gz: '040280d374b94fe5984c3812ab50e0cf683b925e2a0e146071b0356acdcfa5628b2e10e15f5470b60ad1f05efafa5c7ff00a2cc8fa961acf8ae8c5c9ef8a79c9'

data/lib/scorm_engine/models.rb

@@ -1,3 +1,4 @@
+require_relative "models/base"
 require_relative "models/course"
 require_relative "models/course_configuration"
 require_relative "models/course_import"

data/lib/scorm_engine/models/base.rb

@@ -0,0 +1,21 @@
+module ScormEngine
+  module Models
+    class Base
+      attr_accessor :options
+      private :options
+
+      #
+      # Return a hashified representation of the object.
+      #
+      # This hash should not be used to access individual data elements
+      # unavailable via standard accessors, but only for use in marshaling
+      # of the data.
+      #
+      # @return [Hash]
+      #
+      def to_hash
+        options
+      end
+    end
+  end
+end

data/lib/scorm_engine/models/course.rb

@@ -2,10 +2,7 @@ require "time"
 
 module ScormEngine
   module Models
-    class Course
-      attr_accessor :options
-      private :options
-
+    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.

data/lib/scorm_engine/models/course_configuration.rb

@@ -1,9 +1,6 @@
 module ScormEngine
   module Models
-    class CourseConfiguration
-      attr_accessor :options
-      private :options
-
+    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.

data/lib/scorm_engine/models/course_import.rb

@@ -1,9 +1,6 @@
 module ScormEngine
   module Models
-    class CourseImport
-      attr_accessor :options
-      private :options
-
+    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.

data/lib/scorm_engine/models/destination.rb

@@ -1,9 +1,6 @@
 module ScormEngine
   module Models
-    class Destination
-      attr_accessor :options
-      private :options
-
+    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.

data/lib/scorm_engine/models/dispatch.rb

@@ -2,10 +2,7 @@ require "date"
 
 module ScormEngine
   module Models
-    class Dispatch
-      attr_accessor :options
-      private :options
-
+    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.

data/lib/scorm_engine/models/dispatch_zip.rb

@@ -1,9 +1,6 @@
 module ScormEngine
   module Models
-    class DispatchZip
-      attr_accessor :options
-      private :options
-
+    class DispatchZip < Base
       attr_accessor :dispatch_id, :type, :filename, :body
 
       def initialize(options = {})

data/lib/scorm_engine/models/learner.rb

@@ -1,9 +1,6 @@
 module ScormEngine
   module Models
-    class Learner
-      attr_accessor :options
-      private :options
-
+    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.

data/lib/scorm_engine/models/registration.rb

@@ -9,10 +9,7 @@
 #
 module ScormEngine
   module Models
-    class Registration
-      attr_accessor :options
-      private :options
-
+    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.

data/lib/scorm_engine/models/registration_activity_detail.rb

@@ -1,9 +1,6 @@
 module ScormEngine
   module Models
-    class RegistrationActivityDetail
-      attr_accessor :options
-      private :options
-
+    class RegistrationActivityDetail < 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.

data/lib/scorm_engine/models/registration_configuration.rb

@@ -1,9 +1,6 @@
 module ScormEngine
   module Models
-    class RegistrationConfiguration
-      attr_accessor :options
-      private :options
-
+    class RegistrationConfiguration < 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.

data/lib/scorm_engine/models/registration_launch_history.rb

@@ -5,10 +5,7 @@
 #
 module ScormEngine
   module Models
-    class RegistrationLaunchHistory
-      attr_accessor :options
-      private :options
-
+    class RegistrationLaunchHistory < 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.

data/lib/scorm_engine/models/registration_runtime_interaction.rb

@@ -1,9 +1,6 @@
 module ScormEngine
   module Models
-    class RegistrationRuntimeInteraction
-      attr_accessor :options
-      private :options
-
+    class RegistrationRuntimeInteraction < 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.

data/lib/scorm_engine/version.rb

@@ -1,3 +1,3 @@
 module ScormEngine
-  VERSION = "0.6.0".freeze
+  VERSION = "0.6.1".freeze
 end

data/spec/scorm_engine/models/base_spec.rb

@@ -0,0 +1,19 @@
+RSpec.describe ScormEngine::Models::Base do
+  module ScormEngine
+    module Models
+      class Test < Base
+        def initialize(options = {})
+          @options = options
+        end
+      end
+    end
+  end
+
+  describe "#to_hash" do
+    it "returns a hash of the options" do
+      options = { i: 1, s: "str", a: [1, 2, 3] }
+      test = ScormEngine::Models::Test.new(options)
+      expect(test.to_hash).to eq options
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: scorm_engine
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.6.1
 platform: ruby
 authors:
 - Philip Hallstrom
@@ -190,6 +190,7 @@ files:
 - lib/scorm_engine/faraday/connection.rb
 - lib/scorm_engine/faraday/request.rb
 - lib/scorm_engine/models.rb
+- lib/scorm_engine/models/base.rb
 - lib/scorm_engine/models/course.rb
 - lib/scorm_engine/models/course_configuration.rb
 - lib/scorm_engine/models/course_import.rb
@@ -361,6 +362,7 @@ files:
 - spec/scorm_engine/api/endpoints/registrations_spec.rb
 - spec/scorm_engine/configuration_spec.rb
 - spec/scorm_engine/faraday/connection_spec.rb
+- spec/scorm_engine/models/base_spec.rb
 - spec/scorm_engine/models/course_configuration_spec.rb
 - spec/scorm_engine/models/course_import_spec.rb
 - spec/scorm_engine/models/course_spec.rb