ims_caliper 0.1.3 → 0.9.0

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    NDY2Y2Q2YzM0NjExMTU0NzZlNzAyY2ZmZjFjMWE2ZjNkOGZmYTY2ZQ==
-  data.tar.gz: !binary |-
-    YTE4MTRhMGU4YjU0YWEyOWQ2MmI1NDM3OWVjMmFhOGEzMjJhNDE0Ng==
+SHA1:
+  metadata.gz: 5190a42cf274fb1d2e5e327153bb671f70ceb4ec
+  data.tar.gz: 627dca09a9554f4b88c6af4b61e4661f15c7093e
 SHA512:
-  metadata.gz: !binary |-
-    YjViMzRhMjQ2MTEzZjc2NjQ4MzA4ODM5MjY2MGUzMDA5MGQ2NDVmNGY2ZjYy
-    MDhjM2E4Yjc2MzliMjg4MjQwMGVlYzRjZmU0NDljOGZhNGQ5NzRkOTRiZGI4
-    MzM2MjkwNmYyMGMxNDY4OWI1N2IyMjAxODkwMTEwYzZkZTJiOTY=
-  data.tar.gz: !binary |-
-    ZWIzNWNiMDA0M2JhZWE2MzJhYjgyYjUwMGRmMmY2ZTAyMzZlMTE0ZDY1M2Q5
-    ZjY5NjkwOTAwMjcxYjZjMmZiYmYzODBkZTE2ZWU4YzRkMDRmMjliMjhhM2Yw
-    NTMzZWU5MTYxNjIwYTgxZmJiNjM5NTg2MjJjYTcxZjFhZGIzMzU=
+  metadata.gz: 20d5538ccbd0430abfcee5a4856d7566487f8c9031bade4b181851e65534b868c186e29971845bdb25cdd1e63881211595f1ee2679ff19c44dc7254164e9b4d3
+  data.tar.gz: 1f7aa585e027a00eb22b5c71581dbcd35c1a7df6205b8cf338640171f63fd6bcb92e901f43a328302d91e3dcfb9fce51da06bc78f835cdf37dc4ab59e90ea838

data/.gitignore

@@ -35,3 +35,6 @@ build/
 
 # unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
 .rvmrc
+
+## RubyMine
+.idea/*

data/LICENSE

@@ -1,67 +1,165 @@
-
 GNU LESSER GENERAL PUBLIC LICENSE
-
 Version 3, 29 June 2007
 
-Copyright � 2007 Free Software Foundation, Inc. <http://fsf.org/>
-
-Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.
-
-This version of the GNU Lesser General Public License incorporates the terms and conditions of version 3 of the GNU General Public License, supplemented by the additional permissions listed below.
-0. Additional Definitions.
-
-As used herein, �this License� refers to version 3 of the GNU Lesser General Public License, and the �GNU GPL� refers to version 3 of the GNU General Public License.
-
-�The Library� refers to a covered work governed by this License, other than an Application or a Combined Work as defined below.
-
-An �Application� is any work that makes use of an interface provided by the Library, but which is not otherwise based on the Library. Defining a subclass of a class defined by the Library is deemed a mode of using an interface provided by the Library.
-
-A �Combined Work� is a work produced by combining or linking an Application with the Library. The particular version of the Library with which the Combined Work was made is also called the �Linked Version�.
-
-The �Minimal Corresponding Source� for a Combined Work means the Corresponding Source for the Combined Work, excluding any source code for portions of the Combined Work that, considered in isolation, are based on the Application, and not on the Linked Version.
-
-The �Corresponding Application Code� for a Combined Work means the object code and/or source code for the Application, including any data and utility programs needed for reproducing the Combined Work from the Application, but excluding the System Libraries of the Combined Work.
-1. Exception to Section 3 of the GNU GPL.
-
-You may convey a covered work under sections 3 and 4 of this License without being bound by section 3 of the GNU GPL.
-2. Conveying Modified Versions.
-
-If you modify a copy of the Library, and, in your modifications, a facility refers to a function or data to be supplied by an Application that uses the facility (other than as an argument passed when the facility is invoked), then you may convey a copy of the modified version:
-
-    a) under this License, provided that you make a good faith effort to ensure that, in the event an Application does not supply the function or data, the facility still operates, and performs whatever part of its purpose remains meaningful, or
-    b) under the GNU GPL, with none of the additional permissions of this License applicable to that copy.
-
-3. Object Code Incorporating Material from Library Header Files.
-
-The object code form of an Application may incorporate material from a header file that is part of the Library. You may convey such object code under terms of your choice, provided that, if the incorporated material is not limited to numerical parameters, data structure layouts and accessors, or small macros, inline functions and templates (ten or fewer lines in length), you do both of the following:
-
-    a) Give prominent notice with each copy of the object code that the Library is used in it and that the Library and its use are covered by this License.
-    b) Accompany the object code with a copy of the GNU GPL and this license document.
-
-4. Combined Works.
-
-You may convey a Combined Work under terms of your choice that, taken together, effectively do not restrict modification of the portions of the Library contained in the Combined Work and reverse engineering for debugging such modifications, if you also do each of the following:
-
-    a) Give prominent notice with each copy of the Combined Work that the Library is used in it and that the Library and its use are covered by this License.
-    b) Accompany the Combined Work with a copy of the GNU GPL and this license document.
-    c) For a Combined Work that displays copyright notices during execution, include the copyright notice for the Library among these notices, as well as a reference directing the user to the copies of the GNU GPL and this license document.
-    d) Do one of the following:
-        0) Convey the Minimal Corresponding Source under the terms of this License, and the Corresponding Application Code in a form suitable for, and under terms that permit, the user to recombine or relink the Application with a modified version of the Linked Version to produce a modified Combined Work, in the manner specified by section 6 of the GNU GPL for conveying Corresponding Source.
-        1) Use a suitable shared library mechanism for linking with the Library. A suitable mechanism is one that (a) uses at run time a copy of the Library already present on the user's computer system, and (b) will operate properly with a modified version of the Library that is interface-compatible with the Linked Version.
-    e) Provide Installation Information, but only if you would otherwise be required to provide such information under section 6 of the GNU GPL, and only to the extent that such information is necessary to install and execute a modified version of the Combined Work produced by recombining or relinking the Application with a modified version of the Linked Version. (If you use option 4d0, the Installation Information must accompany the Minimal Corresponding Source and Corresponding Application Code. If you use option 4d1, you must provide the Installation Information in the manner specified by section 6 of the GNU GPL for conveying Corresponding Source.)
-
-5. Combined Libraries.
-
-You may place library facilities that are a work based on the Library side by side in a single library together with other library facilities that are not Applications and are not covered by this License, and convey such a combined library under terms of your choice, if you do both of the following:
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
 
-    a) Accompany the combined library with a copy of the same work based on the Library, uncombined with any other library facilities, conveyed under the terms of this License.
-    b) Give prominent notice with the combined library that part of it is a work based on the Library, and explaining where to find the accompanying uncombined form of the same work.
 
-6. Revised Versions of the GNU Lesser General Public License.
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
 
-The Free Software Foundation may publish revised and/or new versions of the GNU Lesser General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns.
+  0. Additional Definitions.
 
-Each version is given a distinguishing version number. If the Library as you received it specifies that a certain numbered version of the GNU Lesser General Public License �or any later version� applies to it, you have the option of following the terms and conditions either of that published version or of any later version published by the Free Software Foundation. If the Library as you received it does not specify a version number of the GNU Lesser General Public License, you may choose any version of the GNU Lesser General Public License ever published by the Free Software Foundation.
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
 
-If the Library as you received it specifies that a proxy can decide whether future versions of the GNU Lesser General Public License shall apply, that proxy's public statement of acceptance of any version is permanent authorization for you to choose that version for the Library.
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
 
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

data/NOTICE

@@ -1,15 +1,49 @@
-©2015 IMS Global Learning Consortium, Inc. All Rights Reserved.
+Copyright © 2015 IMS Global Learning Consortium, Inc. All Rights Reserved.
 
-Trademark Information- http://www.imsglobal.org/copyright.html
+Trademark Information -- http://www.imsglobal.org/copyright.html
 
-IMS Global Caliper Analytics™ APIs are publicly licensed as Open Source Software via GNU Lesser General Public License. LGPL v3.  Use of these APIs and/or code libraries does not signify achievement of IMS conformance certification. The official list of conformance certifications is available at http://www.imscert.org 
+IMS Global Learning Consortium, Inc. Caliper Analytics™ APIs are publicly
+licensed as Open Source Software via the GNU Lesser General Public License,
+LGPL v3 (https://www.gnu.org/licenses/lgpl.html).
 
-IMS Global also makes available an Alternative License based on the Apache 2.0 license.
-Licensees (via the Alternative License) are required to be IMS Global members. Membership in IMS  is a commitment by a supplier to the IMS community for ongoing support for achieving "plug and play" integration.  IMS Membership dues pay for ongoing maintenance for the Alternative License to be applicable to updates to the Caliper Analytics APIs and code libraries. The rationale for this dual-license approach and membership component is to help assure a requisite level of ongoing development, project management, and support for the software.
+Use of these APIs and/or code libraries does not signify achievement of IMS
+conformance certification.  The official list of conformance certifications is
+available at http://www.imscert.org.
 
-Licensees of IMS Global Caliper Analytics APIs and code libraries are strongly encouraged to become active contributors to the Caliper Analytics project and other projects within IMS Global. Prospective licensees should understand that their initial base contribution and ongoing membership fees are insufficient to fully fund the ongoing development and maintenance of Caliper APIs/code libraries and that voluntary contributions are the primary "fuel" ensuring any open source project's viability. Contributions can include development, bug fixing, bug reporting, performance analysis, and other aspects of the overall development process.
+IMS Global also makes available an Alternative License based on the Apache 2.0
+license. Licensees (via the Alternative License) are required to be IMS Global
+members. Membership in IMS Global is a commitment by a supplier to the IMS
+community for ongoing support for achieving "plug and play" integration. IMS
+Global Membership dues pay for ongoing maintenance for the Alternative License
+to be applicable to updates to the Caliper Analytics APIs and code libraries.
+The rationale for this dual-license approach and membership component is to
+help assure a requisite level of ongoing development, project management, and
+support for the software.
 
-Contributor status at the "github" level will be individual-based. Contributors will need to sign an IMS Global Contributor License Agreement (CLA) that grants IMS Global a license to contributions. 
+Licensees of IMS Global Caliper Analytics APIs and code libraries are strongly
+encouraged to become active contributors to the Caliper Analytics project and
+other projects within IMS Global. Prospective licensees should understand that
+their initial base contribution and ongoing membership fees are insufficient to
+fully fund the ongoing development and maintenance of Caliper APIs/code
+libraries and that voluntary contributions are the primary "fuel" ensuring any
+open source project's viability. Contributions can include development, bug
+fixing, bug reporting, performance analysis, and other aspects of the overall
+development process.
 
-If you are interested in licensing the IMS Global Caliper Analytics APIs/code libraries please email licenses@imsglobal.org
+Contributor status at the "Github" level will be individual-based. Contributors
+will need to sign an IMS Global Contributor License Agreement (CLA) that grants
+IMS Global a license to contributions.  If you are interested in licensing the
+IMS Global Caliper Analytics APIs/code libraries please email IMS Global
+(mailto:licenses@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/.

data/README.md

@@ -13,7 +13,7 @@ To set up dev environment and run specs
 #### _Note_
 To run specs, you need to clone caliper-common-fixtures at the same level as caliper-ruby.  Then please create a symlink similar to
 
-➜  caliper-ruby git:(master)  ln -s ../caliper-common-fixtures/src/test/resources/fixtures ./spec/fixtures
+➜  caliper-ruby git:(master)  ln -s ../../caliper-common-fixtures/src/test/resources/fixtures ./spec/fixtures
 
 ## generate the Ruby Gem
 
@@ -21,4 +21,4 @@ gem build caliper.gemspec
 
 ### Use Ruby Style Guide:
 https://github.com/styleguide/ruby
-https://github.com/bbatsov/ruby-style-guide
+https://github.com/bbatsov/ruby-style-guide

data/lib/caliper/defaults.rb

@@ -1,3 +1,23 @@
+##
+# 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/.
+
+#
+# Defaults
+#
 module Caliper
   class Defaults
     HOST = "http://dev-null.comt"
@@ -5,4 +25,4 @@ module Caliper
     SO_TIMEOUT = 10000
     CONNECTION_REQUEST_TIMEOUT = 10000
   end
-end
+end

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

@@ -0,0 +1,37 @@
+##
+# 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 '../w3c/organization'
+
+#
+# W3C Organization
+#
+module Caliper
+  module Entities
+    module Agent
+      class Organization < Entity
+        include Caliper::Entities::W3c::Organization
+
+        def initialize
+          super
+          @type = EntityType::ORGANIZATION
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,38 @@
+##
+# 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 '../foaf/agent.rb'
+
+#
+# An FOAF LIS Person
+# @extends Agent
+#
+module Caliper
+  module Entities
+    module Agent
+      class Person < Entity
+        include Caliper::Entities::FOAF::Agent
+
+        def initialize
+          super
+          @type = EntityType::PERSON
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,39 @@
+##
+# 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 '../foaf/agent'
+require_relative '../schemadotorg/software_application'
+
+#
+#  Software Application (from schema.org)
+#
+module Caliper
+  module Entities
+    module Agent
+      class SoftwareApplication < Entity
+        include Caliper::Entities::FOAF::Agent,
+                Caliper::Entities::SchemaDotOrg::SoftwareApplication
+
+        def initialize()
+          super
+          @type=EntityType::SOFTWARE_APPLICATION
+        end
+      end
+    end
+  end
+end

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

@@ -1,18 +1,29 @@
-require_relative '../../entities/entity'
-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.
 #
-#  
-#  @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'
+
 #
-#  Annotation Entity
+#  Annotation entity.
 #
 module Caliper
 	module Entities
 		module Annotation
-
 			module AnnotationType
 				ANNOTATION = "http://purl.imsglobal.org/caliper/v1/Annotation"
 				BOOKMARK_ANNOTATION = "http://purl.imsglobal.org/caliper/v1/BookmarkAnnotation"
@@ -23,7 +34,7 @@ module Caliper
 
 			## implement the interface Thing
 			class Annotation < Entity
-				include Caliper::Entities::SchemaDotOrg::Thing
+				include Caliper::Entities::Generatable
 
 				attr_accessor :annotated
 
@@ -33,7 +44,6 @@ module Caliper
 					@annotated = nil
 				end
 			end
-
 		end
 	end
-end
+end

data/lib/caliper/entities/annotation/bookmark_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.
+#
+# 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 './annotation'
+
 #
-#  Bookmark Annotation Entity
+#  Bookmark Annotation entity.
 #
 module Caliper
   module Entities
     module Annotation
-
       class BookmarkAnnotation < Annotation
         attr_accessor :bookmarkNotes
 
@@ -20,8 +31,7 @@ module Caliper
           @type = AnnotationType::BOOKMARK_ANNOTATION
           @bookmarkNotes = nil
         end
-
       end
     end
   end
-end
+end

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

@@ -1,12 +1,24 @@
-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.
 #
+# 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 './annotation'
+
 #
-#  Hilight Annotation Entity
+#  Highlight Annotation entity.
 #
 module Caliper
   module Entities
@@ -14,7 +26,7 @@ module Caliper
 
       class HighlightAnnotation < Annotation
         attr_accessor :selectionText,
-          :selection
+                      :selection
 
         def initialize()
           super
@@ -22,8 +34,7 @@ module Caliper
           @selectionText = nil
           @selection = {}
         end
-
       end
     end
   end
-end
+end