ims_caliper 0.1.1 → 0.1.2

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

@@ -0,0 +1,23 @@
+require_relative '../../entities/digital_resource'
+
+#
+# A time based location within a media object
+#
+module Caliper
+  module Entities
+    module Media
+
+      class MediaLocation < DigitalResource
+
+        attr_accessor :currentTime
+
+        def initialize
+          super
+          @type = DigitalResourceType::MEDIA_LOCATION
+          @currentTime = nil
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,38 @@
+require_relative '../../entities/digital_resource'
+require_relative '../../entities/schemadotorg/thing'
+
+# 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 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
+        include Caliper::Entities::SchemaDotOrg::Thing
+
+        attr_accessor :duration
+
+        def initialize
+          super
+          @type = DigitalResourceType::MEDIA_OBJECT
+          @duration = nil
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+require_relative 'media_object'
+
+# https://schema.org/VideoObject
+#
+# A video object embedded in a web page..
+
+module Caliper
+  module Entities
+    module Media
+
+      class VideoObject < MediaObject
+
+        def initialize
+          super
+          @type = MediaType::VIDEO_OBJECT
+        end
+
+      end
+    end
+  end
+end

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

@@ -1,19 +1,27 @@
-# 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'
+require_relative '../../entities/jsonable'
 
+#
+#  
+#  @copyright @copyright ©2013 IMS Global Learning Consortium, Inc.  All Rights Reserved.
+#  @license For license information contact, info@imsglobal.org
+#
+#  Public: Representation of an EPUB 3 Volume
+#  A component of a collection
+#  http://www.idpf.org/epub/vocab/structure/#volume
+#
 module Caliper
   module Entities
     module Reading
-      class EpubVolume < Caliper::Entities::DigitalResource
+
+      class EPubVolume < Caliper::Entities::DigitalResource
+        include Caliper::Entities::Jsonable
+
         def initialize()
 	        super
-          @id = ""
           @type = DigitalResourceType::EPUB_VOLUME
         end
+
       end
     end
   end

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

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

data/lib/caliper/entities/response/fillin_blank_response.rb

@@ -0,0 +1,20 @@
+require "require_all"
+require_all 'lib/caliper/entities/response/response_type.rb'
+#
+# Represents response text or integer/decimal/scientific numbers that completes a question
+# designed with one or more "fill in the blank" option prompts.
+
+module Caliper
+	module Entities
+		module Response
+			class FillinBlankResponse < Response
+				attr_accessor :type,
+			                :values
+
+				def initialize
+					@type = ResponseType::FILLINBLANK
+				end
+			end
+		end
+	end
+end

data/lib/caliper/entities/response/multiple_choice_response.rb

@@ -0,0 +1,20 @@
+require "require_all"
+require_all 'lib/caliper/entities/response/response_type.rb'
+#
+# Represents a response to a multiple choice question that permits a single option to be selected
+#
+
+module Caliper
+	module Entities
+		module Response
+			class MultipleChoiceResponse < Response
+				attr_accessor :type,
+			                :values
+
+				def initialize
+					@type = ResponseType::MULTIPLECHOICE
+				end
+			end
+		end
+	end
+end

data/lib/caliper/entities/response/multiple_response_response.rb

@@ -0,0 +1,20 @@
+require "require_all"
+require_all 'lib/caliper/entities/response/response_type.rb'
+#
+# Representation of a response to a multiple choice question that permits one or more options to be selected.
+#
+
+module Caliper
+	module Entities
+		module Response
+			class MultipleResponseResponse < Response
+				attr_accessor :type,
+			                :values
+
+				def initialize
+					@type = ResponseType::MULTIPLERESPONSE
+				end
+			end
+		end
+	end
+end

data/lib/caliper/entities/response/response.rb

@@ -0,0 +1,23 @@
+require "require_all"
+require_all 'lib/caliper/entities/generatable.rb'
+
+module Caliper
+	module Entities
+		module Response
+			class Response < Entity
+				include Generatable
+				attr_accessor :type,
+			                :assignable,
+			                :actor,
+			                :attempt,
+			                :startedAtTime,
+			                :endedAtTime,
+			                :duration
+
+				def initialize
+					@type = EntityType::RESPONSE
+				end
+			end
+		end
+	end
+end

data/lib/caliper/entities/response/response_type.rb

@@ -0,0 +1,13 @@
+module Caliper
+	module Entities
+		module Response
+			module ResponseType
+				FILLINBLANK = "http://purl.imsglobal.org/caliper/v1/Response/FillinBlank"
+				MULTIPLECHOICE = "http://purl.imsglobal.org/caliper/v1/Response/MultipleChoice"
+				MULTIPLERESPONSE = "http://purl.imsglobal.org/caliper/v1/Response/MultipleResponse"
+				SELECTTEXT = "http://purl.imsglobal.org/caliper/v1/Response/SelectText"
+				TRUEFALSE = "http://purl.imsglobal.org/caliper/v1/Response/TrueFalse"
+			end
+		end
+	end
+end

data/lib/caliper/entities/response/select_type_response.rb

@@ -0,0 +1,20 @@
+require "require_all"
+require_all 'lib/caliper/entities/response/response_type.rb'
+#
+# Represents a response that identifies text from a presented paragraph or list.
+# The response is the identified string or a mapping to a logical identifier;
+
+module Caliper
+	module Entities
+		module Response
+			class SelectTextResponse < Response
+				attr_accessor :type,
+			                :values
+
+				def initialize
+					@type = ResponseType::SELECTTEXT
+				end
+			end
+		end
+	end
+end

data/lib/caliper/entities/response/true_false_response.rb

@@ -0,0 +1,21 @@
+require "require_all"
+require_all 'lib/caliper/entities/response/response_type.rb'
+#
+# Represents response to a multiple choice question that limits options to either 'true or false',
+# 'agree or disagree', etc.
+#
+
+module Caliper
+	module Entities
+		module Response
+			class TrueFalseResponse < Response
+				attr_accessor :type,
+			                :values
+
+				def initialize
+					@type = ResponseType::TRUEFALSE
+				end
+			end
+		end
+	end
+end

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

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

data/lib/caliper/entities/session.rb

@@ -1,26 +1,34 @@
-
 require_relative 'entity'
 require_relative 'generatable'
 require_relative 'targetable'
+require_relative './jsonable'
 
-
+#
+#  
+#  @copyright @copyright ©2013 IMS Global Learning Consortium, Inc.  All Rights Reserved.
+#  @license For license information contact, info@imsglobal.org
+#
+#
+#  Session Entity
+#
 module Caliper
-	module Entities
-		class Session < Entity
-			include Generatable
-			include Targetable
+  module Entities
+
+    class Session < Entity
+      include Generatable
+      include Targetable
+      include Caliper::Entities::Jsonable
 
-			attr_accessor :type, # String
-			              :actor, # Agent
-										:started_at_time,
-										:ended_at_time,
-										:duration # String
+      attr_accessor :actor,
+        :startedAtTime,
+        :endedAtTime,
+        :duration
 
-			def initialize
-				super
-				@type = EntityType::SESSION
-			end
+      def initialize
+        super
+        @type = EntityType::SESSION
+      end
 
-		end
-	end
+    end
+  end
 end

data/lib/caliper/entities/software_application.rb

@@ -2,18 +2,27 @@ require "json"
 require_relative '../entities/entity'
 require_relative '../entities/foaf/agent'
 require_relative '../entities/schemadotorg/software_application'
+require_relative '../entities/lis/organization'
 
+#
+#  
+#  @copyright @copyright ©2013 IMS Global Learning Consortium, Inc.  All Rights Reserved.
+#  @license For license information contact, info@imsglobal.org
+#
+#
+#  Software Application (from schema.org)
+#
 module Caliper
   module Entities
-    class SoftwareApplication < Entity
-	    include Caliper::Entities::FOAF::Agent
-	    include Caliper::Entities::SchemaDotOrg::SoftwareApplication
+    class SoftwareApplication < Caliper::Entities::LIS::Organization
+      include Caliper::Entities::FOAF::Agent
+      include Caliper::Entities::SchemaDotOrg::SoftwareApplication
 
-	    attr_accessor :type
+      def initialize()
+        super
+        @type=EntityType::SOFTWARE_APPLICATION
+      end
 
-	    def initialize()
-				@type=EntityType::SOFTWARE_APPLICATION
-	    end
     end
   end
 end

data/lib/caliper/entities/web_page.rb

@@ -2,8 +2,10 @@ 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

data/lib/caliper/entity_envelope.rb

@@ -0,0 +1,21 @@
+require 'rest_client'
+require_relative "options"
+require_relative 'jsonable'
+##
+#
+#  @copyright @copyright ©2013 IMS Global Learning Consortium, Inc.  All Rights Reserved.
+#  @license For license information contact, info@imsglobal.org
+#
+# Caliper Sensor Entity Envelope
+#
+#
+module Caliper
+
+  class EntityEnvelope
+  	include Caliper::Jsonable
+
+    attr_accessor :apiKey,
+      :sensorId,
+      :entity
+  end
+end