mcgill-utils 0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 72cd10f584b18762fbb9c4c01e117e5e196e8d88
+  data.tar.gz: f770ae27a72525e4072659c2b17708ad7e283d42
+SHA512:
+  metadata.gz: 2bce9b8ee0f882cb4002e102b2bacc69f12fe7cb90b897a2969d2aa5578e4d46c98c49a0e8a0177f334922805387533f346adf6c3ccd5ac6c5c91e1c4a54747f
+  data.tar.gz: 75eb3dc7570f61a1f61cc415606f3eae6eac3231aa7f06f583909e3c2f4d5b1e805df8dcfdd6ca49266da7b8d064b52a3c03ba943fa4fbefc923a9e0c7aaf039

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2014 Noah Lackstein
+
+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,63 @@
+# McGill Utilities
+
+## Description
+
+Crawl McGill's website and the Visual Schedule Builder to determine which courses are being offered and information (professor, timing, capacity) for each section/
+
+## Installation
+
+    $ sudo gem install mcgill-utils
+
+## Usage
+
+So far, the gem only encapsulates the Visual Schedule Builder API in order to provide a list of sections available for each course, along with the professor and timing, etc, of each section.
+
+You need to provide the semester and a list of courses you're interested in. The semester is formated YYYYMM, where the month is either 05 for Summer, 09 for Fall, or 01 for Winter. Courses are formatted `CODE-###`, e.g., `MGCR-293`. Multiple courses can be given at once, either as multiple parameters or as an array.
+
+    > courses = McGill::VSB.new 201409, 'MGCR-293', 'FINE-441', 'COMP-202'
+
+or
+
+    > courses = McGill::VSB.new 201409, ['MGCR-293', 'FINE-449', 'COMP-202']
+
+To get information about each courses section, call `#sections`
+
+    > courses.sections
+    => {"FINE-449"=>
+       [{:crn=>"8270",
+         :kind=>"Lec",
+         :waitlist=>false,
+         :teacher=>"di Pietro, Vadim",
+         :times=>["Thursday 6:05 PM - 8:55 PM, Sep 2 to Dec 3"],
+         :notes=>"Enrolment limited by program \nJoint BCom/MBA course."}],
+         #...
+    }
+
+To check whether it's possible to register for any of the sections, call `#availability`. You'll get back a hash with the crn of the section as the key. If the section has a waitlist, then a result of `true` means that there is space for you to join the waitlist. If there's no waitlist, then `true` means you can join the section immediately. A result of `false` always means that the section, and waitlist if applicable, are full.
+
+    > courses.availability
+    => {"BUSA-465"=>{10097=>true}, "COMP-202"=>{823=>true, 824=>false, 825=>false}}
+
+## License
+
+This software is licensed under the MIT license.
+
+Copyright (c) 2014 Noah Lackstein
+
+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/lib/mcgill-utils.rb

@@ -0,0 +1,3 @@
+require "nokogiri"
+require "open-uri"
+require "mcgill/vsb"

data/lib/mcgill/vsb.rb

@@ -0,0 +1,134 @@
+module McGill
+  class VSB
+    DAYS = {
+      '1' => 'Sunday',
+      '2' => 'Monday',
+      '3' => 'Tuesday',
+      '4' => 'Wednesday',
+      '5' => 'Thursday',
+      '6' => 'Friday',
+      '7' => 'Saturday'
+    }
+    
+    # Session is the date formated as YYYYMM that the semester starts, eg 201309
+    # Courses is an array of courses formated like, eg, ['MCGR-293', 'COMP-202']
+    def initialize(session, *courses)
+      @session, @courses = session, courses
+      
+      # We expect a 1-dimensional array of courses, but for convenience we also
+      # accept a list of courses as strings with the splat. In this case, we
+      # need to flatten the array
+      @courses = @courses.flatten
+      
+      # Not much we can do if we aren't given any courses to look up
+      # Raise an exception and let the caller know they're doing it wrong
+      raise ArgumentError, "At least one course must be given" if @courses.empty?
+      
+      # Visual Schedule Builder expects all the course codes to be uppercase
+      @courses.map!(&:upcase)
+      
+      @results = Nokogiri::XML(open(build_url))
+    end
+  
+    # Returns a hash, the keys are the course codes, the values an array of sections
+    # {"FINE-449"=>
+    #   [{:crn=>"8270",
+    #     :kind=>"Lec",
+    #     :waitlist=>false,
+    #     :teacher=>"di Pietro, Vadim",
+    #     :times=>["Thursday 6:05 PM - 8:55 PM, Sep 2 to Dec 3"],
+    #     :notes=>"Enrolment limited by program \nJoint BCom/MBA course."}]
+    # }
+    def sections
+      @courses.inject({}) do |course_list, course|
+        section_list = @results.xpath("//selection[contains(@key, '#{course}')]").inject([]) do |list, section|
+          section.xpath('block').each do |block|
+            # If there are no scheduled courses, give a blank array
+            timeblocks = block['timeblockids'].split(',') rescue []
+            times_list = timeblocks.inject([]) do |times, timeblock_id|
+              timeblock = @results.at_xpath("//timeblock[@id=#{timeblock_id}]")
+        
+              start_time = format_time(timeblock['t1'])
+              end_time = format_time(timeblock['t2'])
+        
+              times.push "#{DAYS[timeblock['day']]} #{start_time} - #{end_time}, #{timeblock['s']}"
+              times
+            end
+      
+            section_info = {
+              crn: block['key'],
+              kind: block['type'],
+              waitlist: block['wc'].to_i > 0,
+              teacher: block['teacher'].empty? ? "TBA" : block['teacher'],
+              times: times_list.empty? ? [] : times_list,
+              notes: block['n'].empty? ? "" : block['n'].gsub("<br/>","\n").strip
+            }
+      
+            list.push section_info
+          end
+          list
+        end
+        course_list[course] = section_list.uniq
+        course_list
+      end
+    end
+  
+    # Checks whether there are seats available, or if not then whether there are open spots on the waitlist
+    # Returns a Hash of Courses, each Course is a Hash of CRNs with values true (open) or false (closed)
+    # {"BUSA-465"=>{10097=>false}, "COMP-202"=>{823=>false, 824=>false, 825=>false}}
+    def availability
+      @courses.inject({}) do |course_list, course|
+        section_list = @results.xpath("//selection[contains(@key, '#{course}')]").inject({}) do |list, section|
+          section.xpath('block').each do |block|
+            # seats is either 1 (available) or 0 (full), to_bool checks if it's 1
+            # If there are available seats, and wc is 0, then there's no waitlist and you can register
+            if section['seats'].to_i == 1 && block['wc'].to_i == 0
+              section_open = true
+            # If wc > 0 and ws > 0, there's a waitlist, and there's space available on it, so you can register
+            elsif block['wc'].to_i > 0 && block['ws'].to_i > 0
+              section_open = true
+            else
+              section_open = false
+            end
+        
+            list[block['key']] = section_open
+          end
+          list
+        end
+        course_list[course] = section_list
+        course_list
+      end
+    end
+  
+    private
+    # Builds the URL used by Visual Schedule Builder to get class information
+    # The URL for COMP-202 in 201309 would be
+    # https://vsb.mcgill.ca/resultset.jsp?session_201309=1&course_0_0=COMP-202&sa_0_0=tm&dropdown_0_0=al&td_0_0_0=201309
+    def build_url
+      url = "https://vsb.mcgill.ca/resultset.jsp?session_#{@session}=1"
+      @courses.each_with_index do |course, index|
+        url << "&course_#{index}_0=#{course}&sa_#{index}_0=tm&dropdown_#{index}_0=al&td_#{index}_0_0=#{@session}"
+      end
+
+      url
+    end
+    
+    # VSB encodes time as the number of minutes since midnight
+    # This function converts it to the more human readable hour:min am/pm
+    def format_time(minutes)
+      hour = minutes.to_i / 60
+      min = "%02d" % (minutes.to_i % 60)
+      
+      if hour > 12
+        hour -= 12
+        ampm = 'PM'
+      elsif hour == 12
+        ampm = 'PM'
+      else
+        ampm = 'AM'
+      end
+      
+      "#{hour}:#{min} #{ampm}"
+    end
+  end
+end

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification
+name: mcgill-utils
+version: !ruby/object:Gem::Version
+  version: '0.2'
+platform: ruby
+authors:
+- Noah Lackstein
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: |2
+      Crawl McGill's website and the Visual Schedule Builder to determine which
+      courses are being offered and information (professor, timing, capacity) for each section
+email: noah@lackstein.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/mcgill/vsb.rb
+- lib/mcgill-utils.rb
+- LICENSE
+- README.md
+homepage: http://github.com/lackstein/mcgill
+licenses:
+- MIT
+metadata: {}
+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: []
+rubyforge_project: 
+rubygems_version: 2.1.11
+signing_key: 
+specification_version: 4
+summary: Retrieve information for courses being offered by McGill
+test_files: []