ims_caliper 0.1.1 → 0.1.2

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

@@ -1,16 +1,26 @@
 require_relative 'annotation'
 
+#
+#  
+#  @copyright @copyright ©2013 IMS Global Learning Consortium, Inc.  All Rights Reserved.
+#  @license For license information contact, info@imsglobal.org
+#
+#
+#  Bookmark Annotation Entity
+#
 module Caliper
   module Entities
     module Annotation
-      class Bookmark < Annotation
-        attr_accessor :type,
-                      :bookmark_notes
 
-        def initialize(action)
+      class BookmarkAnnotation < Annotation
+        attr_accessor :bookmarkNotes
+
+        def initialize
           super
           @type = AnnotationType::BOOKMARK_ANNOTATION
+          @bookmarkNotes = nil
         end
+
       end
     end
   end

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

@@ -1,17 +1,28 @@
 require_relative 'annotation'
 
+#
+#
+#  @copyright @copyright ©2013 IMS Global Learning Consortium, Inc.  All Rights Reserved.
+#  @license For license information contact, info@imsglobal.org
+#
+#
+#  Hilight Annotation Entity
+#
 module Caliper
   module Entities
     module Annotation
+
       class HighlightAnnotation < Annotation
-        attr_accessor :type,
-                      :bookmark_notes
+        attr_accessor :selectionText,
+          :selection
 
         def initialize()
           super
           @type = AnnotationType::HIGHLIGHT_ANNOTATION
-          @bookmark_notes = ''
+          @selectionText = nil
+          @selection = {}
         end
+
       end
     end
   end

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

@@ -1,17 +1,26 @@
 require_relative 'annotation'
 
+#
+#  
+#  @copyright @copyright ©2013 IMS Global Learning Consortium, Inc.  All Rights Reserved.
+#  @license For license information contact, info@imsglobal.org
+#
+#
+#  Shared Annotation Entity
+#
 module Caliper
   module Entities
     module Annotation
+
       class SharedAnnotation < Annotation
-        attr_accessor :with_agents, # list of Agent object
-                      :type
+        attr_accessor :withAgents # list of Agent objects
 
         def initialize()
           super
           @type = AnnotationType::SHARED_ANNOTATION
-	        @with_agents = ''
+	        @withAgents = Array.new
         end
+        
       end
     end
   end

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

@@ -1,16 +1,26 @@
-require_relative 'Annotation'
+require_relative 'annotation'
 
+#
+#  
+#  @copyright @copyright ©2013 IMS Global Learning Consortium, Inc.  All Rights Reserved.
+#  @license For license information contact, info@imsglobal.org
+#
+#
+#  Tag Annotation Entity
+#
 module Caliper
   module Entities
     module Annotation
+
       class TagAnnotation < Annotation
-        attr_accessor :type,
-                      :tags
+        attr_accessor :tags
 
         def initialize()
           super
           @type = AnnotationType::TAG_ANNOTATION
+          @tags = Array.new
         end
+        
       end
     end
   end

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

@@ -0,0 +1,27 @@
+require_relative '../../entities/assignable/assignable_digital_resource'
+
+#
+#
+#  @copyright @copyright ©2013 IMS Global Learning Consortium, Inc.  All Rights Reserved.
+#  @license For license information contact, info@imsglobal.org
+#
+# Represents an Assessment
+#
+
+module Caliper
+  module Entities
+    module Assessment
+
+      class Assessment < Caliper::Entities::Assignable::AssignableDigitalResource
+
+        attr_accessor :assessmentItems
+
+        def initialize
+          super
+          @type = Caliper::Entities::Assignable::AssignableDigitalResourceType::ASSESSMENT
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+require_relative '../../entities/assignable/assignable_digital_resource'
+
+#
+#  @copyright @copyright ©2013 IMS Global Learning Consortium, Inc.  All Rights Reserved.
+#  @license For license information contact, info@imsglobal.org
+#
+# Represents an Assessment Item.
+#
+
+module Caliper
+  module Entities
+    module Assessment
+
+      class AssessmentItem < Caliper::Entities::Assignable::AssignableDigitalResource
+
+        attr_accessor :isTimeDependent
+
+        def initialize
+          super
+          @type = Caliper::Entities::Assignable::AssignableDigitalResourceType::ASSESSMENT_ITEM
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,47 @@
+require_relative '../../entities/digital_resource'
+require_relative '../../entities/schemadotorg/thing'
+
+#
+#  @copyright @copyright ©2013 IMS Global Learning Consortium, Inc.  All Rights Reserved.
+#  @license For license information contact, info@imsglobal.org
+#
+# Represents AssignableDigitalResource.
+# AssignableDigitalResource's prototype set to DigitalResource
+#
+
+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
+        include Caliper::Entities::SchemaDotOrg::Thing
+
+        attr_accessor :dateToActivate,
+          :dateToShow,
+          :dateToStartOn,
+          :dateToSubmit,
+          :maxAttempts,
+          :maxSubmits,
+          :maxScore
+
+        def initialize
+          super
+          @type = DigitalResourceType::ASSIGNABLE_DIGITAL_RESOURCE
+          @dateToActivate = nil
+          @dateToShow = nil
+          @dateToStartOn = nil
+          @dateToSubmit = nil
+          @maxAttempts = nil
+          @maxSubmits = nil
+          @maxScore = nil
+        end
+
+     end
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+require_relative '../../entities/entity'
+
+#
+#  @copyright @copyright ©2013 IMS Global Learning Consortium, Inc.  All Rights Reserved.
+#  @license For license information contact, info@imsglobal.org
+#
+#
+#  Represents an Attempt on an Assignable
+#
+module Caliper
+  module Entities
+    module Assignable
+
+      class Attempt < Entity
+
+        attr_accessor :assignable,
+          :actor,
+          :count,
+          :startedAtTime,
+          :endedAtTime,
+          :duration
+
+        def initialize
+          super
+          @type = EntityType::ATTEMPT
+        end
+
+      end
+
+    end
+  end
+end

data/lib/caliper/entities/digital_resource.rb

@@ -1,52 +1,53 @@
 require "json"
 require_relative 'entity'
 
+#
+#  
+#  @copyright @copyright ©2013 IMS Global Learning Consortium, Inc.  All Rights Reserved.
+#  @license For license information contact, info@imsglobal.org
+#
 # Public: Caliper representation of a CreativeWork (https://schema.org/CreativeWork)
 # We add learning specific attributes, including a list of
 # LearningObjective learning objectives and a list of
 # String keywords
 #
-# Examples
-#
-
 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
+
+    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
-	    attr_accessor :type,
-	                  :object_types, # list of String
-	                  :learning_objectives, # a list of learning objectives
-	                  :keywords,
-	                  :is_part_of,
-	                  :date_published
+      include Caliper::Entities::Jsonable
+
+      attr_accessor :objectType,
+        :alignedLearningObjective,
+        :keywords,
+        :isPartOf,
+        :datePublished,
+        :version
 
-	    # Public:
-      def to_json(*a)
-	      {
-		      "type" => @type,
-		      "objectTypes" => @object_types,
-	        "learningObjective" => @learning_objectives,
-	        "keywords" => @keywords,
-	        "isPartOf" => @is_part_of,
-	        "datePublished" => @date_published
-	      }.to_json(*a)
+      def initialize
+        super
+        @type = EntityType::DIGITAL_RESOURCE
+        @alignedLearningObjective = Array.new
+        @objectType = Array.new
+        @keywords = Array.new
+        @datePublished = nil
+        @isPartOf = nil
+        @version = nil
       end
 
-	    def initialize()
-		    super
-		    @type = EntityType::DIGITAL_RESOURCE
-	    end
     end
   end
 end

data/lib/caliper/entities/entity.rb

@@ -1,44 +1,58 @@
-require "json"
-
-##
-##  The base Caliper Entity.  Analogous to a schema.org Thing.
-##
+require 'time'
+require 'json'
+require_relative './jsonable'
+#
+#  
+#  @copyright @copyright ©2013 IMS Global Learning Consortium, Inc.  All Rights Reserved.
+#  @license For license information contact, info@imsglobal.org
+#
+#
+#  The base Caliper Entity.  Analogous to a schema.org Thing.
+#
 module Caliper
   module Entities
-	  module EntityType
-		  AGENT = "http://purl.imsglobal.org/caliper/v1/Agent"
-		  ATTEMPT = "http://purl.imsglobal.org/caliper/v1/Attempt"
-		  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"
-		  LEARNING_OBJECTIVE = "http://purl.imsglobal.org/caliper/v1/LearningObjective"
-		  LIS_PERSON = "http://purl.imsglobal.org/caliper/v1/lis/Person"
-		  LIS_ORGANIZATION = "http://purl.imsglobal.org/caliper/v1/lis/Organization"
-		  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
+    module EntityType
+      AGENT = "http://purl.imsglobal.org/caliper/v1/Agent"
+      ATTEMPT = "http://purl.imsglobal.org/caliper/v1/Attempt"
+      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"
+      LEARNING_OBJECTIVE = "http://purl.imsglobal.org/caliper/v1/LearningObjective"
+      LIS_PERSON = "http://purl.imsglobal.org/caliper/v1/lis/Person"
+      # LIS_ORGANIZATION = "http://purl.imsglobal.org/caliper/v1/lis/Organization"
+      COURSE_OFFERING = "http://purl.imsglobal.org/caliper/v1/lis/CourseOffering"
+      COURSE_SECTION = "http://purl.imsglobal.org/caliper/v1/lis/CourseSection"
+      MEMBERSHIP = "http://purl.imsglobal.org/caliper/v1/lis/Membership"
+      ORGANIZATION = "http://purl.imsglobal.org/caliper/v1/w3c/Organization"
+      RESULT = "http://purl.imsglobal.org/caliper/v1/Result"
+      SESSION = "http://purl.imsglobal.org/caliper/v1/Session"
+      RESPONSE = "http://purl.imsglobal.org/caliper/v1/Response"
+      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
-			attr_accessor :id,
-			              :type,
-			              :name,
-			              :description,
-			              :properties,
-			              :date_created,
-			              :date_modified
+      include Caliper::Entities::Jsonable
+
+      attr_accessor :id,
+        :type,
+        :name,
+        :description,
+        :extensions,
+        :dateCreated,
+        :dateModified
+
+      def initialize()
+        @id = ""
+        @type = EntityType::ENTITY
+        @name = nil
+        @description = nil
+        @extensions = {}
+        @dateCreated = Time.now.utc.iso8601(3)
+        @dateModified = Time.now.utc.iso8601(3)
+      end
 
-			def initialize()
-				@id = ""
-				@type = EntityType::ENTITY
-				@name = ""
-				@description = ""
-				@properties = ""
-				@date_created = Time.now.utc
-				@date_modified = Time.now.utc
-			end
     end
   end
 end