pupilfirst_xapi 0.1.0

data/spec/objects/builder_spec.rb

@@ -0,0 +1,54 @@
+require 'spec_helper'
+
+module PupilfirstXapi
+  module Objects
+    RSpec.describe Builder do
+      it do
+        xapi = Builder.new(id: 'any-uri', name: 'Something', description: 'from nothing', type: 'type-uri').call
+
+        expect(xapi).to be_a Xapi::Activity
+        expect(xapi.id).to eq 'any-uri'
+        expect(xapi.definition.name).to eq({'en-US' => 'Something'})
+        expect(xapi.definition.description).to eq({'en-US' => 'from nothing'})
+        expect(xapi.definition.type).to eq 'type-uri'
+        expect(xapi.definition.extensions).to eq nil
+        expect(xapi.object_type).to eq 'Activity'
+      end
+
+      it do
+        xapi = Builder.new(id: 'any-uri', name: 'Something', description: 'from nothing', type: 'type-uri')
+          .with_extension('ext-type-1', 'any-value-1')
+          .with_extension('ext-type-2', 'any-value-2')
+          .call
+
+        expect(xapi).to be_a Xapi::Activity
+        expect(xapi.id).to eq 'any-uri'
+        expect(xapi.definition.name).to eq({'en-US' => 'Something'})
+        expect(xapi.definition.description).to eq({'en-US' => 'from nothing'})
+        expect(xapi.definition.type).to eq 'type-uri'
+        expect(xapi.definition.extensions).to eq({
+          'ext-type-1' => 'any-value-1',
+          'ext-type-2' => 'any-value-2',
+        })
+        expect(xapi.object_type).to eq 'Activity'
+      end
+
+      it do
+        xapi = Builder.new(id: 'any-uri', name: 'Something', description: 'from nothing', type: 'type-uri')
+          .with_extension('ext-type', 'any-value-1')
+          .with_extension('ext-type', 'any-value-2')
+          .call
+
+        expect(xapi).to be_a Xapi::Activity
+        expect(xapi.id).to eq 'any-uri'
+        expect(xapi.definition.name).to eq({'en-US' => 'Something'})
+        expect(xapi.definition.description).to eq({'en-US' => 'from nothing'})
+        expect(xapi.definition.type).to eq 'type-uri'
+        expect(xapi.definition.extensions).to eq({
+          'ext-type' => 'any-value-2',
+        })
+        expect(xapi.object_type).to eq 'Activity'
+      end
+    end
+  end
+end

data/spec/outbox_job_spec.rb

@@ -0,0 +1,15 @@
+require 'rails_helper'
+
+module PupilfirstXapi
+  RSpec.describe Outbox::Job, type: :job do
+    let(:id)        { SecureRandom.uuid }
+    let(:timestamp) { Time.now }
+
+    it 'schedules new xapi statement push' do
+      payload = {actor_id: 123, resource_id: 456, id: id, timestamp: timestamp, event_type: 'any.event'}
+      expect {
+        Outbox << payload
+      }.to have_enqueued_job(Outbox::Job).with(payload)
+    end
+  end
+end

data/spec/outbox_spec.rb

@@ -0,0 +1,71 @@
+require 'spec_helper'
+
+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(:good_one)    { double(:timeline_event, target: target, passed?: true) }
+    let(:bad_one)     { double(:timeline_event, target: target, passed?: false) }
+
+    let(:data) {
+      {
+        course: { 456 => course },
+        timeline_event: {
+          456 => good_one,
+          123 => bad_one,
+        },
+        user: { 123 => john },
+      }
+    }
+    let(:repository) { ->(klass, resource_id) { data.dig(klass, resource_id) } }
+    let(:uri_for) do
+      ->(obj) do
+        case obj
+        when course
+          'rails-for-begginers'
+        when target
+          'target-1'
+        else
+          nil
+        end
+      end
+    end
+
+    it 'post xapi statements to provided lrs' do
+      [
+        [:course_completed, Verbs::COMPLETED, 'rails-for-begginers'],
+        [:student_added, Verbs::REGISTERED, 'rails-for-begginers'],
+        [:submission_graded, Verbs::COMPLETED_ASSIGNMENT, 'target-1'],
+        [:submission_automatically_verified, Verbs::COMPLETED_ASSIGNMENT, 'target-1'],
+      ].each do |event_type, expected_verb, expected_object_id|
+        lrs = FakeLrs.new
+        Outbox.new(lrs: lrs, repository: repository, uri_for: uri_for)
+          .call(actor_id: 123, resource_id: 456, timestamp: timestamp, event_type: event_type)
+        expect(lrs.statements.count).to eq(1)
+        xapi = lrs.statements.first
+        expect(xapi).to be_a Xapi::Statement
+        expect(xapi.id).to eq(nil)
+        expect(xapi.timestamp).to eq(timestamp)
+        expect_actor(xapi.actor, name: 'John Doe', email: 'john@doe.com')
+        expect(xapi.verb).to eq(expected_verb)
+        expect(xapi.object).to be_a Xapi::Activity
+        expect(xapi.object.id).to eq(expected_object_id)
+      end
+    end
+
+    it 'no-op when there is no xapi statement generated' do
+      [
+        :submission_graded,
+        :submission_automatically_verified,
+      ].each do |event_type|
+        lrs = FakeLrs.new
+        Outbox.new(lrs: lrs, repository: repository, uri_for: uri_for)
+          .call(actor_id: 123, resource_id: 123, timestamp: timestamp, event_type: event_type)
+        expect(lrs.statements.count).to eq(0)
+      end
+
+    end
+  end
+end

data/spec/rails_helper.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+ENV['RAILS_ENV'] ||= 'test'
+abort("The Rails environment is running in production mode!") if Rails.env.production?
+require 'rspec/rails'
+require 'webmock/rspec'
+WebMock.disable_net_connect!
+
+RSpec.configure do |config|
+  config.use_active_record = false
+  config.filter_rails_from_backtrace!
+end

data/spec/spec_helper.rb

@@ -0,0 +1,56 @@
+require_relative "../lib/pupilfirst_xapi"
+require 'dotenv'
+Dotenv.load('.env.test')
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+  config.disable_monkey_patching!
+  if config.files_to_run.one?
+    config.default_formatter = "doc"
+  end
+  config.order = :random
+  Kernel.srand config.seed
+
+  config.around(:each, type: :job) do |example|
+    ActiveJob::Base.queue_adapter = :test
+    example.run
+  ensure
+    ActiveJob::Base.queue_adapter.enqueued_jobs = []
+    ActiveJob::Base.queue_adapter.performed_jobs = []
+  end
+
+  config.around(:each, perform_jobs: true) do |example|
+    old_perform_enqueued_jobs = ActiveJob::Base.queue_adapter.perform_enqueued_jobs
+    old_perform_enqueued_at_jobs = ActiveJob::Base.queue_adapter.perform_enqueued_at_jobs
+    ActiveJob::Base.queue_adapter.perform_enqueued_jobs = true
+    ActiveJob::Base.queue_adapter.perform_enqueued_at_jobs = true
+    example.run
+  ensure
+    ActiveJob::Base.queue_adapter.perform_enqueued_jobs = old_perform_enqueued_jobs
+    ActiveJob::Base.queue_adapter.perform_enqueued_at_jobs = old_perform_enqueued_at_jobs
+  end
+end
+
+def expect_actor(xapi, name:, email:)
+  expect(xapi).to be_a Xapi::Agent
+  expect(xapi.mbox).to eq "mailto:#{email}"
+  expect(xapi.name).to eq name
+  expect(xapi.object_type).to eq 'Agent'
+end
+
+class FakeLrs
+  def initialize
+    @statements = []
+  end
+  attr_reader :statements
+
+  def save_statement(statement)
+    @statements << statement
+  end
+end

data/spec/statements/course_completed_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+module PupilfirstXapi
+  module Statements
+    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)
+        data = {
+          course: { 456 => course },
+          user: { 123 => john },
+        }
+        repository = ->(klass, resource_id) { data.dig(klass, resource_id) }
+        uri_for = ->(obj) { obj == course ? 'rails-for-begginers' : nil }
+
+        xapi = CourseCompleted.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/product'
+        expect(xapi.object.definition.name).to eq({'en-US' => 'Rails for Begginers'})
+        expect(xapi.object.definition.description).to eq({'en-US' => 'Seems easy'})
+      end
+    end
+  end
+end

data/spec/statements/course_redistered_spec.rb

@@ -0,0 +1,61 @@
+require 'spec_helper'
+
+module PupilfirstXapi
+  module Statements
+    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)
+        data = {
+          course: { 456 => course },
+          user: { 123 => john },
+        }
+        repository = ->(klass, resource_id) { data.dig(klass, resource_id) }
+        uri_for = ->(obj) { obj == course ? 'rails-for-begginers' : nil }
+
+        xapi = CourseRegistered.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::REGISTERED
+
+        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/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
+      end
+
+      it do
+        starts_at = 1.week.ago
+        ends_at   = 3.days.after
+        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)
+        data = {
+          course: { 456 => course },
+          user: { 123 => john },
+        }
+        repository = ->(klass, resource_id) { data.dig(klass, resource_id) }
+        uri_for = ->(obj) { obj == course ? 'rails-for-begginers' : nil }
+
+        xapi = CourseRegistered.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::REGISTERED
+
+        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/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})
+      end
+    end
+  end
+end

data/spec/statements/target_completed_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+
+module PupilfirstXapi
+  module Statements
+    RSpec.describe TargetCompleted do
+      it do
+        target = double(:target, title: '1st target', description: 'Seems easy')
+        submission = double(:timeline_event, target: target, passed?: true)
+        john   = double(:john, name: 'John Doe', email: 'john@doe.com')
+        data = {
+          timeline_event: { 456 => submission },
+          user: { 123 => john },
+        }
+        repository = ->(klass, resource_id) { data.dig(klass, resource_id) }
+        uri_for = ->(obj) { obj == target ? 'target-1' : nil }
+
+        xapi = TargetCompleted.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_ASSIGNMENT
+
+        expect(xapi.object).to be_a Xapi::Activity
+        expect(xapi.object.object_type).to eq 'Activity'
+        expect(xapi.object.id).to eq 'target-1'
+        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'})
+      end
+
+      it 'no-op when submission is not passed'  do
+        target = double(:target, title: '1st target', description: 'Seems easy')
+        submission = double(:timeline_event, target: target, passed?: false)
+        john   = double(:john, name: 'John Doe', email: 'john@doe.com')
+        data = {
+          timeline_event: { 456 => submission },
+          user: { 123 => john },
+        }
+        repository = ->(klass, resource_id) { data.dig(klass, resource_id) }
+        uri_for = ->(obj) { obj == target ? 'target-1' : nil }
+
+        xapi = TargetCompleted.new(repository, uri_for).call(actor_id: 123, resource_id: 456)
+        expect(xapi).to eq nil
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,156 @@
+--- !ruby/object:Gem::Specification
+name: pupilfirst_xapi
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- GrowthTribe
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-03-02 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
+  type: :runtime
+  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
+- !ruby/object:Gem::Dependency
+  name: growthtribe_xapi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.1
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: dotenv-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description:
+email:
+- devs@growthtribe.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- Rakefile
+- lib/pupilfirst_xapi.rb
+- lib/pupilfirst_xapi/actors.rb
+- lib/pupilfirst_xapi/objects.rb
+- lib/pupilfirst_xapi/objects/builder.rb
+- lib/pupilfirst_xapi/objects/course.rb
+- lib/pupilfirst_xapi/objects/target.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/verbs.rb
+- lib/pupilfirst_xapi/version.rb
+- 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/course_completed_spec.rb
+- spec/statements/course_redistered_spec.rb
+- spec/statements/target_completed_spec.rb
+homepage: https://github.com/growthtribeacademy/pupilfirst-xapi
+licenses:
+- GPL-3.0-or-later
+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:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.3
+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/course_completed_spec.rb
+- spec/statements/course_redistered_spec.rb
+- spec/statements/target_completed_spec.rb