ims_caliper 0.1.3 → 0.9.0

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

@@ -1,30 +1,40 @@
-require_relative './organization'
-require_relative '../../entities/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'
+require_relative '../w3c/organization'
+
 #
-#  a LIS Course Section
+#  LIS Course Offering.
 #
 module Caliper
   module Entities
     module LIS
-
-      class CourseOffering < Caliper::Entities::LIS::Organization
-        include Caliper::Entities::Jsonable
+      class CourseOffering < Entity
+        include Caliper::Entities::W3c::Organization
 
         attr_accessor :courseNumber,
-          :academicSession
+                      :academicSession
 
         def initialize
           super
-          @type = OrganizationType::COURSE_OFFERING
+          @type = EntityType::COURSE_OFFERING
         end
-
       end
     end
   end
-end
+end

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

@@ -1,30 +1,37 @@
-require_relative './organization'
-require_relative '../../entities/jsonable'
-require_relative './course_offering'
-
+##
+# 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.
+#
+# 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 './course_offering'
+
 #
-#  a LIS Course Section
+#  LIS Course Section.
 #
 module Caliper
   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
+          @type = EntityType::COURSE_SECTION
         end
-
       end
     end
   end
-end
+end

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

@@ -1,27 +1,37 @@
-require_relative './organization'
-require_relative '../../entities/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'
+require_relative '../w3c/organization'
+
 #
-#  a LIS Course Section
+#  LIS Group.
 #
 module Caliper
   module Entities
     module LIS
-
-      class Group < Caliper::Entities::LIS::Organization
-        include Caliper::Entities::Jsonable
+      class Group < Entity
+        include Caliper::Entities::W3c::Organization
 
         def initialize
           super
-          @type = OrganizationType::GROUP
+          @type = EntityType::GROUP
         end
-
       end
     end
   end
-end
+end

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

@@ -1,25 +1,31 @@
-require_relative './organization'
-require_relative '../../entities/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'
+require_relative '../w3c/membership'
+
 #
-#  W3C Membership
+#  W3C Membership.
 #
 module Caliper
   module Entities
     module LIS
-
-      class Membership < Caliper::Entities::LIS::Organization
-        include Caliper::Entities::Jsonable
-
-        attr_accessor :member,
-          :organization,
-          :roles,
-          :status
+      class Membership < Entity
+        include Caliper::Entities::W3c::Membership
 
         def initialize
           super
@@ -29,4 +35,4 @@ module Caliper
       end
     end
   end
-end
+end

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

@@ -1,10 +1,22 @@
-require_relative '../../entities/entity'
-require_relative '../../entities/foaf/agent.rb'
-require_relative '../../entities/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/.
+
+#
+# LTI LIS roles.
 #
 module Caliper
   module Entities
@@ -74,4 +86,4 @@ module Caliper
       end
     end
   end
-end
+end

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

@@ -1,10 +1,22 @@
-require_relative '../../entities/entity'
-require_relative '../../entities/foaf/agent.rb'
-require_relative '../../entities/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/.
+
+#
+# LIS Status
 #
 module Caliper
   module Entities
@@ -16,4 +28,4 @@ module Caliper
       end
     end
   end
-end
+end

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

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

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

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

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

@@ -1,12 +1,28 @@
-require_relative '../../entities/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.
+#
+# 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 '../digital_resource'
 
 #
-# A time based location within a media object
+# A time based location within a media object.
 #
 module Caliper
   module Entities
     module Media
-
       class MediaLocation < DigitalResource
 
         attr_accessor :currentTime
@@ -16,7 +32,6 @@ module Caliper
           @type = DigitalResourceType::MEDIA_LOCATION
           @currentTime = nil
         end
-
       end
     end
   end

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

@@ -1,18 +1,31 @@
-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.
+#
+# 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 '../digital_resource'
 
 # 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).
+# stream (2 AudioObject's).  See From https://schema.org/MediaObject.
 #
-# 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'
@@ -22,7 +35,6 @@ module Caliper
 
       ## implement the interface Thing
       class MediaObject < DigitalResource
-        include Caliper::Entities::SchemaDotOrg::Thing
 
         attr_accessor :duration
 
@@ -31,7 +43,6 @@ module Caliper
           @type = DigitalResourceType::MEDIA_OBJECT
           @duration = nil
         end
-
       end
     end
   end

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

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

data/lib/caliper/entities/outcome/result.rb

@@ -1,9 +1,30 @@
+##
+# 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 '../generatable'
+
+#
+# LIS Result
+#
 module Caliper
 	module Entities
 		class Result < Entity
-			include Generatable
+			include Caliper::Entities::Generatable
 
 			attr_accessor :type, # String
 										:normal_score,
@@ -20,4 +41,4 @@ module Caliper
 
 		end
 	end
-end
+end

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

@@ -1,17 +1,33 @@
-require_relative "../digital_resource"
-
-# Public: Representation of an EPUB 3 Chapter.
+##
+# 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.
 #
-# A major structural division of a piece of writing
-# http://www.idpf.org/epub/vocab/structure/#chapter
+# 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'
 
+#
+# Representation of an EPUB 3 Chapter. A major structural division of a piece of writing.
+# See http://www.idpf.org/epub/vocab/structure/#chapter
+#
 module Caliper
   module Entities
     module Reading
-      class EpubChapter < DigitalResource
+      class EpubChapter < Caliper::Entities::DigitalResource
+
         def initialize()
 	        super
-          @id = id
           @type = DigitalResourceType::EPUB_CHAPTER
         end
       end

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

@@ -1,20 +1,36 @@
-# Public: Representation of an EPUB 3 Part
-# A major structural division of a piece of writing, typically
-# encapsulating a set of related chapters.
-# http://www.idpf.org/epub/vocab/structure/#part
+##
+# 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 "../digital_resource"
+require_relative '../digital_resource'
 
+#
+# Representation of an EPUB 3 Part. A major structural division of a piece of writing, typically
+# encapsulating a set of related chapters. See http://www.idpf.org/epub/vocab/structure/#part.
+#
 module Caliper
   module Entities
     module Reading
-      class EpubPart < ::Caliper::Entity::DigitalResource
+      class EpubPart < Caliper::Entities::DigitalResource
+
         def initialize()
 	        super
-          @id = ""
           @type = DigitalResourceType::EPUB_PART
         end
       end
     end
   end
-end
+end