ims_caliper 0.9.3.15 → 1.0.0

data/lib/caliper/entities/{learning_context.rb → entity_base.rb}

@@ -15,28 +15,32 @@
 # 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 'time'
+require 'json'
 require_relative './entity'
-require_relative './agent/software_application'
-require_relative './agent/organization'
-require_relative './foaf/agent'
+require_relative './entity_type'
+require_relative '../context/context'
+require_relative './schemadotorg/thing'
+require_relative './jsonable'
 
 #
-# Learning Context.
+#  The base Caliper Entity.  Analogous to a schema.org Thing.
 #
 module Caliper
   module Entities
-    class LearningContext < Entity
+    class EntityBase < Entity
+      include Caliper::Entities::SchemaDotOrg::Thing, Caliper::Entities::Jsonable
 
-	    attr_accessor :ed_app, # SoftwareApplication educational app
-                    :group, # W3C Organization
-	                  :agent # Agent the agent, since the Agent module is empty for now, use Entity type
+      attr_accessor :name, :description, :extensions, :dateCreated, :dateModified
 
-	    def initialize
-		    super
-		    @ed_app = Caliper::Entities::Agent::SoftwareApplication.new
-		    @group = Caliper::Entities::Agent::Organization.new
-		    @agent = Caliper::Entities::Entity.new
-	    end
-	  end
+      def initialize()
+        super
+        @name = nil
+        @description = nil
+        @extensions = {}
+        @dateCreated = nil
+        @dateModified = nil
+      end
+    end
   end
 end

data/lib/caliper/entities/entity_type.rb

@@ -0,0 +1,39 @@
+##
+# 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 EntityType
+      ANNOTATION = "http://purl.imsglobal.org/caliper/v1/Annotation"
+      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"
+      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"
+      VIEW = "http://purl.imsglobal.org/caliper/v1/View"
+    end
+  end
+end

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

@@ -15,8 +15,6 @@
 # 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'
-
 #
 # An agent (eg. person, group, software or physical artifact). See http://xmlns.com/foaf/spec/#term_Agent.
 #

data/lib/caliper/entities/jsonable.rb

@@ -16,6 +16,7 @@
 # with this program. If not, see http://www.gnu.org/licenses/.
 
 require 'json'
+require_relative './entity_type'
 
 #
 #  Module that supports ser-des for Caliper Entities/JSON
@@ -34,26 +35,36 @@ module Caliper
       def to_json(*a)
         # puts 'Jsonable: to_json invoked'
         result = {}
+        result['@context'] = self.context
         result['@id'] = self.id
         result['@type'] = self.type
         self.instance_variables.each do |key|
           # puts "got key = #{key}"
-          next if (key[1..-1] == 'id' || key[1..-1] == 'type')
+          next if (key[1..-1] == 'context' || key[1..-1] == 'id' || key[1..-1] == 'type')
           value = self.instance_variable_get key
           # puts "setting #{key}: #{value}"
           result[key[1..-1]] = value
         end
+
+        # Filter out context for generic entities
+        # A more generalized approach will be required for 1.1 to filter out all nulls/empties)
+        if (result['@context'].nil?)
+          #if (result['@type'] == Caliper::Entities::EntityType::ENTITY && result['@context'].nil?)
+          result.delete('@context')
+        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.id = data['@id']
         self.type = data['@type']
         self.name = data['name']
         json_hash.each do | key, value |
-          next if (key[1..-1] == 'id' || key[1..-1] == 'type')
+          next if (key[1..-1] == 'context' || key[1..-1] == 'id' || key[1..-1] == 'type')
           # puts "Jsonable - adding #{key} : #{value}"
           self.instance_variable_set "@#{key}", value
         end
@@ -61,7 +72,7 @@ module Caliper
       end
 
       def eql?(other)
-        @id == other.id && @type == other.type && @name == other.name && @description == other.description && @dateCreated == other.dateCreated && @dateModified == other.dateModified
+        @context == other.context && @id == other.id && @type == other.type && @name == other.name && @description == other.description && @dateCreated == other.dateCreated && @dateModified == other.dateModified
       end
     end
   end

data/lib/caliper/entities/learning_objective.rb

@@ -15,18 +15,19 @@
 # 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'
 
 #
 #  Learning Objective
 #
 module Caliper
   module Entities
-    class LearningObjective < Entity
+    class LearningObjective < EntityBase
 
       def initialize
         super
-        @type = EntityType::LEARNING_OBJECTIVE
+        @type = Caliper::Entities::EntityType::LEARNING_OBJECTIVE
       end
     end
   end

data/lib/caliper/entities/lis/course_offering.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 '../w3c/organization'
 
 #
@@ -24,15 +25,17 @@ require_relative '../w3c/organization'
 module Caliper
   module Entities
     module LIS
-      class CourseOffering < Entity
+      class CourseOffering < EntityBase
         include Caliper::Entities::W3C::Organization
 
-        attr_accessor :courseNumber,
-                      :academicSession,
-                      :subOrganizationOf
+        attr_accessor :courseNumber, :academicSession, :subOrganizationOf
+
         def initialize
           super
-          @type = EntityType::COURSE_OFFERING
+          @type = Caliper::Entities::EntityType::COURSE_OFFERING
+          @courseNumber = nil
+          @academicSession = nil
+          @subOrganizationOf = nil
         end
       end
     end

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

@@ -16,6 +16,7 @@
 # with this program. If not, see http://www.gnu.org/licenses/.
 
 require_relative './course_offering'
+require_relative '../entity_type'
 
 #
 #  LIS Course Section.
@@ -29,7 +30,8 @@ module Caliper
 
         def initialize
           super
-          @type = EntityType::COURSE_SECTION
+          @type = Caliper::Entities::EntityType::COURSE_SECTION
+          @category = nil
         end
       end
     end

data/lib/caliper/entities/lis/group.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 '../w3c/organization'
 
 #
@@ -24,14 +25,15 @@ require_relative '../w3c/organization'
 module Caliper
   module Entities
     module LIS
-      class Group < Entity
+      class Group < EntityBase
         include Caliper::Entities::W3C::Organization
 
         attr_accessor :subOrganizationOf
 
         def initialize
           super
-          @type = EntityType::GROUP
+          @type = Caliper::Entities::EntityType::GROUP
+          @subOrganizationOf = nil
         end
       end
     end

data/lib/caliper/entities/lis/membership.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 '../w3c/membership'
 
 #
@@ -24,17 +25,14 @@ require_relative '../w3c/membership'
 module Caliper
   module Entities
     module LIS
-      class Membership < Entity
+      class Membership < EntityBase
         include Caliper::Entities::W3C::Membership
 
-        attr_accessor :member,
-                      :organization,
-                      :roles,
-                      :status
+        attr_accessor :member, :organization, :roles, :status
 
         def initialize
           super
-          @type = EntityType::MEMBERSHIP
+          @type = Caliper::Entities::EntityType::MEMBERSHIP
         end
 
       end

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

@@ -16,6 +16,7 @@
 # with this program. If not, see http://www.gnu.org/licenses/.
 
 require_relative './media_object'
+require_relative './media_object_type'
 
 #
 # Audio object embedded in a web page.  See https://schema.org/AudioObject
@@ -27,7 +28,7 @@ module Caliper
 
         def initialize
           super
-          @type = MediaType::AUDIO_OBJECT
+          @type = Caliper::Entities::Media::MediaObjectType::AUDIO_OBJECT
         end
       end
     end

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

@@ -16,6 +16,7 @@
 # with this program. If not, see http://www.gnu.org/licenses/.
 
 require_relative './media_object'
+require_relative './media_object_type'
 
 #
 # A image object embedded in a web page.  See https://schema.org/ImageObject
@@ -27,7 +28,7 @@ module Caliper
 
         def initialize
           super
-          @type = MediaType::IMAGE_OBJECT
+          @type = Caliper::Entities::Media::MediaObjectType::IMAGE_OBJECT
         end
       end
     end

data/lib/caliper/entities/media/media_location.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'
 
 #
 # A time based location within a media object.
@@ -29,7 +30,7 @@ module Caliper
 
         def initialize
           super
-          @type = DigitalResourceType::MEDIA_LOCATION
+          @type = Caliper::Entities::DigitalResourceType::MEDIA_LOCATION
           @currentTime = nil
         end
       end

data/lib/caliper/entities/media/media_object.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'
 
 # 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
@@ -26,21 +27,13 @@ require_relative '../digital_resource'
 module Caliper
   module Entities
     module Media
-      module MediaType
-        AUDIO_OBJECT = 'http://purl.imsglobal.org/caliper/v1/AudioObject'
-        IMAGE_OBJECT = 'http://purl.imsglobal.org/caliper/v1/ImageObject'
-        VIDEO_OBJECT = 'http://purl.imsglobal.org/caliper/v1/VideoObject'
-        MEDIA_LOCATION = 'http://purl.imsglobal.org/caliper/v1/MediaLocation'
-      end
-
-      ## implement the interface Thing
       class MediaObject < DigitalResource
 
         attr_accessor :duration
 
         def initialize
           super
-          @type = DigitalResourceType::MEDIA_OBJECT
+          @type = Caliper::Entities::DigitalResourceType::MEDIA_OBJECT
           @duration = nil
         end
       end

data/lib/caliper/entities/media/media_object_type.rb

@@ -0,0 +1,31 @@
+##
+# 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/.
+
+#
+# Media Object types.
+#
+module Caliper
+  module Entities
+    module Media
+      module MediaObjectType
+        AUDIO_OBJECT = 'http://purl.imsglobal.org/caliper/v1/AudioObject'
+        IMAGE_OBJECT = 'http://purl.imsglobal.org/caliper/v1/ImageObject'
+        VIDEO_OBJECT = 'http://purl.imsglobal.org/caliper/v1/VideoObject'
+      end
+    end
+  end
+end

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

@@ -16,6 +16,7 @@
 # with this program. If not, see http://www.gnu.org/licenses/.
 
 require_relative './media_object'
+require_relative './media_object_type'
 
 #
 # A video object embedded in a web page.  See https://schema.org/VideoObject.
@@ -27,7 +28,7 @@ module Caliper
 
         def initialize
           super
-          @type = MediaType::VIDEO_OBJECT
+          @type = Caliper::Entities::Media::MediaObjectType::VIDEO_OBJECT
         end
       end
     end

data/lib/caliper/entities/outcome/result.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'
 
 #
@@ -23,22 +24,28 @@ require_relative '../generatable'
 #
 module Caliper
 	module Entities
-		class Result < Entity
-			include Caliper::Entities::Generatable
+    module Outcome
+      class Result < EntityBase
+        include Caliper::Entities::Generatable
 
-			attr_accessor :type, # String
-										:normal_score,
-										:penalty_score,
-										:extra_credit_score,
-										:total_score,
-										:curved_total_score,
-										:curve_factor,
-										:comment,
-										:scored_by
-		end
+        attr_accessor :assignable, :actor, :normalScore, :penaltyScore, :extraCreditScore,
+                      :totalScore, :curvedTotalScore, :curveFactor, :comment, :scoredBy
 
-		def initialize
-			super
-		end
+        def initialize
+          super
+          @type = Caliper::Entities::EntityType::RESULT
+          @assignable = nil
+          @actor = nil
+          @normalScore = nil
+          @penaltyScore = nil
+          @extraCreditScore = nil
+          @totalScore = nil
+          @curvedTotalScore = nil
+          @curveFactor = nil
+          @comment = nil
+          @scoredBy = nil
+        end
+      end
+    end
 	end
 end