Fluminus [WIP]
Warning: this is still a work-in-progress.
F LumiNUS! IVLE ftw! Why fix what ain't broken?!
Since IVLE will be deprecated next academic year (AY2019/2020), while LumiNUS has consistently pushed back its schedule to release an API, I have decided to reverse-engineer the API used by the Angular front-end of LumiNUS. Currently, my goal is to be able to automatically download files a la ivle-sync
I try to keep to best coding practices and use as little dependencies as possible. Do let me know if you have any suggestions!
PR's are welcome.
Installation
Ignore all the parts below.
Add this line to your application's Gemfile:
gem 'fluminus'
And then execute:
$ bundle
Or install it yourself as:
$ gem install fluminus
Usage
Development
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.
Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/indocomsoft/fluminus. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.
License
The gem is available as open source under the terms of the MIT License.
Code of Conduct
Everyone interacting in the Fluminus project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.