pupilfirst_xapi 0.3.5 → 0.3.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8f5c38a8fbf57be11cda1429b9cffc1ed6d818ca11a69d220305a2cd0e954125
-  data.tar.gz: c018dae18cd439930c6d70eba6fb60bafe8014d01a5ce2ae5be6ca3d5556f88c
+  metadata.gz: 9671a7b657ac2a6a5db9b4988b50f069d24bde84e08f722e17c9e510f0990f88
+  data.tar.gz: 1eb93f047df91dc644ee65372d6a163d732c1d64e3763189de793fdd60ccbe2a
 SHA512:
-  metadata.gz: d3d62b03c85f3610a50d7cb3aa0bbbed2fad9ad4d6c3c9aa67fac48f972a64e9a08fdc6d59cc38a7b75e2400efecd2f555d2d6d960c7c889be617432ea347800
-  data.tar.gz: e525ac790f096b0b70a82727901cc88bacee1aeff9b44ecbca7e227e7d0e52bb2aeb39a3007af0b22b3345f05c54204d930523ec9f374f8d8fdde4650ecc246e
+  metadata.gz: 69254b39c819d27d967c005fb6a91f648527cd78abadd17a2ae8b1e51294d56d2a1e9392d58671b2eb617511cfe5884a2565e73ca26f35304c0f68463c814db1
+  data.tar.gz: 9bf904d914c4ad290be96ca7a17fbae1d0cf0aec40f0dfe50e31201291c86942741d010b2cc17c3a103303aa6c776ceb4f2a7f5d550026b49b12b5b4b6f40cf6

data/lib/pupilfirst_xapi/objects.rb

@@ -3,6 +3,10 @@ require_relative 'objects/course'
 require_relative 'objects/target'
 require_relative 'objects/video_start'
 require_relative 'objects/video_end'
+require_relative 'objects/survey_start'
+require_relative 'objects/survey_end'
+require_relative 'objects/survey'
+require_relative 'objects/answer'
 
 module PupilfirstXapi
   module Objects
@@ -18,9 +22,24 @@ module PupilfirstXapi
       VideoStart.new.call(target, uri_for)
     end
 
-
     def self.video_end(target, uri_for)
       VideoEnd.new.call(target, uri_for)
     end
+
+    def self.survey_start(survey, uri_for)
+      SurveyStart.new.call(survey, uri_for)
+    end
+
+    def self.survey_end(survey, uri_for)
+      SurveyEnd.new.call(survey, uri_for)
+    end
+
+    def self.capability_result_viewed(survey, uri_for)
+      Survey.new.call(survey, uri_for)
+    end
+
+    def self.answer(question, uri_for)
+      Answer.new.call(question, uri_for)
+    end
   end
 end

data/lib/pupilfirst_xapi/objects/answer.rb

@@ -0,0 +1,18 @@
+module PupilfirstXapi
+  module Objects
+    class Answer
+      def call(answer, uri_for)
+        target_uri = uri_for.call(answer)
+
+        Builder.new(
+          id: target_uri,
+          type: 'http://adlnet.gov/expapi/activities/assessment',
+          name: answer.question.description,
+          description: answer.question.description
+        ).with_extension('http://adlnet.gov/expapi/activities/question', answer.question.description)
+        .with_extension('http://adlnet.gov/expapi/activities/answer', answer.content || answer.alternatives.as_json)
+          .call
+      end
+    end
+  end
+end

data/lib/pupilfirst_xapi/objects/survey.rb

@@ -0,0 +1,16 @@
+module PupilfirstXapi
+  module Objects
+    class Survey
+      def call(survey, uri_for)
+        target_uri = uri_for.call(survey)
+
+        Builder.new(
+          id: target_uri,
+          type: 'http://id.tincanapi.com/activitytype/survey',
+          name: survey.name,
+          description: survey.external_name
+        ).call
+      end
+    end
+  end
+end

data/lib/pupilfirst_xapi/objects/survey_end.rb

@@ -0,0 +1,18 @@
+module PupilfirstXapi
+  module Objects
+    class SurveyEnd
+      def call(survey, uri_for)
+        target_uri = uri_for.call(survey)
+
+        Builder.new(
+          id: target_uri,
+          type: 'http://adlnet.gov/expapi/activities/assessment',
+          name: survey.name,
+          description: survey.external_name
+        ).with_extension(
+          'http://id.tincanapi.com/extension/target', survey.slug
+        ).call
+      end
+    end
+  end
+end

data/lib/pupilfirst_xapi/objects/survey_start.rb

@@ -0,0 +1,18 @@
+module PupilfirstXapi
+  module Objects
+    class SurveyStart
+      def call(survey, uri_for)
+        target_uri = uri_for.call(survey)
+
+        Builder.new(
+          id: target_uri,
+          type: 'http://adlnet.gov/expapi/activities/assessment',
+          name: survey.name,
+          description: survey.external_name
+        ).with_extension(
+          'http://id.tincanapi.com/extension/target', survey.slug
+        ).call
+      end
+    end
+  end
+end

data/lib/pupilfirst_xapi/statements.rb

@@ -3,6 +3,10 @@ require "pupilfirst_xapi/statements/course_registered"
 require "pupilfirst_xapi/statements/target_completed"
 require "pupilfirst_xapi/statements/video_started"
 require "pupilfirst_xapi/statements/video_ended"
+require "pupilfirst_xapi/statements/survey_started"
+require "pupilfirst_xapi/statements/survey_ended"
+require "pupilfirst_xapi/statements/capability_result_viewed"
+require "pupilfirst_xapi/statements/question_answered"
 
 module PupilfirstXapi
   module Statements
@@ -20,7 +24,11 @@ module PupilfirstXapi
       :submission_graded                  => TargetCompleted,
       :submission_automatically_verified  => TargetCompleted,
       :video_started                      => VideoStarted,
-      :video_ended                        => VideoEnded
+      :video_ended                        => VideoEnded,
+      :survey_started                     => SurveyStarted,
+      :survey_ended                       => SurveyEnded,
+      :capability_result_viewed           => CapabilityResultViewed,
+      :question_answered                  => QuestionAnswered
     }
   end
 end

data/lib/pupilfirst_xapi/statements/capability_result_viewed.rb

@@ -0,0 +1,20 @@
+module PupilfirstXapi
+  module Statements
+    class CapabilityResultViewed
+      def initialize(repository, uri_for)
+        @repository = repository
+        @uri_for = uri_for
+      end
+
+      def call(actor_id:, resource_id:)
+        actor  = @repository.call(:user, actor_id)
+        survey = @repository.call(:survey, resource_id)
+        Xapi.create_statement(
+          actor: Actors.agent(actor),
+          verb: Verbs::VIEWED,
+          object: Objects.capability_result_viewed(survey, @uri_for)
+        )
+      end
+    end
+  end
+end

data/lib/pupilfirst_xapi/statements/question_answered.rb

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

data/lib/pupilfirst_xapi/statements/survey_ended.rb

@@ -0,0 +1,21 @@
+module PupilfirstXapi
+  module Statements
+    class SurveyEnded
+      def initialize(repository, uri_for)
+        @repository = repository
+        @uri_for = uri_for
+      end
+
+      def call(actor_id:, resource_id:)
+        actor = @repository.call(:user, actor_id)
+        survey = @repository.call(:survey, resource_id)
+
+        Xapi.create_statement(
+          actor: Actors.agent(actor),
+          verb: Verbs::COMPLETED,
+          object: Objects.survey_end(survey, @uri_for)
+        )
+      end
+    end
+  end
+end

data/lib/pupilfirst_xapi/statements/survey_started.rb

@@ -0,0 +1,21 @@
+module PupilfirstXapi
+  module Statements
+    class SurveyStarted
+      def initialize(repository, uri_for)
+        @repository = repository
+        @uri_for = uri_for
+      end
+
+      def call(actor_id:, resource_id:)
+        actor = @repository.call(:user, actor_id)
+        survey = @repository.call(:survey, resource_id)
+
+        Xapi.create_statement(
+          actor: Actors.agent(actor),
+          verb: Verbs::STARTED,
+          object: Objects.survey_start(survey, @uri_for)
+        )
+      end
+    end
+  end
+end

data/lib/pupilfirst_xapi/verbs.rb

@@ -5,5 +5,8 @@ module PupilfirstXapi
     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')
+    STARTED               = Xapi.create_verb(id: 'http://adlnet.gov/expapi/verbs/initialized', name: 'initialized')
+    VIEWED                = Xapi.create_verb(id: 'http://id.tincanapi.com/verb/viewed', name: 'viewed')
+    ANSWERED              = Xapi.create_verb(id: 'https://w3id.org/xapi/dod-isd/verbs/answered', name: 'answered')
   end
 end

data/lib/pupilfirst_xapi/version.rb

@@ -1,3 +1,3 @@
 module PupilfirstXapi
-  VERSION = '0.3.5'
+  VERSION = '0.3.8'
 end

data/spec/statements/capability_result_viewed_spec.rb

@@ -0,0 +1,43 @@
+require 'spec_helper'
+
+module PupilfirstXapi
+  module Statements
+    RSpec.describe CapabilityResultViewed do
+      it do
+        john   = double(:john, name: 'John Doe', email: 'john@doe.com')
+        survey = double(
+          :survey,
+          name: 'Rails for Beginners',
+          external_name: '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 = {
+          survey: { 456 => survey },
+          user: { 123 => john }
+        }
+
+        repository = ->(klass, resource_id) { data.dig(klass, resource_id) }
+        uri_for = ->(obj) { obj == survey ? 'rails-for-begginers' : nil }
+
+        xapi = CapabilityResultViewed.new(repository, uri_for).call(actor_id: 123, resource_id: 456)
+
+        expect(xapi).to be_a Xapi::Statement
+        expect_actor(xapi.actor, name: 'John Doe', email: 'john@doe.com')
+        expect(xapi.verb).to eq Verbs::VIEWED
+
+        expect(xapi.object).to be_a Xapi::Activity
+        expect(xapi.object.object_type).to eq 'Activity'
+        expect(xapi.object.id).to eq 'rails-for-begginers'
+        expect(xapi.object.definition.type).to eq 'http://id.tincanapi.com/activitytype/survey'
+        expect(xapi.object.definition.name).to eq({'en-US' => 'Rails for Beginners'})
+        expect(xapi.object.definition.description).to eq({'en-US' => 'Seems easy'})
+      end
+    end
+  end
+end

data/spec/statements/question_answered_spec.rb

@@ -0,0 +1,50 @@
+require 'spec_helper'
+
+module PupilfirstXapi
+  module Statements
+    RSpec.describe QuestionAnswered do
+      it do
+        john   = double(:john, name: 'John Doe', email: 'john@doe.com')
+        question = double(:question, description: "What is your favorite animal?")
+        answer = double(
+          :answer,
+          answer_id: 42,
+          question_id: 4,
+          question: question,
+          alternative_id: nil,
+          survey_group_id:7,
+          user_external_id: 'a6ad5226-7d8b-4108-9cc9-f0821de150f5',
+          answer_type: 'open_ended',
+          content: 'Content',
+          score: 0.0,
+          level: 1.0,
+          language: 'en',
+          created_at: 1.week.ago,
+          ends_at: nil
+        )
+
+        data = {
+          answer: { 456 => answer },
+          user: { 123 => john }
+        }
+
+        repository = ->(klass, resource_id) { data.dig(klass, resource_id) }
+        uri_for = ->(obj) { obj == answer ? 'rails-for-begginers' : nil }
+
+        xapi = QuestionAnswered.new(repository, uri_for).call(actor_id: 123, resource_id: 456)
+
+        expect(xapi).to be_a Xapi::Statement
+        expect_actor(xapi.actor, name: 'John Doe', email: 'john@doe.com')
+        expect(xapi.verb).to eq Verbs::ANSWERED
+
+        expect(xapi.object).to be_a Xapi::Activity
+        expect(xapi.object.object_type).to eq 'Activity'
+        expect(xapi.object.id).to eq 'rails-for-begginers'
+        expect(xapi.object.definition.type).to eq 'http://adlnet.gov/expapi/activities/assessment'
+        expect(xapi.object.definition.name).to eq({'en-US' => 'What is your favorite animal?'})
+        expect(xapi.object.definition.description).to eq({'en-US' => 'What is your favorite animal?'})
+        expect(xapi.object.definition.extensions.fetch('http://adlnet.gov/expapi/activities/question')).to eq("What is your favorite animal?")
+      end
+    end
+  end
+end

data/spec/statements/survey_ended_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+
+module PupilfirstXapi
+  module Statements
+    RSpec.describe SurveyEnded do
+      it do
+        john   = double(:john, name: 'John Doe', email: 'john@doe.com')
+        survey = double(
+          :survey,
+          name: 'Rails for Beginners',
+          external_name: 'Seems easy',
+          slug: 'a6ad5226-7d8b-4108-9cc9-f0821de150f5',
+          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 = {
+          survey: { 456 => survey },
+          user: { 123 => john }
+        }
+
+        repository = ->(klass, resource_id) { data.dig(klass, resource_id) }
+        uri_for = ->(obj) { obj == survey ? 'rails-for-begginers' : nil }
+
+        xapi = SurveyEnded.new(repository, uri_for).call(actor_id: 123, resource_id: 456)
+
+        expect(xapi).to be_a Xapi::Statement
+        expect_actor(xapi.actor, name: 'John Doe', email: 'john@doe.com')
+        expect(xapi.verb).to eq Verbs::COMPLETED
+
+        expect(xapi.object).to be_a Xapi::Activity
+        expect(xapi.object.object_type).to eq 'Activity'
+        expect(xapi.object.id).to eq 'rails-for-begginers'
+        expect(xapi.object.definition.type).to eq 'http://adlnet.gov/expapi/activities/assessment'
+        expect(xapi.object.definition.name).to eq({'en-US' => 'Rails for Beginners'})
+        expect(xapi.object.definition.description).to eq({'en-US' => 'Seems easy'})
+        expect(xapi.object.definition.extensions.fetch('http://id.tincanapi.com/extension/target')).to eq('a6ad5226-7d8b-4108-9cc9-f0821de150f5')
+      end
+    end
+  end
+end

data/spec/statements/survey_started_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+
+module PupilfirstXapi
+  module Statements
+    RSpec.describe SurveyStarted do
+      it do
+        john   = double(:john, name: 'John Doe', email: 'john@doe.com')
+        survey = double(
+          :survey,
+          name: 'Rails for Beginners',
+          external_name: 'Seems easy',
+          slug: 'a6ad5226-7d8b-4108-9cc9-f0821de150f5',
+          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 = {
+          survey: { 456 => survey },
+          user: { 123 => john }
+        }
+
+        repository = ->(klass, resource_id) { data.dig(klass, resource_id) }
+        uri_for = ->(obj) { obj == survey ? 'rails-for-begginers' : nil }
+
+        xapi = SurveyStarted.new(repository, uri_for).call(actor_id: 123, resource_id: 456)
+
+        expect(xapi).to be_a Xapi::Statement
+        expect_actor(xapi.actor, name: 'John Doe', email: 'john@doe.com')
+        expect(xapi.verb).to eq Verbs::STARTED
+
+        expect(xapi.object).to be_a Xapi::Activity
+        expect(xapi.object.object_type).to eq 'Activity'
+        expect(xapi.object.id).to eq 'rails-for-begginers'
+        expect(xapi.object.definition.type).to eq 'http://adlnet.gov/expapi/activities/assessment'
+        expect(xapi.object.definition.name).to eq({'en-US' => 'Rails for Beginners'})
+        expect(xapi.object.definition.description).to eq({'en-US' => 'Seems easy'})
+        expect(xapi.object.definition.extensions.fetch('http://id.tincanapi.com/extension/target')).to eq('a6ad5226-7d8b-4108-9cc9-f0821de150f5')
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pupilfirst_xapi
 version: !ruby/object:Gem::Version
-  version: 0.3.5
+  version: 0.3.8
 platform: ruby
 authors:
 - GrowthTribe
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-07-21 00:00:00.000000000 Z
+date: 2021-08-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -94,15 +94,23 @@ files:
 - lib/pupilfirst_xapi/actors.rb
 - lib/pupilfirst_xapi/lrs.rb
 - lib/pupilfirst_xapi/objects.rb
+- lib/pupilfirst_xapi/objects/answer.rb
 - lib/pupilfirst_xapi/objects/builder.rb
 - lib/pupilfirst_xapi/objects/course.rb
+- lib/pupilfirst_xapi/objects/survey.rb
+- lib/pupilfirst_xapi/objects/survey_end.rb
+- lib/pupilfirst_xapi/objects/survey_start.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/capability_result_viewed.rb
 - lib/pupilfirst_xapi/statements/course_completed.rb
 - lib/pupilfirst_xapi/statements/course_registered.rb
+- lib/pupilfirst_xapi/statements/question_answered.rb
+- lib/pupilfirst_xapi/statements/survey_ended.rb
+- lib/pupilfirst_xapi/statements/survey_started.rb
 - lib/pupilfirst_xapi/statements/target_completed.rb
 - lib/pupilfirst_xapi/statements/video_ended.rb
 - lib/pupilfirst_xapi/statements/video_started.rb
@@ -114,8 +122,12 @@ files:
 - spec/outbox_spec.rb
 - spec/rails_helper.rb
 - spec/spec_helper.rb
+- spec/statements/capability_result_viewed_spec.rb
 - spec/statements/course_completed_spec.rb
 - spec/statements/course_registered_spec.rb
+- spec/statements/question_answered_spec.rb
+- spec/statements/survey_ended_spec.rb
+- spec/statements/survey_started_spec.rb
 - spec/statements/target_completed_spec.rb
 homepage: https://github.com/growthtribeacademy/pupilfirst-xapi
 licenses:
@@ -139,17 +151,21 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.2.15
 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/statements/target_completed_spec.rb
+- spec/spec_helper.rb
+- spec/statements/capability_result_viewed_spec.rb
 - spec/statements/course_completed_spec.rb
 - spec/statements/course_registered_spec.rb
-- spec/spec_helper.rb
-- spec/outbox_spec.rb
-- spec/integration_spec.rb
-- spec/outbox_job_spec.rb
+- spec/statements/question_answered_spec.rb
+- spec/statements/survey_ended_spec.rb
+- spec/statements/survey_started_spec.rb
+- spec/statements/target_completed_spec.rb