RubyGems - ims_caliper - Versions diffs - 0.9.3.15 → 1.0.0 - Mend

ims_caliper 0.9.3.15 → 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (115) hide show

data/spec/lib/{event/session_event_timeout_spec.rb → events/session_timed_out_event_spec.rb} RENAMED Viewed

@@ -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/session_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'
@@ -26,12 +27,11 @@ 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/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'
 require 'json_spec'
 module Caliper
-  module Event
+  module Events
     describe SessionEvent do
@@ -39,78 +39,68 @@ module Caliper
         # 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 (edApp)
         actor = ed_app
         # Action
-        action = Caliper::Profiles::SessionActions::TIMED_OUT
+        action = Caliper::Actions::SessionActions::TIMED_OUT
         # Object session actor (session.actor)
         student = Caliper::Entities::Agent::Person.new
-        student.id = 'https://some-university.edu/user/554433'
-        student.dateCreated = '2015-08-01T06:00:00.000Z'
-        student.dateModified = '2015-09-02T11:30:00.000Z'
+        student.id = 'https://example.edu/user/554433'
+        student.dateCreated = Time.utc(2015,8,1,6,0,0).iso8601(3)
+        student.dateModified = Time.utc(2015,9,2,11,30,0).iso8601(3)
         # Object
         obj = Caliper::Entities::Session::Session.new
-        obj.id = 'https://github.com/readium/session-123456789'
+        obj.id = 'https://example.com/viewer/session-123456789'
         obj.name = 'session-123456789'
-        obj.description = nil
         obj.actor = student
         obj.startedAtTime = '2015-09-15T10:15:00.000Z'
         obj.endedAtTime = '2015-09-15T11:05:00.000Z'
         obj.duration = 'PT3000S'
-        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)
         # 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)
         # Create the Event
         event = SessionEvent.new
         event.actor  = ed_app
         event.action = action
         event.object = obj
-        event.target = nil
-        event.generated = nil
-        event.startedAtTime = '2015-09-15T10:15:00.000Z'
-        event.endedAtTime = '2015-09-15T11:05:00.000Z'
-        event.duration = 'PT3000S'
+        event.eventTime = Time.utc(2015,9,15,10,15,0).iso8601(3)
         event.edApp = ed_app
         event.group = group
-        event.membership = nil
-        # 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

data/spec/lib/{event/viewed_event_spec.rb → events/view_viewed_event_spec.rb} RENAMED Viewed

@@ -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/reading_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'
@@ -26,12 +27,11 @@ 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/event/view_event.rb'
-require_all 'lib/caliper/profiles/reading_profile.rb'
+require_all 'lib/caliper/events/view_event.rb'
 require 'json_spec'
 module Caliper
-  module Event
+  module Events
     describe ViewEvent do
@@ -39,92 +39,84 @@ 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::ReadingActions::VIEWED
+        action = Caliper::Actions::ReadingActions::VIEWED
         # Object
         obj = Caliper::Entities::Reading::EPubVolume.new
-        obj.id = 'https://github.com/readium/readium-js-viewer/book/34843#epubcfi(/4/3)'
+        obj.id = 'https://example.com/viewer/book/34843#epubcfi(/4/3)'
         obj.name = 'The Glorious Cause: The American Revolution, 1763-1789 (Oxford History of the United States)'
         obj.version = '2nd ed.'
-        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)
         # Target frame
         frame = Caliper::Entities::Reading::Frame.new
-        frame.id = 'https://github.com/readium/readium-js-viewer/book/34843#epubcfi(/4/3/1)'
+        frame.id = 'https://example.com/viewer/book/34843#epubcfi(/4/3/1)'
         frame.name = 'Key Figures: George Washington'
         frame.isPartOf = obj
         frame.version = obj.version
         frame.index = 1
-        frame.dateCreated = '2015-08-01T06:00:00.000Z'
-        frame.dateModified = '2015-09-02T11:30:00.000Z'
+        frame.dateCreated = Time.utc(2015,8,1,6,0,0).iso8601(3)
+        frame.dateModified = Time.utc(2015,9,2,11,30,0).iso8601(3)
         # 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)
         # 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 Event
-        event = Caliper::Event::ViewEvent.new
+        event = Caliper::Events::ViewEvent.new
         event.actor  = actor
         event.action = action
         event.object = obj
         event.target = frame
-        event.generated = nil
-        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
@@ -134,7 +126,7 @@ module Caliper
         expect(event.to_json).to be_json_eql(expected_json)#.excluding("actor", "action", "object", "target", "generated", "edApp", "group")
         # puts "JSON from file = #{data_hash}"
-        deser_event = Caliper::Event::ViewEvent.new
+        deser_event = Caliper::Events::ViewEvent.new
         deser_event.from_json data_hash
         # puts "ReadingEvent from JSON = #{deser_event.to_json}"

data/spec/lib/request/{http_requestor_spec.rb → http_requestor_single_event_spec.rb} RENAMED Viewed

@@ -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'
@@ -27,8 +27,8 @@ 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/reading/web_page.rb'
-require_all 'lib/caliper/event/navigation_event.rb'
-require_all 'lib/caliper/profiles/reading_profile.rb'
+require_all 'lib/caliper/entities/session/session.rb'
+require_all 'lib/caliper/events/navigation_event.rb'
 require_all 'lib/caliper/options.rb'
 require_all 'lib/caliper/request/http_requestor.rb'
 require_all 'lib/caliper/sensor.rb'
@@ -44,106 +44,105 @@ module Caliper
         # 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
-        student = Caliper::Entities::Agent::Person.new
-        student.id = 'https://some-university.edu/user/554433'
-        student.dateCreated = '2015-08-01T06:00:00.000Z'
-        student.dateModified = '2015-09-02T11:30:00.000Z'
+        actor = Caliper::Entities::Agent::Person.new
+        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)
+        # LTI federated session
+        session = Caliper::Entities::Session::Session.new
+        session.id = 'https://example.edu/lms/federatedSession/123456789'
+        session.actor = actor
+        session.dateCreated = Time.utc(2015,8,1,6,0,0).iso8601(3)
+        session.startedAtTime = '2015-09-15T10:15:00.000Z'
         # Action
-        action = Caliper::Profiles::ProfileActions::NAVIGATED_TO
+        action = Caliper::Actions::NavigationActions::NAVIGATED_TO
         # Object
         obj = Caliper::Entities::Reading::EPubVolume.new
-        obj.id = 'https://github.com/readium/readium-js-viewer/book/34843#epubcfi(/4/3)'
+        obj.id = 'https://example.com/viewer/book/34843#epubcfi(/4/3)'
         obj.name = 'The Glorious Cause: The American Revolution, 1763-1789 (Oxford History of the United States)'
         obj.version = '2nd ed.'
-        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)
         # Target frame
         frame = Caliper::Entities::Reading::Frame.new
-        frame.id = 'https://github.com/readium/readium-js-viewer/book/34843#epubcfi(/4/3/1)'
+        frame.id = 'https://example.com/viewer/book/34843#epubcfi(/4/3/1)'
         frame.name = 'Key Figures: George Washington'
         frame.isPartOf = obj
         frame.version = obj.version
         frame.index = 1
-        frame.dateCreated = '2015-08-01T06:00:00.000Z'
-        frame.dateModified = '2015-09-02T11:30:00.000Z'
+        frame.dateCreated = Time.utc(2015,8,1,6,0,0).iso8601(3)
+        frame.dateModified = Time.utc(2015,9,2,11,30,0).iso8601(3)
         # navigatedFrom property (specific to Navigation Event)
         from = Caliper::Entities::Reading::WebPage.new
-        from.id = 'https://some-university.edu/politicalScience/2015/american-revolution-101/index.html'
+        from.id = 'https://example.edu/politicalScience/2015/american-revolution-101/index.html'
         from.name = 'American Revolution 101 Landing Page'
-        from.dateCreated = '2015-08-01T06:00:00.000Z'
-        from.dateModified = '2015-09-02T11:30:00.000Z'
-        from.isPartOf = nil
+        from.dateCreated = Time.utc(2015,8,1,6,0,0).iso8601(3)
+        from.dateModified = Time.utc(2015,9,2,11,30,0).iso8601(3)
         from.version = '1.0'
         # 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::NavigationEvent.new
-        event.actor  = student
+        event = Caliper::Events::NavigationEvent.new
+        event.actor  = actor
         event.action = action
         event.object = obj
         event.target = frame
-        event.generated = nil
         event.navigatedFrom = from
-        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}'"
+        event.federatedSession = session.id
         # The Sensor
         options = Caliper::Options.new
-        sensor = Caliper::Sensor.new("http://learning-app.some-university.edu/sensor", options)
+        sensor = Caliper::Sensor.new("https://example.edu/sensor/001", options)
         requestor = Caliper::Request::HttpRequestor.new(options)
         json_payload = requestor.generate_payload(sensor, event)

data/spec/lib/request/http_requestor_single_minimal_event_spec.rb ADDED Viewed

@@ -0,0 +1,84 @@
+##
+# 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 'require_all'
+require_all 'lib/caliper/actions/reading_actions.rb'
+require_all 'lib/caliper/entities/entity.rb'
+require_all 'lib/caliper/events/event.rb'
+require_all 'lib/caliper/options.rb'
+require_all 'lib/caliper/request/http_requestor.rb'
+require_all 'lib/caliper/sensor.rb'
+require 'json_spec'
+module Caliper
+  module Request
+    describe Envelope do
+      it 'should ensure that a Caliper envelope comprising a minimalist event is correctly created and serialized' do
+        # Actor
+        actor = Caliper::Entities::Entity.new
+        actor.context = nil
+        actor.id = 'https://example.edu/user/554433'
+        actor.type = 'http://purl.imsglobal.org/caliper/v1/lis/Person'
+        # puts "new minimal actor entity = #{actor.to_json}"
+        # Action
+        action = Caliper::Actions::ReadingActions::VIEWED
+        obj = Caliper::Entities::Entity.new
+        obj.context = nil
+        obj.id = 'https://example.com/viewer/book/34843#epubcfi(/4/3)'
+        obj.type = 'http://www.idpf.org/epub/vocab/structure/#volume'
+        # puts "new minimal object entity = #{obj.to_json}"
+        # Create the Event
+        event = Caliper::Events::Event.new
+        event.actor = actor
+        event.action = action
+        event.object = obj
+        event.eventTime = Time.utc(2015,9,15,10,15,0).iso8601(3)
+        # The Sensor
+        options = Caliper::Options.new
+        sensor = Caliper::Sensor.new("https://example.edu/sensor/001", options)
+        requestor = Caliper::Request::HttpRequestor.new(options)
+        json_payload = requestor.generate_payload(sensor, event)
+        # Swap out sendTime=DateTime.now() in favor of fixture value (or test will most assuredly fail).
+        json_payload_sub = json_payload.sub(/\"sendTime\":\"[^\"]*\"/, "\"sendTime\":\"2015-09-15T11:05:01.000Z\"")
+        # 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/caliperEnvelopeEventViewViewedMinimal.json')
+        data_hash = JSON.parse(file)
+        expected_json = data_hash.to_json # convert hash back to JSON string after parse
+        expect(json_payload_sub).to be_json_eql(expected_json)
+        # puts "JSON from file = #{data_hash}"
+        # deser_envelope = Caliper::Request::Envelope.new
+        # deser_envelope.from_json data_hash
+        # puts "Envelope from JSON = #{deser_envelope.to_json}"
+        # Ensure that the deserialized shared event object conforms
+        # expect(json_payload_sub).to eql(deser_envelope)
+      end
+    end
+  end
+end