ims_caliper 0.1.1

data/lib/caliper/entities/learning_context.rb

@@ -0,0 +1,21 @@
+require "json"
+require_relative 'entity'
+require_relative 'software_application'
+require_relative 'lis/organization'
+require_relative 'foaf/agent'
+
+module Caliper
+  module Entities
+    class LearningContext < Entity
+	    attr_accessor :ed_app, # SoftwareApplication educational app
+                    :lis_organization, # Organization the LIS organization
+	                  :agent # Agent the agent, since the Agent module is empty for now, use Entity type
+	    def initialize
+		    super
+		    @ed_app = SoftwareApplication.new
+		    @lis_organization = Caliper::Entities::LIS::Organization.new
+		    @agent = Caliper::Entities::Entity.new
+	    end
+	  end
+  end
+end

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

@@ -0,0 +1,18 @@
+require_relative './organization'
+
+module Caliper
+	module Entities
+		module LIS
+			class CourseSection < Caliper::Entities::LIS::Organization
+				attr_accessor :type,
+			                :semester,
+			                :course_number,
+			                :label
+				def initialize
+					super
+					@type = OrganizationType::LIS_COURSE_SECTION
+				end
+			end
+		end
+	end
+end

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

@@ -0,0 +1,22 @@
+require_relative '../../entities/foaf/agent'
+require_relative '../../entities/entity'
+
+module Caliper
+	module Entities
+		module LIS
+			module OrganizationType
+				LIS_COURSE_SECTION = "http://purl.imsglobal.org/caliper/v1/lis/CourseSection"
+			end
+			class Organization < Entity
+				include Caliper::Entities::FOAF::Agent
+				attr_accessor :type, # String
+											:parent_org # Organization
+
+				def initialize
+					super
+					@type = EntityType::LIS_ORGANIZATION
+				end
+			end
+		end
+	end
+end

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

@@ -0,0 +1,12 @@
+require_relative '../../entities/entity'
+
+module Caliper
+	module Entities
+		module LIS
+			class Person < Entity
+				include Caliper::Entities::FOAF::Agent
+				attr_accessor :type # String
+			end
+		end
+	end
+end

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

@@ -0,0 +1,23 @@
+require_relative '../entity'
+require_relative '../generatable'
+module Caliper
+	module Entities
+		class Result < Entity
+			include Generatable
+
+			attr_accessor :type, # String
+										:normal_score,
+										:penalty_score,
+										:extra_credit_score,
+										:total_score,
+										:curved_total_score,
+										:curve_factor,
+										:comment,
+										:scored_by
+		end
+
+		def initialize
+
+		end
+	end
+end

data/lib/caliper/entities/reading/epub_chapter.rb

@@ -0,0 +1,20 @@
+require_relative "../digital_resource"
+
+# Public: Representation of an EPUB 3 Chapter.
+#
+# A major structural division of a piece of writing
+# http://www.idpf.org/epub/vocab/structure/#chapter
+
+module Caliper
+  module Entities
+    module Reading
+      class EpubChapter < DigitalResource
+        def initialize()
+	        super
+          @id = id
+          @type = DigitalResourceType::EPUB_CHAPTER
+        end
+      end
+    end
+  end
+end

data/lib/caliper/entities/reading/epub_part.rb

@@ -0,0 +1,20 @@
+# Public: Representation of an EPUB 3 Part
+# A major structural division of a piece of writing, typically
+# encapsulating a set of related chapters.
+# http://www.idpf.org/epub/vocab/structure/#part
+
+require_relative "../digital_resource"
+
+module Caliper
+  module Entities
+    module Reading
+      class EpubPart < ::Caliper::Entity::DigitalResource
+        def initialize()
+	        super
+          @id = ""
+          @type = DigitalResourceType::EPUB_PART
+        end
+      end
+    end
+  end
+end

data/lib/caliper/entities/reading/epub_sub_chapter.rb

@@ -0,0 +1,20 @@
+# Public: Representation of an EPUB 3 subchapter
+# A major sub-division of a chapter
+# http://www.idpf.org/epub/vocab/structure/#subchapter
+
+require_relative "../digital_resource"
+
+module Caliper
+  module Entities
+    module Reading
+      class EpubSubChapter < Caliper::Entities::DigitalResource
+        def initialize()
+	        super
+          @id = ""
+          @type = DigitalResourceType::EPUB_SUB_CHAPTER
+        end
+      end
+    end
+  end
+end
+

data/lib/caliper/entities/reading/epub_volume.rb

@@ -0,0 +1,20 @@
+# Public: Representation of an EPUB 3 Volume
+# A component of a collection
+# http://www.idpf.org/epub/vocab/structure/#volume
+
+require_relative '../digital_resource'
+require_relative '../entity'
+
+module Caliper
+  module Entities
+    module Reading
+      class EpubVolume < Caliper::Entities::DigitalResource
+        def initialize()
+	        super
+          @id = ""
+          @type = DigitalResourceType::EPUB_VOLUME
+        end
+      end
+    end
+  end
+end

data/lib/caliper/entities/reading/frame.rb

@@ -0,0 +1,32 @@
+require_relative '../digital_resource'
+require_relative '../targetable'
+
+module Caliper
+	module Entities
+		module Reading
+			class Frame < DigitalResource
+				include Targetable
+
+				attr_accessor :id,
+			                :type,
+			                :name,
+			                :description,
+			                :object_type,
+			                :aligned_learning_objective,
+			                :keywords,
+			                :is_part_of,
+			                :properties,
+			                :date_created,
+			                :date_modified,
+			                :date_published,
+			                :index
+
+				def initialize
+					super
+					@type = DigitalResourceType::FRAME
+				end
+
+			end
+		end
+	end
+end

data/lib/caliper/entities/schemadotorg/audio_object.rb

@@ -0,0 +1,15 @@
+require_relative 'media_object'
+
+# https://schema.org/AudioObject
+#
+# An audio object embedded in a web page.
+
+module Caliper
+	module Entities
+		module SchemaDotOrg
+			module AudioObject
+				include MediaObject
+			end
+		end
+	end
+end

data/lib/caliper/entities/schemadotorg/creative_work.rb

@@ -0,0 +1,12 @@
+require_relative 'thing'
+# The most generic kind of creative work, including books, movies,
+# photographs, software programs, etc
+module Caliper
+	module Entities
+		module SchemaDotOrg
+			module CreativeWork
+				include Thing
+			end
+		end
+	end
+end

data/lib/caliper/entities/schemadotorg/image_object.rb

@@ -0,0 +1,15 @@
+require_relative 'media_object'
+
+# https://schema.org/ImageObject
+#
+# An image object embedded in a web page.
+
+module Caliper
+	module Entities
+		module SchemaDotOrg
+			module ImageObject
+				include MediaObject
+			end
+		end
+	end
+end

data/lib/caliper/entities/schemadotorg/media_object.rb

@@ -0,0 +1,19 @@
+require_relative 'creative_work'
+
+# An image, video, or audio object embedded in a web page. Note that a
+# creative work may have many media objects associated with it on the
+# same web page. For example, a page about a single song (MusicRecording)
+# may have a music video (VideoObject), and a high and low bandwidth audio
+# stream (2 AudioObject's).
+#
+# From https://schema.org/MediaObject
+
+module Caliper
+	module Entities
+		module SchemaDotOrg
+			module MediaObject
+				include CreativeWork
+			end
+		end
+	end
+end

data/lib/caliper/entities/schemadotorg/software_application.rb

@@ -0,0 +1,11 @@
+require_relative 'creative_work'
+
+module Caliper
+	module Entities
+		module SchemaDotOrg
+			module SoftwareApplication
+				include CreativeWork
+			end
+		end
+	end
+end

data/lib/caliper/entities/schemadotorg/thing.rb

@@ -0,0 +1,9 @@
+# the most generic type of item
+module Caliper
+	module Entities
+		module SchemaDotOrg
+			module Thing
+			end
+		end
+	end
+end

data/lib/caliper/entities/schemadotorg/video_object.rb

@@ -0,0 +1,15 @@
+require_relative 'media_object'
+
+# https://schema.org/VideoObject
+#
+# A video object embedded in a web page..
+
+module Caliper
+	module Entities
+		module SchemaDotOrg
+			module VideoObject
+				include MediaObject
+			end
+		end
+	end
+end

data/lib/caliper/entities/schemadotorg/web_page.rb

@@ -0,0 +1,11 @@
+require_relative "creative_work"
+
+module Caliper
+	module Entities
+		module SchemaDotOrg
+			module WebPage
+				include CreativeWork
+			end
+		end
+	end
+end

data/lib/caliper/entities/session.rb

@@ -0,0 +1,26 @@
+
+require_relative 'entity'
+require_relative 'generatable'
+require_relative 'targetable'
+
+
+module Caliper
+	module Entities
+		class Session < Entity
+			include Generatable
+			include Targetable
+
+			attr_accessor :type, # String
+			              :actor, # Agent
+										:started_at_time,
+										:ended_at_time,
+										:duration # String
+
+			def initialize
+				super
+				@type = EntityType::SESSION
+			end
+
+		end
+	end
+end

data/lib/caliper/entities/software_application.rb

@@ -0,0 +1,19 @@
+require "json"
+require_relative '../entities/entity'
+require_relative '../entities/foaf/agent'
+require_relative '../entities/schemadotorg/software_application'
+
+module Caliper
+  module Entities
+    class SoftwareApplication < Entity
+	    include Caliper::Entities::FOAF::Agent
+	    include Caliper::Entities::SchemaDotOrg::SoftwareApplication
+
+	    attr_accessor :type
+
+	    def initialize()
+				@type=EntityType::SOFTWARE_APPLICATION
+	    end
+    end
+  end
+end

data/lib/caliper/entities/targetable.rb

@@ -0,0 +1,12 @@
+
+# The targetable interface marks an object type that provides coordinates to a target destination
+# required by certain actions.  The interface allows Caliper to catch errors at compile time for
+# instances of the marked class rather than at runtime if a marker annotation was defined instead.
+
+module Caliper
+	module Entities
+		module Targetable
+
+		end
+	end
+end

data/lib/caliper/entities/web_page.rb

@@ -0,0 +1,13 @@
+require_relative "../entities/digital_resource"
+require_relative "../entities/schemadotorg/web_page"
+module Caliper
+	module Entities
+		class WebPage < DigitalResource
+			include Caliper::Entities::SchemaDotOrg::WebPage
+			def initialize()
+				super
+				@type = Caliper::Entities::DigitalResourceType::WEB_PAGE
+			end
+		end
+	end
+end

data/lib/caliper/event/annotation_event.rb

@@ -0,0 +1,14 @@
+module Caliper
+  module Event
+    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
+      end
+    end
+  end
+end

data/lib/caliper/event/event.rb

@@ -0,0 +1,68 @@
+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
+    class Event
+      attr_accessor :context, # String Required - the JSON-LD context for the Event
+
+							      # Required - the type of the Event
+							      :type, # String
+
+							      # Learning Context
+							      :ed_app,  # SoftwareApplication
+
+							      # LIS organization
+							      :lis_organization, # Organization
+
+							      # Required - Agent (User, System) that performed the action
+							      :actor, # Agent
+
+							      # Required - Action performed by Agent From Metric Profile
+							      :action, # String
+
+							      # Required - "Activity Context" from Metric Profile
+							      :object, # Object
+
+							      # Optional - "target" from Metric Profile
+							      :target, # Targetable
+
+							      # Optional - entity "generated" as result of action - from Metric Profile
+							      :generated, # Generatable
+
+							      # Required time in milliseconds that the event was started at
+							      :started_at_time, # long
+
+							      # 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
+    end
+  end
+end

data/lib/caliper/event/media_event.rb

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

data/lib/caliper/event/navigation_event.rb

@@ -0,0 +1,23 @@
+require_relative 'event'
+require_relative '../profiles/profile'
+
+module Caliper
+  module Event
+    class NavigationEvent < Event
+
+      attr_accessor :context,
+                    :type,
+                    :action,
+                    :object,
+                    :from_resource, #the resource from which the navigation starts
+                    :target
+
+      def initialize
+	      super
+	      @context = EventContext::NAVIGATION
+	      @type = EventType::NAVIGATION
+	      @action = Caliper::Profiles::ProfileActions::NAVIGATED_TO
+      end
+    end
+  end
+end

data/lib/caliper/event/outcome_event.rb

@@ -0,0 +1,20 @@
+require_relative 'event'
+require_relative '../profiles/profile_actions'
+
+module Caliper
+  module Event
+    class OutcomeEvent < Event
+      attr_accessor :context,
+                    :type,
+                    :action,
+                    :object,
+                    :generated
+
+      def initialize
+	      super
+	      @context = EventContext::OUTCOME
+	      @type = EventType::OUTCOME
+      end
+    end
+  end
+end

data/lib/caliper/event/session_event.rb

@@ -0,0 +1,21 @@
+require_relative 'event'
+require_relative '../profiles/session_profile'
+
+module Caliper
+	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
+
+		end
+	end
+end

data/lib/caliper/event/view_event.rb

@@ -0,0 +1,20 @@
+require_relative 'event'
+require_relative '../profiles/reading_profile_key'
+
+module Caliper
+  module Event
+    class ViewEvent < Event
+      attr_accessor :context,
+                    :type,
+                    :action,
+                    :object,
+                    :target
+
+      def initialize
+        @type = EventType::VIEW
+        @action = ReadingProfileKey::VIEWED
+        @context = EventContext::VIEW
+      end
+    end
+  end
+end

data/lib/caliper/options.rb

@@ -0,0 +1,18 @@
+module Caliper
+  class Options
+    attr_accessor :api_key
+    attr_accessor :host
+    attr_accessor :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
+
+end