ims_caliper 0.1.1 → 0.1.2

data/lib/caliper/request/event_store_requestor.rb

@@ -2,40 +2,40 @@ require 'securerandom'
 require_relative 'event_store_envelope'
 
 module Caliper
-	module Request
-		class EventStoreRequestor
+  module Request
+    class EventStoreRequestor
 
 
-			def get_payload_json(caliper_event, id, send_time)
+      def get_payload_json(caliper_event, id, send_time)
 
-			list_payload = Array.new
+        list_payload = Array.new
 
-			# new event envelope
-			envelope = EventStoreEnvelope.new
-			envelope.id = id
-			envelope.type = "caliperEvent"
-			envelope.time = send_time.to_s
-			envelope.data = caliper_event
+        # new event envelope
+        envelope = EventStoreEnvelope.new
+        envelope.id = id
+        envelope.type = "caliperEvent"
+        envelope.time = send_time.to_s
+        envelope.data = caliper_event
 
-			# add envelope into array
-			list_payload<< envelope
+        # add envelope into array
+        list_payload<< envelope
 
-			json_payload = JSON.generate(list_payload)
-				return json_payload
-			end
+        json_payload = JSON.generate(list_payload)
+        return json_payload
+      end
 
-			def generate_payload(caliper_event, id, send_time)
-				if (id.nil?)
-					id = "caliper-java_" + SecureRandom.uuid
-				end
+      def generate_payload(caliper_event, id, send_time)
+        if (id.nil?)
+          id = "caliper-java_" + SecureRandom.uuid
+        end
 
-				if (send_time.nil?)
-					send_time = Time.now
-				end
+        if (send_time.nil?)
+          send_time = Time.now
+        end
 
-				json_payload = get_payload_json(caliper_event, id, send_time)
+        json_payload = get_payload_json(caliper_event, id, send_time)
 
-			end
-		end
-	end
+      end
+    end
+  end
 end

data/lib/caliper/sensor.rb

@@ -1,37 +1,48 @@
-require_relative "client"
+require 'rest_client'
+require_relative "options"
+require_relative "event_envelope"
+require_relative "entity_envelope"
 
-## create
+##
+#
+#  @copyright @copyright ©2013 IMS Global Learning Consortium, Inc.  All Rights Reserved.
+#  @license For license information contact, info@imsglobal.org
+#
+# Caliper Sensor
+#
+#
 module Caliper
-	class Sensor
-		attr_accessor :default_client
-
-		# options to configure the behavior of Caliper client
-		def initialize(options)
-			@default_client=Client.new(options)
-		end
-
-		# Client initialization check
-		def is_initialized()
-			if default_client.nil?
-				# fail with RuntimeError
-				fail 'Caliper client is not initialized. Please call Caliper.initialize(..); before calling measure or describe'
-			end
-		end
-
-		# Describe a Entity that is part of the learning graph
-		def describe(entity)
-			is_initialized()
-			@default_client.describe(entity)
-		end
-
-		def send(event)
-			is_initialized()
-			@default_client.describe(event)
-		end
-
-		def get_statistics()
-			is_initialized()
-			@default_client.getStatistics()
-		end
-	end
-end
+
+  class Sensor
+
+    def initialize(options)
+      @options = options
+      puts "Sensor - initializing with options = #{@options}"
+    end
+
+    def send(event)
+      raise ArgumentError, "Expecting Caliper::Event but got #{event.class.to_s}" unless event.is_a?(Caliper::Event::Event)
+
+      envelope = EventEnvelope.new
+      envelope.apiKey = @options['apiKey']
+      envelope.sensorId = @options['sensorId']
+      envelope.event = event
+
+      RestClient.post @options['host'], envelope.to_json, :content_type => :json, :accept => :json
+
+    end
+
+    def describe(entity)
+      raise ArgumentError, "Expecting Caliper::Entity but got #{entity.class.to_s}" unless entity.is_a?(Caliper::Entities::Entity)
+
+      envelope = EntityEnvelope.new
+      envelope.apiKey = @options['apiKey']
+      envelope.sensorId = @options['sensorId']
+      envelope.entity = entity
+
+      RestClient.post @options['host'], envelope.to_json, :content_type => :json, :accept => :json
+
+    end
+
+  end
+end

data/lib/caliper/version.rb

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

data/spec/lib/entities/entity.json

@@ -0,0 +1,9 @@
+{
+  "@id": "https://some-university.edu/politicalScience/2014/american-revolution-101/assessment1",
+  "@type": "http://purl.imsglobal.org/caliper/v1/Entity",
+  "name": "test",
+  "description": "description",
+  "extensions": {"customProp":42},
+  "dateCreated": "2015-03-15T23:09:11.000Z",
+  "dateModified": "2015-03-15T23:09:11.000Z"
+}

data/spec/lib/entities/entity_spec.rb

@@ -0,0 +1,37 @@
+# require 'spec_helper.rb'
+require 'require_all'
+require 'json_spec'
+require_all 'lib/caliper/entities/entity.rb'
+
+module Caliper
+  module Entities
+
+    describe Entity do
+
+      it "should ensure that a base entity is correctly created and serialized" do
+        entity = Entity.new
+        entity.name = 'test'
+        entity.description = 'description'
+        entity.id = 'https://some-university.edu/politicalScience/2014/american-revolution-101/assessment1'
+        entity.extensions = {'customProp' => 42}
+        entity.dateCreated = '2015-03-15T23:09:11.000Z'
+        entity.dateModified = '2015-03-15T23:09:11.000Z'
+        # puts "Entity JSON = #{entity.to_json}"
+
+        # Compare JSON ouput
+        file = File.read('spec/lib/entities/entity.json')
+        data_hash = JSON.parse(file)
+        expected_json = data_hash.to_json # convert hash back to JSON string after parse
+        entity.to_json.should be_json_eql(expected_json)#.excluding("@class")
+
+        # Compare Deserialized JSON to desired Entity
+        des_entity = Entity.new
+        des_entity.from_json data_hash
+        # puts "Object from JSON = #{des_entity.to_json}"
+        expect(entity).to eql(des_entity)
+
+      end
+
+    end
+  end
+end

data/spec/lib/entities/lis/person_spec.rb

@@ -0,0 +1,37 @@
+# require 'spec_helper.rb'
+require 'require_all'
+require_all 'lib/caliper/entities/*.rb'
+require_all 'lib/caliper/entities/lis/*.rb'
+
+module Caliper
+  module Entities
+    module LIS
+      describe Person do
+
+        it "should ensure that a Person is correctly created and serialized" do
+          student = Person.new
+          student.id = 'https://some-university.edu/students/dent_stu'
+          student.name = 'Stu Dent'
+          student.description = 'A super bright individual'
+          student.extensions = {'customProp' => 42}
+          student.dateCreated = '2015-03-15T23:09:11.000Z'
+          student.dateModified = '2015-03-15T23:09:11.000Z'
+          # puts "new student = #{student.to_json}"
+
+          # Compare JSON ouput
+          file = File.read('spec/lib/entities/lis/student.json')
+          data_hash = JSON.parse(file)
+          expected_json = data_hash.to_json # convert hash back to JSON string after parse
+          student.to_json.should be_json_eql(expected_json)
+
+          des_student = Person.new
+          des_student.from_json data_hash
+          # puts "Object from JSON = #{des_student.to_json}"
+
+          expect(student).to eql(des_student)
+        end
+
+      end
+    end
+  end
+end

data/spec/lib/entities/lis/student.json

@@ -0,0 +1,11 @@
+{
+  "@id": "https://some-university.edu/students/dent_stu",
+  "@type": "http://purl.imsglobal.org/caliper/v1/lis/Person",
+  "name": "Stu Dent",
+  "description": "A super bright individual",
+  "extensions": {
+    "customProp": 42
+  },
+  "dateCreated": "2015-03-15T23:09:11.000Z",
+  "dateModified": "2015-03-15T23:09:11.000Z"
+}

data/spec/lib/event/annotation_event_bookmark_spec.rb

@@ -0,0 +1,159 @@
+require 'require_all'
+require_all 'lib/caliper/entities/entity.rb'
+require_all 'lib/caliper/entities/software_application.rb'
+require_all 'lib/caliper/entities/lis/person.rb'
+require_all 'lib/caliper/entities/lis/membership.rb'
+require_all 'lib/caliper/entities/lis/roles.rb'
+require_all 'lib/caliper/entities/lis/status.rb'
+require_all 'lib/caliper/entities/lis/course_section.rb'
+require_all 'lib/caliper/entities/lis/course_offering.rb'
+require_all 'lib/caliper/entities/lis/group.rb'
+require_all 'lib/caliper/entities/reading/epub_volume.rb'
+require_all 'lib/caliper/entities/annotation/bookmark_annotation.rb'
+require_all 'lib/caliper/event/annotation_event.rb'
+require_all 'lib/caliper/profiles/annotation_profile.rb'
+require 'json_spec'
+
+module Caliper
+  module Event
+
+    describe AnnotationEvent do
+
+      it 'should ensure that a AnnotationEvent (Bookmarked) is correctly created and serialized' do
+
+        # The Actor (Person/Student))
+        student = Caliper::Entities::LIS::Person.new
+        student.id = 'https://some-university.edu/user/554433'
+        membership1 = Caliper::Entities::LIS::Membership.new
+        membership1.id = "https://some-university.edu/membership/001"
+        membership1.member = "https://some-university.edu/user/554433"
+        membership1.organization = "https://some-university.edu/politicalScience/2015/american-revolution-101"
+        membership1.roles = [Caliper::Entities::LIS::Roles::LEARNER]
+        membership1.status = Caliper::Entities::LIS::Status::ACTIVE
+        membership1.dateCreated = "2015-08-01T06:00:00.000Z"
+        membership1.dateModified = nil;
+        membership2 = Caliper::Entities::LIS::Membership.new
+        membership2.id = "https://some-university.edu/membership/002"
+        membership2.member = "https://some-university.edu/user/554433"
+        membership2.organization = "https://some-university.edu/politicalScience/2015/american-revolution-101/section/001"
+        membership2.roles = [Caliper::Entities::LIS::Roles::LEARNER]
+        membership2.status = Caliper::Entities::LIS::Status::ACTIVE
+        membership2.dateCreated = "2015-08-01T06:00:00.000Z"
+        membership2.dateModified = nil
+        membership3 = Caliper::Entities::LIS::Membership.new
+        membership3.id = "https://some-university.edu/membership/003"
+        membership3.member = "https://some-university.edu/user/554433"
+        membership3.organization = "https://some-university.edu/politicalScience/2015/american-revolution-101/section/001/group/001"
+        membership3.roles = [Caliper::Entities::LIS::Roles::LEARNER]
+        membership3.status = Caliper::Entities::LIS::Status::ACTIVE
+        membership3.dateCreated = "2015-08-01T06:00:00.000Z"
+        membership3.dateModified = nil
+        student.hasMembership = [membership1, membership2, membership3]
+        student.dateCreated = '2015-08-01T06:00:00.000Z'
+        student.dateModified = '2015-09-02T11:30:00.000Z'
+        # puts "new student = #{student.to_json}"
+
+        # The Action
+        action = Caliper::Profiles::AnnotationActions::BOOKMARKED
+
+        # The Object of the bookmark (Frame)
+        ePubVolume = Caliper::Entities::Reading::EPubVolume.new
+        ePubVolume.id = 'https://github.com/readium/readium-js-viewer/book/34843#epubcfi(/4/3)'
+        ePubVolume.name = 'The Glorious Cause: The American Revolution, 1763-1789 (Oxford History of the United States)'
+        ePubVolume.version = '2nd ed.'
+        ePubVolume.dateCreated = '2015-08-01T06:00:00.000Z'
+        ePubVolume.dateModified = '2015-09-02T11:30:00.000Z'
+
+        frame = Caliper::Entities::Reading::Frame.new
+        frame.id = 'https://github.com/readium/readium-js-viewer/book/34843#epubcfi(/4/3/2)'
+        frame.name = 'Key Figures: Lord North'
+        frame.version = '2nd ed.'
+        frame.dateCreated = '2015-08-01T06:00:00.000Z'
+        frame.dateModified = '2015-09-02T11:30:00.000Z'
+        frame.index = 2
+        frame.isPartOf = ePubVolume.id
+
+        # The Generated (Annotation::BookmarkAnnotation)
+        bookmark = Caliper::Entities::Annotation::BookmarkAnnotation.new
+        bookmark.id = 'https://someEduApp.edu/bookmarks/00001'
+        bookmark.name = nil
+        bookmark.description = nil
+        bookmark.dateCreated = '2015-08-01T06:00:00.000Z'
+        bookmark.dateModified = '2015-09-02T11:30:00.000Z'
+        bookmark.annotated = 'https://github.com/readium/readium-js-viewer/book/34843#epubcfi(/4/3/2)'
+        bookmark.bookmarkNotes = 'The Intolerable Acts (1774)--bad idea Lord North'
+
+        # The course that is part of the Learning Context (edApp)
+        edApp = Caliper::Entities::SoftwareApplication.new
+        edApp.id = 'https://github.com/readium/readium-js-viewer'
+        edApp.name = 'Readium'
+        edApp.hasMembership = []
+        edApp.dateCreated = '2015-08-01T06:00:00.000Z'
+        edApp.dateModified = '2015-09-02T11:30:00.000Z'
+
+        #LIS Course Offering
+        courseOffering = Caliper::Entities::LIS::CourseOffering.new
+        courseOffering.id = "https://some-university.edu/politicalScience/2015/american-revolution-101"
+        courseOffering.name = "Political Science 101: The American Revolution"
+        courseOffering.courseNumber = "POL101"
+        courseOffering.academicSession = "Fall-2015"
+        courseOffering.membership = []
+        courseOffering.subOrganizationOf = nil
+        courseOffering.dateCreated = '2015-08-01T06:00:00.000Z'
+        courseOffering.dateModified = '2015-09-02T11:30:00.000Z'
+        
+        # The LIS Course Section for the Caliper Event
+        course = Caliper::Entities::LIS::CourseSection.new
+        course.id = 'https://some-university.edu/politicalScience/2015/american-revolution-101/section/001'
+        course.name = 'American Revolution 101'
+        course.courseNumber = "POL101"
+        course.academicSession = "Fall-2015"
+        course.category = nil
+        course.membership = [membership2]
+        course.subOrganizationOf = courseOffering
+        course.dateCreated = '2015-08-01T06:00:00.000Z'
+        course.dateModified = '2015-09-02T11:30:00.000Z'
+
+        # LIS Group
+        group = Caliper::Entities::LIS::Group.new
+        group.id = "https://some-university.edu/politicalScience/2015/american-revolution-101/section/001/group/001"
+        group.name = "Discussion Group 001"
+        group.membership = [membership3]
+        group.subOrganizationOf = course
+        group.dateCreated = '2015-08-01T06:00:00.000Z'
+        group.dateModified = nil
+
+        # The (Annotation::BookmarkAnnotation) Event
+        annotation_event = AnnotationEvent.new
+        annotation_event.actor  = student
+        annotation_event.action = action
+        annotation_event.object = frame
+        annotation_event.target = nil
+        annotation_event.generated = bookmark
+        annotation_event.edApp  = edApp
+        annotation_event.group = group
+        annotation_event.startedAtTime = '2015-09-15T10:15:00.000Z'
+        annotation_event.endedAtTime = nil
+        annotation_event.duration = nil
+        # puts "Event JSON = #{annotation_event.to_json}'"
+
+        # Load JSON from caliper-common-fixtures for comparison
+        # NOTE - sym link to caliper-common-fixtures needs to exist under spec/fixtures
+        file = File.read('spec/fixtures/caliperBookmarkAnnotationEvent.json')
+        data_hash = JSON.parse(file)
+        expected_json = data_hash.to_json # convert hash back to JSON string after parse
+        annotation_event.to_json.should be_json_eql(expected_json)#.excluding("actor", "action", "object", "target", "generated", "edApp", "group")
+
+        # puts "JSON from file = #{data_hash}"
+        deser_annotation_event = AnnotationEvent.new
+        deser_annotation_event.from_json data_hash
+        # puts "AnnotationEvent from JSON = #{deser_annotation_event.to_json}"
+
+        # Ensure that the deserialized bookmark event object conforms
+        expect(annotation_event).to eql(deser_annotation_event)
+
+      end
+
+    end
+  end
+end

data/spec/lib/event/annotation_event_highlight_spec.rb

@@ -0,0 +1,160 @@
+require 'require_all'
+require_all 'lib/caliper/entities/entity.rb'
+require_all 'lib/caliper/entities/software_application.rb'
+require_all 'lib/caliper/entities/lis/person.rb'
+require_all 'lib/caliper/entities/lis/membership.rb'
+require_all 'lib/caliper/entities/lis/roles.rb'
+require_all 'lib/caliper/entities/lis/status.rb'
+require_all 'lib/caliper/entities/lis/course_section.rb'
+require_all 'lib/caliper/entities/lis/course_offering.rb'
+require_all 'lib/caliper/entities/lis/group.rb'
+require_all 'lib/caliper/entities/reading/epub_volume.rb'
+require_all 'lib/caliper/entities/annotation/highlight_annotation.rb'
+require_all 'lib/caliper/event/annotation_event.rb'
+require_all 'lib/caliper/profiles/annotation_profile.rb'
+require 'json_spec'
+
+module Caliper
+  module Event
+
+    describe AnnotationEvent do
+
+      it 'should ensure that a AnnotationEvent (Highlight) is correctly created and serialized' do
+
+        # The Actor (Person/Student))
+        student = Caliper::Entities::LIS::Person.new
+        student.id = 'https://some-university.edu/user/554433'
+        membership1 = Caliper::Entities::LIS::Membership.new
+        membership1.id = "https://some-university.edu/membership/001"
+        membership1.member = "https://some-university.edu/user/554433"
+        membership1.organization = "https://some-university.edu/politicalScience/2015/american-revolution-101"
+        membership1.roles = [Caliper::Entities::LIS::Roles::LEARNER]
+        membership1.status = Caliper::Entities::LIS::Status::ACTIVE
+        membership1.dateCreated = "2015-08-01T06:00:00.000Z"
+        membership1.dateModified = nil;
+        membership2 = Caliper::Entities::LIS::Membership.new
+        membership2.id = "https://some-university.edu/membership/002"
+        membership2.member = "https://some-university.edu/user/554433"
+        membership2.organization = "https://some-university.edu/politicalScience/2015/american-revolution-101/section/001"
+        membership2.roles = [Caliper::Entities::LIS::Roles::LEARNER]
+        membership2.status = Caliper::Entities::LIS::Status::ACTIVE
+        membership2.dateCreated = "2015-08-01T06:00:00.000Z"
+        membership2.dateModified = nil
+        membership3 = Caliper::Entities::LIS::Membership.new
+        membership3.id = "https://some-university.edu/membership/003"
+        membership3.member = "https://some-university.edu/user/554433"
+        membership3.organization = "https://some-university.edu/politicalScience/2015/american-revolution-101/section/001/group/001"
+        membership3.roles = [Caliper::Entities::LIS::Roles::LEARNER]
+        membership3.status = Caliper::Entities::LIS::Status::ACTIVE
+        membership3.dateCreated = "2015-08-01T06:00:00.000Z"
+        membership3.dateModified = nil
+        student.hasMembership = [membership1, membership2, membership3]
+        student.dateCreated = '2015-08-01T06:00:00.000Z'
+        student.dateModified = '2015-09-02T11:30:00.000Z'
+        # puts "new student = #{student.to_json}"
+
+        # The Action
+        action = Caliper::Profiles::AnnotationActions::HIGHLIGHTED
+
+        # The Object of the highlight (Frame)
+        ePubVolume = Caliper::Entities::Reading::EPubVolume.new
+        ePubVolume.id = 'https://github.com/readium/readium-js-viewer/book/34843#epubcfi(/4/3)'
+        ePubVolume.name = 'The Glorious Cause: The American Revolution, 1763-1789 (Oxford History of the United States)'
+        ePubVolume.version = '2nd ed.'
+        ePubVolume.dateCreated = '2015-08-01T06:00:00.000Z'
+        ePubVolume.dateModified = '2015-09-02T11:30:00.000Z'
+
+        frame = Caliper::Entities::Reading::Frame.new
+        frame.id = 'https://github.com/readium/readium-js-viewer/book/34843#epubcfi(/4/3/1)'
+        frame.name = 'Key Figures: George Washington'
+        frame.version = '2nd ed.'
+        frame.dateCreated = '2015-08-01T06:00:00.000Z'
+        frame.dateModified = '2015-09-02T11:30:00.000Z'
+        frame.index = 1
+        frame.isPartOf = ePubVolume.id
+
+        # The Generated (Annotation::BookmarkAnnotation)
+        highlight = Caliper::Entities::Annotation::HighlightAnnotation.new
+        highlight.id = 'https://someEduApp.edu/highlights/12345'
+        highlight.name = nil
+        highlight.description = nil
+        highlight.dateCreated = '2015-08-01T06:00:00.000Z'
+        highlight.dateModified = '2015-09-02T11:30:00.000Z'
+        highlight.annotated = 'https://github.com/readium/readium-js-viewer/book/34843#epubcfi(/4/3/1)'
+        highlight.selectionText = 'Life, Liberty and the pursuit of Happiness'
+        highlight.selection = { 'start' => '455', 'end' => '489'}
+
+        # The course that is part of the Learning Context (edApp)
+        edApp = Caliper::Entities::SoftwareApplication.new
+        edApp.id = 'https://github.com/readium/readium-js-viewer'
+        edApp.name = 'Readium'
+        edApp.hasMembership = []
+        edApp.dateCreated = '2015-08-01T06:00:00.000Z'
+        edApp.dateModified = '2015-09-02T11:30:00.000Z'
+
+        #LIS Course Offering
+        courseOffering = Caliper::Entities::LIS::CourseOffering.new
+        courseOffering.id = "https://some-university.edu/politicalScience/2015/american-revolution-101"
+        courseOffering.name = "Political Science 101: The American Revolution"
+        courseOffering.courseNumber = "POL101"
+        courseOffering.academicSession = "Fall-2015"
+        courseOffering.membership = []
+        courseOffering.subOrganizationOf = nil
+        courseOffering.dateCreated = '2015-08-01T06:00:00.000Z'
+        courseOffering.dateModified = '2015-09-02T11:30:00.000Z'
+        
+        # The LIS Course Section for the Caliper Event
+        course = Caliper::Entities::LIS::CourseSection.new
+        course.id = 'https://some-university.edu/politicalScience/2015/american-revolution-101/section/001'
+        course.name = 'American Revolution 101'
+        course.courseNumber = "POL101"
+        course.academicSession = "Fall-2015"
+        course.category = nil
+        course.membership = [membership2]
+        course.subOrganizationOf = courseOffering
+        course.dateCreated = '2015-08-01T06:00:00.000Z'
+        course.dateModified = '2015-09-02T11:30:00.000Z'
+
+        # LIS Group
+        group = Caliper::Entities::LIS::Group.new
+        group.id = "https://some-university.edu/politicalScience/2015/american-revolution-101/section/001/group/001"
+        group.name = "Discussion Group 001"
+        group.membership = [membership3]
+        group.subOrganizationOf = course
+        group.dateCreated = '2015-08-01T06:00:00.000Z'
+        group.dateModified = nil
+
+        # The (Annotation::BookmarkAnnotation) Event
+        annotation_event = AnnotationEvent.new
+        annotation_event.actor  = student
+        annotation_event.action = action
+        annotation_event.object = frame
+        annotation_event.target = nil
+        annotation_event.generated = highlight
+        annotation_event.edApp  = edApp
+        annotation_event.group = group
+        annotation_event.startedAtTime = '2015-09-15T10:15:00.000Z'
+        annotation_event.endedAtTime = nil
+        annotation_event.duration = nil
+        # puts "Event JSON = #{annotation_event.to_json}'"
+
+        # Load JSON from caliper-common-fixtures for comparison
+        # NOTE - sym link to caliper-common-fixtures needs to exist under spec/fixtures
+        file = File.read('spec/fixtures/caliperHighlightAnnotationEvent.json')
+        data_hash = JSON.parse(file)
+        expected_json = data_hash.to_json # convert hash back to JSON string after parse
+        annotation_event.to_json.should be_json_eql(expected_json)#.excluding("actor", "action", "object", "target", "generated", "edApp", "group")
+
+        # puts "JSON from file = #{data_hash}"
+        deser_annotation_event = AnnotationEvent.new
+        deser_annotation_event.from_json data_hash
+        # puts "AnnotationEvent from JSON = #{deser_annotation_event.to_json}"
+
+        # Ensure that the deserialized highlight event object conforms
+        expect(annotation_event).to eql(deser_annotation_event)
+
+      end
+
+    end
+  end
+end