RubyGems - learnosity-sdk - Versions diffs - 0.2.1 → 0.2.2 - Mend

learnosity-sdk 0.2.1 → 0.2.2

Files changed (118) hide show

data/docs/quickstart/lrn-sdk-rails/app/controllers/questions_controller.rb ADDED Viewed

@@ -0,0 +1,44 @@
+require 'learnosity/sdk/request/init' # Learnosity helper.
+require 'securerandom'
+class QuestionsController < ApplicationController
+@@security_packet = {
+    # XXX: This is a Learnosity Demos consumer; replace it with your own consumer key. Set values in application.rb.
+    'consumer_key'   => Rails.configuration.consumer_key,
+    'domain'         => 'localhost',
+    'user_id'        => SecureRandom.uuid
+  }
+  # XXX: The consumer secret should be in a properly secured credential store, and *NEVER* checked into version control
+  @@consumer_secret = Rails.configuration.consumer_secret
+  @@questions_request = {
+                        "id"=> "f0001",
+                        "name"=> "Intro Activity - French 101",
+                        "questions"=>[
+                             {
+                                 "response_id"=> "60005",
+                                 "type"=> "association",
+                                 "stimulus"=> "Match the cities to the parent nation.",
+                                 "stimulus_list"=>["London", "Dublin", "Paris", "Sydney"],
+                                 "possible_responses"=>["Australia", "France", "Ireland", "England"
+                                 ],
+                                 "validation"=> {
+                                    "valid_responses"=> [
+                                        ["England"],["Ireland"],["France"],["Australia"]
+                                    ]
+                                },
+                                "instant_feedback" => true
+                            }
+                        ],
+                    }
+  def index
+    @init = Learnosity::Sdk::Request::Init.new(
+      'questions',
+      @@security_packet,
+      @@consumer_secret,
+      @@questions_request
+    )
+  end
+end

data/docs/quickstart/lrn-sdk-rails/app/controllers/reports_controller.rb ADDED Viewed

@@ -0,0 +1,32 @@
+require 'learnosity/sdk/request/init' # Learnosity helper.
+require 'securerandom'
+class ReportsController < ApplicationController
+@@security_packet = {
+    # XXX: This is a Learnosity Demos consumer; replace it with your own consumer key. Set values in application.rb.
+    'consumer_key'   => Rails.configuration.consumer_key,
+    'domain'         => 'localhost',
+    'user_id'        => SecureRandom.uuid
+  }
+  # XXX: The consumer secret should be in a properly secured credential store, and *NEVER* checked into version control
+  @@consumer_secret = Rails.configuration.consumer_secret
+  @@reports_request = {
+                          "reports" => [{
+                              "id"=> "session-detail",
+                              "type"=> "session-detail-by-item",
+                              "user_id"=> "906d564c-39d4-44ba-8ddc-2d44066e2ba9",
+                              "session_id"=> "906d564c-39d4-44ba-8ddc-2d44066e2ba9"
+                          }]
+                      }
+  def index
+    @init = Learnosity::Sdk::Request::Init.new(
+      'reports',
+      @@security_packet,
+      @@consumer_secret,
+      @@reports_request
+    )
+  end
+end

data/docs/quickstart/lrn-sdk-rails/app/views/author/index.html.erb ADDED Viewed

@@ -0,0 +1,14 @@
+<h1>Standalone Author Example</h1>
+<div id="learnosity-author"></div>
+<script src="https://authorapi.learnosity.com?latest-lts"></script>
+<script>
+   var callbacks = {
+       readyListener: function () {
+           console.log("Author API has successfully initialized.");
+        },
+        errorListener: function (err) {
+            console.log(err);
+        }
+    };
+    var authorApp = LearnosityAuthor.init( <%= raw @init.generate %>);
+</script>

data/docs/quickstart/lrn-sdk-rails/app/views/index/index.html.erb ADDED Viewed

@@ -0,0 +1,34 @@
+<html>
+     <head>
+         <style>
+            .tb { border-collapse: collapse; }
+            .tb th, .tb td { padding: 5px; border: solid 1px #777; text-align: center;}
+            .tb th { background-color: lightblue; }
+        </style>
+    </head>
+    <body>
+        <h1>Standalone Example APIs</title></h1>
+        <table class="tb" style="width:300px;">
+            <tr>
+                <th>APIs</th>
+                <th>Links</th>
+            </tr>
+            <tr>
+                <td>Author API</td>
+                <td><%=link_to("Here", author_index_path, target: '_blank') %> </td>
+            </tr>
+            <tr>
+                <td>Questions API</td>
+                <td><%=link_to("Here", questions_index_path, target: '_blank') %></td>
+            </tr>
+            <tr>
+                <td>Items API</td>
+                <td><%=link_to("Here", items_index_path, target: '_blank') %></td>
+            </tr>
+            <tr>
+                <td>Reports API</td>
+                <td><%=link_to("Here", reports_index_path, target: '_blank') %></td>
+            </tr>
+        </table>
+    </body>
+</html>

data/{examples/lrn-sdk-rails/app/views/index → docs/quickstart/lrn-sdk-rails/app/views/items}/index.html.erb RENAMED Viewed

@@ -1,8 +1,6 @@
-<h1>Index#index</h1>
+<h1>Standalone Assessment Example</h1>
 <div id="learnosity_assess"></div>
-<script src="//items.learnosity.com"></script>
+<script src="https://items.learnosity.com?latest-lts"></script>
 <script>
   var eventOptions = {
     readyListener: init
@@ -12,7 +10,6 @@
   function init () {
     var assessApp = itemsApp.assessApp();
     assessApp.on('item:load', function () {
       console.log('Active item:', getActiveItem(this.getItems()));
     });

data/docs/quickstart/lrn-sdk-rails/app/views/questions/index.html.erb ADDED Viewed

@@ -0,0 +1,6 @@
+<h1>Standalone Questions Example</h1>
+<span class="learnosity-response question-60005"></span>
+<script src="https://questions.learnosity.com/?latest-lts"></script>
+<script>
+var questionsApp = LearnosityApp.init(<%= raw @init.generate %>);
+</script>

data/docs/quickstart/lrn-sdk-rails/app/views/reports/index.html.erb ADDED Viewed

@@ -0,0 +1,14 @@
+<h1>Standalone Reports Example</h1>
+<span class="learnosity-report" id="session-detail"></span>
+<script src="https://reports.learnosity.com?latest-lts"></script>
+<script>
+var callbacks = {
+    readyListener: function () {
+        console.log("Learnosity Reports has successfully initialized.");
+    },
+    errorListener: function (err) {
+        console.log(err);
+    }
+};
+reportsApp = LearnosityReports.init( <%= raw @init.generate %>);
+</script>

data/docs/quickstart/lrn-sdk-rails/config/application.rb ADDED Viewed

@@ -0,0 +1,24 @@
+require_relative 'boot'
+require 'rails/all'
+# Require the gems listed in Gemfile, including any gems
+# you've limited to :test, :development, or :production.
+Bundler.require(*Rails.groups)
+module LrnSdkRails
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+    # The consumerKey and consumerSecret are the public & private
+    # security keys required to access Learnosity APIs and
+    # data. Learnosity will provide keys for your own private account.
+    # Note: The consumer secret should be in a properly secured credential store,
+    # and *NEVER* checked into version control.
+    # The keys listed here grant access to Learnosity's public demos account.
+    config.consumer_key = 'yis0TYCu7U9V4o7M'
+    config.consumer_secret = '74c5fd430cf1242a527f6223aebd42d30464be22'
+  end
+end

data/docs/quickstart/lrn-sdk-rails/config/routes.rb ADDED Viewed

@@ -0,0 +1,11 @@
+Rails.application.routes.draw do
+  root 'index#index'
+  get 'index/index'
+  get 'questions/index', as: 'questions_index'
+  get 'author/index' , as: 'author_index'
+  get 'reports/index', as: 'reports_index'
+  get 'items/index', as: 'items_index'
+#   get 'abc' , to: "index#index"
+  # For details on the DSL available within this file, see http://guides.rubyonrails.org/routing.html
+end

data/examples/simple/init_data.rb CHANGED Viewed

@@ -7,12 +7,14 @@ 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',
+    # XXX: This is a Learnosity Demos consumer; replace it with your own consumer key. Set values in application.rb.
+    'consumer_key'   => Rails.configuration.consumer_key,
 	'domain'         => 'localhost'
 }
-# XXX: The consumer secret should be in a properly secured credential store, and *NEVER* checked in in revision control
-consumer_secret = '74c5fd430cf1242a527f6223aebd42d30464be22'
+# XXX: The consumer secret should be in a properly secured credential store, and *NEVER* checked into version control.
+# Set values in application.rb.
+consumer_secret = Rails.configuration.consumer_secret
 data_request = { 'limit' => 1 }
 # Do 5 subsequent requests using the `next` pointer

data/examples/simple/init_items.rb CHANGED Viewed

@@ -2,12 +2,14 @@
 require 'learnosity/sdk/request/init'
 security_packet = {
-	# XXX: This is a Learnosity Demos consumer; replace it with your own consumer key
-	'consumer_key'   => 'yis0TYCu7U9V4o7M',
+    # XXX: This is a Learnosity Demos consumer; replace it with your own consumer key. Set values in application.rb.
+    'consumer_key'   => Rails.configuration.consumer_key,
 	'domain'         => 'localhost'
 }
-# XXX: The consumer secret should be in a properly secured credential store, and *NEVER* checked in in revision control
-consumer_secret = '74c5fd430cf1242a527f6223aebd42d30464be22'
+# XXX: The consumer secret should be in a properly secured credential store, and *NEVER* checked into version control.
+# Set values in application.rb.
+consumer_secret = Rails.configuration.consumer_secret
 items_request = { 'limit' => 50 }
 init = Learnosity::Sdk::Request::Init.new(

data/learnosity-sdk.gemspec CHANGED Viewed

@@ -4,37 +4,37 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'learnosity/sdk/version'
 Gem::Specification.new do |spec|
-  spec.name          = "learnosity-sdk"
+  spec.name          = 'learnosity-sdk'
   spec.version       = Learnosity::Sdk::VERSION
-  spec.authors       = [ "Olivier Mehani", "learnosity" ]
-  spec.email         = [ "olivier.mehani@learnosity.com", "licenses@learnosity.com" ]
+  spec.authors       = [ 'Olivier Mehani', 'learnosity' ]
+  spec.email         = [ 'olivier.mehani@learnosity.com', 'licenses@learnosity.com' ]
-  spec.summary       = "SDK to interact with Learnosity APIs"
-  spec.homepage      = "https://github.com/Learnosity/learnosity-sdk-ruby/"
+  spec.summary       = 'SDK to interact with Learnosity APIs'
+  spec.homepage      = 'https://github.com/Learnosity/learnosity-sdk-ruby/'
-  spec.license	     = "Apache-2.0"
+  spec.license	     = 'Apache-2.0'
   # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
   # to allow pushing to a single host or delete this section to allow pushing to any host.
   if spec.respond_to?(:metadata)
-    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
   else
-    raise "RubyGems 2.0 or newer is required to protect against " \
-      "public gem pushes."
+    raise 'RubyGems 2.0 or newer is required to protect against ' \
+      'public gem pushes.'
   end
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
   spec.add_runtime_dependency 'sys-uname', '>= 1.0'
-  spec.add_development_dependency 'bundler', '~> 2.0'
-  spec.add_development_dependency 'rake', '~> 13.0'
-  spec.add_development_dependency 'rspec', '~> 3.9'
+  spec.add_development_dependency 'bundler', '>= 2.2.10'
+  spec.add_development_dependency 'rake', '>= 12.3.3'
+  spec.add_development_dependency 'rspec', '>= 3.0'
 end
 # vim: sw=2

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

@@ -1,6 +1,6 @@
 require 'digest'
 require 'json'
+require 'openssl'
 require 'learnosity/sdk/exceptions'
 require 'learnosity/sdk/utils'
 require 'learnosity/sdk/version'
@@ -24,6 +24,8 @@ module Learnosity
         # Determines if telemetry is enabled
         @@telemetry_enabled = true
+        @@signaturePrefix = '$02$'
         def self.enable_telemetry
           @@telemetry_enabled = true
         end
@@ -60,8 +62,6 @@ module Learnosity
             end
           end
-          signature_array << @secret
           if @sign_request_data and ! @request_string.nil?
             signature_array << @request_string
           end
@@ -70,7 +70,7 @@ module Learnosity
             signature_array << @action
           end
-          hash_signature(signature_array)
+          hash_signature(signature_array, @secret)
         end
         def generate(encode = true)
@@ -255,7 +255,7 @@ module Learnosity
           when 'events'
             hashed_users = {}
             @request_packet['users'].each do |k, v|
-              hashed_users[k] =  hash_value(k + @secret)
+              hashed_users[k] =  hash_value(k , @secret)
             end
             @request_packet['users'] = hashed_users
           when 'author', 'data'
@@ -269,12 +269,13 @@ module Learnosity
           JSON.generate @request_packet unless request_packet.nil?
         end
-        def hash_value(value)
-          Digest::SHA256.hexdigest value
+        def hash_value(value, secret)
+          @@signaturePrefix + OpenSSL::HMAC.hexdigest("SHA256", secret, value)
         end
-        def hash_signature(signature_array)
-          hash_value(signature_array.join('_'))
+        def hash_signature(signature_array, secret)
+          hash_value(signature_array.join('_'), secret)
         end
       end

data/lib/learnosity/sdk/version.rb CHANGED Viewed

@@ -1,5 +1,5 @@
 module Learnosity
   module Sdk
-    VERSION = "0.2.1"
+    VERSION = "0.2.2"
   end
 end