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/events/outcome_graded_event_spec.rb ADDED Viewed

@@ -0,0 +1,163 @@
+##
+# 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/outcome_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/assessment/assessment.rb'
+require_all 'lib/caliper/entities/lis/membership.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'
+require_all 'lib/caliper/entities/lis/group.rb'
+require_all 'lib/caliper/entities/assignable/attempt.rb'
+require_all 'lib/caliper/entities/outcome/result.rb'
+require_all 'lib/caliper/events/outcome_event.rb'
+require 'json_spec'
+module Caliper
+  module Events
+    describe OutcomeEvent do
+      it 'should ensure that an OutcomeEvent is correctly created and serialized' do
+        # Scoring edApp
+        ed_app = Caliper::Entities::Agent::SoftwareApplication.new
+        ed_app.id = 'https://example.com/super-assessment-tool'
+        ed_app.name = 'Super Assessment Tool'
+        ed_app.dateCreated = Time.utc(2015,8,1,6,0,0).iso8601(3)
+        # Actor
+        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)
+        # Action
+        action = Caliper::Actions::OutcomeActions::GRADED
+        # Object
+        obj = Caliper::Entities::Assignable::Attempt.new
+        obj.id = "https://example.edu/politicalScience/2015/american-revolution-101/assessment/001/attempt/5678"
+        obj.actor = "https://example.edu/user/554433"
+        obj.assignable = "https://example.edu/politicalScience/2015/american-revolution-101/assessment/001"
+        obj.dateCreated = Time.utc(2015,8,1,6,0,0).iso8601(3)
+        obj.count = 1
+        obj.startedAtTime = "2015-09-15T10:15:00.000Z"
+        # Assessment (result.assignable)
+        assessment = Caliper::Entities::Assessment::Assessment.new
+        assessment.id = "https://example.edu/politicalScience/2015/american-revolution-101/assessment/001"
+        assessment.name = "American Revolution - Key Figures Assessment"
+        assessment.dateModified = Time.utc(2015,9,2,11,30,0).iso8601(3)
+        assessment.dateCreated = Time.utc(2015,8,1,6,0,0).iso8601(3)
+        assessment.datePublished = Time.utc(2015,8,15,9,30,0).iso8601(3)
+        assessment.version = "1.0"
+        assessment.dateToActivate = Time.utc(2015,8,16,5,0,0).iso8601(3)
+        assessment.dateToShow = Time.utc(2015,8,16,5,0,0).iso8601(3)
+        assessment.dateToStartOn = Time.utc(2015,8,16,5,0,0).iso8601(3)
+        assessment.dateToSubmit = Time.utc(2015,9,28,11,59,59).iso8601(3)
+        assessment.maxAttempts = 2
+        assessment.maxSubmits = 2
+        assessment.maxScore = 3.0
+        # Generated result
+        generated = Caliper::Entities::Outcome::Result.new
+        generated.id = "https://example.edu/politicalScience/2015/american-revolution-101/assessment/001/attempt/5678/result"
+        generated.dateCreated = Time.utc(2015,8,1,6,0,0).iso8601(3)
+        generated.assignable = assessment.id
+        generated.actor = actor.id
+        generated.normalScore = 3.0
+        generated.penaltyScore = 0.0
+        generated.extraCreditScore = 0.0
+        generated.totalScore = 3.0
+        generated.curvedTotalScore = 3.0
+        generated.curveFactor = 0.0
+        generated.comment = "Well done."
+        generated.scoredBy = ed_app
+        # LIS Course Offering
+        course = Caliper::Entities::LIS::CourseOffering.new
+        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.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://example.edu/politicalScience/2015/american-revolution-101/section/001'
+        section.name = 'American Revolution 101'
+        section.courseNumber = "POL101"
+        section.academicSession = "Fall-2015"
+        section.subOrganizationOf = course
+        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://example.edu/politicalScience/2015/american-revolution-101/section/001/group/001"
+        group.name = "Discussion Group 001"
+        group.subOrganizationOf = section
+        group.dateCreated = Time.utc(2015,8,1,6,0,0).iso8601(3)
+        # Membership
+        membership = Caliper::Entities::LIS::Membership.new
+        membership.id = "https://example.edu/politicalScience/2015/american-revolution-101/roster/554433"
+        membership.name = "American Revolution 101"
+        membership.description = "Roster entry"
+        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 = Time.utc(2015,8,1,6,0,0).iso8601(3)
+        # Create the Event
+        event = OutcomeEvent.new
+        event.actor  = actor
+        event.action = action
+        event.object = obj
+        event.generated = generated
+        event.eventTime = Time.utc(2015,9,15,10,15,0).iso8601(3)
+        event.edApp = ed_app
+        event.group = group
+        event.membership = membership
+        # 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/caliperAssessmentOutcomeEvent.json')
+        data_hash = JSON.parse(file)
+        expected_json = data_hash.to_json # convert hash back to JSON string after parse
+        #puts "JSON= #{event.to_json}"
+        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_event = OutcomeEvent.new
+        deser_event.from_json data_hash
+        # puts "AssessmentEvent from JSON = #{deser_event.to_json}"
+        # Ensure that the deserialized bookmark event object conforms
+        expect(event).to eql(deser_event)
+      end
+    end
+  end
+end

data/spec/lib/{event/session_event_login_spec.rb → events/session_logged_in_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'
@@ -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/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
@@ -40,96 +40,89 @@ 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::SessionActions::LOGGED_IN
+        action = Caliper::Actions::SessionActions::LOGGED_IN
         # Object (edApp)
         obj = Caliper::Entities::Agent::SoftwareApplication.new
-        obj.id = 'https://github.com/readium/readium-js-viewer'
-        obj.name = 'Readium'
-        obj.dateCreated = '2015-08-01T06:00:00.000Z'
-        obj.dateModified = '2015-09-02T11:30:00.000Z'
+        obj.id = 'https://example.com/viewer'
+        obj.name = 'ePub'
+        obj.dateCreated = Time.utc(2015,8,1,6,0,0).iso8601(3)
+        obj.dateModified = Time.utc(2015,9,2,11,30,0).iso8601(3)
         # ePub parent (target.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)
         # 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 the Event
         event = SessionEvent.new
@@ -138,11 +131,10 @@ module Caliper
         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 = 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

data/spec/lib/{event/session_event_logout_spec.rb → events/session_logged_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,74 +39,69 @@ 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
         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_OUT
+        action = Caliper::Actions::SessionActions::LOGGED_OUT
         # Object (edApp)
         obj = ed_app
         # Target session
         session = Caliper::Entities::Session::Session.new
-        session.id = 'https://github.com/readium/session-123456789'
+        session.id = 'https://example.com/viewer/session-123456789'
         session.name = 'session-123456789'
-        session.description = nil
         session.actor = actor
         session.startedAtTime = '2015-09-15T10:15:00.000Z'
         session.endedAtTime = '2015-09-15T11:05:00.000Z'
         session.duration = 'PT3000S'
-        session.dateCreated = '2015-08-01T06:00:00.000Z'
-        session.dateModified = '2015-09-02T11:30:00.000Z'
+        session.dateCreated = Time.utc(2015,8,1,6,0,0).iso8601(3)
+        session.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 = SessionEvent.new
@@ -114,14 +109,10 @@ module Caliper
         event.action = action
         event.object = obj
         event.target = session
-        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 = 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