ims_caliper 0.9.1 → 0.9.3

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MTU3NzJjMmQxOGQ5ZTFhZjhlOTY5Y2UzYjBlMDMyNDY2ODk2ZWE1OQ==
+    OWU0MTc4MDI1OTBlMWU0ODNlZDZmOTgwMjMyN2Y1YmU4ZGQ5ZGQxZQ==
   data.tar.gz: !binary |-
-    MTUxMGE4NGUxZGY3ZWVmNGNjMWU2MWMwNzZlNzdjMTBiMzUwYzhjYQ==
+    YTQxNGYwZDcyNWRiMzZjMWUxMDUyMTg3NjBhZjJhMTVmMWY0ZDU1Zg==
 SHA512:
   metadata.gz: !binary |-
-    YmFlYjZhOTNjMjA2YWE1MWIyOTg4M2ZlNjY2ZjI3YzJmMWNkN2E2NGMzYzA2
-    NWNlNmZiNWMzYTI4YzhkZmZlNmYxY2EzNTcyNTdjMzljZTMyZTcxZTM5Zjlk
-    ZjEzOGFmN2JhYTkxY2MzNzhlNmVlYzg4ZDAzZDc3MjQ0YzM5N2M=
+    OWI5YjQyODc4NzIwOTM2YzBiZTJjMmNjODg5OTEzOTRlM2RhZGFkOTcxYjhi
+    NTkxMjkzODcwMDcyM2MwNzViYzBiNjQ2MjI3ODE4MjFhY2FkZjVhN2U1Njk1
+    MDZjZWQxNWIxZjU4NDcyZTAwMTQ5YTc4MDFjYTA3NmNkMTM2N2E=
   data.tar.gz: !binary |-
-    YTkwODgzOWU1NDJhMmIzZjU1NzU4MDM3NDQyNGQ4NTFlYjAwMWM1YWM2NDM2
-    ZGU3YWZmMTFmMTkzYWVkNWY2ODZiNTQ3ZDI0Y2MxZjQ0YzExNzFlM2QwODIw
-    MTAzMzYzMzNjZGQzN2E1YjYxOTU5MDMxOTUyZmFhYmQyZTM4ZjQ=
+    YjQ2ZjJlYWVhMjJiZTUwN2Y4ZDNkYWQzYzc1NzRjYTcyZjI0ZTdhNjBjOTBm
+    YzFjYzc5MTcyOWVhNTgwNTgxNTgyOTcwODI2YjRmMTM0YTkwMzc1ODFjMDQ1
+    MjMwNGIwZGE4ZTY4OGIxNjZkN2E1NWM2YzlmMjczYzdiZWMwN2Y=

data/lib/caliper/defaults.rb

@@ -21,8 +21,8 @@
 module Caliper
   class Defaults
     HOST = "http://dev-null.comt"
-    CONNECTION_TIMEOUT = 10000
-    SO_TIMEOUT = 10000
     CONNECTION_REQUEST_TIMEOUT = 10000
+    CONNECTION_TIMEOUT = 10000
+    SOCKET_TIMEOUT = 10000
   end
 end

data/lib/caliper/entities/agent/organization.rb

@@ -27,6 +27,9 @@ module Caliper
       class Organization < Entity
         include Caliper::Entities::W3C::Organization
 
+        attr_accessor :membership,
+                      :subOrganizationOf
+
         def initialize
           super
           @type = EntityType::ORGANIZATION

data/lib/caliper/entities/learning_context.rb

@@ -17,7 +17,7 @@
 
 require_relative './entity'
 require_relative './agent/software_application'
-require_relative './w3c/organization'
+require_relative './agent/organization'
 require_relative './foaf/agent'
 
 #
@@ -34,7 +34,7 @@ module Caliper
 	    def initialize
 		    super
 		    @ed_app = Caliper::Entities::Agent::SoftwareApplication.new
-		    @group = Caliper::Entities::W3C::Organization.new
+		    @group = Caliper::Entities::Agent::Organization.new
 		    @agent = Caliper::Entities::Entity.new
 	    end
 	  end

data/lib/caliper/entities/lis/course_offering.rb

@@ -28,8 +28,9 @@ module Caliper
         include Caliper::Entities::W3C::Organization
 
         attr_accessor :courseNumber,
-                      :academicSession
-
+                      :academicSession,
+                      :membership,
+                      :subOrganizationOf
         def initialize
           super
           @type = EntityType::COURSE_OFFERING

data/lib/caliper/entities/lis/group.rb

@@ -27,6 +27,9 @@ module Caliper
       class Group < Entity
         include Caliper::Entities::W3C::Organization
 
+        attr_accessor :membership,
+                      :subOrganizationOf
+
         def initialize
           super
           @type = EntityType::GROUP

data/lib/caliper/entities/lis/membership.rb

@@ -27,6 +27,11 @@ module Caliper
       class Membership < Entity
         include Caliper::Entities::W3C::Membership
 
+        attr_accessor :member,
+                      :organization,
+                      :roles,
+                      :status
+
         def initialize
           super
           @type = EntityType::MEMBERSHIP

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

@@ -38,7 +38,7 @@ module Caliper
 		end
 
 		def initialize
-
+			super
 		end
 	end
 end

data/lib/caliper/entities/response/fillin_blank_response.rb

@@ -30,6 +30,7 @@ module Caliper
 			                :values
 
 				def initialize
+          super
 					@type = ResponseType::FILLINBLANK
 				end
 			end

data/lib/caliper/entities/response/multiple_choice_response.rb

@@ -29,6 +29,7 @@ module Caliper
 			                :values
 
 				def initialize
+          super
 					@type = ResponseType::MULTIPLECHOICE
 				end
 			end

data/lib/caliper/entities/response/multiple_response_response.rb

@@ -29,6 +29,7 @@ module Caliper
 			                :values
 
 				def initialize
+          super
 					@type = ResponseType::MULTIPLERESPONSE
 				end
 			end

data/lib/caliper/entities/response/response.rb

@@ -36,6 +36,7 @@ module Caliper
 			                :duration
 
 				def initialize
+          super
 					@type = EntityType::RESPONSE
 				end
 			end

data/lib/caliper/entities/response/select_type_response.rb

@@ -30,6 +30,7 @@ module Caliper
 			                :values
 
 				def initialize
+          super
 					@type = ResponseType::SELECTTEXT
         end
 			end

data/lib/caliper/entities/response/true_false_response.rb

@@ -30,6 +30,7 @@ module Caliper
 			                :values
 
 				def initialize
+          super
 					@type = ResponseType::TRUEFALSE
 				end
 			end

data/lib/caliper/entities/w3c/membership.rb

@@ -21,11 +21,8 @@
 module Caliper
   module Entities
     module W3C
-      class Membership
-        attr_accessor :member,
-                      :organization,
-                      :roles,
-                      :status
+      module Membership
+
       end
     end
   end

data/lib/caliper/entities/w3c/organization.rb

@@ -21,9 +21,8 @@
 module Caliper
   module Entities
     module W3C
-      class Organization
-        attr_accessor :membership,
-                      :subOrganizationOf
+      module Organization
+
       end
     end
   end

data/lib/caliper/event/annotation_event.rb

@@ -25,6 +25,7 @@ module Caliper
     class AnnotationEvent < Event
 
       def initialize
+        super
         @context = Caliper::Event::EventContext::ANNOTATION
         @type = Caliper::Event::EventType::ANNOTATION
       end

data/lib/caliper/event/view_event.rb

@@ -25,6 +25,7 @@ module Caliper
     class ViewEvent < Event
 
       def initialize
+        super
         @type = EventType::VIEW
         @context = EventContext::VIEW
       end

data/lib/caliper/jsonable.rb

@@ -64,7 +64,8 @@ module Caliper
     end
 
     def eql?(other)
-      @sensorId == other.sensorId && @apiKey == other.apiKey
+      @context == other.context && @apiKey == other.apiKey
+      # @context == other.context && @sensorId == other.sensorId && @apiKey == other.apiKey
     end
   end
 end

data/lib/caliper/options.rb

@@ -20,18 +20,18 @@
 #
 module Caliper
   class Options
-    attr_accessor :api_key
     attr_accessor :host
-    attr_accessor :time_out
+    attr_accessor :api_key
+    attr_accessor :connection_request_time_out
+    attr_accessor :connection_time_out
+    attr_accessor :socket_time_out
   end
 
-	def initialize()
-		@host = Defaults.HOST
-		@time_out = Defaults.CONNECTION_TIMEOUT
-	end
-
-	def initialize(host, time_out)
-		@host = host
-		@time_out = time_out
-	end
+  def initialize(options = {})
+    self.host options[:host] || Defaults.HOST
+    self.api_key options[:api_key] || ''
+    self.connection_request_time_out options[:connection_request_time_out] || Defaults.CONNECTION_REQUEST_TIMEOUT
+    self.connection_time_out options[:connection_time_out] || Defaults.CONNECTION_TIMEOUT
+    self.socket_time_out options[:socket_time_out] || Defaults.SOCKET_TIMEOUT
+  end
 end

data/lib/caliper/request/{event_store_envelope.rb → envelope.rb}

@@ -15,13 +15,35 @@
 # 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 './envelope_jsonable'
+
 #
 # Event store envelope. Contains event info.
 #
 module Caliper
-	module Request
-		class EventStoreEnvelope
-			attr_accessor :id, :type, :time, :data
-		end
-	end
+  module Request
+    module Context
+      CONTEXT = "http://purl.imsglobal.org/caliper/ctx/v1/Envelope"
+    end
+
+    # module Type
+    #  TYPE = "http://purl.imsglobal.org/caliper/v1/Envelope"
+    # end
+
+    class Envelope
+      include Caliper::Request::EnvelopeJsonable
+
+      attr_accessor :context,
+                    :sensor,
+                    :sendTime,
+                    :data
+
+      def initialize
+        @context = Context::CONTEXT
+        @sensor = ''
+        @sendTime = Time.now.utc.iso8601(3)
+        @data = []
+      end
+    end
+  end
 end

data/lib/caliper/request/envelope_jsonable.rb

@@ -0,0 +1,69 @@
+##
+# 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 'json'
+
+#
+#  Module that supports ser-des for Caliper Envelope
+#
+module Caliper
+  module Request
+    module EnvelopeJsonable
+
+      def self.included(base)
+        base.extend ClassMethods
+      end
+
+      module ClassMethods
+      end
+
+      def to_json(*a)
+        # puts 'Jsonable: to_json invoked'
+        result = {}
+        result['@context'] = self.context
+        # result['@type'] = self.type
+        self.instance_variables.each do |key|
+          # puts "got key = #{key}"
+          next if (key[1..-1] == 'context')
+          # next if (key[1..-1] == 'context' || key[1..-1] == 'type')
+          value = self.instance_variable_get key
+          # puts "setting #{key}: #{value}"
+          result[key[1..-1]] = value
+        end
+        result.to_json(*a)
+      end
+
+      def from_json json_hash
+        data = json_hash
+        # puts "Jsonable: from_json: json_hash = #{json_hash}"
+        self.context = data['@context']
+        # self.type = data['@type']
+        json_hash.each do | key, value |
+          next if (key[1..-1] == 'context')
+          # next if (key[1..-1] == 'context' || key[1..-1] == 'type')
+          # puts "Jsonable - adding #{key} : #{value}"
+          self.instance_variable_set "@#{key}", value
+        end
+        return self
+      end
+
+      def eql?(other)
+        @context == other.context
+      end
+    end
+  end
+end

data/lib/caliper/request/event_store_requestor.rb

@@ -16,7 +16,7 @@
 # with this program. If not, see http://www.gnu.org/licenses/.
 
 require 'securerandom'
-require_relative './event_store_envelope'
+require_relative './envelope'
 
 #
 # Event store requestor.
@@ -25,36 +25,25 @@ module Caliper
   module Request
     class EventStoreRequestor
 
-      def get_payload_json(caliper_event, id, send_time)
-
-        list_payload = Array.new
-
-        # new event envelope
-        envelope = EventStoreEnvelope.new
-        envelope.id = id
-        envelope.type = "caliperEvent"
-        envelope.time = send_time.to_s
-        envelope.data = caliper_event
-
-        # add envelope into array
-        list_payload<< envelope
-
-        json_payload = JSON.generate(list_payload)
-        return json_payload
+      def generate_payload(sensor, data)
+        return get_payload_json(sensor, data)
       end
 
-      def generate_payload(caliper_event, id, send_time)
-        if (id.nil?)
-          id = "caliper-java_" + SecureRandom.uuid
-        end
-
-        if (send_time.nil?)
-          send_time = Time.now
-        end
+      def get_payload_json(sensor, data)
+        envelope = create_envelope(sensor, data)
+        return JSON.generate(envelope)
+      end
 
-        json_payload = get_payload_json(caliper_event, id, send_time)
+      def create_envelope(sensor, data)
+        envelope = Envelope.new
+        envelope.sensor = sensor.id
+        envelope.data = to_array(data)
+        return envelope
+      end
 
+      def to_array(data)
+        return [data] if !(data.is_a?(Array))
       end
     end
   end
-end
+end

data/lib/caliper/request/http_requestor.rb

@@ -15,10 +15,9 @@
 # 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 "net/http"
-require "uri"
+require 'rest-client'
+require_relative './envelope'
 require_relative './event_store_requestor'
-require_relative './event_store_envelope'
 
 module Caliper
 	module Request
@@ -28,34 +27,14 @@ module Caliper
 
 			def initialize(options)
 				@options = options
-			end
+      end
 
-			def send(event)
-				status = false
+      def send(sensor, data)
+        payload = generate_payload(sensor, data)
 
-				raise ArgumentError, "Expecting Caliper::Event but got #{event.class.to_s}" unless event.is_a?(Caliper::Event::Event)
-
-				envelope = EventEnvelope.new
-				envelope.apiKey = @options['apiKey']
-				envelope.sensorId = @options['sensorId']
-				envelope.event = event
-
-				RestClient.post @options['host'], envelope.to_json, :content_type => :json, :accept => :json
-
-
-				if (response.code != 200)
-					status_code = response.code
-
-					# failed call
-					status = false
-					fail "Failed: HTTP error code: " + status_code
-				else
-					# success call
-					status = true
-				end
-
-				return status
-			end
+        # What about the api key (authorization)?
+        RestClient.post @options['host'], payload, :content_type => :json, :accept => :json
+      end
 		end
 	end
 end

data/lib/caliper/sensor.rb

@@ -15,10 +15,9 @@
 # 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 "./event_envelope"
-require_relative "./entity_envelope"
+
+require_relative './options'
+require_relative './request/http_requestor'
 
 #
 # Caliper Sensor.
@@ -26,33 +25,23 @@ require_relative "./entity_envelope"
 module Caliper
   class Sensor
 
-    def initialize(options)
-      @options = options
-      puts "Sensor - initializing with options = #{@options}"
-    end
-
-    def send(event)
-      raise ArgumentError, "Expecting Caliper::Event but got #{event.class.to_s}" unless event.is_a?(Caliper::Event::Event)
-
-      envelope = EventEnvelope.new
-      envelope.apiKey = @options['apiKey']
-      envelope.sensorId = @options['sensorId']
-      envelope.event = event
-
-      RestClient.post @options['host'], envelope.to_json, :content_type => :json, :accept => :json
+    attr_accessor :id
 
+    def initialize(id, options)
+      @id = id
+      @options = options
     end
 
     def describe(entity)
       raise ArgumentError, "Expecting Caliper::Entity but got #{entity.class.to_s}" unless entity.is_a?(Caliper::Entities::Entity)
 
-      envelope = EntityEnvelope.new
-      envelope.apiKey = @options['apiKey']
-      envelope.sensorId = @options['sensorId']
-      envelope.entity = entity
+      HttpRequestor.new(@options).send(self, entity)
+    end
 
-      RestClient.post @options['host'], envelope.to_json, :content_type => :json, :accept => :json
+    def send(event)
+      raise ArgumentError, "Expecting Caliper::Event but got #{event.class.to_s}" unless event.is_a?(Caliper::Event::Event)
 
+      HttpRequestor.new(@options).send(self, event)
     end
   end
 end

data/lib/caliper/version.rb

@@ -19,5 +19,5 @@
 # Version.
 #
 module Caliper
-  VERSION = "0.9.1"
+  VERSION = "0.9.3"
 end

data/spec/lib/event/assessment_item_started_event_spec.rb

@@ -31,6 +31,7 @@ require_all 'lib/caliper/entities/assignable/attempt.rb'
 require_all 'lib/caliper/entities/assignable/assignable_digital_resource.rb'
 require_all 'lib/caliper/event/assessment_item_event.rb'
 require_all 'lib/caliper/profiles/assessment_item_profile.rb'
+require_all 'lib/caliper/profiles/assessment_profile.rb'
 require 'json_spec'
 
 module Caliper

data/spec/lib/event/session_event_login_spec.rb

@@ -25,10 +25,10 @@ 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/session/session.rb'
 require_all 'lib/caliper/event/session_event.rb'
 require_all 'lib/caliper/profiles/session_profile.rb'
-require_all 'lib/caliper/entities/reading/epub_volume.rb'
 require 'json_spec'
 
 module Caliper

data/spec/lib/request/http_requestor_spec.rb

@@ -0,0 +1,188 @@
+##
+# 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/roles.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/sensor.rb'
+require_all 'lib/caliper/request/http_requestor.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
+
+        # 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
+        action = Caliper::Profiles::ProfileActions::NAVIGATED_TO
+
+        # The Object navigated (ePub Volume)
+        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'
+
+        # The Target within the Object (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.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 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'
+        course.courseNumber = "POL101"
+        course.academicSession = "Fall-2015"
+        course.category = nil
+        course.membership = [membership2]
+        course.subOrganizationOf = courseOffering
+        course.dateCreated = '2015-08-01T06:00:00.000Z'
+        course.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.dateCreated = '2015-08-01T06:00:00.000Z'
+        group.dateModified = nil
+
+        # The navigatedFrom property (specific to Navigation Event)
+        fromPage = Caliper::Entities::Reading::WebPage.new
+        fromPage.id = 'https://some-university.edu/politicalScience/2015/american-revolution-101/index.html'
+        fromPage.name = 'American Revolution 101 Landing Page'
+        fromPage.dateCreated = '2015-08-01T06:00:00.000Z'
+        fromPage.dateModified = '2015-09-02T11:30:00.000Z'
+        fromPage.isPartOf = nil
+        fromPage.version = '1.0'
+
+        # The (Reading::BookmarkReading) Event
+        navigated_event = Caliper::Event::NavigationEvent.new
+        navigated_event.actor  = student
+        navigated_event.action = action
+        navigated_event.object = ePubVolume
+        navigated_event.target = frame
+        navigated_event.generated = nil
+        navigated_event.edApp  = edApp
+        navigated_event.group = group
+        navigated_event.navigatedFrom = fromPage
+        navigated_event.startedAtTime = '2015-09-15T10:15:00.000Z'
+        navigated_event.endedAtTime = nil
+        navigated_event.duration = nil
+        # puts "Event JSON = #{navigated_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, navigated_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
+        json_payload_sub.should 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

@@ -26,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',
-		    'apiKey' => '_-kJMcjiSymICwhUaHULbg'
-	    }
-
-	    sensor = Sensor.new options
-
-	    # 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/caliperNavigationEvent.json')
-	    data_hash = JSON.parse(file)
-	    # puts "JSON from file = #{data_hash}"
-	    deser_session_event = Caliper::Event::SessionEvent.new
-	    deser_session_event.from_json data_hash
-
-	    # 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_session_event
-
-	    p response
-
-
-	    # NOTE: To test sending events to an actual endpoint,
+      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.
       
       # 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.1
+  version: 0.9.3
 platform: ruby
 authors:
 - Caliper Dev Group
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-29 00:00:00.000000000 Z
+date: 2015-05-03 00:00:00.000000000 Z
 dependencies: []
 description: This is the implementation of IMSGlobal Caliper in Ruby
 email:
@@ -79,7 +79,6 @@ 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
@@ -91,7 +90,6 @@ files:
 - 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
@@ -102,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
@@ -137,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
@@ -183,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/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