ims_caliper 0.1.1 → 0.1.2

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

@@ -5,7 +5,7 @@ module Caliper
   module Entities
 	  module FOAF
       module Agent
-
+      	attr_accessor :hasMembership # Membership
       end
     end
   end

data/lib/caliper/entities/jsonable.rb

@@ -0,0 +1,56 @@
+require 'json'
+
+#
+#  
+#  @copyright @copyright ©2013 IMS Global Learning Consortium, Inc.  All Rights Reserved.
+#  @license For license information contact, info@imsglobal.org
+#
+#  Module that supports ser-des for Caliper Entities/JSON
+#
+module Caliper
+  module Entities
+    module Jsonable
+
+      def self.included(base)
+        base.extend ClassMethods
+      end
+
+      module ClassMethods
+      end
+
+      def to_json(*a)
+        # puts 'Jsonable: to_json invoked'
+        result = {}
+        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')
+          value = self.instance_variable_get key
+          # puts "setting #{key}: #{value}"
+          result[key[1..-1]] = value
+        end
+        result.to_json(*a)
+      end
+
+      def from_json json_hash
+        data = json_hash
+        # puts "Jsonable: from_json: json_hash = #{json_hash}"
+        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')
+          # puts "Jsonable - adding #{key} : #{value}"
+          self.instance_variable_set "@#{key}", value
+        end
+        return self
+      end
+
+      def eql?(other)
+        @id == other.id && @type == other.type && @name == other.name && @description == other.description && @dateCreated == other.dateCreated && @dateModified == other.dateModified
+      end
+
+    end
+  end
+end

data/lib/caliper/entities/learning_objective.rb

@@ -0,0 +1,26 @@
+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
+#
+#
+#  Learning Objective 
+#
+module Caliper
+  module Entities
+
+    class LearningObjective < Entity
+
+      def initialize
+        super
+        @type = EntityType::LEARNING_OBJECTIVE
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,30 @@
+require_relative './organization'
+require_relative '../../entities/jsonable'
+
+#
+#
+#  @copyright @copyright ©2013 IMS Global Learning Consortium, Inc.  All Rights Reserved.
+#  @license For license information contact, info@imsglobal.org
+#
+#
+#  a LIS Course Section
+#
+module Caliper
+  module Entities
+    module LIS
+
+      class CourseOffering < Caliper::Entities::LIS::Organization
+        include Caliper::Entities::Jsonable
+
+        attr_accessor :courseNumber,
+          :academicSession
+
+        def initialize
+          super
+          @type = OrganizationType::COURSE_OFFERING
+        end
+
+      end
+    end
+  end
+end

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

@@ -1,18 +1,30 @@
 require_relative './organization'
+require_relative '../../entities/jsonable'
+require_relative './course_offering'
 
+#
+#  
+#  @copyright @copyright ©2013 IMS Global Learning Consortium, Inc.  All Rights Reserved.
+#  @license For license information contact, info@imsglobal.org
+#
+#
+#  a LIS Course Section
+#
 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
+  module Entities
+    module LIS
+
+      class CourseSection < Caliper::Entities::LIS::CourseOffering
+        include Caliper::Entities::Jsonable
+
+        attr_accessor :category
+
+        def initialize
+          super
+          @type = OrganizationType::LIS_COURSE_SECTION
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,27 @@
+require_relative './organization'
+require_relative '../../entities/jsonable'
+
+#
+#  
+#  @copyright @copyright ©2013 IMS Global Learning Consortium, Inc.  All Rights Reserved.
+#  @license For license information contact, info@imsglobal.org
+#
+#
+#  a LIS Course Section
+#
+module Caliper
+  module Entities
+    module LIS
+
+      class Group < Caliper::Entities::LIS::Organization
+        include Caliper::Entities::Jsonable
+
+        def initialize
+          super
+          @type = OrganizationType::GROUP
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+require_relative './organization'
+require_relative '../../entities/jsonable'
+
+#
+#  
+#  @copyright @copyright ©2013 IMS Global Learning Consortium, Inc.  All Rights Reserved.
+#  @license For license information contact, info@imsglobal.org
+#
+#
+#  W3C Membership
+#
+module Caliper
+  module Entities
+    module LIS
+
+      class Membership < Caliper::Entities::LIS::Organization
+        include Caliper::Entities::Jsonable
+
+        attr_accessor :member,
+          :organization,
+          :roles,
+          :status
+
+        def initialize
+          super
+          @type = EntityType::MEMBERSHIP
+        end
+
+      end
+    end
+  end
+end

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

@@ -2,21 +2,24 @@ 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
+  module Entities
+    module LIS
+      module OrganizationType
+        COURSE_OFFERING = "http://purl.imsglobal.org/caliper/v1/lis/CourseOffering"
+        LIS_COURSE_SECTION = "http://purl.imsglobal.org/caliper/v1/lis/CourseSection"
+        GROUP = "http://purl.imsglobal.org/caliper/v1/lis/Group"
+      end
+      class Organization < Entity
+        include Caliper::Entities::FOAF::Agent
 
-				def initialize
-					super
-					@type = EntityType::LIS_ORGANIZATION
-				end
-			end
-		end
-	end
-end
+        attr_accessor :membership,
+        :subOrganizationOf
+
+        def initialize
+          super
+          @type = EntityType::ORGANIZATION
+        end
+      end
+    end
+  end
+end

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

@@ -1,12 +1,25 @@
 require_relative '../../entities/entity'
-
+require_relative '../../entities/foaf/agent.rb'
+require_relative '../../entities/jsonable'
+#
+#  
+#  @copyright @copyright ©2013 IMS Global Learning Consortium, Inc.  All Rights Reserved.
+#  @license For license information contact, info@imsglobal.org
+#
 module Caliper
-	module Entities
-		module LIS
-			class Person < Entity
-				include Caliper::Entities::FOAF::Agent
-				attr_accessor :type # String
-			end
-		end
-	end
-end
+  module Entities
+    module LIS
+      # Represents Person.
+      # @extends Agent
+      class Person < Entity
+        include Caliper::Entities::FOAF::Agent, Caliper::Entities::Jsonable
+
+        def initialize
+          super
+          @type = EntityType::LIS_PERSON
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,77 @@
+require_relative '../../entities/entity'
+require_relative '../../entities/foaf/agent.rb'
+require_relative '../../entities/jsonable'
+#
+#
+#  @copyright @copyright ©2013 IMS Global Learning Consortium, Inc.  All Rights Reserved.
+#  @license For license information contact, info@imsglobal.org
+#
+module Caliper
+  module Entities
+    module LIS
+      module Roles
+        LEARNER = 'http://purl.imsglobal.org/vocab/lis/v2/membership#Learner'
+        EXTERNAL_LEARNER = 'http://purl.imsglobal.org/vocab/lis/v2/membership/Learner#ExternalLearner'
+        GUEST_LEARNER = 'http://purl.imsglobal.org/vocab/lis/v2/membership/Learner#GuestLearner'
+        LEARNER_INSTRUCTOR = 'http://purl.imsglobal.org/vocab/lis/v2/membership/Learner#Instructor'
+        LEARNER_LEARNER = 'http://purl.imsglobal.org/vocab/lis/v2/membership/Learner#Learner'
+        NONCREDIT_LEARNER = 'http://purl.imsglobal.org/vocab/lis/v2/membership/Learner#NonCreditLearner'
+
+        INSTRUCTOR = 'http://purl.imsglobal.org/vocab/lis/v2/membership#Instructor'
+        EXTERNAL_INSTRUCTOR = 'http://purl.imsglobal.org/vocab/lis/v2/membership/Instructor#ExternalInstructor'
+        GUEST_INSTRUCTOR = 'http://purl.imsglobal.org/vocab/lis/v2/membership/Instructor#GuestInstructor'
+        LECTURER = 'http://purl.imsglobal.org/vocab/lis/v2/membership/Instructor#Lecturer'
+        PRIMARY_INSTRUCTOR = 'http://purl.imsglobal.org/vocab/lis/v2/membership/Instructor#PrimaryInstructor'
+
+        ADMINISTRATOR = 'http://purl.imsglobal.org/vocab/lis/v2/membership#Administrator'
+        ADMINISTRATOR_ADMINISTRATOR = 'http://purl.imsglobal.org/vocab/lis/v2/membership/Administrator#Administrator'
+        ADMINISTRATOR_DEVELOPER = 'http://purl.imsglobal.org/vocab/lis/v2/membership/Administrator#Developer'
+        ADMINISTRATOR_SUPPORT = 'http://purl.imsglobal.org/vocab/lis/v2/membership/Administrator#Support'
+        ADMINISTRATOR_SYSTEM_ADMINISTRATOR = 'http://purl.imsglobal.org/vocab/lis/v2/membership/Administrator#SystemAdministrator'
+
+        ADMINISTRATOR_EXTERNAL_DEVELOPER = 'http://purl.imsglobal.org/vocab/lis/v2/membership/Administrator#ExternalSupport'
+        ADMINISTRATOR_EXTERNAL_SUPPORT = 'http://purl.imsglobal.org/vocab/lis/v2/membership/Administrator#ExternalDeveloper'
+        ADMINISTRATOR_EXTERNAL_SYSTEM_ADMINISTRATOR = 'http://purl.imsglobal.org/vocab/lis/v2/membership/Administrator#ExternalSystemAdministrator'
+
+        CONTENT_DEVELOPER = 'http://purl.imsglobal.org/vocab/lis/v2/membership#ContentDeveloper'
+        CONTENT_DEVELOPER_CONTENT_DEVELOPER = 'http://purl.imsglobal.org/vocab/lis/v2/membership/ContentDeveloper#ContentDeveloper'
+        CONTENT_DEVELOPER_LIBRARIAN = 'http://purl.imsglobal.org/vocab/lis/v2/membership/ContentDeveloper#Librarian'
+        CONTENT_DEVELOPER_CONTENT_EXPERT = 'http://purl.imsglobal.org/vocab/lis/v2/membership/ContentDeveloper#ContentExpert'
+        CONTENT_DEVELOPER_EXTERNAL_CONTENT_EXPERT = 'http://purl.imsglobal.org/vocab/lis/v2/membership/ContentDeveloper#ExternalContentExpert'
+
+        MANAGER = 'http://purl.imsglobal.org/vocab/lis/v2/membership#Manager'
+        MANAGER_AREA_MANAGER = 'http://purl.imsglobal.org/vocab/lis/v2/membership/Manager#AreaManager'
+        MANAGER_COURSE_COORDINATOR = 'http://purl.imsglobal.org/vocab/lis/v2/membership/Manager#CourseCoordinator'
+        MANAGER_OBSERVER = 'http://purl.imsglobal.org/vocab/lis/v2/membership/Manager#Observer'
+        MANAGER_EXTERNAL_OBSERVER = 'http://purl.imsglobal.org/vocab/lis/v2/membership/Manager#ExternalObserver'
+
+        MEMBER = 'http://purl.imsglobal.org/vocab/lis/v2/membership#Member'
+        MEMBER_MEMBER = 'http://purl.imsglobal.org/vocab/lis/v2/membership/Member#Member'
+
+        MENTOR = 'http://purl.imsglobal.org/vocab/lis/v2/membership#Mentor'
+        MENTOR_MENTOR = 'http://purl.imsglobal.org/vocab/lis/v2/membership/Mentor#Mentor'
+        MENTOR_ADVISOR = 'http://purl.imsglobal.org/vocab/lis/v2/membership/Mentor#Advisor'
+        MENTOR_AUDITOR = 'http://purl.imsglobal.org/vocab/lis/v2/membership/Mentor#Auditor'
+        MENTOR_REVIEWER = 'http://purl.imsglobal.org/vocab/lis/v2/membership/Mentor#Reviewer'
+        MENTOR_TUTOR = 'http://purl.imsglobal.org/vocab/lis/v2/membership/Mentor#Tutor'
+        MENTOR_LEARNING_FACILITATOR = 'http://purl.imsglobal.org/vocab/lis/v2/membership/Mentor#LearningFacilitator'
+
+        MENTOR_EXTERNAL_MENTOR = 'http://purl.imsglobal.org/vocab/lis/v2/membership/Mentor#ExternalMentor'
+        MENTOR_EXTERNAL_ADVISOR = 'http://purl.imsglobal.org/vocab/lis/v2/membership/Mentor#ExternalAdvisor'
+        MENTOR_EXTERNAL_AUDITOR = 'http://purl.imsglobal.org/vocab/lis/v2/membership/Mentor#ExternalAuditor'
+        MENTOR_EXTERNAL_REVIEWER = 'http://purl.imsglobal.org/vocab/lis/v2/membership/Mentor#ExternalReviewer'
+        MENTOR_EXTERNAL_TUTOR = 'http://purl.imsglobal.org/vocab/lis/v2/membership/Mentor#ExternalTutor'
+        MENTOR_EXTERNAL_LEARNING_FACILITATOR = 'http://purl.imsglobal.org/vocab/lis/v2/membership/Mentor/ExternalLearningFacilitator'
+
+        TEACHING_ASSISTANT = 'http://purl.imsglobal.org/vocab/lis/v2/membership#TeachingAssistant'
+        TEACHING_ASSISTANT_TEACHING_ASSISTANT = 'http://purl.imsglobal.org/vocab/lis/v2/membership/TeachingAssistant#TeachingAssistant'
+        TEACHING_ASSISTANT_GRADER = 'http://purl.imsglobal.org/vocab/lis/v2/membership/TeachingAssistant#Grader'
+        TEACHING_ASSISTANT_TEACHING_ASSISTANT_SECTION = 'http://purl.imsglobal.org/vocab/lis/v2/membership/TeachingAssistant#TeachingAssistantSection'
+        TEACHING_ASSISTANT_TEACHING_ASSISTANT_SECTION_ASSOCIATION = 'http://purl.imsglobal.org/vocab/lis/v2/membership/TeachingAssistant#TeachingAssistantSectionAssociation'
+        TEACHING_ASSISTANT_TEACHING_ASSISTANT_OFFERING = 'http://purl.imsglobal.org/vocab/lis/v2/membership/TeachingAssistant#TeachingAssistantOffering'
+        TEACHING_ASSISTANT_TEACHING_ASSISTANT_TEMPLATE = 'http://purl.imsglobal.org/vocab/lis/v2/membership/TeachingAssistant#TeachingAssistantTemplate'
+        TEACHING_ASSISTANT_TEACHING_ASSISTANT_GROUP = 'http://purl.imsglobal.org/vocab/lis/v2/membership/TeachingAssistant#TeachingAssistantGroup'
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+require_relative '../../entities/entity'
+require_relative '../../entities/foaf/agent.rb'
+require_relative '../../entities/jsonable'
+#
+#
+#  @copyright @copyright ©2013 IMS Global Learning Consortium, Inc.  All Rights Reserved.
+#  @license For license information contact, info@imsglobal.org
+#
+module Caliper
+  module Entities
+    module LIS
+      module Status
+        ACTIVE = 'http://purl.imsglobal.org/vocab/lis/v2/status#Active'
+        DELETED = 'http://purl.imsglobal.org/vocab/lis/v2/status#Deleted'
+        INACTIVE = 'http://purl.imsglobal.org/vocab/lis/v2/status#Inactive'
+      end
+    end
+  end
+end

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

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

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

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