ims_caliper 0.9.3.14 → 0.9.3.15

data/spec/lib/request/http_requestor_spec.rb

@@ -0,0 +1,170 @@
+##
+# 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/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/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/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/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 NavigationEvent is correctly created and serialized' do
+
+        # 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'
+        
+        # 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'
+
+        # Action
+        action = Caliper::Profiles::ProfileActions::NAVIGATED_TO
+
+        # Object
+        obj = Caliper::Entities::Reading::EPubVolume.new
+        obj.id = 'https://github.com/readium/readium-js-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'
+
+        # Target frame
+        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.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'
+
+        # 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.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.version = '1.0'
+
+        # 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.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.subOrganizationOf = section
+        group.dateCreated = '2015-08-01T06:00:00.000Z'
+        group.dateModified = nil
+
+        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 = Caliper::Event::NavigationEvent.new
+        event.actor  = student
+        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.edApp = ed_app
+        event.group = group
+        event.membership = membership
+        # puts "Event JSON = #{event.to_json}'"
+
+        # The Sensor
+        options = Caliper::Options.new
+        sensor = Caliper::Sensor.new("http://learning-app.some-university.edu/sensor", 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/eventStorePayload.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

data/spec/lib/sensor_spec.rb

@@ -18,10 +18,6 @@
 require 'require_all'
 require_all 'lib/caliper/sensor.rb'
 require_relative './event_helper'
-require_all 'lib/caliper/event/session_event.rb'
-require_all 'lib/caliper/event/grade_predict_event.rb'
-require_all 'lib/caliper/entities/outcome/predicted_grade.rb'
-require_all 'lib/caliper/entities/outcome/result.rb'
 
 module Caliper
 
@@ -30,36 +26,20 @@ module Caliper
 
     it "should ensure that we can create and send an event" do
 
-	    options = {
-		    'host'  => 'http://dev1.intellifylearning.com/v1custom/eventdata',
-		    'sensorId' => '0945062D-C8A1-40D7-9834-C1659705EC5B',
-		    #'sensorId' => 'D9DC57B5-3AAA-41D4-B73D-58AE828D9D85',
-		    'apiKey' => '_-kJMcjiSymICwhUaHULbg'
-		    #'apiKey' => '_-kJMcjiSymICwhUaHULbg'
-	    }
-
-      sensor = Sensor.new options
-      event  = session_eventP
-
-	    predictedEvent = Caliper::Entities::Outcome::PredictedGrade.new
-
-	    outcome = Caliper::Entities::Outcome::Result.new
-
-	    file = File.read('spec/fixtures/caliper_session_gradecraft.json')
-	    data_hash = JSON.parse(file)
-	    expected_json = data_hash.to_json # convert hash back to JSON string after parse
-	    # puts "JSON from file = #{data_hash}"
-	    deser_annotation_event = Caliper::Event::SessionEvent.new
-	    deser_annotation_event.from_json data_hash
-	    # puts "AnnotationEvent from JSON = #{deser_annotation_event.to_json}"
+      id = 'http://learning-app.some-university.edu/sensor'
+      options = {
+        'host'  => 'http://requestb.in/1i7pr2i1',
+        'apiKey' => 'test_api_key'
+      }
 
+      sensor = Sensor.new id, options
+      event  = session_event
       
       # NOTE: To test sending events to an actual endpoint, 
       # for now, uncomment the line below after setting options.host above
       # to a new/valid request bin or end point URL.
       
-      response = sensor.send deser_annotation_event
-	    p response
+      # sensor.send event
     end
   end
-end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ims_caliper
 version: !ruby/object:Gem::Version
-  version: 0.9.3.14
+  version: 0.9.3.15
 platform: ruby
 authors:
 - Caliper Dev Group
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-04 00:00:00.000000000 Z
+date: 2015-05-21 00:00:00.000000000 Z
 dependencies: []
 description: This is the implementation of IMSGlobal Caliper in Ruby
 email:
@@ -50,14 +50,13 @@ files:
 - lib/caliper/entities/lis/course_section.rb
 - lib/caliper/entities/lis/group.rb
 - lib/caliper/entities/lis/membership.rb
-- lib/caliper/entities/lis/roles.rb
+- lib/caliper/entities/lis/role.rb
 - lib/caliper/entities/lis/status.rb
 - lib/caliper/entities/media/audio_object.rb
 - lib/caliper/entities/media/image_object.rb
 - lib/caliper/entities/media/media_location.rb
 - lib/caliper/entities/media/media_object.rb
 - lib/caliper/entities/media/video_object.rb
-- lib/caliper/entities/outcome/predicted_grade.rb
 - lib/caliper/entities/outcome/result.rb
 - lib/caliper/entities/reading/epub_chapter.rb
 - lib/caliper/entities/reading/epub_part.rb
@@ -80,20 +79,17 @@ files:
 - lib/caliper/entities/targetable.rb
 - lib/caliper/entities/w3c/membership.rb
 - lib/caliper/entities/w3c/organization.rb
-- lib/caliper/entity_envelope.rb
 - lib/caliper/event/annotation_event.rb
 - lib/caliper/event/assessment_event.rb
 - lib/caliper/event/assessment_item_event.rb
 - lib/caliper/event/assignable_event.rb
 - lib/caliper/event/event.rb
-- lib/caliper/event/grade_predict_event.rb
 - lib/caliper/event/jsonable.rb
 - lib/caliper/event/media_event.rb
 - lib/caliper/event/navigation_event.rb
 - lib/caliper/event/outcome_event.rb
 - lib/caliper/event/session_event.rb
 - lib/caliper/event/view_event.rb
-- lib/caliper/event_envelope.rb
 - lib/caliper/jsonable.rb
 - lib/caliper/options.rb
 - lib/caliper/profiles/annotation_profile.rb
@@ -104,7 +100,8 @@ files:
 - lib/caliper/profiles/profile.rb
 - lib/caliper/profiles/reading_profile.rb
 - lib/caliper/profiles/session_profile.rb
-- lib/caliper/request/event_store_envelope.rb
+- lib/caliper/request/envelope.rb
+- lib/caliper/request/envelope_jsonable.rb
 - lib/caliper/request/event_store_requestor.rb
 - lib/caliper/request/http_requestor.rb
 - lib/caliper/sensor.rb
@@ -139,6 +136,7 @@ files:
 - spec/lib/event/session_event_timeout_spec.rb
 - spec/lib/event/viewed_event_spec.rb
 - spec/lib/event_helper.rb
+- spec/lib/request/http_requestor_spec.rb
 - spec/lib/sensor_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/IMSGlobal/caliper-ruby
@@ -151,17 +149,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: Caliper Sensor API
@@ -185,5 +183,6 @@ test_files:
 - spec/lib/event/session_event_timeout_spec.rb
 - spec/lib/event/viewed_event_spec.rb
 - spec/lib/event_helper.rb
+- spec/lib/request/http_requestor_spec.rb
 - spec/lib/sensor_spec.rb
 - spec/spec_helper.rb

data/lib/caliper/entities/outcome/predicted_grade.rb

@@ -1,43 +0,0 @@
-##
-# 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_relative '../entity'
-require_relative '../generatable'
-
-#
-# LIS Result
-#
-module Caliper
-	module Entities
-		class PredictedGrade < Entity
-			include Caliper::Entities::Generatable
-
-			attr_accessor :type, # String
-			              :course_id,
-			              :scored_by,
-			              :student_id,
-			              :user_role,
-			              :assignment_id,
-			              :predicted_score,
-			              :possible_score
-
-			def initialize
-
-			end
-		end
-	end
-end

data/lib/caliper/entity_envelope.rb

@@ -1,33 +0,0 @@
-##
-# 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 'rest_client'
-require_relative "./options"
-require_relative './jsonable'
-
-#
-# Caliper Sensor Entity Envelope.
-#
-module Caliper
-  class EntityEnvelope
-  	include Caliper::Jsonable
-
-    attr_accessor :apiKey,
-      :sensorId,
-      :entity
-  end
-end

data/lib/caliper/event_envelope.rb

@@ -1,33 +0,0 @@
-##
-# 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 'rest_client'
-require_relative "./options"
-require_relative './jsonable'
-
-#
-# Caliper Sensor Event Envelope.
-#
-module Caliper
-  class EventEnvelope
-    include Caliper::Jsonable
-
-    attr_accessor :apiKey,
-      :sensorId,
-      :event
-  end
-end

data/lib/caliper/request/event_store_envelope.rb

@@ -1,27 +0,0 @@
-##
-# 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/.
-
-#
-# Event store envelope. Contains event info.
-#
-module Caliper
-	module Request
-		class EventStoreEnvelope
-			attr_accessor :id, :type, :time, :data
-		end
-	end
-end