Skip to content

ChangeLog.md

Latest commit

 

History

History
66 lines (46 loc) · 2.45 KB

ChangeLog.md

File metadata and controls

66 lines (46 loc) · 2.45 KB

Change Log

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog and this project adheres to Semantic Versioning.

[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.

Added

  • Improved Makefile and tests
  • PR template

Security

  • Updated vendor libraries to fix security issues

[v0.2.1] - 2019-01-08

Added

  • Updated version range of sys-uname to include versions 1.0 and above

[v0.2.0] - 2019-08-12

Added

  • This ChangeLog!
  • Telemetry data (basic information about the execution environment) is now added to the request objects being signed which is later read and logged internally by our APIs when the request is received. This allows us to better support our various SDKs and does not send any additional network requests. More information can be found in README.md.

[v0.1.0] - 2017-05-10

Initial Release