learnosity-sdk 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e1b27ed22a689e2e1f36aa33f042acb3562919089628503575ad67a2b919c4a8
-  data.tar.gz: a35af7e9fa7b838322f7751efe2f942e9599a785fece6813e475bd9c9b4cac54
+  metadata.gz: 6d90f14540c688f96421e9cf91925e65868d316ada287955fa74083f0798db05
+  data.tar.gz: c5a79a3bb3e1a2610c79210b65abbe0c83b5a25134cc5e60d9e6dedb98277953
 SHA512:
-  metadata.gz: a5ed2d8fc9dba2277ca2232b9d8d5fb30bd38cd2d6bd3b4fee732e09981f7df3f2fc3600a16b1324c4d5c49c5734b82fa2615fbe28faf7224b5373f8d11618a2
-  data.tar.gz: d3fbaa32870101f42837bc38d5fceeca2acaab7d3228e618de349b8ca9f4dbf79de8f15794cdc9c59dae8ad601a094662c02ea5d814a83d797a024b0feb61405
+  metadata.gz: ffa6fa9e7c1b1e1b8ebe549eb1e7e0e9e7f192bea5b76a96bd03f50561796461f1a946bde865271b3a36ab45d3eefa0ba5387636222e8cfa8690569ad117b196
+  data.tar.gz: 36fd5d5a4787652eeae1916eac9d7b91a763ce2d543cb82dbd744577727cf7408a66057b805d5def84b26730dcadb96845943a181eab80fc202e8e82903403fc

data/ChangeLog.md

@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [Unreleased]
 
+## [v0.3.0] - 2024-07-12
+### Added
+- Add support for api-authoraide.
+
 ## [v0.2.2] - 2023-06-29
 ### Security
 - Upgraded signature to match the security standard.

data/docs/quickstart/lrn-sdk-rails/app/controllers/authoraide_controller.rb

@@ -0,0 +1,32 @@
+require 'learnosity/sdk/request/init' # Learnosity helper.
+require 'securerandom'
+
+class AuthoraideController < 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',
+  }
+
+  # XXX: The consumer secret should be in a properly secured credential store, and *NEVER* checked into version control
+  @@consumer_secret = Rails.configuration.consumer_secret
+
+  @@authoraide_request =  {
+          "user"=> {
+              "id" => "brianmoser",
+              "firstname" => "Test",
+              "lastname" => "Test",
+              "email" => "test@test.com"
+          }
+  }
+
+  def index
+    @init = Learnosity::Sdk::Request::Init.new(
+      'authoraide',
+      @@security_packet,
+      @@consumer_secret,
+      @@authoraide_request
+    )
+  end
+end

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

@@ -0,0 +1,6 @@
+<h1>Standalone Authoraide Example</h1>
+<div id="aiApp"></div>
+<script src="https://authoraide.learnosity.com"></script>
+<script>
+    var authoraideApp = LearnosityAuthorAide.init(<%= raw @init.generate %>, "#aiApp");
+</script>

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

@@ -29,6 +29,10 @@
                 <td>Reports API</td>
                 <td><%=link_to("Here", reports_index_path, target: '_blank') %></td>
             </tr>
+            <tr>
+                <td>Authoraide API</td>
+                <td><%=link_to("Here", authoraide_index_path, target: '_blank') %> </td>
+            </tr>
         </table>
     </body>
 </html>

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

@@ -3,6 +3,7 @@ Rails.application.routes.draw do
   get 'index/index'
   get 'questions/index', as: 'questions_index'
   get 'author/index' , as: 'author_index'
+  get 'authoraide/index' , as: 'authoraide_index'
   get 'reports/index', as: 'reports_index'
   get 'items/index', as: 'items_index'
 #   get 'abc' , to: "index#index"

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

@@ -19,7 +19,7 @@ module Learnosity
         @@valid_security_keys = ['consumer_key', 'domain', 'timestamp', 'expires', 'user_id'];
 
         # Service names that are valid for `$service`
-        @@valid_services = ['assess', 'author', 'data', 'events', 'items', 'questions', 'reports'];
+        @@valid_services = ['assess', 'author', 'data', 'events', 'items', 'questions', 'reports', 'authoraide'];
 
         # Determines if telemetry is enabled
         @@telemetry_enabled = true
@@ -77,7 +77,7 @@ module Learnosity
           output = {}
 
           case @service
-          when 'assess', 'author', 'data', 'items', 'reports'
+          when 'assess', 'author', 'data', 'items', 'reports', 'authoraide'
             output['security'] =  @security_packet
 
             unless @request_packet.nil?
@@ -258,7 +258,7 @@ module Learnosity
               hashed_users[k] =  hash_value(k , @secret)
             end
             @request_packet['users'] = hashed_users
-          when 'author', 'data'
+          when 'author', 'data', 'authoraide'
             @sign_request_data = true
           else
             raise Exception, "set_service_options() for #{@service} not implemented"

data/lib/learnosity/sdk/version.rb

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

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: learnosity-sdk
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Olivier Mehani
 - learnosity
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-07-14 00:00:00.000000000 Z
+date: 2024-07-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sys-uname
@@ -67,7 +67,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
-description: 
+description:
 email:
 - olivier.mehani@learnosity.com
 - licenses@learnosity.com
@@ -114,6 +114,7 @@ files:
 - docs/quickstart/lrn-sdk-rails/app/channels/application_cable/connection.rb
 - docs/quickstart/lrn-sdk-rails/app/controllers/application_controller.rb
 - docs/quickstart/lrn-sdk-rails/app/controllers/author_controller.rb
+- docs/quickstart/lrn-sdk-rails/app/controllers/authoraide_controller.rb
 - docs/quickstart/lrn-sdk-rails/app/controllers/concerns/.keep
 - docs/quickstart/lrn-sdk-rails/app/controllers/index_controller.rb
 - docs/quickstart/lrn-sdk-rails/app/controllers/items_controller.rb
@@ -126,6 +127,7 @@ files:
 - docs/quickstart/lrn-sdk-rails/app/models/application_record.rb
 - docs/quickstart/lrn-sdk-rails/app/models/concerns/.keep
 - docs/quickstart/lrn-sdk-rails/app/views/author/index.html.erb
+- docs/quickstart/lrn-sdk-rails/app/views/authoraide/index.html.erb
 - docs/quickstart/lrn-sdk-rails/app/views/index/index.html.erb
 - docs/quickstart/lrn-sdk-rails/app/views/items/index.html.erb
 - docs/quickstart/lrn-sdk-rails/app/views/layouts/application.html.erb
@@ -200,7 +202,7 @@ licenses:
 - Apache-2.0
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -215,8 +217,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3.1
-signing_key: 
+rubygems_version: 3.3.27
+signing_key:
 specification_version: 4
 summary: SDK to interact with Learnosity APIs
 test_files: []