mitchellh-rubyuw 0.6.1 → 0.6.2

data/README.markdown

@@ -46,4 +46,35 @@ The following is a quick and simple example:
     myuw.login("netid", "password") or raise("Login Failed!")
     
     # Get SLN information
-    sln_info = myuw.sln(14153)
+    sln_info = myuw.sln(14153)
+    
+    # Get user course schedule
+    schedule = myuw.schedule.schedule
+
+## Testing
+
+RubyUW includes a comprehensive test suite included both live and
+mocked testing. Mocked testing uses "mocked" HTML pages and a lot
+of object stubbing to simulate a real environment and to force
+certain events to occur (such as strange HTML in a request) in order
+to completely test the library. Mock testing can be run straight
+"out of the box" via a rake task:
+
+    rake test:run_mock
+
+RubyUW also includes "live" testing which uses a real UW NetID and
+password to conduct live tests. To run this, see test/password.rb.sample
+and modify it to include your credentials, then save it as password.rb.
+Following this, run another rake task:
+
+    rake test:run_live
+
+Note: Live testing is very very slow. On my machine with the current
+suite it takes about a minute to run all the tests (though this is
+highly dependent on your internet connection).
+
+Note: Also, live testing DOES NOT test registration since that actually
+affects your MyUW account in a significant way. To test registration,
+run the registration test directly:
+
+    cd test/live && ruby registration_test.rb

data/Rakefile

@@ -15,11 +15,6 @@ rescue LoadError
 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
 

data/VERSION

@@ -1 +1 @@
-0.6.1
+0.6.2

data/lib/myuw/sln.rb

@@ -36,6 +36,9 @@ class MyUW
       # Request the actual page
       page = get_sln_page
       
+      # Check if the time is not available
+      check_time_schedule_closed page
+      
       # Get the actual course information
       get_course_info page
       get_enrollment_info page
@@ -72,48 +75,51 @@ class MyUW
     # Gets the basic SLN info (the top table in the
     # current status page)
     def get_course_info(page)
+      data_keys = [nil, :course, :section, :type, :credits, :title]
       info_nodes = page.search("//table[@border=1 and @cellpadding=3]//tr[@rowspan=1]//td")
-      raise InvalidPageError.new(page, "Could not extract course info for SLN.") if info_nodes.empty?
-      
-      data_order = [nil, :course, :section, :type, :credits, :title]
-      info_nodes.each_with_index do |node, i|
-        if i < data_order.length then
-          data_key = data_order[i]
-        
-          unless data_key.nil?
-            @data ||= {}
-            @data[data_key] = node.inner_text.strip.gsub("\302\240", "")
-          end
-        end
-      end
+      raise InvalidPageError.new(page, "Could not extract course info for SLN.") unless extract_info(data_keys, info_nodes)
     end
     
     # Gets the enrollment information for an SLN such
     # as current enrollment, space available, etc.
     def get_enrollment_info(page)
+      data_keys = [:current_enrollment, :limit_enrollment, :room_capacity, :space_available, :status]
       info_nodes = page.search("//table[@border=1 and @cellpadding=3]//tr[count(td)=5]//td")
-      raise InvalidPageError.new(page, "Could not extract enrollment info for SLN.") if info_nodes.empty?
+      raise InvalidPageError.new(page, "Could not extract enrollment info for SLN.") unless extract_info(data_keys, info_nodes)
+    end
+    
+    # Gets the notes for a course
+    def get_course_notes(page)
+      data_keys = [:notes]
+      info_nodes = page.search("//table[@border=1 and @cellpadding=3]//tr[count(td)=1]//preceding-sibling::tr[count(th)=1]//following-sibling::tr//td")
+      raise InvalidPageError.new(page, "Could not find course notes information.") unless extract_info(data_keys, info_nodes)
+    end
+    
+    # Extracts course information from each node and
+    # stores it as the proper key in the @data variable
+    def extract_info(keys, nodes)
+      return false if nodes.empty?
       
-      data_order = [:current_enrollment, :limit_enrollment, :room_capacity, :space_available, :status]
-      info_nodes.each_with_index do |node, i|
-        if i < data_order.length then
-          data_key = data_order[i]
+      nodes.each_with_index do |node, i|
+        # Make sure we have keys left still
+        if i < keys.length then
+          data_key = keys[i]
           
+          # If the key is nil, we skip this node
           unless data_key.nil?
             @data ||= {}
             @data[data_key] = node.inner_text.strip.gsub("\302\240", "")
           end
         end
       end
+      
+      true
     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")
-      raise InvalidPageError.new(page, "Could not find course notes information.") if info_nodes.empty?
-      
-      @data ||= {}
-      @data[:notes] = info_nodes[0].inner_text.strip
+    # Checks if the time schedule system is closed and if
+    # so, raises an exception
+    def check_time_schedule_closed(page)
+      raise TimeScheduleClosedError.new if page.uri.to_s == "http://www.washington.edu/students/timeschd/nots.html"
     end
   end
   
@@ -121,4 +127,5 @@ class MyUW
   # Exceptions
   class InvalidSLNError < StandardError; end
   class RequestSLNTooSoonError < StandardError; end  
+  class TimeScheduleClosedError < StandardError; end
 end

data/rubyuw.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{rubyuw}
-  s.version = "0.6.1"
+  s.version = "0.6.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Mitchell Hashimoto"]
-  s.date = %q{2009-06-29}
+  s.date = %q{2009-07-02}
   s.description = %q{TODO}
   s.email = %q{mitchell.hashimoto@gmail.com}
   s.extra_rdoc_files = [

data/test/mocked/myuw_test.rb

@@ -1,3 +1,5 @@
+require File.join(File.dirname(__FILE__), 'test_helper')
+
 class MyUWTest < Test::Unit::TestCase
   context "initializing a MyUW object" do
     setup do

data/test/mocked/sln_test.rb

@@ -65,25 +65,118 @@ class MockedSlnTest < Test::Unit::TestCase
     should "raise an InvalidPageError if it can't find the course info" do
       fixture_page = @browser.get(path_to_html("sln_no_course_info"))
 
-      assert_raise MyUW::InvalidPageError do
+      e = assert_raise MyUW::InvalidPageError do
         @sln.get_course_info(fixture_page)
       end
+      
+      assert !e.page.nil?
     end
     
     should "raise an InvalidPageError if it can't find the enrollment info" do
       fixture_page = @browser.get(path_to_html("sln_no_enrollment_info"))
 
-      assert_raise MyUW::InvalidPageError do
+      e = assert_raise MyUW::InvalidPageError do
         @sln.get_enrollment_info(fixture_page)
       end
+      
+      assert !e.page.nil?
     end
     
     should "raise an InvalidPageError if it can't find the course notes" do
       fixture_page = @browser.get(path_to_html("sln_no_course_notes"))
 
-      assert_raise MyUW::InvalidPageError do
+      e = assert_raise MyUW::InvalidPageError do
         @sln.get_course_notes(fixture_page)
       end
+      
+      assert !e.page.nil?
+    end
+    
+    should "raise a TimeScheduleClosedError if the time schedule system is closed" do
+      fixture_page = mock()
+      fixture_page.stubs(:uri).returns("http://www.washington.edu/students/timeschd/nots.html")
+      fixture_page.stubs(:body).returns("")
+      @browser.expects(:get).returns(fixture_page)
+      
+      assert_raise MyUW::TimeScheduleClosedError do
+        @sln.course
+      end
+    end
+    
+    should "not raise a TimeScheduleClosedError if the URI doesn't match" do
+      fixture_page = @browser.get(path_to_html("sln_status"))
+      @browser.expects(:get).returns(fixture_page)
+      
+      assert_nothing_raised do
+        @sln.course
+      end
+    end
+  end
+  
+  context "extract info from nodes" do
+    setup do
+      @myuw = MyUW.new
+      @sln = @myuw.sln("123456", "AUT+2009")
+      
+      @keys = [:foo, :bar, :baz]
+      @values = [
+        stub(:inner_text => "vfoo"),
+        stub(:inner_text => "vbar"),
+        stub(:inner_text => "vbaz")
+      ]
+      
+      @long_values = @values.dup
+      @long_values.push(stub(:inner_text => "vbad"))
+      
+      @nil_keys = @keys.dup
+      @nil_keys.push(nil)
+      @nil_keys.push(:bang)
+      
+      @nil_values = @long_values.dup
+      @nil_values.push(stub(:inner_text => "vbang"))
+    end
+    
+    should "return false if there are no nodes" do
+      assert !@sln.extract_info(@keys, [])
+    end
+    
+    should "return true if everything is good" do
+      assert @sln.extract_info(@keys, @values)
+    end
+    
+    should "only extract as long as there are keys left" do
+      assert @sln.extract_info(@keys, @long_values)
+      assert_equal @keys.length, @sln.data.length
+      
+      # It shouldn't get the 4th long value since there are only 3 keys
+      @sln.data.each { |k,v| assert_not_equal @long_values[@keys.length].inner_text, v }
+    end
+    
+    should "extract values and associate them with proper keys" do
+      assert @sln.extract_info(@keys, @values)
+      assert_equal @keys.length, @sln.data.length
+      
+      @sln.data.each do |k,v|
+        assert @keys.include?(k)
+        assert_equal @values[@keys.index(k)].inner_text, v
+      end
+    end
+    
+    should "not store values associated with nil keys" do
+      assert @sln.extract_info(@nil_keys, @nil_values)
+      assert_equal (@nil_keys.length - 1), @sln.data.length
+      
+      @nil_keys.each_index do |i|
+        key = @nil_keys[i]
+        
+        # If the key is nil, it should NOT store the value
+        # at that index, otherwise it should
+        if key.nil?
+          assert !@sln.data.has_value?(@nil_values[i].inner_text)
+        else
+          assert_equal @nil_values[i].inner_text, @sln.data[key]
+        end
+      end
     end
   end
 end

data/test/mocked/test_helper.rb

@@ -1,3 +1,9 @@
+require File.join(File.dirname(__FILE__), '..', '..', 'lib', 'myuw')
+require 'test/unit'
+require "contest"
+require "stories"
+require "mocha"
+
 class Test::Unit::TestCase
   def path_to_html(html)
     "file://" + File.join(File.dirname(__FILE__), 'fixture_pages', "#{html}.html")

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: mitchellh-rubyuw
 version: !ruby/object:Gem::Version 
-  version: 0.6.1
+  version: 0.6.2
 platform: ruby
 authors: 
 - Mitchell Hashimoto
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-06-29 00:00:00 -07:00
+date: 2009-07-02 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency