ims_caliper 0.1.1 → 0.1.2

data/lib/caliper/entities/annotation/text_position_selector.rb

@@ -1,14 +0,0 @@
-
-# An Selector which describes a range of text based on its start and end positions
-# Defined by: http://www.w3.org/ns/oa#d4e667
-
-module Caliper
-  module Entities
-    module Annotation
-      class TextPositionSelector
-        attr_accessor :start,
-                      :end
-      end
-    end
-  end
-end

data/lib/caliper/entities/schemadotorg/audio_object.rb

@@ -1,15 +0,0 @@
-require_relative 'media_object'
-
-# https://schema.org/AudioObject
-#
-# An audio object embedded in a web page.
-
-module Caliper
-	module Entities
-		module SchemaDotOrg
-			module AudioObject
-				include MediaObject
-			end
-		end
-	end
-end

data/lib/caliper/entities/schemadotorg/image_object.rb

@@ -1,15 +0,0 @@
-require_relative 'media_object'
-
-# https://schema.org/ImageObject
-#
-# An image object embedded in a web page.
-
-module Caliper
-	module Entities
-		module SchemaDotOrg
-			module ImageObject
-				include MediaObject
-			end
-		end
-	end
-end

data/lib/caliper/entities/schemadotorg/media_object.rb

@@ -1,19 +0,0 @@
-require_relative 'creative_work'
-
-# An image, video, or audio object embedded in a web page. Note that a
-# creative work may have many media objects associated with it on the
-# same web page. For example, a page about a single song (MusicRecording)
-# may have a music video (VideoObject), and a high and low bandwidth audio
-# stream (2 AudioObject's).
-#
-# From https://schema.org/MediaObject
-
-module Caliper
-	module Entities
-		module SchemaDotOrg
-			module MediaObject
-				include CreativeWork
-			end
-		end
-	end
-end

data/lib/caliper/entities/schemadotorg/video_object.rb

@@ -1,15 +0,0 @@
-require_relative 'media_object'
-
-# https://schema.org/VideoObject
-#
-# A video object embedded in a web page..
-
-module Caliper
-	module Entities
-		module SchemaDotOrg
-			module VideoObject
-				include MediaObject
-			end
-		end
-	end
-end

data/spec/lib/client_spec.rb

@@ -1,35 +0,0 @@
-require "spec_helper.rb"
-
-module Caliper
-  describe Client do
-    it "should throw error if provided consumer is invalid" do
-      expect(lambda{ Client.new("some API key", :consumer => "ThisClassTotally::DoesntExist") }).to raise_error(NameError)
-      expect(lambda{ Client.new("some API key", :consumer => Object) }).to raise_error(ArgumentError)
-    end
-
-    it "should throw error if provided an invalid event" do
-      expect(lambda{ Client.new("some API key").measure(Object.new) }).to raise_error(ArgumentError)
-    end
-
-    it "should call the appropriate method on the consumer" do
-      consumer = Consumer::Base.new("some API key")
-      client = Client.new("some API key", :consumer => consumer)
-      consumer.expects(:measure)
-      consumer.expects(:describe)
-
-      client.measure(Event::Base.new)
-      client.describe(Entity::Base.new)
-    end
-
-    it "should default to current if timestamps are not provided" do
-      consumer = Consumer::Base.new("some API key")
-      client = Client.new("some API key", :consumer => consumer)
-      t = Time.now
-      Time.stubs(:now).returns(t)
-      consumer.expects(:measure).with(anything, anything, anything, t)
-      #todo same for describe
-      client.measure(Event::Base.new)
-    end
-
-  end
-end

data/spec/lib/consumer/base_spec.rb

@@ -1,28 +0,0 @@
-require 'spec_helper.rb'
-
-module Caliper
-  module Consumer
-    describe Base do
-      it "should validate options hash" do
-        b = Base.new("Some API key")
-        expect(b.validate_options({:debug= => true, :ssl => false, :on_error => lambda { "blah blah" }, :some_other_key => "This will be ignored"})).not_to include(:some_other_key)
-      end
-
-      it "should enable debug and ssl" do
-        b = Base.new("Some API key", :debug => true, :ssl => true)
-        expect(b.with_debug?).to be_truthy
-        expect(b.with_ssl?).to be_truthy
-      end
-
-      context "#on_error" do
-        it "should call custom error handler" do
-          Object.stubs(:non_existent_method).returns(true)
-          p = proc { |e| Object.non_existent_method }
-          Object.expects(:non_existent_method).once
-          b = Base.new("Some API key", :on_error => p)
-          b.on_error("Some error")
-        end
-      end
-    end
-  end
-end

data/spec/lib/consumer/queue_spec.rb

@@ -1,16 +0,0 @@
-require "spec_helper.rb"
-
-module Caliper
-  module Consumer
-    describe Queue do
-      it "should store max_queue_size and batch_size" do
-        max = 1000
-        batch = 100
-        c = Queue.new("some API key", :max_queue_size => max, :batch_size => batch)
-        expect(c.max_queue_size).to equal(max)
-        expect(c.batch_size).to equal(batch)
-      end
-    end
-  end
-end
-

data/spec/lib/event/annotation_spec.rb

@@ -1,12 +0,0 @@
-require "spec_helper.rb"
-require "caliper"
-
-module Caliper
-  module Event
-    describe Annotation do
-      it "should raise error if instantiated directly" do
-        expect(lambda{ Annotation.new("action") }).to raise_error NotImplementedError
-      end
-    end
-  end
-end

data/spec/lib/event/bookmarked_spec.rb

@@ -1,17 +0,0 @@
-require "spec_helper.rb"
-require "caliper"
-
-module Caliper
-  module Event
-    describe Bookmarked do
-      it "should be a BookmarkedEvent" do
-        expect(Bookmarked.new("action").type).to eq "BookmarkedEvent"
-      end
-
-      it "should have a 'marked' or 'unmarked' action, as appropriate" do
-        expect(Bookmarked.mark.action).to eq "marked"
-        expect(Bookmarked.unmark.action).to eq "unmarked"
-      end
-    end
-  end
-end

data/spec/lib/event/commented_spec.rb

@@ -1,19 +0,0 @@
-require "spec_helper.rb"
-require "caliper"
-
-module Caliper
-  module Event
-    describe Commented do
-      it "should be a CommentedEvent" do
-        expect(Commented.new("action").type).to eq "CommentedEvent"
-      end
-
-      it "should have 'commented', 'comment-updated', or 'uncommented' actions, as appropriate" do
-        expect(Commented.add_comment.action).to eq "commented"
-        expect(Commented.remove_comment.action).to eq "uncommented"
-        expect(Commented.update_comment.action).to eq "comment-updated"
-      end
-    end
-  end
-end
-

data/spec/lib/event/highlighted_spec.rb

@@ -1,18 +0,0 @@
-require "spec_helper.rb"
-require "caliper"
-
-module Caliper
-  module Event
-    describe Highlighted do
-      it "should be a HighlightedEvent" do
-        expect(Highlighted.new("action").type).to eq "HighlightedEvent"
-      end
-
-      it "should have a 'highlighted' or 'unhighlighted' action, as appropriate" do
-        expect(Highlighted.highlight.action).to eq "highlighted"
-        expect(Highlighted.unhighlight.action).to eq "unhighlighted"
-      end
-    end
-  end
-end
-

data/spec/lib/event/navigation_spec.rb

@@ -1,15 +0,0 @@
-require "spec_helper.rb"
-require "caliper"
-
-module Caliper
-  module Event
-    describe Navigation do
-      it "should be a NavigationEvent" do
-        e = Navigation.new
-        expect(e.type).to eq "NavigationEvent"
-        expect(e.action).to eq "navigatedTo"
-      end
-    end
-  end
-end
-

data/spec/lib/event/shared_spec.rb

@@ -1,18 +0,0 @@
-require "spec_helper.rb"
-require "caliper"
-
-module Caliper
-  module Event
-    describe Shared do
-      it "should be a SharedEvent" do
-        expect(Shared.new("action").type).to eq "SharedEvent"
-      end
-
-      it "should have a 'shared' or 'unshared' action, as appropriate" do
-        expect(Shared.share.action).to eq "shared"
-        expect(Shared.unshare.action).to eq "unshared"
-      end
-    end
-  end
-end
-

data/spec/lib/event/tagged_spec.rb

@@ -1,17 +0,0 @@
-require "spec_helper.rb"
-require "caliper"
-
-module Caliper
-  module Event
-    describe Tagged do
-      it "should be a TaggedEvent" do
-        expect(Tagged.new("action").type).to eq "TaggedEvent"
-      end
-
-      it "should have a 'tagged' or 'untagged' action, as appropriate" do
-        expect(Tagged.tag.action).to eq "tagged"
-        expect(Tagged.untag.action).to eq "untagged"
-      end
-    end
-  end
-end

data/spec/lib/event/used_spec.rb

@@ -1,15 +0,0 @@
-require "spec_helper.rb"
-require "caliper"
-
-module Caliper
-  module Event
-    describe Used do
-      it "should be a UsedEvent" do
-        e = Used.new
-        expect(e.type).to eq "UsedEvent"
-        expect(e.action).to eq "used"
-      end
-    end
-  end
-end
-

data/spec/lib/event/viewed_spec.rb

@@ -1,15 +0,0 @@
-require "spec_helper.rb"
-require "caliper"
-
-module Caliper
-  module Event
-    describe Viewed do
-      it "should be a ViewedEvent" do
-        e = Viewed.new
-        expect(e.type).to eq "ViewedEvent"
-        expect(e.action).to eq "viewed"
-      end
-    end
-  end
-end
-

data/test/caliper/events/session_login_event_test.rb

@@ -1,58 +0,0 @@
-
-require '../../../lib/caliper/entities/learning_context'
-require '../../../lib/caliper/entities/software_application'
-require '../../../lib/caliper/entities/reading/epub_sub_chapter'
-require '../../../lib/caliper/entities/session'
-require '../../../lib/caliper/event/event'
-
-require_relative "../../../lib/caliper/request/http_requestor"
-require_relative "../../../lib/caliper/profiles/session_profile"
-require_relative "../../../lib/caliper/profiles/reading_profile"
-require_relative "../test_utils"
-
-require 'i18n'
-require 'json'
-
-class SessionLoginEventTest < Test::Unit::TestCase
-	include I18n::Tests
-	include TestUtils
-
-	attr_accessor :learning_context, # LearningContext
-								:ed_app, # SoftwareApplication
-								:key, # String
-								:target, # EpubSubChapter
-								:generated, # Session
-								:event # Event
-
-	def setup
-
-		p  File.expand_path("../../", Dir.pwd) + '/config/locales/en.yml'
-		I18n.load_path = [[File.expand_path("../../..", Dir.pwd) + '/config/locales/en.yml']]
-		I18n.locale = :en
-		# I18n.t("actions.annotation.attached")
-
-		# Build the Learning Context
-		@learning_context = TestUtils.build_readium_learning_context
-
-		# Action
-		@ed_app = learning_context.ed_app
-
-		@key = Caliper::Profiles::SessionActions::LOGGED_IN
-
-		# build target
-		@target = TestUtils.build_epub_sub_chap_431
-
-		# build generated
-		@generated = TestUtils.build_session_start
-
-		# build event
-		@event = TestUtils.build_epub_login_event(@learning_context, @ed_app, @key, @target, @generated)
-
-	end
-
-	def test_caliper_event_serializes_to_json
-		json_payload_fixture = JSON.parse(File.read(File.expand_path("../../", Dir.pwd) + "/fixtures/caliper_session_login_event.json")).to_json
-		assert_equal("Test if loggedIn event is serialized to JSON with expected values",
-		             json_payload_fixture, @event.to_json)
-	end
-end

data/test/caliper/events/session_logout_event_test.rb

@@ -1,55 +0,0 @@
-
-require '../../../lib/caliper/entities/learning_context'
-require '../../../lib/caliper/entities/software_application'
-require '../../../lib/caliper/entities/reading/epub_sub_chapter'
-require '../../../lib/caliper/entities/session'
-require '../../../lib/caliper/event/event'
-
-require_relative "../../../lib/caliper/request/http_requestor"
-require_relative "../../../lib/caliper/profiles/session_profile"
-require_relative "../../../lib/caliper/profiles/reading_profile"
-require_relative "../test_utils"
-
-require 'i18n'
-require 'json'
-
-class SessionLogoutEventTest < Test::Unit::TestCase
-	include I18n::Tests
-	include TestUtils
-
-	attr_accessor :learning_context, # LearningContext
-								:ed_app, # SoftwareApplication
-								:key, # String
-								:target, # EpubSubChapter
-								:event # Event
-
-	def setup
-
-		p  File.expand_path("../../", Dir.pwd) + '/config/locales/en.yml'
-		I18n.load_path = [[File.expand_path("../../..", Dir.pwd) + '/config/locales/en.yml']]
-		I18n.locale = :en
-		# I18n.t("actions.annotation.attached")
-
-		# Build the Learning Context
-		@learning_context = TestUtils.build_readium_learning_context
-
-		# Action
-		@ed_app = learning_context.ed_app
-
-		# Action
-		@key = Caliper::Profiles::SessionActions::LOGGED_OUT
-
-		# build target
-		@target = TestUtils.build_session_end
-
-		# build event
-		@event = TestUtils.build_epub_logout_event(@learning_context, @ed_app, @key, @target)
-
-	end
-
-	def test_caliper_event_serializes_to_json
-		json_payload_fixture = JSON.parse(File.read(File.expand_path("../../", Dir.pwd) + "/fixtures/caliper_session_logout_event.json")).to_json
-		assert_equal("Test if loggedIn event is serialized to JSON with expected values",
-		             json_payload_fixture, @event.to_json)
-	end
-end