mitchellh-rubyuw 0.7.2 → 0.99.0

data/test/mocked/test_helper.rb

@@ -1,11 +1,67 @@
-require File.join(File.dirname(__FILE__), '..', '..', 'lib', 'myuw')
+require 'rubygems'
+$:.unshift(File.join(File.dirname(__FILE__), '..', '..', 'lib'))
+require 'rubyuw'
 require 'test/unit'
 require "contest"
 require "stories"
 require "mocha"
 
 class Test::Unit::TestCase
+  def setup
+    RubyUW::Base.reset_connection!
+    RubyUW::Base.connection.follow_meta_refresh = false
+  end
+  
   def path_to_html(html)
     "file://" + File.join(File.dirname(__FILE__), 'fixture_pages', "#{html}.html")
   end
+  
+  def expect_get(return_page, with=nil, expectation_type = :expects)
+    return_html = RubyUW::Base.connection.get(path_to_html(return_page))
+    expectation_obj = RubyUW::Base.connection.send(expectation_type, :get).returns(return_html)
+    expectation_obj.with(with) unless with.nil?
+    
+    return_html
+  end
+  
+  def mock_flow(flow)
+    flow_seq = sequence('flow')
+    
+    flow.each do |task, params, return_html|
+      return_page = RubyUW::Base.connection.get(path_to_html(return_html))
+      
+      relay_form = return_page.form_with(:name => 'relay')
+      relay_form.stubs(:submit) if relay_form
+      
+      RubyUW::Base.connection.expects("execute_#{task}!").with(anything, *params).returns(return_page).in_sequence(flow_seq)
+    end
+  end
+end
+
+# Ugly hack. Avoiding using send() since that will not work in
+# Ruby 1.9. Also, since I'm trying to make SINGLETON methods
+# public, I can't do the Class.send(:public, *Class.protected_methods)
+# trick. So this is the ugly hack until I can find a way around it.
+# Anyone?
+class Class
+  def publicize_singleton_methods
+    class << self
+      @_publicize_internals = protected_instance_methods
+      public *@_publicize_internals
+    end
+    
+    if block_given?
+      yield
+
+      class <<self
+        protected *@_publicize_internals
+      end
+    end
+  end
+  
+  def protect_singleton_methods
+    class <<self
+      protected *@_publicize_internals
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: mitchellh-rubyuw
 version: !ruby/object:Gem::Version 
-  version: 0.7.2
+  version: 0.99.0
 platform: ruby
 authors: 
 - Mitchell Hashimoto
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-09-09 00:00:00 -07:00
+date: 2009-09-14 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -20,34 +20,32 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 0.9.2.20090428085858
+        version: 0.9.3.20090623142847
     version: 
-description: TODO
+description: Library which provides a ruby interface to the University of Washington student portal.
 email: mitchell.hashimoto@gmail.com
 executables: []
 
 extensions: []
 
 extra_rdoc_files: 
-- README.markdown
+- README.md
 files: 
 - .gitignore
-- README.markdown
+- README.md
 - Rakefile
 - VERSION
-- lib/myuw.rb
-- lib/myuw/curriculum_enrollment.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
+- lib/rubyuw.rb
+- lib/rubyuw/base.rb
+- lib/rubyuw/connection.rb
+- lib/rubyuw/curriculum_enrollment.rb
+- lib/rubyuw/errors.rb
+- lib/rubyuw/sln.rb
+- test/live/curriculum_enrollment_test.rb
 - test/live/sln_test.rb
 - test/live/test_helper.rb
+- test/mocked/base_test.rb
+- test/mocked/connection_test.rb
 - test/mocked/curriculum_enrollment_test.rb
 - test/mocked/fixture_pages/bad_request.html
 - test/mocked/fixture_pages/curric_courses.html
@@ -74,15 +72,12 @@ files:
 - test/mocked/fixture_pages/sln_no_enrollment_info.html
 - 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
 - test/mocked/test_helper.rb
 - test/password.rb.sample
 has_rdoc: false
 homepage: http://github.com/mitchellh/rubyuw
+licenses: 
 post_install_message: 
 rdoc_options: 
 - --charset=UTF-8
@@ -103,20 +98,16 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.2.0
+rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
 summary: Library which provides a ruby interface to the University of Washington student portal.
 test_files: 
-- test/live/registration_test.rb
-- test/live/schedule_test.rb
-- test/live/session_test.rb
+- test/live/curriculum_enrollment_test.rb
 - test/live/sln_test.rb
 - test/live/test_helper.rb
+- test/mocked/base_test.rb
+- test/mocked/connection_test.rb
 - test/mocked/curriculum_enrollment_test.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
 - test/mocked/test_helper.rb

data/lib/myuw.rb

@@ -1,67 +0,0 @@
-$LOAD_PATH.unshift(File.dirname(__FILE__))
-
-require 'rubygems'
-require 'mechanize'
-
-require 'myuw/errors'
-require 'myuw/session'
-require 'myuw/sln'
-require 'myuw/schedule'
-require 'myuw/registration'
-require 'myuw/curriculum_enrollment'
-
-class MyUW
-  extend Forwardable
-
-  attr_accessor :browser
-  attr_accessor :session
-  attr_accessor :schedule
-  attr_accessor :registration
-  
-  def initialize
-    # Initialize the browser instance and mascarade
-    # around as Safari on Mac
-    @browser = WWW::Mechanize.new do |browser|
-      browser.user_agent_alias = 'Mac Safari'
-      browser.follow_meta_refresh = true
-      
-      # Workaround to avoid frozen object error SSL pages
-      browser.keep_alive = false
-      
-      # Do not keep any history
-      browser.max_history = 0
-    end
-    
-    # Initialize other members
-    @session = Session.new(self)
-    @schedule = Schedule.new(self)
-    @registration = Registration.new(self)
-  end
-  
-  # Forward the session methods
-  def_delegator :session, :logged_in?
-  def_delegator :session, :logout
-  
-  # Log into MyUW with a given username and password
-  def login(user, pass)
-    @session.email = user
-    @session.password = pass
-    @session.login
-  end
-  
-  # Creates a new SLN object and returns it
-  def sln(sln_number, term)
-    sln_obj = SLNInfo.new(self)
-    sln_obj.sln = sln_number
-    sln_obj.term = term
-    return sln_obj
-  end
-  
-  # Creates a new curriculum enrollment object and returns it
-  def curriculum_enrollment(curric, term)
-    curric_obj = CurriculumEnrollment.new(self)
-    curric_obj.curriculum = curric
-    curric_obj.term = term
-    return curric_obj
-  end
-end

data/lib/myuw/curriculum_enrollment.rb

@@ -1,110 +0,0 @@
-class MyUW
-  # = Synopsis
-  # Gets information regarding enrollment within a specific
-  # subject.
-  class CurriculumEnrollment
-    attr_reader :term
-    attr_reader :curriculum
-    attr_accessor :myuw
-    attr_reader :data
-    
-    def initialize(myuw)
-      @myuw = myuw
-      @term = nil
-      @data = nil
-      @curriculum = nil
-    end
-    
-    # Custom setter for SLN to reset data
-    def curriculum=(value)
-      @curriculum = value
-      @data = nil
-    end
-    
-    # Custom setter for term to reset data
-    def term=(value)
-      @term = value
-      @data = nil
-    end
-    
-    # Fetches the information for the given SLN. 
-    def fetch_data
-      raise ArgumentError.new("Curriculum not set.") if @curriculum.nil?
-      raise ArgumentError.new("Term not set.") if @term.nil?
-      raise NotLoggedInError.new("User must be logged in to fetch SLN data") unless @myuw.logged_in?
-      
-      # Request the actual page
-      page = get_dept_page
-
-      # Get the actual course information
-    end
-
-    # Get data for a specific SLN
-    def data_by_sln(sln, reload = false)
-      fetch_data if @data.nil? || reload
-      @data[sln]
-    end
-    
-    # Gets the SLN info page for the SLN and term, raising
-    # an exception if it is requested too soon
-    def get_dept_page
-      page = @myuw.browser.get("https://sdb.admin.washington.edu/timeschd/uwnetid/tsstat.asp?QTRYR=#{@term}&CURRIC=#{@curriculum}")
-      if page.body.to_s =~ /No sections found for #{@curriculum}./
-        raise InvalidCurriculumError.new("Curriculum does not exist.")
-      end
-      
-      page
-    end
-    
-    # Gets and stores all course data
-    def get_all_courses_data(page)
-      nodes = page.search('//table//tr[count(th)>1 and @bgcolor="#d0d0d0"]//following-sibling::tr')
-      raise InvalidPageError.new("Couldn't find any courses listed.") if nodes.empty?
-      
-      @data = {}
-      nodes.each do |node|
-        node_data = get_course_data(node)
-        @data[node_data[:sln]] = node_data
-      end
-    end
-    
-    # Gets a single course row's data
-    def get_course_data(row)
-      nodes = row.search('td')
-      raise InvalidPageError.new("Couldn't find course information for a single row.") if nodes.empty?
-      
-      data_keys = [:sln, :course, :section, :type, :title, :current_enrollment, :limit_enrollment,
-          :room_capacity, :space_available, nil, :notes]
-      
-      data = extract_info(data_keys, nodes)
-      raise InvalidPageError.new("Failed to extract data for single row.") if !data
-      
-      data
-    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 = {}
-      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_key] = node.inner_text.strip.gsub("\302\240", "")
-          end
-        end
-      end
-      
-      data
-    end
-  end
-  
-  #
-  # Exceptions
-  class InvalidCurriculumError < StandardError; end
-end

data/lib/myuw/errors.rb

@@ -1,18 +0,0 @@
-# General purpose errors used within MyUW
-
-class MyUW
-  class NotLoggedInError < StandardError; end
-  
-  # A generic error to capture strange invalid HTML
-  # results. These errors can typically be used to 
-  # find edge cases of HTML (such as maintenance
-  # pages and so on) in MyUW
-  class InvalidPageError < StandardError
-    attr_reader :page
-    
-    def initialize(page, msg=nil)
-      @page = page
-      super(msg)
-    end
-  end
-end

data/lib/myuw/registration.rb

@@ -1,98 +0,0 @@
-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