martlet 0.0.6 → 0.0.7

checksums.yaml

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

data/.gitignore

@@ -15,3 +15,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+.DS_Store

data/bin/martlet

@@ -1,6 +1,5 @@
 #!/usr/bin/env ruby
-$:.unshift File.join File.dirname(__FILE__), '..', 'lib'
-require 'rubygems'
+
 require 'martlet'
 require 'martlet/cli'
 

data/lib/martlet/calendar_exporter.rb

@@ -0,0 +1,66 @@
+module Martlet
+  class CalendarExporter
+    include CalendarHelpers
+
+    def initialize(filename, courses)
+      @filename = filename
+      @courses  = courses
+    end
+
+    def export
+      f = File.new(@filename, 'w')
+      f.write("BEGIN:VCALENDAR\r\n")
+
+      @courses.each do |course|
+        course.meetings.each do |meeting|
+          if meeting.start_time
+            f.write(calendar_vevent(course, meeting))
+          else
+            puts "Warning: schedule information unavailable for #{course.number}"
+          end
+        end
+      end
+
+      f.write("END:VCALENDAR\r\n")
+    ensure
+      f.close
+    end
+
+    private
+
+    def calendar_dtstart(meeting)
+      event_date = calendar_date(meeting.start_date)
+      start_time = calendar_time(meeting.start_time)
+      "#{event_date}T#{start_time}"
+    end
+
+    def calendar_dtend(meeting)
+      event_date = calendar_date(meeting.start_date)
+      end_time   = calendar_time(meeting.end_time)
+      "#{event_date}T#{end_time}"
+    end
+
+    def calendar_rrule(meeting)
+      end_date    = calendar_date(meeting.end_date)
+      repeat_days = calendar_days(meeting.days)
+      "FREQ=WEEKLY;INTERVAL=1;UNTIL=#{end_date}T235959;BYDAY=#{repeat_days}"
+    end
+
+    def calendar_vevent(course, meeting)
+      begin_vevent = "BEGIN:VEVENT\r\n"
+      summary      = "SUMMARY:#{course.number} - #{course.name}\r\n"
+      location     = "LOCATION:#{meeting.location}\r\n"
+      dtstart      = "DTSTART:#{calendar_dtstart(meeting)}\r\n"
+      dtend        = "DTEND:#{calendar_dtend(meeting)}\r\n"
+      rrule        = "RRULE:#{calendar_rrule(meeting)}\r\n"
+      end_vevent   = "END:VEVENT\r\n"
+
+      if exclude_first_day?(meeting)
+        exdate = "EXDATE:#{calendar_dtstart(meeting)}\r\n"
+        [begin_vevent, summary, location, dtstart, dtend, rrule, exdate, end_vevent].join('')
+      else
+        [begin_vevent, summary, location, dtstart, dtend, rrule, end_vevent].join('')
+      end
+    end
+  end
+end

data/lib/martlet/calendar_helpers.rb

@@ -0,0 +1,40 @@
+module Martlet
+  module CalendarHelpers
+    include DayConversions
+
+    def calendar_time(time)
+      sprintf "%02d%02d00", time.hour, time.min
+    end
+
+    def calendar_date(date)
+      sprintf "%04d%02d%02d", date.year, date.month, date.day
+    end
+
+    def calendar_day(day)
+      case day.capitalize
+      when 'Sunday'    then 'SU'
+      when 'Monday'    then 'MO'
+      when 'Tuesday'   then 'TU'
+      when 'Wednesday' then 'WE'
+      when 'Thursday'  then 'TH'
+      when 'Friday'    then 'FR'
+      when 'Saturday'  then 'SA'
+      end
+    end
+
+    def calendar_days(days)
+      repeat_days = days.map { |day| calendar_day(day) }
+      repeat_days.join(',')
+    end
+
+    def in_days?(date, days)
+      wday  = date.wday
+      wdays = days.map { |day| number_from_day(day) }
+      wdays.include?(wday)
+    end
+
+    def exclude_first_day?(meeting)
+      !in_days?(meeting.start_date, meeting.days)
+    end
+  end
+end

data/lib/martlet/cli.rb

@@ -7,7 +7,7 @@ module Martlet
     default_task :grades
 
     desc "grades", "Lists all your grades"
-    method_option :sort, aliases: 's', enum: ['course', 'grade']
+    option :sort, aliases: 's', enum: ['course', 'grade']
     def grades
       puts 'Fetching grades...'
       grades = client.grades
@@ -24,13 +24,16 @@ module Martlet
     end
 
     desc "courses SEMESTER YEAR", "List current courses or courses for given semester and year"
+    option :export, type: :boolean, default: false,
+                    desc: "Export course schedule as an iCalendar (.ics) file in the current directory"
     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)
+      schedule = client.schedule(semester, year)
+      courses = schedule.fetch_courses
       course_name_size = courses.map { |c| c.name.length }.max
 
       puts "#{semester.capitalize} #{year} courses"
@@ -41,6 +44,12 @@ module Martlet
       end
 
       puts 'No courses found' if courses.empty?
+
+      if options[:export] && !courses.empty?
+        filename = "#{semester}_#{year}.ics"
+        puts "Exporting courses to #{filename}..."
+        client.export_calendar(filename, courses)
+      end
     end
 
     private

data/lib/martlet/client.rb

@@ -17,9 +17,17 @@ module Martlet
       transcript.fetch_grades
     end
 
+    def schedule(semester, year)
+      Schedule.new(@agent, semester, year)
+    end
+
     def courses(semester, year)
-      schedule = Schedule.new(@agent, semester, year)
-      schedule.fetch_courses
+      schedule(semester, year).fetch_courses
+    end
+
+    def export_calendar(filename, courses)
+      exporter = CalendarExporter.new(filename, courses)
+      exporter.export
     end
   end
 end

data/lib/martlet/course.rb

@@ -1,9 +1,6 @@
 module Martlet
   class Course
-    include DayConversions
-
-    attr_accessor :name, :number, :term, :crn, :instructor, :credits, :level, :campus,
-                  :time, :days, :location, :date_range, :type, :instructors
+    attr_accessor :name, :number, :term, :crn, :instructor, :credits, :level, :campus, :meetings
 
     def initialize(args)
       @name        = args[:name] || ''
@@ -14,15 +11,13 @@ module Martlet
       @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]
+      @meetings    = args[:meetings]
 
       @name.gsub! /\.$/, ''
-      @days = @days.split('').map { |letter| day_from_letter(letter) }
+    end
+
+    def location
+      meetings.first.location
     end
   end
-end
+end

data/lib/martlet/course_meeting.rb

@@ -0,0 +1,14 @@
+module Martlet
+  class CourseMeeting
+    attr_reader :start_time, :end_time, :start_date, :end_date, :days, :location
+
+    def initialize(args)
+      @start_time = args[:start_time]
+      @end_time   = args[:end_time]
+      @start_date = args[:start_date]
+      @end_date   = args[:end_date]
+      @days       = args[:days]
+      @location   = args[:location]
+    end
+  end
+end

data/lib/martlet/schedule.rb

@@ -1,5 +1,7 @@
 module Martlet
   class Schedule
+    attr_reader :semester, :year
+
     def initialize(agent, semester, year)
       @agent    = agent
       @semester = semester

data/lib/martlet/schedule_parser.rb

@@ -1,25 +1,44 @@
 module Martlet
   class ScheduleParser
+    include DayConversions
+
     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_times  = document.search("br+table[@class='datadisplaytable']+table tr")
+      course_times  = split_course_times(course_times)
 
-      course_tables.each_with_index do |table, index|
+      courses = course_tables.map.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 = {
+        course_time_info = course_times[index].map do |course_time|
+          course_time.search('td').map { |d| d.text.strip }
+        end
+
+        meetings = course_time_info.map do |course_time|
+          start_time, end_time = parse_time_range(course_time[0])
+          start_date, end_date = parse_date_range(course_time[3])
+          days = parse_days(course_time[1])
+
+          CourseMeeting.new({
+            start_time:  start_time,
+            end_time:    end_time,
+            start_date:  start_date,
+            end_date:    end_date,
+            days:        days,
+            location:    course_time[2]
+          })
+        end
+
+        Course.new({
           name:        course_name,
           number:      course_number,
           term:        course_data[0],
@@ -28,18 +47,41 @@ module Martlet
           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)
+          meetings:    meetings
+        })
+      end
+    end
+
+    private
+
+    def split_course_times(course_times)
+      split = []
+      course_times.each do |info|
+        if headers?(info)
+          split << []
+        else
+          split.last << info
+        end
       end
+      split
+    end
+
+    def headers?(row)
+      !row.search('th').empty?
+    end
+
+    def parse_time_range(time_range)
+      times = time_range.scan(/\d+:\d+\s[AP]M/)
+      times.map { |time| Time.parse(time) }
+    end
+
+    def parse_date_range(date_range)
+      dates = date_range.scan(/\w+\s\d+,\s\d+/)
+      dates.map { |date| Date.parse(date) }
+    end
 
-      courses
+    def parse_days(days)
+      days.split('').map { |letter| day_from_letter(letter) }
     end
   end
-end
+end

data/lib/martlet/version.rb

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

data/lib/martlet.rb

@@ -5,9 +5,12 @@ require 'martlet/transcript'
 require 'martlet/transcript_parser'
 require 'martlet/schedule'
 require 'martlet/schedule_parser'
+require 'martlet/calendar_helpers'
+require 'martlet/calendar_exporter'
 require 'martlet/record'
 require 'martlet/grade'
 require 'martlet/course'
+require 'martlet/course_meeting'
 require 'martlet/version'
 
 module Martlet

data/martlet.gemspec

@@ -19,9 +19,8 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "bundler", "~> 1.3"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "pry"
+  spec.add_development_dependency "rake", "~> 10.3"
   
   spec.add_dependency "mechanize", "~> 2.7"
-  spec.add_dependency "thor", "~> 0.19.1"
+  spec.add_dependency "thor", "~> 0.19"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: martlet
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - Alex Coco
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-18 00:00:00.000000000 Z
+date: 2014-08-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -28,30 +28,16 @@ dependencies:
   name: rake
   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: pry
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.3'
 - !ruby/object:Gem::Dependency
   name: mechanize
   requirement: !ruby/object:Gem::Requirement
@@ -72,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.19.1
+        version: '0.19'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.19.1
+        version: '0.19'
 description: Ruby client for McGill's student portal, Minerva.
 email:
 - hello@alexcoco.com
@@ -96,9 +82,12 @@ files:
 - bin/martlet
 - lib/martlet.rb
 - lib/martlet/authenticator.rb
+- lib/martlet/calendar_exporter.rb
+- lib/martlet/calendar_helpers.rb
 - lib/martlet/cli.rb
 - lib/martlet/client.rb
 - lib/martlet/course.rb
+- lib/martlet/course_meeting.rb
 - lib/martlet/day_conversions.rb
 - lib/martlet/grade.rb
 - lib/martlet/record.rb