ims_caliper 0.9.3.15 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d787d10711e9df110e47808696cc7320a4d38fac
-  data.tar.gz: 829240aa1cfbc63aa8738b15f12f460da5f9b83a
+  metadata.gz: c8f8b82d69f8412b3be27a29ec5e9f3f8e144acd
+  data.tar.gz: d24cffc6b24c29129a31d48fe2f0d22670dc2c09
 SHA512:
-  metadata.gz: 241b1e7dd90b7cb2fe680f1c4de7ef53576d4d3b1694593ed44c64116d4c7f9a7bc95804f3b231ac8f855b9e51d3025736923238ac47f2eb1df9d4ed02cebde9
-  data.tar.gz: 15fc41e4d02518ac66a10f7f1f790846377c7a8769f02b0d3bad81ec4d19ffb7397f25f8be2a4a06b9d001d5ebb866dd19a236144e7d9293321944ee95d366f7
+  metadata.gz: 2821a168e5d3eb6b99ffe53fa0d3625ea77d7dca06c362a799589cdc90c41eddf467c68dbde78fa7f74f29c7c1c27f62d810835a0e15c8c5c94581bca0f1809d
+  data.tar.gz: bdaf13f3aa7de2f4402e0e7c688db8663601a1345f427b657c3159028c9ea013f3dd7fc656fdf6013b2feb7d2705c50455ce0c0bdc9d46802b2a508a5beb27e5

data/README.md

@@ -1,7 +1,7 @@
-caliper-ruby
+IMS Global caliper-ruby
 ===================
 
-caliper-ruby is a Ruby client for [Caliper](http://www.imsglobal.org) that provides a Ruby implementation of the Caliper Sensor API
+caliper-ruby is a Ruby client for [Caliper](http://www.imsglobal.org/caliper) that provides an implementation of the Caliper SensorAPI™.
 
 ## development notes
 To set up dev environment and run specs
@@ -19,6 +19,11 @@ To run specs, you need to clone caliper-common-fixtures at the same level as cal
 
 gem build caliper.gemspec
 
-### Use Ruby Style Guide:
-https://github.com/styleguide/ruby
-https://github.com/bbatsov/ruby-style-guide
+## Documentation
+
+Documentation is available at [http://www.imsglobal.org/caliper](https://www.imsglobal.org/caliper).
+
+©2015 IMS Global Learning Consortium, Inc. All Rights Reserved.
+Trademark Information - http://www.imsglobal.org/copyright.html
+
+For license information contact, info@imsglobal.org and read the license file contained in the repository.

data/lib/caliper/{profiles/annotation_profile.rb → actions/annotation_actions.rb}

@@ -15,16 +15,12 @@
 # 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 './profile'
-require_relative '../entities/digital_resource'
-require_relative '../entities/annotation/annotation'
-require_relative '../entities/reading/frame'
-
 #
-# Annotation Profile.
+# Annotation actions.
 #
+
 module Caliper
-  module Profiles
+  module Actions
     module AnnotationActions
       ATTACHED = "http://purl.imsglobal.org/vocab/caliper/v1/action#Attached"
       BOOKMARKED = "http://purl.imsglobal.org/vocab/caliper/v1/action#Bookmarked"
@@ -44,39 +40,5 @@ module Caliper
       SUBSCRIBED = "http://purl.imsglobal.org/vocab/caliper/v1/action#Subscribed"
       TAGGED = "http://purl.imsglobal.org/vocab/caliper/v1/action#Tagged"
     end
-
-    class ReadingProfile < Profile
-      include AnnotationActions
-      attr_accessor :key, # String
-        :lookup # hash of ReadingActions
-
-      # whether object if of type DigitalResource
-      def validate_object (object)
-        if  (object.is_a? AnnotationType::BOOKMARK_ANNOTATION)
-          ## TODO check required properties
-          return object
-        elsif (object.is_a? AnnotationType::HIGHLIGHT_ANNOTATION)
-          ## TODO check required properties
-          return object
-        elsif  (object.is_a? AnnotationType::SHARED_ANNOTATION)
-          ## TODO check required properties
-          return object
-        elsif  (object.is_a? AnnotationType::TAG_ANNOTATION)
-          ## TODO check required properties
-          return object
-        else
-          fail "Object must be of type Annotation"
-        end
-      end
-
-      # whether target is of type Frame
-      def validate_target(target)
-        if (target is_a? Frame)
-          return target
-        else
-          fail "Target must be of type Frame."
-        end
-      end
-    end
   end
 end

data/lib/caliper/{profiles/assessment_profile.rb → actions/assessment_actions.rb}

@@ -15,33 +15,17 @@
 # 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 './profile'
-
 #
-# Assessment Profile.
+# Assessment actions.
 #
+
 module Caliper
-  module Profiles
+  module Actions
     module AssessmentActions
       PAUSED = "http://purl.imsglobal.org/vocab/caliper/v1/action#Paused"
       RESTARTED = "http://purl.imsglobal.org/vocab/caliper/v1/action#Restarted"
       STARTED = "http://purl.imsglobal.org/vocab/caliper/v1/action#Started"
       SUBMITTED = "http://purl.imsglobal.org/vocab/caliper/v1/action#Submitted"
     end
-
-    class AssessmentProfile < Caliper::Profiles::Profile
-
-      attr_accessor :key, # String
-        :lookup # hash of AssessmentActions
-
-      # whether object if of type DigitalResource
-      def validate_object(object)
-        if (object.is_a? DigitalResource)
-          return object
-        else
-          fail 'Object must be of type DigitalResource'
-        end
-      end
-    end
   end
 end

data/lib/caliper/actions/assessment_item_actions.rb

@@ -0,0 +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/.
+
+#
+# Assessment item actions.
+#
+
+module Caliper
+  module Actions
+    module AssessmentItemActions
+      COMPLETED = "http://purl.imsglobal.org/vocab/caliper/v1/action#Completed"
+      REVIEWED = "http://purl.imsglobal.org/vocab/caliper/v1/action#Reviewed"
+      SKIPPED = "http://purl.imsglobal.org/vocab/caliper/v1/action#Skipped"
+      STARTED = "http://purl.imsglobal.org/vocab/caliper/v1/action#Started"
+    end
+  end
+end

data/lib/caliper/{profiles/assignable_profile.rb → actions/assignable_actions.rb}

@@ -15,13 +15,12 @@
 # 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 './profile'
-
 #
-# Assignable Profile.
+# Assignable actions.
 #
+
 module Caliper
-  module Profiles
+  module Actions
     module AssignableActions
       ABANDONED = "http://purl.imsglobal.org/vocab/caliper/v1/action#Abandoned"
       ACTIVATED = "http://purl.imsglobal.org/vocab/caliper/v1/action#Activated"
@@ -33,29 +32,5 @@ module Caliper
       STARTED = "http://purl.imsglobal.org/vocab/caliper/v1/action#Started"
       SUBMITTED = "http://purl.imsglobal.org/vocab/caliper/v1/action#Submitted"
     end
-
-    class AssignableProfile < Caliper::Profiles::Profile
-
-      attr_accessor :key, # String
-        :lookup # hash of AssignableActions
-
-      # whether object if of type DigitalResource
-      def validate_object(object)
-        if (object.is_a? DigitalResource)
-          return object
-        else
-          fail 'Object must e of type DigitalResource'
-        end
-      end
-
-      # whether target is of type Frame
-      def validate_target(target)
-        if (target is_a? frame)
-          return target
-        else
-          fail 'Target must be of type Frame'
-        end
-      end
-    end
   end
 end

data/lib/caliper/{profiles/media_profile.rb → actions/media_actions.rb}

@@ -15,13 +15,12 @@
 # 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 './profile'
-
 #
-# Media Profile.
+# Media actions.
 #
+
 module Caliper
-  module Profiles
+  module Actions
     module MediaActions
       CHANGED_RESOLUTION = "http://purl.imsglobal.org/vocab/caliper/v1/action#ChangedResolution"
       CHANGED_SIZE = "http://purl.imsglobal.org/vocab/caliper/v1/action#ChangedSize"
@@ -43,29 +42,5 @@ module Caliper
       STARTED = "http://purl.imsglobal.org/vocab/caliper/v1/action#Started"
       UNMUTED = "http://purl.imsglobal.org/vocab/caliper/v1/action#Unmuted"
     end
-
-    class MediaProfile < Caliper::Profiles::Profile
-
-      attr_accessor :key, # String
-        :lookup # hash of MediaActions
-
-      # whether object if of type DigitalResource
-      def validate_object(object)
-        if (object.is_a? DigitalResource)
-          return object
-        else
-          fail "Object must e of type DigitalResource"
-        end
-      end
-
-      # whether target is of type Frame
-      def validate_target(target)
-        if (target is_a? frame)
-          return target
-        else
-          fail "Target must be of type Frame."
-        end
-      end
-    end
   end
-end
+end

data/lib/caliper/{event/view_event.rb → actions/navigation_actions.rb}

@@ -15,20 +15,14 @@
 # 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 './event'
-
 #
-# View Event per the Caliper Base Profile.
+# Profile actions.
 #
-module Caliper
-  module Event
-    class ViewEvent < Event
 
-      def initialize
-        super
-        @type = EventType::VIEW
-        @context = EventContext::VIEW
-      end
+module Caliper
+  module Actions
+    module NavigationActions
+      NAVIGATED_TO = "http://purl.imsglobal.org/vocab/caliper/v1/action#NavigatedTo"
     end
   end
 end

data/lib/caliper/{validators/event_validator_context.rb → actions/outcome_actions.rb}

@@ -16,21 +16,13 @@
 # with this program. If not, see http://www.gnu.org/licenses/.
 
 #
-# Event Validator context.
+# Outcome actions.
 #
-module Caliper
-	module Validators
-		class EventValidatorContext
-			attr_accessor :validator
-
-			def initialize(validator)
-				@validator = validator
-			end
 
-			def validate (event)
-				# do the validation
-				return @validator.validate(event)
-			end
-		end
-	end
+module Caliper
+  module Actions
+    module OutcomeActions
+      GRADED = "http://purl.imsglobal.org/vocab/caliper/v1/action#Graded"
+    end
+  end
 end

data/lib/caliper/{event/navigation_event.rb → actions/reading_actions.rb}

@@ -15,23 +15,15 @@
 # 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 './event'
-
 #
-# Navigation Event.
+# Reading actions.
 #
-module Caliper
-  module Event
-    class NavigationEvent < Event
 
-      attr_accessor :navigatedFrom
-
-      def initialize
-	      super
-	      @context = EventContext::NAVIGATION
-	      @type = EventType::NAVIGATION
-        @navigatedFrom = nil
-      end
+module Caliper
+  module Actions
+    module ReadingActions
+      SEARCHED = "http://purl.imsglobal.org/vocab/caliper/v1/action#Searched"
+      VIEWED = "http://purl.imsglobal.org/vocab/caliper/v1/action#Viewed"
     end
   end
 end

data/lib/caliper/actions/session_actions.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/.
+
+#
+# Session actions.
+#
+
+module Caliper
+  module Actions
+    module SessionActions
+      LOGGED_IN = 'http://purl.imsglobal.org/vocab/caliper/v1/action#LoggedIn'
+      LOGGED_OUT = 'http://purl.imsglobal.org/vocab/caliper/v1/action#LoggedOut'
+      TIMED_OUT = 'http://purl.imsglobal.org/vocab/caliper/v1/action#TimedOut'
+    end
+  end
+end

data/lib/caliper/context/context.rb

@@ -0,0 +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/.
+
+#
+# JSON-LD context.
+#
+
+module Caliper
+  module Context
+    module Context
+      CONTEXT = "http://purl.imsglobal.org/ctx/caliper/v1/Context"
+      # ENTITY = "http://purl.imsglobal.org/ctx/caliper/v1/Entity"
+      # ENVELOPE = "http://purl.imsglobal.org/caliper/ctx/v1/Envelope"
+      # EVENT = "http://purl.imsglobal.org/ctx/caliper/v1/Event"
+    end
+  end
+end

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

@@ -15,7 +15,8 @@
 # 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 '../entity_base'
+require_relative '../entity_type'
 require_relative '../w3c/organization'
 
 #
@@ -24,7 +25,7 @@ require_relative '../w3c/organization'
 module Caliper
   module Entities
     module Agent
-      class Organization < Entity
+      class Organization < EntityBase
         include Caliper::Entities::FOAF::Agent,
                 Caliper::Entities::W3C::Organization
 
@@ -32,7 +33,7 @@ module Caliper
 
         def initialize
           super
-          @type = EntityType::ORGANIZATION
+          @type = Caliper::Entities::EntityType::ORGANIZATION
         end
       end
     end

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

@@ -15,7 +15,8 @@
 # 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 '../entity_base'
+require_relative '../entity_type'
 require_relative '../foaf/agent.rb'
 
 #
@@ -25,12 +26,12 @@ require_relative '../foaf/agent.rb'
 module Caliper
   module Entities
     module Agent
-      class Person < Entity
+      class Person < EntityBase
         include Caliper::Entities::FOAF::Agent
 
         def initialize
           super
-          @type = EntityType::PERSON
+          @type = Caliper::Entities::EntityType::PERSON
         end
       end
     end