ims_caliper 0.9.3.15 → 1.0.0

data/lib/caliper/events/event_context.rb

@@ -0,0 +1,24 @@
+##
+# 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/.
+
+module Caliper
+  module Events
+    module EventContext
+      attr_accessor :target, :generated, :edApp, :group, :membership, :federatedSession
+    end
+  end
+end

data/lib/caliper/events/event_type.rb

@@ -0,0 +1,33 @@
+##
+# 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/.
+
+module Caliper
+  module Events
+    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
+  end
+end

data/lib/caliper/{event → events}/jsonable.rb

@@ -21,7 +21,7 @@ require 'json'
 #  Module that supports ser-des for Caliper Event/JSON
 #
 module Caliper
-  module Event
+  module Events
     module Jsonable
 
       def self.included(base)
@@ -60,7 +60,7 @@ module Caliper
       end
 
       def eql?(other)
-        @context == other.context && @type == other.type && @startedAtTime == other.startedAtTime && @endedAtTime == other.endedAtTime
+        @context == other.context && @type == other.type && @eventTime == other.eventTime
       end
     end
   end

data/lib/caliper/{event → events}/media_event.rb

@@ -16,23 +16,26 @@
 # with this program. If not, see http://www.gnu.org/licenses/.
 
 require_relative './event'
+require_relative './event_context'
+require_relative './event_type'
 
 #
 # Media Event.
 #
 module Caliper
-  module Event
+  module Events
     class MediaEvent < Event
-      attr_accessor :context,
-                    :type,
-                    :action,
-                    :object,
-                    :target
+      include Caliper::Events::EventContext
 
       def initialize
 	      super
-	      @context = EventContext::MEDIA
-	      @type = EventType::MEDIA
+	      @type = Caliper::Events::EventType::MEDIA
+        @target = nil
+        @generated = nil
+        @edApp = nil
+        @group = nil
+        @membership = nil
+        @federatedSession = nil
       end
     end
   end

data/lib/caliper/events/navigation_event.rb

@@ -0,0 +1,47 @@
+##
+# 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 '../actions/navigation_actions.rb'
+require_relative './event'
+require_relative './event_context'
+require_relative './event_type'
+
+#
+# Navigation Event.
+#
+module Caliper
+  module Events
+    class NavigationEvent < Event
+      include Caliper::Events::EventContext
+
+      attr_accessor :navigatedFrom
+
+      def initialize
+	      super
+	      @type = Caliper::Events::EventType::NAVIGATION
+        @action = Caliper::Actions::NavigationActions::NAVIGATED_TO
+        @navigatedFrom = nil
+        @target = nil
+        @generated = nil
+        @edApp = nil
+        @group = nil
+        @membership = nil
+        @federatedSession = nil
+      end
+    end
+  end
+end

data/lib/caliper/events/outcome_event.rb

@@ -0,0 +1,44 @@
+##
+# 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 '../actions/outcome_actions.rb'
+require_relative './event'
+require_relative './event_context'
+require_relative './event_type'
+
+#
+# Outcome Event.
+#
+module Caliper
+  module Events
+    class OutcomeEvent < Event
+      include Caliper::Events::EventContext
+
+      def initialize
+	      super
+	      @type = Caliper::Events::EventType::OUTCOME
+        @action = Caliper::Actions::OutcomeActions::GRADED
+        @target = nil
+        @generated = nil
+        @edApp = nil
+        @group = nil
+        @membership = nil
+        @federatedSession = nil
+      end
+    end
+  end
+end

data/lib/caliper/{event/outcome_event.rb → events/reading_event.rb}

@@ -16,23 +16,26 @@
 # with this program. If not, see http://www.gnu.org/licenses/.
 
 require_relative './event'
+require_relative './event_context'
+require_relative './event_type'
 
 #
 # Outcome Event.
 #
 module Caliper
-  module Event
-    class OutcomeEvent < Event
-      attr_accessor :context,
-                    :type,
-                    :action,
-                    :object,
-                    :generated
+  module Events
+    class ReadingEvent < Event
+      include Caliper::Events::EventContext
 
       def initialize
-	      super
-	      @context = EventContext::OUTCOME
-	      @type = EventType::OUTCOME
+        super
+        @type = Caliper::Events::EventType::READING
+        @target = nil
+        @generated = nil
+        @edApp = nil
+        @group = nil
+        @membership = nil
+        @federatedSession = nil
       end
     end
   end

data/lib/caliper/events/session_event.rb

@@ -0,0 +1,42 @@
+##
+# 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 './event'
+require_relative './event_context'
+require_relative './event_type'
+
+#
+# Session Event per the Caliper Session Profile.
+#
+module Caliper
+  module Events
+    class SessionEvent < Event
+      include Caliper::Events::EventContext
+
+      def initialize
+        super
+        @type = Caliper::Events::EventType::SESSION
+        @target = nil
+        @generated = nil
+        @edApp = nil
+        @group = nil
+        @membership = nil
+        @federatedSession = nil
+      end
+    end
+  end
+end

data/lib/caliper/events/view_event.rb

@@ -0,0 +1,44 @@
+##
+# 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 '../actions/reading_actions.rb'
+require_relative './event'
+require_relative './event_context'
+require_relative './event_type'
+
+#
+# View Event per the Caliper Base Profile.
+#
+module Caliper
+  module Events
+    class ViewEvent < Event
+      include Caliper::Events::EventContext
+
+      def initialize
+        super
+        @type = Caliper::Events::EventType::VIEW
+        @action = Caliper::Actions::ReadingActions::VIEWED
+        @target = nil
+        @generated = nil
+        @edApp = nil
+        @group = nil
+        @membership = nil
+        @federatedSession = nil
+      end
+    end
+  end
+end

data/lib/caliper/request/envelope.rb

@@ -15,31 +15,20 @@
 # 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'
+require 'json'
+require_relative './jsonable'
 
 #
 # Event store envelope. Contains event info.
 #
 module Caliper
   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
+      include Caliper::Request::Jsonable
 
-      attr_accessor :context,
-                    :sensor,
-                    :sendTime,
-                    :data
+      attr_accessor :sensor, :sendTime, :data
 
       def initialize
-        @context = Context::CONTEXT
         @sensor = ''
         @sendTime = Time.now.utc.iso8601(3)
         @data = []

data/lib/caliper/request/event_store_requestor.rb

@@ -35,7 +35,7 @@ module Caliper
       end
 
       def create_envelope(sensor, data)
-        envelope = Envelope.new
+        envelope = Caliper::Request::Envelope.new
         envelope.sensor = sensor.id
         envelope.data = to_array(data)
         return envelope

data/lib/caliper/request/{envelope_jsonable.rb → jsonable.rb}

@@ -18,11 +18,11 @@
 require 'json'
 
 #
-#  Module that supports ser-des for Caliper Envelope
+#  Module that supports ser-des for Caliper Event/JSON
 #
 module Caliper
   module Request
-    module EnvelopeJsonable
+    module Jsonable
 
       def self.included(base)
         base.extend ClassMethods
@@ -34,12 +34,11 @@ module Caliper
       def to_json(*a)
         # puts 'Jsonable: to_json invoked'
         result = {}
-        result['@context'] = self.context
-        # result['@type'] = self.type
+        #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')
+          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
@@ -50,11 +49,10 @@ module Caliper
       def from_json json_hash
         data = json_hash
         # puts "Jsonable: from_json: json_hash = #{json_hash}"
-        self.context = data['@context']
-        # self.type = data['@type']
+        #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')
+          next if (key[1..-1] == 'context' || key[1..-1] == 'type')
           # puts "Jsonable - adding #{key} : #{value}"
           self.instance_variable_set "@#{key}", value
         end
@@ -62,7 +60,7 @@ module Caliper
       end
 
       def eql?(other)
-        @context == other.context
+        @sensor == other.sensor && @sendTime == other.sendTime && @data == other.data
       end
     end
   end

data/lib/caliper/sensor.rb

@@ -39,7 +39,7 @@ module Caliper
     end
 
     def send(event)
-      raise ArgumentError, "Expecting Caliper::Event but got #{event.class.to_s}" unless event.is_a?(Caliper::Event::Event)
+      raise ArgumentError, "Expecting Caliper::Event but got #{event.class.to_s}" unless event.is_a?(Caliper::Events::Event)
 
       HttpRequestor.new(@options).send(self, event)
     end