Project

magister

0.0
The project is in a healthy, maintained state
An unofficial Magister API wrapper for ruby
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Runtime

~> 0.2.0
~> 2.7, >= 2.7.1
~> 0.3.1
 Project Readme

rubymag

License: MPL 2.0

ko-fi

Ruby Gem Gem Version

A pretty generic wrapper for the magister, specifically magister 6, api.

Basic usage

You can simply create a new instance of the magister class.

require 'magister'

magister = Magister.new

Then you can log the user with their school, username, and password.

magister.login("someSchool", "123456", "p@s5W0rd!")

Since version 1.2.1 profile verifiying all happens automagically!

Then the user is logged in and you can get the user data!

puts "Welcome #{magister.profile.person.firstName} #{magister.profile.person.lastName}!"
puts "You have succesfully logged in to #{magister.profile.school}."

For more in depth documentation, see the docs

Example

This is the output from this very simple code

Personal details are blanked out in this image.

The output just as you'd expect, populated with actual data