learnosity-sdk 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6d90f14540c688f96421e9cf91925e65868d316ada287955fa74083f0798db05
-  data.tar.gz: c5a79a3bb3e1a2610c79210b65abbe0c83b5a25134cc5e60d9e6dedb98277953
+  metadata.gz: 3f6ae3d63eaf2bc30203e980a98b7636cefb5e760a9decf38b6b2f41650b8158
+  data.tar.gz: 94bdb3fa2b8bad774f4b06709aa89aba682c02ea871d28b51e3b02568ad11981
 SHA512:
-  metadata.gz: ffa6fa9e7c1b1e1b8ebe549eb1e7e0e9e7f192bea5b76a96bd03f50561796461f1a946bde865271b3a36ab45d3eefa0ba5387636222e8cfa8690569ad117b196
-  data.tar.gz: 36fd5d5a4787652eeae1916eac9d7b91a763ce2d543cb82dbd744577727cf7408a66057b805d5def84b26730dcadb96845943a181eab80fc202e8e82903403fc
+  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,34 @@ 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.

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/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/data_api/index.html.erb

@@ -0,0 +1,277 @@
+<!DOCTYPE html>
+<html>
+<head>
+    <style>
+        body {
+            font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, "Helvetica Neue", Arial, sans-serif;
+            max-width: 1200px;
+            margin: 0 auto;
+            padding: 20px;
+            background: #f5f5f5;
+        }
+        h1 {
+            color: #333;
+            border-bottom: 3px solid #667eea;
+            padding-bottom: 10px;
+        }
+        .demo-section {
+            background: #f8f9fa;
+            border-left: 4px solid #667eea;
+            padding: 20px;
+            margin: 20px 0;
+            border-radius: 4px;
+        }
+        .demo-section h2 {
+            margin-top: 0;
+            color: #333;
+        }
+        .item {
+            background: white;
+            padding: 15px;
+            margin: 10px 0;
+            border-radius: 4px;
+            border: 1px solid #dee2e6;
+        }
+        .item-reference {
+            font-family: monospace;
+            color: #667eea;
+            font-weight: bold;
+            margin-bottom: 5px;
+        }
+        .item-status {
+            color: #666;
+            font-size: 14px;
+        }
+        .meta-info {
+            background: #e7f3ff;
+            padding: 10px;
+            margin: 10px 0;
+            border-radius: 4px;
+            border-left: 3px solid #0066cc;
+        }
+        .error {
+            background: #f8d7da;
+            color: #721c24;
+            padding: 15px;
+            border-radius: 4px;
+            border-left: 4px solid #f5c6cb;
+        }
+        pre {
+            background: #2d2d2d;
+            color: #f8f8f2;
+            padding: 15px;
+            border-radius: 4px;
+            overflow-x: auto;
+            font-size: 12px;
+        }
+        code {
+            background: #f4f4f4;
+            padding: 2px 6px;
+            border-radius: 3px;
+            font-family: monospace;
+        }
+        .note-box {
+            background: #d1ecf1;
+            border: 1px solid #bee5eb;
+            border-radius: 4px;
+            padding: 15px;
+            margin: 20px 0;
+            color: #0c5460;
+        }
+        .note-box strong {
+            display: block;
+            margin-bottom: 5px;
+        }
+        .api-responses {
+            margin: 20px 0;
+        }
+        .api-responses h2 {
+            color: #333;
+            margin-bottom: 15px;
+        }
+        .request-info {
+            background: #4a90e2;
+            color: white;
+            padding: 12px 20px;
+            border-radius: 4px 4px 0 0;
+            font-weight: bold;
+            margin-top: 20px;
+        }
+        .request-details {
+            background: white;
+            border: 1px solid #dee2e6;
+            border-top: none;
+        }
+        .request-row {
+            display: flex;
+            border-bottom: 1px solid #dee2e6;
+        }
+        .request-row:last-child {
+            border-bottom: none;
+        }
+        .request-label {
+            background: #f8f9fa;
+            padding: 12px 20px;
+            font-weight: bold;
+            width: 150px;
+            border-right: 1px solid #dee2e6;
+        }
+        .request-value {
+            padding: 12px 20px;
+            flex: 1;
+            font-family: monospace;
+            word-break: break-all;
+        }
+        .request-value.success {
+            color: #28a745;
+            font-weight: bold;
+        }
+        .request-value.url {
+            color: #e83e8c;
+        }
+        .request-value.action {
+            color: #e83e8c;
+        }
+        .metadata-headers {
+            background: #5cb85c;
+            color: white;
+            padding: 12px 20px;
+            border-radius: 4px 4px 0 0;
+            font-weight: bold;
+            margin-top: 20px;
+        }
+        .metadata-note {
+            background: white;
+            border: 1px solid #dee2e6;
+            border-top: none;
+            padding: 12px 20px;
+            color: #666;
+            font-size: 14px;
+        }
+        .header-row {
+            display: flex;
+            border-bottom: 1px solid #dee2e6;
+            background: white;
+        }
+        .header-row:last-child {
+            border-bottom: none;
+        }
+        .header-name {
+            background: #f8f9fa;
+            padding: 12px 20px;
+            font-weight: bold;
+            width: 250px;
+            border-right: 1px solid #dee2e6;
+            color: #e83e8c;
+        }
+        .header-value {
+            padding: 12px 20px;
+            flex: 1;
+            font-family: monospace;
+            word-break: break-all;
+        }
+    </style>
+</head>
+<body>
+    <h1>Data API Example - With Metadata Headers</h1>
+
+    <div class="note-box">
+        <strong>Note:</strong> This example demonstrates the Data API with automatic metadata headers. Every request includes consumer, action, and SDK language-version information.
+    </div>
+
+    <% if @request_metadata %>
+    <div class="api-responses">
+        <h2>API Responses</h2>
+
+        <div class="request-info">Request Information</div>
+        <div class="request-details">
+            <div class="request-row">
+                <div class="request-label">Endpoint</div>
+                <div class="request-value url"><%= @request_metadata[:endpoint] %></div>
+            </div>
+            <div class="request-row">
+                <div class="request-label">Action</div>
+                <div class="request-value action"><%= @request_metadata[:action] %></div>
+            </div>
+            <div class="request-row">
+                <div class="request-label">Status Code</div>
+                <div class="request-value success"><%= @request_metadata[:status_code] || 'N/A' %></div>
+            </div>
+        </div>
+
+        <div class="metadata-headers">Metadata Headers (Sent Automatically)</div>
+        <div class="metadata-note">
+            These headers are added automatically by the SDK and are invisible to customers:
+        </div>
+        <div class="request-details">
+            <div class="header-row">
+                <div class="header-name">X-Learnosity-Consumer</div>
+                <div class="header-value"><%= @request_metadata[:headers]['X-Learnosity-Consumer'] %></div>
+            </div>
+            <div class="header-row">
+                <div class="header-name">X-Learnosity-Action</div>
+                <div class="header-value"><%= @request_metadata[:headers]['X-Learnosity-Action'] %></div>
+            </div>
+            <div class="header-row">
+                <div class="header-name">X-Learnosity-SDK</div>
+                <div class="header-value"><%= @request_metadata[:headers]['X-Learnosity-SDK'] %></div>
+            </div>
+        </div>
+    </div>
+    <% end %>
+
+    <div class="demo-section">
+        <h2>Demo 1: Manual Iteration (5 items)</h2>
+        <p>Using <code>request()</code> method with manual pagination via the 'next' pointer.</p>
+        <% if @demo1_error %>
+            <div class="error">Error: <%= @demo1_error %></div>
+        <% else %>
+            <% @demo1_output.each do |item| %>
+                <div class="item">
+                    <div class="item-reference">Item <%= item[:number] %>: <%= item[:reference] %></div>
+                    <div class="item-status">Status: <%= item[:status] %></div>
+                </div>
+            <% end %>
+        <% end %>
+    </div>
+
+    <div class="demo-section">
+        <h2>Demo 2: Page Iteration (5 pages)</h2>
+        <p>Using <code>request_iter()</code> method to automatically iterate over pages.</p>
+        <% if @demo2_error %>
+            <div class="error">Error: <%= @demo2_error %></div>
+        <% else %>
+            <% @demo2_output.each do |page| %>
+                <div class="meta-info">
+                    Page <%= page[:page_number] %>: <%= page[:item_count] %> items
+                </div>
+                <% page[:items].each do |item| %>
+                    <div class="item">
+                        <div class="item-reference"><%= item[:reference] %></div>
+                        <div class="item-status">Status: <%= item[:status] %></div>
+                    </div>
+                <% end %>
+            <% end %>
+        <% end %>
+    </div>
+
+    <div class="demo-section">
+        <h2>Demo 3: Results Iteration (5 items)</h2>
+        <p>Using <code>results_iter()</code> method to automatically iterate over individual items.</p>
+        <% if @demo3_error %>
+            <div class="error">Error: <%= @demo3_error %></div>
+        <% else %>
+            <% @demo3_output.each do |item| %>
+                <div class="item">
+                    <div class="item-reference">Item <%= item[:number] %>: <%= h item[:reference] %></div>
+                    <div class="item-status">Status: <%= h item[:status] %></div>
+                    <pre><%= h item[:json] %>...</pre>
+                </div>
+            <% end %>
+        <% end %>
+    </div>
+
+    <p><a href="/">Back to API Examples</a></p>
+</body>
+</html>
+

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

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

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

@@ -1,3 +1,7 @@
 ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../Gemfile', __dir__)
 
 require 'bundler/setup' # Set up gems listed in the Gemfile.
+
+# Fix for Ruby 2.6 compatibility with Rails 6.1
+# Rails 6.1 expects Logger to be available before ActiveSupport loads
+require 'logger'

data/docs/quickstart/lrn-sdk-rails/config/initializers/new_framework_defaults.rb

@@ -18,7 +18,8 @@ ActiveSupport.to_time_preserves_timezone = true
 Rails.application.config.active_record.belongs_to_required_by_default = true
 
 # Do not halt callback chains when a callback returns false. Previous versions had true.
-ActiveSupport.halt_callback_chains_on_return_false = false
+# This option is not applicable for Rails 6.1 and has been removed.
+# ActiveSupport.halt_callback_chains_on_return_false = false
 
 # Configure SSL options to enable HSTS with subdomains. Previous versions had false.
 Rails.application.config.ssl_options = { hsts: { subdomains: true } }

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

@@ -6,6 +6,7 @@ Rails.application.routes.draw do
   get 'authoraide/index' , as: 'authoraide_index'
   get 'reports/index', as: 'reports_index'
   get 'items/index', as: 'items_index'
+  get 'data_api/index', as: 'data_api_index'
 #   get 'abc' , to: "index#index"
 
   # For details on the DSL available within this file, see http://guides.rubyonrails.org/routing.html

data/examples/simple/data_api_example.rb

@@ -0,0 +1,82 @@
+#!/usr/bin/env ruby
+require 'learnosity/sdk/request/data_api'
+
+# Configuration
+# XXX: This is a Learnosity Demos consumer; replace it with your own consumer key
+consumer_key = 'yis0TYCu7U9V4o7M'
+# XXX: The consumer secret should be in a properly secured credential store, and *NEVER* checked into version control
+consumer_secret = '74c5fd430cf1242a527f6223aebd42d30464be22'
+domain = 'localhost'
+
+# Initialize DataApi
+data_api = Learnosity::Sdk::DataApi.new(
+  consumer_key: consumer_key,
+  consumer_secret: consumer_secret,
+  domain: domain
+)
+
+# Security packet
+security_packet = {
+  'consumer_key' => consumer_key,
+  'domain' => domain
+}
+
+# Endpoint
+endpoint = 'https://data.learnosity.com/v1/itembank/items'
+
+puts "=== Example 1: Single Request ==="
+puts
+
+# Make a single request
+response = data_api.request(
+  endpoint,
+  security_packet,
+  consumer_secret,
+  { 'limit' => 5 },
+  'get'
+)
+
+puts "Status: #{response.code}"
+data = JSON.parse(response.body)
+puts "Records: #{data['meta']['records']}"
+puts "Items returned: #{data['data'].length}"
+puts
+
+puts "=== Example 2: Iterate Through Pages ==="
+puts
+
+# Iterate through pages (up to 3 pages)
+page_count = 0
+data_api.request_iter(
+  endpoint,
+  security_packet,
+  consumer_secret,
+  { 'limit' => 5 },
+  'get'
+).each do |page|
+  page_count += 1
+  puts "Page #{page_count}: #{page['data'].length} items"
+  break if page_count >= 3
+end
+puts
+
+puts "=== Example 3: Iterate Through Individual Results ==="
+puts
+
+# Iterate through individual results (up to 10 items)
+item_count = 0
+data_api.results_iter(
+  endpoint,
+  security_packet,
+  consumer_secret,
+  { 'limit' => 5 },
+  'get'
+).each do |item|
+  item_count += 1
+  puts "Item #{item_count}: #{item['reference'] || item['id'] || 'N/A'}"
+  break if item_count >= 10
+end
+puts
+
+puts "Done!"
+

data/examples/simple/uuid_example.rb

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+require 'bundler/setup'
+require 'learnosity/sdk'
+
+# Example: Generate UUIDs using the Learnosity SDK utility
+# This is commonly used for user_id and session_id in API requests
+
+puts "Generating UUIDs using Learnosity::Sdk::Uuid.generate:"
+puts
+
+# Generate a few UUIDs
+5.times do |i|
+  uuid = Learnosity::Sdk::Uuid.generate
+  puts "UUID #{i + 1}: #{uuid}"
+end
+
+puts
+puts "Example usage in API requests:"
+puts
+
+# Example: Using UUIDs in an Items API request
+user_id = Learnosity::Sdk::Uuid.generate
+session_id = Learnosity::Sdk::Uuid.generate
+
+puts "user_id: #{user_id}"
+puts "session_id: #{session_id}"
+
+# vim: sw=2
+

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

@@ -0,0 +1,196 @@
+require 'net/http'
+require 'uri'
+require 'json'
+require 'learnosity/sdk/request/init'
+require 'learnosity/sdk/version'
+
+module Learnosity
+  module Sdk
+    module Request
+      # DataApi - Routing layer for Learnosity Data API
+      #
+      # Provides methods to make HTTP requests to the Data API with automatic
+      # signing and pagination support.
+      class DataApi
+        attr_reader :consumer_key, :consumer_secret, :domain
+
+        # Initialize a new DataApi instance
+        #
+        # @param options [Hash] Configuration options
+        # @option options [String] :consumer_key Learnosity consumer key
+        # @option options [String] :consumer_secret Learnosity consumer secret
+        # @option options [String] :domain Domain for security packet
+        # @option options [Proc] :http_adapter Optional custom HTTP adapter
+        def initialize(options = {})
+          @consumer_key = options[:consumer_key]
+          @consumer_secret = options[:consumer_secret]
+          @domain = options[:domain]
+          @http_adapter = options[:http_adapter] || method(:default_http_adapter)
+        end
+
+        # Make a single request to Data API
+        #
+        # @param endpoint [String] Full URL to the Data API endpoint
+        # @param security_packet [Hash] Security object with consumer_key and domain
+        # @param secret [String] Consumer secret
+        # @param request_packet [Hash] Request parameters (default: {})
+        # @param action [String] Action type: 'get', 'set', 'update', 'delete' (default: 'get')
+        # @return [Net::HTTPResponse] HTTP response object
+        def request(endpoint, security_packet, secret, request_packet = {}, action = 'get')
+          # Generate signed request using SDK
+          init = Init.new('data', security_packet, secret, request_packet, action)
+          signed_request = init.generate
+
+          # Extract metadata for routing
+          consumer = extract_consumer(security_packet)
+          derived_action = derive_action(endpoint, action)
+
+          # Prepare headers with routing metadata
+          headers = {
+            'Content-Type' => 'application/x-www-form-urlencoded',
+            'X-Learnosity-Consumer' => consumer,
+            'X-Learnosity-Action' => derived_action,
+            'X-Learnosity-SDK' => "Ruby:#{Learnosity::Sdk::VERSION}"
+          }
+
+          # Make HTTP request using adapter
+          @http_adapter.call(endpoint, signed_request, headers)
+        end
+
+        # Iterate over pages of results from Data API
+        #
+        # @param endpoint [String] Full URL to the Data API endpoint
+        # @param security_packet [Hash] Security object
+        # @param secret [String] Consumer secret
+        # @param request_packet [Hash] Request parameters (default: {})
+        # @param action [String] Action type (default: 'get')
+        # @return [Enumerator] Enumerator yielding pages of results
+        def request_iter(endpoint, security_packet, secret, request_packet = {}, action = 'get')
+          Enumerator.new do |yielder|
+            # Deep copy to avoid mutation
+            security = deep_copy(security_packet)
+            request_params = deep_copy(request_packet)
+            data_end = false
+
+            until data_end
+              response = self.request(endpoint, security, secret, request_params, action)
+              validate_response(response)
+
+              data = parse_response_body(response)
+              validate_response_status(data)
+
+              data_end = !has_more_pages?(data)
+              request_params['next'] = data['meta']['next'] if data['meta'] && data['meta']['next']
+
+              yielder << data
+            end
+          end
+        end
+
+        # Iterate over individual results from Data API
+        #
+        # Automatically handles pagination and yields each individual result
+        # from the data array.
+        #
+        # @param endpoint [String] Full URL to the Data API endpoint
+        # @param security_packet [Hash] Security object
+        # @param secret [String] Consumer secret
+        # @param request_packet [Hash] Request parameters (default: {})
+        # @param action [String] Action type (default: 'get')
+        # @return [Enumerator] Enumerator yielding individual results
+        def results_iter(endpoint, security_packet, secret, request_packet = {}, action = 'get')
+          Enumerator.new do |yielder|
+            request_iter(endpoint, security_packet, secret, request_packet, action).each do |page|
+              if page['data'].is_a?(Hash)
+                # If data is a hash (not array), yield key-value pairs
+                page['data'].each do |key, value|
+                  yielder << { key => value }
+                end
+              elsif page['data'].is_a?(Array)
+                # If data is an array, yield each item
+                page['data'].each do |result|
+                  yielder << result
+                end
+              end
+            end
+          end
+        end
+
+        # Extract consumer key from security packet
+        def extract_consumer(security_packet)
+          security_packet['consumer_key'] || security_packet[:consumer_key] || ''
+        end
+
+        # Derive action metadata from endpoint and action
+        def derive_action(endpoint, action)
+          uri = URI.parse(endpoint)
+          path = uri.path.sub(/\/$/, '')
+
+          # Remove version prefix (e.g., /v1, /v2023.1.LTS, /latest)
+          path_parts = path.split('/')
+
+          if path_parts.length > 1
+            first_segment = path_parts[1].downcase
+            version_pattern = /^v[\d.]+(?:\.(lts|preview\d+))?$/
+            special_versions = ['latest', 'latest-lts', 'developer']
+
+            if version_pattern.match?(first_segment) || special_versions.include?(first_segment)
+              path = '/' + path_parts[2..-1].join('/')
+            end
+          end
+
+          "#{action}_#{path}"
+        end
+
+        private
+
+        # Default HTTP adapter using Net::HTTP
+        def default_http_adapter(endpoint, signed_request, headers)
+          uri = URI.parse(endpoint)
+          http = Net::HTTP.new(uri.host, uri.port)
+          http.use_ssl = (uri.scheme == 'https')
+          http.open_timeout = 15  # seconds to establish connection
+          http.read_timeout = 60  # seconds to read response
+
+          request = Net::HTTP::Post.new(uri.request_uri, headers)
+          request.set_form_data(signed_request)
+
+          http.request(request)
+        end
+
+        # Deep copy a hash to avoid mutation
+        # Using JSON serialization instead of Marshal for security
+        def deep_copy(obj)
+          JSON.parse(JSON.generate(obj))
+        end
+
+        # Validate HTTP response
+        def validate_response(response)
+          return if response.is_a?(Net::HTTPSuccess)
+          raise "Server returned HTTP status #{response.code}: #{response.body}"
+        end
+
+        # Parse response body as JSON
+        def parse_response_body(response)
+          JSON.parse(response.body)
+        rescue JSON::ParserError
+          raise "Server returned invalid JSON: #{response.body}"
+        end
+
+        # Validate response has successful status
+        def validate_response_status(data)
+          return if data.dig('meta', 'status') == true
+          raise "Server returned unsuccessful status: #{data.to_json}"
+        end
+
+        # Check if there are more pages to fetch
+        def has_more_pages?(data)
+          data['meta'] && data['meta']['next'] && data['data'] && !data['data'].empty?
+        end
+      end
+    end
+  end
+end
+
+# vim: sw=2
+

data/lib/learnosity/sdk/utils/uuid.rb

@@ -0,0 +1,21 @@
+require 'securerandom'
+
+module Learnosity
+  module Sdk
+    module Utils
+      # UUID utility for generating UUIDv4 identifiers
+      # Commonly used for user_id and session_id in Learnosity API requests
+      class Uuid
+        # Generate a UUIDv4 string
+        #
+        # @return [String] A UUIDv4 string
+        def self.generate
+          SecureRandom.uuid
+        end
+      end
+    end
+  end
+end
+
+# vim: sw=2
+

data/lib/learnosity/sdk/version.rb

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

data/lib/learnosity/sdk.rb

@@ -1,8 +1,14 @@
 require "learnosity/sdk/version"
+require "learnosity/sdk/request/data_api"
+require "learnosity/sdk/utils/uuid"
 
 module Learnosity
   module Sdk
-    # Your code goes here...
+    # Export DataApi class for convenient access
+    DataApi = Request::DataApi
+
+    # Export Uuid utility for convenient access
+    Uuid = Utils::Uuid
   end
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: learnosity-sdk
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Olivier Mehani
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-07-22 00:00:00.000000000 Z
+date: 2026-01-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sys-uname
@@ -116,6 +116,7 @@ files:
 - 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/data_api_controller.rb
 - docs/quickstart/lrn-sdk-rails/app/controllers/index_controller.rb
 - docs/quickstart/lrn-sdk-rails/app/controllers/items_controller.rb
 - docs/quickstart/lrn-sdk-rails/app/controllers/questions_controller.rb
@@ -128,6 +129,7 @@ files:
 - 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/data_api/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
@@ -188,14 +190,18 @@ files:
 - docs/quickstart/lrn-sdk-rails/tmp/.keep
 - docs/quickstart/lrn-sdk-rails/vendor/assets/javascripts/.keep
 - docs/quickstart/lrn-sdk-rails/vendor/assets/stylesheets/.keep
+- examples/simple/data_api_example.rb
 - examples/simple/init_data.rb
 - examples/simple/init_items.rb
+- examples/simple/uuid_example.rb
 - learnosity-sdk.gemspec
 - lib/learnosity/sdk.rb
 - lib/learnosity/sdk/exceptions.rb
 - lib/learnosity/sdk/request.rb
+- lib/learnosity/sdk/request/data_api.rb
 - lib/learnosity/sdk/request/init.rb
 - lib/learnosity/sdk/utils.rb
+- lib/learnosity/sdk/utils/uuid.rb
 - lib/learnosity/sdk/version.rb
 homepage: https://github.com/Learnosity/learnosity-sdk-ruby/
 licenses:
@@ -217,7 +223,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.27
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: SDK to interact with Learnosity APIs