School21 API SDK

[!NOTE] Development is still in progress, implementation may change in future versions.

[!WARNING] Do not store your login and password as raw string values, use environment variables instead! Currently platform provides only one way to authorize API calls with login:password pair you're using for the school everyday tasks. As soon as other types of authorization will be added (such as using API token), they'll be implemented for this gem as well.

Installation

Install the gem and add to the application's Gemfile by executing:

bundle add school21_api_sdk

If bundler is not being used to manage dependencies, install the gem by executing:

gem install school21_api_sdk

Setup

Please check docs for more information.

• Rails:

rails generate school21:install

• Manual:

require 'school21'

login = 'your_login_here'
password = 'your_password_here'

School21.configure do |config|
  config.credentials = { login: login, password: password }

  # If you want to log client's requests and responses (turned off by default)
  config.enable_logging = true
end

Usage

• Select the domain specific API that you want to use. This API has all endpoints related to that domain. Here's an example of Participant API and a call to /participants/:login

participants_api = School21.participants_api
response = participants_api.participant('peer_nickname')

if response.success?
  puts response.data
else
  # Error handling
end

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake test to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and the created tag, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/ikael21/school21_api_sdk.