ims_caliper 0.9.3.15 → 1.0.0

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

@@ -15,7 +15,8 @@
 # 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 '../entity'
+require_relative '../entity_base'
+require_relative '../entity_type'
 require_relative '../foaf/agent'
 require_relative '../schemadotorg/software_application'
 
@@ -25,13 +26,13 @@ require_relative '../schemadotorg/software_application'
 module Caliper
   module Entities
     module Agent
-      class SoftwareApplication < Entity
+      class SoftwareApplication < EntityBase
         include Caliper::Entities::FOAF::Agent,
                 Caliper::Entities::SchemaDotOrg::SoftwareApplication
 
         def initialize()
           super
-          @type=EntityType::SOFTWARE_APPLICATION
+          @type = Caliper::Entities::EntityType::SOFTWARE_APPLICATION
         end
       end
     end

data/lib/caliper/entities/annotation/annotation.rb

@@ -15,7 +15,8 @@
 # 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 '../entity'
+require_relative '../entity_base'
+require_relative '../entity_type'
 require_relative '../generatable'
 
 #
@@ -24,23 +25,14 @@ require_relative '../generatable'
 module Caliper
 	module Entities
 		module Annotation
-			module AnnotationType
-				ANNOTATION = "http://purl.imsglobal.org/caliper/v1/Annotation"
-				BOOKMARK_ANNOTATION = "http://purl.imsglobal.org/caliper/v1/BookmarkAnnotation"
-				HIGHLIGHT_ANNOTATION = "http://purl.imsglobal.org/caliper/v1/HighlightAnnotation"
-				SHARED_ANNOTATION = "http://purl.imsglobal.org/caliper/v1/SharedAnnotation"
-				TAG_ANNOTATION = "http://purl.imsglobal.org/caliper/v1/TagAnnotation"
-			end
-
-			## implement the interface Thing
-			class Annotation < Entity
+			class Annotation < EntityBase
 				include Caliper::Entities::Generatable
 
 				attr_accessor :annotated
 
 				def initialize
 					super
-					@type = AnnotationType::ANNOTATION
+					@type = Caliper::Entities::EntityType::ANNOTATION
 					@annotated = nil
 				end
 			end

data/lib/caliper/entities/annotation/annotation_type.rb

@@ -0,0 +1,32 @@
+##
+# 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/.
+
+#
+# Annotation types.
+#
+module Caliper
+  module Entities
+    module Annotation
+      module AnnotationType
+        BOOKMARK_ANNOTATION = "http://purl.imsglobal.org/caliper/v1/BookmarkAnnotation"
+        HIGHLIGHT_ANNOTATION = "http://purl.imsglobal.org/caliper/v1/HighlightAnnotation"
+        SHARED_ANNOTATION = "http://purl.imsglobal.org/caliper/v1/SharedAnnotation"
+        TAG_ANNOTATION = "http://purl.imsglobal.org/caliper/v1/TagAnnotation"
+      end
+    end
+  end
+end

data/lib/caliper/entities/annotation/bookmark_annotation.rb

@@ -16,6 +16,7 @@
 # with this program. If not, see http://www.gnu.org/licenses/.
 
 require_relative './annotation'
+require_relative './annotation_type'
 
 #
 #  Bookmark Annotation entity.
@@ -24,11 +25,12 @@ module Caliper
   module Entities
     module Annotation
       class BookmarkAnnotation < Annotation
+
         attr_accessor :bookmarkNotes
 
         def initialize
           super
-          @type = AnnotationType::BOOKMARK_ANNOTATION
+          @type = Caliper::Entities::Annotation::AnnotationType::BOOKMARK_ANNOTATION
           @bookmarkNotes = nil
         end
       end

data/lib/caliper/entities/annotation/highlight_annotation.rb

@@ -16,6 +16,7 @@
 # with this program. If not, see http://www.gnu.org/licenses/.
 
 require_relative './annotation'
+require_relative './annotation_type'
 
 #
 #  Highlight Annotation entity.
@@ -23,14 +24,13 @@ require_relative './annotation'
 module Caliper
   module Entities
     module Annotation
-
       class HighlightAnnotation < Annotation
-        attr_accessor :selectionText,
-                      :selection
+
+        attr_accessor :selectionText, :selection
 
         def initialize()
           super
-          @type = AnnotationType::HIGHLIGHT_ANNOTATION
+          @type = Caliper::Entities::Annotation::AnnotationType::HIGHLIGHT_ANNOTATION
           @selectionText = nil
           @selection = {}
         end

data/lib/caliper/entities/annotation/shared_annotation.rb

@@ -16,6 +16,7 @@
 # with this program. If not, see http://www.gnu.org/licenses/.
 
 require_relative './annotation'
+require_relative './annotation_type'
 
 #
 #  Shared Annotation entity.
@@ -24,11 +25,12 @@ module Caliper
   module Entities
     module Annotation
       class SharedAnnotation < Annotation
+
         attr_accessor :withAgents # list of Agent objects
 
         def initialize()
           super
-          @type = AnnotationType::SHARED_ANNOTATION
+          @type = Caliper::Entities::Annotation::AnnotationType::SHARED_ANNOTATION
 	        @withAgents = Array.new
         end
       end

data/lib/caliper/entities/annotation/tag_annotation.rb

@@ -16,6 +16,7 @@
 # with this program. If not, see http://www.gnu.org/licenses/.
 
 require_relative './annotation'
+require_relative './annotation_type'
 
 #
 #  Tag Annotation entity.
@@ -24,11 +25,12 @@ module Caliper
   module Entities
     module Annotation
       class TagAnnotation < Annotation
+
         attr_accessor :tags
 
         def initialize()
           super
-          @type = AnnotationType::TAG_ANNOTATION
+          @type = Caliper::Entities::Annotation::AnnotationType::TAG_ANNOTATION
           @tags = Array.new
         end
       end

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

@@ -16,7 +16,7 @@
 # with this program. If not, see http://www.gnu.org/licenses/.
 
 require_relative '../assignable/assignable_digital_resource'
-
+require_relative '../assignable/assignable_digital_resource_type'
 #
 # Assessment entity.
 #

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

@@ -16,6 +16,7 @@
 # with this program. If not, see http://www.gnu.org/licenses/.
 
 require_relative '../assignable/assignable_digital_resource'
+require_relative '../assignable/assignable_digital_resource_type'
 
 #
 # Assessment Item entity.
@@ -30,6 +31,7 @@ module Caliper
         def initialize
           super
           @type = Caliper::Entities::Assignable::AssignableDigitalResourceType::ASSESSMENT_ITEM
+          @isTimeDependent = false
         end
       end
     end

data/lib/caliper/entities/assignable/assignable_digital_resource.rb

@@ -16,6 +16,7 @@
 # with this program. If not, see http://www.gnu.org/licenses/.
 
 require_relative '../digital_resource'
+require_relative '../digital_resource_type'
 
 #
 # AssignableDigitalResource entity. AssignableDigitalResource's prototype is set to DigitalResource.
@@ -23,24 +24,13 @@ require_relative '../digital_resource'
 module Caliper
   module Entities
     module Assignable
-      module AssignableDigitalResourceType
-        ASSESSMENT = "http://purl.imsglobal.org/caliper/v1/Assessment"
-        ASSESSMENT_ITEM = "http://purl.imsglobal.org/caliper/v1/AssessmentItem"
-      end
-
       class AssignableDigitalResource < DigitalResource
 
-        attr_accessor :dateToActivate,
-          :dateToShow,
-          :dateToStartOn,
-          :dateToSubmit,
-          :maxAttempts,
-          :maxSubmits,
-          :maxScore
+        attr_accessor :dateToActivate, :dateToShow, :dateToStartOn, :dateToSubmit, :maxAttempts, :maxSubmits, :maxScore
 
         def initialize
           super
-          @type = DigitalResourceType::ASSIGNABLE_DIGITAL_RESOURCE
+          @type = Caliper::Entities::DigitalResourceType::ASSIGNABLE_DIGITAL_RESOURCE
           @dateToActivate = nil
           @dateToShow = nil
           @dateToStartOn = nil

data/lib/caliper/{event/session_event.rb → entities/assignable/assignable_digital_resource_type.rb}

@@ -15,20 +15,16 @@
 # 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'
-
 #
-# Session Event per the Caliper Session Profile.
+# Assignable types.
 #
 module Caliper
-  module Event
-    class SessionEvent < Event
-
-      def initialize
-        super
-        @context = Caliper::Event::EventContext::SESSION
-        @type = Caliper::Event::EventType::SESSION
+  module Entities
+    module Assignable
+      module AssignableDigitalResourceType
+        ASSESSMENT = "http://purl.imsglobal.org/caliper/v1/Assessment"
+        ASSESSMENT_ITEM = "http://purl.imsglobal.org/caliper/v1/AssessmentItem"
       end
     end
   end
-end
+end

data/lib/caliper/entities/assignable/attempt.rb

@@ -15,7 +15,8 @@
 # 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 '../entity'
+require_relative '../entity_base'
+require_relative '../entity_type'
 require_relative '../generatable'
 
 #
@@ -24,19 +25,17 @@ require_relative '../generatable'
 module Caliper
   module Entities
     module Assignable
-      class Attempt < Entity
+      class Attempt < EntityBase
         include Caliper::Entities::Generatable
 
-        attr_accessor :assignable,
-          :actor,
-          :count,
-          :startedAtTime,
-          :endedAtTime,
-          :duration
+        attr_accessor :assignable, :actor, :count, :startedAtTime, :endedAtTime, :duration
 
         def initialize
           super
-          @type = EntityType::ATTEMPT
+          @type = Caliper::Entities::EntityType::ATTEMPT
+          @startedAtTime = nil
+          @endedAtTime = nil
+          @duration = nil
         end
 
       end

data/lib/caliper/entities/digital_resource.rb

@@ -15,7 +15,8 @@
 # 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 './entity'
+require_relative './entity_base'
+require_relative './entity_type'
 require_relative './schemadotorg/creative_work'
 require_relative './targetable'
 
@@ -25,33 +26,15 @@ require_relative './targetable'
 #
 module Caliper
   module Entities
-    module DigitalResourceType
-      ASSIGNABLE_DIGITAL_RESOURCE = "http://purl.imsglobal.org/caliper/v1/AssignableDigitalResource"
-      EPUB_CHAPTER = "http://www.idpf.org/epub/vocab/structure/#chapter"
-      EPUB_PART = "http://www.idpf.org/epub/vocab/structure/#part"
-      EPUB_SUB_CHAPTER = "http://www.idpf.org/epub/vocab/structure/#subchapter"
-      EPUB_VOLUME = "http://www.idpf.org/epub/vocab/structure/#volume"
-      FRAME = "http://purl.imsglobal.org/caliper/v1/Frame"
-      MEDIA_LOCATION = "http://purl.imsglobal.org/caliper/v1/MediaLocation"
-      MEDIA_OBJECT = "http://purl.imsglobal.org/caliper/v1/MediaObject"
-      READING = "http://www.idpf.org/epub/vocab/structure"
-      WEB_PAGE = "http://purl.imsglobal.org/caliper/v1/WebPage"
-    end
-
-    class DigitalResource < Entity
+    class DigitalResource < EntityBase
       include Caliper::Entities::SchemaDotOrg::CreativeWork,
               Caliper::Entities::Targetable
 
-      attr_accessor :objectType,
-                    :alignedLearningObjective,
-                    :keywords,
-                    :isPartOf,
-                    :datePublished,
-                    :version
+      attr_accessor :objectType, :alignedLearningObjective, :keywords, :isPartOf, :datePublished, :version
 
       def initialize
         super
-        @type = EntityType::DIGITAL_RESOURCE
+        @type = Caliper::Entities::EntityType::DIGITAL_RESOURCE
         @alignedLearningObjective = Array.new
         @objectType = Array.new
         @keywords = Array.new

data/lib/caliper/entities/digital_resource_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 Entities
+    module DigitalResourceType
+      ASSIGNABLE_DIGITAL_RESOURCE = "http://purl.imsglobal.org/caliper/v1/AssignableDigitalResource"
+      EPUB_CHAPTER = "http://www.idpf.org/epub/vocab/structure/#chapter"
+      EPUB_PART = "http://www.idpf.org/epub/vocab/structure/#part"
+      EPUB_SUB_CHAPTER = "http://www.idpf.org/epub/vocab/structure/#subchapter"
+      EPUB_VOLUME = "http://www.idpf.org/epub/vocab/structure/#volume"
+      FRAME = "http://purl.imsglobal.org/caliper/v1/Frame"
+      MEDIA_LOCATION = "http://purl.imsglobal.org/caliper/v1/MediaLocation"
+      MEDIA_OBJECT = "http://purl.imsglobal.org/caliper/v1/MediaObject"
+      READING = "http://purl.imsglobal.org/caliper/v1/Reading"
+      WEB_PAGE = "http://purl.imsglobal.org/caliper/v1/WebPage"
+    end
+  end
+end

data/lib/caliper/entities/entity.rb

@@ -17,6 +17,8 @@
 
 require 'time'
 require 'json'
+require_relative './entity_type'
+require_relative '../context/context'
 require_relative './schemadotorg/thing'
 require_relative './jsonable'
 
@@ -25,47 +27,15 @@ require_relative './jsonable'
 #
 module Caliper
   module Entities
-    module EntityType
-      AGENT = "http://purl.imsglobal.org/caliper/v1/Agent"
-      ATTEMPT = "http://purl.imsglobal.org/caliper/v1/Attempt"
-      COURSE_OFFERING = "http://purl.imsglobal.org/caliper/v1/lis/CourseOffering"
-      COURSE_SECTION = "http://purl.imsglobal.org/caliper/v1/lis/CourseSection"
-      DIGITAL_RESOURCE = "http://purl.imsglobal.org/caliper/v1/DigitalResource"
-      ENTITY = "http://purl.imsglobal.org/caliper/v1/Entity"
-      GENERATED = "http://purl.imsglobal.org/caliper/v1/Generated"
-      GROUP = "http://purl.imsglobal.org/caliper/v1/lis/Group"
-      LEARNING_OBJECTIVE = "http://purl.imsglobal.org/caliper/v1/LearningObjective"
-      MEMBERSHIP = "http://purl.imsglobal.org/caliper/v1/lis/Membership"
-      ORGANIZATION = "http://purl.imsglobal.org/caliper/v1/w3c/Organization"
-      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"
-      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"
-      VIEW = "http://purl.imsglobal.org/caliper/v1/View"
-    end
-
     class Entity
-      include Caliper::Entities::SchemaDotOrg::Thing,
-              Caliper::Entities::Jsonable
+      include Caliper::Entities::SchemaDotOrg::Thing, Caliper::Entities::Jsonable
 
-      attr_accessor :id,
-        :type,
-        :name,
-        :description,
-        :extensions,
-        :dateCreated,
-        :dateModified
+      attr_accessor :context, :id, :type
 
       def initialize()
-        @id = ""
-        @type = EntityType::ENTITY
-        @name = nil
-        @description = nil
-        @extensions = {}
-        @dateCreated = Time.now.utc.iso8601(3)
-        @dateModified = Time.now.utc.iso8601(3)
+        @context = Caliper::Context::Context::CONTEXT
+        @id = nil
+        @type = Caliper::Entities::EntityType::ENTITY
       end
     end
   end