ims_caliper 0.9.3.15 → 1.0.0

data/lib/caliper/profiles/session_profile.rb

@@ -1,46 +0,0 @@
-##
-# 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'
-
-#
-# Session Profile.
-#
-module Caliper
-  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
-
-      # whether object if of type DigitalResource
-      def validate_event (event)
-
-      end
-    end
-  end
-end

data/lib/caliper/validators/error_message.rb

@@ -1,63 +0,0 @@
-##
-# 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/.
-
-#
-# Error Message.
-#
-module Caliper
-	module Validators
-		class ErrorMessage
-
-			attr_accessor :text
-
-			def initialize
-				@text = ""
-			end
-
-			# append comma if appropriate when building conformance violation message
-			def append_text(text)
-				if (@text.length == 0)
-					# assign text value
-					@text = text
-				else
-					# append text value
-					@text = @text + ",\n" + text + "\n"
-				end
-			end
-
-			# prepend text
-			# typically a Caliper conformance clause that prefixes a string of one or more violations.
-			def prepend_text(text)
-				@text = text + "\n" + @text
-			end
-
-			# append period and end sentence
-			def end_sentence
-				@text = @text + "."
-			end
-
-			def end_message(text)
-				prepend_text(text)
-				end_sentence
-			end
-
-			def length
-				return @text.length
-			end
-		end
-	end
-end

data/lib/caliper/validators/event_validator.rb

@@ -1,57 +0,0 @@
-##
-# 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/.
-
-#
-# Event Validator.
-#
-module Caliper
-	module Validators
-		module EventValidator
-			module Conformance
-				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"
-				ASSIGNABLE_NOT_ASSESSMENT = "assignable must be of type Assessment"
-				CONTEXT_ERROR = "context URI must be specified"
-				COUNT_NOT_ZERO = "count must be specified"
-				DURATION_INVALID = "duration format is invalid"
-				ENDEDATTIME_IS_NULL = "endedAtTime must be specified"
-				ENDEDATTIME_SET = "endedAtTime must not be specified"
-				EVENT_ILLEGAL_STATE = "event constructed in an illegal state."
-				GENERATED_NOT_ATTEMPT = "generated object must be of type Attempt"
-				GENERATED_NOT_NULL = "a generated object is not required"
-				GENERATED_NOT_SESSION = "generated object must be of type Session"
-				OBJECT_NOT_ASSESSMENT = "object must be of type Assessment"
-				OBJECT_NOT_SOFTWAREAPP = "object must be of type SoftwareApplication"
-				STARTEDATTIME_IS_NULL = "startedAtTime must be specified"
-				TARGET_NOT_CREATIVEWORK = "target must be of type CreativeWork"
-				TARGET_NOT_DIGITALRESOURCE = "target must be of type DigitalResource"
-				TARGET_NOT_NULL = "target is not required."
-				TARGET_NOT_SESSION = "target must be of type Session"
-				TARGET_NOT_SET = "target must be specified"
-				TARGET_NOT_THING = "target must be of type Thing"
-				TIME_ERROR = "end time must be greater than start time."
-				TYPE_ERROR = "type URI must be specified"
-			end
-
-			def validate
-				# to be implemented
-			end
-		end
-	end
-end

data/lib/caliper/validators/property_type_check.rb

@@ -1,33 +0,0 @@
-##
-# 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 '../agent/person'
-require_relative '../schemadotorg/software_application'
-
-#
-# Type check.
-#
-module Caliper
-	module Validators
-		class PropertyTypeCheck
-			# whether the object is of wanted target class
-			def is_object_of_type(object, targetClass)
-				return !object.nil? && object.is_a?(targetClass)
-			end
-		end
-	end
-end

data/lib/caliper/validators/session_login_event_validator.rb

@@ -1,121 +0,0 @@
-##
-# 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_validator'
-require_relative './error_message'
-require_relative './property_type_check'
-require_relative './time_check'
-require_relative '../event/event'
-require_relative '../agent/person'
-require_relative '../digital_resource'
-require_relative '../session/session'
-require_relative '../schemadotorg/software_application'
-
-#
-# Session Login validator
-#
-module Caliper
-	module Validators
-		class SessionLoginEventValidator
-			include EventValidator
-			include TimeCheck
-
-			## Validate session login event properties.
-	    # Properties
-	    # context:: required
-	    # type:: required
-	    # edApp:: optional
-	    # group:: optional
-	    # actor:: required: Person
-	    # action:: required: session.loggedIn
-	    # object:: required: SoftwareApplication
-	    # target:: required: DigitalResource
-	    # generated:: required: Session
-	    # startedAtTime:: required
-	    # endedAtTime:: optional: but should not be set.
-	    # duration:: optional: but should not be set.
-			# returns conformance violations message.
-			def validate(event)
-				context = "session"
-				error_message = ErrorMessage.new
-				property_check = PropertyTypeCheck.new
-
-
-				if (!event.is_a?(Event))
-					# check whether the argument is of right type
-					return
-				else
-					# is event context of Session
-					if (!event.context.equal?(EventType::SESSION))
-						error_message.append_text(event.context + " " + Conformance::CONTEXT_ERROR)
-					end
-
-					# is event type of Session
-					if (!event.type.equal?(EventType::SESSION))
-						error_message.append_text(event.type + " " + Conformance::TYPE_ERROR)
-					end
-
-					# is event actor a Person
-					if (!property_check.is_object_of_type(event.actor, Person.class))
-						error_message.append_text(event.actor.class + " " + Conformance::ACTOR_NOT_PERSON)
-					end
-
-					# is event object a SoftwareApplication
-					if (!property_check.is_object_of_type(event.object, SoftwareApplication.class))
-						error_message.append_text(event.object.class + " " + Conformance::OBJECT_NOT_SOFTWAREAPP)
-					end
-
-					# is event target a DigitalResource
-					if (!property_check.is_object_of_type(event.target, DigitalResource.class))
-						error_message.append_text(event.object.class + " " + Conformance::TARGET_NOT_DIGITALRESOURCE)
-					end
-
-					if (property_check.is_object_of_type(event.generated, Session.class))
-						if (event.generated.started_at_time == 0)
-							error_message.append_text(context + " " + Conformance::STARTEDATTIME_IS_NULL)
-						elsif (event.generated.end_at_time != 0)
-							error_message.append_text(context + " " + Conformance::ENDEDATTIME_SET)
-						end
-					else
-						error_message.append_text(Conformance::GENERATED_NOT_SESSION)
-					end
-
-					# start time set for event
-					if (!check_started_at_time(event.started_at_time))
-						error_message.append_text(Conformance::STARTEDATTIME_IS_NULL)
-					end
-
-					# also check the event end time
-					if (!check_ended_at_time(event.started_at_time, event.ended_at_time))
-						error_message.append_text(Conformance::TIME_ERROR)
-					end
-
-					# check duration value
-					if (check_duration(event.duration))
-						error_message.append_text(Conformance::DURATION_INVALID)
-					end
-
-					if (error_message.length() > 0)
-						error_message.end_message("Caliper Session profile login event conformance: ")
-					end
-
-					return error_message.text
-				end
-			end
-		end
-	end
-end

data/lib/caliper/validators/session_logout_event_validator.rb

@@ -1,120 +0,0 @@
-##
-# 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_validator'
-require_relative 'error_message'
-require_relative 'property_type_check'
-require_relative 'time_check'
-require_relative '../event/event'
-require_relative '../entities/agent/person'
-require_relative '../entities/digital_resource'
-require_relative '../entities/session/session'
-require_relative '../entities/schemadotorg/software_application'
-
-#
-# Session logout validator.
-#
-module Caliper
-	module Validators
-		class SessionLogoutEventValidator
-			include EventValidator
-			include TimeCheck
-
-			Validate session logout event properties.
-				                              *
-			## Validate SessionEvent.
-			# An IllegalStateException will be thrown as a defensive measure if programing
-			# errors are encountered during object construction.
-			# Properties
-			# context:: required
-			# type:: required
-			# edApp:: optional
-			# group:: optional
-			# actor:: required: Person
-			# action:: required: session.loggedIn
-			# object:: required: SoftwareApplication
-			# target:: required: DigitalResource
-			# generated:: required: Session
-			# startedAtTime:: required
-			# endedAtTime:: optional: but should not be set.
-			# duration:: optional: but should not be set.
-			# returns conformance violations message.
-			def validate(event)
-				context = "session"
-				error_message = ErrorMessage.new
-				property_check = PropertyTypeCheck.new
-
-
-				if (!event.is_a?(Event))
-					# check whether the argument is of right type
-					return
-				else
-					# is event context of Session
-					if (!event.context.equal?(EventType::SESSION))
-						error_message.append_text(event.context + " " + Conformance::CONTEXT_ERROR)
-					end
-
-					# is event type of Session
-					if (!event.type.equal?(EventType::SESSION))
-						error_message.append_text(event.type + " " + Conformance::TYPE_ERROR)
-					end
-
-					# is event actor a Person
-					if (!property_check.is_object_of_type(event.actor, Person.class))
-						error_message.append_text(event.actor.class + " " + Conformance::ACTOR_NOT_PERSON)
-					end
-
-					# is event object a SoftwareApplication
-					if (!property_check.is_object_of_type(event.object, SoftwareApplication.class))
-						error_message.append_text(event.object.class + " " + Conformance::OBJECT_NOT_SOFTWAREAPP)
-					end
-
-					# is event target a DigitalResource
-					if (!property_check.is_object_of_type(event.target, Session.class))
-						error_message.append_text(event.object.class + " " + Conformance::TARGET_NOT_SESSION)
-					end
-
-					# should not be generated
-					if (event.generated)
-						message.appendText(Conformance::GENERATED_NOT_NULL);
-					end
-
-					# start time set for event
-					if (!check_started_at_time(event.started_at_time))
-						error_message.append_text(Conformance::STARTEDATTIME_IS_NULL)
-					end
-
-					# also check the event end time
-					if (!check_ended_at_time(event.started_at_time, event.ended_at_time))
-						error_message.append_text(Conformance::TIME_ERROR)
-					end
-
-					# check duration value
-					if (check_duration(event.duration))
-						error_message.append_text(Conformance::DURATION_INVALID)
-					end
-
-					if (error_message.length > 0)
-						error_message.end_message("Caliper Session profile login event conformance: ")
-					end
-
-					return error_message.text
-				end
-			end
-		end
-	end
-end