growthtribe_xapi 0.0.1

data/lib/xapi/team_analytics_query.rb

@@ -0,0 +1,36 @@
+# encoding: utf-8
+module Xapi
+  class TeamAnalyticsQuery
+
+    attr_accessor :version, :verb_id
+    attr_accessor :activity_id, :registration, :activity_type, :team_name, :agent_email
+
+    def initialize(&block)
+      self.version = TCAPIVersion::V101
+      if block_given?
+        block[self]
+      end
+    end
+
+    def verb_id=(value)
+      if value.is_a?(Verb)
+        @verb_id = value.id
+      else
+        @verb_id =value
+      end
+    end
+
+    def parameter_map
+      params = {}
+      params['verb'] = verb_id.to_s if verb_id
+      params['activity'] = activity_id.to_s if activity_id
+      params['registration'] = registration if registration
+      params['activity_type'] = activity_type if activity_type
+      params['team_name'] = team_name if team_name
+      params['agent_email'] = agent_email if agent_email
+
+      params
+    end
+
+  end
+end

data/lib/xapi/verb.rb

@@ -0,0 +1,35 @@
+# encoding: utf-8
+module Xapi
+  class Verb
+
+    attr_accessor :id, :display
+
+    def initialize(options={}, &block)
+      json = options.fetch(:json, nil)
+      if json
+        attributes = JSON.parse(json)
+        self.id = attributes['id'] if attributes['id']
+        self.display = attributes['display'] if attributes['display']
+      else
+        self.id = options.fetch(:id, nil)
+        self.display = options.fetch(:display, nil)
+
+        if block_given?
+          block[self]
+        end
+      end
+    end
+
+    def id=(value)
+      @id = value if value
+    end
+
+    def serialize(version)
+      node = {}
+      node['id'] = id.to_s if id
+      node['display'] = display if display
+      node
+    end
+
+  end
+end

data/lib/xapi/version.rb

@@ -0,0 +1,4 @@
+# encoding: utf-8
+module Xapi
+  VERSION = "0.0.1"
+end

data/spec/fixtures/about.json

@@ -0,0 +1,10 @@
+{
+  "extensions" : {
+    "http://id.Xapi.com/extension/powered-by" : {
+      "name" : "Tin Can Engine",
+      "homePage" : "http://Xapi.com/lrs-lms/lrs-for-lmss-home/",
+      "version" : "2012.1.0.8c644"
+    }
+  },
+  "version" : [ "0.9", "0.95", "1.0.1" ]
+}

data/spec/fixtures/statement.json

@@ -0,0 +1,33 @@
+{
+  "id": "06a6cbbb-b09c-4618-88a8-e8aa6884ad42",
+  "actor": {
+    "mbox": "mailto:tincanruby@Xapi.com",
+    "objectType": "Agent"
+  },
+  "verb": {
+    "id": "http://adlnet.gov/expapi/verbs/experienced",
+    "display": {
+      "en-GB": "experienced",
+      "en-US": "experienced"
+    }
+  },
+  "timestamp": "2015-03-27T13:14:42.081Z",
+  "stored": "2015-03-27T13:14:42.081Z",
+  "authority": {
+    "account": {
+      "homePage": "http://example.com/",
+      "name": "ABCDEFGHI"
+    },
+    "objectType": "Agent"
+  },
+  "version": "1.0.1",
+  "object": {
+    "id": "http://Xapi.com/TinCanRuby/Test/Unit/0",
+    "definition": {
+      "name": {"en-US": "TinCanJava Tests: Unit 0"},
+      "description": {"en-US": "Unit test 0 in the test suite for the Tin Can Ruby library."},
+      "type": "http://id.Xapi.com/activitytype/unit-test"
+    },
+    "objectType": "Activity"
+  }
+}

data/spec/spec_helper.rb

@@ -0,0 +1,107 @@
+require 'webmock/rspec'
+require 'securerandom'
+require 'growthtribe_xapi'
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
+
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end
+
+def fixture_path
+  File.expand_path("../fixtures", __FILE__)
+end
+
+def fixture(file)
+  File.new(File.join(fixture_path, '/', file))
+end

data/spec/support/helpers.rb

@@ -0,0 +1,60 @@
+module Helpers
+  def get_agent(name, type, value)
+    agent = Xapi::Agent.new(name: name)
+    case type
+      when :mbox
+        agent.mbox =  value
+      when :open_id
+        agent.open_id = value
+      when :mbox_sha1_sum
+        agent.mbox_sha1_sum = value
+      when :account
+        parts = value.split('|')
+        account = Xapi::AgentAccount.new(home_page: parts.first, name: parts.last)
+        agent.account = account
+    end
+    agent
+  end
+
+  def get_team(name, type, value)
+    agent = Xapi::Team.new(name: name)
+    case type
+      when :mbox
+        agent.mbox =  value
+      when :open_id
+        agent.open_id = value
+      when :mbox_sha1_sum
+        agent.mbox_sha1_sum = value
+      when :account
+        parts = value.split('|')
+        account = Xapi::AgentAccount.new(home_page: parts.first, name: parts.last)
+        agent.account = account
+    end
+    agent
+  end
+
+  def create_interaction_component(id, description)
+    component = Xapi::InteractionComponent.new
+    component.id = id
+    map = {}
+    map['en-US'] = description
+    component.description = map
+    [component]
+  end
+
+  def assert_serialize_and_deserialize(object)
+    Xapi::TCAPIVersion.values.each do |version|
+      assert_serialize_and_deserialize_for_version(object, version)
+    end
+  end
+
+  def assert_serialize_and_deserialize_for_version(object, version)
+    hash = object.serialize(version)
+    new_definition = object.class.new(json: hash.to_json)
+    expect(hash).to eq(new_definition.serialize(version))
+  end
+
+  def default_request_headers
+    {'Accept'=>'*/*', 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 'Authorization'=>'Basic dXNlcjpwYXNzd29yZA==', 'User-Agent'=>'Faraday v1.3.0', 'X-Experience-Api-Version'=>'1.0.1'}
+  end
+end

data/spec/xapi/activity_definition_spec.rb

@@ -0,0 +1,37 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe Xapi::ActivityDefinition do
+  include Helpers
+
+  it 'should serialize and deserialize' do
+    definition = Xapi::ActivityDefinition.new
+    definition.choices = create_interaction_component('choice1', 'Choice 1')
+    definition.correct_responses_pattern = ['correct_response']
+
+    map = {}
+    map['en-US'] = 'Activity Definition Description'
+    definition.description = map
+
+    extensions = {}
+    extensions['http://example.com/extensions'] = 'extensionValue'
+    definition.extensions = extensions
+
+    map = {}
+    map['en-US'] = 'Activity Definition'
+    definition.name = map
+
+    definition.scale = create_interaction_component('scale1', 'Scale 1')
+    definition.source = create_interaction_component('source1', 'Source 1')
+    definition.steps = create_interaction_component('steps1', 'Steps 1')
+    definition.target = create_interaction_component('target1', 'Target 1')
+
+    definition.type = 'http://adlnet.gov/expapi/activities/assessment'
+
+    Xapi::InteractionType.values.each do |type|
+      definition.interaction_type = type
+      assert_serialize_and_deserialize(definition)
+    end
+
+  end
+end

data/spec/xapi/activity_spec.rb

@@ -0,0 +1,23 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe Xapi::Activity do
+  include Helpers
+
+  it 'sets the object type' do
+    activity = Xapi::Activity.new
+    expect(activity.object_type).to eq('Activity')
+  end
+
+  it 'should serialize and deserialize' do
+    activity = Xapi::Activity.new
+    activity.id = 'http://example.com/activity'
+    definition = Xapi::ActivityDefinition.new
+    map = {}
+    map['en-US'] = 'Activity Definition'
+    definition.name = map
+    activity.definition = definition
+    assert_serialize_and_deserialize(activity)
+  end
+
+end

data/spec/xapi/agent_account_spec.rb

@@ -0,0 +1,13 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe Xapi::AgentAccount do
+  include Helpers
+
+  it 'should serialize and deserialize' do
+    account = Xapi::AgentAccount.new
+    account.homePage = 'http://example.com'
+    account.name = 'joeuser'
+    assert_serialize_and_deserialize(account)
+  end
+end

data/spec/xapi/agent_spec.rb

@@ -0,0 +1,24 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe Xapi::Agent do
+  include Helpers
+  it 'should serialize and deserialize' do
+    agent = Xapi::Agent.new
+    name = 'Joe User'
+    ids = {
+        mbox: 'mailto:joeuser@example.com',
+        open_id: 'http://openid.org/joeuser',
+        mbox_sha1_sum: 'b623062e19c5608ab0e1342e5011d48292ce00e3',
+        account: 'http://example.com|joeuser'
+    }
+    ids.each_pair do |key, value|
+      Xapi::TCAPIVersion.values.each do |version|
+        agent = get_agent(name, key, value)
+        hash = agent.serialize(version)
+        new_agent = Xapi::Agent.new(json: hash.to_json)
+        expect(hash).to eq(new_agent.serialize(version))
+      end
+    end
+  end
+end

data/spec/xapi/attachment_spec.rb

@@ -0,0 +1,26 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe Xapi::Attachment do
+  include Helpers
+
+  it 'should serialize and deserialize' do
+    attachment = Xapi::Attachment.new
+    attachment.content_type = 'text/plain'
+    map = {}
+    map['en-US'] = 'Some attachment'
+    attachment.display = map
+
+    map = {}
+    map['en-US'] = 'Some attachment description'
+    attachment.description = map
+
+    attachment.file_url = URI.parse('http://example.com/somefile')
+    attachment.length = 27
+    attachment.sha2 = '495395e777cd98da653df9615d09c0fd6bb2f8d4788394cd53c56a3bfdcd848a'
+    attachment.usage_type = Addressable::URI.parse('http://example.com/attachment-usage/test')
+
+    assert_serialize_and_deserialize(attachment)
+
+  end
+end

data/spec/xapi/context_activities_spec.rb

@@ -0,0 +1,57 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe Xapi::ContextActivities do
+  include Helpers
+
+  it 'should serialize and deserialize' do
+    context = Xapi::ContextActivities.new
+    activity = Xapi::Activity.new
+    activity.id = 'http://example.com/parent'
+    context.parent = [activity]
+
+    activity = Xapi::Activity.new
+    activity.id = 'http://example.com/grouping'
+    context.grouping = [activity]
+
+    activity = Xapi::Activity.new
+    activity.id = 'http://example.com/other'
+    context.other = [activity]
+
+    assert_serialize_and_deserialize(context)
+  end
+
+  # 'category' arrived in 1.0.0, so confirm it works in everything after that point, which is to say not 0.95
+  it 'should work with category in version 1.0.0 and later' do
+    context = Xapi::ContextActivities.new
+    activity = Xapi::Activity.new
+    activity.id = 'http://example.com/parent'
+    context.parent = [activity]
+
+    activity = Xapi::Activity.new
+    activity.id = 'http://example.com/grouping'
+    context.grouping = [activity]
+
+    activity = Xapi::Activity.new
+    activity.id = 'http://example.com/other'
+    context.other = [activity]
+
+    activity = Xapi::Activity.new
+    activity.id = 'http://example.com/category'
+    context.category = [activity]
+
+    assert_serialize_and_deserialize_for_version(context, Xapi::TCAPIVersion::V101)
+    assert_serialize_and_deserialize_for_version(context, Xapi::TCAPIVersion::V100)
+  end
+
+  # 'category' is not supported in 0.95, make sure it isn't
+  it 'should fail with category in version 0.95 and later' do
+    context = Xapi::ContextActivities.new
+
+    activity = Xapi::Activity.new
+    activity.id = 'http://example.com/category'
+    context.category = [activity]
+
+    expect{assert_serialize_and_deserialize_for_version(context, Xapi::TCAPIVersion::V095)}.to raise_error(Xapi::Errors::IncompatibleTCAPIVersion)
+  end
+end