Openstud

Build Status License: GPL v3

Maintainability Test Coverage Yard Docs

A Ruby gem for Openstud.

Installation

Add this line to your application's Gemfile:

gem 'openstud-rb'

And then execute:

$ bundle

Or install it yourself as:

$ gem install openstud-rb

Usage

os = Openstud::Base.new student_id: id, password: pwd

os.

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.

Functionalities

Authentication

  • [x] Login
  • [ ] Security question and password recovery
  • [ ] Passsword reset

Profile

  • [x] Student infos
  • [ ] Certificates
  • [ ] Photo and student card

Classroom

  • [ ] Classroom and timetable

Exams

  • [ ] Doable and done exams
  • [ ] Active and available reservations
  • [ ] Insert and delete reservations
  • [ ] Pdf reservation
  • [ ] Calendar events
  • [ ] Course surveys (OPIS)

Taxes

  • [ ] Paid and unpaid taxes
  • [ ] Current ISEE and ISEE history

News

  • [ ] News and newsletter events

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/lrusso96/openstud-rb.

Take a look at the Java project too.

License

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