ims_caliper 0.1.3 → 0.9.0

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

@@ -1,16 +1,33 @@
-# Public: Representation of an EPUB 3 subchapter
-# A major sub-division of a chapter
-# http://www.idpf.org/epub/vocab/structure/#subchapter
+##
+# 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 subchapter.  A major sub-division of a chapter.
+# See http://www.idpf.org/epub/vocab/structure/#subchapter.
+#
 module Caliper
   module Entities
     module Reading
       class EpubSubChapter < Caliper::Entities::DigitalResource
+
         def initialize()
 	        super
-          @id = ""
           @type = DigitalResourceType::EPUB_SUB_CHAPTER
         end
       end

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

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

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

@@ -1,14 +1,31 @@
+##
+# 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 '../../entities/digital_resource'
 require_relative '../../entities/targetable'
-require_relative '../../entities/jsonable'
 
+#
+# A Frame
+#
 module Caliper
 	module Entities
 		module Reading
-
-			class Frame < DigitalResource
-				include Targetable
-				include Caliper::Entities::Jsonable
+			class Frame < Caliper::Entities::DigitalResource
+				include Caliper::Entities::Targetable
 
 				attr_accessor :index
 
@@ -17,7 +34,6 @@ module Caliper
 					@type = DigitalResourceType::FRAME
 					@index = 0
 				end
-
 			end
 		end
 	end

data/lib/caliper/entities/reading/web_page.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 "../../entities/digital_resource"
+require_relative "../../entities/schemadotorg/web_page"
+
+#
+# Web Page
+#
+module Caliper
+	module Entities
+		module Reading
+			class WebPage < Caliper::Entities::DigitalResource
+				include Caliper::Entities::SchemaDotOrg::WebPage
+
+				def initialize()
+					super
+					@type = Caliper::Entities::DigitalResourceType::WEB_PAGE
+        end
+			end
+		end
+	end
+end

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

@@ -1,9 +1,27 @@
-require "require_all"
-require_all 'lib/caliper/entities/response/response_type.rb'
+##
+# 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 './response'
+require_relative './response_type'
+
 #
 # Represents response text or integer/decimal/scientific numbers that completes a question
 # designed with one or more "fill in the blank" option prompts.
-
+#
 module Caliper
 	module Entities
 		module Response

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

@@ -1,9 +1,26 @@
-require "require_all"
-require_all 'lib/caliper/entities/response/response_type.rb'
+##
+# 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.
 #
-# Represents a response to a multiple choice question that permits a single option to be selected
+# 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 './response'
+require_relative './response_type'
 
+#
+# Represents a response to a multiple choice question that permits a single option to be selected
+#
 module Caliper
 	module Entities
 		module Response

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

@@ -1,9 +1,26 @@
-require "require_all"
-require_all 'lib/caliper/entities/response/response_type.rb'
+##
+# 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.
 #
-# Representation of a response to a multiple choice question that permits one or more options to be selected.
+# 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 './response'
+require_relative './response_type'
 
+#
+# Representation of a response to a multiple choice question that permits one or more options to be selected.
+#
 module Caliper
 	module Entities
 		module Response

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

@@ -1,11 +1,32 @@
-require "require_all"
-require_all 'lib/caliper/entities/generatable.rb'
+##
+# 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'
+
+#
+# A Response
+#
 module Caliper
 	module Entities
 		module Response
 			class Response < Entity
-				include Generatable
+				include Caliper::Entities::Generatable
+
 				attr_accessor :type,
 			                :assignable,
 			                :actor,

data/lib/caliper/entities/response/response_type.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/.
+
+#
+# Response types.
+#
 module Caliper
 	module Entities
 		module Response

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

@@ -1,9 +1,27 @@
-require "require_all"
-require_all 'lib/caliper/entities/response/response_type.rb'
+##
+# 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.
 #
-# Represents a response that identifies text from a presented paragraph or list.
-# The response is the identified string or a mapping to a logical identifier;
+# 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 './response'
+require_relative './response_type'
 
+#
+# Represents a response that identifies text from a presented paragraph or list.
+# The response is the identified string or a mapping to a logical identifier.
+#
 module Caliper
 	module Entities
 		module Response
@@ -13,7 +31,7 @@ module Caliper
 
 				def initialize
 					@type = ResponseType::SELECTTEXT
-				end
+        end
 			end
 		end
 	end

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

@@ -1,10 +1,27 @@
-require "require_all"
-require_all 'lib/caliper/entities/response/response_type.rb'
+##
+# 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 './response'
+require_relative './response_type'
+
 #
 # Represents response to a multiple choice question that limits options to either 'true or false',
 # 'agree or disagree', etc.
 #
-
 module Caliper
 	module Entities
 		module Response

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

@@ -1,6 +1,26 @@
-require_relative '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 './thing'
+
+#
 # The most generic kind of creative work, including books, movies,
-# photographs, software programs, etc
+# photographs, software programs, etc.
+#
 module Caliper
 	module Entities
 		module SchemaDotOrg

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

@@ -1,5 +1,25 @@
-require_relative 'creative_work'
+##
+# 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 './creative_work'
+
+#
+# Software Application.
+#
 module Caliper
   module Entities
     module SchemaDotOrg
@@ -8,4 +28,4 @@ module Caliper
       end
     end
   end
-end
+end

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

@@ -1,4 +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/.
+
+#
 # the most generic type of item
+#
 module Caliper
 	module Entities
 		module SchemaDotOrg

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

@@ -1,5 +1,25 @@
-require_relative "creative_work"
+##
+# 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 './creative_work'
+
+#
+# Web Page.
+#
 module Caliper
 	module Entities
 		module SchemaDotOrg
@@ -8,4 +28,4 @@ module Caliper
 			end
 		end
 	end
-end
+end

data/lib/caliper/entities/session/session.rb

@@ -0,0 +1,44 @@
+##
+# 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'
+require_relative '../targetable'
+
+#
+#  Session Entity.
+#
+module Caliper
+  module Entities
+    module Session
+      class Session < Entity
+        include Caliper::Entities::Generatable,
+                Caliper::Entities::Targetable
+
+        attr_accessor :actor,
+                      :startedAtTime,
+                      :endedAtTime,
+                      :duration
+
+        def initialize
+          super
+          @type = EntityType::SESSION
+        end
+      end
+    end
+  end
+end

data/lib/caliper/entities/targetable.rb

@@ -1,12 +1,28 @@
+##
+# 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 targetable interface marks an object type that provides coordinates to a target destination
+#
+# The Targetable interface marks an object type that provides coordinates to a target destination
 # required by certain actions.  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 Targetable
-
 		end
 	end
 end

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

@@ -0,0 +1,32 @@
+##
+# 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/.
+
+#
+#  W3C Membership.
+#
+module Caliper
+  module Entities
+    module W3c
+      module Membership
+        attr_accessor :member,
+                      :organization,
+                      :roles,
+                      :status
+      end
+    end
+  end
+end

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

@@ -0,0 +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/.
+
+#
+# A W3C Organization.
+#
+module Caliper
+  module Entities
+    module W3c
+      module Organization
+        attr_accessor :membership,
+                      :subOrganizationOf
+      end
+    end
+  end
+end