learnosity-sdk 0.1.0

data/lib/learnosity/sdk.rb

@@ -0,0 +1,9 @@
+require "learnosity/sdk/version"
+
+module Learnosity
+  module Sdk
+    # Your code goes here...
+  end
+end
+
+# vim: sw=2

data/lib/learnosity/sdk/exceptions.rb

@@ -0,0 +1,10 @@
+module Learnosity
+  module Sdk
+
+    class ValidationException < Exception
+    end
+
+  end
+end
+
+# vim: sw=2

data/lib/learnosity/sdk/request.rb

@@ -0,0 +1,9 @@
+module Learnosity
+  module Sdk
+    module Request
+      # Your code goes here...
+    end
+  end
+end
+
+# vim: sw=2

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

@@ -0,0 +1,232 @@
+require 'digest'
+require 'json'
+
+require 'learnosity/sdk/exceptions'
+require 'learnosity/sdk/utils'
+
+module Learnosity
+  module Sdk
+    module Request
+
+      class Init
+	# 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'];
+
+        # Service names that are valid for `$service`
+        @@validServices = ['assess', 'author', 'data', 'events', 'items', 'questions', 'reports'];
+
+        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()
+        end
+
+	def generate_signature()
+	  signature_array = []
+	  @@validSecurityKeys.each do |k|
+	    if @security_packet.include? k
+	      signature_array.<< @security_packet[k]
+	    end
+	  end
+
+	  signature_array << @secret
+
+	  if @sign_request_data and ! @request_string.nil?
+	    signature_array << @request_string
+	  end
+
+	  if ! @action.nil?
+	    signature_array << @action
+	  end
+
+	  return self.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
+
+	protected
+
+	attr_accessor :service, :secret, :request_packet, :action, :sign_request_data
+	attr_writer :security_packet, :request_string
+
+        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
+
+	  # 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|
+	      if ! @@validSecurityKeys.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
+
+	    if ! @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')
+	      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
+
+      end
+
+    end
+  end
+end
+
+# vim: sw=2

data/lib/learnosity/sdk/utils.rb

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

data/lib/learnosity/sdk/version.rb

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

metadata

@@ -0,0 +1,187 @@
+--- !ruby/object:Gem::Specification
+name: learnosity-sdk
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Olivier Mehani
+- learnosity
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-05-10 00:00:00.000000000 Z
+dependencies:
+- !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
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- olivier.mehani@learnosity.com
+- licenses@learnosity.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- examples/lrn-sdk-rails/.gitignore
+- examples/lrn-sdk-rails/Gemfile
+- examples/lrn-sdk-rails/README.md
+- examples/lrn-sdk-rails/Rakefile
+- examples/lrn-sdk-rails/app/assets/config/manifest.js
+- examples/lrn-sdk-rails/app/assets/images/.keep
+- examples/lrn-sdk-rails/app/assets/javascripts/application.js
+- examples/lrn-sdk-rails/app/assets/javascripts/cable.js
+- examples/lrn-sdk-rails/app/assets/javascripts/channels/.keep
+- examples/lrn-sdk-rails/app/assets/javascripts/index.coffee
+- examples/lrn-sdk-rails/app/assets/stylesheets/application.css
+- examples/lrn-sdk-rails/app/assets/stylesheets/index.scss
+- examples/lrn-sdk-rails/app/channels/application_cable/channel.rb
+- examples/lrn-sdk-rails/app/channels/application_cable/connection.rb
+- examples/lrn-sdk-rails/app/controllers/application_controller.rb
+- examples/lrn-sdk-rails/app/controllers/concerns/.keep
+- examples/lrn-sdk-rails/app/controllers/index_controller.rb
+- examples/lrn-sdk-rails/app/helpers/application_helper.rb
+- examples/lrn-sdk-rails/app/helpers/index_helper.rb
+- examples/lrn-sdk-rails/app/jobs/application_job.rb
+- examples/lrn-sdk-rails/app/mailers/application_mailer.rb
+- examples/lrn-sdk-rails/app/models/application_record.rb
+- examples/lrn-sdk-rails/app/models/concerns/.keep
+- examples/lrn-sdk-rails/app/views/index/index.html.erb
+- examples/lrn-sdk-rails/app/views/layouts/application.html.erb
+- examples/lrn-sdk-rails/app/views/layouts/mailer.html.erb
+- examples/lrn-sdk-rails/app/views/layouts/mailer.text.erb
+- examples/lrn-sdk-rails/bin/bundle
+- examples/lrn-sdk-rails/bin/rails
+- examples/lrn-sdk-rails/bin/rake
+- examples/lrn-sdk-rails/bin/setup
+- examples/lrn-sdk-rails/bin/spring
+- examples/lrn-sdk-rails/bin/update
+- examples/lrn-sdk-rails/config.ru
+- examples/lrn-sdk-rails/config/application.rb
+- examples/lrn-sdk-rails/config/boot.rb
+- examples/lrn-sdk-rails/config/cable.yml
+- examples/lrn-sdk-rails/config/database.yml
+- examples/lrn-sdk-rails/config/environment.rb
+- examples/lrn-sdk-rails/config/environments/development.rb
+- examples/lrn-sdk-rails/config/environments/production.rb
+- examples/lrn-sdk-rails/config/environments/test.rb
+- examples/lrn-sdk-rails/config/initializers/application_controller_renderer.rb
+- examples/lrn-sdk-rails/config/initializers/assets.rb
+- examples/lrn-sdk-rails/config/initializers/backtrace_silencers.rb
+- examples/lrn-sdk-rails/config/initializers/cookies_serializer.rb
+- examples/lrn-sdk-rails/config/initializers/filter_parameter_logging.rb
+- examples/lrn-sdk-rails/config/initializers/inflections.rb
+- examples/lrn-sdk-rails/config/initializers/mime_types.rb
+- examples/lrn-sdk-rails/config/initializers/new_framework_defaults.rb
+- examples/lrn-sdk-rails/config/initializers/session_store.rb
+- examples/lrn-sdk-rails/config/initializers/wrap_parameters.rb
+- examples/lrn-sdk-rails/config/locales/en.yml
+- examples/lrn-sdk-rails/config/puma.rb
+- examples/lrn-sdk-rails/config/routes.rb
+- examples/lrn-sdk-rails/config/secrets.yml
+- examples/lrn-sdk-rails/config/spring.rb
+- examples/lrn-sdk-rails/db/seeds.rb
+- examples/lrn-sdk-rails/lib/assets/.keep
+- examples/lrn-sdk-rails/lib/tasks/.keep
+- examples/lrn-sdk-rails/log/.keep
+- examples/lrn-sdk-rails/public/404.html
+- examples/lrn-sdk-rails/public/422.html
+- examples/lrn-sdk-rails/public/500.html
+- examples/lrn-sdk-rails/public/apple-touch-icon-precomposed.png
+- examples/lrn-sdk-rails/public/apple-touch-icon.png
+- examples/lrn-sdk-rails/public/favicon.ico
+- examples/lrn-sdk-rails/public/robots.txt
+- examples/lrn-sdk-rails/test/controllers/.keep
+- examples/lrn-sdk-rails/test/controllers/index_controller_test.rb
+- examples/lrn-sdk-rails/test/fixtures/.keep
+- examples/lrn-sdk-rails/test/fixtures/files/.keep
+- examples/lrn-sdk-rails/test/helpers/.keep
+- examples/lrn-sdk-rails/test/integration/.keep
+- examples/lrn-sdk-rails/test/mailers/.keep
+- examples/lrn-sdk-rails/test/models/.keep
+- examples/lrn-sdk-rails/test/test_helper.rb
+- examples/lrn-sdk-rails/tmp/.keep
+- examples/lrn-sdk-rails/vendor/assets/javascripts/.keep
+- examples/lrn-sdk-rails/vendor/assets/stylesheets/.keep
+- examples/simple/init_data.rb
+- examples/simple/init_items.rb
+- learnosity-sdk.gemspec
+- lib/learnosity/sdk.rb
+- lib/learnosity/sdk/exceptions.rb
+- lib/learnosity/sdk/request.rb
+- lib/learnosity/sdk/request/init.rb
+- lib/learnosity/sdk/utils.rb
+- lib/learnosity/sdk/version.rb
+homepage: https://github.com/Learnosity/learnosity-sdk-ruby/
+licenses:
+- Apache-2.0
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+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.6.11
+signing_key: 
+specification_version: 4
+summary: SDK to interact with Learnosity APIs
+test_files: []