RubyGems - ims_caliper - Versions diffs - 0.9.3.15 → 1.0.0 - Mend

ims_caliper 0.9.3.15 → 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (115) hide show

data/spec/lib/sensor_spec.rb CHANGED Viewed

@@ -26,7 +26,7 @@ module Caliper
     it "should ensure that we can create and send an event" do
-      id = 'http://learning-app.some-university.edu/sensor'
+      id = 'https://example.edu/sensor/001'
       options = {
         'host'  => 'http://requestb.in/1i7pr2i1',
         'apiKey' => 'test_api_key'

metadata CHANGED Viewed

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ims_caliper
 version: !ruby/object:Gem::Version
-  version: 0.9.3.15
+  version: 1.0.0
 platform: ruby
 authors:
 - Caliper Dev Group
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-05-21 00:00:00.000000000 Z
+date: 2016-07-15 00:00:00.000000000 Z
 dependencies: []
 description: This is the implementation of IMSGlobal Caliper in Ruby
 email:
@@ -17,7 +17,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
 - Gemfile
 - Gemfile.lock
 - LICENSE
@@ -26,11 +26,22 @@ files:
 - caliper.gemspec
 - config/locales/en.yml
 - lib/caliper.rb
+- lib/caliper/actions/annotation_actions.rb
+- lib/caliper/actions/assessment_actions.rb
+- lib/caliper/actions/assessment_item_actions.rb
+- lib/caliper/actions/assignable_actions.rb
+- lib/caliper/actions/media_actions.rb
+- lib/caliper/actions/navigation_actions.rb
+- lib/caliper/actions/outcome_actions.rb
+- lib/caliper/actions/reading_actions.rb
+- lib/caliper/actions/session_actions.rb
+- lib/caliper/context/context.rb
 - lib/caliper/defaults.rb
 - lib/caliper/entities/agent/organization.rb
 - lib/caliper/entities/agent/person.rb
 - lib/caliper/entities/agent/software_application.rb
 - lib/caliper/entities/annotation/annotation.rb
+- lib/caliper/entities/annotation/annotation_type.rb
 - lib/caliper/entities/annotation/bookmark_annotation.rb
 - lib/caliper/entities/annotation/highlight_annotation.rb
 - lib/caliper/entities/annotation/shared_annotation.rb
@@ -38,13 +49,16 @@ files:
 - lib/caliper/entities/assessment/assessment.rb
 - lib/caliper/entities/assessment/assessment_item.rb
 - lib/caliper/entities/assignable/assignable_digital_resource.rb
+- lib/caliper/entities/assignable/assignable_digital_resource_type.rb
 - lib/caliper/entities/assignable/attempt.rb
 - lib/caliper/entities/digital_resource.rb
+- lib/caliper/entities/digital_resource_type.rb
 - lib/caliper/entities/entity.rb
+- lib/caliper/entities/entity_base.rb
+- lib/caliper/entities/entity_type.rb
 - lib/caliper/entities/foaf/agent.rb
 - lib/caliper/entities/generatable.rb
 - lib/caliper/entities/jsonable.rb
-- lib/caliper/entities/learning_context.rb
 - lib/caliper/entities/learning_objective.rb
 - lib/caliper/entities/lis/course_offering.rb
 - lib/caliper/entities/lis/course_section.rb
@@ -56,6 +70,7 @@ files:
 - lib/caliper/entities/media/image_object.rb
 - lib/caliper/entities/media/media_location.rb
 - lib/caliper/entities/media/media_object.rb
+- lib/caliper/entities/media/media_object_type.rb
 - lib/caliper/entities/media/video_object.rb
 - lib/caliper/entities/outcome/result.rb
 - lib/caliper/entities/reading/epub_chapter.rb
@@ -79,64 +94,54 @@ files:
 - lib/caliper/entities/targetable.rb
 - lib/caliper/entities/w3c/membership.rb
 - lib/caliper/entities/w3c/organization.rb
-- lib/caliper/event/annotation_event.rb
-- lib/caliper/event/assessment_event.rb
-- lib/caliper/event/assessment_item_event.rb
-- lib/caliper/event/assignable_event.rb
-- lib/caliper/event/event.rb
-- lib/caliper/event/jsonable.rb
-- lib/caliper/event/media_event.rb
-- lib/caliper/event/navigation_event.rb
-- lib/caliper/event/outcome_event.rb
-- lib/caliper/event/session_event.rb
-- lib/caliper/event/view_event.rb
+- lib/caliper/events/annotation_event.rb
+- lib/caliper/events/assessment_event.rb
+- lib/caliper/events/assessment_item_event.rb
+- lib/caliper/events/assignable_event.rb
+- lib/caliper/events/event.rb
+- lib/caliper/events/event_context.rb
+- lib/caliper/events/event_type.rb
+- lib/caliper/events/jsonable.rb
+- lib/caliper/events/media_event.rb
+- lib/caliper/events/navigation_event.rb
+- lib/caliper/events/outcome_event.rb
+- lib/caliper/events/reading_event.rb
+- lib/caliper/events/session_event.rb
+- lib/caliper/events/view_event.rb
 - lib/caliper/jsonable.rb
 - lib/caliper/options.rb
-- lib/caliper/profiles/annotation_profile.rb
-- lib/caliper/profiles/assessment_item_profile.rb
-- lib/caliper/profiles/assessment_profile.rb
-- lib/caliper/profiles/assignable_profile.rb
-- lib/caliper/profiles/media_profile.rb
-- lib/caliper/profiles/profile.rb
-- lib/caliper/profiles/reading_profile.rb
-- lib/caliper/profiles/session_profile.rb
 - lib/caliper/request/envelope.rb
-- lib/caliper/request/envelope_jsonable.rb
 - lib/caliper/request/event_store_requestor.rb
 - lib/caliper/request/http_requestor.rb
+- lib/caliper/request/jsonable.rb
 - lib/caliper/sensor.rb
 - lib/caliper/stats/atomic_wrapper.rb
 - lib/caliper/stats/statistic.rb
 - lib/caliper/stats/statistics.rb
 - lib/caliper/stats/statistics_map.rb
-- lib/caliper/validators/error_message.rb
-- lib/caliper/validators/event_validator.rb
-- lib/caliper/validators/event_validator_context.rb
-- lib/caliper/validators/property_type_check.rb
-- lib/caliper/validators/session_login_event_validator.rb
-- lib/caliper/validators/session_logout_event_validator.rb
-- lib/caliper/validators/time_check.rb
 - lib/caliper/version.rb
+- spec/lib/entities/agent/person.json
 - spec/lib/entities/agent/person_spec.rb
-- spec/lib/entities/agent/student.json
-- spec/lib/entities/entity.json
-- spec/lib/entities/entity_spec.rb
-- spec/lib/event/annotation_event_bookmark_spec.rb
-- spec/lib/event/annotation_event_highlight_spec.rb
-- spec/lib/event/annotation_event_shared_spec.rb
-- spec/lib/event/annotation_event_tag_spec.rb
-- spec/lib/event/assessment_event_spec.rb
-- spec/lib/event/assessment_item_completed_event_spec.rb
-- spec/lib/event/assessment_item_started_event_spec.rb
-- spec/lib/event/assignable_event_spec.rb
-- spec/lib/event/media_event_spec.rb
-- spec/lib/event/navigated_event_spec.rb
-- spec/lib/event/session_event_login_spec.rb
-- spec/lib/event/session_event_logout_spec.rb
-- spec/lib/event/session_event_timeout_spec.rb
-- spec/lib/event/viewed_event_spec.rb
+- spec/lib/entities/assessment/assessment.json
+- spec/lib/entities/assessment/assessment_spec.rb
 - spec/lib/event_helper.rb
-- spec/lib/request/http_requestor_spec.rb
+- spec/lib/events/annotation_bookmarked_event_spec.rb
+- spec/lib/events/annotation_highlighted_event_spec.rb
+- spec/lib/events/annotation_shared_event_spec.rb
+- spec/lib/events/annotation_tagged_event_spec.rb
+- spec/lib/events/assessment_item_completed_event_spec.rb
+- spec/lib/events/assessment_item_started_event_spec.rb
+- spec/lib/events/assessment_started_event_spec.rb
+- spec/lib/events/assignable_activated_event_spec.rb
+- spec/lib/events/media_paused_video_event_spec.rb
+- spec/lib/events/navigation_navigated_to_event_spec.rb
+- spec/lib/events/outcome_graded_event_spec.rb
+- spec/lib/events/session_logged_in_event_spec.rb
+- spec/lib/events/session_logged_out-event_spec.rb
+- spec/lib/events/session_timed_out_event_spec.rb
+- spec/lib/events/view_viewed_event_spec.rb
+- spec/lib/request/http_requestor_single_event_spec.rb
+- spec/lib/request/http_requestor_single_minimal_event_spec.rb
 - spec/lib/sensor_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/IMSGlobal/caliper-ruby
@@ -149,40 +154,42 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project:
-rubygems_version: 2.4.6
+rubygems_version: 2.5.1
 signing_key:
 specification_version: 4
 summary: Caliper Sensor API
 test_files:
+- spec/lib/entities/agent/person.json
 - spec/lib/entities/agent/person_spec.rb
-- spec/lib/entities/agent/student.json
-- spec/lib/entities/entity.json
-- spec/lib/entities/entity_spec.rb
-- spec/lib/event/annotation_event_bookmark_spec.rb
-- spec/lib/event/annotation_event_highlight_spec.rb
-- spec/lib/event/annotation_event_shared_spec.rb
-- spec/lib/event/annotation_event_tag_spec.rb
-- spec/lib/event/assessment_event_spec.rb
-- spec/lib/event/assessment_item_completed_event_spec.rb
-- spec/lib/event/assessment_item_started_event_spec.rb
-- spec/lib/event/assignable_event_spec.rb
-- spec/lib/event/media_event_spec.rb
-- spec/lib/event/navigated_event_spec.rb
-- spec/lib/event/session_event_login_spec.rb
-- spec/lib/event/session_event_logout_spec.rb
-- spec/lib/event/session_event_timeout_spec.rb
-- spec/lib/event/viewed_event_spec.rb
+- spec/lib/entities/assessment/assessment.json
+- spec/lib/entities/assessment/assessment_spec.rb
 - spec/lib/event_helper.rb
-- spec/lib/request/http_requestor_spec.rb
+- spec/lib/events/annotation_bookmarked_event_spec.rb
+- spec/lib/events/annotation_highlighted_event_spec.rb
+- spec/lib/events/annotation_shared_event_spec.rb
+- spec/lib/events/annotation_tagged_event_spec.rb
+- spec/lib/events/assessment_item_completed_event_spec.rb
+- spec/lib/events/assessment_item_started_event_spec.rb
+- spec/lib/events/assessment_started_event_spec.rb
+- spec/lib/events/assignable_activated_event_spec.rb
+- spec/lib/events/media_paused_video_event_spec.rb
+- spec/lib/events/navigation_navigated_to_event_spec.rb
+- spec/lib/events/outcome_graded_event_spec.rb
+- spec/lib/events/session_logged_in_event_spec.rb
+- spec/lib/events/session_logged_out-event_spec.rb
+- spec/lib/events/session_timed_out_event_spec.rb
+- spec/lib/events/view_viewed_event_spec.rb
+- spec/lib/request/http_requestor_single_event_spec.rb
+- spec/lib/request/http_requestor_single_minimal_event_spec.rb
 - spec/lib/sensor_spec.rb
 - spec/spec_helper.rb

data/lib/caliper/event/event.rb DELETED Viewed

@@ -1,114 +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 'json'
-require_relative './jsonable'
-#
-# Base event.
-#
-module Caliper
-  module Event
-    module EventContext
-      ANNOTATION = "http://purl.imsglobal.org/ctx/caliper/v1/AnnotationEvent"
-      ASSESSMENT = "http://purl.imsglobal.org/ctx/caliper/v1/AssessmentEvent"
-      ASSESSMENT_ITEM = "http://purl.imsglobal.org/ctx/caliper/v1/AssessmentItemEvent"
-      ASSIGNABLE = "http://purl.imsglobal.org/ctx/caliper/v1/AssignableEvent"
-      EVENT = "http://purl.imsglobal.org/ctx/caliper/v1/Event"
-      MEDIA = "http://purl.imsglobal.org/ctx/caliper/v1/MediaEvent"
-      NAVIGATION = "http://purl.imsglobal.org/ctx/caliper/v1/NavigationEvent"
-      OUTCOME = "http://purl.imsglobal.org/ctx/caliper/v1/OutcomeEvent"
-      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"
-      ASSESSMENT_ITEM = "http://purl.imsglobal.org/caliper/v1/AssessmentItemEvent"
-      ASSIGNABLE = "http://purl.imsglobal.org/caliper/v1/AssignableEvent"
-      EVENT = "http://purl.imsglobal.org/caliper/v1/Event"
-      MEDIA = "http://purl.imsglobal.org/caliper/v1/MediaEvent"
-      NAVIGATION = "http://purl.imsglobal.org/caliper/v1/NavigationEvent"
-      OUTCOME = "http://purl.imsglobal.org/caliper/v1/OutcomeEvent"
-      SESSION = "http://purl.imsglobal.org/caliper/v1/SessionEvent"
-      VIEW = "http://purl.imsglobal.org/caliper/v1/ViewEvent"
-    end
-    class Event
-      include Caliper::Event::Jsonable
-      attr_accessor :context, # String Required - the JSON-LD context for the Event
-        # Required - the type of the Event
-        :type,
-        # Required - Agent (User, System) that performed the action
-        :actor,
-        # Required - Action performed by Agent From Metric Profile (String)
-        :action,
-        # Required - Object
-        :object,
-        # Optional - Targeted object (Targetable)
-        :target,
-        # Optional - Generated object (Generatable)
-        :generated,
-        # Required time that the event was started at (ISO-8601 date string)
-        :startedAtTime,
-        # An optional time that the event ended at (ISO-8601 date string)
-        :endedAtTime,
-        # An xsd:duration (http://books.xmlschemata.org/relaxng/ch19-77073.html)
-        # The String format is expected to be PnYnMnDTnHnMnS
-        # Valid values include PT1004199059S, PT130S, PT2M10S, P1DT2S, -P1Y, or P1Y2M3DT5H20M30.123S.
-        # The following values are invalid: 1Y (leading P is missing), P1S (T separator is missing),
-        # P-1Y (all parts must be positive), P1M2Y (parts order is significant and Y must precede M)                                                                                                * or P1Y-1M (all parts must be positive).                                                                               */
-        :duration,
-        # edApp
-        :edApp,
-        # Group
-        :group,
-        # Membership
-        :membership
-      def initialize()
-        @context = EventContext::EVENT
-        @type = EventType::EVENT
-        @actor = nil
-        @action = nil
-        @object = nil
-        @target = nil
-        @generated = nil
-        @startedAtTime = Time.now.utc.iso8601(3)
-        @endedAtTime = nil
-        @duration = nil
-        @edApp = nil
-        @group = nil
-        @membership = nil
-      end
-    end
-  end
-end

data/lib/caliper/profiles/assessment_item_profile.rb DELETED Viewed

@@ -1,48 +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'
-#
-# 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

data/lib/caliper/profiles/reading_profile.rb DELETED Viewed

@@ -1,56 +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/reading/frame'
-#
-# Reading Profile.
-#
-module Caliper
-  module Profiles
-    module ReadingActions
-      SEARCHED = "http://purl.imsglobal.org/vocab/caliper/v1/action#Searched"
-      VIEWED = "http://purl.imsglobal.org/vocab/caliper/v1/action#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