ims_caliper 0.1.1

data/lib/caliper/validators/session_login_event_validator.rb

@@ -0,0 +1,103 @@
+require_relative 'event_validator'
+require_relative 'error_message'
+require_relative 'property_type_check'
+require_relative 'time_check'
+require_relative '../event/event'
+require_relative '../profiles/profile'
+require_relative '../entities/lis/person'
+require_relative '../entities/digital_resource'
+require_relative '../entities/session'
+require_relative '../entities/schemadotorg/software_application'
+
+
+module Caliper
+	module Validators
+		class SessionLoginEventValidator
+			include EventValidator
+			include TimeCheck
+
+			## Validate session login event properties.
+	    # Properties
+	    # context:: required
+	    # type:: required
+	    # edApp:: optional
+	    # group:: optional
+	    # actor:: required: Person
+	    # action:: required: session.loggedIn
+	    # object:: required: SoftwareApplication
+	    # target:: required: DigitalResource
+	    # generated:: required: Session
+	    # startedAtTime:: required
+	    # endedAtTime:: optional: but should not be set.
+	    # duration:: optional: but should not be set.
+			# returns conformance violations message.
+			def validate(event)
+				context = "session"
+				error_message = ErrorMessage.new
+				property_check = PropertyTypeCheck.new
+
+
+				if (!event.is_a?(Event))
+					# check whether the argument is of right type
+					return
+				else
+					# is event context of Session
+					if (!event.context.equal?(EventType::SESSION))
+						error_message.append_text(event.context + " " + ProfileConformance::CONTEXT_ERROR)
+					end
+
+					# is event type of Session
+					if (!event.type.equal?(EventType::SESSION))
+						error_message.append_text(event.type + " " + ProfileConformance::TYPE_ERROR)
+					end
+
+					# is event actor a Person
+					if (!property_check.is_object_of_type(event.actor, Person.class))
+						error_message.append_text(event.actor.class + " " + ProfileConformance::ACTOR_NOT_PERSON)
+					end
+
+					# is event object a SoftwareApplication
+					if (!property_check.is_object_of_type(event.object, SoftwareApplication.class))
+						error_message.append_text(event.object.class + " " + ProfileConformance::OBJECT_NOT_SOFTWAREAPP)
+					end
+
+					# is event target a DigitalResource
+					if (!property_check.is_object_of_type(event.target, DigitalResource.class))
+						error_message.append_text(event.object.class + " " + ProfileConformance::TARGET_NOT_DIGITALRESOURCE)
+					end
+
+					if (property_check.is_object_of_type(event.generated, Session.class))
+						if (event.generated.started_at_time == 0)
+							error_message.append_text(context + " " + ProfileConformance::STARTEDATTIME_IS_NULL)
+						elsif (event.generated.end_at_time != 0)
+							error_message.append_text(context + " " + ProfileConformance::ENDEDATTIME_SET)
+						end
+					else
+						error_message.append_text(ProfileConformance::GENERATED_NOT_SESSION)
+					end
+
+					# start time set for event
+					if (!check_started_at_time(event.started_at_time))
+						error_message.append_text(ProfileConformance::STARTEDATTIME_IS_NULL)
+					end
+
+					# also check the event end time
+					if (!check_ended_at_time(event.started_at_time, event.ended_at_time))
+						error_message.append_text(ProfileConformance::TIME_ERROR)
+					end
+
+					# check duration value
+					if (check_duration(event.duration))
+						error_message.append_text(ProfileConformance::DURATION_INVALID)
+					end
+
+					if (error_message.length() > 0)
+						error_message.end_message("Caliper Session profile login event conformance: ")
+					end
+
+					return error_message.text
+				end
+			end
+		end
+	end
+end

data/lib/caliper/validators/session_logout_event_validator.rb

@@ -0,0 +1,102 @@
+require_relative 'event_validator'
+require_relative 'error_message'
+require_relative 'property_type_check'
+require_relative 'time_check'
+require_relative '../event/event'
+require_relative '../profiles/profile'
+require_relative '../entities/lis/person'
+require_relative '../entities/digital_resource'
+require_relative '../entities/session'
+require_relative '../entities/schemadotorg/software_application'
+
+
+module Caliper
+	module Validators
+		class SessionLogoutEventValidator
+			include EventValidator
+			include TimeCheck
+
+			Validate session logout event properties.
+				                              *
+			## Validate SessionEvent.
+			# An IllegalStateException will be thrown as a defensive measure if programing
+			# errors are encountered during object construction.
+			# Properties
+			# context:: required
+			# type:: required
+			# edApp:: optional
+			# group:: optional
+			# actor:: required: Person
+			# action:: required: session.loggedIn
+			# object:: required: SoftwareApplication
+			# target:: required: DigitalResource
+			# generated:: required: Session
+			# startedAtTime:: required
+			# endedAtTime:: optional: but should not be set.
+			# duration:: optional: but should not be set.
+			# returns conformance violations message.
+			def validate(event)
+				context = "session"
+				error_message = ErrorMessage.new
+				property_check = PropertyTypeCheck.new
+
+
+				if (!event.is_a?(Event))
+					# check whether the argument is of right type
+					return
+				else
+					# is event context of Session
+					if (!event.context.equal?(EventType::SESSION))
+						error_message.append_text(event.context + " " + ProfileConformance::CONTEXT_ERROR)
+					end
+
+					# is event type of Session
+					if (!event.type.equal?(EventType::SESSION))
+						error_message.append_text(event.type + " " + ProfileConformance::TYPE_ERROR)
+					end
+
+					# is event actor a Person
+					if (!property_check.is_object_of_type(event.actor, Person.class))
+						error_message.append_text(event.actor.class + " " + ProfileConformance::ACTOR_NOT_PERSON)
+					end
+
+					# is event object a SoftwareApplication
+					if (!property_check.is_object_of_type(event.object, SoftwareApplication.class))
+						error_message.append_text(event.object.class + " " + ProfileConformance::OBJECT_NOT_SOFTWAREAPP)
+					end
+
+					# is event target a DigitalResource
+					if (!property_check.is_object_of_type(event.target, Session.class))
+						error_message.append_text(event.object.class + " " + ProfileConformance::TARGET_NOT_SESSION)
+					end
+
+					# should not be generated
+					if (event.generated)
+						message.appendText(Profile.Conformance.GENERATED_NOT_NULL.violation());
+					end
+
+					# start time set for event
+					if (!check_started_at_time(event.started_at_time))
+						error_message.append_text(ProfileConformance::STARTEDATTIME_IS_NULL)
+					end
+
+					# also check the event end time
+					if (!check_ended_at_time(event.started_at_time, event.ended_at_time))
+						error_message.append_text(ProfileConformance::TIME_ERROR)
+					end
+
+					# check duration value
+					if (check_duration(event.duration))
+						error_message.append_text(ProfileConformance::DURATION_INVALID)
+					end
+
+					if (error_message.length > 0)
+						error_message.end_message("Caliper Session profile login event conformance: ")
+					end
+
+					return error_message.text
+				end
+			end
+		end
+	end
+end

data/lib/caliper/validators/time_check.rb

@@ -0,0 +1,30 @@
+module Caliper
+	module Validators
+		module TimeCheck
+
+			# validate startedAtTime
+			def check_started_at_time(started_at_time)
+				return started_at_time > 0
+			end
+
+			# Event ended_at_time is an optional setting.
+			# If both a started_at_time and ended_at_aime are specified
+			# check that startedAtTime precedes endedAtTime.  If not return false.
+			def check_ended_at_time(started_at_time, ended_at_time)
+				if (check_started_at_time(started_at_time))
+					return ended_at_time >= started_at_time
+				else
+					return true
+				end
+			end
+
+			def check_duration(duration)
+				if (!duration.nil? && !duration.length == 0)
+					return true
+				else
+					return false
+				end
+			end
+		end
+	end
+end

data/lib/caliper/version.rb

@@ -0,0 +1,4 @@
+module Caliper
+  VERSION = "0.1.1"
+end
+

data/lib/caliper.rb

@@ -0,0 +1,17 @@
+module Caliper
+  autoload :Client, "caliper/client"
+  
+  module Consumer
+    autoload :Base, "caliper/consumer/base"
+    autoload :Queue, "caliper/consumer/queue"
+    autoload :Socket, "caliper/consumer/socket"
+  end
+
+  module Event
+    autoload :Base, "caliper/event/base"
+  end
+
+  module Entities
+    autoload :Base, "caliper/entity/base"
+  end
+end

data/spec/lib/client_spec.rb

@@ -0,0 +1,35 @@
+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

@@ -0,0 +1,28 @@
+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

@@ -0,0 +1,16 @@
+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

@@ -0,0 +1,12 @@
+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

@@ -0,0 +1,17 @@
+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

@@ -0,0 +1,19 @@
+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

@@ -0,0 +1,18 @@
+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

@@ -0,0 +1,15 @@
+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

@@ -0,0 +1,18 @@
+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

@@ -0,0 +1,17 @@
+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

@@ -0,0 +1,15 @@
+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

@@ -0,0 +1,15 @@
+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/spec/spec_helper.rb

@@ -0,0 +1,26 @@
+require 'simplecov'
+require 'simplecov-rcov'
+require "caliper"
+
+SimpleCov.use_merging
+SimpleCov.merge_timeout(10000)
+SimpleCov.command_name('open_data_export_gem')
+SimpleCov.start('test_frameworks') do
+  SimpleCov.coverage_dir('../../coverage')
+  SimpleCov.at_exit {
+    SimpleCov.result
+  }
+end
+
+
+RSpec.configure do |config|
+  # ## Mock Framework
+  config.mock_with :mocha
+
+  # 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"
+end
+

data/test/caliper/events/session_login_event_test.rb

@@ -0,0 +1,58 @@
+
+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

@@ -0,0 +1,55 @@
+
+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