ims_caliper 0.1.3 → 0.9.0

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

@@ -1,17 +1,28 @@
-require_relative 'annotation'
-
+##
+# 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.
 #
-#  
-#  @copyright @copyright ©2013 IMS Global Learning Consortium, Inc.  All Rights Reserved.
-#  @license For license information contact, info@imsglobal.org
+# 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.
 #
-#  Shared Annotation Entity
+# 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 './annotation'
+
+#
+#  Shared Annotation entity.
 #
 module Caliper
   module Entities
     module Annotation
-
       class SharedAnnotation < Annotation
         attr_accessor :withAgents # list of Agent objects
 
@@ -20,8 +31,7 @@ module Caliper
           @type = AnnotationType::SHARED_ANNOTATION
 	        @withAgents = Array.new
         end
-        
       end
     end
   end
-end
+end

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

@@ -1,17 +1,28 @@
-require_relative 'annotation'
-
+##
+# 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.
 #
-#  
-#  @copyright @copyright ©2013 IMS Global Learning Consortium, Inc.  All Rights Reserved.
-#  @license For license information contact, info@imsglobal.org
+# 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.
 #
-#  Tag Annotation Entity
+# 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 './annotation'
+
+#
+#  Tag Annotation entity.
 #
 module Caliper
   module Entities
     module Annotation
-
       class TagAnnotation < Annotation
         attr_accessor :tags
 
@@ -20,8 +31,7 @@ module Caliper
           @type = AnnotationType::TAG_ANNOTATION
           @tags = Array.new
         end
-        
       end
     end
   end
-end
+end

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

@@ -1,17 +1,28 @@
-require_relative '../../entities/assignable/assignable_digital_resource'
-
-#
+##
+# 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.
 #
-#  @copyright @copyright ©2013 IMS Global Learning Consortium, Inc.  All Rights Reserved.
-#  @license For license information contact, info@imsglobal.org
+# 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.
 #
-# Represents an Assessment
+# 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/.
 
+require_relative '../assignable/assignable_digital_resource'
+
+#
+# Assessment entity.
+#
 module Caliper
   module Entities
     module Assessment
-
       class Assessment < Caliper::Entities::Assignable::AssignableDigitalResource
 
         attr_accessor :assessmentItems
@@ -20,8 +31,7 @@ module Caliper
           super
           @type = Caliper::Entities::Assignable::AssignableDigitalResourceType::ASSESSMENT
         end
-
       end
     end
   end
-end
+end

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

@@ -1,16 +1,28 @@
-require_relative '../../entities/assignable/assignable_digital_resource'
-
+##
+# 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.
 #
-#  @copyright @copyright ©2013 IMS Global Learning Consortium, Inc.  All Rights Reserved.
-#  @license For license information contact, info@imsglobal.org
+# 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.
 #
-# Represents an Assessment Item.
+# 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/.
+
+require_relative '../assignable/assignable_digital_resource'
 
+#
+# Assessment Item entity.
+#
 module Caliper
   module Entities
     module Assessment
-
       class AssessmentItem < Caliper::Entities::Assignable::AssignableDigitalResource
 
         attr_accessor :isTimeDependent
@@ -19,8 +31,7 @@ module Caliper
           super
           @type = Caliper::Entities::Assignable::AssignableDigitalResourceType::ASSESSMENT_ITEM
         end
-
       end
     end
   end
-end
+end

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

@@ -1,25 +1,34 @@
-require_relative '../../entities/digital_resource'
-require_relative '../../entities/schemadotorg/thing'
-
+##
+# 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.
 #
-#  @copyright @copyright ©2013 IMS Global Learning Consortium, Inc.  All Rights Reserved.
-#  @license For license information contact, info@imsglobal.org
+# 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.
 #
-# Represents AssignableDigitalResource.
-# AssignableDigitalResource's prototype set to DigitalResource
+# 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/.
+
+require_relative '../digital_resource'
 
+#
+# AssignableDigitalResource entity. AssignableDigitalResource's prototype is 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,
@@ -40,8 +49,7 @@ module Caliper
           @maxSubmits = nil
           @maxScore = nil
         end
-
      end
     end
   end
-end
+end

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

@@ -1,17 +1,31 @@
-require_relative '../../entities/entity'
-
+##
+# 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.
 #
-#  @copyright @copyright ©2013 IMS Global Learning Consortium, Inc.  All Rights Reserved.
-#  @license For license information contact, info@imsglobal.org
+# 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/.
+
+require_relative '../entity'
+require_relative '../generatable'
+
 #
-#  Represents an Attempt on an Assignable
+#  Attempt entity on an Assignable.
 #
 module Caliper
   module Entities
     module Assignable
-
       class Attempt < Entity
+        include Caliper::Entities::Generatable
 
         attr_accessor :assignable,
           :actor,
@@ -26,7 +40,6 @@ module Caliper
         end
 
       end
-
     end
   end
-end
+end

data/lib/caliper/entities/digital_resource.rb

@@ -1,19 +1,30 @@
-require "json"
-require_relative 'entity'
-
+##
+# 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.
 #
-#  
-#  @copyright @copyright ©2013 IMS Global Learning Consortium, Inc.  All Rights Reserved.
-#  @license For license information contact, info@imsglobal.org
+# 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.
 #
-# 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
+# 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 './schemadotorg/creative_work'
+require_relative './targetable'
+
+#
+# Caliper representation of a CreativeWork. We add learning specific attributes, including a list of
+# LearningObjective learning objectives and a list of String keywords.  See https://schema.org/CreativeWork.
 #
 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"
@@ -28,14 +39,15 @@ module Caliper
     end
 
     class DigitalResource < Entity
-      include Caliper::Entities::Jsonable
+      include Caliper::Entities::SchemaDotOrg::CreativeWork,
+              Caliper::Entities::Targetable
 
       attr_accessor :objectType,
-        :alignedLearningObjective,
-        :keywords,
-        :isPartOf,
-        :datePublished,
-        :version
+                    :alignedLearningObjective,
+                    :keywords,
+                    :isPartOf,
+                    :datePublished,
+                    :version
 
       def initialize
         super
@@ -47,7 +59,6 @@ module Caliper
         @isPartOf = nil
         @version = nil
       end
-
     end
   end
 end

data/lib/caliper/entities/entity.rb

@@ -1,11 +1,25 @@
+##
+# 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/.
+
 require 'time'
 require 'json'
+require_relative './schemadotorg/thing'
 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.
 #
@@ -14,26 +28,27 @@ module Caliper
     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"
-      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"
+      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"
-      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
-      include Caliper::Entities::Jsonable
+      include Caliper::Entities::SchemaDotOrg::Thing,
+              Caliper::Entities::Jsonable
 
       attr_accessor :id,
         :type,
@@ -52,7 +67,6 @@ module Caliper
         @dateCreated = Time.now.utc.iso8601(3)
         @dateModified = Time.now.utc.iso8601(3)
       end
-
     end
   end
-end
+end

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

@@ -1,6 +1,25 @@
-require_relative '../../entities/entity'
-# Public: From http://xmlns.com/foaf/spec/#term_Agent An agent (eg. person,
-#        group, software or physical artifact)
+##
+# 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/.
+
+require_relative '../entity'
+
+#
+# An agent (eg. person, group, software or physical artifact). See http://xmlns.com/foaf/spec/#term_Agent.
+#
 module Caliper
   module Entities
 	  module FOAF

data/lib/caliper/entities/generatable.rb

@@ -1,9 +1,28 @@
-# The generatable interface marks an object type that is created or generated as a result of an action.
+##
+# 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/.
+
+#
+# The Generatable interface marks an object type that is created or generated as a result of an action.
 # The interface allows Caliper to catch errors at compile time for instances of the marked class rather
 # than at runtime if a marker annotation was defined instead.
+#
 module Caliper
 	module Entities
 		module Generatable
 		end
 	end
-end
+end

data/lib/caliper/entities/jsonable.rb

@@ -1,9 +1,22 @@
+##
+# 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/.
+
 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
 #
@@ -50,7 +63,6 @@ module Caliper
       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_context.rb

@@ -1,21 +1,42 @@
-require "json"
-require_relative 'entity'
-require_relative 'software_application'
-require_relative 'lis/organization'
-require_relative 'foaf/agent'
+##
+# 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/.
 
+require_relative './entity'
+require_relative './agent/software_application'
+require_relative './w3c/organization'
+require_relative './foaf/agent'
+
+#
+# Learning Context.
+#
 module Caliper
   module Entities
     class LearningContext < Entity
+
 	    attr_accessor :ed_app, # SoftwareApplication educational app
-                    :lis_organization, # Organization the LIS organization
+                    :group, # W3C Organization
 	                  :agent # Agent the agent, since the Agent module is empty for now, use Entity type
+
 	    def initialize
 		    super
-		    @ed_app = SoftwareApplication.new
-		    @lis_organization = Caliper::Entities::LIS::Organization.new
+		    @ed_app = Caliper::Entities::Agent::SoftwareApplication.new
+		    @group = Caliper::Entities::W3c::Organization.new
 		    @agent = Caliper::Entities::Entity.new
 	    end
 	  end
   end
-end
+end

data/lib/caliper/entities/learning_objective.rb

@@ -1,26 +1,33 @@
-require_relative 'entity'
-require_relative 'generatable'
-require_relative 'targetable'
-require_relative './jsonable'
-
+##
+# 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.
 #
-#  
-#  @copyright @copyright ©2013 IMS Global Learning Consortium, Inc.  All Rights Reserved.
-#  @license For license information contact, info@imsglobal.org
+# 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/.
+
+require_relative './entity'
+
 #
-#  Learning Objective 
+#  Learning Objective
 #
 module Caliper
   module Entities
-
     class LearningObjective < Entity
 
       def initialize
         super
         @type = EntityType::LEARNING_OBJECTIVE
       end
-
     end
   end
-end
+end