learnosity-sdk 0.2.2 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e1b27ed22a689e2e1f36aa33f042acb3562919089628503575ad67a2b919c4a8
-  data.tar.gz: a35af7e9fa7b838322f7751efe2f942e9599a785fece6813e475bd9c9b4cac54
+  metadata.gz: 3f6ae3d63eaf2bc30203e980a98b7636cefb5e760a9decf38b6b2f41650b8158
+  data.tar.gz: 94bdb3fa2b8bad774f4b06709aa89aba682c02ea871d28b51e3b02568ad11981
 SHA512:
-  metadata.gz: a5ed2d8fc9dba2277ca2232b9d8d5fb30bd38cd2d6bd3b4fee732e09981f7df3f2fc3600a16b1324c4d5c49c5734b82fa2615fbe28faf7224b5373f8d11618a2
-  data.tar.gz: d3fbaa32870101f42837bc38d5fceeca2acaab7d3228e618de349b8ca9f4dbf79de8f15794cdc9c59dae8ad601a094662c02ea5d814a83d797a024b0feb61405
+  metadata.gz: 7d9de43a26ce21bf8dc476357ecf35149ad4145836e83458575451b47e86eb1e28417fe4a5709f018afc58b8cd569e70a235006e014deba40a9d9d49ec04ab7d
+  data.tar.gz: 60d57e9e7366fd2809b0c82029f1a3583918abbb45deb0c259165b23a8d9c7f244c8bfee873fb8f91d0c9de67be20c95090e877a9a0af3912dc7a1c7323f7acb

data/.travis.yml

@@ -2,10 +2,9 @@ sudo: false
 dist: focal
 language: ruby
 rvm:
-  - '2.6'
-  - '2.7'
   - '3.0'
   - '3.1'
+  - '3.2'
 before_install:
   # Login to docker hub
   - echo "$DOCKERHUB_PASSWORD" | docker login -u "$DOCKERHUB_USERNAME" --password-stdin

data/CONTRIBUTING.md

@@ -1,6 +1,18 @@
 # Contributing
 
-Contribution in the form of [Issues] and [PRs] are welcome.
+Contribution in the form of [PRs] are welcome.
+
+## Why We Are No Longer Accepting Public Issues
+After careful consideration, we’ve decided to discontinue accepting issues via GitHub Issues for our public repositories.
+
+Here’s why:
+
+- We have established support channels specifically designed to handle customer inquiries and issues.
+- These channels are staffed 24/7, and we work diligently to ensure prompt responses and high-quality support.
+- Maintaining and responding to GitHub Issues requires significant resources, and we are unable to provide the same level of support through this channel as we do through our dedicated support teams.
+- By focusing on our dedicated support channels, we can streamline our processes and offer a more effective and responsive service to our users.
+
+For any issues or support needs, please use the existing support channels. This will help us provide you with the best possible assistance in a timely manner.
 
 ## Testing
 

data/ChangeLog.md

@@ -7,6 +7,38 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [Unreleased]
 
+## [v0.4.0] - 2026-01-07
+
+### Added
+
+- UUID generation utility (`Learnosity::Sdk::Uuid.generate()`) for feature parity with Python and Node.js SDKs
+- Data API support with dedicated `DataApi` class
+  - `request()` method for single authenticated Data API requests
+  - `request_iter()` method for iterating through paginated responses
+  - `results_iter()` method for iterating through individual results across pages
+  - Automatic routing metadata headers: `X-Learnosity-Consumer`, `X-Learnosity-Action`, `X-Learnosity-SDK`
+  - HTTP timeout configurations (15s open timeout, 60s read timeout)
+- Data API demo added to Rails quickstart application
+- Comprehensive unit and integration tests for Data API functionality
+- Example usage in `examples/simple/data_api_example.rb`
+
+### Changed
+
+- Updated documentation and examples to use `Learnosity::Sdk::Uuid.generate` instead of `SecureRandom.uuid`
+- Improved error handling in Data API controller with detailed error messages and backtraces
+
+### Fixed
+
+- Ruby 2.6 compatibility in Rails quickstart (commented out `spring` gems that require Ruby 2.7+)
+- Rails 6.1 compatibility with Ruby 2.6 (added `require 'logger'` to `config/boot.rb`)
+- Bumped 3rd party libraries to fix known vulnerabilities in the quick start application
+- Fixed seed data for the api-reports example in the quick start application
+- Code quality improvements addressing Codacy findings
+
+## [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/README.md

@@ -98,6 +98,9 @@ For production use, you should install the SDK using the RubyGems package manage
 Let's take a look at a simple example of the SDK in action. In this example, we'll load an assessment into the browser.
 
 ### **Start up your web server and view the standalone assessment example**
+
+**Note:** The Rails quickstart supports Ruby 2.6+. The `spring` and `spring-watcher-listen` gems are commented out in the Gemfile for Ruby 2.6 compatibility. If you're using Ruby 2.7+, you can uncomment these gems for faster development reloading.
+
 To start up your Ruby web server, first find the following folder location under the SDK. Change directory ('cd') to this location on the command line.
 
 ``` bash
@@ -107,6 +110,7 @@ To start up your Ruby web server, first find the following folder location under
 To start, run this command from that folder:
 
 ``` bash
+    bundle install
     rails server
 ```
 
@@ -143,7 +147,7 @@ We start by including some LearnositySDK helpers in [items_controller.rb](docs/q
 
 ``` ruby
 require 'learnosity/sdk/request/init' # Learnosity helper.
-require 'securerandom'                # Library for generating UUIDs.
+require 'learnosity/sdk'               # For UUID generation utility.
 ```
 
 Now we'll declare the configuration options for Items API. The following options specify which assessment content should be rendered, how it should be displayed, which user is taking this assessment and how their responses should be stored. 
@@ -277,6 +281,9 @@ Take a look at some more in-depth options and tutorials on using Learnosity asse
 ### **SDK reference**
 See a more detailed breakdown of all the SDK features, and examples of how to use more advanced or specialised features on the [SDK reference page](REFERENCE.md).
 
+### **Data API support**
+The SDK now includes comprehensive Data API support with automatic request signing, routing metadata headers, and pagination support. See the [Data API documentation](docs/DataApi.md) for detailed usage examples and API reference.
+
 ### **Additional quick start guides**
 There are more quick start guides, going beyond the initial quick start topic of loading an assessment, these further tutorials show how to set up authoring and analytics:
 

data/REFERENCE.md

@@ -106,16 +106,67 @@ request = init.generate
 Net::HTTP.post_form URI('https://data.learnosity.com/v1/itembank/items'), request
 ```
 
-### Recursive Queries
+### DataApi Class (Recommended)
 
-tl;dr: not currently implemented
+The SDK now includes a dedicated `DataApi` class that provides a more convenient way to interact with the Data API, including automatic pagination support, routing metadata headers, and simplified request handling.
+
+```ruby
+require 'learnosity/sdk/request/data_api'
+
+# Initialize DataApi
+data_api = Learnosity::Sdk::Request::DataApi.new(
+  consumer_key: 'your_consumer_key',
+  consumer_secret: 'your_consumer_secret',
+  domain: 'yourdomain.com'
+)
+
+security_packet = {
+  'consumer_key' => 'your_consumer_key',
+  'domain' => 'yourdomain.com'
+}
+
+# Make a single request
+response = data_api.request(
+  'https://data.learnosity.com/v1/itembank/items',
+  security_packet,
+  'your_consumer_secret',
+  { 'limit' => 10 },
+  'get'
+)
+
+# Iterate through all pages automatically
+data_api.request_iter(
+  'https://data.learnosity.com/v1/itembank/items',
+  security_packet,
+  'your_consumer_secret',
+  { 'limit' => 100 },
+  'get'
+).each do |page|
+  puts "Page has #{page['data'].length} items"
+end
+
+# Iterate through individual results
+data_api.results_iter(
+  'https://data.learnosity.com/v1/itembank/items',
+  security_packet,
+  'your_consumer_secret',
+  { 'limit' => 100 },
+  'get'
+).each do |item|
+  puts "Item: #{item['reference']}"
+end
+```
+
+See the [Data API documentation](docs/DataApi.md) for more details and examples.
+
+### Recursive Queries (Legacy Approach)
 
 Some requests are paginated to the `limit` passed in the request, or some
 server-side default. Responses to those requests contain a `next` parameter in
 their `meta` property, which can be placed in the next request to access another
 page of data.
 
-For the time being, you can iterate through pages by looping over the
+You can iterate through pages by looping over the
 `Init#new`/`Init#generate`/`Net::HTTP#post_form`, updating the `next` attribute
 in the request.
 
@@ -129,12 +180,21 @@ end
 
 This will `require 'json'` to be able to parse the response.
 
+**Note:** The new `DataApi` class (see above) handles pagination automatically and is the recommended approach.
+
 See `examples/simple/init_data.rb` for an example.
 
 ### Generating UUIDs
 
-You will need to generate UUIDs. You can use the Ruby `securerandom`
-module for this purpose.
+You will need to generate UUIDs for user IDs and session IDs. The SDK provides a convenient utility for this purpose.
+
+```ruby
+require 'learnosity/sdk'
+
+p Learnosity::Sdk::Uuid.generate
+```
+
+Alternatively, you can use the Ruby `securerandom` module directly:
 
 ```ruby
 require 'securerandom'

data/docs/quickstart/lrn-sdk-rails/Gemfile

@@ -5,30 +5,29 @@ git_source(:github) do |repo_name|
   "https://github.com/#{repo_name}.git"
 end
 
-
 # Bundle edge Rails instead: gem 'rails', github: 'rails/rails'
-gem 'rails', '~> 5.0.2'
+gem 'rails', '~> 6.1.0'
 # Use sqlite3 as the database for Active Record
-gem 'sqlite3', '~> 1.3.6'
+gem 'sqlite3', '~> 1.6.3'
 # Use Puma as the app server
-gem 'puma', '~> 4.3.8'
+gem 'puma', '~> 6.4.0'
 # Use SCSS for stylesheets
-gem 'sass-rails', '~> 5.0'
+gem 'sass-rails', '~> 5.1.0'
 # Use Uglifier as compressor for JavaScript assets
-gem 'uglifier', '>= 1.3.0'
+gem 'uglifier', '>= 4.2.0'
 # Use CoffeeScript for .coffee assets and views
-gem 'coffee-rails', '~> 4.2'
+gem 'coffee-rails', '~> 5.0'
 # See https://github.com/rails/execjs#readme for more supported runtimes
-# gem 'therubyracer', platforms: :ruby
+# gem 'mini_racer', platforms: :ruby
 
 # Use jquery as the JavaScript library
 gem 'jquery-rails'
 # Turbolinks makes navigating your web application faster. Read more: https://github.com/turbolinks/turbolinks
 gem 'turbolinks', '~> 5'
 # Build JSON APIs with ease. Read more: https://github.com/rails/jbuilder
-gem 'jbuilder', '~> 2.5'
+gem 'jbuilder', '~> 2.11'
 # Use Redis adapter to run Action Cable in production
-# gem 'redis', '~> 3.0'
+# gem 'redis', '~> 4.0'
 # Use ActiveModel has_secure_password
 # gem 'bcrypt', '~> 3.1.7'
 
@@ -42,11 +41,13 @@ end
 
 group :development do
   # Access an IRB console on exception pages or by using <%= console %> anywhere in the code.
-  gem 'web-console', '>= 3.3.0'
-  gem 'listen', '~> 3.0.5'
+  gem 'web-console', '>= 4.2.0'
+  gem 'listen', '~> 3.8'
   # Spring speeds up development by keeping your application running in the background. Read more: https://github.com/rails/spring
-  gem 'spring'
-  gem 'spring-watcher-listen', '~> 2.0.0'
+  # Note: spring-watcher-listen requires Ruby >= 2.7.0, so it's commented out for Ruby 2.6 compatibility
+  # If you're using Ruby 2.7+, you can uncomment these lines for faster development reloading:
+  # gem 'spring'
+  # gem 'spring-watcher-listen', '~> 2.1.0'
 end
 
 # Windows does not include zoneinfo files, so bundle the tzinfo-data gem

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

@@ -1,5 +1,5 @@
 require 'learnosity/sdk/request/init' # Learnosity helper.
-require 'securerandom'
+require 'learnosity/sdk'               # For UUID generation utility.
 
 class AuthorController < ApplicationController
 
@@ -7,7 +7,7 @@ class AuthorController < ApplicationController
     # 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
+    'user_id'        => Learnosity::Sdk::Uuid.generate
   }
 
   # XXX: The consumer secret should be in a properly secured credential store, and *NEVER* checked into version control

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/controllers/data_api_controller.rb

@@ -0,0 +1,156 @@
+require 'learnosity/sdk/request/data_api'
+require 'json'
+
+class DataApiController < ApplicationController
+  # rubocop:disable Metrics/CyclomaticComplexity
+  # Note: This is a demo/quickstart controller that intentionally demonstrates
+  # three different Data API usage patterns (manual iteration, page iteration,
+  # and results iteration) with comprehensive error handling for educational purposes.
+  def index
+    # Initialize DataApi
+    data_api = Learnosity::Sdk::Request::DataApi.new(
+      consumer_key: Rails.configuration.consumer_key,
+      consumer_secret: Rails.configuration.consumer_secret,
+      domain: 'localhost'
+    )
+
+    # Endpoint and security packet
+    itembank_uri = 'https://data.learnosity.com/latest-lts/itembank/items'
+    security_packet = {
+      'consumer_key' => Rails.configuration.consumer_key,
+      'domain' => 'localhost'
+    }
+
+    # Get SDK version
+    sdk_version = Learnosity::Sdk::VERSION
+
+    # Initialize request metadata
+    @request_metadata = {
+      endpoint: itembank_uri,
+      action: 'get',
+      status_code: nil,
+      headers: {
+        'X-Learnosity-Consumer' => data_api.extract_consumer(security_packet),
+        'X-Learnosity-Action' => data_api.derive_action(itembank_uri, 'get'),
+        'X-Learnosity-SDK' => "Ruby:#{sdk_version}"
+      }
+    }
+
+    # Demo 1: Manual iteration (5 items)
+    @demo1_output = []
+    @demo1_error = nil
+
+    begin
+      data_request = { 'limit' => 1 }
+
+      5.times do |i|
+        result = data_api.request(
+          itembank_uri,
+          security_packet,
+          Rails.configuration.consumer_secret,
+          data_request,
+          'get'
+        )
+
+        # Capture status code from the first request
+        @request_metadata[:status_code] = result.code if i == 0
+
+        response = JSON.parse(result.body) rescue { 'raw_body' => result.body }
+
+        if response['data'] && response['data'].length > 0
+          item = response['data'][0]
+          @demo1_output << {
+            number: i + 1,
+            reference: item['reference'] || 'N/A',
+            status: item['status'] || 'N/A'
+          }
+        end
+
+        if response['meta'] && response['meta']['next']
+          data_request = { 'next' => response['meta']['next'] }
+        else
+          break
+        end
+      end
+    rescue => e
+      @demo1_error = {
+        error: "#{e.class}: #{e.message}",
+        backtrace: e.backtrace&.first(5)
+      }
+    end
+
+    # Demo 2: Page iteration (5 pages)
+    @demo2_output = []
+    @demo2_error = nil
+
+    begin
+      data_request = { 'limit' => 1 }
+      page_count = 0
+
+      data_api.request_iter(
+        itembank_uri,
+        security_packet,
+        Rails.configuration.consumer_secret,
+        data_request,
+        'get'
+      ).each do |page|
+        page_count += 1
+        page_data = {
+          page_number: page_count,
+          item_count: page['data'] ? page['data'].length : 0,
+          items: []
+        }
+
+        if page['data']
+          page['data'].each do |item|
+            page_data[:items] << {
+              reference: item['reference'] || 'N/A',
+              status: item['status'] || 'N/A'
+            }
+          end
+        end
+
+        @demo2_output << page_data
+        break if page_count >= 5
+      end
+    rescue => e
+      @demo2_error = {
+        error: "#{e.class}: #{e.message}",
+        backtrace: e.backtrace&.first(5)
+      }
+    end
+
+    # Demo 3: Results iteration (5 items)
+    @demo3_output = []
+    @demo3_error = nil
+
+    begin
+      data_request = { 'limit' => 1 }
+      result_count = 0
+
+      data_api.results_iter(
+        itembank_uri,
+        security_packet,
+        Rails.configuration.consumer_secret,
+        data_request,
+        'get'
+      ).each do |item|
+        result_count += 1
+        @demo3_output << {
+          number: result_count,
+          reference: item['reference'] || 'N/A',
+          status: item['status'] || 'N/A',
+          json: JSON.pretty_generate(item)[0..500]
+        }
+        break if result_count >= 5
+      end
+    rescue => e
+      @demo3_error = {
+        error: "#{e.class}: #{e.message}",
+        backtrace: e.backtrace&.first(5)
+      }
+    end
+  end
+  # rubocop:enable Metrics/CyclomaticComplexity
+end
+

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

@@ -1,5 +1,5 @@
 require 'learnosity/sdk/request/init' # Learnosity helper.
-require 'securerandom'                # Library for generating UUIDs.
+require 'learnosity/sdk'               # For UUID generation utility.
 
 class IndexController < ApplicationController
 

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

@@ -1,5 +1,5 @@
 require 'learnosity/sdk/request/init' # Learnosity helper.
-require 'securerandom'                # Library for generating UUIDs.
+require 'learnosity/sdk'               # For UUID generation utility.
 
 class ItemsController < ApplicationController
   @@security_packet = {
@@ -12,9 +12,9 @@ class ItemsController < ApplicationController
   @@consumer_secret = Rails.configuration.consumer_secret
 
   @@items_request = {
-    "user_id" => SecureRandom.uuid,
+    "user_id" => Learnosity::Sdk::Uuid.generate,
     "activity_template_id" => "quickstart_examples_activity_template_001",
-    "session_id" => SecureRandom.uuid,
+    "session_id" => Learnosity::Sdk::Uuid.generate,
     "activity_id" => "quickstart_examples_activity_001",
     "rendering_type" => "assess",
     "type" => "submit_practice",

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

@@ -1,5 +1,5 @@
 require 'learnosity/sdk/request/init' # Learnosity helper.
-require 'securerandom'
+require 'learnosity/sdk'               # For UUID generation utility.
 
 class QuestionsController < ApplicationController
 
@@ -7,7 +7,7 @@ class QuestionsController < ApplicationController
     # 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
+    'user_id'        => Learnosity::Sdk::Uuid.generate
   }
 
   # XXX: The consumer secret should be in a properly secured credential store, and *NEVER* checked into version control

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

@@ -1,5 +1,5 @@
 require 'learnosity/sdk/request/init' # Learnosity helper.
-require 'securerandom'
+require 'learnosity/sdk'               # For UUID generation utility.
 
 class ReportsController < ApplicationController
 
@@ -7,7 +7,7 @@ class ReportsController < ApplicationController
     # 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
+    'user_id'        => Learnosity::Sdk::Uuid.generate
   }
 
   # XXX: The consumer secret should be in a properly secured credential store, and *NEVER* checked into version control
@@ -17,8 +17,8 @@ class ReportsController < ApplicationController
                           "reports" => [{
                               "id"=> "session-detail",
                               "type"=> "session-detail-by-item",
-                              "user_id"=> "906d564c-39d4-44ba-8ddc-2d44066e2ba9",
-                              "session_id"=> "906d564c-39d4-44ba-8ddc-2d44066e2ba9"
+                              "user_id"=> "student_0001",
+                              "session_id"=> "ef4f80b8-e281-41f4-9efd-349b7eb9dd37"
                           }]
                       }
   def index

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>