Skip to content

User configurable gem for accessing learnosity's data API

License

Notifications You must be signed in to change notification settings

LYNx785/learnosity_utils

Repository files navigation

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

About

User configurable gem for accessing learnosity's data API

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published