scorm_engine 0.6.1 → 0.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3f9f09bee2cb90376b11857112525d4f8b684fbf413efe376e4a1e62f13165bf
-  data.tar.gz: 4ddb77b0f64f4f9da50851e79a106acade6e4f6e20a208702bcc0c241f54202f
+  metadata.gz: f03bd17c2d3fdd0d6c6327553e3ed8657a7f6c796fa4535944cc003b5cc37335
+  data.tar.gz: c136aefda64d406464d3f88cf8e6e9f4954df53c93fe351b1c03daff64ce3187
 SHA512:
-  metadata.gz: d9f07c8575519f7b092ef0c2e035128276a76c6383167446a63559e5d311bc24bb2b2aa9867e7c00b110ec7508194c82aa3ec99c713ac59d1533186118b6db0f
-  data.tar.gz: '040280d374b94fe5984c3812ab50e0cf683b925e2a0e146071b0356acdcfa5628b2e10e15f5470b60ad1f05efafa5c7ff00a2cc8fa961acf8ae8c5c9ef8a79c9'
+  metadata.gz: 98bdc0ec1d7dd57cdcb8cf64fcf2a64a5eb7a04b5da0763c4ab7c6ac7285b58119c93f8e5450f42bee9ad8c869a9824331ef4d9655b02a25880a2b2dfaa2aaf6
+  data.tar.gz: 7aefdb729d6c36ba334da198026f51f9bfbc78de9c8f65317c314e1e23f530961f4c4315b9654b582120603238990a2c06d7f8b535e05e63be845f9046c8efb7

data/lib/scorm_engine/models/registration.rb

@@ -13,10 +13,29 @@ module ScormEngine
       # 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, :instance, :updated, :registration_completion, :registration_success,
+      attr_accessor :id, :instance, :updated,
         :total_seconds_tracked, :score, :course, :learner, :activity_details,
-        :first_access_date, :last_access_date, :completed_date, :created_date,
-        :registration_completion_amount
+        :first_access_date, :last_access_date, :completed_date, :created_date
+
+      # @attr
+      # Has this registration been completed?
+      # @return [String] (UNKNOWN COMPLETED INCOMPLETE)
+      attr_accessor :registration_completion
+
+      # @attr
+      # Has this registration been passed?
+      # @return [String] (Unknown Passed Failed)
+      attr_accessor :registration_success
+
+      # @attr
+      # A decimal value between 0 and 1 representing the percentage of this
+      # course that the learner has completed so far, if known. Note: for
+      # learning standards other than SCORM 2004 4th Edition, this value is
+      # based on the percentage of activities completed/passed. This means that
+      # single-activity courses in those standards will always return either 0
+      # or 1.
+      # @return [Float] (Unknown Passed Failed)
+      attr_accessor :registration_completion_amount
 
       def self.new_from_api(options = {})
         this = new
@@ -44,6 +63,50 @@ module ScormEngine
         this
       end
 
+      #
+      # Has this registration been completed?
+      #
+      # @return [Boolean]
+      #   Returns true, false or nil if completion status is unknown.
+      #
+      def complete?
+        return nil if registration_completion == "UNKNOWN"
+        registration_completion == "COMPLETED"
+      end
+
+      #
+      # Is this registration incomplete?
+      #
+      # @return [Boolean]
+      #   Returns true, false or nil if completion status is unknown.
+      #
+      def incomplete?
+        return nil if registration_completion == "UNKNOWN"
+        registration_completion == "INCOMPLETE"
+      end
+
+      #
+      # Has this registration been passed?
+      #
+      # @return [Boolean]
+      #   Returns true, false or nil if success status is unknown.
+      #
+      def passed?
+        return nil if registration_success == "Unknown"
+        registration_success == "Passed"
+      end
+
+      #
+      # Has this registration failed?
+      #
+      # @return [Boolean]
+      #   Returns true, false or nil if success status is unknown.
+      #
+      def failed?
+        return nil if registration_success == "Unknown"
+        registration_success == "Failed"
+      end
+
       #
       # Extract and normalize the scaled passing score from the API options.
       #

data/lib/scorm_engine/models/registration_activity_detail.rb

@@ -6,11 +6,29 @@ module ScormEngine
       # instances from API options hash.
       attr_accessor :id, :children, :runtime_interactions
 
+      # @attr
+      # Represents whether the current attempt on the activity has been completed.
+      # @return [String] (UNKNOWN COMPLETED INCOMPLETE)
+      attr_accessor :activity_completion
+
+      # @attr
+      # Represents whether the previous attempt on the activity has been completed.
+      # @return [String] (Unknown Completed Incomplete)
+      attr_accessor :previous_attempt_completion
+
+      # @attr
+      # Pass/fail status of primary objective for this activity.
+      # @return [String] (UNKNOWN PASSED FAILED)
+      attr_accessor :activity_success
+
       def self.new_from_api(options = {})
         this = new
 
         this.options = options.dup
         this.id = options["id"]
+        this.activity_completion = options["activityCompletion"]
+        this.previous_attempt_completion = options["previousAttemptCompletion"]
+        this.activity_success = options["activitySuccess"]
 
         this.runtime_interactions = get_runtime_interactions_from_api(options)
 
@@ -19,6 +37,11 @@ module ScormEngine
         this
       end
 
+      #
+      # Return a flattened array of all runtime interactions
+      #
+      # @return [Array<RegistrationRuntimeInteraction>]
+      #
       def all_runtime_interactions
         (runtime_interactions + children.map(&:all_runtime_interactions)).flatten
       end
@@ -29,6 +52,73 @@ module ScormEngine
           .fetch("runtimeInteractions", [])
           .map { |e| RegistrationRuntimeInteraction.new_from_api(e) }
       end
+
+      #
+      # Has this activity been completed?
+      #
+      # @return [Boolean]
+      #   Returns true, false or nil if completion status is unknown.
+      #
+      def complete?
+        return nil if activity_completion == "UNKNOWN"
+        activity_completion == "COMPLETED"
+      end
+
+      #
+      # Is this activity incomplete?
+      #
+      # @return [Boolean]
+      #   Returns true, false or nil if completion status is unknown.
+      #
+      def incomplete?
+        return nil if activity_completion == "UNKNOWN"
+        activity_completion == "INCOMPLETE"
+      end
+
+      #
+      # Has the previous attempt of this activity been completed?
+      #
+      # @return [Boolean]
+      #   Returns true, false or nil if completion status is unknown.
+      #
+      def previous_attempt_complete?
+        return nil if previous_attempt_completion == "Unknown"
+        previous_attempt_completion == "Completed"
+      end
+
+      #
+      # Is the previous attempt of this previous_attempt incomplete?
+      #
+      # @return [Boolean]
+      #   Returns true, false or nil if completion status is unknown.
+      #
+      def previous_attempt_incomplete?
+        return nil if previous_attempt_completion == "Unknown"
+        previous_attempt_completion == "Incomplete"
+      end
+
+      #
+      # Has this activity been passed?
+      #
+      # @return [Boolean]
+      #   Returns true, false or nil if success status is unknown.
+      #
+      def passed?
+        return nil if activity_success == "UNKNOWN"
+        activity_success == "PASSED"
+      end
+
+      #
+      # Has this activity failed?
+      #
+      # @return [Boolean]
+      #   Returns true, false or nil if success status is unknown.
+      #
+      def failed?
+        return nil if activity_success == "UNKNOWN"
+        activity_success == "FAILED"
+      end
+
     end
   end
 end

data/lib/scorm_engine/version.rb

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

data/spec/scorm_engine/models/registration_activity_detail_spec.rb

@@ -97,5 +97,107 @@ RSpec.describe ScormEngine::Models::RegistrationActivityDetail do
         ]
       end
     end
+
+    describe "#complete?" do
+      it "is nil when completion is UNKNOWN" do
+        activity = described_class.new_from_api("activityCompletion" => "UNKNOWN")
+        expect(activity.complete?).to eq nil
+      end
+
+      it "is false when completion is INCOMPLETE" do
+        activity = described_class.new_from_api("activityCompletion" => "INCOMPLETE")
+        expect(activity.complete?).to eq false
+      end
+
+      it "is true when completion is COMPLETED" do
+        activity = described_class.new_from_api("activityCompletion" => "COMPLETED")
+        expect(activity.complete?).to eq true
+      end
+    end
+
+    describe "#incomplete?" do
+      it "is nil when completion is UNKNOWN" do
+        activity = described_class.new_from_api("activityCompletion" => "UNKNOWN")
+        expect(activity.incomplete?).to eq nil
+      end
+
+      it "is true when completion is INCOMPLETE" do
+        activity = described_class.new_from_api("activityCompletion" => "INCOMPLETE")
+        expect(activity.incomplete?).to eq true
+      end
+
+      it "is false when completion is COMPLETED" do
+        activity = described_class.new_from_api("activityCompletion" => "COMPLETED")
+        expect(activity.incomplete?).to eq false
+      end
+    end
+
+    describe "#previous_attempt_complete?" do
+      it "is nil when completion is Unknown" do
+        activity = described_class.new_from_api("previousAttemptCompletion" => "Unknown")
+        expect(activity.previous_attempt_complete?).to eq nil
+      end
+
+      it "is false when completion is Incomplete" do
+        activity = described_class.new_from_api("previousAttemptCompletion" => "Incomplete")
+        expect(activity.previous_attempt_complete?).to eq false
+      end
+
+      it "is true when completion is Completed" do
+        activity = described_class.new_from_api("previousAttemptCompletion" => "Completed")
+        expect(activity.previous_attempt_complete?).to eq true
+      end
+    end
+
+    describe "#previous_atempt_incomplete?" do
+      it "is nil when completion is Unknown" do
+        activity = described_class.new_from_api("previousAttemptCompletion" => "Unknown")
+        expect(activity.previous_attempt_incomplete?).to eq nil
+      end
+
+      it "is true when completion is Incomplete" do
+        activity = described_class.new_from_api("previousAttemptCompletion" => "Incomplete")
+        expect(activity.previous_attempt_incomplete?).to eq true
+      end
+
+      it "is false when completion is Completed" do
+        activity = described_class.new_from_api("previousAttemptCompletion" => "Completed")
+        expect(activity.previous_attempt_incomplete?).to eq false
+      end
+    end
+
+    describe "#passed?" do
+      it "is nil when completion is UNKNOWN" do
+        activity = described_class.new_from_api("activitySuccess" => "UNKNOWN")
+        expect(activity.passed?).to eq nil
+      end
+
+      it "is false when completion is FAILED" do
+        activity = described_class.new_from_api("activitySuccess" => "FAILED")
+        expect(activity.passed?).to eq false
+      end
+
+      it "is true when completion is PASSED" do
+        activity = described_class.new_from_api("activitySuccess" => "PASSED")
+        expect(activity.passed?).to eq true
+      end
+    end
+
+    describe "#failed?" do
+      it "is nil when completion is UNKNOWN" do
+        activity = described_class.new_from_api("activitySuccess" => "UNKNOWN")
+        expect(activity.failed?).to eq nil
+      end
+
+      it "is true when completion is FAILED" do
+        activity = described_class.new_from_api("activitySuccess" => "FAILED")
+        expect(activity.failed?).to eq true
+      end
+
+      it "is false when completion is PASSED" do
+        activity = described_class.new_from_api("activitySuccess" => "PASSED")
+        expect(activity.failed?).to eq false
+      end
+    end
   end
 end

data/spec/scorm_engine/models/registration_spec.rb

@@ -78,5 +78,73 @@ RSpec.describe ScormEngine::Models::Registration do
         expect(registration.learner).to eq nil
       end
     end
+
+    describe "#complete?" do
+      it "is nil when completion is UNKNOWN" do
+        registration = described_class.new_from_api("registrationCompletion" => "UNKNOWN")
+        expect(registration.complete?).to eq nil
+      end
+
+      it "is false when completion is INCOMPLETE" do
+        registration = described_class.new_from_api("registrationCompletion" => "INCOMPLETE")
+        expect(registration.complete?).to eq false
+      end
+
+      it "is true when completion is COMPLETED" do
+        registration = described_class.new_from_api("registrationCompletion" => "COMPLETED")
+        expect(registration.complete?).to eq true
+      end
+    end
+
+    describe "#incomplete?" do
+      it "is nil when completion is UNKNOWN" do
+        registration = described_class.new_from_api("registrationCompletion" => "UNKNOWN")
+        expect(registration.incomplete?).to eq nil
+      end
+
+      it "is true when completion is INCOMPLETE" do
+        registration = described_class.new_from_api("registrationCompletion" => "INCOMPLETE")
+        expect(registration.incomplete?).to eq true
+      end
+
+      it "is false when completion is COMPLETED" do
+        registration = described_class.new_from_api("registrationCompletion" => "COMPLETED")
+        expect(registration.incomplete?).to eq false
+      end
+    end
+
+    describe "#passed?" do
+      it "is nil when completion is Unknown" do
+        registration = described_class.new_from_api("registrationSuccess" => "Unknown")
+        expect(registration.passed?).to eq nil
+      end
+
+      it "is false when completion is Failed" do
+        registration = described_class.new_from_api("registrationSuccess" => "Failed")
+        expect(registration.passed?).to eq false
+      end
+
+      it "is true when completion is Passed" do
+        registration = described_class.new_from_api("registrationSuccess" => "Passed")
+        expect(registration.passed?).to eq true
+      end
+    end
+
+    describe "#failed?" do
+      it "is nil when completion is Unknown" do
+        registration = described_class.new_from_api("registrationSuccess" => "Unknown")
+        expect(registration.failed?).to eq nil
+      end
+
+      it "is true when completion is Failed" do
+        registration = described_class.new_from_api("registrationSuccess" => "Failed")
+        expect(registration.failed?).to eq true
+      end
+
+      it "is false when completion is Passed" do
+        registration = described_class.new_from_api("registrationSuccess" => "Passed")
+        expect(registration.failed?).to eq false
+      end
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: scorm_engine
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.6.2
 platform: ruby
 authors:
 - Philip Hallstrom
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-08-23 00:00:00.000000000 Z
+date: 2018-08-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday