This is a simple Ruby API wrapper for Clever.
Add this line to your application's Gemfile:
And then execute:
Or install it yourself as:
$ gem install clever
The gem can be initialized as follows:
client = Clever::Client.configure do |config| config.app_id = 'app_id for district' config.vendor_key = 'vendor_key for tci' config.vendor_secret = 'vendor_secret for tci' end
This gem support requesting:
- Request all students:
- Request a subset of students, filtered by their
client.students([student_1['data']['id']], student_2['data']['id'], …])
- Request all teachers:
- Request a subset of teachers, filtered by their
client.teachers([teacher_1['data']['id']], teacher_2['data']['id'], …])
- Request all courses:
- Request a subset of courses, filtered by their
client.courses([course_1['data']['id']], course_2['data']['id'], …])
- Request all sections:
- Request a subset of sections, filtered by their
client.sections([section_1['data']['id']], section_2['data']['id'], …])
- Request all classrooms
- Request all enrollments
- Request a subset of enrollments, filtered by their classroom's
client.enrollments([classroom_1['data']['id'], classroom_2['data']['id']], …)
After checking out the repo, run
bin/setup to install dependencies. Then, run
rake spec 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 tags, and push the
.gem file to rubygems.org.
Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/clever.
The gem is available as open source under the terms of the MIT License.