ims_caliper 0.9.3.15 → 1.0.0

data/lib/caliper/version.rb

@@ -19,5 +19,5 @@
 # Version.
 #
 module Caliper
-  VERSION = "0.9.3.15"
+  VERSION = "1.0.0"
 end

data/lib/caliper.rb

@@ -25,7 +25,7 @@ module Caliper
   end
 
   module Event
-    autoload :Base, "caliper/event/base"
+    autoload :Base, "caliper/events/base"
   end
 
   module Entities

data/spec/lib/entities/agent/{student.json → person.json}

@@ -1,8 +1,9 @@
 {
-  "@id": "https://some-university.edu/students/dent_stu",
+  "@context": "http://purl.imsglobal.org/ctx/caliper/v1/Context",
+  "@id": "https://example.edu/user/123456789",
   "@type": "http://purl.imsglobal.org/caliper/v1/lis/Person",
-  "name": "Stu Dent",
-  "description": "A super bright individual",
+  "name": null,
+  "description": "A bright individual",
   "extensions": {
     "customProp": 42
   },

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

@@ -30,22 +30,21 @@ module Caliper
       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 = Caliper::Entities::Agent::Person.new
+          student.id = 'https://example.edu/user/123456789'
+          student.description = 'A 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/agent/student.json')
+          file = File.read('spec/lib/entities/agent/person.json')
           data_hash = JSON.parse(file)
           expected_json = data_hash.to_json # convert hash back to JSON string after parse
           expect(student.to_json).to be_json_eql(expected_json)
 
-          des_student = Person.new
+          des_student = Caliper::Entities::Agent::Person.new
           des_student.from_json data_hash
           # puts "Object from JSON = #{des_student.to_json}"
 

data/spec/lib/entities/assessment/assessment.json

@@ -0,0 +1,23 @@
+{
+  "@context": "http://purl.imsglobal.org/ctx/caliper/v1/Context",
+  "@id": "https://example.edu/politicalScience/2014/american-revolution-101/assessment/001",
+  "@type": "http://purl.imsglobal.org/caliper/v1/Assessment",
+  "name": "Assessment 001",
+  "description": "description",
+  "objectType": [],
+  "alignedLearningObjective": [],
+  "keywords": [],
+  "isPartOf": null,
+  "extensions": {"isPracticeTest": true},
+  "dateCreated": "2015-03-15T23:09:11.000Z",
+  "dateModified": "2015-03-15T23:09:11.000Z",
+  "datePublished": null,
+  "version": null,
+  "dateToActivate": null,
+  "dateToShow": null,
+  "dateToStartOn": null,
+  "dateToSubmit": null,
+  "maxAttempts": null,
+  "maxScore": null,
+  "maxSubmits": null
+}

data/spec/lib/entities/assessment/assessment_spec.rb

@@ -0,0 +1,54 @@
+##
+# This file is part of IMS Caliper Analytics™ and is licensed to
+# IMS Global Learning Consortium, Inc. (http://www.imsglobal.org)
+# under one or more contributor license agreements.  See the NOTICE
+# file distributed with this work for additional information.
+#
+# IMS Caliper is free software: you can redistribute it and/or modify it under
+# the terms of the GNU Lesser General Public License as published by the Free
+# Software Foundation, version 3 of the License.
+#
+# IMS Caliper is distributed in the hope that it will be useful, but WITHOUT
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
+# A PARTICULAR PURPOSE.  See the GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License along
+# with this program. If not, see http://www.gnu.org/licenses/.
+
+# require 'spec_helper.rb'
+require 'require_all'
+require 'json_spec'
+require_all 'lib/caliper/entities/assessment/assessment.rb'
+
+module Caliper
+  module Entities
+    module Assessment
+
+      describe Assessment do
+
+        it "should ensure that a base entity is correctly created and serialized" do
+          entity = Caliper::Entities::Assessment::Assessment.new
+          entity.id = 'https://example.edu/politicalScience/2014/american-revolution-101/assessment/001'
+          entity.name = 'Assessment 001'
+          entity.description = 'description'
+          entity.extensions = {'isPracticeTest' => true}
+          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/assessment/assessment.json')
+          data_hash = JSON.parse(file)
+          expected_json = data_hash.to_json # convert hash back to JSON string after parse
+          expect(entity.to_json).to be_json_eql(expected_json)#.excluding("@class")
+
+          # Compare Deserialized JSON to desired Entity
+          des_entity = Caliper::Entities::Assessment::Assessment.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
+end

data/spec/lib/event_helper.rb

@@ -16,7 +16,7 @@
 # with this program. If not, see http://www.gnu.org/licenses/.
 
 require 'require_all'
-require_all 'lib/caliper/entities/entity.rb'
+require_all 'lib/caliper/entities/entity_base.rb'
 require_all 'lib/caliper/entities/agent/software_application.rb'
 require_all 'lib/caliper/entities/agent/person.rb'
 require_all 'lib/caliper/entities/lis/membership.rb'
@@ -28,8 +28,7 @@ require_all 'lib/caliper/entities/lis/group.rb'
 require_all 'lib/caliper/entities/reading/epub_volume.rb'
 require_all 'lib/caliper/entities/reading/frame.rb'
 require_all 'lib/caliper/entities/session/session.rb'
-require_all 'lib/caliper/event/session_event.rb'
-require_all 'lib/caliper/profiles/session_profile.rb'
+require_all 'lib/caliper/events/session_event.rb'
 
 module Helper
 
@@ -37,101 +36,94 @@ module Helper
 
     # Edapp
     ed_app = Caliper::Entities::Agent::SoftwareApplication.new
-    ed_app.id = 'https://github.com/readium/readium-js-viewer'
-    ed_app.name = 'Readium'
-    ed_app.dateCreated = '2015-08-01T06:00:00.000Z'
-    ed_app.dateModified = '2015-09-02T11:30:00.000Z'
+    ed_app.id = 'https://example.com/viewer'
+    ed_app.name = 'ePub'
+    ed_app.dateCreated = Time.utc(2015,8,1,6,0,0).iso8601(3)
+    ed_app.dateModified = Time.utc(2015,9,2,11,30,0).iso8601(3)
 
     # Actor
     actor = Caliper::Entities::Agent::Person.new
-    actor.id = 'https://some-university.edu/user/554433'
-    actor.dateCreated = '2015-08-01T06:00:00.000Z'
-    actor.dateModified = '2015-09-02T11:30:00.000Z'
+    actor.id = 'https://example.edu/user/554433'
+    actor.dateCreated = Time.utc(2015,8,1,6,0,0).iso8601(3)
+    actor.dateModified = Time.utc(2015,9,2,11,30,0).iso8601(3)
 
     # Action
-    action = Caliper::Profiles::SessionActions::LOGGED_IN;
+    action = Caliper::Actions::SessionActions::LOGGED_IN;
 
     # Object
     obj = ed_app
 
     # ePub parent (frame.isPartOf)
     ePub = Caliper::Entities::Reading::EPubVolume.new
-    ePub.id = 'https://github.com/readium/readium-js-viewer/book/34843#epubcfi(/4/3)'
+    ePub.id = 'https://example.com/viewer/book/34843#epubcfi(/4/3)'
     ePub.name = 'The Glorious Cause: The American Revolution, 1763-1789 (Oxford History of the United States)'
     ePub.version = '2nd ed.'
-    ePub.dateCreated = '2015-08-01T06:00:00.000Z'
-    ePub.dateModified = '2015-09-02T11:30:00.000Z'
+    ePub.dateCreated = Time.utc(2015,8,1,6,0,0).iso8601(3)
+    ePub.dateModified = Time.utc(2015,9,2,11,30,0).iso8601(3)
 
     # Target frame
     target = Caliper::Entities::Reading::Frame.new
-    target.id = 'https://github.com/readium/readium-js-viewer/book/34843#epubcfi(/4/3/1)'
+    target.id = 'https://example.com/viewer/book/34843#epubcfi(/4/3/1)'
     target.name = 'Key Figures: George Washington'
     target.isPartOf = ePub
     target.version = ePub.version
     target.index = 1
-    target.dateCreated = '2015-08-01T06:00:00.000Z'
-    target.dateModified = '2015-09-02T11:30:00.000Z'
+    target.dateCreated = Time.utc(2015,8,1,6,0,0).iso8601(3)
+    target.dateModified = Time.utc(2015,9,2,11,30,0).iso8601(3)
 
     # Generated session
     generated = Caliper::Entities::Session::Session.new
-    generated.id = 'https://github.com/readium/session-123456789'
+    generated.id = 'https://example.com/viewer/session-123456789'
     generated.name = 'session-123456789'
-    generated.description = nil
     generated.actor = actor
     generated.startedAtTime = '2015-09-15T10:15:00.000Z'
-    generated.endedAtTime = nil
-    generated.duration = nil
-    generated.dateCreated = '2015-08-01T06:00:00.000Z'
-    generated.dateModified = '2015-09-02T11:30:00.000Z'
+    generated.dateCreated = Time.utc(2015,8,1,6,0,0).iso8601(3)
+    generated.dateModified = Time.utc(2015,9,2,11,30,0).iso8601(3)
 
     # LIS Course Offering
     course = Caliper::Entities::LIS::CourseOffering.new
-    course.id = "https://some-university.edu/politicalScience/2015/american-revolution-101"
+    course.id = "https://example.edu/politicalScience/2015/american-revolution-101"
     course.name = "Political Science 101: The American Revolution"
     course.courseNumber = "POL101"
     course.academicSession = "Fall-2015"
-    course.subOrganizationOf = nil
-    course.dateCreated = '2015-08-01T06:00:00.000Z'
-    course.dateModified = '2015-09-02T11:30:00.000Z'
+    course.dateCreated = Time.utc(2015,8,1,6,0,0).iso8601(3)
+    course.dateModified = Time.utc(2015,9,2,11,30,0).iso8601(3)
 
     # LIS Course Section
     section = Caliper::Entities::LIS::CourseSection.new
-    section.id = 'https://some-university.edu/politicalScience/2015/american-revolution-101/section/001'
+    section.id = 'https://example.edu/politicalScience/2015/american-revolution-101/section/001'
     section.name = 'American Revolution 101'
     section.courseNumber = "POL101"
     section.academicSession = "Fall-2015"
-    section.category = nil
     section.subOrganizationOf = course
-    section.dateCreated = '2015-08-01T06:00:00.000Z'
-    section.dateModified = '2015-09-02T11:30:00.000Z'
+    section.dateCreated = Time.utc(2015,8,1,6,0,0).iso8601(3)
+    section.dateModified = Time.utc(2015,9,2,11,30,0).iso8601(3)
 
     # LIS Group
     group = Caliper::Entities::LIS::Group.new
-    group.id = "https://some-university.edu/politicalScience/2015/american-revolution-101/section/001/group/001"
+    group.id = "https://example.edu/politicalScience/2015/american-revolution-101/section/001/group/001"
     group.name = "Discussion Group 001"
     group.subOrganizationOf = section
-    group.dateCreated = '2015-08-01T06:00:00.000Z'
-    group.dateModified = nil
+    group.dateCreated = Time.utc(2015,8,1,6,0,0).iso8601(3)
 
     membership = Caliper::Entities::LIS::Membership.new
-    membership.id = "https://some-university.edu/politicalScience/2015/american-revolution-101/roster/554433"
+    membership.id = "https://example.edu/politicalScience/2015/american-revolution-101/roster/554433"
     membership.name = "American Revolution 101"
     membership.description = "Roster entry"
-    membership.member = "https://some-university.edu/user/554433"
-    membership.organization = "https://some-university.edu/politicalScience/2015/american-revolution-101/section/001"
+    membership.member = "https://example.edu/user/554433"
+    membership.organization = "https://example.edu/politicalScience/2015/american-revolution-101/section/001"
     membership.roles = [Caliper::Entities::LIS::Role::LEARNER]
     membership.status = Caliper::Entities::LIS::Status::ACTIVE
-    membership.dateCreated = "2015-08-01T06:00:00.000Z"
-    membership.dateModified = nil
+    membership.dateCreated = Time.utc(2015,8,1,6,0,0).iso8601(3)
 
     # Create the Event
-    event = Caliper::Event::SessionEvent.new
+    event = Caliper::Events::SessionEvent.new
     event.actor  = actor
     event.action = action
     event.object = obj
     event.target = target
     event.generated = generated
-    event.startedAtTime = '2015-09-15T10:15:00.000Z'
+    event.eventTime = Time.utc(2015,9,15,10,15,0).iso8601(3)
     event.edApp  = ed_app
     event.group = course
     event.membership = membership

data/spec/lib/{event/annotation_event_bookmark_spec.rb → events/annotation_bookmarked_event_spec.rb}

@@ -16,7 +16,8 @@
 # with this program. If not, see http://www.gnu.org/licenses/.
 
 require 'require_all'
-require_all 'lib/caliper/entities/entity.rb'
+require_all 'lib/caliper/actions/annotation_actions.rb'
+require_all 'lib/caliper/entities/entity_base.rb'
 require_all 'lib/caliper/entities/agent/software_application.rb'
 require_all 'lib/caliper/entities/agent/person.rb'
 require_all 'lib/caliper/entities/lis/membership.rb'
@@ -27,12 +28,11 @@ 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_all 'lib/caliper/events/annotation_event.rb'
 require 'json_spec'
 
 module Caliper
-  module Event
+  module Events
 
     describe AnnotationEvent do
 
@@ -40,102 +40,92 @@ module Caliper
 
         # Actor
         actor = Caliper::Entities::Agent::Person.new
-        actor.id = 'https://some-university.edu/user/554433'
-        actor.dateCreated = '2015-08-01T06:00:00.000Z'
-        actor.dateModified = '2015-09-02T11:30:00.000Z'
+        actor.id = 'https://example.edu/user/554433'
+        actor.dateCreated = Time.utc(2015,8,1,6,0,0).iso8601(3)
+        actor.dateModified = Time.utc(2015,9,2,11,30,0).iso8601(3)
 
         # Action
-        action = Caliper::Profiles::AnnotationActions::BOOKMARKED
+        action = Caliper::Actions::AnnotationActions::BOOKMARKED
 
         # ePub parent volume
         ePub = Caliper::Entities::Reading::EPubVolume.new
-        ePub.id = 'https://github.com/readium/readium-js-viewer/book/34843#epubcfi(/4/3)'
+        ePub.id = 'https://example.com/viewer/book/34843#epubcfi(/4/3)'
         ePub.name = 'The Glorious Cause: The American Revolution, 1763-1789 (Oxford History of the United States)'
         ePub.version = '2nd ed.'
-        ePub.dateCreated = '2015-08-01T06:00:00.000Z'
-        ePub.dateModified = '2015-09-02T11:30:00.000Z'
+        ePub.dateCreated = Time.utc(2015,8,1,6,0,0).iso8601(3)
+        ePub.dateModified = Time.utc(2015,9,2,11,30,0).iso8601(3)
 
         # Object
         obj = Caliper::Entities::Reading::Frame.new
-        obj.id = 'https://github.com/readium/readium-js-viewer/book/34843#epubcfi(/4/3/2)'
+        obj.id = 'https://example.com/viewer/book/34843#epubcfi(/4/3/2)'
         obj.name = 'Key Figures: Lord North'
         obj.isPartOf = ePub
         obj.version = ePub.version
         obj.index = 2
-        obj.dateCreated = '2015-08-01T06:00:00.000Z'
-        obj.dateModified = '2015-09-02T11:30:00.000Z'
+        obj.dateCreated = Time.utc(2015,8,1,6,0,0).iso8601(3)
+        obj.dateModified = Time.utc(2015,9,2,11,30,0).iso8601(3)
 
         # Generated annotation
         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.id = 'https://example.edu/bookmarks/00001'
+        bookmark.dateCreated = Time.utc(2015,8,1,6,0,0).iso8601(3)
+        bookmark.dateModified = Time.utc(2015,9,2,11,30,0).iso8601(3)
+        bookmark.annotated = 'https://example.com/viewer/book/34843#epubcfi(/4/3/2)'
         bookmark.bookmarkNotes = 'The Intolerable Acts (1774)--bad idea Lord North'
 
-        # Readium app
+        # ePub app
         ed_app = Caliper::Entities::Agent::SoftwareApplication.new
-        ed_app.id = 'https://github.com/readium/readium-js-viewer'
-        ed_app.name = 'Readium'
-        ed_app.dateCreated = '2015-08-01T06:00:00.000Z'
-        ed_app.dateModified = '2015-09-02T11:30:00.000Z'
+        ed_app.id = 'https://example.com/viewer'
+        ed_app.name = 'ePub'
+        ed_app.dateCreated = Time.utc(2015,8,1,6,0,0).iso8601(3)
+        ed_app.dateModified = Time.utc(2015,9,2,11,30,0).iso8601(3)
 
         # LIS Course Offering
         course = Caliper::Entities::LIS::CourseOffering.new
-        course.id = "https://some-university.edu/politicalScience/2015/american-revolution-101"
+        course.id = "https://example.edu/politicalScience/2015/american-revolution-101"
         course.name = "Political Science 101: The American Revolution"
         course.courseNumber = "POL101"
         course.academicSession = "Fall-2015"
-        course.subOrganizationOf = nil
-        course.dateCreated = '2015-08-01T06:00:00.000Z'
-        course.dateModified = '2015-09-02T11:30:00.000Z'
+        course.dateCreated = Time.utc(2015,8,1,6,0,0).iso8601(3)
+        course.dateModified = Time.utc(2015,9,2,11,30,0).iso8601(3)
         
         # LIS Course Section
         section = Caliper::Entities::LIS::CourseSection.new
-        section.id = 'https://some-university.edu/politicalScience/2015/american-revolution-101/section/001'
+        section.id = 'https://example.edu/politicalScience/2015/american-revolution-101/section/001'
         section.name = 'American Revolution 101'
         section.courseNumber = "POL101"
         section.academicSession = "Fall-2015"
-        section.category = nil
         section.subOrganizationOf = course
-        section.dateCreated = '2015-08-01T06:00:00.000Z'
-        section.dateModified = '2015-09-02T11:30:00.000Z'
+        section.dateCreated = Time.utc(2015,8,1,6,0,0).iso8601(3)
+        section.dateModified = Time.utc(2015,9,2,11,30,0).iso8601(3)
 
         # LIS Group
         group = Caliper::Entities::LIS::Group.new
-        group.id = "https://some-university.edu/politicalScience/2015/american-revolution-101/section/001/group/001"
+        group.id = "https://example.edu/politicalScience/2015/american-revolution-101/section/001/group/001"
         group.name = "Discussion Group 001"
         group.subOrganizationOf = section
-        group.dateCreated = '2015-08-01T06:00:00.000Z'
-        group.dateModified = nil
+        group.dateCreated = Time.utc(2015,8,1,6,0,0).iso8601(3)
 
         membership = Caliper::Entities::LIS::Membership.new
-        membership.id = "https://some-university.edu/politicalScience/2015/american-revolution-101/roster/554433"
+        membership.id = "https://example.edu/politicalScience/2015/american-revolution-101/roster/554433"
         membership.name = "American Revolution 101"
         membership.description = "Roster entry"
-        membership.member = "https://some-university.edu/user/554433"
-        membership.organization = "https://some-university.edu/politicalScience/2015/american-revolution-101/section/001"
+        membership.member = "https://example.edu/user/554433"
+        membership.organization = "https://example.edu/politicalScience/2015/american-revolution-101/section/001"
         membership.roles = [Caliper::Entities::LIS::Role::LEARNER]
         membership.status = Caliper::Entities::LIS::Status::ACTIVE
-        membership.dateCreated = "2015-08-01T06:00:00.000Z"
-        membership.dateModified = nil
+        membership.dateCreated = Time.utc(2015,8,1,6,0,0).iso8601(3)
 
         # Create the Event
         event = AnnotationEvent.new
         event.actor  = actor
         event.action = action
         event.object = obj
-        event.target = nil
         event.generated = bookmark
-        event.startedAtTime = '2015-09-15T10:15:00.000Z'
-        event.endedAtTime = nil
-        event.duration = nil
+        event.eventTime = Time.utc(2015,9,15,10,15,0).iso8601(3)
         event.edApp = ed_app
         event.group = group
         event.membership = membership
-        # puts "Event JSON = #{event.to_json}'"
 
         # Load JSON from caliper-common-fixtures for comparison
         # NOTE - sym link to caliper-common-fixtures needs to exist under spec/fixtures