rubyuw 0.99.1 → 0.99.2

data/README.md

@@ -20,17 +20,21 @@ with. I do not support this.
 
 RubyUW functions by emulating a human in an actual browser. It hunts
 down buttons to click, fields to fill in, etc. It is programmed
-using the Ruby Mechanize library to achieve this level of human
-simulation.
+using the ruby [mechanize library](http://github.com/tenderlove/mechanize) to achieve 
+this level of human simulation.
 
 Of course this also means that even minor tweaks to the MyUW layout
 could potentially "break" the RubyUW library.
 
 ## Installing
 
+The `rubyuw` gem is hosted on [gemcutter](http://gemcutter.org/). If
+your rubygems isn't updated to use gemcutter yet, please visit their
+website to prepare your rubygems installation prior to running the
+following command. (It takes only a minute)
+
     # Install the gem
-    sudo gem sources -a http://gems.github.com
-    sudo gem install mitchellh-rubyuw
+    sudo gem install rubyuw
 
 ## Using RubyUW
 

data/VERSION

@@ -1 +1 @@
-0.99.1
+0.99.2

data/lib/rubyuw/base.rb

@@ -22,8 +22,8 @@ module RubyUW
       # every feature), will require that this authentication is
       # completed first.
       #
-      # @param [String] UW NetID
-      # @param [String] Password for the UW NetID
+      # @param [String] netid UW NetID
+      # @param [String] password Password for the UW NetID
       # @return [nil]
       def authenticate(netid, password)
         # Clear pre-existing session information first

data/lib/rubyuw/connection.rb

@@ -55,7 +55,7 @@ module RubyUW
     # Flow item: Go to a specific URL. Calling this method will
     # attach a task to the current flow to go to a specific URL.
     #
-    # @param [String] URL to go to (must respond to #to_s)
+    # @param [String] url URL to go to (must respond to #to_s)
     # @return self
     def goto(url)
       current_flow.push([:goto, url])
@@ -67,8 +67,8 @@ module RubyUW
     # parameters may be given as the second argument to be filled into
     # the form.
     #
-    # @param [String] Name of the form.
-    # @param [Hash] Parameters to pass through to the form.
+    # @param [String] name Name of the form.
+    # @param [Hash] parameters Parameters to pass through to the form.
     # @return self
     def submit_form(name, parameters={})
       current_flow.push([:submit_form, name, parameters])
@@ -79,7 +79,7 @@ module RubyUW
     # a task to verify that the given XPath string matches at least one
     # element.
     #
-    # @param [String] XPath of the element(s) to verify existence of.
+    # @param [String] xpath XPath of the element(s) to verify existence of.
     # @return self
     def verify(xpath)
       current_flow.push([:verify, xpath])

data/lib/rubyuw/curriculum_enrollment.rb

@@ -1,6 +1,6 @@
 module RubyUW
   # RubyUW::CurriculumEnrollment is used to extract SLN information
-  # for an entire "curriculum" of courses (whic is how MyUW refers
+  # for an entire "curriculum" of courses (which is how MyUW refers
   # to it). If you have multiple SLNs within the same curriculum
   # (chemistry, computer science, history, etc.), it is more efficient
   # to use the CurriculumEnrollment class rather than SLN.
@@ -24,8 +24,8 @@ module RubyUW
       # directly from the MyUW curriculum information page. Authentication
       # is required prior to use.
       #
-      # @param [String] Curriculum to search for.
-      # @param [String] The term (quarter) to search in.
+      # @param [String] curriculum Curriculum to search for.
+      # @param [String] term The term (quarter) to search in.
       def find(curriculum, term)
         raise Errors::NotLoggedInError.new unless Base.authenticated?
 

data/lib/rubyuw/schedule.rb

@@ -21,7 +21,7 @@ module RubyUW
       # * location
       # * instructor
       #
-      # To get any more details you have to use the {RubyUW::SLN.find}
+      # To get any more details you have to use the {RubyUW::SLN} find
       # method.
       def get
         raise Errors::NotLoggedInError.new unless Base.authenticated?

data/lib/rubyuw/sln.rb

@@ -16,15 +16,14 @@ module RubyUW
   #   sln_info = RubyUW::SLN.find("12345", "AUT+2009")
   class SLN
     attr_reader :sln
-    attr_reader :data
     
     # Initialize a new SLN object. This should never be called on its
     # own, but instead you should use the find method to setup a
     # sln.
     #
-    # @param [String] SLN number in string format.
-    # @param [String] Term that the SLN corresponds to.
-    # @param [Hash] Data of key to value.
+    # @param [String] sln SLN number in string format.
+    # @param [String] term Term that the SLN corresponds to.
+    # @param [Hash] data Data of key to value.
     def initialize(sln, term, data)
       @sln = sln
       @term = term
@@ -34,17 +33,48 @@ module RubyUW
     # Grab the data of the SLN based on a key. Returns the value of
     # a field for the SLN, or nil otherwise. Supported fields coming
     # soon.
-    def data(key)
+    #
+    # == Example:
+    #
+    #   # Assuming @sln has an instance of {RubyUW::SLN} already
+    #   course_name = @sln[:course]
+    #   capacity    = @sln[:room_capacity]
+    #
+    # == Supported fields in alphabetical order:
+    # * *course* - The name of the course
+    # * *credits* - The number of credits the course gives
+    # * *current_enrollment* - Number of students currently enrolled.
+    # * *curriculum* - The curriculum which this course is part of. This field's
+    #   value can be used to query {RubyUW::CurriculumEnrollment}.
+    # * *limit_enrollment* - The maximum (limit) number of students which can be enrolled.
+    # * *notes* - Often a multi-paragraph block of text from the "notes" section
+    #   on the course info page.
+    # * *room_capacity* - The capacity of the classroom.
+    # * *section* - The section of the course. Ex. "A" or "AB"
+    # * *space_available* - 
+    #   Space available at the moment. Note that there is an important difference
+    #   between this and the difference between "limit_enrollment" and
+    #   "current_enrollmemnt." This is because sometimes the university closes
+    #   registration for a day (to open more slots the next day). So even though
+    #   there may be space, there may be no openings for the day. There are other
+    #   reasons as well.
+    # * *status* - Text pulled directly from "status" box on course info page.
+    # * *title* - The name of the course, typically in all caps. Ex. "INTRO TO LOGIC"
+    # * *type* - Type of course. Typically "LC" or "QZ" though others exist
+    def [](key)
       @data[key.to_sym]
     end
     
+    # Aliased for legacy
+    alias :data :[]
+    
     class <<self
       # Finds information about a specific SLN. The SLN information
       # is grabbed from the MyUW time schedule page. Authentication is
       # required prior to use.
       #
-      # @param [#to_s] The SLN, which must respond to #to_s
-      # @param [String] The term, as represented in the time schedule URL.
+      # @param [String, #to_s] sln_number The SLN, which must respond to #to_s
+      # @param [String] term The term, as represented in the time schedule URL.
       # @return [RubyUW::SLN]
       def find(sln_number, term)
         raise Errors::NotLoggedInError.new unless Base.authenticated?
@@ -81,13 +111,35 @@ module RubyUW
           [[:notes], "//table[@border=1 and @cellpadding=3]//tr[count(td)=1]//preceding-sibling::tr[count(th)=1]//following-sibling::tr//td"]
         ]
 
+        # Extract initial data, straight scraping
         data = {}
-        extract_data.each do |keys, xpath|
-          data.merge!(Base.extract(page, xpath, keys))
-        end
+        extract_data.each { |keys, xpath| data.merge!(Base.extract(page, xpath, keys)) }
+
+        # Extract other data which must be massaged
+        extract_curriculum(data)
 
         data
       end
+      
+      # Extracts the "curriculum" from the SLN information. This curriculum
+      # can then be used with {RubyUW::CurriculumEnrollment} to grab multiple
+      # classes within the same curriculum simultaneously.
+      #
+      # The curriculum value used to query the enrollment page appears to
+      # follow the pattern that it is the course category, URL encoded.
+      #
+      # Examples: 
+      # * CHEM 102 = "CHEM"
+      # * C LIT 240 = "C LIT"
+      #
+      # Note that this is subject to change at any time but this method is
+      # well unit tested in both mock and live tests, which should signal
+      # any changes quickly.
+      def extract_curriculum(data)
+        data[:course] =~ /^(.+?)(\d+)$/
+        data[:curriculum] = $1.strip
+        data
+      end
     end
   end
   

data/rubyuw.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{rubyuw}
-  s.version = "0.99.1"
+  s.version = "0.99.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Mitchell Hashimoto"]

data/test/live/sln_test.rb

@@ -11,12 +11,13 @@ class LiveSLNTest < Test::Unit::TestCase
           :type     => "QZ",
           :credits  => "",
           :title    => "INTRO TO LOGIC",
-          :current_enrollment => "25",
+          :current_enrollment => "22",
           :limit_enrollment   => "25",
           :room_capacity      => "40",
-          :space_available    => "",
-          :status             => "** Closed **",
-          :notes              => "Quiz Section"
+          :space_available    => "3",
+          :status             => "Open",
+          :notes              => "Quiz Section",
+          :curriculum         => "PHIL"
         }
       }
     end

data/test/mocked/sln_test.rb

@@ -32,6 +32,43 @@ class SLNTest < Test::Unit::TestCase
         assert_equal v, @sln_obj.data(k.to_s)
       end
     end
+    
+    should "be able to access using []" do
+      @data.each do |k,v|
+        assert_equal v, @sln_obj[k]
+      end
+    end
+  end
+  
+  context "extracting data from SLN page" do
+    setup do
+      mocked_page = RubyUW::Base.connection.get(path_to_html("sln_status"))
+      @data = RubyUW::SLN.extract_data_from_page(mocked_page)
+    end
+    
+    context "extracting 'special' data from page" do
+      context "curriculum" do
+        should "strip any surrounding whitespace and trailing number and return curriculum" do
+          result = RubyUW::SLN.extract_curriculum({ :course => @data[:course]})
+          assert_equal "PHIL", result[:curriculum]
+        end
+        
+        should "extract multiword curriculums" do
+          result = RubyUW::SLN.extract_curriculum({ :course => "C LIT     240"})
+          assert_equal "C LIT", result[:curriculum]
+        end
+        
+        should "modify data in place" do
+          data = { :course => "PHIL 120" }
+          RubyUW::SLN.extract_curriculum(data)
+          assert_equal "PHIL", data[:curriculum]
+        end
+      end
+    end
+    
+    context "extracting typicaly data from page" do
+      # TODO
+    end
   end
   
   context "finding an SLN" do

data/test/mocked/test_helper.rb

@@ -1,4 +1,3 @@
-require 'rubygems'
 $:.unshift(File.join(File.dirname(__FILE__), '..', '..', 'lib'))
 require 'rubyuw'
 require 'test/unit'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: rubyuw
 version: !ruby/object:Gem::Version 
-  version: 0.99.1
+  version: 0.99.2
 platform: ruby
 authors: 
 - Mitchell Hashimoto