ims_caliper 0.1.1 → 0.1.2

data/lib/caliper/event/annotation_event.rb

@@ -1,13 +1,17 @@
+require_relative 'event'
+require_relative '../profiles/annotation_profile'
+
 module Caliper
   module Event
+
+    #
+    # Annotation Event per Caliper Annotation Profile
+    #
     class AnnotationEvent < Event
-      attr_accessor :location
 
-      def initialize(action)
-        @context = "http://purl.imsglobal.org/ctx/caliper/v1/AnnotationEvent"
-		    @type = "http://purl.imsglobal.org/caliper/v1/AnnotationEvent"
-        # only subclasses should be instantiated
-        @action = action
+      def initialize
+        @context = Caliper::Event::EventContext::ANNOTATION
+        @type = Caliper::Event::EventType::ANNOTATION
       end
     end
   end

data/lib/caliper/event/assessment_event.rb

@@ -0,0 +1,19 @@
+require_relative 'event'
+
+module Caliper
+  module Event
+    class AssessmentEvent < Event
+      attr_accessor :context,
+        :type,
+        :action,
+        :object,
+        :target
+
+      def initialize
+        super
+        @context = EventContext::ASSESSMENT
+        @type = EventType::ASSESSMENT
+      end
+    end
+  end
+end

data/lib/caliper/event/assessment_item_event.rb

@@ -0,0 +1,19 @@
+require_relative 'event'
+
+module Caliper
+  module Event
+    class AssessmentItemEvent < Event
+      attr_accessor :context,
+        :type,
+        :action,
+        :object,
+        :target
+
+      def initialize
+        super
+        @context = EventContext::ASSESSMENT_ITEM
+        @type = EventType::ASSESSMENT_ITEM
+      end
+    end
+  end
+end

data/lib/caliper/event/assignable_event.rb

@@ -0,0 +1,19 @@
+require_relative 'event'
+
+module Caliper
+  module Event
+    class AssignableEvent < Event
+      attr_accessor :context,
+        :type,
+        :action,
+        :object,
+        :target
+
+      def initialize
+        super
+        @context = EventContext::ASSIGNABLE
+        @type = EventType::ASSIGNABLE
+      end
+    end
+  end
+end

data/lib/caliper/event/event.rb

@@ -1,68 +1,88 @@
+require 'json'
+require_relative './jsonable'
+
 module Caliper
   module Event
-	  module EventContext
-		  ANNOTATION = "http://purl.imsglobal.org/ctx/caliper/v1/AnnotationEvent"
-		  ASSESSMENT = "http://purl.imsglobal.org/ctx/caliper/v1/AssessmentEvent"
-		  ASSESSMENT_ITEM = "http://purl.imsglobal.org/ctx/caliper/v1/AssessmentItemEvent"
-		  ASSIGNABLE = "http://purl.imsglobal.org/ctx/caliper/v1/AssignableEvent"
-		  EVENT = "http://purl.imsglobal.org/ctx/caliper/v1/Event"
-		  MEDIA = "http://purl.imsglobal.org/ctx/caliper/v1/MediaEvent"
-		  NAVIGATION = "http://purl.imsglobal.org/ctx/caliper/v1/NavigationEvent"
-		  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"
-	  end
-	  module EventType
-		  ANNOTATION = "http://purl.imsglobal.org/caliper/v1/AnnotationEvent"
-		  ASSESSMENT = "http://purl.imsglobal.org/caliper/v1/AssessmentEvent"
-		  ASSESSMENT_ITEM = "http://purl.imsglobal.org/caliper/v1/AssessmentItemEvent"
-		  ASSIGNABLE = "http://purl.imsglobal.org/caliper/v1/AssignableEvent"
-		  EVENT = "http://purl.imsglobal.org/caliper/v1/Event"
-		  MEDIA = "http://purl.imsglobal.org/caliper/v1/MediaEvent"
-		  NAVIGATION = "http://purl.imsglobal.org/caliper/v1/NavigationEvent"
-		  OUTCOME = "http://purl.imsglobal.org/caliper/v1/OutcomeEvent"
-		  SESSION = "http://purl.imsglobal.org/caliper/v1/SessionEvent"
-		  VIEW = "http://purl.imsglobal.org/caliper/v1/ViewEvent"
-	  end
+    module EventContext
+      ANNOTATION = "http://purl.imsglobal.org/ctx/caliper/v1/AnnotationEvent"
+      ASSESSMENT = "http://purl.imsglobal.org/ctx/caliper/v1/AssessmentEvent"
+      ASSESSMENT_ITEM = "http://purl.imsglobal.org/ctx/caliper/v1/AssessmentItemEvent"
+      ASSIGNABLE = "http://purl.imsglobal.org/ctx/caliper/v1/AssignableEvent"
+      EVENT = "http://purl.imsglobal.org/ctx/caliper/v1/Event"
+      MEDIA = "http://purl.imsglobal.org/ctx/caliper/v1/MediaEvent"
+      NAVIGATION = "http://purl.imsglobal.org/ctx/caliper/v1/NavigationEvent"
+      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"
+    end
+    module EventType
+      ANNOTATION = "http://purl.imsglobal.org/caliper/v1/AnnotationEvent"
+      ASSESSMENT = "http://purl.imsglobal.org/caliper/v1/AssessmentEvent"
+      ASSESSMENT_ITEM = "http://purl.imsglobal.org/caliper/v1/AssessmentItemEvent"
+      ASSIGNABLE = "http://purl.imsglobal.org/caliper/v1/AssignableEvent"
+      EVENT = "http://purl.imsglobal.org/caliper/v1/Event"
+      MEDIA = "http://purl.imsglobal.org/caliper/v1/MediaEvent"
+      NAVIGATION = "http://purl.imsglobal.org/caliper/v1/NavigationEvent"
+      OUTCOME = "http://purl.imsglobal.org/caliper/v1/OutcomeEvent"
+      SESSION = "http://purl.imsglobal.org/caliper/v1/SessionEvent"
+      VIEW = "http://purl.imsglobal.org/caliper/v1/ViewEvent"
+    end
     class Event
+      include Caliper::Event::Jsonable
+
       attr_accessor :context, # String Required - the JSON-LD context for the Event
 
-							      # Required - the type of the Event
-							      :type, # String
+        # Required - the type of the Event
+        :type, # String
+
+        # Learning Context
+        :edApp,  # SoftwareApplication
 
-							      # Learning Context
-							      :ed_app,  # SoftwareApplication
+        # LIS Group
+        :group, # Group
 
-							      # LIS organization
-							      :lis_organization, # Organization
+        # Required - Agent (User, System) that performed the action
+        :actor, # Agent
 
-							      # Required - Agent (User, System) that performed the action
-							      :actor, # Agent
+        # Required - Action performed by Agent From Metric Profile
+        :action, # String
 
-							      # Required - Action performed by Agent From Metric Profile
-							      :action, # String
+        # Required - "Activity Context" from Metric Profile
+        :object, # Object
 
-							      # Required - "Activity Context" from Metric Profile
-							      :object, # Object
+        # Optional - "target" from Metric Profile
+        :target, # Targetable
 
-							      # Optional - "target" from Metric Profile
-							      :target, # Targetable
+        # Optional - entity "generated" as result of action - from Metric Profile
+        :generated, # Generatable
 
-							      # Optional - entity "generated" as result of action - from Metric Profile
-							      :generated, # Generatable
+        # Required time that the event was started at
+        :startedAtTime, # ISO-8601 date string
 
-							      # Required time in milliseconds that the event was started at
-							      :started_at_time, # long
+        # An optional time that the event ended at
+        :endedAtTime, # ISO-8601 date string
 
-							      # An optional time in milliseconds that the event ended at
-							      :ended_at_time, # long
+        # An xsd:duration (http://books.xmlschemata.org/relaxng/ch19-77073.html)
+        # The 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
 
-							      # An xsd:duration (http://books.xmlschemata.org/relaxng/ch19-77073.html)
-							      # The 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
+      def initialize()
+        @context = EventContext::EVENT
+        @type = EventType::EVENT
+        @actor = nil
+        @action = nil
+        @object = nil
+        @target = nil
+        @generated = nil
+        @edApp = nil
+        @group = nil
+        @startedAtTime = Time.now.utc.iso8601(3)
+        @endedAtTime = nil
+        @duration = nil
+      end
     end
   end
 end

data/lib/caliper/event/jsonable.rb

@@ -0,0 +1,55 @@
+require 'json'
+
+#
+#  
+#  @copyright @copyright ©2013 IMS Global Learning Consortium, Inc.  All Rights Reserved.
+#  @license For license information contact, info@imsglobal.org
+#
+#  Module that supports ser-des for Caliper Event/JSON
+#
+module Caliper
+  module Event
+    module Jsonable
+
+      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' || 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' || 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 && @type == other.type && @startedAtTime == other.startedAtTime && @endedAtTime == other.endedAtTime
+      end
+
+    end
+  end
+end

data/lib/caliper/event/navigation_event.rb

@@ -5,18 +5,13 @@ module Caliper
   module Event
     class NavigationEvent < Event
 
-      attr_accessor :context,
-                    :type,
-                    :action,
-                    :object,
-                    :from_resource, #the resource from which the navigation starts
-                    :target
+      attr_accessor :navigatedFrom
 
       def initialize
 	      super
 	      @context = EventContext::NAVIGATION
 	      @type = EventType::NAVIGATION
-	      @action = Caliper::Profiles::ProfileActions::NAVIGATED_TO
+        @navigatedFrom = nil
       end
     end
   end

data/lib/caliper/event/outcome_event.rb

@@ -1,5 +1,5 @@
 require_relative 'event'
-require_relative '../profiles/profile_actions'
+require_relative '../profiles/profile'
 
 module Caliper
   module Event

data/lib/caliper/event/session_event.rb

@@ -2,20 +2,19 @@ require_relative 'event'
 require_relative '../profiles/session_profile'
 
 module Caliper
-	module Event
-		class SessionEvent < Event
+  module Event
+    
+    class SessionEvent < Event
 
-			# Utilize builder to construct SessionEvent.  Validate Session object copy rather than the
-			# Session builder.  This approach protects the class against parameter changes from another
-			# thread during the "window of vulnerability" between the time the parameters are checked
-			# until when they are copied.  Validate properties of builder copy and if conformance violations
-			# are found throw an IllegalStateException (Bloch, Effective Java, 2nd ed., items 2, 39, 60, 63).
-			def initialize
-				super
-				@context = Caliper::Event::EventContext::SESSION
-				@type = Caliper::Event::EventType::SESSION
-			end
+      #
+      # Session Event per the Caliper Session Profile
+      # 
+      def initialize
+        super
+        @context = Caliper::Event::EventContext::SESSION
+        @type = Caliper::Event::EventType::SESSION
+      end
 
-		end
-	end
+    end
+  end
 end

data/lib/caliper/event/view_event.rb

@@ -1,20 +1,19 @@
 require_relative 'event'
-require_relative '../profiles/reading_profile_key'
+require_relative '../profiles/reading_profile.rb'
 
 module Caliper
   module Event
+
     class ViewEvent < Event
-      attr_accessor :context,
-                    :type,
-                    :action,
-                    :object,
-                    :target
 
+      #
+      # Viewed Event per the Caliper Base Profile
+      #
       def initialize
         @type = EventType::VIEW
-        @action = ReadingProfileKey::VIEWED
         @context = EventContext::VIEW
       end
+
     end
   end
 end

data/lib/caliper/event_envelope.rb

@@ -0,0 +1,22 @@
+require 'rest_client'
+require_relative "options"
+require_relative 'jsonable'
+
+##
+#
+#  @copyright @copyright ©2013 IMS Global Learning Consortium, Inc.  All Rights Reserved.
+#  @license For license information contact, info@imsglobal.org
+#
+# Caliper Sensor Event Envelope
+#
+#
+module Caliper
+
+  class EventEnvelope
+    include Caliper::Jsonable
+
+    attr_accessor :apiKey,
+      :sensorId,
+      :event
+  end
+end

data/lib/caliper/jsonable.rb

@@ -0,0 +1,53 @@
+require 'json'
+
+#
+#
+#  @copyright @copyright ©2013 IMS Global Learning Consortium, Inc.  All Rights Reserved.
+#  @license For license information contact, info@imsglobal.org
+#
+#  Module that supports ser-des for Caliper Envelope
+#
+module Caliper
+  module Jsonable
+
+    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' || 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' || key[1..-1] == 'type')
+        # puts "Jsonable - adding #{key} : #{value}"
+        self.instance_variable_set "@#{key}", value
+      end
+      return self
+    end
+
+    def eql?(other)
+      @sensorId == other.sensorId && @apiKey == other.apiKey
+    end
+
+  end
+end