pupilfirst_xapi 0.1.0 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 99a6dddb084209a85ef5d3f6ad55cf489fb50cf21b0a1f1c1e01a392079a13e9
-  data.tar.gz: bff106abc8d633185bda3b156203ad901ae0beff5fdb544051014a462405fd67
+  metadata.gz: bdb9ed6c9957df10e29f9f8fac0d5a303ac6ed5f962d78bb27af84be1255f61d
+  data.tar.gz: 361c1a5767d137ee50a99a191bb9906b1ca295bf6074e2c3568b80a5cf5121ce
 SHA512:
-  metadata.gz: b41c20f2967044b42d4d3f11c5307a5970e680f8313d200a91e98e948f0e7ae8053793c976d091372d78eb3a9ede6da505d0253265cd588c51707d355fe26ad5
-  data.tar.gz: 8a526960635e5065792c221140153834f5eb3f01ab5ef66b221369b034e18510f094e972637702052a2a7a7bfe506fe1762838cf39d3f98a558b7878abf1d2f0
+  metadata.gz: ab2a1cba32a1cdc99afeabb7bffc99b022a695989817ac8fe27e7f11894635dedc7befa6a88308af5660ddae6cf9aec8a4d97270bf45e9fb17263eb710d8aa61
+  data.tar.gz: e58f22380039a0235534988affdaaa4f01b208b83e43857908d62e20c17d636b548b9a8da96a616e0bb9d1ed03a77b5627488d5c3d0e0bf8e560d658bcc2d24b

data/lib/pupilfirst_xapi.rb

@@ -2,6 +2,7 @@ require "action_controller/railtie"
 require "active_job/railtie"
 require "growthtribe_xapi"
 require "pupilfirst_xapi/version"
+require "pupilfirst_xapi/lrs"
 require "pupilfirst_xapi/outbox"
 require "pupilfirst_xapi/actors"
 require "pupilfirst_xapi/objects"
@@ -11,6 +12,7 @@ require "pupilfirst_xapi/statements"
 module PupilfirstXapi
   mattr_accessor :uri_for
   mattr_accessor :repository
+  mattr_accessor :lrs
 
   Statements.subscribe do |event_type|
     ActiveSupport::Notifications.subscribe("#{event_type}.pupilfirst") do |_name, _start, finish, _id, payload|

data/lib/pupilfirst_xapi/lrs.rb

@@ -0,0 +1,24 @@
+require 'xapi'
+
+module PupilfirstXapi
+  class Lrs
+    def initialize(
+      end_point: ENV['LRS_ENDPOINT'],
+      key: ENV['LRS_KEY'],
+      secret: ENV['LRS_SECRET']
+    )
+      @lrs = end_point && key && secret &&
+        Xapi.create_remote_lrs(
+          end_point: end_point,
+          user_name: key,
+          password: secret
+        )
+    end
+
+    def call(statement)
+      return unless statement && @lrs
+
+      Xapi.post_statement(remote_lrs: @lrs, statement: statement)
+    end
+  end
+end

data/lib/pupilfirst_xapi/objects.rb

@@ -4,12 +4,12 @@ require_relative 'objects/target'
 
 module PupilfirstXapi
   module Objects
-    def self.course(course, uri)
-      Course.new.call(course, uri)
+    def self.course(course, uri_for)
+      Course.new.call(course, uri_for)
     end
 
-    def self.target(target, uri)
-      Target.new.call(target, uri)
+    def self.target(target, uri_for)
+      Target.new.call(target, uri_for)
     end
   end
 end

data/lib/pupilfirst_xapi/objects/course.rb

@@ -1,13 +1,16 @@
 module PupilfirstXapi
   module Objects
     class Course
-      def call(course, uri)
+      def call(course, uri_for)
+        uri = uri_for.call(course)
+
         Builder.new(
           id: uri,
           type: 'http://adlnet.gov/expapi/activities/product',
           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

@@ -1,13 +1,19 @@
 module PupilfirstXapi
   module Objects
     class Target
-      def call(target, uri)
+      def call(target, uri_for)
+        course = target.course
+        target_uri = uri_for.call(target)
+
         Builder.new(
-          id: uri,
+          id: target_uri,
           type: "http://activitystrea.ms/schema/1.0/task",
           name: target.title,
           description: target.description
-        ).call
+        ).tap do |obj|
+          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
   end

data/lib/pupilfirst_xapi/outbox.rb

@@ -1,5 +1,4 @@
 require "active_job"
-require 'xapi'
 
 module PupilfirstXapi
   class Outbox
@@ -14,19 +13,11 @@ module PupilfirstXapi
 
       def outbox
         Outbox.new(
-          lrs: remote_lrs,
+          lrs: PupilfirstXapi.lrs || PupilfirstXapi::Lrs.new,
           repository: PupilfirstXapi.repository,
           uri_for: PupilfirstXapi.uri_for
         )
       end
-
-      def remote_lrs
-        Xapi.create_remote_lrs(
-          end_point: ENV['LRS_ENDPOINT'],
-          user_name: ENV['LRS_KEY'],
-          password: ENV['LRS_SECRET']
-        )
-      end
     end
 
     class << self
@@ -42,8 +33,7 @@ module PupilfirstXapi
     end
 
     def call(**payload)
-      statement = statement_for(**payload)
-      Xapi.post_statement(remote_lrs: @lrs, statement: statement) if statement
+      @lrs.call(statement_for(**payload))
     end
 
     private

data/lib/pupilfirst_xapi/statements/course_completed.rb

@@ -13,7 +13,7 @@ module PupilfirstXapi
         Xapi.create_statement(
           actor: Actors.agent(actor),
           verb: Verbs::COMPLETED,
-          object: Objects.course(course, @uri_for.call(course))
+          object: Objects.course(course, @uri_for)
         )
       end
     end

data/lib/pupilfirst_xapi/statements/course_registered.rb

@@ -13,7 +13,7 @@ module PupilfirstXapi
         Xapi.create_statement(
           actor: Actors.agent(actor),
           verb: Verbs::REGISTERED,
-          object: Objects.course(course, @uri_for.call(course))
+          object: Objects.course(course, @uri_for)
         )
       end
     end

data/lib/pupilfirst_xapi/statements/target_completed.rb

@@ -16,7 +16,7 @@ module PupilfirstXapi
         Xapi.create_statement(
           actor: Actors.agent(actor),
           verb: Verbs::COMPLETED_ASSIGNMENT,
-          object: Objects.target(target, @uri_for.call(target))
+          object: Objects.target(target, @uri_for)
         )
       end
     end

data/lib/pupilfirst_xapi/version.rb

@@ -1,3 +1,3 @@
 module PupilfirstXapi
-  VERSION = '0.1.0'
+  VERSION = '0.3.2'
 end

data/spec/integration_spec.rb

@@ -15,13 +15,20 @@ 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,
            title: 'Getting Started with Rails',
            description: 'This guide covers getting up and running with Ruby on Rails.',
-           uri: 'https://guides.rubyonrails.org/getting_started.html')
+           uri: 'https://guides.rubyonrails.org/getting_started.html',
+           course: ror_guides
+          )
   }
   let(:good_one) { double(:timeline_event, target: getting_started, passed?: true) }
   let(:bad_one) { double(:timeline_event, target: getting_started, passed?: false) }
@@ -75,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,
@@ -88,7 +96,7 @@ RSpec.describe "#xapi", type: :job, perform_jobs: true do
           'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3',
           'Authorization'=>'Basic a2V5OnNlY3JldA==',
           'Content-Type'=>'application/json',
-          'User-Agent'=>'Faraday v1.3.0',
+          'User-Agent'=>'Faraday v1.3.1',
           'X-Experience-Api-Version'=>'1.0.1'
         }
       ).to_return(status: 204, body: "", headers: {})

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, 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') }
+    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/spec_helper.rb

@@ -50,7 +50,9 @@ class FakeLrs
   end
   attr_reader :statements
 
-  def save_statement(statement)
+  def call(statement)
+    return unless statement
+
     @statements << statement
   end
 end

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_redistered_spec.rb → 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,7 +4,12 @@ module PupilfirstXapi
   module Statements
     RSpec.describe TargetCompleted do
       it do
-        target = double(:target, title: '1st target', 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 = {
@@ -12,7 +17,7 @@ module PupilfirstXapi
           user: { 123 => john },
         }
         repository = ->(klass, resource_id) { data.dig(klass, resource_id) }
-        uri_for = ->(obj) { obj == target ? 'target-1' : nil }
+        uri_for = ->(obj) { obj == target ? 'target-1' : obj == course ? 'course-1' : nil }
 
         xapi = TargetCompleted.new(repository, uri_for).call(actor_id: 123, resource_id: 456)
 
@@ -26,10 +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['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,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pupilfirst_xapi
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.2
 platform: ruby
 authors:
 - GrowthTribe
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-03-02 00:00:00.000000000 Z
+date: 2021-05-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -36,14 +36,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.1
+        version: 0.0.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.1
+        version: 0.0.2
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
@@ -98,6 +98,7 @@ files:
 - Rakefile
 - lib/pupilfirst_xapi.rb
 - lib/pupilfirst_xapi/actors.rb
+- lib/pupilfirst_xapi/lrs.rb
 - lib/pupilfirst_xapi/objects.rb
 - lib/pupilfirst_xapi/objects/builder.rb
 - lib/pupilfirst_xapi/objects/course.rb
@@ -116,7 +117,7 @@ files:
 - spec/rails_helper.rb
 - spec/spec_helper.rb
 - spec/statements/course_completed_spec.rb
-- spec/statements/course_redistered_spec.rb
+- spec/statements/course_registered_spec.rb
 - spec/statements/target_completed_spec.rb
 homepage: https://github.com/growthtribeacademy/pupilfirst-xapi
 licenses:
@@ -152,5 +153,5 @@ test_files:
 - spec/rails_helper.rb
 - spec/spec_helper.rb
 - spec/statements/course_completed_spec.rb
-- spec/statements/course_redistered_spec.rb
+- spec/statements/course_registered_spec.rb
 - spec/statements/target_completed_spec.rb