learnosity-sdk 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 69ce4c83a0acd03be313fa8caa56a35d28442cf0
-  data.tar.gz: 18da69bf85b5879a3a0848202dadb1d00746b235
+  metadata.gz: ba0bf92f67d01ee19c744c6aaeb8673d8837dc25
+  data.tar.gz: e3e37546a446b45dd1d2138dd558c7bc15d3522e
 SHA512:
-  metadata.gz: ce0bdb72d86c33ca14bea31e072e5765ac8129a0c029bd3639408123411045a362a0fc35ac75c83629281ae50cd16f3ad46158343f83edf9442adfa1aa0da8ed
-  data.tar.gz: a21edf6bae35274ad21645b1cb17caafa734657b4a047afd74471263d02bb33b72e1d97e37cbd898449c9b6a51593dba888718b8eba6ac3ea49179c5ed89225f
+  metadata.gz: 6687888f2a40215ad49d9197a0f3a4625ebb210bfa1cfafbe4987d7acf86aece7e3ce0889f487e8e4fdae82f7a6d8398f6a3b2907bd28dc998c786df44796dfd
+  data.tar.gz: 04cc99d5b8318d4c900887df355d245f089f4f348ae10603fff89363d5ab8d2d8a304c606f617998278d31cada4e9e2fc2ac31ee111e58025dbe319dd6cfd9b0

data/.codeclimate.yml

@@ -0,0 +1,42 @@
+version: "2"         # required to adjust maintainability checks
+
+checks:
+  argument-count:
+    enabled: false
+  file-lines:
+    enabled: false
+  method-count:
+    enabled: false
+  method-lines:
+    enabled: false
+  similar-code:
+    config:
+      threshold: 150
+  identical-code:
+    config:
+      threshold: 100
+  method-complexity:
+    config:
+      threshold: 15
+
+plugins:
+  # Ruby
+  bundler-audit:
+    enabled: true
+  rubocop:
+    enabled: true
+  duplication:
+    enabled: true
+    config:
+      languages:
+      - ruby:
+
+  # Other
+  git-legal:
+    enabled: true
+  fixme:
+    enabled: true
+    config:
+      strings:
+      - FIXME
+      - BUG

data/.gitignore

@@ -1,6 +1,7 @@
+.idea/
+.rakeTasks
 /.bundle/
 /.yardoc
-/Gemfile.lock
 /_yardoc/
 /coverage/
 /doc/
@@ -8,5 +9,7 @@
 /spec/reports/
 /tmp/
 
+/examples/lrn-sdk-rails/Gemfile.lock
+
 # rspec failure tracking
 .rspec_status

data/ChangeLog.md

@@ -0,0 +1,16 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
+and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [v0.2.0] - 2019-08-12
+### Added
+- This ChangeLog!
+- Telemetry data (basic information about the execution environment) is now added to the request objects being signed which is later read and logged internally by our APIs when the request is received. This allows us to better support our various SDKs and does not send any additional network requests. More information can be found in README.md.
+
+## [v0.1.0] - 2017-05-10
+Initial Release

data/Gemfile.lock

@@ -0,0 +1,39 @@
+PATH
+  remote: .
+  specs:
+    learnosity-sdk (0.2.0)
+      sys-uname (~> 1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    ffi (1.11.1)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    sys-uname (1.0.4)
+      ffi (>= 1.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (>= 1.14)
+  learnosity-sdk!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.17.3

data/README.md

@@ -1,5 +1,7 @@
 # Learnosity SDK - Ruby
 
+[![Gem Version](https://badge.fury.io/rb/learnosity-sdk.svg)](https://badge.fury.io/rb/learnosity-sdk)
+
 This gem allows to ease integration with the following Learnosity APIs,
 
 - Author API [author-api-doc]
@@ -26,7 +28,7 @@ You can build and install the SDK directly from a Git clone, with
     cd learnosity-sdk-ruby/
     bundle install
     rake build
-    gem install --user-install pkg/learnosity-sdk-0.1.0.gem
+    gem install --user-install pkg/learnosity-sdk-0.2.0.gem
 
 If `bundle` is missing, you can install it with
 
@@ -60,9 +62,11 @@ say, the `items` API, you just need to instantiate the
 require "learnosity/sdk/request/init"
 
 security_packet = {
-        'consumer_key'   => 'yis0TYCu7U9V4o7M',
-        'domain'         => 'localhost',
+	# XXX: This is a Learnosity Demos consumer; replace it with your own consumer key
+	'consumer_key'   => 'yis0TYCu7U9V4o7M',
+	'domain'         => 'localhost'
 }
+# XXX: The consumer secret should be in a properly secured credential store, and *NEVER* checked in in revision control
 consumer_secret = '74c5fd430cf1242a527f6223aebd42d30464be22'
 items_request = { 'limit' => 50 }
 
@@ -109,9 +113,11 @@ require "learnosity/sdk/request/init"
 
 
 security_packet = {
-        'consumer_key'   => 'yis0TYCu7U9V4o7M',
-        'domain'         => 'localhost',
+	# XXX: This is a Learnosity Demos consumer; replace it with your own consumer key
+	'consumer_key'   => 'yis0TYCu7U9V4o7M',
+	'domain'         => 'localhost'
 }
+# XXX: The consumer secret should be in a properly secured credential store, and *NEVER* checked in in revision control
 consumer_secret = '74c5fd430cf1242a527f6223aebd42d30464be22'
 data_request = { 'limit' => 50 }
 
@@ -141,7 +147,13 @@ For the time being, you can iterate through pages by looping over the
 `Init#new`/`Init#generate`/`Net::HTTP#post_form`, updating the `next` attribute
 in the request.
 
-	data_request['next'] = JSON.parse(res.body)['meta']['next']
+```ruby
+response = JSON.parse(res.body)
+if ( !response['meta']['next'].nil? \
+		and !response['meta']['records'].nil? and response['meta']['records'] > 0)
+	data_request['next'] = response['meta']['next']
+end
+```
 
 This will `require 'json'` to be able to parse the response.
 
@@ -190,6 +202,7 @@ require 'learnosity/sdk/request/init'
 
 class IndexController < ApplicationController
   @@security_packet = {
+    # XXX: This is a Learnosity Demos consumer; replace it with your own consumer key
     'consumer_key'   => 'yis0TYCu7U9V4o7M',
     'domain'         => 'localhost'
   }
@@ -212,7 +225,7 @@ end
 
 Add the HTML/Javascript boilerplate to the view, `app/views/index/index.html.erb`
 
-```
+```erb
 <h1>Index#index</h1>
 
 <div id="learnosity_assess"></div>
@@ -255,7 +268,19 @@ Just run
 
     rake spec
 
-to exercise the testsuite
+to exercise the testsuite.
+
+##Tracking
+
+In version v0.2.0, we introduced code to track the following information by adding it to the request being signed:
+
+    SDK version
+    SDK language
+    SDK language version
+    Host platform (OS)
+    Platform version
+
+We use this data to enable better support and feature planning. All subsequent versions of the SDK shall include this usage tracking.
 
 
 [author-api-doc]: https://docs.learnosity.com/authoring/author

data/examples/lrn-sdk-rails/Gemfile

@@ -9,7 +9,7 @@ end
 # Bundle edge Rails instead: gem 'rails', github: 'rails/rails'
 gem 'rails', '~> 5.0.2'
 # Use sqlite3 as the database for Active Record
-gem 'sqlite3'
+gem 'sqlite3', '~> 1.3.6'
 # Use Puma as the app server
 gem 'puma', '~> 3.0'
 # Use SCSS for stylesheets

data/examples/lrn-sdk-rails/app/controllers/index_controller.rb

@@ -3,6 +3,7 @@ require 'securerandom'
 
 class IndexController < ApplicationController
   @@security_packet = {
+    # XXX: This is a Learnosity Demos consumer; replace it with your own consumer key
     'consumer_key'   => 'yis0TYCu7U9V4o7M',
     'domain'         => 'localhost'
   }
@@ -91,7 +92,7 @@ class IndexController < ApplicationController
     "session_id" => SecureRandom.uuid,
     "state" => "initial",
     "type" => "submit_practice",
-    "user_id" => "demo_student"
+    "user_id" => "$ANONYMIZED_USER_ID"
   }
 
   def index

data/examples/simple/init_data.rb

@@ -4,7 +4,10 @@ require 'json'
 
 require 'learnosity/sdk/request/init'
 
+itembank_uri = URI('https://data.learnosity.com/v1/itembank/items')
+
 security_packet = {
+	# XXX: This is a Learnosity Demos consumer; replace it with your own consumer key
 	'consumer_key'   => 'yis0TYCu7U9V4o7M',
 	'domain'         => 'localhost'
 }
@@ -13,7 +16,7 @@ consumer_secret = '74c5fd430cf1242a527f6223aebd42d30464be22'
 data_request = { 'limit' => 1 }
 
 # Do 5 subsequent requests using the `next` pointer
-[1,2,3,4,5].each  do |reqno|
+[1,2,3,4,5].each do |reqno|
 	init = Learnosity::Sdk::Request::Init.new(
 		'data',
 		security_packet,
@@ -23,12 +26,15 @@ data_request = { 'limit' => 1 }
 
 	request = init.generate
 
-	itembankUri = URI('https://data.learnosity.com/v1/itembank/items')
-	puts ">>> [#{itembankUri} (#{reqno})] #{JSON.generate(request)}"
+	puts ">>> [#{itembank_uri} (#{reqno})] #{JSON.generate(request)}"
 
-	res = Net::HTTP.post_form(itembankUri, request)
+	res = Net::HTTP.post_form(itembank_uri, request)
 
 	puts "<<< [#{res.code}] #{res.body}"
 
-	data_request['next'] = JSON.parse(res.body)['meta']['next']
+	response = JSON.parse(res.body)
+	if !response['meta']['next'].nil? \
+			and !response['meta']['records'].nil? and response['meta']['records'] > 0
+		data_request['next'] = response['meta']['next']
+	end
 end

data/examples/simple/init_items.rb

@@ -2,6 +2,7 @@
 require 'learnosity/sdk/request/init'
 
 security_packet = {
+	# XXX: This is a Learnosity Demos consumer; replace it with your own consumer key
 	'consumer_key'   => 'yis0TYCu7U9V4o7M',
 	'domain'         => 'localhost'
 }

data/learnosity-sdk.gemspec

@@ -30,7 +30,8 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_runtime_dependency "sys-uname", "~> 1.0"
+  spec.add_development_dependency "bundler", ">= 1.14"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
 end

data/lib/learnosity/sdk/request/init.rb

@@ -3,226 +3,279 @@ require 'json'
 
 require 'learnosity/sdk/exceptions'
 require 'learnosity/sdk/utils'
+require 'learnosity/sdk/version'
+require 'sys/uname'
 
 module Learnosity
   module Sdk
     module Request
 
       class Init
-	# XXX: Needs to be public for unit tests
-	attr_reader :security_packet, :request_string
+        # XXX: Needs to be public for unit tests
+        attr_reader :security_packet, :request_string
 
         # Keynames that are valid in the security_packet, they are also in
         # the correct order for signature generation.
-        @@validSecurityKeys = ['consumer_key', 'domain', 'timestamp', 'expires', 'user_id'];
+        @@valid_security_keys = ['consumer_key', 'domain', 'timestamp', 'expires', 'user_id'];
 
         # Service names that are valid for `$service`
-        @@validServices = ['assess', 'author', 'data', 'events', 'items', 'questions', 'reports'];
+        @@valid_services = ['assess', 'author', 'data', 'events', 'items', 'questions', 'reports'];
+
+        # Determines if telemetry is enabled
+        @@telemetry_enabled = true
+
+        def self.enable_telemetry
+          @@telemetry_enabled = true
+        end
+
+        def self.disable_telemetry
+          @@telemetry_enabled = false
+        end
 
         def initialize(service, security_packet, secret, request_packet = nil, action = nil)
-	  @sign_request_data = false
-	  @service = service
-	  @security_packet = security_packet.clone if ! security_packet.nil?
-	  @secret = secret
-	  @request_packet = request_packet.clone if ! request_packet.nil?
-	  @action = action
-
-	  self.validate()
-	  self.set_service_options()
-
-	  @request_string = self.generate_request_string()
-	  @security_packet['signature'] = self.generate_signature()
+          @sign_request_data = false
+          @service = service
+          @security_packet = security_packet.clone unless security_packet.nil?
+          @secret = secret
+          @request_packet = request_packet.clone unless request_packet.nil?
+          @action = action
+
+          validate
+
+          if @@telemetry_enabled
+            add_meta
+          end
+
+          set_service_options
+
+          @request_string = generate_request_string
+          @security_packet['signature'] = generate_signature
         end
 
-	def generate_signature()
-	  signature_array = []
-	  @@validSecurityKeys.each do |k|
-	    if @security_packet.include? k
-	      signature_array.<< @security_packet[k]
-	    end
-	  end
+        def generate_signature
+          signature_array = []
+          @@valid_security_keys.each do |k|
+            if @security_packet.include? k
+              signature_array.<< @security_packet[k]
+            end
+          end
 
-	  signature_array << @secret
+          signature_array << @secret
 
-	  if @sign_request_data and ! @request_string.nil?
-	    signature_array << @request_string
-	  end
+          if @sign_request_data and ! @request_string.nil?
+            signature_array << @request_string
+          end
 
-	  if ! @action.nil?
-	    signature_array << @action
-	  end
+          unless @action.nil?
+            signature_array << @action
+          end
 
-	  return self.hash_signature(signature_array)
-	end
+          hash_signature(signature_array)
+        end
 
         def generate(encode = true)
-	  output = {}
-
-	  case @service
-	  when 'assess', 'author', 'data', 'items', 'reports'
-	    output['security'] =  @security_packet
-
-	    if !@request_packet.nil?
-	      output['request'] = @request_packet
-	    end
-
-	    case @service
-	    when 'data'
-	      dataOutput = { 'security' => JSON.generate(output['security']) }
-	      if output.key?('request')
-		dataOutput['request'] = JSON.generate(output['request'])
-	      end
-	      if !@action.nil?
-		dataOutput['action'] = @action
-	      end
-	      return dataOutput
-
-	    when 'assess'
-	      output = output['request']
-	    end
-
-	  when 'questions'
-	    output = hash_except(@security_packet, 'domain')
-	    if !@request_packet.nil?
-	      output = output.merge(@request_packet)
-	    end
-
-	  when 'events'
-	    output['security'] =  @security_packet
-	    output['config'] =  @request_packet
-	  else
-	    raise Exception, "generate() for #{@service} not implemented"
-	  end
-
-	  if !encode
-	    return output
-	  end
-	  return JSON.generate(output)
-        end
+          output = {}
+
+          case @service
+          when 'assess', 'author', 'data', 'items', 'reports'
+            output['security'] =  @security_packet
+
+            unless @request_packet.nil?
+              output['request'] = @request_packet
+            end
+
+            case @service
+            when 'data'
+              data_output = { 'security' => JSON.generate(output['security']) }
 
-	protected
+              if output.key?('request')
+                data_output['request'] = JSON.generate(output['request'])
+              end
 
-	attr_accessor :service, :secret, :request_packet, :action, :sign_request_data
-	attr_writer :security_packet, :request_string
+              unless @action.nil?
+                data_output['action'] = @action
+              end
 
-        def validate()
-	  if @service.nil?
-	    raise Learnosity::Sdk::ValidationException, 'The `service` argument wasn\'t found or was empty'
-	  elsif ! @@validServices.include? @service
-	    raise Learnosity::Sdk::ValidationException, "The service provided (#{service}) is not valid"
-	  end
+              return data_output
 
-	  # XXX we don't do JSON to native object conversion for now, as the PHP SDK does
+            when 'assess'
+              output = output['request']
+            end
 
-	  if @security_packet.nil? or ! @security_packet.is_a? Hash
-	    raise Learnosity::Sdk::ValidationException, 'The security packet must be a Hash'
-	  else
-	    @security_packet.each do |k, v|
-	      if ! @@validSecurityKeys.include? k
-		raise ValidationException, "Invalid key found in the security packet: #{k}"
-	      end
-	    end
+          when 'questions'
+            output = hash_except(@security_packet, 'domain')
 
-	    if @service == 'questions' and ! @security_packet.include? 'user_id'
-	      raise ValidationException, 'Questions API requires a `user_id` in the security packet'
-	    end
+            unless @request_packet.nil?
+              output = output.merge(@request_packet)
+            end
 
-	    if ! @security_packet.include? 'timestamp'
-	      @security_packet['timestamp'] = Time.now.gmtime.strftime('%Y%m%d-%H%m')
-	    end
-	  end
+          when 'events'
+            output['security'] =  @security_packet
+            output['config'] =  @request_packet
+          else
+            raise Exception, "generate() for #{@service} not implemented"
+          end
 
-	  if @secret.nil? or ! @secret.is_a? String
-	   raise ValidationException, 'The `secret` argument must be a valid string'
-	  end
+          unless encode
+            return output
+          end
 
-	  # XXX we don't do JSON to native object conversion for now, as the PHP SDK does
+          JSON.generate(output)
+        end
+
+        protected
+
+        attr_accessor :service, :secret, :request_packet, :action, :sign_request_data
+        attr_writer :security_packet, :request_string
+
+        def get_platform
+          if Sys::Platform.linux?
+            'linux'
+          elsif Sys::Platform.windows?
+            'win'
+          elsif Sys::Platform.mac?
+            'darwin'
+          else
+            Sys::Uname.platform
+          end
+        end
+
+        def add_meta
+          if @request_packet.nil?
+            @request_packet = {}
+          end
+
+          sdk_metrics = {
+            :version => VERSION,
+            :lang => 'ruby',
+            :lang_version => RUBY_VERSION,
+            :platform => get_platform,
+            :platform_version => Sys::Uname.release
+          }
+
+          if @request_packet.include? 'meta'
+            @request_packet['meta'].delete('sdk') if @request_packet['meta'].include? 'sdk'
+
+            @request_packet['meta'][:sdk] = sdk_metrics
+          elsif @request_packet.include? :meta
+            @request_packet[:meta].delete('sdk') if @request_packet[:meta].include? 'sdk'
 
-	  if ! @request_packet.nil? and ! @request_packet.is_a? Hash
-	    raise ValidationException, 'The request packet must be a hash'
-	  end
+            @request_packet[:meta][:sdk] = sdk_metrics
+          else
+            @request_packet[:meta] = {}
 
-	  if ! @action.nil? and ! @action.is_a? String
-	   raise ValidationException, 'The `action` argument must be a string'
-	  end
+            @request_packet[:meta][:sdk] = sdk_metrics
+          end
+        end
+
+        def validate
+          if @service.nil?
+            raise Learnosity::Sdk::ValidationException, 'The `service` argument wasn\'t found or was empty'
+          elsif ! @@valid_services.include? @service
+            raise Learnosity::Sdk::ValidationException, "The service provided (#{service}) is not valid"
+          end
+
+          # XXX we don't do JSON to native object conversion for now, as the PHP SDK does
+          if @security_packet.nil? or ! @security_packet.is_a? Hash
+            raise Learnosity::Sdk::ValidationException, 'The security packet must be a Hash'
+          else
+            @security_packet.each do |k, v|
+              unless @@valid_security_keys.include? k
+                raise ValidationException, "Invalid key found in the security packet: #{k}"
+              end
+            end
+
+            if @service == 'questions' and ! @security_packet.include? 'user_id'
+              raise ValidationException, 'Questions API requires a `user_id` in the security packet'
+            end
+
+            unless @security_packet.include? 'timestamp'
+              @security_packet['timestamp'] = Time.now.gmtime.strftime('%Y%m%d-%H%m')
+            end
+          end
+
+          if @secret.nil? or ! @secret.is_a? String
+            raise ValidationException, 'The `secret` argument must be a valid string'
+          end
+
+          # XXX we don't do JSON to native object conversion for now, as the PHP SDK does
+          if ! @request_packet.nil? and ! @request_packet.is_a? Hash
+            raise ValidationException, 'The request packet must be a hash'
+          end
+
+          if ! @action.nil? and ! @action.is_a? String
+            raise ValidationException, 'The `action` argument must be a string'
+          end
+        end
 
+        def set_service_options
+          case @service
+          when 'questions'
+            # nothing to do
+          when 'assess'
+            if @request_packet.key?('questionsApiActivity')
+              questions_api_activity = @request_packet['questionsApiActivity']
+
+              signature_parts = {}
+              signature_parts['consumer_key'] \
+                = questions_api_activity['consumer_key'] \
+                = @security_packet['consumer_key']
+
+              signature_parts['domain'] = @security_packet['domain'] \
+                || questions_api_activity['domain'] \
+                || 'assess.learnosity.com'
+
+              signature_parts['timestamp'] \
+                = questions_api_activity['timestamp'] \
+                = @security_packet['timestamp']
+
+              signature_parts['expires'] = \
+                questions_api_activity['expires'] \
+                = @security_packet['expires'] if @security_packet.key?('expires')
+
+              signature_parts['user_id'] = \
+                questions_api_activity['user_id'] = \
+                @security_packet['user_id']
+
+              signature_parts['secret'] = @security_packet['secret']
+
+              # Remove expires attribute if present but nil
+              questions_api_activity = hash_except(questions_api_activity, 'expires') if questions_api_activity['expires'].nil?
+
+              @security_packet = signature_parts
+              questions_api_activity['signature'] = generate_signature
+              @request_packet['questionsApiActivity'] = questions_api_activity
+            end
+          when 'items', 'reports'
+            @sign_request_data = true
+            if ! @request_packet.nil? and @request_packet.include? 'user_id' and
+                ! @security_packet.include? 'user_id'
+              @security_packet['user_id'] = @request_packet['user_id']
+            end
+          when 'events'
+            hashed_users = {}
+            @request_packet['users'].each do |k, v|
+              hashed_users[k] =  hash_value(k + @secret)
+            end
+            @request_packet['users'] = hashed_users
+          when 'author', 'data'
+            @sign_request_data = true
+          else
+            raise Exception, "set_service_options() for #{@service} not implemented"
+          end
         end
 
-	def set_service_options()
-	  case @service
-	  when 'questions'
-	    # nothing to do
-	  when 'assess'
-	    if @request_packet.key?('questionsApiActivity')
-	      questionsApiActivity = @request_packet['questionsApiActivity']
-
-	      signatureParts = {}
-	      signatureParts['consumer_key'] \
-		= questionsApiActivity['consumer_key'] \
-		= @security_packet['consumer_key']
-
-	      signatureParts['domain'] = @security_packet['domain'] \
-		|| questionsApiActivity['domain'] \
-		|| 'assess.learnosity.com'
-
-	      signatureParts['timestamp'] \
-		= questionsApiActivity['timestamp'] \
-		= @security_packet['timestamp']
-
-	      signatureParts['expires'] = \
-		questionsApiActivity['expires'] \
-		= @security_packet['expires'] if @security_packet.key?('expires')
-
-	      signatureParts['user_id'] = \
-		questionsApiActivity['user_id'] = \
-		@security_packet['user_id']
-
-	      signatureParts['secret'] = @security_packet['secret']
-
-	      # Remove expires attribute if present but nil
-	      questionsApiActivity = hash_except(questionsApiActivity, 'expires') if questionsApiActivity['expires'].nil?
-
-	      @security_packet = signatureParts
-	      questionsApiActivity['signature'] = self.generate_signature()
-	      @request_packet['questionsApiActivity'] = questionsApiActivity
-
-	    end
-	  when 'items', 'reports'
-	    @sign_request_data = true
-	    if ! @request_packet.nil? and @request_packet.include? 'user_id' and
-		! @security_packet.include? 'user_id'
-	      @security_packet['user_id'] = @request_packet['user_id']
-	    end
-	  when 'events'
-	    hashedUsers = {}
-	    @request_packet['users'].each do |k, v|
-	      hashedUsers[k] =  self.hash_value(k + @secret)
-	    end
-	    @request_packet['users'] = hashedUsers
-	  when 'author', 'data'
-	    @sign_request_data = true
-	  else
-	    raise Exception, "set_service_options() for #{@service} not implemented"
-	  end
-	end
-
-	def generate_request_string()
-	  request_string = nil
-	  if ! @request_packet.nil?
-	    request_string = JSON.generate(@request_packet)
-	  end
-
-	  return request_string
-	end
-
-	def hash_value(value)
-	  return Digest::SHA256.hexdigest value
-	end
-
-	def hash_signature(signature_array)
-	  return self.hash_value(signature_array.join('_'))
-	end
+        def generate_request_string
+          JSON.generate @request_packet unless request_packet.nil?
+        end
 
+        def hash_value(value)
+          Digest::SHA256.hexdigest value
+        end
+
+        def hash_signature(signature_array)
+          hash_value(signature_array.join('_'))
+        end
       end
 
     end

data/lib/learnosity/sdk/utils.rb

@@ -1,4 +1,4 @@
 # Emulate Hash#except from Rails
 def hash_except(h, k)
-    return h.reject { |kk,vv| kk == k }
+    h.reject { |kk,vv| kk == k }
 end

data/lib/learnosity/sdk/version.rb

@@ -1,5 +1,5 @@
 module Learnosity
   module Sdk
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: learnosity-sdk
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Olivier Mehani
@@ -9,20 +9,34 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-05-10 00:00:00.000000000 Z
+date: 2019-08-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: sys-uname
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.14'
 - !ruby/object:Gem::Dependency
@@ -61,10 +75,13 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".codeclimate.yml"
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- ChangeLog.md
 - Gemfile
+- Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile
@@ -180,7 +197,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.5.2.3
 signing_key: 
 specification_version: 4
 summary: SDK to interact with Learnosity APIs