stellar 0.1.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.project

@@ -0,0 +1,18 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<projectDescription>
+	<name>stellar</name>
+	<comment></comment>
+	<projects>
+	</projects>
+	<buildSpec>
+		<buildCommand>
+			<name>com.aptana.ide.core.unifiedBuilder</name>
+			<arguments>
+			</arguments>
+		</buildCommand>
+	</buildSpec>
+	<natures>
+		<nature>com.aptana.ruby.core.rubynature</nature>
+		<nature>com.aptana.projects.webnature</nature>
+	</natures>
+</projectDescription>

data/.rspec

@@ -0,0 +1,3 @@
+--backtrace
+--color
+--debugger

data/Gemfile

@@ -0,0 +1,21 @@
+source :rubygems
+
+# Add dependencies required to use your gem here.
+gem 'mechanize', '>= 2.0.2'
+gem 'nokogiri', '>= 1.5.0'
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem 'rdoc', '>= 3.9.4'
+  gem 'rspec', '>= 2.6.0'
+  gem 'yard', '>= 0.7.2'
+  gem 'yard-rspec', '>= 0.1'
+  gem 'bundler', '>= 1.0.21'
+  gem 'jeweler', '>= 1.6.4'
+  gem 'rcov', '>= 0'
+  gem 'ruby-debug', :platform => :mri_18
+  gem 'ruby-debug19', :platform => :mri_19
+
+  gem 'highline', '>= 1.6.2'
+end

data/Gemfile.lock

@@ -0,0 +1,75 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    archive-tar-minitar (0.5.2)
+    columnize (0.3.4)
+    diff-lcs (1.1.3)
+    git (1.2.5)
+    highline (1.6.2)
+    jeweler (1.6.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+    json (1.6.1)
+    linecache (0.46)
+      rbx-require-relative (> 0.0.4)
+    linecache19 (0.5.12)
+      ruby_core_source (>= 0.1.4)
+    mechanize (2.0.2)
+      net-http-digest_auth (~> 1.1, >= 1.1.1)
+      net-http-persistent (~> 1.8)
+      nokogiri (~> 1.4)
+      webrobots (~> 0.0, >= 0.0.9)
+    net-http-digest_auth (1.1.1)
+    net-http-persistent (1.9)
+    nokogiri (1.5.0)
+    rake (0.9.2)
+    rbx-require-relative (0.0.5)
+    rcov (0.9.11)
+    rdoc (3.10)
+      json (~> 1.4)
+    rspec (2.6.0)
+      rspec-core (~> 2.6.0)
+      rspec-expectations (~> 2.6.0)
+      rspec-mocks (~> 2.6.0)
+    rspec-core (2.6.4)
+    rspec-expectations (2.6.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.6.0)
+    ruby-debug (0.10.4)
+      columnize (>= 0.1)
+      ruby-debug-base (~> 0.10.4.0)
+    ruby-debug-base (0.10.4)
+      linecache (>= 0.3)
+    ruby-debug-base19 (0.11.25)
+      columnize (>= 0.3.1)
+      linecache19 (>= 0.5.11)
+      ruby_core_source (>= 0.1.4)
+    ruby-debug19 (0.11.6)
+      columnize (>= 0.3.1)
+      linecache19 (>= 0.5.11)
+      ruby-debug-base19 (>= 0.11.19)
+    ruby_core_source (0.1.5)
+      archive-tar-minitar (>= 0.5.2)
+    webrobots (0.0.12)
+      nokogiri (>= 1.4.4)
+    yard (0.7.2)
+    yard-rspec (0.1)
+      yard
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (>= 1.0.21)
+  highline (>= 1.6.2)
+  jeweler (>= 1.6.4)
+  mechanize (>= 2.0.2)
+  nokogiri (>= 1.5.0)
+  rcov
+  rdoc (>= 3.9.4)
+  rspec (>= 2.6.0)
+  ruby-debug
+  ruby-debug19
+  yard (>= 0.7.2)
+  yard-rspec (>= 0.1)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Victor Costan
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,18 @@
+= stellar
+
+Automated access to MIT's Stellar data, so we don't have to put up with
+Stellar's craptastic UI.
+
+== Contributing to stellar
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2011 Victor Costan. See LICENSE.txt for further details.

data/Rakefile

@@ -0,0 +1,76 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "stellar"
+  gem.homepage = "http://github.com/pwnall/stellar"
+  gem.license = "MIT"
+  gem.summary = %Q{Automated access to MIT's Stellar data}
+  gem.description = %Q{So we don't have to put up with Stellar's craptastic ui}
+  gem.email = "victor@costan.us"
+  gem.authors = ["Victor Costan"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'yard'
+YARD::Rake::YardocTask.new
+
+# Fixtures.
+
+require 'highline/import'
+require 'readline'
+require 'yaml'
+
+task :spec => :fixtures
+
+krb_file = 'spec/fixtures/kerberos.b64'
+file krb_file do
+  kerberos = {}
+  kerberos[:user] = ask('MIT Kerberos Username: ') { |q| q.echo = true }
+  kerberos[:pass] = ask('MIT Kerberos Password: ') { |q| q.echo = '*' }
+  kerberos[:mit_id] = ask('MIT ID: ') { |q| q.echo = true }
+  File.open(krb_file, 'w') {|f| f.write [kerberos.to_yaml].pack('m') }
+end
+task :fixtures => krb_file
+
+cert_file = 'spec/fixtures/mit_cert.yml'
+file cert_file => krb_file do
+  $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), 'lib'))
+  require 'stellar'
+  
+  kerberos = YAML.load File.read(krb_file).unpack('m').first
+  cert = Stellar::Auth.get_certificate kerberos
+  yaml = {:cert => cert[:cert].to_pem, :key => cert[:key].to_pem}.to_yaml
+  File.open(cert_file, 'wb') { |f| f.write yaml }
+  
+  # Write the certificate in PKCS#12 format for debugging purposes.
+  p12 = OpenSSL::PKCS12.create(nil, 'MIT Stellar', cert[:key], cert[:cert])
+  File.open('spec/fixtures/mit_cert.p12', 'wb') { |f| f.write p12.to_der }
+end
+task :fixtures => cert_file

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/stellar.rb

@@ -0,0 +1,18 @@
+# Standard library.
+require 'openssl'
+require 'uri'
+
+# Gems.
+require 'nokogiri'
+require 'mechanize'
+
+# TODO(pwnall): documentation
+module Stellar
+  
+end  # namespace Stellar
+
+# Code.
+require 'stellar/auth.rb'
+require 'stellar/client.rb'
+require 'stellar/courses.rb'
+require 'stellar/homework.rb'

data/lib/stellar/auth.rb

@@ -0,0 +1,130 @@
+require 'logger'
+
+# :nodoc: namespace
+module Stellar
+
+# Support for authentication on MIT systems.
+module Auth
+  # Path to the MIT CA self-signed certificate.
+  def mitca_path
+    File.join File.dirname(__FILE__), 'mitca.crt'
+  end
+  
+  # Authenticates using some credentials, e.g. an MIT certificate.
+  #
+  # @param [Hash] options credentials to be used for authentication
+  # @option options [String] :cert path to MIT client certificate for the user
+  # @option options [Hash] :kerberos:: Kerberos credentials, encoded as a Hash
+  #     with :user and :pass keys
+  # @return [Stellar::Client] self, for convenient method chaining
+  def auth(options = {})
+    # Reset any prior credentials.
+    @mech = mech
+    if options[:cert]
+      log = Logger.new(STDERR)
+      log.level = Logger::INFO
+      @mech.log = log
+      
+      key = options[:cert][:key]
+      if key.respond_to?(:to_str)
+        if File.exist?(key)
+          @mech.key = key
+        else
+          @mech.key = OpenSSL::PKey::RSA.new key
+        end
+      else
+        @mech.key = key
+      end
+      cert = options[:cert][:cert]
+      if cert.respond_to?(:to_str)
+        if File.exist?(cert)
+          @mech.cert = cert
+        else
+          @mech.cert = OpenSSL::X509::Certificate.new cert
+        end
+      else
+        @mech.cert = cert
+      end
+    end
+    
+    # Go to a page that is guaranteed to redirect to shitoleth.
+    step1_page = get '/atstellar'
+    # Fill in the form.
+    step1_form = step1_page.form_with :action => /WAYF/
+    step1_form.checkbox_with(:name => /perm/).checked = :checked
+    step2_page = step1_form.submit
+    # Click through the stupid confirmation form.
+    step2_form = step2_page.form_with :action => /WAYF/
+    cred_page = step2_form.submit
+    
+    # Fill in the credentials form.
+    if options[:cert]
+      cred_form = cred_page.form_with :action => /certificate/i
+      cred_form.checkbox_with(:name => /pref/).checked = :checked
+      puts cred_form
+      puts cred_form.submit(cred_form.buttons.first).body
+      return
+    elsif options[:kerberos]
+      cred_form = cred_page.form_with :action => /username/i
+      cred_form.field_with(:name => /user/).value = options[:kerberos][:user]
+      cred_form.field_with(:name => /pass/).value = options[:kerberos][:pass]
+    else
+      raise 'Unsupported credentials'
+    end
+    
+    # Click through the SAML response form.
+    saml_page = cred_form.submit
+    unless saml_form = saml_page.form_with(:action => /SAML/)
+      raise ArgumentError, 'Authentication failed due to invalid credentials'
+    end
+    saml_form.submit
+    
+    self
+  end
+end  # module Stellar::Auth
+  
+# :nodoc: class methods
+module Auth
+  class <<self
+    include Auth
+    
+    # Obtains a certificate using a Kerberos credentials.
+    #
+    # @param [Hash] kerberos MIT Kerberos credentials
+    # @option kerberos [String] :user the Kerberos username (e.g. "costan")
+    # @option kerberos [String] :pass the Kerberos password (handle with care!)
+    # @option kerberos [String] :mit_id 9-character string or 9-digit number
+    #                                   starting with 9 (9........)
+    # @option kerberos [Fixnum] :ttl certificate lifetime, in days (optional;
+    #                                            defaults to 1 day)
+    #
+    # @return [Hash] a Hash with a :cert key (the OpenSSL::X509::Certificate)
+    #     and a :key key (the matching OpenSSL::PKey::PKey private key)
+    def get_certificate(kerberos)
+      mech = Mechanize.new
+      mech.ca_file = mitca_path
+      mech.user_agent_alias = 'Linux Firefox'
+      login_page = mech.get 'https://ca.mit.edu/ca/'
+      login_form = login_page.form_with :action => /login/
+      login_form.field_with(:name => /login/).value = kerberos[:user]
+      login_form.field_with(:name => /pass/).value = kerberos[:pass]
+      login_form.field_with(:name => /mitid/).value = kerberos[:mit_id]
+      keygen_page = login_form.submit login_form.buttons.first
+
+      keygen_form = keygen_page.form_with(:action => /ca/)
+      if /login/ =~ keygen_form.action
+        raise ArgumentError, 'Invalid Kerberos credentials'
+      end
+      keygen_form.field_with(:name => /life/).value = kerberos[:ttl] || 1
+      key_pair = keygen_form.keygens.first.key
+      response_page = keygen_form.submit keygen_form.buttons.first
+      
+      cert_frame = response_page.frame_with(:name => /download/)
+      cert_bytes = mech.get_file cert_frame.uri
+      cert = OpenSSL::X509::Certificate.new cert_bytes
+      {:key => key_pair, :cert => cert}
+    end
+  end
+end  # module Stellar::Auth
+
+end  # namespace Stellar

data/lib/stellar/client.rb

@@ -0,0 +1,66 @@
+# :nodoc: namespace
+module Stellar
+
+# Client session for accessing the Stellar API.
+class Client
+  include Stellar::Auth
+
+  # Client for accessing public information.
+  #
+  # Call auth to authenticate as a user and access restricted functionality.
+  def initialize
+    @mech = mech
+    
+    @courses = nil
+  end
+  
+  # New Mechanize instance.
+  def mech
+    m = Mechanize.new
+    m.ca_file = mitca_path
+    m.user_agent_alias = 'Linux Firefox'
+    m
+  end
+
+  # Fetches a page from the Stellar site.
+  #
+  # @param [String] path relative URL of the page to be fetched
+  # @return [Mechanize::Page] the desired page, wrapped in the Mechanize API
+  def get(path)
+    uri = URI.join('https://stellar.mit.edu', path)
+    page_bytes = @mech.get uri
+  end
+
+  # Fetches a page from the Stellar site.
+  #
+  # @param [String] path relative URL of the page to be fetched
+  # @return [Nokogiri::HTML::Document] the desired page, parsed with Nokogiri
+  def get_nokogiri(path)
+    uri = URI.join('https://stellar.mit.edu', path)
+    raw_html = @mech.get_file uri
+    Nokogiri.HTML raw_html, uri.to_s
+  end
+  
+  # Fetches a file from the Stellar site.
+  #
+  # @param [String] path relative URL of the file to be fetched
+  # @return [String] raw contents of the file
+  def get_file(path)
+    uri = URI.join('https://stellar.mit.edu', path)
+    @mech.get_file uri
+  end
+  
+  # A Stellar client specialized to answer course queries.
+  #
+  # @return [Stellar::Courses] client specialized to course queries
+  def courses
+    @courses ||= Stellar::Courses.new self
+  end
+  
+  # (see Stellar::Course#for)
+  def course(number, year, semester)
+    Stellar::Course.for number, year, semester, self
+  end
+end  # class Stellar::Client
+  
+end  # namespace Stellar