pupilfirst_xapi 0.2.2 → 0.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f4c1f6e893b9a58bb193b6ddcbdf806ae9c341c3ff5527f3a2ba6a528cda7a05
-  data.tar.gz: 87858bf6e6a1b2beaa9bc8a85f9e7bc22424788a8011bc1a476f96fcd52d8370
+  metadata.gz: ab3ca34388c5e492e15f05a5768d692af65e56c3f088a1a2958143ab2dcf6152
+  data.tar.gz: 80bf4e923f96112d5e1f175f811fcaf1dc7c27709bcd7c937b09eeae4d89c755
 SHA512:
-  metadata.gz: a9a7da4741a9151c9251e7f9a31dc149d303a213fadb94cbdccd9a65578fb21bc7adfadfec168f30d6dbbf614fdb372aeb8ac2a967547628d427c046c0c3d944
-  data.tar.gz: 606c6d2f23faccbc6d30ee80e49b912148a862cc9855ea10814e1d64cd18300ece70469daea7f72093d5dad1cc176a1ddb2b5818a850bb9de9e88ab66982356c
+  metadata.gz: ac920b2427236772f18041c7219405fa05812248cc0745029ab62a72896076fb6335dac990e59783b653a6c7c3c5b922610e74b442c75c7a29d9c9fc6a77cb60
+  data.tar.gz: 3680b27bd76f6e184ffd307dfa50e9b97e27d46f85c19d49c827e430e02a87be75d6cbff741edbb1219fc19f82d8f755165675149eb273321104fb96511f82e4

data/lib/pupilfirst_xapi/objects.rb

@@ -1,6 +1,7 @@
 require_relative 'objects/builder'
 require_relative 'objects/course'
 require_relative 'objects/target'
+require_relative 'objects/video_start'
 
 module PupilfirstXapi
   module Objects
@@ -11,5 +12,14 @@ module PupilfirstXapi
     def self.target(target, uri_for)
       Target.new.call(target, uri_for)
     end
+
+    def self.video_start(student, video_id, uri_for)
+      VideoStart.new.call(student, video_id, uri_for)
+    end
+
+
+    def self.video_end(student, video_id, uri_for)
+      VideoEnd.new.call(student, video_id, uri_for)
+    end
   end
 end

data/lib/pupilfirst_xapi/objects/course.rb

@@ -10,6 +10,7 @@ module PupilfirstXapi
           name: course.name,
           description: course.description
         ).tap do |obj|
+          obj.with_extension('http://id.tincanapi.com/extension/ending-position', course.targets.count)
           if course.ends_at.present?
             duration = ActiveSupport::Duration.build(course.ends_at - course.created_at).iso8601
             obj.with_extension("http://id.tincanapi.com/extension/planned-duration", duration)

data/lib/pupilfirst_xapi/objects/target.rb

@@ -4,7 +4,6 @@ module PupilfirstXapi
       def call(target, uri_for)
         course = target.course
         target_uri = uri_for.call(target)
-        course_uri = uri_for.call(course)
 
         Builder.new(
           id: target_uri,
@@ -12,8 +11,8 @@ module PupilfirstXapi
           name: target.title,
           description: target.description
         ).tap do |obj|
-          obj.with_extension('course_id', course_uri)
-          obj.with_extension('course_name', course.name)
+          obj.with_extension('http://id.tincanapi.com/extension/host', Objects.course(course, uri_for).as_json)
+          obj.with_extension('http://id.tincanapi.com/extension/position', target.sort_index)
         end.call
       end
     end

data/lib/pupilfirst_xapi/objects/video_end.rb

@@ -0,0 +1,17 @@
+module PupilfirstXapi
+  module Objects
+    class VideoEnd
+      def call(student, video_id, uri_for)
+        student_uri = uri_for.call(student)
+        puts video_id
+
+        Builder.new(
+          id: student_uri,
+          type: "http://activitystrea.ms/schema/1.0/event",
+          name: student.name,
+          description: "student started video #{video_id}"
+        ).call
+      end
+    end
+  end
+end

data/lib/pupilfirst_xapi/objects/video_start.rb

@@ -0,0 +1,17 @@
+module PupilfirstXapi
+  module Objects
+    class VideoStart
+      def call(student, video_id, uri_for)
+        student_uri = uri_for.call(student)
+        puts video_id
+
+        Builder.new(
+          id: student_uri,
+          type: "http://activitystrea.ms/schema/1.0/event",
+          name: student.name,
+          description: "student started video #{video_id}"
+        ).call
+      end
+    end
+  end
+end

data/lib/pupilfirst_xapi/statements.rb

@@ -1,6 +1,8 @@
 require "pupilfirst_xapi/statements/course_completed"
 require "pupilfirst_xapi/statements/course_registered"
 require "pupilfirst_xapi/statements/target_completed"
+require "pupilfirst_xapi/statements/video_started"
+require "pupilfirst_xapi/statements/video_ended"
 
 module PupilfirstXapi
   module Statements
@@ -17,6 +19,8 @@ module PupilfirstXapi
       :student_added                      => CourseRegistered,
       :submission_graded                  => TargetCompleted,
       :submission_automatically_verified  => TargetCompleted,
+      :video_started                      => VideoStarted,
+      :video_ended                        => VideoEnded
     }
   end
 end

data/lib/pupilfirst_xapi/statements/video_ended.rb

@@ -0,0 +1,19 @@
+module PupilfirstXapi
+  module Statements
+    class VideoEnded
+      def initialize(repository, uri_for)
+        @repository = repository
+        @uri_for = uri_for
+      end
+
+      def call(actor_id:, resource_id:)
+        actor = @repository.call(:user, actor_id)
+        Xapi.create_statement(
+          actor: Actors.agent(actor),
+          verb: Verbs::VIDEO_ENDED,
+          object: Objects.video_end(actor, resource_id, @uri_for)
+        )
+      end
+    end
+  end
+end

data/lib/pupilfirst_xapi/statements/video_started.rb

@@ -0,0 +1,19 @@
+module PupilfirstXapi
+  module Statements
+    class VideoStarted
+      def initialize(repository, uri_for)
+        @repository = repository
+        @uri_for = uri_for
+      end
+
+      def call(actor_id:, resource_id:)
+        actor = @repository.call(:user, actor_id)
+        Xapi.create_statement(
+          actor: Actors.agent(actor),
+          verb: Verbs::VIDEO_STARTED,
+          object: Objects.video_start(actor, resource_id, @uri_for)
+        )
+      end
+    end
+  end
+end

data/lib/pupilfirst_xapi/verbs.rb

@@ -3,5 +3,7 @@ module PupilfirstXapi
     COMPLETED             = Xapi.create_verb(id: 'http://adlnet.gov/expapi/verbs/completed', name: 'completed')
     COMPLETED_ASSIGNMENT  = Xapi.create_verb(id: 'https://w3id.org/xapi/dod-isd/verbs/completed-assignment', name: 'completed assignment')
     REGISTERED            = Xapi.create_verb(id: 'http://adlnet.gov/expapi/verbs/registered', name: 'registered')
+    VIDEO_STARTED         = Xapi.create_verb(id: 'http://activitystrea.ms/schema/1.0/start', name: 'start')
+    VIDEO_ENDED           = Xapi.create_verb(id: 'http://activitystrea.ms/schema/1.0/consume', name: 'consumed')
   end
 end

data/lib/pupilfirst_xapi/version.rb

@@ -1,3 +1,3 @@
 module PupilfirstXapi
-  VERSION = '0.2.2'
+  VERSION = '0.3.4'
 end

data/spec/integration_spec.rb

@@ -15,7 +15,12 @@ RSpec.describe "#xapi", type: :job, perform_jobs: true do
            description: 'These guides are designed to make you immediately productive with Rails',
            created_at: Time.new(2021,01,01),
            ends_at: nil,
-           uri: 'https://guides.rubyonrails.org/')
+           uri: 'https://guides.rubyonrails.org/',
+           targets: [
+             double(:target, title: '1st target', description: 'Seems easy'),
+             double(:target, title: '2nd target', description: 'Seems not easy')
+            ]
+          )
   }
   let(:getting_started) {
     double(:target,
@@ -77,6 +82,7 @@ RSpec.describe "#xapi", type: :job, perform_jobs: true do
           name: {'en-US' => 'Ruby on Rails Guides'},
           description: {'en-US' => 'These guides are designed to make you immediately productive with Rails'},
           type: 'http://adlnet.gov/expapi/activities/product',
+          extensions: {"http://id.tincanapi.com/extension/ending-position"=>2}
         },
       },
       timestamp: timestamp.iso8601,

data/spec/outbox_spec.rb

@@ -4,8 +4,8 @@ module PupilfirstXapi
   RSpec.describe Outbox do
     let(:timestamp)   { Time.now }
     let(:john)        { double(:john, name: 'John Doe', email: 'john@doe.com') }
-    let(:course)      { double(:course, id: 32, name: 'Rails for Begginers', description: 'Seems easy', created_at: 1.week.ago, ends_at: nil) }
-    let(:target)      { double(:target, title: '1st target', description: 'Seems easy', course: course) }
+    let(:course)      { double(:course, id: 32, name: 'Rails for Begginers', description: 'Seems easy', created_at: 1.week.ago, ends_at: nil, targets: []) }
+    let(:target)      { double(:target, title: '1st target', description: 'Seems easy', course: course, sort_index: 7) }
     let(:good_one)    { double(:timeline_event, target: target, passed?: true) }
     let(:bad_one)     { double(:timeline_event, target: target, passed?: false) }
 

data/spec/statements/course_completed_spec.rb

@@ -5,7 +5,11 @@ module PupilfirstXapi
     RSpec.describe CourseCompleted do
       it do
         john   = double(:john, name: 'John Doe', email: 'john@doe.com')
-        course = double(:course, name: 'Rails for Begginers', description: 'Seems easy', created_at: 1.week.ago, ends_at: nil)
+        course = double(:course, name: 'Rails for Begginers', description: 'Seems easy', created_at: 1.week.ago, ends_at: nil,
+                                 targets: [
+                                   double(:target, title: '1st target', description: 'Seems easy'),
+                                   double(:target, title: '2nd target', description: 'Seems not easy')
+                                  ])
         data = {
           course: { 456 => course },
           user: { 123 => john },

data/spec/statements/course_registered_spec.rb

@@ -5,7 +5,11 @@ module PupilfirstXapi
     RSpec.describe CourseRegistered do
       it do
         john   = double(:john, name: 'John Doe', email: 'john@doe.com')
-        course = double(:course, name: 'Rails for Begginers', description: 'Seems easy', created_at: 1.week.ago, ends_at: nil)
+        course = double(:course, name: 'Rails for Begginers', description: 'Seems easy', created_at: 1.week.ago, ends_at: nil,
+                                 targets: [
+                                   double(:target, title: '1st target', description: 'Seems easy'),
+                                   double(:target, title: '2nd target', description: 'Seems not easy')
+                                  ])
         data = {
           course: { 456 => course },
           user: { 123 => john },
@@ -25,7 +29,9 @@ module PupilfirstXapi
         expect(xapi.object.definition.type).to eq 'http://adlnet.gov/expapi/activities/product'
         expect(xapi.object.definition.name).to eq({'en-US' => 'Rails for Begginers'})
         expect(xapi.object.definition.description).to eq({'en-US' => 'Seems easy'})
-        expect(xapi.object.definition.extensions).to eq nil
+        expect(xapi.object.definition.extensions).to eq ({
+          "http://id.tincanapi.com/extension/ending-position" => 2
+        })
       end
 
       it do
@@ -34,7 +40,11 @@ module PupilfirstXapi
         duration  = ActiveSupport::Duration.build(ends_at - starts_at).iso8601
 
         john   = double(:john, name: 'John Doe', email: 'john@doe.com')
-        course = double(:course, name: 'Rails for Begginers', description: 'Seems easy', created_at: starts_at, ends_at: ends_at)
+        course = double(:course, name: 'Rails for Begginers', description: 'Seems easy', created_at: starts_at, ends_at: ends_at,
+                                 targets: [
+                                   double(:target, title: '1st target', description: 'Seems easy'),
+                                   double(:target, title: '2nd target', description: 'Seems not easy')
+                                  ])
         data = {
           course: { 456 => course },
           user: { 123 => john },
@@ -54,7 +64,10 @@ module PupilfirstXapi
         expect(xapi.object.definition.type).to eq 'http://adlnet.gov/expapi/activities/product'
         expect(xapi.object.definition.name).to eq({'en-US' => 'Rails for Begginers'})
         expect(xapi.object.definition.description).to eq({'en-US' => 'Seems easy'})
-        expect(xapi.object.definition.extensions).to eq({"http://id.tincanapi.com/extension/planned-duration" => duration})
+        expect(xapi.object.definition.extensions).to eq({
+          "http://id.tincanapi.com/extension/planned-duration" => duration,
+          "http://id.tincanapi.com/extension/ending-position" => 2
+        })
       end
     end
   end

data/spec/statements/target_completed_spec.rb

@@ -4,8 +4,12 @@ module PupilfirstXapi
   module Statements
     RSpec.describe TargetCompleted do
       it do
-        course = double(:course, id: 17, name: 'Rails for Begginers', description: 'Seems easy', created_at: 1.week.ago, ends_at: nil)
-        target = double(:target, title: '1st target', course: course, description: 'Seems easy')
+        course = double(:course, id: 17, name: 'Rails for Begginers', description: 'Seems easy', created_at: 1.week.ago, ends_at: nil,
+                                 targets: [
+                                   double(:target, title: '1st target', description: 'Seems easy'),
+                                   double(:target, title: '2nd target', description: 'Seems not easy')
+                                  ])
+        target = double(:target, title: '1st target', course: course, description: 'Seems easy', sort_index: 5)
         submission = double(:timeline_event, target: target, passed?: true)
         john   = double(:john, name: 'John Doe', email: 'john@doe.com')
         data = {
@@ -27,14 +31,11 @@ module PupilfirstXapi
         expect(xapi.object.definition.type).to eq 'http://activitystrea.ms/schema/1.0/task'
         expect(xapi.object.definition.name).to eq({'en-US' => '1st target'})
         expect(xapi.object.definition.description).to eq({'en-US' => 'Seems easy'})
-        expect(xapi.object.definition.extensions).to eq({
-          'course_id'=>'course-1',
-          'course_name'=>'Rails for Begginers'
-        })
+        expect(xapi.object.definition.extensions['http://id.tincanapi.com/extension/host']['id']).to eq 'course-1'
       end
 
       it 'no-op when submission is not passed'  do
-        target = double(:target, title: '1st target', description: 'Seems easy')
+        target = double(:target, title: '1st target', description: 'Seems easy', sort_index: 3)
         submission = double(:timeline_event, target: target, passed?: false)
         john   = double(:john, name: 'John Doe', email: 'john@doe.com')
         data = {

metadata

@@ -1,22 +1,19 @@
 --- !ruby/object:Gem::Specification
 name: pupilfirst_xapi
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.4
 platform: ruby
 authors:
 - GrowthTribe
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-05-13 00:00:00.000000000 Z
+date: 2021-07-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 6.0.3
     - - ">="
       - !ruby/object:Gem::Version
         version: 6.0.3.4
@@ -24,9 +21,6 @@ dependencies:
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 6.0.3
     - - ">="
       - !ruby/object:Gem::Version
         version: 6.0.3.4
@@ -86,7 +80,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description:
+description: 
 email:
 - devs@growthtribe.io
 executables: []
@@ -103,11 +97,15 @@ files:
 - lib/pupilfirst_xapi/objects/builder.rb
 - lib/pupilfirst_xapi/objects/course.rb
 - lib/pupilfirst_xapi/objects/target.rb
+- lib/pupilfirst_xapi/objects/video_end.rb
+- lib/pupilfirst_xapi/objects/video_start.rb
 - lib/pupilfirst_xapi/outbox.rb
 - lib/pupilfirst_xapi/statements.rb
 - lib/pupilfirst_xapi/statements/course_completed.rb
 - lib/pupilfirst_xapi/statements/course_registered.rb
 - lib/pupilfirst_xapi/statements/target_completed.rb
+- lib/pupilfirst_xapi/statements/video_ended.rb
+- lib/pupilfirst_xapi/statements/video_started.rb
 - lib/pupilfirst_xapi/verbs.rb
 - lib/pupilfirst_xapi/version.rb
 - spec/integration_spec.rb
@@ -126,7 +124,7 @@ metadata:
   homepage_uri: https://github.com/growthtribeacademy/pupilfirst-xapi
   source_code_uri: https://github.com/growthtribeacademy/pupilfirst-xapi/pupilfirst_xapi
   changelog_uri: https://github.com/growthtribeacademy/pupilfirst-xapi/pupilfirst_xapi/CHANGELOG.md
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -141,17 +139,17 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
-signing_key:
+rubygems_version: 3.1.6
+signing_key: 
 specification_version: 4
 summary: XAPI statements generator and publisher to LRS for Pupilfirst
 test_files:
-- spec/integration_spec.rb
 - spec/objects/builder_spec.rb
-- spec/outbox_job_spec.rb
-- spec/outbox_spec.rb
 - spec/rails_helper.rb
-- spec/spec_helper.rb
+- spec/statements/target_completed_spec.rb
 - spec/statements/course_completed_spec.rb
 - spec/statements/course_registered_spec.rb
-- spec/statements/target_completed_spec.rb
+- spec/spec_helper.rb
+- spec/outbox_spec.rb
+- spec/integration_spec.rb
+- spec/outbox_job_spec.rb