ScormEngine

A ruby client for Rustici’s SCORM Engine 2017.1 API and limited support for the Engine 20.1 API v2.

• rustici-docs.s3.amazonaws.com/engine/2017.1.x/index.html

• rustici-docs.s3.amazonaws.com/engine/20.1.x/api/apiV2.html

• support.scorm.com/hc/en-us/sections/115000043974-Release-Notes

• rustici-docs.s3.amazonaws.com/engine/2017.1.x/api.html

• rustici-docs.s3.amazonaws.com/engine/2017.1.x.dispatch/api-dispatch.html

• rustici-docs.s3.amazonaws.com/engine/2017.1.x/Configuration/GeneratedConfigurationSettings.html

Installation

From GitHub Packages (Recommended)

Remote packages: New versions are automatically published to GitHub Packages when a git tag matching v*.. (e.g., v0.10.0) is pushed to the repository.

Local packages: First, configure your Bundler to authenticate with GitHub Packages:

# Replace YOUR_GITHUB_USERNAME and YOUR_GITHUB_TOKEN with your actual values
bundle config https://rubygems.pkg.github.com/get-bridge YOUR_GITHUB_USERNAME:YOUR_GITHUB_TOKEN

You’ll need a GitHub Personal Access Token with read:packages scope. Create one at: github.com/settings/tokens

Then add this line to your application’s Gemfile:

source "https://rubygems.pkg.github.com/get-bridge" do
  gem 'scorm_engine'
end

From RubyGems (Legacy)

Add this line to your application’s Gemfile:

gem 'scorm_engine'

And then execute:

$ bundle

Or install it yourself as:

$ gem install scorm_engine

Usage #TODO

Testing

All in one testing for rubocop, rspec, and yard doc generation with the default rake task:

bin/rake

To test running these specs against an actual SCORM server, create a .env.test.local - cp .env.test .env.test.local - Update the values in .env.test.local with the values you want overridden.

Contributing

Bug reports and pull requests are welcome on GitHub at github.com/get-bridge/scorm_engine.

License

The gem is available as open source under the terms of the MIT License.