magister 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8615e0de52da0b061810bd3ead80cb1be7c5c74b4cd019fa8adc378c2ed5ab3d
+  data.tar.gz: a3c20cfb453481be6079f14878e00e8d70ffe3c4b56769c5df0c79535547dd7c
+SHA512:
+  metadata.gz: a00609ba584cf34ccd127aa7f3d431856bf1e223e2bba6b7dafc3d752bca0972ac30664d8befa0a2e4db831678b684fdfaa1fa34e368f86c8dae4fb44a3f44ed
+  data.tar.gz: 68e5d06e95b52ebaad3c33ce98266d2e1967eb63f0e5efdce94dda66eaeae538290360a8273ae0596a3e10f01d9cf5eb77dd4c711f3127756d193c2302f43d15

data/lib/magister/authenticator.rb

@@ -0,0 +1,73 @@
+# 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 './lib/magister/profile.rb'
+require 'net/http'
+require 'json'
+require 'securerandom'
+require 'base64'
+require 'digest'
+require 'selenium-webdriver'
+
+module Authenticator
+    extend self
+
+    def login(username, password, school)
+        # uri = URI("https://#{school}.magister.net/oidc_config.js")
+        # http = Net::HTTP.new(uri.host, uri.port)
+        # http.use_ssl = true
+        # request = Net::HTTP::Get.new(uri.request_uri)
+        # response = http.request(request)
+        # 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)
+
+        codeVerifier  = SecureRandom.alphanumeric(128)
+        verifier      = Base64.urlsafe_encode64(codeVerifier)
+
+        rawChallenge = Digest::SHA256.hexdigest verifier
+        challenge = Base64.urlsafe_encode64(rawChallenge)
+
+        @@state = SecureRandom.hex(16)
+        @@nonce = SecureRandom.hex(16)
+
+        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}"
+
+        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
+            puts "Using Selenium with Chrome for authentication."
+            options = Selenium::WebDriver::Options.chrome(args: ['--headless=new'])
+            driver = Selenium::WebDriver.for :chrome, options: options
+
+            driver.get auth_uri
+            while !driver.current_url.start_with? "https://accounts.magister.net/account/login"
+                sleep(0.5)
+                # puts "waiting for load..."
+            end
+            sleep(3)
+
+            username_field = driver.find_element(id: 'username')
+            username_field.send_keys(username)
+            go_to_password_button = driver.find_element(id: 'username_submit')
+            go_to_password_button.click
+
+            sleep(1)
+
+            password_field = driver.find_element(id: 'password')
+            password_field.send_keys(password)
+            signin_button = driver.find_element(id: 'password_submit')
+            signin_button.click
+
+            wait = Selenium::WebDriver::Wait.new(timeout: 30)
+            wait.until { driver.current_url.start_with? "https://#{school}.magister.net/oidc/redirect_callback.html" }
+
+            token = driver.current_url.split("access_token=").last.split("&").first
+
+            driver.quit
+
+            return Profile.new(token, school)
+        end
+    end
+end

data/lib/magister/data.rb

@@ -0,0 +1,22 @@
+# 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 'date'
+
+def validate_date(date)
+    format = '%Y-%m-%d'
+    DateTime.strptime(date, format)
+    true
+rescue ArgumentError
+    false
+end
+
+module MagisterData
+    def get_classes(dateFrom, dateTo)
+        if validate_date(dateFrom) && validate_date(dateTo)
+            @profile.authenticatedRequest("/personen/{*id*}/afspraken?status=1&van=#{dateFrom}&tot=#{dateTo}")
+        else
+            puts "Invalid date, Format is yyyy-mm-dd"
+        end
+    end
+end

data/lib/magister/profile.rb

@@ -0,0 +1,82 @@
+# 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 'uri'
+require 'net/http'
+require 'json'
+
+class Profile
+  def initialize(token, school)
+    @token = token
+    @id = 0
+    @school = school
+    @person = nil
+  end
+
+  def token=(token)
+    @token=token
+  end
+  def id
+    @id
+  end
+  def school
+    @school
+  end
+  def inspect
+    "#<#{self.class}:0x#{object_id} @token=\"[PRIVATE]\", @id=#{@id}, @school=#{@school}>"
+  end
+
+  def person
+    @person
+  end
+
+  def verify()
+    if @school == nil || @token == nil
+      puts "Either school or token was not defined!"
+    end
+    puts "authenticating to #{@school}..."
+    uri = URI("https://#{@school}.magister.net/api/account")
+    http = Net::HTTP.new(uri.host, uri.port)
+    http.use_ssl = true
+    request = Net::HTTP::Get.new(uri.request_uri)
+    request['authorization'] = "Bearer #{@token}"
+
+    begin
+      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"]}"
+      else
+        puts "Failed to authenticate, http code #{response.code}"
+      end
+    rescue StandardError => e
+      puts "An error occurred #{e}"
+    end
+  end
+
+  def authenticatedRequest(endpoint)
+    if @id == 0
+      puts "Not yet authenticated!"
+      self.verify()
+    end
+    uri = URI("https://#{@school}.magister.net/api#{endpoint}".gsub("{*id*}", @id.to_s))
+    http = Net::HTTP.new(uri.host, uri.port)
+    http.use_ssl = true
+    request = Net::HTTP::Get.new(uri.request_uri)
+    request['authorization'] = "Bearer #{@token}"
+
+    begin
+      response = http.request(request)
+      if response.is_a?(Net::HTTPSuccess)
+        return JSON.parse(response.body)
+      else
+        puts "failed to get #{endpoint}, status code #{response.code}"
+        return nil
+      end
+    rescue StandardError => e
+      puts "An error occurred #{e}"
+    end
+  end
+end

data/lib/magister.rb

@@ -0,0 +1,31 @@
+# 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 './lib/magister/profile.rb'
+require './lib/magister/data.rb'
+require './lib/magister/authenticator.rb'
+
+# can be either "selenium" or "local"
+# "selenium" will run headlessly
+# "local" will open a browser window for the user to login
+$authMode = "selenium"
+
+class Magister
+    include MagisterData
+
+    def initialize
+        @profile = nil
+    end
+
+    def authenticate(school, token)
+        @profile = Profile.new(token, school)
+        @profile.verify
+    end
+    def login(school, username, password)
+        @profile = Authenticator.login(username, password, school)
+    end
+
+    def profile
+        @profile
+    end
+end

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: magister
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Riley0122
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2024-02-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.7.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.7.1
+- !ruby/object:Gem::Dependency
+  name: securerandom
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.1
+- !ruby/object:Gem::Dependency
+  name: base64
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+- !ruby/object:Gem::Dependency
+  name: selenium-webdriver
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.17'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.17'
+description: An unofficial Magister API wrapper for ruby
+email: contact@riley0122.dev
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/magister.rb
+- lib/magister/authenticator.rb
+- lib/magister/data.rb
+- lib/magister/profile.rb
+homepage: https://github.com/riley0122/rubymag#readme
+licenses:
+- MPL-2.0
+metadata:
+  source_code_uri: https://github.com/riley0122/rubymag
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key: 
+specification_version: 4
+summary: Magister API wrapper
+test_files: []