ims_caliper 0.9.3.14 → 0.9.3.15

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    YTFiNGQxYTJkOTcyNzBkZjAwNWVkZGNhN2UxNTg0YWRhM2ZkOTYxYQ==
-  data.tar.gz: !binary |-
-    Yjk4ZmU4Njg0YzQwMDdhYmJmYTA0YmRiZWRhMWM0Mjk3NmVmODBhNw==
+SHA1:
+  metadata.gz: d787d10711e9df110e47808696cc7320a4d38fac
+  data.tar.gz: 829240aa1cfbc63aa8738b15f12f460da5f9b83a
 SHA512:
-  metadata.gz: !binary |-
-    MWYwZjFmZGRhNDc2YmRhZDNhNjFkODY1MGIxZDgzOWI2ZTA3NTk4OTA1YzBj
-    ZTRiMTAxNmIyN2NjNDc2YjYxM2NjZWE1ZDM2OWRhM2IyYmYzZGVkMmI0M2Vl
-    YWNkYTIyOGEwYmJlM2U2N2EwN2I2YjQwZDc0Y2I4ZWExYzY4MjY=
-  data.tar.gz: !binary |-
-    MmZlOWU2ZTIyMjM1YzM0ZWEyMWVmMTg4MDViMTg4OWI1NzkzYWU5NDY5MzQx
-    ODg5NDEzMTA0Yjc1ZTE1Zjk0ZTM3ZjFiNjVkMzQ5ZjIwZjRlZDc4NjJjZjE1
-    NDYxNGUyODNkNzRlYWViZmFlYTJhZTYwODhiMmRjYzY4N2ExZTQ=
+  metadata.gz: 241b1e7dd90b7cb2fe680f1c4de7ef53576d4d3b1694593ed44c64116d4c7f9a7bc95804f3b231ac8f855b9e51d3025736923238ac47f2eb1df9d4ed02cebde9
+  data.tar.gz: 15fc41e4d02518ac66a10f7f1f790846377c7a8769f02b0d3bad81ec4d19ffb7397f25f8be2a4a06b9d001d5ebb866dd19a236144e7d9293321944ee95d366f7

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

@@ -25,10 +25,10 @@ module Caliper
   module Entities
     module Agent
       class Organization < Entity
-        include Caliper::Entities::W3C::Organization
+        include Caliper::Entities::FOAF::Agent,
+                Caliper::Entities::W3C::Organization
 
-        attr_accessor :membership,
-                      :subOrganizationOf
+        attr_accessor :subOrganizationOf
 
         def initialize
           super

data/lib/caliper/entities/assessment/assessment.rb

@@ -25,8 +25,6 @@ module Caliper
     module Assessment
       class Assessment < Caliper::Entities::Assignable::AssignableDigitalResource
 
-        attr_accessor :assessmentItems
-
         def initialize
           super
           @type = Caliper::Entities::Assignable::AssignableDigitalResourceType::ASSESSMENT

data/lib/caliper/entities/entity.rb

@@ -40,7 +40,6 @@ module Caliper
       PERSON = "http://purl.imsglobal.org/caliper/v1/lis/Person"
       RESPONSE = "http://purl.imsglobal.org/caliper/v1/Response"
       RESULT = "http://purl.imsglobal.org/caliper/v1/Result"
-      PREDICTED_GRADE = "http://purl.imsglobal.org/caliper/v1/PredictedGrade"
       SESSION = "http://purl.imsglobal.org/caliper/v1/Session"
       SOFTWARE_APPLICATION = "http://purl.imsglobal.org/caliper/v1/SoftwareApplication"
       TARGET = "http://purl.imsglobal.org/caliper/v1/Target"

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

@@ -24,7 +24,7 @@ module Caliper
   module Entities
 	  module FOAF
       module Agent
-      	attr_accessor :hasMembership # Membership
+
       end
     end
   end

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

@@ -29,7 +29,6 @@ module Caliper
 
         attr_accessor :courseNumber,
                       :academicSession,
-                      :membership,
                       :subOrganizationOf
         def initialize
           super

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

@@ -27,8 +27,7 @@ module Caliper
       class Group < Entity
         include Caliper::Entities::W3C::Organization
 
-        attr_accessor :membership,
-                      :subOrganizationOf
+        attr_accessor :subOrganizationOf
 
         def initialize
           super

data/lib/caliper/entities/lis/{roles.rb → role.rb}

@@ -21,7 +21,7 @@
 module Caliper
   module Entities
     module LIS
-      module Roles
+      module Role
         LEARNER = 'http://purl.imsglobal.org/vocab/lis/v2/membership#Learner'
         EXTERNAL_LEARNER = 'http://purl.imsglobal.org/vocab/lis/v2/membership/Learner#ExternalLearner'
         GUEST_LEARNER = 'http://purl.imsglobal.org/vocab/lis/v2/membership/Learner#GuestLearner'

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

@@ -35,10 +35,10 @@ module Caliper
 										:curve_factor,
 										:comment,
 										:scored_by
+		end
 
-			def initialize
-
-			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/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/event.rb

@@ -34,7 +34,6 @@ module Caliper
       OUTCOME = "http://purl.imsglobal.org/ctx/caliper/v1/OutcomeEvent"
       SESSION = "http://purl.imsglobal.org/ctx/caliper/v1/SessionEvent"
       VIEW = "http://purl.imsglobal.org/ctx/caliper/v1/ViewEvent"
-	    GRADE_PREDICT = "http://purl.imsglobal.org/ctx/caliper/v1/GradePredictEvent"
     end
 
     module EventType
@@ -46,7 +45,6 @@ module Caliper
       MEDIA = "http://purl.imsglobal.org/caliper/v1/MediaEvent"
       NAVIGATION = "http://purl.imsglobal.org/caliper/v1/NavigationEvent"
       OUTCOME = "http://purl.imsglobal.org/caliper/v1/OutcomeEvent"
-      GRADE_PREDICT = "http://purl.imsglobal.org/caliper/v1/GradePredictEvent"
       SESSION = "http://purl.imsglobal.org/caliper/v1/SessionEvent"
       VIEW = "http://purl.imsglobal.org/caliper/v1/ViewEvent"
     end
@@ -57,41 +55,44 @@ module Caliper
       attr_accessor :context, # String Required - the JSON-LD context for the Event
 
         # Required - the type of the Event
-        :type, # String
-
-        # Learning Context
-        :edApp,  # SoftwareApplication
-
-        # LIS Group
-        :group, # Group
+        :type,
 
         # Required - Agent (User, System) that performed the action
-        :actor, # Agent
+        :actor,
 
-        # Required - Action performed by Agent From Metric Profile
-        :action, # String
+        # Required - Action performed by Agent From Metric Profile (String)
+        :action,
 
-        # Required - "Activity Context" from Metric Profile
-        :object, # Object
+        # Required - Object
+        :object,
 
-        # Optional - "target" from Metric Profile
-        :target, # Targetable
+        # Optional - Targeted object (Targetable)
+        :target,
 
-        # Optional - entity "generated" as result of action - from Metric Profile
-        :generated, # Generatable
+        # Optional - Generated object (Generatable)
+        :generated,
 
-        # Required time that the event was started at
-        :startedAtTime, # ISO-8601 date string
+        # Required time that the event was started at (ISO-8601 date string)
+        :startedAtTime,
 
-        # An optional time that the event ended at
-        :endedAtTime, # ISO-8601 date string
+        # An optional time that the event ended at (ISO-8601 date string)
+        :endedAtTime,
 
         # An xsd:duration (http://books.xmlschemata.org/relaxng/ch19-77073.html)
-        # The format is expected to be PnYnMnDTnHnMnS
+        # The String format is expected to be PnYnMnDTnHnMnS
         # Valid values include PT1004199059S, PT130S, PT2M10S, P1DT2S, -P1Y, or P1Y2M3DT5H20M30.123S.
         # The following values are invalid: 1Y (leading P is missing), P1S (T separator is missing),
         # P-1Y (all parts must be positive), P1M2Y (parts order is significant and Y must precede M)                                                                                                * or P1Y-1M (all parts must be positive).                                                                               */
-        :duration # String
+        :duration,
+
+        # edApp
+        :edApp,
+
+        # Group
+        :group,
+
+        # Membership
+        :membership
 
       def initialize()
         @context = EventContext::EVENT
@@ -101,11 +102,12 @@ module Caliper
         @object = nil
         @target = nil
         @generated = nil
-        @edApp = nil
-        @group = nil
         @startedAtTime = Time.now.utc.iso8601(3)
         @endedAtTime = nil
         @duration = nil
+        @edApp = nil
+        @group = nil
+        @membership = nil
       end
     end
   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/profiles/assessment_profile.rb

@@ -27,7 +27,6 @@ module Caliper
       RESTARTED = "http://purl.imsglobal.org/vocab/caliper/v1/action#Restarted"
       STARTED = "http://purl.imsglobal.org/vocab/caliper/v1/action#Started"
       SUBMITTED = "http://purl.imsglobal.org/vocab/caliper/v1/action#Submitted"
-	    GRADED = "http://purl.imsglobal.org/vocab/caliper/v1/action#Graded"
     end
 
     class AssessmentProfile < Caliper::Profiles::Profile

data/lib/caliper/{event/grade_predict_event.rb → request/envelope.rb}

@@ -15,24 +15,34 @@
 # 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 './event'
+require_relative './envelope_jsonable'
 
 #
-# GradePredictEvent Event.
+# Event store envelope. Contains event info.
 #
 module Caliper
-  module Event
-    class GradePredictEvent < Event
+  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,
-                    :type,
-                    :action,
-                    :object,
-                    :generated
+                    :sensor,
+                    :sendTime,
+                    :data
 
       def initialize
-	      super
-	      @context = EventContext::GRADE_PREDICT
-	      @type = EventType::GRADE_PREDICT
+        @context = Context::CONTEXT
+        @sensor = ''
+        @sendTime = Time.now.utc.iso8601(3)
+        @data = []
       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,32 +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)
 
-				# the option.host returns whole url string
-				uri = URI(@options.host)
-				Net::HTTP.start(uri.host, uri.port) do |http|
-					request = Net::HTTP::Post.new uri
-
-					response = http.request request # Net::HTTPResponse object
-				end
-
-				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.3.14"
+  VERSION = "0.9.3.15"
 end

data/spec/lib/entities/agent/person_spec.rb

@@ -43,7 +43,7 @@ module Caliper
           file = File.read('spec/lib/entities/agent/student.json')
           data_hash = JSON.parse(file)
           expected_json = data_hash.to_json # convert hash back to JSON string after parse
-          student.to_json.should be_json_eql(expected_json)
+          expect(student.to_json).to be_json_eql(expected_json)
 
           des_student = Person.new
           des_student.from_json data_hash

data/spec/lib/entities/entity_spec.rb

@@ -39,7 +39,7 @@ module Caliper
         file = File.read('spec/lib/entities/entity.json')
         data_hash = JSON.parse(file)
         expected_json = data_hash.to_json # convert hash back to JSON string after parse
-        entity.to_json.should be_json_eql(expected_json)#.excluding("@class")
+        expect(entity.to_json).to be_json_eql(expected_json)#.excluding("@class")
 
         # Compare Deserialized JSON to desired Entity
         des_entity = Entity.new