martlet 0.0.5 → 0.0.6

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 35a2b85f2c458fe8574f563eda6789bafe0944c3
+  data.tar.gz: 56f1b0405e9918adc07b75a57523d9fc825c0856
+SHA512:
+  metadata.gz: 568ec7e3a3347e0273d48e03158d0906217eacf942bd46dc2cd6e4d6ec318b285f3097d7a65112cb07143a75ed49a471d1330e14e5a1a0fd99aab9f5ee28a59b
+  data.tar.gz: c3ac26d611c43935969620f116344c7ed0112fa4c7381bb7a6d5c0a312170b608c900d4d097ab8ed6d9a8d555e5033e8202ae2607cd5f717837fd885affbd309

data/bin/martlet

@@ -2,61 +2,6 @@
 $:.unshift File.join File.dirname(__FILE__), '..', 'lib'
 require 'rubygems'
 require 'martlet'
-require 'yaml'
-require 'io/console'
+require 'martlet/cli'
 
-def usage
-  puts <<-STR
-USAGE:
-  martlet [command]
-
-COMMANDS:
-  grades  Lists all your grades. This is the default command.
-  STR
-end
-
-def get_credentials
-  config_path = File.join ENV['HOME'], '.martlet'
-  email = nil
-  password = nil
-  
-  if File.exist?(config_path)
-    config = YAML.load_file config_path
-    email = config['email']
-    password = config['password']
-  else
-    print 'Minerva email: '
-    email = gets.chomp
-  
-    print 'Password: '
-    password = STDIN.noecho(&:gets).chomp
-    puts
-  end
-  
-  return email, password
-end
-
-def run(args)
-  case args.shift
-  when nil, 'grades'
-    email, password = get_credentials
-  
-    puts 'Authenticating...'
-    client = Martlet.new(email, password)
-  
-    puts 'Fetching grades...'
-    grades = client.grades
-
-    grades.each do |number, grade|
-      puts "#{number}: #{grade}"
-    end
-  else
-    usage
-  end
-rescue Martlet::AuthenticationError => e
-  puts "An error has occurred: #{e.message}"
-end
-
-args = ARGV.dup
-ARGV.clear
-run(args)
+Martlet::CLI.start(ARGV)

data/lib/martlet/cli.rb

@@ -0,0 +1,91 @@
+require 'thor'
+require 'yaml'
+require 'io/console'
+
+module Martlet
+  class CLI < Thor
+    default_task :grades
+
+    desc "grades", "Lists all your grades"
+    method_option :sort, aliases: 's', enum: ['course', 'grade']
+    def grades
+      puts 'Fetching grades...'
+      grades = client.grades
+
+      grades = case options['sort']
+      when 'course' then grades.sort_by { |k,v| k }
+      when 'grade'  then grades.sort_by { |k,v| Grade.new v }
+      else grades
+      end
+
+      grades.each do |number, grade|
+        puts "#{number}: #{grade}"
+      end
+    end
+
+    desc "courses SEMESTER YEAR", "List current courses or courses for given semester and year"
+    def courses(semester = nil, year = nil)
+      if semester.nil? || year.nil?
+        semester, year = current_semester_and_year
+      end
+
+      puts 'Fetching courses...'
+      courses = client.courses(semester, year)
+      course_name_size = courses.map { |c| c.name.length }.max
+
+      puts "#{semester.capitalize} #{year} courses"
+
+      courses.each do |course|
+        course_row_format = "%-11s %-#{course_name_size}s @ %s\n"
+        printf course_row_format, "#{course.number}", course.name, course.location
+      end
+
+      puts 'No courses found' if courses.empty?
+    end
+
+    private
+
+    def credentials
+      email = nil
+      password = nil
+      
+      if File.exist?(config_path)
+        # Get credentials from config file
+        config = YAML.load_file config_path
+        email = config['email']
+        password = config['password']
+      else
+        # Get credentials from stdin
+        print 'Minerva email: '
+        email = gets.chomp
+      
+        print 'Password: '
+        password = STDIN.noecho(&:gets).chomp
+        puts
+      end
+      
+      return email, password
+    end
+
+    def client
+      @client ||= begin
+        puts 'Authenticating...'
+        Martlet.new(*credentials)
+      end
+    end
+
+    def config_path
+      "#{ENV['HOME']}/.martlet"
+    end
+
+    def current_semester_and_year
+      semester = case Time.now.month
+      when 1..4  then 'winter'
+      when 5..8  then 'summer'
+      when 9..12 then 'fall'
+      end
+
+      return semester, Time.now.year
+    end
+  end
+end

data/lib/martlet/client.rb

@@ -6,7 +6,7 @@ module Martlet
     
     def initialize(email, password)
       @agent = Mechanize.new
-      @email = format_email(email)
+      @email = email.include?('@') ? email : "#{email}@mail.mcgill.ca"
       
       authenticator = Authenticator.new(@agent)
       authenticator.authenticate(@email, password)
@@ -16,15 +16,10 @@ module Martlet
       transcript = Transcript.new(@agent)
       transcript.fetch_grades
     end
-    
-    private
-    
-    def format_email(email)
-      if email.include?('@')
-        email
-      else
-        "#{email}@mail.mcgill.ca"
-      end
+
+    def courses(semester, year)
+      schedule = Schedule.new(@agent, semester, year)
+      schedule.fetch_courses
     end
   end
-end
+end

data/lib/martlet/course.rb

@@ -0,0 +1,28 @@
+module Martlet
+  class Course
+    include DayConversions
+
+    attr_accessor :name, :number, :term, :crn, :instructor, :credits, :level, :campus,
+                  :time, :days, :location, :date_range, :type, :instructors
+
+    def initialize(args)
+      @name        = args[:name] || ''
+      @number      = args[:number]
+      @term        = args[:term]
+      @crn         = args[:crn]
+      @instructor  = args[:instructor]
+      @credits     = args[:credits]
+      @level       = args[:level]
+      @campus      = args[:campus]
+      @time        = args[:time]
+      @days        = args[:days] || ''
+      @location    = args[:location]
+      @date_range  = args[:date_range]
+      @type        = args[:type]
+      @instructors = args[:instructors]
+
+      @name.gsub! /\.$/, ''
+      @days = @days.split('').map { |letter| day_from_letter(letter) }
+    end
+  end
+end

data/lib/martlet/day_conversions.rb

@@ -0,0 +1,35 @@
+module Martlet
+  module DayConversions
+    def day_from_letter(letter)
+      case letter.upcase
+      when 'M' then 'Monday'
+      when 'T' then 'Tuesday'
+      when 'W' then 'Wednesday'
+      when 'R' then 'Thursday'
+      when 'F' then 'Friday'
+      else letter
+      end
+    end
+
+    def short_day_name(day)
+      case day.capitalize
+      when 'M', 'Monday'    then 'Mon'
+      when 'T', 'Tuesday'   then 'Tue'
+      when 'W', 'Wednesday' then 'Wed'
+      when 'R', 'Thursday'  then 'Thu'
+      when 'F', 'Friday'    then 'Fri'
+      else day
+      end
+    end
+
+    def number_from_day(day)
+      case day.capitalize
+      when 'M', 'Monday'    then 1
+      when 'T', 'Tuesday'   then 2
+      when 'W', 'Wednesday' then 3
+      when 'R', 'Thursday'  then 4
+      when 'F', 'Friday'    then 5
+      end
+    end
+  end
+end

data/lib/martlet/grade.rb

@@ -0,0 +1,21 @@
+module Martlet
+	class Grade
+		include Comparable
+
+		attr_reader :letter
+
+		def initialize(letter)
+			@letter = letter.upcase
+		end
+
+		def <=>(other)
+			letters.index(letter) <=> letters.index(other.letter)
+		end
+
+		private
+
+		def letters
+			%w{P S R CO A A- B+ B B- C+ C D F U HH J K KE K* KF IC KK L LE L* NA && NE NR W WF WL W-- -- IP Q}
+		end
+	end
+end

data/lib/martlet/schedule.rb

@@ -0,0 +1,38 @@
+module Martlet
+  class Schedule
+    def initialize(agent, semester, year)
+      @agent    = agent
+      @semester = semester
+      @year     = year
+      @html     = fetch_schedule_html
+    end
+
+    def fetch_courses
+      parser = ScheduleParser.new(@html)
+      parser.parse_courses
+    end
+
+    private
+
+    def schedule_url
+      'https://horizon.mcgill.ca/pban1/bwskfshd.P_CrseSchdDetl'
+    end
+
+    def number_from_semester(semester)
+      case semester.to_s.downcase
+      when 'winter' then '01'
+      when 'summer' then '05'
+      when 'fall'   then '09'
+      end
+    end
+
+    def schedule_params
+      { 'term_in' => "#{@year}#{number_from_semester(@semester)}" }
+    end
+
+    def fetch_schedule_html
+      page = @agent.post(schedule_url, schedule_params)
+      page.body
+    end
+  end
+end

data/lib/martlet/schedule_parser.rb

@@ -0,0 +1,45 @@
+module Martlet
+  class ScheduleParser
+    def initialize(html)
+      @html = html
+    end
+
+    def parse_courses
+      courses = []
+      document = Nokogiri::HTML(@html)
+      course_tables = document.search("br+table[@class='datadisplaytable']")
+      course_times  = document.search("br+table[@class='datadisplaytable']+table tr+tr")
+
+      course_tables.each_with_index do |table, index|
+        course_name_info = table.search('caption').first
+        course_name_info = course_name_info.text.split(' - ')
+        course_name = course_name_info[0]
+        course_number = course_name_info[1]
+
+        course_time_info = course_times[index].search('td').map { |d| d.text.strip }
+
+        course_data = table.search('tr td').map { |d| d.text.strip }
+        args = {
+          name:        course_name,
+          number:      course_number,
+          term:        course_data[0],
+          crn:         course_data[1],
+          instructor:  course_data[3],
+          credits:     course_data[5],
+          level:       course_data[6],
+          campus:      course_data[7],
+          time:        course_time_info[0],
+          days:        course_time_info[1],
+          location:    course_time_info[2],
+          date_range:  course_time_info[3],
+          type:        course_time_info[4],
+          instructors: course_time_info[5]
+        }
+
+        courses << Course.new(args)
+      end
+
+      courses
+    end
+  end
+end

data/lib/martlet/version.rb

@@ -1,3 +1,3 @@
 module Martlet
-  VERSION = "0.0.5"
+  VERSION = "0.0.6"
 end

data/lib/martlet.rb

@@ -1,8 +1,13 @@
 require 'martlet/client'
 require 'martlet/authenticator'
+require 'martlet/day_conversions'
 require 'martlet/transcript'
 require 'martlet/transcript_parser'
+require 'martlet/schedule'
+require 'martlet/schedule_parser'
 require 'martlet/record'
+require 'martlet/grade'
+require 'martlet/course'
 require 'martlet/version'
 
 module Martlet

data/martlet.gemspec

@@ -20,6 +20,8 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
+  spec.add_development_dependency "pry"
   
   spec.add_dependency "mechanize", "~> 2.7"
+  spec.add_dependency "thor", "~> 0.19.1"
 end

metadata

@@ -1,64 +1,85 @@
 --- !ruby/object:Gem::Specification
 name: martlet
 version: !ruby/object:Gem::Version
-  version: 0.0.5
-  prerelease: 
+  version: 0.0.6
 platform: ruby
 authors:
 - Alex Coco
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-27 00:00:00.000000000 Z
+date: 2014-04-18 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: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    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'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.19.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.19.1
 description: Ruby client for McGill's student portal, Minerva.
 email:
 - hello@alexcoco.com
@@ -67,7 +88,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -75,8 +96,14 @@ files:
 - bin/martlet
 - lib/martlet.rb
 - lib/martlet/authenticator.rb
+- lib/martlet/cli.rb
 - lib/martlet/client.rb
+- lib/martlet/course.rb
+- lib/martlet/day_conversions.rb
+- lib/martlet/grade.rb
 - lib/martlet/record.rb
+- lib/martlet/schedule.rb
+- lib/martlet/schedule_parser.rb
 - lib/martlet/transcript.rb
 - lib/martlet/transcript_parser.rb
 - lib/martlet/version.rb
@@ -84,26 +111,25 @@ files:
 homepage: https://github.com/alexcoco/martlet
 licenses:
 - MIT
+metadata: {}
 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
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Client for McGill's student portal
 test_files: []