ims_caliper 0.1.1

data/test/caliper/events/session_timeout_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 SessionTimeoutEventTest < 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::TIMEOUT
+
+		# 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

data/test/caliper/request/http_requestor_test.rb

@@ -0,0 +1,59 @@
+require_relative "../../../lib/caliper/request/http_requestor"
+require_relative "../../../lib/caliper/profiles/reading_profile"
+require_relative "../test_utils"
+require "test/unit"
+
+
+class HttpRequestorTest < Test::Unit::TestCase
+
+	attr_accessor :http_requestor,
+	              :id,
+	              :timestamp,
+	              :expected_content_type,
+	              :learning_context,
+	              :epub,
+	              :from_resource,
+	              :target,
+	              :action,
+	              :event
+
+	def setup
+		now = Time.now
+
+		options =TestUtils.get_testing_options
+		@http_requestor = Caliper::Request::HttpRequestor.new options
+
+		@id = "caliper-java_fccffd9b-68d5-4183-b563-e22136aafaa3"
+		@timestamp = now
+		@expected_content_type = "Content-Type: application/json"
+
+		# build the learning context
+		@learning_context = TestUtils.build_readium_learning_context
+
+		# Build epub
+		@epub = TestUtils.build_epub_volume_43
+
+		# build previous location
+		@from_resource = TestUtils.build_am_rev_101_landing_page
+
+		# build target
+		@target = TestUtils.build_epub_sub_chap_431
+
+		# action
+		@reading_profile = Caliper::Profiles::ReadingProfile.new
+
+		#action = reading_profile.get_action_from_bundle(reading_profile.actions.
+
+		p @learning_context.class
+
+		@event = TestUtils.build_epub_navigation_event @learning_context, @epub, @action, @fromResource, @target
+
+
+	end
+
+	def test_generate_payload_json()
+		json_payload = @http_requestor.generate_payload @event, @id, @timestamp
+		json_payload_fixture = JSON.parse(File.read(File.expand_path("../../", Dir.pwd) + "/fixtures/event_store_payload.json")).to_json
+		assert_equal("Test HTTP Requestor payload JSON",json_payload_fixture, "sss")
+	end
+end

data/test/caliper/test_event.rb

@@ -0,0 +1,53 @@
+
+require "../../lib/caliper/entities/learning_context"
+require "../../lib/caliper/entities/software_application"
+require "../../lib/caliper/entities/digital_resource"
+require "../../lib/caliper/entities/reading/epub_sub_chapter"
+require "../../lib/caliper/sensor"
+require_relative "test_utils"
+require "test/unit"
+
+class TestEvent < Test::Unit::TestCase
+	def test
+		test_utils = TestUtils.new
+		Caliper::Sensor.new(test_utils.test_options())
+
+		# Build the Learning Context
+		learningContext = TestUtils.buildReadiumLearningContext()
+
+		# Build epub
+		epub = TestUtils.buildEpubVolume43()
+
+		# Build previous location
+		from_resource = TestUtils.buildAmRev101LandingPage()
+
+		# Build target
+		target = TestUtils.buildEpubSubChap431()
+
+		# Action
+		action = ReadingProfile.getActionFromBundle(ReadingProfile.Actions.NAVIGATED_TO.key())
+
+		# Fire event test - Send 50 events
+		for i in 0..50
+			Sensor.send(TestUtils.buildEpubNavigationEvent(learningContext, epub, action, fromResource, target))
+		end
+
+		# There should be two caliperEvents queued
+		assertEquals("Expect fifty Caliper events to be sent", 50,
+		             Sensor.getStatistics().getMeasures().getCount())
+
+		# TODO - Describes test - Send five describes
+
+		# There should be four describes queued assertEquals("Expect five describes to be sent", 5,
+		# Caliper.getStatistics().getDescribes().getCount())
+
+		# There should be two message successfully sent
+		successes = Sensor.getStatistics().getSuccessful().getCount()
+		assertEquals("Expect fifty messages to be sent successfully", 50, successes);
+
+		# There should be zero failures
+		failures = Sensor.getStatistics().getFailed().getCount();
+		assertEquals("Expect zero message failures to be sent", 0, failures);
+	end
+
+end

data/test/caliper/test_utils.rb

@@ -0,0 +1,198 @@
+require "test/unit"
+require_relative '../../lib/caliper/options'
+require_relative '../../lib/caliper/entities/lis/course_section'
+require_relative '../../lib/caliper/entities/lis/person'
+require_relative '../../lib/caliper/entities/learning_context'
+require_relative '../../lib/caliper/entities/software_application'
+require_relative '../../lib/caliper/entities/session'
+require_relative '../../lib/caliper/entities/web_page'
+require_relative '../../lib/caliper/entities/reading/epub_volume'
+require_relative '../../lib/caliper/entities/reading/epub_sub_chapter'
+require_relative '../../lib/caliper/entities/schemadotorg/web_page'
+require_relative '../../lib/caliper/entities/reading/frame'
+require_relative '../../lib/caliper/event/navigation_event'
+require_relative '../../lib/caliper/event/session_event'
+
+require 'json'
+
+
+module TestUtils
+
+	def TestUtils.get_testing_options
+		options = Caliper::Options.new
+		options.host ="http://localhost:1080/1.0/event/put"
+		options.api_key = "6xp7jKrOSOWOgy3acxHFWA"
+		return options
+	end
+
+	def TestUtils.build_readium_learning_context
+
+		software_application = Caliper::Entities::SoftwareApplication.new
+		software_application.id = "https://github.com/readium/readium-js-viewer"
+		software_application.name = "Readium"
+		software_application.date_modified = Time.now
+
+		learning_context = Caliper::Entities::LearningContext.new
+		learning_context.ed_app = software_application
+		learning_context.lis_organization = build_am_rev_101_course_section
+		learning_context.agent = build_student_554433
+
+		return learning_context
+	end
+
+	def TestUtils.build_epub_volume_43
+		epub_volume = Caliper::Entities::Reading::EpubVolume.new
+		epub_volume.id = "https://github.com/readium/readium-js-viewer/book/34843#epubcfi(/4/3)"
+		epub_volume.name = "The Glorious Cause: The American Revolution, 1763-1789 (Oxford History of the United States)"
+		epub_volume.date_modified = Time.now
+
+		return epub_volume
+	end
+
+	# return Am Rev 101 course section.
+	def TestUtils.build_am_rev_101_course_section
+		course_section = Caliper::Entities::LIS::CourseSection.new
+		course_section.id = "https://some-university.edu/politicalScience/2014/american-revolution-101"
+		course_section.semester = "Spring-2014"
+		course_section.course_number = "AmRev-101"
+		course_section.label = "Am Rev 101"
+		course_section.name = "American Revolution 101"
+		course_section.date_modified = Time.now
+
+		return course_section
+	end
+
+	def TestUtils.build_student_554433
+		person = Caliper::Entities::LIS::Person.new
+		person.id = "https://some-university.edu/user/554433"
+		person.date_modified = Time.now
+
+		return person
+	end
+
+	def TestUtils.build_am_rev_101_landing_page
+			web_page = Caliper::Entities::WebPage.new
+			web_page.id = "AmRev-101-landingPage"
+			web_page.name ="American Revolution 101 Landing Page"
+			web_page.is_part_of = build_am_rev_101_course_section
+			web_page.date_modified = Time.now
+			return web_page
+	end
+
+	# sample EPUB sub chapter
+	def TestUtils.build_epub_sub_chap_431
+			epub_sub_chapter = Caliper::Entities::Reading::EpubSubChapter.new
+			epub_sub_chapter.id = "https://github.com/readium/readium-js-viewer/book/34843#epubcfi(/4/3/1)"
+			epub_sub_chapter.name = "Key Figures: George Washington"
+			epub_sub_chapter.is_part_of = build_epub_volume_43
+			epub_sub_chapter.date_modified = Time.now
+			return epub_sub_chapter
+	end
+
+	# return json object read from file
+	def TestUtils.read_fixture_json_file
+		json = File.read('fixtures/event_store_payload.json')
+		obj = JSON.parse(json)
+		return obj
+	end
+
+	def TestUtils.build_epub_navigation_event(learning_context, #LearningContext
+	                                epub,             #digial resource
+																	action_key,
+																	from_resource,
+																	target #EpubSubChapter
+																	)
+		navigation_event = Caliper::Event::NavigationEvent.new
+
+		raise ArgumentError, "build_epub_navigation_event first param should be of class LearningContext" unless learning_context.is_a? Caliper::Entities::LearningContext
+
+		navigation_event.ed_app = learning_context.ed_app
+		navigation_event.lis_organization = learning_context.lis_organization
+		navigation_event.actor = learning_context.agent
+		navigation_event.action = action_key
+		navigation_event.object = epub
+
+		frame = Caliper::Entities::Reading::Frame.new
+		frame.id = target.id
+		frame.name = target.name
+		frame.is_part_of = epub
+		frame.date_modified = 1402965614516
+		frame.index = 1
+		navigation_event.target = frame
+
+		navigation_event.from_resource = from_resource
+		navigation_event.started_at_time = 1402965614516
+
+		return navigation_event
+	end
+
+	# session start
+	def TestUtils.build_session_start
+		session = Caliper::Entities::Session.new
+		session.id = "https://github.com/readium/session-123456789"
+		session.name = "session-123456789"
+		session.actor = build_student_554433
+		session.date_modified = 1402965614516
+		session.started_at_time = 1402965614516
+		return session
+	end
+
+	#session send
+	def TestUtils.build_session_end
+		session = Caliper::Entities::Session.new
+		session.id = "https://github.com/readium/session-123456789"
+		session.name = "session-123456789"
+		session.actor = build_student_554433
+		session.date_modified = 1402965614516
+		session.started_at_time = 1402965614516
+		session.ended_at_time = 1402965614516
+		return session
+	end
+
+	def TestUtils.build_epub_login_event(learning_context, ed_app,action_key,target,generated)
+		# a frame object
+		frame = Caliper::Entities::Reading::Frame.new
+		frame.id = target.id
+		frame.name = target.name
+		frame.is_part_of = target.is_part_of
+		frame.date_modified = 1402965614516
+		frame.index = 1
+
+		session_event = Caliper::Event::SessionEvent.new
+		session_event.ed_app = learning_context.ed_app
+		session_event.lis_organization = learning_context.lis_organization
+		session_event.actor = learning_context.agent
+		session_event.action = action_key
+		session_event.object = ed_app
+		session_event.target = frame
+		session_event.generated = generated
+		session_event.started_at_time = 1402965614516
+
+		return session_event
+	end
+
+	def TestUtils.build_epub_logout_event(learning_context, ed_app, action_key, target)
+		session_event = Caliper::Event::SessionEvent.new
+		session_event.ed_app = learning_context.ed_app
+		session_event.lis_organization = learning_context.lis_organization
+		session_event.actor = learning_context.agent
+		session_event.action = action_key
+		session_event.object = ed_app
+		session_event.target = target
+		session_event.started_at_time = 1402965614516
+		session_event.ended_at_time = 1402965614516
+	end
+
+	def TestUtils.build_epub_timeout_event(learning_context, ed_app, action_key, target)
+		session_event = Caliper::Event::SessionEvent.new
+		session_event.ed_app = learning_context.ed_app
+		session_event.lis_organization = learning_context.lis_organization
+		session_event.actor = learning_context.agent
+		session_event.action = action_key
+		session_event.object = ed_app
+		session_event.target = target
+		session_event.started_at_time = 1402965614516
+		session_event.ended_at_time = 1402965614516
+	end
+
+end

data/test/fixtures/caliper_session_login_event.json

@@ -0,0 +1,71 @@
+{
+    "@context": "http://purl.imsglobal.org/ctx/caliper/v1/SessionEvent",
+    "@type": "http://purl.imsglobal.org/caliper/v1/SessionEvent",
+    "actor": {
+        "@id": "https://some-university.edu/user/554433",
+        "@type": "http://purl.imsglobal.org/caliper/v1/lis/Person",
+        "name": null,
+        "lastModifiedTime": 1402965614516
+    },
+    "action": "logged in",
+    "object": {
+        "@id": "https://github.com/readium/readium-js-viewer",
+        "@type":"http://purl.imsglobal.org/caliper/v1/SoftwareApplication",
+        "name": "Readium",
+        "lastModifiedTime": 1402965614516
+    },
+    "target": {
+        "@id": "https://github.com/readium/readium-js-viewer/book/34843#epubcfi(/4/3/1)",
+        "@type": "http://purl.imsglobal.org/caliper/v1/Frame",
+        "name": "Key Figures: George Washington",
+        "objectType": [],
+        "alignedLearningObjective": [],
+        "keyword": [],
+        "partOf": {
+            "@id": "https://github.com/readium/readium-js-viewer/book/34843#epubcfi(/4/3)",
+            "@type": "http://www.idpf.org/epub/vocab/structure/#volume",
+            "name": "The Glorious Cause: The American Revolution, 1763-1789 (Oxford History of the United States)",
+            "objectType": [],
+            "alignedLearningObjective": [],
+            "keyword": [],
+            "partOf": null,
+            "lastModifiedTime": 1402965614516
+        },
+        "lastModifiedTime": 1402965614516,
+        "index": 1
+    },
+    "generated": {
+        "@id": "https://github.com/readium/session-123456789",
+        "@type":"http://purl.imsglobal.org/caliper/v1/Session",
+        "name": "session-123456789",
+        "lastModifiedTime": 1402965614516,
+        "actor": {
+            "@id": "https://some-university.edu/user/554433",
+            "@type": "http://purl.imsglobal.org/caliper/v1/lis/Person",
+            "name": null,
+            "lastModifiedTime": 1402965614516
+        },
+        "startedAtTime": 1402965614516,
+        "endedAtTime": 0,
+        "duration": null
+    },
+    "startedAtTime": 1402965614516,
+    "endedAtTime": 0,
+    "duration": null,
+    "edApp": {
+        "@id": "https://github.com/readium/readium-js-viewer",
+        "@type":"http://purl.imsglobal.org/caliper/v1/SoftwareApplication",
+        "name": "Readium",
+        "lastModifiedTime": 1402965614516
+    },
+    "group": {
+        "@id": "https://some-university.edu/politicalScience/2014/american-revolution-101",
+        "@type": "http://purl.imsglobal.org/caliper/v1/lis/CourseSection",
+        "semester": "Spring-2014",
+        "courseNumber": "AmRev-101",
+        "label": "Am Rev 101",
+        "name": "American Revolution 101",
+        "parentOrg": null,
+        "lastModifiedTime": 1402965614516
+    }
+}

data/test/fixtures/caliper_session_logout_event.json

@@ -0,0 +1,52 @@
+{
+    "@context": "http://purl.imsglobal.org/ctx/caliper/v1/SessionEvent",
+    "@type": "http://purl.imsglobal.org/caliper/v1/SessionEvent",
+    "actor": {
+        "@id": "https://some-university.edu/user/554433",
+        "@type": "http://purl.imsglobal.org/caliper/v1/lis/Person",
+        "name": null,
+        "lastModifiedTime": 1402965614516
+    },
+    "action": "logged out",
+    "object": {
+        "@id": "https://github.com/readium/readium-js-viewer",
+        "@type":"http://purl.imsglobal.org/caliper/v1/SoftwareApplication",
+        "name": "Readium",
+        "lastModifiedTime": 1402965614516
+    },
+    "target": {
+        "@id": "https://github.com/readium/session-123456789",
+        "@type":"http://purl.imsglobal.org/caliper/v1/Session",
+        "name": "session-123456789",
+        "lastModifiedTime": 1402965614516,
+        "actor": {
+            "@id": "https://some-university.edu/user/554433",
+            "@type": "http://purl.imsglobal.org/caliper/v1/lis/Person",
+            "name": null,
+            "lastModifiedTime": 1402965614516
+        },
+        "startedAtTime": 1402965614516,
+        "endedAtTime": 1402965614516,
+        "duration": null
+    },
+    "generated": null,
+    "startedAtTime": 1402965614516,
+    "endedAtTime": 1402965614516,
+    "duration": null,
+    "edApp": {
+        "@id": "https://github.com/readium/readium-js-viewer",
+        "@type":"http://purl.imsglobal.org/caliper/v1/SoftwareApplication",
+        "name": "Readium",
+        "lastModifiedTime": 1402965614516
+    },
+    "group": {
+        "@id": "https://some-university.edu/politicalScience/2014/american-revolution-101",
+        "@type": "http://purl.imsglobal.org/caliper/v1/lis/CourseSection",
+        "semester": "Spring-2014",
+        "courseNumber": "AmRev-101",
+        "label": "Am Rev 101",
+        "name": "American Revolution 101",
+        "parentOrg": null,
+        "lastModifiedTime": 1402965614516
+    }
+}

data/test/fixtures/caliper_session_timeout_event.json

@@ -0,0 +1,52 @@
+{
+    "@context": "http://purl.imsglobal.org/ctx/caliper/v1/SessionEvent",
+    "@type": "http://purl.imsglobal.org/caliper/v1/SessionEvent",
+    "actor": {
+        "@id": "https://github.com/readium/readium-js-viewer",
+        "@type":"http://purl.imsglobal.org/caliper/v1/SoftwareApplication",
+        "name": "Readium",
+        "lastModifiedTime": 1402965614516
+    },
+    "action": "timed out",
+    "object": {
+        "@id": "https://github.com/readium/readium-js-viewer",
+        "@type":"http://purl.imsglobal.org/caliper/v1/SoftwareApplication",
+        "name": "Readium",
+        "lastModifiedTime": 1402965614516
+    },
+    "target": {
+        "@id": "https://github.com/readium/session-123456789",
+        "@type":"http://purl.imsglobal.org/caliper/v1/Session",
+        "name": "session-123456789",
+        "lastModifiedTime": 1402965614516,
+        "actor": {
+            "@id": "https://some-university.edu/user/554433",
+            "@type": "http://purl.imsglobal.org/caliper/v1/lis/Person",
+            "name": null,
+            "lastModifiedTime": 1402965614516
+        },
+        "startedAtTime": 1402965614516,
+        "endedAtTime": 1402965614516,
+        "duration": null
+    },
+    "generated": null,
+    "startedAtTime": 1402965614516,
+    "endedAtTime": 1402965614516,
+    "duration": null,
+    "edApp": {
+        "@id": "https://github.com/readium/readium-js-viewer",
+        "@type":"http://purl.imsglobal.org/caliper/v1/SoftwareApplication",
+        "name": "Readium",
+        "lastModifiedTime": 1402965614516
+    },
+    "group": {
+        "@id": "https://some-university.edu/politicalScience/2014/american-revolution-101",
+        "@type": "http://purl.imsglobal.org/caliper/v1/lis/CourseSection",
+        "semester": "Spring-2014",
+        "courseNumber": "AmRev-101",
+        "label": "Am Rev 101",
+        "name": "American Revolution 101",
+        "parentOrg": null,
+        "lastModifiedTime": 1402965614516
+    }
+}

data/test/fixtures/event_store_payload.json

@@ -0,0 +1,85 @@
+[{
+    "id"  : "caliper-java_fccffd9b-68d5-4183-b563-e22136aafaa3",
+    "type": "caliperEvent",
+    "time": "2014-07-01T14:29:29.858-04:00",
+    "data": {
+        "@context": "http://purl.imsglobal.org/ctx/caliper/v1/NavigationEvent",
+        "@type": "http://purl.imsglobal.org/caliper/v1/NavigationEvent",
+        "actor": {
+            "@id": "https://some-university.edu/user/554433",
+            "@type": "http://purl.imsglobal.org/caliper/v1/lis/Person",
+            "name": null,
+            "lastModifiedTime": 1402965614516
+        },
+        "action": "navigated to",
+        "object": {
+            "@id": "https://github.com/readium/readium-js-viewer/book/34843#epubcfi(/4/3)",
+            "@type": "http://www.idpf.org/epub/vocab/structure/#volume",
+            "name": "The Glorious Cause: The American Revolution, 1763-1789 (Oxford History of the United States)",
+            "objectType": [],
+            "alignedLearningObjective": [],
+            "keyword": [],
+            "partOf": null,
+            "lastModifiedTime": 1402965614516
+        },
+        "target": {
+            "@id": "https://github.com/readium/readium-js-viewer/book/34843#epubcfi(/4/3/1)",
+            "@type": "http://purl.imsglobal.org/caliper/v1/Frame",
+            "name": "Key Figures: George Washington",
+            "objectType": [],
+            "alignedLearningObjective": [],
+            "keyword": [],
+            "partOf": {
+                "@id": "https://github.com/readium/readium-js-viewer/book/34843#epubcfi(/4/3)",
+                "@type": "http://www.idpf.org/epub/vocab/structure/#volume",
+                "name": "The Glorious Cause: The American Revolution, 1763-1789 (Oxford History of the United States)",
+                "objectType": [],
+                "alignedLearningObjective": [],
+                "keyword": [],
+                "partOf": null,
+                "lastModifiedTime": 1402965614516
+            },
+            "lastModifiedTime": 1402965614516,
+            "index": 1
+        },
+        "generated": null,
+        "startedAtTime": 1402965614516,
+        "endedAtTime": 0,
+        "duration": null,
+        "edApp": {
+            "@id": "https://github.com/readium/readium-js-viewer",
+            "@type":"http://purl.imsglobal.org/caliper/v1/SoftwareApplication",
+            "name": "Readium",
+            "lastModifiedTime": 1402965614516
+        },
+        "group": {
+            "@id": "https://some-university.edu/politicalScience/2014/american-revolution-101",
+            "@type": "http://purl.imsglobal.org/caliper/v1/lis/CourseSection",
+            "semester": "Spring-2014",
+            "courseNumber": "AmRev-101",
+            "label": "Am Rev 101",
+            "name": "American Revolution 101",
+            "parentOrg": null,
+            "lastModifiedTime": 1402965614516
+        },
+        "navigatedFrom": {
+            "@id": "AmRev-101-landingPage",
+            "@type": "http://purl.imsglobal.org/caliper/v1/WebPage",
+            "name": "American Revolution 101 Landing Page",
+            "objectType": [],
+            "alignedLearningObjective": [],
+            "keyword": [],
+            "partOf": {
+                "@id": "https://some-university.edu/politicalScience/2014/american-revolution-101",
+                "@type": "http://purl.imsglobal.org/caliper/v1/lis/CourseSection",
+                "semester": "Spring-2014",
+                "courseNumber": "AmRev-101",
+                "label": "Am Rev 101",
+                "name": "American Revolution 101",
+                "parentOrg": null,
+                "lastModifiedTime": 1402965614516
+            },
+            "lastModifiedTime": 1402965614516
+        }
+    }
+}]