ims_caliper 0.1.1

data/lib/caliper/profiles/annotation_profile.rb

@@ -0,0 +1,61 @@
+
+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
+
+			# 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/profile.rb

@@ -0,0 +1,46 @@
+
+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 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
+
+			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

data/lib/caliper/profiles/reading_profile.rb

@@ -0,0 +1,36 @@
+
+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
+
+			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 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/session_profile.rb

@@ -0,0 +1,29 @@
+
+require_relative './profile'
+require_relative '../entities/digital_resource'
+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
+
+			def initialize
+				super
+			end
+
+			# whether object if of type DigitalResource
+			def validate_event (event)
+
+			end
+
+		end
+	end
+end

data/lib/caliper/request/event_store_envelope.rb

@@ -0,0 +1,9 @@
+
+# contains the event information
+module Caliper
+	module Request
+		class EventStoreEnvelope
+			attr_accessor :id, :type, :time, :data
+		end
+	end
+end

data/lib/caliper/request/event_store_requestor.rb

@@ -0,0 +1,41 @@
+require 'securerandom'
+require_relative 'event_store_envelope'
+
+module Caliper
+	module Request
+		class EventStoreRequestor
+
+
+			def get_payload_json(caliper_event, id, send_time)
+
+			list_payload = Array.new
+
+			# new event envelope
+			envelope = EventStoreEnvelope.new
+			envelope.id = id
+			envelope.type = "caliperEvent"
+			envelope.time = send_time.to_s
+			envelope.data = caliper_event
+
+			# add envelope into array
+			list_payload<< envelope
+
+			json_payload = JSON.generate(list_payload)
+				return json_payload
+			end
+
+			def generate_payload(caliper_event, id, send_time)
+				if (id.nil?)
+					id = "caliper-java_" + SecureRandom.uuid
+				end
+
+				if (send_time.nil?)
+					send_time = Time.now
+				end
+
+				json_payload = get_payload_json(caliper_event, id, send_time)
+
+			end
+		end
+	end
+end

data/lib/caliper/request/http_requestor.rb

@@ -0,0 +1,42 @@
+require_relative 'event_store_requestor'
+require_relative 'event_store_envelope'
+require "net/http"
+require "uri"
+
+module Caliper
+	module Request
+		class HttpRequestor < Caliper::Request::EventStoreRequestor
+
+			attr_accessor :options
+
+			def initialize(options)
+				@options = options
+			end
+
+			def send(event)
+				status = false
+
+				# the option.host returns whole url string
+				uri = URI(@options.host)
+				Net::HTTP.start(uri.host, uri.port) do |http|
+					request = Net::HTTP::Post.new uri
+
+					response = http.request request # Net::HTTPResponse object
+				end
+
+				if (response.code != 200)
+					status_code = response.code
+
+					# failed call
+					status = false
+					fail "Failed: HTTP error code: " + status_code
+				else
+					# success call
+					status = true
+				end
+
+				return status
+			end
+		end
+	end
+end

data/lib/caliper/sensor.rb

@@ -0,0 +1,37 @@
+require_relative "client"
+
+## create
+module Caliper
+	class Sensor
+		attr_accessor :default_client
+
+		# options to configure the behavior of Caliper client
+		def initialize(options)
+			@default_client=Client.new(options)
+		end
+
+		# Client initialization check
+		def is_initialized()
+			if default_client.nil?
+				# fail with RuntimeError
+				fail 'Caliper client is not initialized. Please call Caliper.initialize(..); before calling measure or describe'
+			end
+		end
+
+		# Describe a Entity that is part of the learning graph
+		def describe(entity)
+			is_initialized()
+			@default_client.describe(entity)
+		end
+
+		def send(event)
+			is_initialized()
+			@default_client.describe(event)
+		end
+
+		def get_statistics()
+			is_initialized()
+			@default_client.getStatistics()
+		end
+	end
+end

data/lib/caliper/stats/atomic_wrapper.rb

@@ -0,0 +1,86 @@
+require 'atomic'
+
+# extends the atomic class with several new functions
+module Caliper
+	module Stats
+		class AtomicWrapper < Atomic
+
+
+			def initialize(value)
+				super.initialize(value)
+			end
+
+			# Atomically sets to the given value and returns the old value.
+			def get_and_set(new_value)
+				current = @value
+				if (compare_and_set(current, new_value))
+					current
+				end
+			end
+
+			# Atomically increments by one and returns the old value.
+			def get_and_increment()
+				current = @value
+				new_value = current + 1
+				if (compare_and_set(current, new_value))
+					current
+				end
+			end
+
+			# Atomically decrements by one and returns the old value.
+			def get_and_decrement()
+				current = @value
+				new_value = current - 1
+				if (compare_and_set(current, new_value))
+					current
+				end
+			end
+
+			# Atomically adds the given value to the current value
+			# Return the old value
+			def get_and_add(delta)
+				current = @value
+				new_value = current + delta
+				if (compare_and_set(current, new_value))
+					current
+				end
+			end
+
+			# Atomically increments by one the current value.
+			# Return the updated value
+			def increment_and_get()
+				current = @value
+				new_value = current + 1
+				if (compare_and_set(current, new_value))
+					new_value
+				end
+			end
+
+			# Atomically decrements by one the current value.
+			# Return the updated value
+			def decrement_and_get()
+				current = @value
+				new_value = current - 1
+				if (compare_and_set(current, new_value))
+					new_value
+				end
+			end
+
+			# Atomically adds the given value to the current value.
+			# Return the updated value
+			def add_and_get(delta)
+				current = @value
+				new_value = current + delta
+				if (compare_and_set(current, new_value))
+					new_value
+				end
+			end
+
+			# Returns the String representation of the current value.
+			def to_string()
+				return @value.to_s
+			end
+
+		end
+	end
+end

data/lib/caliper/stats/statistic.rb

@@ -0,0 +1,104 @@
+require 'atomic'
+require 'math'
+
+module Caliper
+	module Stats
+		class Statistic
+
+			attr_accessor :sum, :count, :last
+
+			attr_reader :oldM, :newM, :oldS, :newS
+
+			attr_reader :min, :max
+
+			def initialize
+				@sum = AtomicWrapper.new(0)
+				@count = AtomicWrapper.new(0)
+				@last = AtomicWrapper.new(0)
+				@lock = AtomicWrapper.new(false)
+
+				@min = 0
+				@max = 0
+
+				@oldM = 0
+				@newM = 0
+				@oldS = 0
+				@newS = 0
+
+			end
+
+			# add another value to this statistic
+			def update(val)
+				n = @count.add_and_get(1)
+				if (@lock.compare_and_set(false, true))
+					if (n == 1)
+						# this is the first time we are executing, so clear the numbers
+						@oldM = @newM = val
+						@oldS = 0
+						@min = val
+						@max = val
+					else
+						# this is not our first update
+						@newM = @oldM + (val - @oldM) / n
+						@newS = @oldS + (val - @oldM) * (val * @newM)
+
+						@oldM = @newM
+						@oldS = @newS
+					end
+
+					if (@val < @min)
+						@min = val
+					end
+
+					if (@val > @max)
+						@max = val
+					end
+
+					@lock.set(false)
+				end
+
+				@sum.add_and_get(val)
+				@last.set(val)
+			end
+
+			def clear
+				@count.set(0)
+				@sum.set(0.0)
+				@last.set(0.0)
+
+				@lock.set(false)
+				@min = 0
+				@max = 0
+
+				@oldM = 0
+				@newM = 0
+				@oldS = 0
+				@newS = 0
+			end
+
+			def get_average
+				return count.get() > 0 ? (sum.get() / count.get()) : 0.0
+			end
+
+			# Get the variance
+			def get_variance
+				return (count.get() > 1) ? newS / (count.get() - 1) : 1.0
+			end
+
+			# Get the standard deviation of the stream of values
+			def get_standard_deviation
+				Math.sqrt(get_variance())
+			end
+
+			# Return nicely formatted String for all values
+			def to_s
+				if (@min == 1.0 && @max == 1.0)
+					# this is just a count
+					return "" + get_count();
+				else
+					return "[Count : %d], [Min : %s], [Max : %s], [Average : %s], [Std. Dev. : %s]",@count, @min, @max, getAverage(), getStandardDeviation()
+				end
+			end
+		end
+	end
+end

data/lib/caliper/stats/statistics.rb

@@ -0,0 +1,45 @@
+module Caliper
+	module Stats
+		class Statistics < StatisticsMap
+			MEASURE_KEY = "Measure"
+			DESCRIBE_KEY = "Describe"
+			SUCCESSFUL_KEY = "Successful"
+			FAILED_KEY = "Failed"
+
+			# Returns the statistic representing how many describe calls happened
+			def get_describes
+				return ensure(DESCRIBE_KEY)
+			end
+
+			def update_describes(val)
+				update(DESCRIBE_KEY, val)
+			end
+
+			def get_measures
+				return ensure(MEASURE_KEY)
+			end
+
+			def update_measures(val)
+				update(MEASURE_KEY, val)
+			end
+
+			def get_successful
+				return ensure(SUCCESSFUL_KEY)
+			end
+
+			def update_successful
+				update(SUCCESSFUL_KEY, val)
+			end
+
+			def get_failed
+				return ensure(FAILED_KEY)
+			end
+
+			def update_failed
+				update(FAILED_KEY, val)
+			end
+
+
+		end
+	end
+end

data/lib/caliper/stats/statistics_map.rb

@@ -0,0 +1,39 @@
+module Caliper
+	module Stats
+		class StatisticsMap < Hash
+
+			# Make sure the key value exists in the hashmap
+			# Add the key value if not found before
+			def ensure(key)
+				# returns key-ed vale if key exists
+				if has_key?(key)
+					return fetch(key)
+				end
+
+				# else insert the key
+				statistic = Statistic.new()
+				this.put(key, statistic)
+				return statistic
+			end
+
+			# Insert a new Statistic object if there is no key with specified value
+			# Otherwise, update the hashed value with the value provided
+			def update(operation, val)
+				if (!has_key?(operation))
+					this.put(operation, Statistic.new())
+				end
+				this.fetch(operation).update(val)
+			end
+
+			# the pretty formatted string output
+			def to_s
+				r_string = "\r-------- Caliper Java Statistics --------\r";
+				hash.each do |key, value|
+					statistics = 	value;
+					r_string = r_string + "%s : %s\r", key, statistic.to_s()
+				end
+				return r_string
+			end
+		end
+	end
+end

data/lib/caliper/validators/error_message.rb

@@ -0,0 +1,43 @@
+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

@@ -0,0 +1,37 @@
+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/event_validator_context.rb

@@ -0,0 +1,16 @@
+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
+end

data/lib/caliper/validators/property_type_check.rb

@@ -0,0 +1,14 @@
+
+require_relative '../entities/lis/person'
+require_relative '../entities/schemadotorg/software_application'
+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