mitchellh-rubyuw 0.2.0

data/.gitignore

@@ -0,0 +1 @@
+pkg/*

data/README.markdown

@@ -0,0 +1,49 @@
+# RubyUW: Ruby Interface to MyUW
+
+__RubyUW is NOT supported in any way by the University of Washington__
+
+RubyUW provides a programmable interface to MyUW, University
+of Washington's student web portal. 
+
+## Why?
+
+Proof of Concept.
+
+It's a fun project and it was really a proof of concept more than
+anything. I don't plan on officially supporting this library or
+promising updates in case any features break. Its a good example
+for any Ruby developer on the uses of mechanize and the ability
+to scrape content or simulate a human at a browser.
+
+It is also a useful library to create MyUW automation tools
+with. I do not support this.
+
+## How does it work?
+
+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.
+
+Of course this also means that even minor tweaks to the MyUW layout
+could potentially "break" the RubyUW library.
+
+## Installing
+
+    # Install the gem
+    sudo gem sources -a http://gems.github.com
+    sudo gem install mitchellh-rubyuw
+
+## Using RubyUW
+
+It's easy to get started with RubyUW. Officially RDoc documentation
+is planned but is __not up yet__. Sorry!
+
+The following is a quick and simple example:
+
+    require 'myuw'
+    myuw = MyUW.new
+    myuw.login("netid", "password") or raise("Login Failed!")
+    
+    # Get SLN information
+    sln_info = myuw.sln(14153)

data/Rakefile

@@ -0,0 +1,13 @@
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "rubyuw"
+    gemspec.summary = "Library which provides a ruby interface to the University of Washington student portal."
+    gemspec.email = "mitchell.hashimoto@gmail.com"
+    gemspec.homepage = "http://github.com/mitchellh/rubyuw"
+    gemspec.description = "TODO"
+    gemspec.authors = ["Mitchell Hashimoto"]
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end

data/VERSION

@@ -0,0 +1 @@
+0.2.0

data/lib/myuw.rb

@@ -0,0 +1,49 @@
+require 'rubygems'
+require 'mechanize'
+
+require 'lib/myuw/session'
+require 'lib/myuw/sln'
+
+class MyUW
+  extend Forwardable
+  
+  ##
+  # The version of the ruby MyUW automation class
+  VERSION = '0.1'
+  
+  attr_accessor :browser
+  attr_accessor :session
+  
+  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
+    end
+    
+    # Initialize other members
+    @session = Session.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)
+    sln_obj = SLNInfo.new(self)
+    sln_obj.sln = sln_number
+    return sln_obj
+  end
+end

data/lib/myuw/session.rb

@@ -0,0 +1,87 @@
+class MyUW
+  # = Synopsis
+  # This class encapsulates a MyUW session. It handles
+  # the login/logout of the MyUW portal.
+  class Session
+    attr_accessor :myuw
+    attr_accessor :email
+    attr_accessor :password
+    
+    def initialize(myuw=nil)
+      @myuw ||= myuw
+      
+      @email = @password = nil
+    end
+    
+    # Checks if a user is logged in. This method is actually 
+    # pretty expensive in terms of time since it actually
+    # 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?
+      
+      relay_page = home.form_with(:name => 'f').submit()
+      welcome_msg = relay_page.search("span.greetingw")
+      return !welcome_msg.empty?
+    end
+    
+    # Logs a user in using the given email and password
+    def login
+      # Make sure that email and password are filled out or this is
+      # useless
+      if @email.nil? || @password.nil?
+        raise("Email and password weren't specified for MyUW session")
+      end
+      
+      # Log out first
+      logout
+
+      # Go to the MyUW page and get to the login form
+      login_page = get_login_page
+      login_form = login_page.form_with(:name => 'query')
+      raise("Login form was not found on the MyUW page") if login_form.nil?
+      login_form.user = @email
+      login_form.pass = @password
+      relay_page = login_form.submit()
+      
+      # Check if the login failed
+      unless relay_page.form_with(:name => 'query').nil?
+        return false
+      end
+      
+      # Follow the relay
+      follow_relay_page(relay_page)
+      true
+    end
+    
+    # Log out of the MyUW site
+    def logout
+      @myuw.browser.cookie_jar.clear!
+    end
+    
+    private
+    
+    def get_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?
+      
+      entry_form = home.form_with(:name => 'f')
+      relay_page = entry_form.submit()
+      
+      return follow_relay_page(relay_page)
+    end
+    
+    def follow_relay_page(relay_page)
+      relay_form = relay_page.form_with(:name => 'relay')
+      relay_form.submit()
+    end
+  end
+end

data/lib/myuw/sln.rb

@@ -0,0 +1,89 @@
+class MyUW
+  # = Synopsis
+  # Gets information regarding a specific SLN, returning
+  # information in a SLN object.
+  class SLNInfo
+    attr_accessor :term
+    attr_reader :sln
+    attr_accessor :myuw
+    attr_reader :data
+    
+    def initialize(myuw)
+      @myuw = myuw
+      @term = "AUT+2009"
+      @data = nil
+      @sln = nil
+    end
+    
+    # Custom setter for SLN to reset data
+    def sln=(value)
+      @sln = value
+      @data = nil
+    end
+    
+    # Fetches the information for the given SLN. 
+    def fetch_data
+      raise("SLN not set.") if @sln.nil?
+      raise("User must be logged in to fetch SLN data") unless @myuw.logged_in?
+      
+      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
+        raise("Attempted to fetch SLN data too soon.")
+      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
+      info_nodes = page.search("//table[@border=1 and @cellpadding=3]//tr[@rowspan=1]//td")
+      
+      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
+          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.
+      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]
+      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
+          end
+        end
+      end
+      
+      # And finally getting the notes of an SLN, accompanied by
+      # by far the ugliest xpath query yet.
+      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

@@ -0,0 +1,41 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{rubyuw}
+  s.version = "0.2.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-21}
+  s.description = %q{TODO}
+  s.email = %q{mitchell.hashimoto@gmail.com}
+  s.extra_rdoc_files = [
+    "README.markdown"
+  ]
+  s.files = [
+    ".gitignore",
+     "README.markdown",
+     "Rakefile",
+     "VERSION",
+     "lib/myuw.rb",
+     "lib/myuw/session.rb",
+     "lib/myuw/sln.rb",
+     "rubyuw.gemspec"
+  ]
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/mitchellh/rubyuw}
+  s.rdoc_options = ["--charset=UTF-8"]
+  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.}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification 
+name: mitchellh-rubyuw
+version: !ruby/object:Gem::Version 
+  version: 0.2.0
+platform: ruby
+authors: 
+- Mitchell Hashimoto
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-06-21 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: TODO
+email: mitchell.hashimoto@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.markdown
+files: 
+- .gitignore
+- README.markdown
+- Rakefile
+- VERSION
+- lib/myuw.rb
+- lib/myuw/session.rb
+- lib/myuw/sln.rb
+- rubyuw.gemspec
+has_rdoc: true
+homepage: http://github.com/mitchellh/rubyuw
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Library which provides a ruby interface to the University of Washington student portal.
+test_files: []
+