martlet 0.0.2

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in martlet.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Alex Coco
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,27 @@
+# Martlet
+
+Martlet is a Ruby client for McGill's student portal, Minerva. Minerva sucks and constantly checking your grades sucks even more.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'martlet'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install martlet
+
+## Usage
+
+    $ irb
+    >> require 'martlet'
+    >> client = Martlet.new('your.name@mail.mcgill.ca', 'topsecret')
+    >> pp client.grades
+    {"COMP 206"=>"A",
+     "COMP 250"=>"A"
+     ...

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/martlet/authenticator.rb

@@ -0,0 +1,48 @@
+module Martlet
+  class AuthenticationError < StandardError; end
+  
+  class Authenticator
+    def initialize(agent)
+      @agent = agent
+    end
+    
+    def authenticate(email, password)
+      # Go to login page
+      login_page = @agent.get(login_url)
+      
+      # Find and fill login form
+      form = login_form(login_page)
+      form['sid'] = email
+      form['PIN'] = password
+      
+      submit_login_form(form)
+    end
+    
+    private
+    
+    def login_url
+      'https://horizon.mcgill.ca/pban1/twbkwbis.P_WWWLogin'
+    end
+    
+    def login_form(page)
+      if form = page.form('loginform1')
+        form
+      else
+        raise AuthenticationError.new('Login form not found')
+      end
+    end
+    
+    def submit_login_form(form)
+      page = form.submit
+      body = page.body
+      
+      unless body.match(/Welcome,\+(.*),\+to\+Minerva/)
+        if body.include?('Authorization Failure')
+          raise AuthenticationError.new('Invalid email or password')
+        else
+          raise AuthenticationError.new('Authentication failed')
+        end
+      end
+    end
+  end
+end

data/lib/martlet/client.rb

@@ -0,0 +1,20 @@
+require 'mechanize'
+
+module Martlet
+  class Client
+    attr_reader :email
+    
+    def initialize(email, password)
+      @agent = Mechanize.new
+      @email = email
+      
+      authenticator = Authenticator.new(@agent)
+      authenticator.authenticate(email, password)
+    end
+    
+    def grades
+      transcript = Transcript.new(@agent)
+      transcript.fetch_grades
+    end
+  end
+end

data/lib/martlet/record.rb

@@ -0,0 +1,39 @@
+module Martlet
+  class Record
+    attr_accessor :number, :name, :section, :credits, :grade, :average
+    
+    def initialize(args)
+      @number  = args[:number]
+      @name    = args[:name]
+      @section = args[:section]
+      @credits = args[:credits].to_i
+      @grade   = args[:grade]
+      @average = args[:average]
+    end
+    
+    def gpa
+      grade_to_gpa(grade)
+    end
+    
+    def average_gpa
+      grade_to_gpa(average)
+    end
+    
+    private
+    
+    def grade_to_gpa(grade)
+      case grade
+      when 'A'  then 4.0
+      when 'A-' then 3.7
+      when 'B+' then 3.3
+      when 'B'  then 3.0
+      when 'B-' then 2.7
+      when 'C+' then 2.3
+      when 'C'  then 2.0
+      when 'D'  then 1.0
+      when 'F'  then 0.0
+      else nil
+      end
+    end
+  end
+end

data/lib/martlet/transcript.rb

@@ -0,0 +1,32 @@
+module Martlet
+  class Transcript
+    def initialize(agent)
+      @agent = agent
+      @html  = fetch_transcript_html
+    end
+    
+    def fetch_grades
+      records = fetch_records
+      records.inject({}) do |hash, record|
+        hash[record.number] = record.grade
+        hash
+      end
+    end
+    
+    def fetch_records
+      parser = TranscriptParser.new(@html)
+      parser.parse_records
+    end
+    
+    private
+    
+    def transcript_url
+      'https://horizon.mcgill.ca/pban1/bzsktran.P_Display_Form?user_type=S&tran_type=V'
+    end
+    
+    def fetch_transcript_html
+      page = @agent.get(transcript_url)
+      page.body
+    end
+  end
+end

data/lib/martlet/transcript_parser.rb

@@ -0,0 +1,68 @@
+module Martlet
+  class TranscriptParser
+    def initialize(html)
+      @html = html
+    end
+    
+    def parse_records
+      records = []
+      document = Nokogiri::HTML(@html)
+      rows = document.search("table[@class='dataentrytable'] tr")
+      
+      rows.each do |row|
+        row_data = row.search('td')
+        next unless record_data_row?(row_data) && grade_present?(row_data)
+        
+        record_data = {
+          number:  extract_record_data_for(row_data, :number),
+          name:    extract_record_data_for(row_data, :name),
+          section: extract_record_data_for(row_data, :section),
+          credits: extract_record_data_for(row_data, :credits),
+          grade:   extract_record_data_for(row_data, :grade),
+          average: extract_record_data_for(row_data, :average)
+        }
+        
+        records << Record.new(record_data)
+        
+      end
+      
+      records
+    end
+    
+    private
+    
+    def index_for(name)
+      case name
+      when :number  then 1
+      when :section then 2
+      when :name    then 3
+      when :credits then 4
+      when :grade   then 6
+      when :average then 10
+      end
+    end
+    
+    def extract_record_data_for(data, name)
+      index = index_for(name)
+      
+      if data && data[index]
+        span = data[index].search('span')
+        
+        if span
+          span.text
+        else
+          ''
+        end
+      end
+    end
+    
+    def record_data_row?(row_data)
+      row_data.length == 11
+    end
+    
+    def grade_present?(row_data)
+      grade = extract_record_data_for(row_data, :grade)
+      grade && !grade.empty?
+    end
+  end
+end

data/lib/martlet/version.rb

@@ -0,0 +1,3 @@
+module Martlet
+  VERSION = "0.0.2"
+end

data/lib/martlet.rb

@@ -0,0 +1,12 @@
+require 'martlet/client'
+require 'martlet/authenticator'
+require 'martlet/transcript'
+require 'martlet/transcript_parser'
+require 'martlet/record'
+require 'martlet/version'
+
+module Martlet
+  def self.new(*args)
+    Client.new(*args)
+  end
+end

data/martlet.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'martlet/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "martlet"
+  spec.version       = Martlet::VERSION
+  spec.authors       = ["Alex Coco"]
+  spec.email         = ["hello@alexcoco.com"]
+  spec.description   = %q{Ruby client for McGill's student portal, Minerva.}
+  spec.summary       = %q{Client for McGill's student portal}
+  spec.homepage      = "https://github.com/alexcoco/martlet"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  
+  spec.add_dependency "mechanize", "~> 2.7"
+end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: martlet
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- Alex Coco
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mechanize
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.7'
+description: Ruby client for McGill's student portal, Minerva.
+email:
+- hello@alexcoco.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/martlet.rb
+- lib/martlet/authenticator.rb
+- lib/martlet/client.rb
+- lib/martlet/record.rb
+- lib/martlet/transcript.rb
+- lib/martlet/transcript_parser.rb
+- lib/martlet/version.rb
+- martlet.gemspec
+homepage: https://github.com/alexcoco/martlet
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Client for McGill's student portal
+test_files: []