tin_can_api 0.0.1

data/spec/spec_helper.rb

@@ -0,0 +1,106 @@
+require 'webmock/rspec'
+require 'tin_can_api'
+# 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,43 @@
+module Helpers
+  def get_agent(name, type, value)
+    agent = TinCanApi::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 = TinCanApi::AgentAccount.new(home_page: parts.first, name: parts.last)
+        agent.account = account
+    end
+    agent
+  end
+
+  def create_interaction_component(id, description)
+    component = TinCanApi::InteractionComponent.new
+    component.id = id
+    map = {}
+    map['en-US'] = description
+    component.description = map
+    [component]
+  end
+
+  def assert_serialize_and_deserialize(object)
+    TinCanApi::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', 'User-Agent'=>'Faraday v0.9.1', 'X-Experience-Api-Version'=>'1.0.1'}
+  end
+end

data/spec/tin_can_api/activity_definition_spec.rb

@@ -0,0 +1,37 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe TinCanApi::ActivityDefinition do
+  include Helpers
+
+  it 'should serialize and deserialize' do
+    definition = TinCanApi::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'
+
+    TinCanApi::InteractionType.values.each do |type|
+      definition.interaction_type = type
+      assert_serialize_and_deserialize(definition)
+    end
+
+  end
+end

data/spec/tin_can_api/activity_spec.rb

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

data/spec/tin_can_api/agent_account_spec.rb

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

data/spec/tin_can_api/agent_spec.rb

@@ -0,0 +1,24 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe TinCanApi::Agent do
+  include Helpers
+  it 'should serialize and deserialize' do
+    agent = TinCanApi::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|
+      TinCanApi::TCAPIVersion.values.each do |version|
+        agent = get_agent(name, key, value)
+        hash = agent.serialize(version)
+        new_agent = TinCanApi::Agent.new(json: hash.to_json)
+        expect(hash).to eq(new_agent.serialize(version))
+      end
+    end
+  end
+end

data/spec/tin_can_api/attachment_spec.rb

@@ -0,0 +1,26 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe TinCanApi::Attachment do
+  include Helpers
+
+  it 'should serialize and deserialize' do
+    attachment = TinCanApi::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/tin_can_api/client_spec.rb

@@ -0,0 +1,44 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe TinCanApi::Client do
+  include Helpers
+
+  describe 'about' do
+    it 'is successful' do
+      stub_request(:get, "http://user:password@www.example.com/about").
+          with(headers: default_request_headers).
+          to_return(
+              status: 200,
+              body: fixture('about.json'),
+              headers: {})
+
+      client = TinCanApi::Client.new do |c|
+        c.end_point = 'http://www.example.com'
+        c.user_name = 'user'
+        c.password = 'password'
+      end
+
+      response = client.about
+      expect(response.success).to be(true)
+    end
+
+    it 'creates an about instance' do
+      stub_request(:get, "http://user:password@www.example.com/about").
+          with(headers: default_request_headers).
+          to_return(
+              status: 200,
+              body: fixture('about.json'),
+              headers: {})
+
+      client = TinCanApi::Client.new do |c|
+        c.end_point = 'http://www.example.com'
+        c.user_name = 'user'
+        c.password = 'password'
+      end
+
+      response = client.about
+      expect(response.content).to be_a(TinCanApi::About)
+    end
+  end
+end

data/spec/tin_can_api/context_activities_spec.rb

@@ -0,0 +1,57 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe TinCanApi::ContextActivities do
+  include Helpers
+
+  it 'should serialize and deserialize' do
+    context = TinCanApi::ContextActivities.new
+    activity = TinCanApi::Activity.new
+    activity.id = 'http://example.com/parent'
+    context.parent = [activity]
+
+    activity = TinCanApi::Activity.new
+    activity.id = 'http://example.com/grouping'
+    context.grouping = [activity]
+
+    activity = TinCanApi::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 = TinCanApi::ContextActivities.new
+    activity = TinCanApi::Activity.new
+    activity.id = 'http://example.com/parent'
+    context.parent = [activity]
+
+    activity = TinCanApi::Activity.new
+    activity.id = 'http://example.com/grouping'
+    context.grouping = [activity]
+
+    activity = TinCanApi::Activity.new
+    activity.id = 'http://example.com/other'
+    context.other = [activity]
+
+    activity = TinCanApi::Activity.new
+    activity.id = 'http://example.com/category'
+    context.category = [activity]
+
+    assert_serialize_and_deserialize_for_version(context, TinCanApi::TCAPIVersion::V101)
+    assert_serialize_and_deserialize_for_version(context, TinCanApi::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 = TinCanApi::ContextActivities.new
+
+    activity = TinCanApi::Activity.new
+    activity.id = 'http://example.com/category'
+    context.category = [activity]
+
+    expect{assert_serialize_and_deserialize_for_version(context, TinCanApi::TCAPIVersion::V095)}.to raise_error(TinCanApi::Errors::IncompatibleTCAPIVersion)
+  end
+end

data/spec/tin_can_api/context_spec.rb

@@ -0,0 +1,32 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe TinCanApi::Context do
+  include Helpers
+
+  it 'should serialize and deserialize' do
+    context = TinCanApi::Context.new
+    activities = TinCanApi::ContextActivities.new
+    activity = TinCanApi::Activity.new
+    activity.id = 'http://example.com/activity'
+    activities.parent = [activity]
+    context.context_activities = activities
+
+    map = {}
+    map['http://example.com/extension'] = 'extension value'
+    context.extensions = map
+
+    context.instructor = get_agent('Instructor', 'mbox', 'mailto:instructor@example.com')
+    context.language = 'en-US'
+    context.platform = 'iPhone 5'
+    context.registration = SecureRandom.uuid
+    context.revision = '1.2.3'
+    ref = TinCanApi::StatementRef.new
+    ref.id = SecureRandom.uuid
+    context.statement = ref
+    context.team = get_agent('Group', 'mbox', 'mailto:group@example.com')
+
+    assert_serialize_and_deserialize(context)
+  end
+
+end

data/spec/tin_can_api/group_spec.rb

@@ -0,0 +1,15 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe TinCanApi::Group do
+  include Helpers
+
+  it 'should serialize and deserialize' do
+    members = (1..10).map {|member| get_agent("Member #{member}", :mbox, "mailto:#{member}@example.com")}
+    group = TinCanApi::Group.new
+    group.name = 'Group'
+    group.mbox = 'mailto:group@example.com'
+    group.members = members
+    assert_serialize_and_deserialize(group)
+  end
+end

data/spec/tin_can_api/interaction_component_spec.rb

@@ -0,0 +1,18 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe TinCanApi::InteractionComponent do
+  include Helpers
+
+  it 'should serialize and deserialize' do
+    component = TinCanApi::InteractionComponent.new
+    component.id = 'choice1'
+
+    map = {}
+    map['en-US'] = 'Some choice'
+    component.description = map
+
+    assert_serialize_and_deserialize(component)
+  end
+
+end

data/spec/tin_can_api/result_spec.rb

@@ -0,0 +1,26 @@
+# encoding: utf-8
+require 'spec_helper'
+require 'ruby-duration'
+
+describe TinCanApi::Result do
+  include Helpers
+
+  it 'should serialize and deserialize' do
+    result = TinCanApi::Result.new
+    result.completion = true
+    result.duration = Duration.new('P1DT8H')
+
+    map = {}
+    map['http://example.com/extension'] = 'extension value'
+    result.extensions = map
+
+    result.response = "Here's a response"
+
+    score = TinCanApi::Score.new(raw: 0.43)
+    result.score = score
+    result.success = false
+
+    assert_serialize_and_deserialize(result)
+
+  end
+end

data/spec/tin_can_api/score_spec.rb

@@ -0,0 +1,12 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe TinCanApi::Score do
+  include Helpers
+
+  it 'should serialize and deserialize' do
+    score = TinCanApi::Score.new(max: 100.0, min: 0.0, raw: 80.0, scaled: 0.8)
+
+    assert_serialize_and_deserialize(score)
+  end
+end

data/spec/tin_can_api/statement_ref_spec.rb

@@ -0,0 +1,19 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe TinCanApi::StatementRef do
+  include Helpers
+
+  it 'sets the object type' do
+    ref = TinCanApi::StatementRef.new
+    expect(ref.object_type).to eq('StatementRef')
+  end
+
+  it 'should serialize and deserialize' do
+    ref = TinCanApi::StatementRef.new
+    ref.id = SecureRandom.uuid
+
+    assert_serialize_and_deserialize(ref)
+  end
+
+end

data/spec/tin_can_api/statement_spec.rb

@@ -0,0 +1,57 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe TinCanApi::Statement do
+  include Helpers
+
+  it 'should serialize and deserialize' do
+    targets = []
+    activity = TinCanApi::Activity.new
+    activity.id = 'http://example.com/activity'
+    targets << activity
+    targets << get_agent('Target', 'mbox', 'mailto:target@example.com')
+    ref = TinCanApi::StatementRef.new
+    ref.id = SecureRandom.uuid
+    targets << ref
+
+    sub = TinCanApi::SubStatement.new
+    sub.actor = get_agent('Sub', 'mbox', 'mailto:sub@example.com')
+    verb = TinCanApi::Verb.new
+    verb.id = 'http://example.com/verb'
+    sub.verb = verb
+    activity = TinCanApi::Activity.new
+    activity.id = 'http://example.com/sub-activity'
+    sub.object = activity
+    targets << sub
+
+    statement = TinCanApi::Statement.new
+    statement.actor = get_agent('Joe', 'mbox', 'mailto:joe@example.com')
+    attachment = TinCanApi::Attachment.new
+    attachment.sha2 = '123'
+    statement.attachments = [attachment]
+
+    statement.authority = get_agent('Authority', 'mbox', 'mailto:authority@example.com')
+
+    context = TinCanApi::Context.new
+    context.language = 'en-US'
+    statement.context = context
+
+    statement.id = SecureRandom.uuid
+
+    result = TinCanApi::Result.new
+    result.completion = true
+    statement.result = result
+
+    statement.stored = Time.now
+    statement.timestamp = Time.now
+
+    verb = TinCanApi::Verb.new
+    verb.id = 'http://example.com/verb'
+    statement.verb = verb
+
+    targets.each do |target|
+      statement.object = target
+      assert_serialize_and_deserialize(statement)
+    end
+  end
+end

data/spec/tin_can_api/sub_statement_spec.rb

@@ -0,0 +1,30 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe TinCanApi::SubStatement do
+  include Helpers
+
+  it 'should serialize and deserialize' do
+    statement = TinCanApi::SubStatement.new
+    statement.actor = get_agent('Joe', 'mbox', 'mailto:joe@example.com')
+    context = TinCanApi::Context.new
+    context.language = 'en-US'
+    statement.context = context
+
+    activity = TinCanApi::Activity.new
+    activity.id = 'http://example.com/activity'
+    statement.object = activity
+
+    result = TinCanApi::Result.new
+    result.completion = true
+    statement.result = result
+
+    statement.timestamp = Time.now
+
+    verb = TinCanApi::Verb.new
+    verb.id = 'http://example.com/verb'
+    statement.verb = verb
+
+    assert_serialize_and_deserialize(statement)
+  end
+end

data/spec/tin_can_api/verb_spec.rb

@@ -0,0 +1,17 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe TinCanApi::Verb do
+  include Helpers
+
+  it 'should serialize and deserialize' do
+    verb = TinCanApi::Verb.new
+    verb.id = 'http://example.com/attempted'
+    map = {}
+    map['en-US'] = 'attempted'
+    verb.display = map
+
+    assert_serialize_and_deserialize(verb)
+
+  end
+end

data/tin_can_api.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'tin_can_api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "tin_can_api"
+  spec.version       = TinCanApi::VERSION
+  spec.authors       = ["Paul Coleman"]
+  spec.email         = ["pcoleman@coleman.co.uk"]
+  spec.summary       = "A Ruby library for implementing Tin Can API."
+  spec.description   = %q{A Ruby library for interacting with a Learning Record Store (LRS) using the Tin Can API (Experience API)}
+  spec.homepage      = 'https://github.com/pwcoleman/TinCanRuby'
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.2'
+  spec.add_development_dependency 'pry', '~> 0.10'
+  spec.add_development_dependency 'webmock', '~> 1.20'
+
+  spec.add_runtime_dependency 'faraday', '~> 0.9'
+  spec.add_runtime_dependency 'addressable', '~> 2.3'
+  spec.add_runtime_dependency 'ruby-duration', '~> 3.2'
+end