ims_caliper 0.9.3.14 → 0.9.3.15

data/spec/lib/event/annotation_event_bookmark_spec.rb

@@ -20,7 +20,7 @@ require_all 'lib/caliper/entities/entity.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'
-require_all 'lib/caliper/entities/lis/roles.rb'
+require_all 'lib/caliper/entities/lis/role.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'
@@ -38,59 +38,34 @@ module Caliper
 
       it 'should ensure that a Bookmarked AnnotationEvent is correctly created and serialized' do
 
-        # The Actor (Person/Student))
-        student = Caliper::Entities::Agent::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
+        # 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'
+
+        # 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)
+        # ePub parent volume
+        ePub = Caliper::Entities::Reading::EPubVolume.new
+        ePub.id = 'https://github.com/readium/readium-js-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'
+
+        # Object
+        obj = Caliper::Entities::Reading::Frame.new
+        obj.id = 'https://github.com/readium/readium-js-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'
+
+        # Generated annotation
         bookmark = Caliper::Entities::Annotation::BookmarkAnnotation.new
         bookmark.id = 'https://someEduApp.edu/bookmarks/00001'
         bookmark.name = nil
@@ -100,74 +75,82 @@ module Caliper
         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::Agent::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'
+        # Readium 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'
+
+        # LIS Course Offering
+        course = Caliper::Entities::LIS::CourseOffering.new
+        course.id = "https://some-university.edu/politicalScience/2015/american-revolution-101"
+        course.name = "Political Science 101: The American Revolution"
         course.courseNumber = "POL101"
         course.academicSession = "Fall-2015"
-        course.category = nil
-        course.membership = [membership2]
-        course.subOrganizationOf = courseOffering
+        course.subOrganizationOf = nil
         course.dateCreated = '2015-08-01T06:00:00.000Z'
         course.dateModified = '2015-09-02T11:30:00.000Z'
+        
+        # LIS Course Section
+        section = Caliper::Entities::LIS::CourseSection.new
+        section.id = 'https://some-university.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'
 
         # 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.subOrganizationOf = section
         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}'"
+        membership = Caliper::Entities::LIS::Membership.new
+        membership.id = "https://some-university.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.roles = [Caliper::Entities::LIS::Role::LEARNER]
+        membership.status = Caliper::Entities::LIS::Status::ACTIVE
+        membership.dateCreated = "2015-08-01T06:00:00.000Z"
+        membership.dateModified = nil
+
+        # 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.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
         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")
+        expect(event.to_json).to be_json_eql(expected_json)#.excluding("actor", "action", "object", "target", "generated", "ed_app", "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}"
+        deser_event = AnnotationEvent.new
+        deser_event.from_json data_hash
+        # puts "AnnotationEvent from JSON = #{deser_event.to_json}"
 
         # Ensure that the deserialized bookmark event object conforms
-        expect(annotation_event).to eql(deser_annotation_event)
+        expect(event).to eql(deser_event)
       end
     end
   end

data/spec/lib/event/annotation_event_highlight_spec.rb

@@ -20,7 +20,7 @@ require_all 'lib/caliper/entities/entity.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'
-require_all 'lib/caliper/entities/lis/roles.rb'
+require_all 'lib/caliper/entities/lis/role.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'
@@ -38,59 +38,34 @@ module Caliper
 
       it 'should ensure that a Highlighted AnnotationEvent is correctly created and serialized' do
 
-        # The Actor (Person/Student))
-        student = Caliper::Entities::Agent::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
+        # 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'
+
+        # 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)
+        # ePub parent volume
+        ePub = Caliper::Entities::Reading::EPubVolume.new
+        ePub.id = 'https://github.com/readium/readium-js-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'
+
+        # Object
+        obj = Caliper::Entities::Reading::Frame.new
+        obj.id = 'https://github.com/readium/readium-js-viewer/book/34843#epubcfi(/4/3/1)'
+        obj.name = 'Key Figures: George Washington'
+        obj.isPartOf = ePub
+        obj.version = ePub.version
+        obj.index = 1
+        obj.dateCreated = '2015-08-01T06:00:00.000Z'
+        obj.dateModified = '2015-09-02T11:30:00.000Z'
+
+        # Generated annotation
         highlight = Caliper::Entities::Annotation::HighlightAnnotation.new
         highlight.id = 'https://someEduApp.edu/highlights/12345'
         highlight.name = nil
@@ -101,74 +76,82 @@ module Caliper
         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::Agent::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'
+        # Readium 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'
+
+        # LIS Course Offering
+        course = Caliper::Entities::LIS::CourseOffering.new
+        course.id = "https://some-university.edu/politicalScience/2015/american-revolution-101"
+        course.name = "Political Science 101: The American Revolution"
         course.courseNumber = "POL101"
         course.academicSession = "Fall-2015"
-        course.category = nil
-        course.membership = [membership2]
-        course.subOrganizationOf = courseOffering
+        course.subOrganizationOf = nil
         course.dateCreated = '2015-08-01T06:00:00.000Z'
         course.dateModified = '2015-09-02T11:30:00.000Z'
 
+        # LIS Course Section
+        section = Caliper::Entities::LIS::CourseSection.new
+        section.id = 'https://some-university.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'
+
         # 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.subOrganizationOf = section
         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}'"
+        membership = Caliper::Entities::LIS::Membership.new
+        membership.id = "https://some-university.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.roles = [Caliper::Entities::LIS::Role::LEARNER]
+        membership.status = Caliper::Entities::LIS::Status::ACTIVE
+        membership.dateCreated = "2015-08-01T06:00:00.000Z"
+        membership.dateModified = nil
+
+        # Create the Event
+        event = AnnotationEvent.new
+        event.actor  = actor
+        event.action = action
+        event.object = obj
+        event.target = nil
+        event.generated = highlight
+        event.startedAtTime = '2015-09-15T10:15:00.000Z'
+        event.endedAtTime = nil
+        event.duration = nil
+        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
         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")
+        expect(event.to_json).to be_json_eql(expected_json)#.excluding("actor", "action", "object", "target", "generated", "ed_app", "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}"
+        deser_event = AnnotationEvent.new
+        deser_event.from_json data_hash
+        # puts "AnnotationEvent from JSON = #{deser_event.to_json}"
 
         # Ensure that the deserialized highlight event object conforms
-        expect(annotation_event).to eql(deser_annotation_event)
+        expect(event).to eql(deser_event)
       end
     end
   end