mitchellh-rubyuw 0.5.0 → 0.6.0

data/VERSION

@@ -1 +1 @@
-0.5.0
+0.6.0

data/lib/myuw/registration.rb

@@ -0,0 +1,98 @@
+class MyUW
+  # = Synopsis
+  # The Registration class can automate the registration
+  # process for a user. It does NOT support initial
+  # setup of the registration process such as verifying
+  # addresses and such (and doesnt plan to, that is
+  # an important step that should be done manually)
+  class Registration
+    attr_accessor :myuw
+    attr_reader :errors
+    
+    def initialize(myuw=nil)
+      @myuw ||= myuw
+      @errors = nil
+    end
+    
+    # Registers for one or more courses. The courses
+    # parameter should be an Array of strings (the
+    # SLNs)
+    def register(courses)
+      raise NotLoggedInError.new("User must be logged in to register for classes.") unless @myuw.logged_in?
+      
+      # Get registration page
+      register_page = @myuw.browser.get("https://sdb.admin.washington.edu/students/uwnetid/register.asp")
+      register_form = register_page.form_with(:name => 'regform')
+      raise InvalidPageError.new(register_page, "Could not verify registration page") if register_form.nil?
+      
+      # Fill in the form
+      fill_registration_form(register_form, courses)
+      
+      # Submit it and analyze result
+      get_registration_result(register_form.submit())
+    end
+    
+    def get_registration_result(result_page)
+      return true if result_page.body =~ /ALT="OK">Schedule updated\./i
+      raise InvalidPageError.new(result_page, "Unknown registration result.") unless result_page.body =~ /ALT="ERROR">Schedule not updated\./i
+      
+      # Otherwise, get the errors out of the result page
+      extract_registration_errors(result_page)
+      false
+    end
+    
+    def extract_registration_errors(result_page)
+      # //input[@type='hidden' and @name='action4']/following-sibling::input[@type='hidden']/following-sibling::td
+      registration_form = result_page.form_with(:name => 'regform')
+      start_index = get_add_section_index(registration_form)
+      current_index = start_index.to_i
+      
+      @errors = {}
+      
+      loop do
+        # Get current SLN, and if its empty, then return out
+        current_sln = registration_form["sln#{current_index}"]
+        return if current_sln.nil? || current_sln.empty?
+        
+        error_cell = result_page.search("//input[@name='action#{current_index}']/parent::tr//td[5]")
+        raise InvalidPageError.new(result_page, "Couldn't extract errors (couldn't get data cells)") if error_cell.empty?
+        
+        error_text = error_cell[0].inner_text.strip.gsub("\302\240", '')
+        @errors[current_sln] = error_text
+        
+        current_index += 1
+      end
+    end
+    
+    def fill_registration_form(register_form, courses)
+      # Determine where to begin adding SLNs (what fields)
+      start_index = get_add_section_index(register_form)
+      
+      current_index = start_index.to_i
+      courses.each do |course|
+        register_form["sln#{current_index}"] = course.to_s
+        current_index += 1
+      end
+    end
+    
+    # The registration page is one giant form.
+    # We need to figure out which index fields
+    # to begin filling in with SLN data. This
+    # method returns the index.
+    def get_add_section_index(register_form)
+      # First way is to add maxadds and maxdrops and
+      # determine the offset.
+      maxdrops = register_form["maxdrops"].to_i
+      index_by_hiddens = maxdrops + 1
+      
+      # Verify by inspecting actions
+      1.upto(11) do |i|
+        # Find the version action with an "A" (meaning add)
+        if register_form["action#{i}"].to_s == "A"
+          raise InvalidPageError.new(nil, "Couldn't determine add offset.") unless i == index_by_hiddens
+          return i.to_s
+        end
+      end
+    end
+  end
+end

data/lib/myuw/schedule.rb

@@ -32,6 +32,9 @@ class MyUW
       
       # Grab the credits
       get_credits schedule_page
+      
+      # Return the courses
+      @courses
     end
     
     def get_courses(schedule)

data/lib/myuw.rb

@@ -7,6 +7,7 @@ require 'myuw/errors'
 require 'myuw/session'
 require 'myuw/sln'
 require 'myuw/schedule'
+require 'myuw/registration'
 
 class MyUW
   extend Forwardable
@@ -14,6 +15,7 @@ class MyUW
   attr_accessor :browser
   attr_accessor :session
   attr_accessor :schedule
+  attr_accessor :registration
   
   def initialize
     # Initialize the browser instance and mascarade
@@ -32,6 +34,7 @@ class MyUW
     # Initialize other members
     @session = Session.new(self)
     @schedule = Schedule.new(self)
+    @registration = Registration.new(self)
   end
   
   # Forward the session methods

data/rubyuw.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{rubyuw}
-  s.version = "0.5.0"
+  s.version = "0.6.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Mitchell Hashimoto"]
-  s.date = %q{2009-06-27}
+  s.date = %q{2009-06-28}
   s.description = %q{TODO}
   s.email = %q{mitchell.hashimoto@gmail.com}
   s.extra_rdoc_files = [
@@ -19,10 +19,12 @@ Gem::Specification.new do |s|
      "VERSION",
      "lib/myuw.rb",
      "lib/myuw/errors.rb",
+     "lib/myuw/registration.rb",
      "lib/myuw/schedule.rb",
      "lib/myuw/session.rb",
      "lib/myuw/sln.rb",
      "rubyuw.gemspec",
+     "test/live/registration_test.rb",
      "test/live/schedule_test.rb",
      "test/live/session_test.rb",
      "test/live/sln_test.rb",
@@ -33,6 +35,12 @@ Gem::Specification.new do |s|
      "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/registration.html",
+     "test/mocked/fixture_pages/registration_error.html",
+     "test/mocked/fixture_pages/registration_error_no_rows.html",
+     "test/mocked/fixture_pages/registration_no_form.html",
+     "test/mocked/fixture_pages/registration_success.html",
+     "test/mocked/fixture_pages/registration_unknown.html",
      "test/mocked/fixture_pages/schedule.html",
      "test/mocked/fixture_pages/schedule_diff_credit_row.html",
      "test/mocked/fixture_pages/schedule_empty.html",
@@ -41,6 +49,7 @@ Gem::Specification.new do |s|
      "test/mocked/fixture_pages/sln_status.html",
      "test/mocked/fixture_pages/welcome.html",
      "test/mocked/myuw_test.rb",
+     "test/mocked/registration_test.rb",
      "test/mocked/schedule_test.rb",
      "test/mocked/session_test.rb",
      "test/mocked/sln_test.rb",
@@ -54,11 +63,13 @@ Gem::Specification.new do |s|
   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/schedule_test.rb",
+    "test/live/registration_test.rb",
+     "test/live/schedule_test.rb",
      "test/live/session_test.rb",
      "test/live/sln_test.rb",
      "test/live/test_helper.rb",
      "test/mocked/myuw_test.rb",
+     "test/mocked/registration_test.rb",
      "test/mocked/schedule_test.rb",
      "test/mocked/session_test.rb",
      "test/mocked/sln_test.rb",

data/test/live/registration_test.rb

@@ -0,0 +1,46 @@
+if $0 != __FILE__
+  puts <<-WORDS
+  Note: Registration tests can only be run by directly
+  invoking the registration_test.rb file in the
+  test/live directory.
+  WORDS
+end
+
+if $0 == __FILE__
+  # Only run tests in this file if we're executing it
+  # on its own
+  require File.join(File.dirname(__FILE__), 'test_helper')
+  
+  class LiveRegistrationTest < Test::Unit::TestCase
+    context "registering for a course" do
+      setup do
+        @myuw = MyUW.new
+        @session = @myuw.session
+        @session.email = MYUW_ID
+        @session.password = MYUW_PASSWORD
+        assert @session.login
+        
+        @schedule = @myuw.schedule
+        @registration = @myuw.registration
+        
+        @good_course = "17697"
+        @bad_courses = ["17778", "17779"]
+      end
+
+      should "successfully register for a course" do
+        assert !@schedule.schedule.empty?
+        @schedule.schedule.each { |course| assert_not_equal @good_course, course[:sln] }
+        
+        assert @registration.register([@good_course])
+        
+        @schedule.schedule(true)
+        assert !@schedule.schedule.select { |course| course[:sln].to_i == @good_course.to_i }.empty?
+      end
+      
+      should "successfully read erroneous registration for multiple courses" do
+        assert !@registration.register(@bad_courses)        
+        assert !@registration.errors["17779"].empty?
+      end
+    end
+  end
+end