magister 1.1.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: faf4f432a878e25770d0a9faf41d4d1691332a60ce70d0bf5d71087da14d080e
-  data.tar.gz: 7e8fdd7861269b393f96af946b4790a682a5b9661ec99ec8a0435303e95924b6
+  metadata.gz: bd94a0cc6b6ee2470916892afd0c9ffe626d2c7a31acd3fc2bd7e7e4485415bc
+  data.tar.gz: 21f397e67ca49836e84af7fd83a425223a30b385e41a116149c2a0b02074fce4
 SHA512:
-  metadata.gz: 88ebd7702f2ac21a3724b131da9b374847b6412d66b17d55a722f1c04769c56cc48b3e9e33855e1d40dc6a4b10f7462c0db7496dbe460809c53410cbbb88a981
-  data.tar.gz: fcb21e21d0dc94c815cf1b75e08a573c7ed66463e5060e244517c54ec145358c7786d21235242f40c64c292af4beb29e13387e6fb93696ad5efcbec54b9873d3
+  metadata.gz: 53033d79c500d959a80a63f83763091ff28900fdc52356f789022b69da6bce591e53961c7ab30254eff05df8906528daa2acf03ef3ee4336359b4176d29cc732
+  data.tar.gz: 6b5762af287bbaf677e06d50462d4284856de1817f0c9afa9f76d0b96f3cb03303eebc8926edffbc8eca28ac697a52220641eb2b545ed16ee7b43638e2ccec20

data/lib/magister/authenticator.rb

@@ -1,17 +1,24 @@
 # This Source Code Form is subject to the terms of the Mozilla Public
 # License, v. 2.0. If a copy of the MPL was not distributed with this
 # file, You can obtain one at https://mozilla.org/MPL/2.0/.
-require 'magister/profile.rb'
+require 'magister/profile'
 require 'net/http'
 require 'json'
 require 'securerandom'
 require 'base64'
 require 'digest'
 require 'selenium-webdriver'
+require 'time'
 
+# A module used to authenticate a user with the magister api.
 module Authenticator
     extend self
 
+    # Log in with username and password
+    # @param username [String] The username, usually in the form of a "leerlingnummer"
+    # @param password [String] The users password
+    # @param school [String] The school the user attends
+    # @since 1.1.0
     def login(username, password, school)
         # uri = URI("https://#{school}.magister.net/oidc_config.js")
         # http = Net::HTTP.new(uri.host, uri.port)
@@ -21,6 +28,19 @@ module Authenticator
         # oidc_conf = (response.body.split("config =").last.split("};").first.gsub("window.location.hostname", "'" + uri.hostname + "'") + "}").gsub(': ', '":').gsub(/,(\s*)/, ',"').gsub(/{(\s*)/, '{"').gsub("'", '"').gsub('" + "', "")
 
         # oidc_conf = JSON.parse(oidc_conf)
+        if $magister_useCache && File.exist?($magister_cachingDirectory + "/auth.json")
+            f = File.open($magister_cachingDirectory + "/auth.json")
+            cached_data = f.read
+            cached_data = JSON.parse(cached_data)
+            expires = Time.at(cached_data["expires"].to_i)
+            puts "attempting to use cached token..."
+            if expires.to_i > Time.now.to_i
+              puts "using cached token."
+              return Profile.new(cached_data["token"], school)
+            else
+              puts "cached token expired."
+            end
+        end
 
         codeVerifier  = SecureRandom.alphanumeric(128)
         verifier      = Base64.urlsafe_encode64(codeVerifier)
@@ -34,6 +54,7 @@ module Authenticator
         auth_uri = "https://#{school}.magister.net/connect/authorize?client_id=M6LOAPP&redirect_uri=m6loapp%3A%2F%2Foauth2redirect%2F&scope=openid%20profile%20opp.read%20opp.manage%20attendance.overview%20attendance.administration%20calendar.ical.user%20calendar.to-do.user%20grades.read%20grades.manage&state=#{@@state}&nonce=#{@@nonce}&code_challenge=#{challenge}&code_challenge_method=S256&prompt=select_account"
         # puts "using authentication url #{auth_uri}"
 
+        token = ""
         if $authMode == "local"
             raise NotImplementedError.new("\n\nLocal authentication mode has not been implemented yet, \nCheck our github for any updates, or if you want to help implementing it!\n")
         else
@@ -63,11 +84,19 @@ module Authenticator
             wait = Selenium::WebDriver::Wait.new(timeout: 30)
             wait.until { driver.current_url.start_with? "https://#{school}.magister.net/oidc/redirect_callback.html" }
 
+            expires_in = driver.current_url.split("expires_in=").last.split("&").first.to_i
+            expires = Time.now + expires_in
             token = driver.current_url.split("access_token=").last.split("&").first
 
             driver.quit
+        end
 
-            return Profile.new(token, school)
+        if $magister_useCache
+            if $magister_cacheType == "json"
+              File.write($magister_cachingDirectory + "/auth.json", "{\"token\": \"#{token}\", \"expires\": \"#{expires.to_i}\"}")
+            end
         end
+
+        return Profile.new(token, school)
     end
 end

data/lib/magister/data.rb

@@ -6,6 +6,10 @@ require 'magister/types/grade'
 require 'date'
 require 'json'
 
+# Validates a date
+# @param date [String]
+# @return [Boolean]
+# @see get_classes
 def validate_date(date)
     format = '%Y-%m-%d'
     DateTime.strptime(date, format)
@@ -14,7 +18,12 @@ rescue ArgumentError
     false
 end
 
+# Functions for getting or setting data from/to the magister apis
 module MagisterData
+    # Get all the scheduled classes between 2 dates
+    # @param dateFrom [String] the start of the selection
+    # @param dateTo [String] the end of the selection
+    # @since 1.0.0
     def get_classes(dateFrom, dateTo)
         if validate_date(dateFrom) && validate_date(dateTo)
             data = @profile.authenticatedRequest("/personen/{*id*}/afspraken?status=1&van=#{dateFrom}&tot=#{dateTo}")
@@ -28,6 +37,10 @@ module MagisterData
         end
     end
 
+    # Get a certain ammount of grades.
+    # @param count [String] The ammount of grades to get
+    # @param page [String] What page to get from
+    # @since 1.1.0
     def get_grades(count = 5, page = 0)
         data = @profile.authenticatedRequest("/personen/{*id*}/cijfers/laatste?top=#{count}&skip=#{count * page}")
         grades = Array.new

data/lib/magister/profile.rb

@@ -1,11 +1,17 @@
 # This Source Code Form is subject to the terms of the Mozilla Public
 # License, v. 2.0. If a copy of the MPL was not distributed with this
 # file, You can obtain one at https://mozilla.org/MPL/2.0/.
+require 'magister/types/person'
 require 'uri'
 require 'net/http'
 require 'json'
 
+# This represents a profile or a user in magister
 class Profile
+  # Returns a new instance of Profile.
+  # @param token [String] the users token
+  # @param school [String] the school the user attends
+  # @since 1.1.0
   def initialize(token, school)
     @token = token
     @id = 0
@@ -13,23 +19,41 @@ class Profile
     @person = nil
   end
 
+  # Set the user token
+  # @param token [String] new token
+  # @since 1.1.0
   def token=(token)
     @token=token
   end
+  # Get the user id
+  # @return [Integer] id
+  # @since 1.0.0
   def id
     @id
   end
+  # What school the user attends
+  # @return [String] name of the school
+  # @since 1.0.0
   def school
     @school
   end
+  # Get a summary of the object
+  # @return [String] the summary
+  # @since 1.0.0
   def inspect
     "#<#{self.class}:0x#{object_id} @token=\"[PRIVATE]\", @id=#{@id}, @school=#{@school}>"
   end
 
+  # Get the person of the profile
+  # @return [Person] the person
+  # @since 1.0.0
   def person
     @person
   end
 
+  # Verify the authenticity of the token and obtain user data
+  # @note +token+ and +school+ of the #Profile must be defined
+  # @since 1.0.0
   def verify()
     if @school == nil || @token == nil
       puts "Either school or token was not defined!"
@@ -45,9 +69,9 @@ class Profile
       response = http.request(request)
       if response.is_a?(Net::HTTPSuccess)
         res = JSON.parse(response.body)
-        @person = res["Persoon"]
-        @id = person["Id"].to_i
-        puts "Succesfully authenticated as #{@person["Roepnaam"]} with id #{@person["Id"]}"
+        @person = Person.new res["Persoon"]
+        @id = @person.id.to_i
+        puts "Succesfully authenticated as #{@person.firstName} with id #{@person.id}"
       else
         puts "Failed to authenticate, http code #{response.code}"
       end
@@ -56,6 +80,13 @@ class Profile
     end
   end
 
+  # Makes a request that is authenticated on the users behalve.
+  # @param endpoint [String] the endpoint to request (starting with slash, excluding /api)
+  # @note if you put +{*id*}+ in the endpoint, it will be replaced by the users actual id.
+  # @return [Hash] the response given by the magister api.
+  # @example make a request to +https://SCHOOL.magister.net/api/sessions/current+ to get information about the current session (+profile+ is an instance of +Profile+)
+  #   sessionInfo = profile.authenticatedRequest("/sessions/current")
+  # @since 1.0.0
   def authenticatedRequest(endpoint)
     if @id == 0
       puts "Not yet authenticated!"

data/lib/magister/types/class.rb

@@ -5,8 +5,12 @@ require "magister/types/classroom.rb"
 require "magister/types/subject.rb"
 require "magister/types/teacher.rb"
 
+# This class describes a Class as it would appear in the schedule in magister.
 # MagClass instead of Class becasue ruby got confused with class
 class MagClass
+    # Returns a new instance of MagClass.
+    # @param rawParsed [Hash] The raw data, yet it has already been parsed (like with JSON.parse)
+    # @since 1.1.0
     def initialize(rawParsed)
         @id                 = rawParsed["Id"]
         @classStart         = rawParsed["Start"]
@@ -51,89 +55,198 @@ class MagClass
         @groups             = rawParsed["Groepen"]
     end
 
+    # Gets a summary of the object.
+    # Overwrites default function.
+    # @return [String] object summary
+    # @since 1.1.0
     def inspect
         "#<#{self.class}:0x#{object_id} @id=#{@id}, @description=#{@description}, @subjects[0]=#{@subjects[0].inspect}, @teachers[0]=#{@teachers[0].inspect}, @location=#{@location}>"
     end
 
     # getters
+
+    # The ID of the class
+    # @return [Integer] the id
+    # @since 1.1.0
     def id
         @id
     end
+    # The time the class starts
+    # @return [String] the date formatted in ISO 8601
+    # @since 1.1.0
     def classStart
         @classStart
     end
+    # @see classStart
+    # @since 1.1.0
     def startTime
         @classStart
     end
+    # The time the class ends
+    # @return [String] the ending date formatted in ISO 8601
+    # @since 1.1.0
     def classEndInclusive
         @classEndInclusive
     end
+    # @see classEndInclusive
+    # @since 1.1.0
     def endTime
         @classEndInclusive
     end
+    # If the class lasts the whole day
+    # @return [Boolean]
+    # @since 1.1.0
     def wholeDay
         @wholeDay
     end
+    # The description of the class formatted like
+    # a - b - c.
+    # where a is a short version of the classes name.
+    # where b is the short code of the teachers name.
+    # where c is the class/group the class belongs to.
+    # @return [String] a - b - c
+    # @since 1.1.0
     def description
         @description
     end
+    # The location where the class is
+    # @note reccommended to use the +classrooms+ property instead
+    # @return [String] the location
+    # @see classrooms
+    # @since 1.1.0
     def location
         @location
     end
+    # The content of the class.
+    # @return [String, nil] the content
+    # @note This is stuff like homework or test descriptions.
+    # @since 1.1.0
     def content
         @content
     end
+    # A remark (opmerking) added to the class
+    # @return [String, nil] the remark
+    # @note This is diffrent form the +note+
+    # @see note
+    # @since 1.1.0
     def remark
         @remark
     end
+    # A note (aantekening) added to the class
+    # @return [String, nil] the note
+    # @note This is diffrent from +remark+
+    # @see remark
+    # @since 1.1.0
     def note
         @note
     end
+    # If it is marked as finished
+    # @note this has been set by the user, not by the teacher or anyone else.
+    # @return [Boolean]
+    # @since 1.1.0
     def finished
         @finished
     end
+    # If the class repeats
+    # @note Currently we are not certain what every status means.
+    # @return [Integer] the status
+    # @since 1.1.0
     def repeatStatus
         @repeatStatus
     end
+    # |?| How it repeats
+    # @note We do not have info on what this property does/means
+    # @return [?]
+    # @since 1.1.0
     def repeat
         @repeat
     end
+    # What subjects are in this class
+    # @return [Array<Subject>] The subjects
+    # @since 1.1.0
     def subjects
         @subjects
     end
+    # What teachers are giving this class
+    # @return [Array<Teacher>] The teachers
+    # @since 1.1.0
     def teachers
         @teachers
     end
+    # What classrooms this class is given in
+    # @return [Array<ClassRoom>] The classrooms
+    # @since 1.1.0
     def classrooms
         @classrooms
     end
+    # If the class has any attachments
+    # @return [Boolean] has attachments
+    # @see attachments
+    # @since 1.1.0
     def hasAttachments
         @hasAttachments
     end
+    # The attachments that are attached
+    # @note Unsure yet what type the attachments will be
+    # @return [?, nil]
+    # @since 1.1.0
     def attachments
         @attachments
     end
+
+    # |?| What kind of content it has
+    # @note We do not have info on what this property does/means
+    # @return [?]
+    # @since 1.1.0
     def infoType
         @infoType
     end
+    # |?| if the class is cancelled etc?
+    # @note We do not have info on what this property does/means
+    # @return [Integer]
+    # @since 1.1.0
     def status
         @status
     end
+    # |?|
+    # @note We do not have info on what this property does/means
+    # @return [?]
+    # @since 1.1.0
     def type
         @type
     end
+    # |?|
+    # @note We do not have info on what this property does/means
+    # @return [?]
+    # @since 1.1.0
     def subtype
         @subtype
     end
-    def usOnline
+    # |?| Wether or not the class has online attendance
+    # @note We do not have info on what this property does/means
+    # @return [Boolean]
+    # @since 1.1.0
+    def isOnline
         @isOnline
     end
+    # |?|
+    # @note We do not have info on what this property does/means
+    # @return [Integer]
+    # @since 1.1.0
     def viewType
         @viewType
     end
+    # |?|
+    # @note We do not have info on what this property does/means
+    # @return [?]
+    # @since 1.1.0
     def assignmentId
         @assignmentId
     end
+    # |?|
+    # @note We do not have info on what this property does/means
+    # @return [?, nil]
+    # @since 1.1.0
     def groups
         @groups
     end

data/lib/magister/types/classroom.rb

@@ -2,12 +2,18 @@
 # License, v. 2.0. If a copy of the MPL was not distributed with this
 # file, You can obtain one at https://mozilla.org/MPL/2.0/.
 
+# This class represents a physical classroom.
 class ClassRoom
+    # Returns a new instance of ClassRoom.
+    # @param rawParsed [Hash] The raw data, yet it has already been parsed (like with JSON.parse)
+    # @since 1.1.0
     def initialize(rawParsed)
       @name = rawParsed["Naam"]
     end
 
-    # singular getter
+    # The name of the class
+    # @return [String] name
+    # @since 1.1.0
     def name
         @name
     end

data/lib/magister/types/grade.rb

@@ -3,7 +3,11 @@
 # file, You can obtain one at https://mozilla.org/MPL/2.0/.
 require 'json'
 
+# This class is used to represent a grade and all metadata of it.
 class Grade
+    # Returns a new instance of Grade.
+    # @param rawParsed [Hash] The raw data, yet it has already been parsed (like with JSON.parse)
+    # @since 1.1.0
     def initialize(rawParsed)
         @id             = rawParsed["kolomId"]
         @description    = rawParsed["omschrijving"]
@@ -25,46 +29,95 @@ class Grade
         @earnedOn       = rawParsed["behaaldOp"]
     end
 
-    # getters
+    # The id of the grade
+    # @return [Integer] id
+    # @since 1.1.0
     def id
         @id
     end
+    # The description of the grade
+    # @return [String] description
+    # @since 1.1.0
     def description
         @description
     end
+    # The subject the grade belongs to
+    # @return [Subject] subject
+    # @since 1.1.0
     def subject
         @subject
     end
+    # If the grade is considered sufficient
+    # @return [Boolean] sufficient
+    # @since 1.1.0
     def isSufficient
         @isSufficient
     end
+    # If the grade is considered insufficient
+    # @return [Boolean] insufficient
+    # @note This is simply the inverse of +isSufficient+
+    # @see isSufficient
+    # @since 1.1.0
     def isInsufficient
         !@isSufficient
     end
+    # Get the actual grade/value
+    # @return [Float] grade
+    # @since 1.1.0
     def grade
         @grade
     end
-    def values
+    # Get the actual grade/value
+    # @return [Float] grade
+    # @see grade
+    # @since 1.1.0
+    def value
         @grade
     end
+    # Get the wight of the grade
+    # @return [Integer] weight
+    # @since 1.1.0
     def weight
         @weight
     end
+    # If the grade actually counts
+    # @return [Boolean] counts
+    # @since 1.1.0
     def counts
         @counts
     end
+    # If the test/thing that caused the grade needs to be caught up on
+    # @return [Boolean] needs to be caught up
+    # @since 1.1.0
     def toBeCaughtUp
         @toBeCaughtUp
     end
+    # If the current user is exempt from the subject
+    # @return [Boolean] exempt
+    # @since 1.1.0
     def isExempt
         @isExempt
     end
+    # If the current user is exempt from the subject
+    # @return [Boolean] exempt
+    # @see exempt
+    # @since 1.1.0
     def exempt
         @isExempt
     end
+    # When the grade was entered
+    # @return [String] Date
+    # @note This is when the teacher added the grade to magisters
+    # @see earnedOn
+    # @since 1.1.0
     def addedOn
         @addedOn
     end
+    # If the current user is exempt from the subhect
+    # @return [Boolean, nil] exempt
+    # @note This is when the actual test occurred
+    # @see addedOn
+    # @since 1.1.0
     def earnedOn
         @earnedOn
     end

data/lib/magister/types/person.rb

@@ -0,0 +1,138 @@
+# This Source Code Form is subject to the terms of the Mozilla Public
+# License, v. 2.0. If a copy of the MPL was not distributed with this
+# file, You can obtain one at https://mozilla.org/MPL/2.0/.
+
+# Module used in the #person class
+# @since 1.2.0
+module Birth
+    # The birthday of the person
+    # @return [String] birthday
+    # @since 1.2.0
+    def day
+        @birthDay
+    end
+    # The persons last name given at birth
+    # @return [String] name
+    # @since 1.2.0
+    def lastName
+        @birthLastName
+    end
+    # The persons preposition given at birth
+    # @return [String] preposition
+    # @since 1.2.0
+    def preposition
+        @birthnamePreposition
+    end
+    # Wether or not to use the users birth name
+    # @return [Boolean] use birth name
+    # @since 1.2.0
+    def use
+        @useBirthname
+    end
+    # Wether or not to use the users birth name
+    # @return [Boolean] use birth name
+    # @since 1.2.0
+    def useBirthname
+        @useBirthname
+    end
+end
+
+# Module used in the #person class
+# @since 1.2.0
+module Official
+    # The official first of the person
+    # @return [String] name
+    # @since 1.2.0
+    def firstNames
+        @officialFirstNames
+    end
+    # The official prepositions of the person
+    # @return [String, nil] prepositions
+    # @since 1.2.0
+    def prepositions
+        @officialPrepositions
+    end
+    # The official last name of the person
+    # @return [String] name
+    # @since 1.2.0
+    def lastName
+        @officialLastName
+    end
+    # The initials of the person
+    # @return [String] initials
+    # @since 1.2.0
+    def initials
+        @initials
+    end
+end
+
+# This class describes the person object the magister api gives us
+# this object includes all the user's personal data like name and birthday
+class Person
+    include Birth
+    include Official
+
+    # Returns a new instance of Person.
+    # @param rawParsed [Hash] The raw data, yet it has already been parsed (like with JSON.parse)
+    # @since 1.2.0
+    def initialize(rawParsed)
+        @id                     = rawParsed["Id"]
+        @firstName              = rawParsed["Roepnaam"]
+        @preposition            = rawParsed["Tussenvoegsel"]
+        @lastName               = rawParsed["Achternaam"]
+        @officialFirstNames     = rawParsed["OfficieleVoornamen"]
+        @initials               = rawParsed["Voorletters"]
+        @officialPrepositions   = rawParsed["OfficieleTussenvoegsels"]
+        @officialLastName       = rawParsed["OfficieleAchternaam"]
+        @birthDay               = rawParsed["Geboortedatum"]
+        @birthLastName          = rawParsed["GeboorteAchternaam"]
+        @birthnamePreposition   = rawParsed["GeboortenaamTussenvoegsel"]
+        @useBirthname           = rawParsed["GebruikGeboortenaam"]
+
+        # probably only for tracking
+        @externalId             = rawParsed["ExterneId"]
+    end
+
+    # The id of the person
+    # @return [Integer] id
+    # @since 1.2.0
+    def id
+        @id
+    end
+    # The first name of the person
+    # @return [String] name
+    # @since 1.2.0
+    def firstName
+        @firstName
+    end
+    # The preposition (thing between first & last name) of the person
+    # @return [String, nil] preposition
+    # @since 1.2.0
+    def preposition
+        @preposition
+    end
+    # The last name of the person
+    # @return [String] name
+    # @since 1.2.0
+    def lastName
+        @lastName
+    end
+    # The initials of the person
+    # @return [String] initials
+    # @since 1.2.0
+    def initials
+        @initials
+    end
+    # The birthday of the person
+    # @return [String] birthday
+    # @since 1.2.0
+    def birthDay
+        @birthDay
+    end
+    # Wether or not to use the users birth name
+    # @return [Boolean] use birth name
+    # @since 1.2.0
+    def useBirthname
+        @useBirthname
+    end
+end

data/lib/magister/types/subject.rb

@@ -2,16 +2,29 @@
 # License, v. 2.0. If a copy of the MPL was not distributed with this
 # file, You can obtain one at https://mozilla.org/MPL/2.0/.
 
+# This class represents a subject in magister in the sense of when it is linked to another object
 class Subject
+    # Returns a new instance of Subject.
+    # @param rawParsed [Hash] The raw data, yet it has already been parsed (like with JSON.parse)
+    # @since 1.1.0
     def initialize(rawParsed)
         @id = rawParsed["Id"]
         @name = rawParsed["Naam"]
     end
 
-    # getters
+    # The id (or code) of the subject
+    # @return [Integer, String] id
+    # @note When initialized by +Grade+ it uses the code as the id to initialize
+    # @see Grade
+    # @since 1.1.0
     def id
         @id
     end
+    # The name of the subject
+    # @return [String] Name
+    # @note When initialized by +Grade+ it uses the description as the name to initialize
+    # @see Grade
+    # @since 1.1.0
     def name
         @name
     end

data/lib/magister/types/teacher.rb

@@ -2,26 +2,44 @@
 # License, v. 2.0. If a copy of the MPL was not distributed with this
 # file, You can obtain one at https://mozilla.org/MPL/2.0/.
 
+# This class represents the teacher object magister gives us.
 class Teacher
+    # Returns a new instance of Teacher.
+    # @param rawParsed [Hash] The raw data, yet it has already been parsed (like with JSON.parse)
+    # @since 1.1.0
     def initialize(rawParsed)
         @id = rawParsed["Id"]
         @name = rawParsed["Naam"]
         @abrev = rawParsed["Docentcode"]
     end
 
-    # getters
+    # The id of the teacher
+    # @return [Integer] id
+    # @since 1.1.0
     def id
         @id
     end
+    # The name of the teacher
+    # @return [String] name
+    # @since 1.1.0
     def name
         @name
     end
+    # The abreviation of the teacher
+    # @return [String] Abreviation
+    # @since 1.1.0
     def abrev
         @abrev
     end
+    # The abreviation of the teacher
+    # @return [String] Abreviation
+    # @since 1.1.0
     def abreviaton
         @abrev
     end
+    # The abreviation of the teacher
+    # @return [String] Abreviation
+    # @since 1.1.0
     def code
         @abrev
     end

data/lib/magister.rb

@@ -1,30 +1,65 @@
 # This Source Code Form is subject to the terms of the Mozilla Public
 # License, v. 2.0. If a copy of the MPL was not distributed with this
 # file, You can obtain one at https://mozilla.org/MPL/2.0/.
-require 'magister/profile.rb'
-require 'magister/data.rb'
-require 'magister/authenticator.rb'
+require 'magister/profile'
+require 'magister/data'
+require 'magister/authenticator'
 
 # can be either "selenium" or "local"
 # "selenium" will run headlessly
 # "local" will open a browser window for the user to login
 $authMode = "selenium"
 
+# Caching options
+$magister_useCache = true
+$magister_cachingDirectory = ".cache/magister"
+
+# Cache type can eitehr be "compact" or "json"
+$magister_cacheType = "json"
+# Wether to encrypt the cache, this can secure the acount by not exposing the token or any sensetive data.
+$magister_encryptCache = false
+# When using encryption, this may not be empty
+$magister_encryptionKey = ""
+
+# The main magister class
 class Magister
     include MagisterData
 
+    # Returns a new instance of Magister.
+    # @since 1.0.0
     def initialize
         @profile = nil
+
+        if $magister_useCache
+            prev = ""
+            $magister_cachingDirectory.split("/").each do |directory|
+                Dir.mkdir(prev + directory) unless File.exist?(prev + directory)
+                prev += directory + "/"
+            end
+        end
     end
 
+    # Create a new profile and authenticate with a token
+    # @param school [String] The school the user attends
+    # @param token [String] The users token
+    # @since 1.0.0
     def authenticate(school, token)
         @profile = Profile.new(token, school)
         @profile.verify
     end
+    # Create a new profile based on a username and password
+    # @param school [String] The school the user attends
+    # @param username [String] The users username
+    # @param password [String] The users password
+    # @see Authenticator#login
+    # @since 1.1.0
     def login(school, username, password)
         @profile = Authenticator.login(username, password, school)
     end
 
+    # Get the users profile
+    # @return [Profile] the profile
+    # @since 1.0.0
     def profile
         @profile
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: magister
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.1
 platform: ruby
 authors:
 - Riley0122
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-02-19 00:00:00.000000000 Z
+date: 2024-02-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -85,6 +85,7 @@ files:
 - lib/magister/types/class.rb
 - lib/magister/types/classroom.rb
 - lib/magister/types/grade.rb
+- lib/magister/types/person.rb
 - lib/magister/types/subject.rb
 - lib/magister/types/teacher.rb
 homepage: https://github.com/riley0122/rubymag#readme
@@ -92,6 +93,7 @@ licenses:
 - MPL-2.0
 metadata:
   source_code_uri: https://github.com/riley0122/rubymag
+  documentation_uri: https://riley0122.github.io/rubymag
 post_install_message: 
 rdoc_options: []
 require_paths: