mitchellh-rubyuw 0.4.0 → 0.4.1

data/.gitignore

@@ -1 +1,2 @@
-pkg/*
+pkg/*
+test/password.rb

data/Rakefile

@@ -13,3 +13,27 @@ begin
 rescue LoadError
   puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
 end
+
+def run_tests(files)
+  require File.join(File.dirname(__FILE__), 'lib', 'myuw')
+  require 'test/unit'
+  require "contest"
+  require "stories"
+  require "mocha"
+  files.each { |f| require f }
+end
+
+namespace :test do
+  desc "Run all the tests" 
+  task :run => [:run_mock, :run_live]
+  
+  desc "Run the library test on fixtured data"
+  task :run_mock do
+    run_tests(Dir[File.join(File.dirname(__FILE__), 'test', 'mocked', '**', '*.rb')])
+  end
+  
+  desc "Run the library tests on live data (requires password.rb file). NOTE: This method is very slow."
+  task :run_live do
+    run_tests(Dir[File.join(File.dirname(__FILE__), 'test', 'live', '**', '*.rb')])
+  end
+end

data/VERSION

@@ -1 +1 @@
-0.4.0
+0.4.1

data/lib/myuw.rb

@@ -8,11 +8,7 @@ require 'myuw/sln'
 
 class MyUW
   extend Forwardable
-  
-  ##
-  # The version of the ruby MyUW automation class
-  VERSION = '0.1'
-  
+
   attr_accessor :browser
   attr_accessor :session
   

data/lib/myuw/session.rb

@@ -18,16 +18,9 @@ class MyUW
     # verifies by going to the MyUW homepage and seeing if the
     # dashboard loads. 
     def logged_in?
-      home = @myuw.browser.get("http://myuw.washington.edu")
-      
-      # Click the login button to hopefully get to the main MyUW
-      # page
-      entry_button = home.search("//input[@type='submit' and @value='Log in with your UW NetID']")
-      raise("Failed to find the log in button") if entry_button.empty?
-      
+      home = get_bare_login_page
       relay_page = home.form_with(:name => 'f').submit()
-      welcome_msg = relay_page.search("span.greetingw")
-      return !welcome_msg.empty?
+      !relay_page.search("span.greetingw").empty?
     end
     
     # Logs a user in using the given email and password
@@ -66,19 +59,30 @@ class MyUW
     
     private
     
-    def get_login_page
+    # Gets the myuw.washington.edu homepage. It raises an error
+    # if it cannot find the login button (meaning something
+    # weird is going on)
+    def get_bare_login_page
       home = @myuw.browser.get("http://myuw.washington.edu")
       
       # Click the login button to get to the forum
       entry_button = home.search("//input[@type='submit' and @value='Log in with your UW NetID']")
       raise("Failed to find the log in button") if entry_button.empty?
       
+      home
+    end
+    
+    # Gets the actual login page by pressing the "Log In"
+    # button and following the relay
+    def get_login_page
+      home = get_bare_login_page
       entry_form = home.form_with(:name => 'f')
       relay_page = entry_form.submit()
       
       return follow_relay_page(relay_page)
     end
     
+    # Follows a relay form
     def follow_relay_page(relay_page)
       relay_form = relay_page.form_with(:name => 'relay')
       relay_form.submit()

data/lib/myuw/sln.rb

@@ -30,16 +30,48 @@ class MyUW
     # Fetches the information for the given SLN. 
     def fetch_data
       raise("SLN not set.") if @sln.nil?
+      raise("Term not set.") if @term.nil?
       raise("User must be logged in to fetch SLN data") unless @myuw.logged_in?
       
+      # Request the actual page
+      page = get_sln_page
+      
+      # Get the actual course information
+      get_course_info page
+      get_enrollment_info page
+      get_course_notes page
+    end
+
+    # The methods to extract various info out of the SLN. While
+    # I tend to try to avoid metaprogramming, this case seemed
+    # simple enough. Nothing tricky happening here!
+    [:course, :section, :type, :credits, :title, :current_enrollment, 
+    :limit_enrollment, :room_capacity, :space_available, :status,
+    :notes].each do |info|
+      eval(<<-eomethod)
+        def #{info}
+          fetch_data if @data.nil?
+          @data[:#{info}]
+        end
+      eomethod
+    end
+    
+    # Gets the SLN info page for the SLN and term, raising
+    # an exception if it is requested too soon
+    def get_sln_page
       page = @myuw.browser.get("https://sdb.admin.washington.edu/timeschd/uwnetid/sln.asp?QTRYR=#{@term}&SLN=#{@sln}")
-      if page.uri == "http://www.washington.edu/students/timeschd/badrequest.html" then
+      if page.uri.to_s == "http://www.washington.edu/students/timeschd/badrequest.html"
         raise("Attempted to fetch SLN data too soon.")
+      elsif page.body.to_s =~ /SLN: #{@sln} does not exist./
+        raise("SLN does not exist.")
       end
       
-      # Get the SLN information. I use a pretty sneaky xpath query
-      # here which is VERY LIKELY to break given any changes to the
-      # design of UW time schedules
+      page
+    end
+    
+    # Gets the basic SLN info (the top table in the
+    # current status page)
+    def get_course_info(page)
       info_nodes = page.search("//table[@border=1 and @cellpadding=3]//tr[@rowspan=1]//td")
       
       data_order = [nil, :course, :section, :type, :credits, :title]
@@ -49,14 +81,15 @@ class MyUW
         
           unless data_key.nil?
             @data ||= {}
-            @data[data_key] = node.inner_text.strip
+            @data[data_key] = node.inner_text.strip.gsub("\302\240", "")
           end
         end
       end
-      
-      # Get the enrollment information. Uses a pretty complicated
-      # xpath query once again which is likely to break given any
-      # changes to the design of the UW time schedules.
+    end
+    
+    # Gets the enrollment information for an SLN such
+    # as current enrollment, space available, etc.
+    def get_enrollment_info(page)
       info_nodes = page.search("//table[@border=1 and @cellpadding=3]//tr[count(td)=5]//td")
       
       data_order = [:current_enrollment, :limit_enrollment, :room_capacity, :space_available, :status]
@@ -66,30 +99,17 @@ class MyUW
           
           unless data_key.nil?
             @data ||= {}
-            @data[data_key] = node.inner_text.strip
+            @data[data_key] = node.inner_text.strip.gsub("\302\240", "")
           end
         end
       end
-      
-      # And finally getting the notes of an SLN, accompanied by
-      # by far the ugliest xpath query yet.
+    end
+    
+    # Gets the notes for a course
+    def get_course_notes(page)
       info_nodes = page.search("//table[@border=1 and @cellpadding=3]//tr[count(td)=1]//preceding-sibling::tr[count(th)=1]//following-sibling::tr//td")
       @data ||= {}
       @data[:notes] = info_nodes[0].inner_text.strip
     end
-
-    # The methods to extract various info out of the SLN. While
-    # I tend to try to avoid metaprogramming, this case seemed
-    # simple enough. Nothing tricky happening here!
-    [:course, :section, :type, :credits, :title, :current_enrollment, 
-    :limit_enrollment, :room_capacity, :space_available, :status,
-    :notes].each do |info|
-      eval(<<-eomethod)
-        def #{info}
-          fetch_data if @data.nil?
-          @data[:#{info}]
-        end
-      eomethod
-    end
   end
 end

data/rubyuw.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{rubyuw}
-  s.version = "0.4.0"
+  s.version = "0.4.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Mitchell Hashimoto"]
-  s.date = %q{2009-06-26}
+  s.date = %q{2009-06-27}
   s.description = %q{TODO}
   s.email = %q{mitchell.hashimoto@gmail.com}
   s.extra_rdoc_files = [
@@ -20,7 +20,24 @@ Gem::Specification.new do |s|
      "lib/myuw.rb",
      "lib/myuw/session.rb",
      "lib/myuw/sln.rb",
-     "rubyuw.gemspec"
+     "rubyuw.gemspec",
+     "test/live/session_test.rb",
+     "test/live/sln_test.rb",
+     "test/live/test_helper.rb",
+     "test/mocked/fixture_pages/bad_request.html",
+     "test/mocked/fixture_pages/logged_in_relay.html",
+     "test/mocked/fixture_pages/login.html",
+     "test/mocked/fixture_pages/no_form_login.html",
+     "test/mocked/fixture_pages/no_login_button.html",
+     "test/mocked/fixture_pages/not_logged_in_relay.html",
+     "test/mocked/fixture_pages/sln_does_not_exist.html",
+     "test/mocked/fixture_pages/sln_status.html",
+     "test/mocked/fixture_pages/welcome.html",
+     "test/mocked/myuw_test.rb",
+     "test/mocked/session_test.rb",
+     "test/mocked/sln_test.rb",
+     "test/mocked/test_helper.rb",
+     "test/password.rb.sample"
   ]
   s.has_rdoc = true
   s.homepage = %q{http://github.com/mitchellh/rubyuw}
@@ -28,6 +45,15 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
   s.rubygems_version = %q{1.3.1}
   s.summary = %q{Library which provides a ruby interface to the University of Washington student portal.}
+  s.test_files = [
+    "test/live/session_test.rb",
+     "test/live/sln_test.rb",
+     "test/live/test_helper.rb",
+     "test/mocked/myuw_test.rb",
+     "test/mocked/session_test.rb",
+     "test/mocked/sln_test.rb",
+     "test/mocked/test_helper.rb"
+  ]
 
   if s.respond_to? :specification_version then
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION

data/test/live/session_test.rb

@@ -0,0 +1,34 @@
+require File.join(File.dirname(__FILE__), 'test_helper')
+
+class LiveSessionTest < Test::Unit::TestCase
+  context "live sessions" do
+    setup do
+      @myuw = MyUW.new
+      @session = @myuw.session
+      @session.email = MYUW_ID
+      @session.password = MYUW_PASSWORD
+    end
+    
+    should "report successful login with credentials" do
+      assert @session.login
+    end
+    
+    should "fail login with bad credentials" do
+      @session.password = MYUW_PASSWORD + "bad"
+      assert !@session.login
+      assert !@session.logged_in?
+    end
+    
+    should "report logged_in? once logged in via the session object" do
+      assert @session.login
+      assert @session.logged_in?
+    end
+    
+    should "not report logged_in? once logout is called after logging in" do
+      assert @session.login
+      assert @session.logged_in?
+      @session.logout
+      assert !@session.logged_in?
+    end
+  end
+end

data/test/live/sln_test.rb

@@ -0,0 +1,64 @@
+require File.join(File.dirname(__FILE__), 'test_helper')
+
+class LiveSLNTest < Test::Unit::TestCase
+  context "live SLN info grabbing" do
+    setup do
+      @myuw = MyUW.new
+      @session = @myuw.session
+      @session.email = MYUW_ID
+      @session.password = MYUW_PASSWORD
+      @session.login
+      assert @session.logged_in? # Sanity
+      
+      @sln_info = {
+        :sln      => "17237",
+        :quarter  => "AUT+2009",
+        :info     => {
+          :section  => "AE",
+          :type     => "QZ",
+          :credits  => "",
+          :title    => "INTRO TO LOGIC",
+          :current_enrollment => "25",
+          :limit_enrollment   => "25",
+          :room_capacity      => "40",
+          :space_available    => "",
+          :status             => "** Closed **",
+          :notes              => "Quiz Section"
+        }
+      }
+      
+      @sln = @myuw.sln(@sln_info[:sln], @sln_info[:quarter])
+      assert @sln # Sanity
+    end
+    
+    teardown do
+      sleep(5) # To avoid the timeout problems within tests
+    end
+    
+    should "grab course info for a valid SLN and quarter" do
+      @sln_info[:info].each do |k,v|
+        assert_equal v, @sln.send(k), "#{k} should've been #{v}"
+      end
+    end
+    
+    should "raise an error if requests are back to back too fast" do
+      assert_nothing_raised do
+        @sln.course
+      end
+      
+      @sln.sln = @sln.sln # Force reload
+      
+      assert_raise RuntimeError do
+        @sln.course
+      end
+    end
+    
+    should "raise an error for an invalid SLN/quarter" do
+      @sln.sln = 91919 # Tested to not exist
+      
+      assert_raise RuntimeError do
+        @sln.course
+      end
+    end
+  end
+end

data/test/live/test_helper.rb

@@ -0,0 +1,5 @@
+begin
+  require File.join(File.dirname(__FILE__), '..', 'password')
+rescue LoadError => e
+  abort("Running live tests requires a password.rb file in the test folder with your MyUW credentials.")
+end

data/test/mocked/fixture_pages/bad_request.html

@@ -0,0 +1,80 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0//EN"
+	"http://www.w3.org/TR/REC-html40/strict.dtd">
+<HTML>
+<HEAD>
+<TITLE>Time Schedule Status - Invalid Request
+</TITLE>
+<LINK REL="stylesheet" HREF="/home/home.css"  TYPE="text/css">
+
+</HEAD>
+<BODY>
+
+
+
+
+ 
+
+
+
+
+
+
+
+
+
+
+<div><a href="http://www.washington.edu/"><img id="toplogo" src="/home/graphics/UWlogo150p.gif" alt="University of Washington" /></a></div>
+
+<div id="toolbar">
+    &nbsp;<span class="l1text"><a href="/home/search.html">Search</a> |
+    <a href="/home/directories.html">Directories</a> |
+    <a href="http://www.lib.washington.edu/research/">Reference
+    Tools</a></span></div>
+
+
+<!--Section Banner Table -->
+ 
+ 
+  
+  
+ 
+<div class="bannerwrapper">
+  <div id="topbanner" ><img src="/home/graphics/rib0.gif" width="6" height="16" alt="" /></div>
+</div>
+
+<div id="crumbs"><span class="l1text"><a href="/">UW Home</a> &gt; <a href="/uwin/">UWIN</a> &gt; <a href="/students/">Student Guide</a></span>&nbsp;</div><div class="forceclear"></div>
+
+
+
+
+
+
+
+
+<H1>Time Schedule Status - Invalid Request</H1>
+
+
+<p>Your request was improperly formatted.  Try again.
+</P>
+
+
+
+
+
+
+<div id="footer"><div id="footerseal">
+<a href="http://www.washington.edu/"><img src="/home/graphics/blockw.gif" width="53" height="37" alt="UW Logo" /></a>
+</div>
+<div id="addressright"></div>
+<div id="address"><address>
+	<a href="http://registrar.washington.edu/">Office of the University Registrar</a>, 206-543-5378<br />
+	<a href="mailto:registrar@u.washington.edu">registrar@u.washington.edu</a><br />
+	Modified: January 28, 1998
+</address>
+</div>
+</div>
+
+
+</BODY>
+<HTML>
+<!--Created by chtml 1.48 on Jun 10, 2009 2:59pm-->