Skip to content

Latest commit

 

History

History
58 lines (38 loc) · 1.56 KB

README.md

File metadata and controls

58 lines (38 loc) · 1.56 KB
Raw

LearnosityUtils

LearnosityUtils wraps the learnosity-sdk gem, adding easy user configuration, and preset method generation for commonly used Learnosity Data Api itembank endpoints

Installation

Add this line to your application's Gemfile:

gem 'learnosity_utils'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install learnosity_utils

Usage

After installation you'll need configure the gem with your personal Learnosity provided credentials

LearnosityUtils.configure do |config|
  config.consumer_secret = '74c5fd430cf1242a527f6223aebd42d30464be22'
  config.security_packet = {
    'consumer_key' => 'yis0TYCu7U9V4o7M',
    'domain' => 'localhost'
  }
end

Note: The example contains demo credentials exposed by Learnosity's data-api demo site

The itembank endpoints currently accessible as getters and setters are:

  • items
  • items_tags
  • questions
  • features
  • activities

When performing a get request, the only parameter necessary is an array of reference IDs

references = ['1234567890']

LearnosityUtils::EndPoint::ItemBank.send(:get_items, references)

Code of Conduct

Everyone interacting in this codebase and issue tracker is expected to follow the code of conduct

License

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