ims_caliper 0.1.1 → 0.1.2

data/lib/caliper/profiles/annotation_profile.rb

@@ -1,61 +1,64 @@
-
 require_relative './profile'
 require_relative '../entities/digital_resource'
 require_relative '../entities/annotation/annotation'
 require_relative '../entities/reading/frame'
 
 module Caliper
-	module Profiles
-		module AnnotationActions
-			ATTACHED = "annotation.attached"
-				BOOKMARKED = "annotation.bookmarked"
-				CLASSIFIED = "annotation.classified"
-				COMMENTED = "annotation.commented"
-				DESCRIBED = "annotation.described"
-				HIGHLIGHTED = "annotation.highlighted"
-				IDENTIFIED = "annotation.identified"
-				LIKED = "annotation.liked"
-				LINKED = "annotation.linked"
-				RANKED = "annotation.ranked"
-				QUESTIONED = "annotation.questioned"
-				RECOMMENDED = "annotation.recommended"
-				REPLIED = "annotation.replied"
-				SHARED = "annotation.shared"
-				SUBSCRIBED = "annotation.subscribed"
-				TAGGED = "annotation.tagged"
-		end
-		class ReadingProfile < Profile
-			include AnnotationActions
-			attr_accessor :key, # String
-										:lookup # hash of ReadingActions
+  module Profiles
+
+    module AnnotationActions
+      ATTACHED = "http://purl.imsglobal.org/vocab/caliper/v1/action#Attached"
+      BOOKMARKED = "http://purl.imsglobal.org/vocab/caliper/v1/action#Bookmarked"
+      CLASSIFIED = "http://purl.imsglobal.org/vocab/caliper/v1/action#Classified"
+      COMMENTED = "http://purl.imsglobal.org/vocab/caliper/v1/action#Commented"
+      DESCRIBED = "http://purl.imsglobal.org/vocab/caliper/v1/action#Described"
+      DISLIKED = "http://purl.imsglobal.org/vocab/caliper/v1/action#Disliked"
+      HIGHLIGHTED = "http://purl.imsglobal.org/vocab/caliper/v1/action#Highlighted"
+      IDENTIFIED = "http://purl.imsglobal.org/vocab/caliper/v1/action#Identified"
+      LIKED = "http://purl.imsglobal.org/vocab/caliper/v1/action#Liked"
+      LINKED = "http://purl.imsglobal.org/vocab/caliper/v1/action#Linked"
+      RANKED = "http://purl.imsglobal.org/vocab/caliper/v1/action#Ranked"
+      QUESTIONED = "http://purl.imsglobal.org/vocab/caliper/v1/action#Questioned"
+      RECOMMENDED = "http://purl.imsglobal.org/vocab/caliper/v1/action#Recommended"
+      REPLIED = "http://purl.imsglobal.org/vocab/caliper/v1/action#Replied"
+      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
+      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 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
+      # 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

@@ -0,0 +1,48 @@
+require_relative './profile'
+
+module Caliper
+  module Profiles
+
+    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"
+      NAVIGATED_TO = "http://purl.imsglobal.org/vocab/caliper/v1/action#NavigatedTo"
+    end
+
+    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"
+      NAVIGATED_TO = "http://purl.imsglobal.org/vocab/caliper/v1/action#NavigatedTo"
+    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 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/assignable_profile.rb

@@ -0,0 +1,44 @@
+require_relative './profile'
+
+module Caliper
+  module Profiles
+
+    module AssignableActions
+      ABANDONED = "http://purl.imsglobal.org/vocab/caliper/v1/action#Abandoned"
+      ACTIVATED = "http://purl.imsglobal.org/vocab/caliper/v1/action#Activated"
+      COMPLETED = "http://purl.imsglobal.org/vocab/caliper/v1/action#Completed"
+      DEACTIVATED = "http://purl.imsglobal.org/vocab/caliper/v1/action#Deactivated"
+      HID = "http://purl.imsglobal.org/vocab/caliper/v1/action#Hid"
+      REVIEWED = "http://purl.imsglobal.org/vocab/caliper/v1/action#Reviewed"
+      SHOWED = "http://purl.imsglobal.org/vocab/caliper/v1/action#Showed"
+      STARTED = "http://purl.imsglobal.org/vocab/caliper/v1/action#Started"
+      SUBMITTED = "http://purl.imsglobal.org/vocab/caliper/v1/action#Submitted"
+      NAVIGATED_TO = "http://purl.imsglobal.org/vocab/caliper/v1/action#NavigatedTo"
+    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

@@ -0,0 +1,54 @@
+require_relative './profile'
+
+module Caliper
+  module Profiles
+
+    module MediaActions
+      CHANGED_RESOLUTION = "http://purl.imsglobal.org/vocab/caliper/v1/action#ChangedResolution"
+      CHANGED_SIZE = "http://purl.imsglobal.org/vocab/caliper/v1/action#ChangedSize"
+      CHANGED_SPEED = "http://purl.imsglobal.org/vocab/caliper/v1/action#ChangedSpeed"
+      CHANGED_VOLUME = "http://purl.imsglobal.org/vocab/caliper/v1/action#ChangedVolume"
+      CLOSED_POPOUT = "http://purl.imsglobal.org/vocab/caliper/v1/action#ClosedPopout"
+      DISABLED_CLOSED_CAPTIONING = "http://purl.imsglobal.org/vocab/caliper/v1/action#DisabledCloseCaptioning"
+      ENABLED_CLOSE_CAPTIONING = "http://purl.imsglobal.org/vocab/caliper/v1/action#EnabledCloseCaptioning"
+      ENDED = "http://purl.imsglobal.org/vocab/caliper/v1/action#Ended"
+      ENTERED_FULLSCREEN = "http://purl.imsglobal.org/vocab/caliper/v1/action#EnteredFullScreen"
+      EXITED_FULLSCREEN = "http://purl.imsglobal.org/vocab/caliper/v1/action#ExitedFullScreen"
+      FORWARDED_TO = "http://purl.imsglobal.org/vocab/caliper/v1/action#ForwardedTo"
+      JUMPED_TO = "http://purl.imsglobal.org/vocab/caliper/v1/action#JumpedTo"
+      MUTED = "http://purl.imsglobal.org/vocab/caliper/v1/action#Muted"
+      OPENED_POPOUT = "http://purl.imsglobal.org/vocab/caliper/v1/action#OpenedPopout"
+      PAUSED = "http://purl.imsglobal.org/vocab/caliper/v1/action#Paused"
+      RESUMED = "http://purl.imsglobal.org/vocab/caliper/v1/action#Resumed"
+      REWOUND = "http://purl.imsglobal.org/vocab/caliper/v1/action#Rewound"
+      STARTED = "http://purl.imsglobal.org/vocab/caliper/v1/action#Started"
+      UNMUTED = "http://purl.imsglobal.org/vocab/caliper/v1/action#Unmuted"
+      NAVIGATED_TO = "http://purl.imsglobal.org/vocab/caliper/v1/action#NavigatedTo"
+    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

data/lib/caliper/profiles/profile.rb

@@ -2,45 +2,45 @@
 require 'i18n'
 
 module Caliper
-	module Profiles
-		module ProfileActions
-			DOWNLOADED = "item.downloaded"
-			UPLOADED = "item.uploaded"
-			LOGGED_IN = "session.loggedIn"
-			LOGGED_OUT = "session.loggedOut"
-			NAVIGATED_TO = "navigation.navigatedTo"
-		end
+  module Profiles
+    module ProfileActions
+      DOWNLOADED = "item.downloaded"
+      UPLOADED = "item.uploaded"
+      LOGGED_IN = "session.loggedIn"
+      LOGGED_OUT = "session.loggedOut"
+      NAVIGATED_TO = "navigation.navigatedTo"
+    end
 
-		module ProfileConformance
-			ACTION_IS_NULL = "an action must be specified."
-			ACTION_UNRECOGNIZED = "unrecognized action."
-			ACTOR_NOT_PERSON = "actor must be of type Person"
-			ACTOR_NOT_SOFTWAREAPP = "actor must be of type SoftwareApplication"
-			CONTEXT_ERROR = "context URI must be specified"
-			DURATION_INVALID = "duration format is invalid"
-			ENDEDATTIME_SET = "endedAtTime must not be specified"
-			EVENT_ILLEGAL_STATE = "event constructed in an illegal state."
-			GENERATED_NOT_NULL = "a generated object is not required."
-			GENERATED_NOT_SESSION = "generated object must be of type Session"
-			OBJECT_NOT_SOFTWAREAPP = "object must be of type SoftwareApplication"
-			STARTEDATTIME_IS_NULL = "startedAtTime must be specified."
-			TARGET_NOT_DIGITALRESOURCE = "target must be of type DigitalResource"
-			TARGET_NOT_SESSION = "target must be of type Session"
-			TIME_ERROR = "end time must be greater than start time."
-			TYPE_ERROR = "type URI must be specified"
-		end
+    module ProfileConformance
+      ACTION_IS_NULL = "an action must be specified."
+      ACTION_UNRECOGNIZED = "unrecognized action."
+      ACTOR_NOT_PERSON = "actor must be of type Person"
+      ACTOR_NOT_SOFTWAREAPP = "actor must be of type SoftwareApplication"
+      CONTEXT_ERROR = "context URI must be specified"
+      DURATION_INVALID = "duration format is invalid"
+      ENDEDATTIME_SET = "endedAtTime must not be specified"
+      EVENT_ILLEGAL_STATE = "event constructed in an illegal state."
+      GENERATED_NOT_NULL = "a generated object is not required."
+      GENERATED_NOT_SESSION = "generated object must be of type Session"
+      OBJECT_NOT_SOFTWAREAPP = "object must be of type SoftwareApplication"
+      STARTEDATTIME_IS_NULL = "startedAtTime must be specified."
+      TARGET_NOT_DIGITALRESOURCE = "target must be of type DigitalResource"
+      TARGET_NOT_SESSION = "target must be of type Session"
+      TIME_ERROR = "end time must be greater than start time."
+      TYPE_ERROR = "type URI must be specified"
+    end
 
-		class Profile
-			include ProfileActions
+    class Profile
+      include ProfileActions
 
-			def initialize()
-			end
+      def initialize()
+      end
 
-			def get_navigated_to_action_from_bundle(key)
-				if key.equal? ProfileActions::NAVIGATED_TO
-					return I18n.translate :action
-				end
-			end
-		end
-	end
-end
+      def get_navigated_to_action_from_bundle(key)
+        if key.equal? ProfileActions::NAVIGATED_TO
+          return I18n.translate :action
+        end
+      end
+    end
+  end
+end

data/lib/caliper/profiles/reading_profile.rb

@@ -1,36 +1,39 @@
-
 require_relative './profile'
 require_relative '../entities/digital_resource'
 require_relative '../entities/reading/frame'
 
 module Caliper
-	module Profiles
-		module ReadingActions
-			SEARCHED = "reading.searched"
-			VIEWED = "reading.viewed"
-		end
-		class ReadingProfile < Caliper::Profiles::Profile
+  module Profiles
+
+    module ReadingActions
+      SEARCHED = "http://purl.imsglobal.org/vocab/caliper/v1/action#Searched"
+      VIEWED = "http://purl.imsglobal.org/vocab/caliper/v1/action#Viewed"
+      NAVIGATED_TO = "http://purl.imsglobal.org/vocab/caliper/v1/action#NavigatedTo"
+    end
+
+    class ReadingProfile < Caliper::Profiles::Profile
+
+      attr_accessor :key, # String
+        :lookup # hash of ReadingActions
 
-			attr_accessor :key, # String
-										:lookup # hash of ReadingActions
+      # 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 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
 
-			# 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
+end

data/lib/caliper/profiles/session_profile.rb

@@ -5,25 +5,24 @@ require_relative '../entities/annotation/annotation'
 require_relative '../entities/reading/frame'
 
 module Caliper
-	module Profiles
-		module SessionActions
-			LOGGED_IN = "session.loggedIn"
-			LOGGED_OUT = "session.loggedOut"
-			TIMEOUT = "session.timeOut"
-			UNRECOGNIZED = "action.unrecognized"
-		end
-		class SessionProfile < Profile
-			include SessionActions
+  module Profiles
+    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
+    class SessionProfile < Profile
+      include SessionActions
 
-			def initialize
-				super
-			end
+      def initialize
+        super
+      end
 
-			# whether object if of type DigitalResource
-			def validate_event (event)
+      # whether object if of type DigitalResource
+      def validate_event (event)
 
-			end
+      end
 
-		end
-	end
-end
+    end
+  end
+end