ims_caliper 0.1.1 → 0.1.2

data/spec/spec_helper.rb

@@ -1,12 +1,13 @@
 require 'simplecov'
 require 'simplecov-rcov'
-require "caliper"
+require 'require_all'
+require_all 'lib/caliper/*.rb'
 
 SimpleCov.use_merging
 SimpleCov.merge_timeout(10000)
 SimpleCov.command_name('open_data_export_gem')
 SimpleCov.start('test_frameworks') do
-  SimpleCov.coverage_dir('../../coverage')
+  SimpleCov.coverage_dir('./coverage')
   SimpleCov.at_exit {
     SimpleCov.result
   }

metadata

@@ -1,77 +1,107 @@
 --- !ruby/object:Gem::Specification
 name: ims_caliper
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
-- Anthus Williams
-- Zhen Qian
+- Caliper Dev Group
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-18 00:00:00.000000000 Z
+date: 2015-04-22 00:00:00.000000000 Z
 dependencies: []
 description: This is the implementation of IMSGlobal Caliper in Ruby
 email:
-- aj@instructure.com
-- zqian@umich.edu
+- lisa@imsglobal.org
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- .gitignore
+- .idea/caliper-ruby.iml
+- .idea/encodings.xml
+- .idea/misc.xml
+- .idea/modules.xml
+- .idea/scopes/scope_settings.xml
+- .idea/vcs.xml
 - Gemfile
 - Gemfile.lock
+- LICENSE
+- NOTICE
 - README.md
 - caliper.gemspec
 - config/locales/en.yml
 - lib/caliper.rb
-- lib/caliper/client.rb
-- lib/caliper/consumer/base.rb
-- lib/caliper/consumer/queue.rb
-- lib/caliper/consumer/socket.rb
 - lib/caliper/defaults.rb
 - lib/caliper/entities/annotation/annotation.rb
 - lib/caliper/entities/annotation/bookmark_annotation.rb
 - lib/caliper/entities/annotation/highlight_annotation.rb
 - lib/caliper/entities/annotation/shared_annotation.rb
 - lib/caliper/entities/annotation/tag_annotation.rb
-- lib/caliper/entities/annotation/text_position_selector.rb
+- 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/attempt.rb
 - lib/caliper/entities/digital_resource.rb
 - lib/caliper/entities/entity.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
+- lib/caliper/entities/lis/group.rb
+- lib/caliper/entities/lis/membership.rb
 - lib/caliper/entities/lis/organization.rb
 - lib/caliper/entities/lis/person.rb
+- lib/caliper/entities/lis/roles.rb
+- lib/caliper/entities/lis/status.rb
+- lib/caliper/entities/media/audio_object.rb
+- 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/video_object.rb
 - lib/caliper/entities/outcome/result.rb
 - lib/caliper/entities/reading/epub_chapter.rb
 - lib/caliper/entities/reading/epub_part.rb
 - lib/caliper/entities/reading/epub_sub_chapter.rb
 - lib/caliper/entities/reading/epub_volume.rb
 - lib/caliper/entities/reading/frame.rb
-- lib/caliper/entities/schemadotorg/audio_object.rb
+- lib/caliper/entities/response/fillin_blank_response.rb
+- lib/caliper/entities/response/multiple_choice_response.rb
+- lib/caliper/entities/response/multiple_response_response.rb
+- lib/caliper/entities/response/response.rb
+- lib/caliper/entities/response/response_type.rb
+- lib/caliper/entities/response/select_type_response.rb
+- lib/caliper/entities/response/true_false_response.rb
 - lib/caliper/entities/schemadotorg/creative_work.rb
-- lib/caliper/entities/schemadotorg/image_object.rb
-- lib/caliper/entities/schemadotorg/media_object.rb
 - lib/caliper/entities/schemadotorg/software_application.rb
 - lib/caliper/entities/schemadotorg/thing.rb
-- lib/caliper/entities/schemadotorg/video_object.rb
 - lib/caliper/entities/schemadotorg/web_page.rb
 - lib/caliper/entities/session.rb
 - lib/caliper/entities/software_application.rb
 - lib/caliper/entities/targetable.rb
 - lib/caliper/entities/web_page.rb
-- lib/caliper/event/.shared.rb.swp
+- lib/caliper/entity_envelope.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/event_envelope.rb
+- lib/caliper/jsonable.rb
 - lib/caliper/options.rb
 - lib/caliper/profiles/annotation_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
@@ -91,29 +121,26 @@ files:
 - lib/caliper/validators/session_logout_event_validator.rb
 - lib/caliper/validators/time_check.rb
 - lib/caliper/version.rb
-- spec/lib/client_spec.rb
-- spec/lib/consumer/base_spec.rb
-- spec/lib/consumer/queue_spec.rb
-- spec/lib/event/annotation_spec.rb
-- spec/lib/event/bookmarked_spec.rb
-- spec/lib/event/commented_spec.rb
-- spec/lib/event/highlighted_spec.rb
-- spec/lib/event/navigation_spec.rb
-- spec/lib/event/shared_spec.rb
-- spec/lib/event/tagged_spec.rb
-- spec/lib/event/used_spec.rb
-- spec/lib/event/viewed_spec.rb
+- spec/lib/entities/entity.json
+- spec/lib/entities/entity_spec.rb
+- spec/lib/entities/lis/person_spec.rb
+- spec/lib/entities/lis/student.json
+- 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/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/event_helper.rb
+- spec/lib/sensor_spec.rb
 - spec/spec_helper.rb
-- test/caliper/events/session_login_event_test.rb
-- test/caliper/events/session_logout_event_test.rb
-- test/caliper/events/session_timeout_event_test.rb
-- test/caliper/request/http_requestor_test.rb
-- test/caliper/test_event.rb
-- test/caliper/test_utils.rb
-- test/fixtures/caliper_session_login_event.json
-- test/fixtures/caliper_session_logout_event.json
-- test/fixtures/caliper_session_timeout_event.json
-- test/fixtures/event_store_payload.json
 homepage: https://github.com/IMSGlobal/caliper-ruby
 licenses:
 - http://www.imsglobal.org/copyright.html
@@ -139,27 +166,23 @@ signing_key:
 specification_version: 4
 summary: Caliper Sensor API
 test_files:
-- spec/lib/client_spec.rb
-- spec/lib/consumer/base_spec.rb
-- spec/lib/consumer/queue_spec.rb
-- spec/lib/event/annotation_spec.rb
-- spec/lib/event/bookmarked_spec.rb
-- spec/lib/event/commented_spec.rb
-- spec/lib/event/highlighted_spec.rb
-- spec/lib/event/navigation_spec.rb
-- spec/lib/event/shared_spec.rb
-- spec/lib/event/tagged_spec.rb
-- spec/lib/event/used_spec.rb
-- spec/lib/event/viewed_spec.rb
+- spec/lib/entities/entity.json
+- spec/lib/entities/entity_spec.rb
+- spec/lib/entities/lis/person_spec.rb
+- spec/lib/entities/lis/student.json
+- 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/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/event_helper.rb
+- spec/lib/sensor_spec.rb
 - spec/spec_helper.rb
-- test/caliper/events/session_login_event_test.rb
-- test/caliper/events/session_logout_event_test.rb
-- test/caliper/events/session_timeout_event_test.rb
-- test/caliper/request/http_requestor_test.rb
-- test/caliper/test_event.rb
-- test/caliper/test_utils.rb
-- test/fixtures/caliper_session_login_event.json
-- test/fixtures/caliper_session_logout_event.json
-- test/fixtures/caliper_session_timeout_event.json
-- test/fixtures/event_store_payload.json
-has_rdoc: 

data/lib/caliper/client.rb

@@ -1,33 +0,0 @@
-
-module Caliper
-  class Client
-	  attr_accessor :api_key, :options, :stats
-    def initialize(key, opts = {})
-      if opts[:consumer]
-        opts[:consumer] = Object.const_get(opts[:consumer]) if opts[:consumer].is_a?(String)
-        opts[:consumer] = opts[:consumer].new(key, opts) if opts[:consumer].respond_to?(:new)
-        raise ArgumentError, "Expecting Caliper::Consumer but got #{opts[:consumer].class.to_s}" unless opts[:consumer].is_a?(Caliper::Consumer::Base)
-      end
-      @consumer = opts[:consumer] || Caliper::Consumer::Socket.new(key, opts)
-    end
-
-    def measure(event, timestamp=nil)
-      raise ArgumentError, "Expecting Caliper::Event but got #{event.class.to_s}" unless event.is_a?(Caliper::Event::Base)
-      #todo ensure timestamp is iso8601
-      timestamp ||= Time.now
-      action = event.action
-      # returned json will serialize nil contexts as []
-      learning_context = event.learning_context ? event.learning_context : nil
-      activity_context = event.activity_context ? event.activity_context : nil
-
-      @consumer.measure(action, learning_context, activity_context, timestamp)
-    end
-
-    def describe(entity, timestamp=nil)
-      raise ArgumentError, "Expecting Caliper::Entity but got #{entity.class.to_s}" unless entity.is_a?(Caliper::Entity::Base)
-      #todo ensure timestamp is iso8601
-      timestamp ||= Time.now
-      @consumer.describe(entity.type, entity.id, entity.properties, Time.now)
-    end
-  end
-end

data/lib/caliper/consumer/base.rb

@@ -1,46 +0,0 @@
-module Caliper
-  module Consumer
-    class Base
-      attr_reader :api_key
-
-      def initialize(key, opts = {})
-        @api_key = key
-        @options = validate_options(opts)
-      end
-
-      def describe(type, id, props, timestamp); end
-
-      def measure(action, learning_context, activity_context, timestamp); end
-
-      def with_debug?
-        @options[:debug] || false
-      end
-
-      def with_ssl?
-        @options[:ssl] || false
-      end
-
-      def on_error(error)
-        if with_debug?
-          #todo: log if debug
-        end
-
-        if @options[:on_error]
-          @options[:on_error].call(error)
-        end
-      end
-
-      def validate_options(opts)
-        hsh = {}
-        hsh[:debug] = opts[:debug] ? true : false
-        hsh[:ssl] = opts[:ssl] ? true : false
-        if opts[:on_error]
-          raise ArgumentError, "on_error option should be callable" unless opts[:on_error].is_a?(Proc) 
-          hsh[:on_error] = opts[:on_error]
-        end
-        hsh
-      end
-
-    end
-  end
-end

data/lib/caliper/consumer/queue.rb

@@ -1,40 +0,0 @@
-module Caliper
-  module Consumer
-    class Queue < Base
-      attr_reader :max_queue_size, :batch_size
-
-      def initialize(key, opts = {})
-        super
-        @queue = []
-      end
-
-      def validate_options(opts)
-        hsh = super
-        @max_queue_size = hsh[:max_queue_size] = opts[:max_queue_size].to_i
-        @batch_size = hsh[:batch_size] = opts[:batch_size].to_i
-        hsh
-      end
-
-      def measure(action, learning_context, activity_context, timestamp)
-        enqueue OpenStruct.new(api_key: @api_key, action: action, learning_context: learning_context, activity_context: activity_context, timestamp: timestamp, proc_name: "measure")
-      end
-
-      def describe(type, id, properties, timestamp)
-        enqueue OpenStruct.new(api_key: @api_key, entity_type: type, entity_id: id, properties: properties, timestamp: timestamp, proc_name: "describe")
-      end
-
-      def enqueue(item) 
-        if item.proc_name == "measure"
-          flush_measure(item)
-        elsif item.proc_name == "describe"
-          flush_describe(item)
-        end
-      end
-
-      def flush_measure(item); end
-
-      def flush_describe(item); end
-
-    end
-  end
-end

data/lib/caliper/consumer/socket.rb

@@ -1,132 +0,0 @@
-require 'socket'
-require 'openssl'
-require "active_support"
-
-module Caliper
-  module Consumer
-    class Socket < Queue
-      attr_reader :socket
-
-      def initialize(key, opts = {})
-        super
-      end
-
-      def validate_options(opts)
-        hsh = super(opts)
-        hsh[:timeout] = opts[:timeout] || 0.5
-        hsh[:host] = opts[:host] || "localhost"
-        hsh[:port] = opts[:port] || ( hsh[:ssl] ? 443 : 80 )
-        hsh[:max_response_size] = opts[:max_response_size] || 2048
-        hsh
-      end
-
-      private
-
-      def flush_describe(item)
-        socket = init_socket
-        return unless socket
-
-        send_request( socket, describe_body( @options[:host], ActiveSupport::JSON.encode(item)) )
-      end
-
-      def flush_measure(item)
-        socket = init_socket
-        return unless socket
-
-        send_request( socket, measure_body( @options[:host], ActiveSupport::JSON.encode(item)) )
-      end
-
-      # both describe_body and measure_body hardcode a URL as is the case with caliper-php
-      # todo: make this configurable
-      def describe_body(host, content)
-        <<-STR.gsub(/^ {10}/,'')
-          PUT /v1/describe HTTP/1.1/
-          Host: #{host}
-          Content-Type: application/json
-          Accept: application\json
-          Content-length: #{content.length}
-          
-          #{content}
-        STR
-      end
-
-      def measure_body(host, content)
-        <<-STR.gsub(/^ {10}/,'')
-          PUT /v1/learningevent HTTP/1.1/
-          Host: #{host}
-          Content-Type: application/json
-          Accept: application\json
-          Content-length: #{content.length}
-          
-          #{content}
-        STR
-      end
-
-      def init_socket
-        # if socket has failed, don't keep trying to connect on future events
-        return if @socket_failed
-        begin
-          s = TCPSocket.new(@options[:host], @options[:port])
-          if with_ssl?
-            s = OpenSSL::SSL::SSLSocket.new(s)
-            s.sync_close
-            s.connect
-          end
-        rescue SocketError => e
-          on_error(e)
-          @socket_failed = true
-          return
-        end
-        s
-      end
-
-      def send_request(socket, body, with_retries = 1)
-        written = 0
-        closed = false
-        while !closed && bytes_written < body.bytesize
-          begin
-             bytes_written = socket.write(body[bytes_written..-1])
-            if bytes_written.zero?
-              closed = true
-            else
-              written += bytes_written
-            end
-          rescue SocketError => e
-            on_error(e)
-            closed = true
-          end
-        end
-
-        if closed
-          socket.close
-          # attempt to retry connection up to with_retries times
-          unless with_retries.zero?
-            socket = init_socket
-            return send_request(socket, body, with_retries - 1) if socket
-          end
-          return false
-        end
-
-        success = true
-
-        # if debug is enabled, wait for response
-        if with_debug?
-          r = parse_response(socket.read(@options[:max_response_size]))
-          unless r.status == 200
-            #todo build exception and send it to on_error
-            success = false
-          end
-        end
-
-        return success
-      end
-
-      def parse_response(resp)
-        contents = resp.split("\n")
-        status = contents.first.split(" ")
-        OpenStruct.new(:status => (status.length > 1 ? status[1] : nil), :message => contents.last) 
-      end
-
-    end
-  end
-end