ims_caliper 0.1.3 → 0.9.0

data/lib/caliper/entity_envelope.rb

@@ -1,15 +1,28 @@
-require_relative "options"
-require_relative 'jsonable'
 ##
+# This file is part of IMS Caliper Analytics™ and is licensed to
+# IMS Global Learning Consortium, Inc. (http://www.imsglobal.org)
+# under one or more contributor license agreements.  See the NOTICE
+# file distributed with this work for additional information.
 #
-#  @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.
 #
-# Caliper Sensor Entity Envelope
+# 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 'rest_client'
+require_relative "./options"
+require_relative './jsonable'
+
+#
+# Caliper Sensor Entity Envelope.
 #
 module Caliper
-
   class EntityEnvelope
   	include Caliper::Jsonable
 
@@ -17,4 +30,4 @@ module Caliper
       :sensorId,
       :entity
   end
-end
+end

data/lib/caliper/event/annotation_event.rb

@@ -1,12 +1,27 @@
-require_relative 'event'
-require_relative '../profiles/annotation_profile'
+##
+# 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 './event'
+
+#
+# Annotation Event per Caliper Annotation Profile.
+#
 module Caliper
   module Event
-
-    #
-    # Annotation Event per Caliper Annotation Profile
-    #
     class AnnotationEvent < Event
 
       def initialize

data/lib/caliper/event/assessment_event.rb

@@ -1,5 +1,25 @@
-require_relative 'event'
+##
+# 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 './event'
+
+#
+# Assessment Event.
+#
 module Caliper
   module Event
     class AssessmentEvent < Event
@@ -16,4 +36,4 @@ module Caliper
       end
     end
   end
-end
+end

data/lib/caliper/event/assessment_item_event.rb

@@ -1,5 +1,25 @@
-require_relative 'event'
+##
+# 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 './event'
+
+#
+# AssessmentItem Event.
+#
 module Caliper
   module Event
     class AssessmentItemEvent < Event
@@ -16,4 +36,4 @@ module Caliper
       end
     end
   end
-end
+end

data/lib/caliper/event/assignable_event.rb

@@ -1,5 +1,25 @@
-require_relative 'event'
+##
+# 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 './event'
+
+#
+# Assignable Event.
+#
 module Caliper
   module Event
     class AssignableEvent < Event
@@ -16,4 +36,4 @@ module Caliper
       end
     end
   end
-end
+end

data/lib/caliper/event/event.rb

@@ -1,6 +1,26 @@
+##
+# This file is part of IMS Caliper Analytics™ and is licensed to
+# IMS Global Learning Consortium, Inc. (http://www.imsglobal.org)
+# under one or more contributor license agreements.  See the NOTICE
+# file distributed with this work for additional information.
+#
+# IMS Caliper is free software: you can redistribute it and/or modify it under
+# the terms of the GNU Lesser General Public License as published by the Free
+# Software Foundation, version 3 of the License.
+#
+# IMS Caliper is distributed in the hope that it will be useful, but WITHOUT
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
+# A PARTICULAR PURPOSE.  See the GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License along
+# with this program. If not, see http://www.gnu.org/licenses/.
+
 require 'json'
 require_relative './jsonable'
 
+#
+# Base event.
+#
 module Caliper
   module Event
     module EventContext
@@ -15,6 +35,7 @@ module Caliper
       SESSION = "http://purl.imsglobal.org/ctx/caliper/v1/SessionEvent"
       VIEW = "http://purl.imsglobal.org/ctx/caliper/v1/ViewEvent"
     end
+
     module EventType
       ANNOTATION = "http://purl.imsglobal.org/caliper/v1/AnnotationEvent"
       ASSESSMENT = "http://purl.imsglobal.org/caliper/v1/AssessmentEvent"
@@ -27,6 +48,7 @@ module Caliper
       SESSION = "http://purl.imsglobal.org/caliper/v1/SessionEvent"
       VIEW = "http://purl.imsglobal.org/caliper/v1/ViewEvent"
     end
+
     class Event
       include Caliper::Event::Jsonable
 
@@ -85,4 +107,4 @@ module Caliper
       end
     end
   end
-end
+end

data/lib/caliper/event/jsonable.rb

@@ -1,9 +1,22 @@
+##
+# This file is part of IMS Caliper Analytics™ and is licensed to
+# IMS Global Learning Consortium, Inc. (http://www.imsglobal.org)
+# under one or more contributor license agreements.  See the NOTICE
+# file distributed with this work for additional information.
+#
+# IMS Caliper is free software: you can redistribute it and/or modify it under
+# the terms of the GNU Lesser General Public License as published by the Free
+# Software Foundation, version 3 of the License.
+#
+# IMS Caliper is distributed in the hope that it will be useful, but WITHOUT
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
+# A PARTICULAR PURPOSE.  See the GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License along
+# with this program. If not, see http://www.gnu.org/licenses/.
+
 require 'json'
 
-#
-#  
-#  @copyright @copyright ©2013 IMS Global Learning Consortium, Inc.  All Rights Reserved.
-#  @license For license information contact, info@imsglobal.org
 #
 #  Module that supports ser-des for Caliper Event/JSON
 #
@@ -49,7 +62,6 @@ module Caliper
       def eql?(other)
         @context == other.context && @type == other.type && @startedAtTime == other.startedAtTime && @endedAtTime == other.endedAtTime
       end
-
     end
   end
-end
+end

data/lib/caliper/event/media_event.rb

@@ -1,5 +1,25 @@
-require_relative 'event'
+##
+# 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 './event'
+
+#
+# Media Event.
+#
 module Caliper
   module Event
     class MediaEvent < Event
@@ -16,4 +36,4 @@ module Caliper
       end
     end
   end
-end
+end

data/lib/caliper/event/navigation_event.rb

@@ -1,6 +1,25 @@
-require_relative 'event'
-require_relative '../profiles/profile'
+##
+# 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 './event'
+
+#
+# Navigation Event.
+#
 module Caliper
   module Event
     class NavigationEvent < Event
@@ -15,4 +34,4 @@ module Caliper
       end
     end
   end
-end
+end

data/lib/caliper/event/outcome_event.rb

@@ -1,6 +1,25 @@
-require_relative 'event'
-require_relative '../profiles/profile'
+##
+# 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 './event'
+
+#
+# Outcome Event.
+#
 module Caliper
   module Event
     class OutcomeEvent < Event
@@ -17,4 +36,4 @@ module Caliper
       end
     end
   end
-end
+end

data/lib/caliper/event/session_event.rb

@@ -1,20 +1,34 @@
-require_relative 'event'
-require_relative '../profiles/session_profile'
+##
+# 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 './event'
+
+#
+# Session Event per the Caliper Session Profile.
+#
 module Caliper
   module Event
-    
     class SessionEvent < Event
 
-      #
-      # Session Event per the Caliper Session Profile
-      # 
       def initialize
         super
         @context = Caliper::Event::EventContext::SESSION
         @type = Caliper::Event::EventType::SESSION
       end
-
     end
   end
 end

data/lib/caliper/event/view_event.rb

@@ -1,19 +1,33 @@
-require_relative 'event'
-require_relative '../profiles/reading_profile.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 './event'
+
+#
+# View Event per the Caliper Base Profile.
+#
 module Caliper
   module Event
-
     class ViewEvent < Event
 
-      #
-      # Viewed Event per the Caliper Base Profile
-      #
       def initialize
         @type = EventType::VIEW
         @context = EventContext::VIEW
       end
-
     end
   end
-end
+end

data/lib/caliper/event_envelope.rb

@@ -1,16 +1,28 @@
-require_relative "options"
-require_relative 'jsonable'
-
 ##
+# This file is part of IMS Caliper Analytics™ and is licensed to
+# IMS Global Learning Consortium, Inc. (http://www.imsglobal.org)
+# under one or more contributor license agreements.  See the NOTICE
+# file distributed with this work for additional information.
 #
-#  @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.
 #
-# Caliper Sensor Event Envelope
+# 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 'rest_client'
+require_relative "./options"
+require_relative './jsonable'
+
+#
+# Caliper Sensor Event Envelope.
 #
 module Caliper
-
   class EventEnvelope
     include Caliper::Jsonable
 
@@ -18,4 +30,4 @@ module Caliper
       :sensorId,
       :event
   end
-end
+end

data/lib/caliper/jsonable.rb

@@ -1,9 +1,22 @@
-require 'json'
-
+##
+# 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 'json'
+
 #
 #  Module that supports ser-des for Caliper Envelope
 #
@@ -27,7 +40,12 @@ module Caliper
         next if (key[1..-1] == 'context' || key[1..-1] == 'type')
         value = self.instance_variable_get key
         # puts "setting #{key}: #{value}"
-        result[key[1..-1]] = value
+        attribute_key = key[1..-1]
+        if (key[1..-1] == 'id' || key[1..-1] == 'type' || key[1..-1] == 'context')
+	        ## prefix with @ char for linked json data
+	        attribute_key = "@#{attribute_key}"
+        end
+        result[attribute_key] = value
       end
       result.to_json(*a)
     end
@@ -48,6 +66,5 @@ module Caliper
     def eql?(other)
       @sensorId == other.sensorId && @apiKey == other.apiKey
     end
-
   end
-end
+end

data/lib/caliper/options.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/.
+
+#
+# Options
+#
 module Caliper
   class Options
     attr_accessor :api_key
@@ -14,5 +34,4 @@ module Caliper
 		@host = host
 		@time_out = time_out
 	end
-
-end
+end

data/lib/caliper/profiles/annotation_profile.rb

@@ -1,11 +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 './profile'
 require_relative '../entities/digital_resource'
 require_relative '../entities/annotation/annotation'
 require_relative '../entities/reading/frame'
 
+#
+# Annotation Profile.
+#
 module Caliper
   module Profiles
-
     module AnnotationActions
       ATTACHED = "http://purl.imsglobal.org/vocab/caliper/v1/action#Attached"
       BOOKMARKED = "http://purl.imsglobal.org/vocab/caliper/v1/action#Bookmarked"
@@ -24,7 +43,6 @@ module Caliper
       SHARED = "http://purl.imsglobal.org/vocab/caliper/v1/action#Shared"
       SUBSCRIBED = "http://purl.imsglobal.org/vocab/caliper/v1/action#Subscribed"
       TAGGED = "http://purl.imsglobal.org/vocab/caliper/v1/action#Tagged"
-      NAVIGATED_TO = "http://purl.imsglobal.org/vocab/caliper/v1/action#NavigatedTo"
     end
 
     class ReadingProfile < Profile
@@ -61,4 +79,4 @@ module Caliper
       end
     end
   end
-end
+end

data/lib/caliper/profiles/assessment_item_profile.rb

@@ -0,0 +1,48 @@
+##
+# 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 './profile'
+
+#
+# Assessment Profile.
+#
+module Caliper
+  module Profiles
+    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"
+      VIEWED = "http://purl.imsglobal.org/vocab/caliper/v1/action#Viewed"
+    end
+
+    class AssessmentItemProfile < Caliper::Profiles::Profile
+
+      attr_accessor :key, # String
+                    :lookup # hash of AssessmentItemActions
+
+      # 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