stellar 0.1.0

data/lib/stellar/courses.rb

@@ -0,0 +1,112 @@
+# :nodoc: namespace
+module Stellar
+
+# Course search functionality.
+class Courses
+  def initialize(client)
+    @client = client
+  end
+
+  # My classes.
+  # @return [Array] array with one Hash per class; Hashes have :number and
+  #                 :url keys
+  def mine
+    page = @client.get_nokogiri '/atstellar'
+    class_links = page.css('a[href*="/S/course/"]').
+        map { |link| Stellar::Course.from_link link, @client }.reject(&:nil?)
+  end
+end  # class Stellar::Courses
+
+# Stellar client scoped to a course.
+class Course
+  # Official MIT course ID, e.g. "6.006".
+  attr_reader :number
+  
+  # URL to the course's main page on Stellar.
+  #
+  # Example: "https://stellar.mit.edu/S/course/6/fa11/6.006/"
+  attr_reader :url
+  
+  # Maps the text in navigation links to URI objects.
+  #
+  # Example: navigation['Homework'] => <# URI: .../ >
+  attr_reader :navigation
+  
+  # True if the client has administrative rights for this course.
+  attr_reader :is_admin
+  
+  # The generic Stellar client used to query the server.
+  attr_reader :client
+  
+  # Creates a scoped Stellar client from a link to the course's page.
+  #
+  # @param [Nokogiri::XML::Element] nokogiri_link a link pointing to the
+  #                                               course's main page 
+  # @param [Stellar::Client] client generic Stellar client
+  # @return [Stellar::Course] client scoped to the course, or nil if the link
+  #                                  is not valid
+  def self.from_link(nokogiri_link, client)
+    number = nokogiri_link.css('span.courseNo').inner_text
+    return nil if number.empty?
+    url = nokogiri_link['href']
+    return nil unless url.index(number)
+    return nil unless /\/S\/course\// =~ url
+    
+    return self.new(client, url, number)
+  end
+  
+  # Creates a scoped Stellar client from a link to the course's page.
+  #
+  # @param [String] number the official MIT course ID, e.g. "6.006"
+  # @param [Fixnum] year the year the course was taught e.g. 2011 
+  # @param [Symbol] semester :fall, :iap, :spring, :summer
+  # @return [Stellar::Course] client scoped to the course
+  def self.for(number, year, semester, client)
+    semester_string = case semester
+    when :fall
+      'fa'
+    when :spring
+      'sp'
+    when :summer
+      'su'
+    when :iap
+      'ia'
+    end
+    term = "#{semester_string}#{year.to_s[-2..-1]}"
+    major = number.split('.', 2).first
+    url = "/S/course/#{major}/#{term}/#{number}/index.html"
+    
+    return self.new(client, url, number)
+  end
+  
+  # Creates a scoped Stellar client from detailed specifications.
+  #
+  # @param [Stellar::Client] client generic Stellar client
+  # @param [String] course_url HTTP URI to the course's main Stellar page
+  # @param [String] course_number official course ID, e.g. "6.006"
+  # @raise ArgumentError if the course URL does not point to a course page
+  def initialize(client, course_url, course_number)
+    @client = client
+    @url = course_url
+    @number = course_number
+    
+    course_page = @client.get_nokogiri course_url
+    
+    @is_admin = course_page.css('p#toolset').length > 0
+    
+    navbar_elems = course_page.css('#mainnav')
+    unless navbar_elems.length == 1
+      raise ArgumentError, "#{course_url} is not a course page"
+    end
+    @navigation = Hash[navbar_elems.first.css('a').map do |link|
+      [link.inner_text, URI.join(course_page.url, link['href'])]
+    end]
+  end
+  
+  # Client scoped to the course's Homework module.
+  def homework
+    @homework ||= Stellar::HomeworkList.new self
+  end
+end  # class Stellar::Course
+
+end  # namespace Stellar

data/lib/stellar/homework.rb

@@ -0,0 +1,242 @@
+# :nodoc: namespace
+module Stellar
+
+# Homework listing functionality.
+class HomeworkList
+  # Creates a Stellar client scoped to a course's Homework module.
+  #
+  # @param [Stellar::Course] the course whose homework is desired
+  def initialize(course)
+    @course = course
+    @client = course.client
+    @url = course.navigation['Homework']
+    
+    page = @client.get_nokogiri @url
+    @assignments = page.css('#content a[href*="assignment"]').map { |link|
+      name = link.inner_text
+      url = URI.join page.url, link['href']
+      begin
+        Stellar::Homework.new url, name, course
+      rescue ArgumentError
+        nil
+      end
+    }.reject(&:nil?)
+  end
+
+  # All assignments in this course's homework module.
+  # @return [Array<Stellar::Homework>] list of assignments posted by this course 
+  def all
+    @assignments
+  end
+  
+  # All assignments in this course's homework module.
+  # @return [Array<Stellar::Homework>] list of assignments posted by this course 
+  def named(name)
+    @assignments.find { |a| a.name == name }
+  end
+end  # class Stellar::HomeworkList
+
+# One assignment in the homework tab.
+class Homework
+  # Assignment name.
+  attr_reader :name
+  
+  # The course that this assignment is for.
+  attr_reader :course
+  
+  # Generic Stellar client used to make requests.
+  attr_reader :client
+  
+  # Creates a Stellar client scoped to an assignment.
+  #
+  # @param [URI, String] page_url URL to the assignment's main Stellar page
+  # @param [String] assignment name, e.g. "name"
+  # @param [Course] the course that issued the assignment
+  def initialize(page_url, name, course)
+    @name = name
+    @url = page_url
+    @course = course
+    @client = course.client
+    
+    page = @client.get_nokogiri @url
+    unless page.css('#content p b').any? { |dom| dom.inner_text.strip == name }
+      raise ArgumentError, 'Invalid homework page URL'
+    end
+  end
+  
+  # List of submissions associated with this problem set.
+  def submissions
+    page = @client.get_nokogiri @url
+    @submissions ||= page.css('.gradeTable tbody tr').map { |tr|
+      begin
+        Stellar::Homework::Submission.new tr, self
+      rescue ArgumentError
+        nil
+      end
+    }.reject(&:nil?)
+  end
+  
+# A student's submission for an assignment.
+class Submission
+  # URL to the last file that the student submitted.
+  attr_reader :file_url
+  
+  # Name of the student who authored this submission.
+  attr_reader :name
+  
+  # Email of the student who authorted this submission.
+  attr_reader :email
+
+  # Comments posted on this submission.
+  attr_reader :comments
+  
+  # Homework that the submission belongs to.
+  attr_reader :homework
+  
+  # Generic Stellar client used to make requests.
+  attr_reader :client
+  
+  # Creates a submission from a <tr> element in the Stellar homework page.
+  #
+  # @param [Nokogiri::XML::Element]
+  def initialize(tr, homework)
+    link = tr.css('a').find { |link| /submission\s+details/ =~ link.inner_text }
+    raise ArgumentError, 'Invalid submission-listing <tr>' unless link
+
+    @url = URI.join tr.document.url, link['href']
+    @homework = homework
+    @client = homework.client
+    
+    page = @client.get_nokogiri @url
+
+    unless author_link = page.css('#content h4 a[href^="mailto:"]').first
+      raise ArgumentError, 'Invalud submission-listing <tr>'
+    end
+    @name = author_link.inner_text
+    @email = author_link['href'].sub /^mailto:/, ''
+    @file_url = page.css('#rosterBox a[href*="studentWork"]').map { |link|
+      next nil unless link.inner_text == homework.name
+      URI.join @url.to_s, link['href']
+    }.reject(&:nil?).first
+    
+    @add_comment_url = URI.join @url.to_s,
+        page.css('#comments a[href*="add"]').first['href']
+    reload_comments! page
+  end
+  
+  # The contents of the file attached to this Stellar submission.
+  #
+  # @return [String] raw file data
+  def file_data
+    @client.get_file @file_url
+  end
+    
+  # Adds a comment to the student's submission.
+  #
+  # @param [String] text the comment text
+  # @param [String] file_data the content of the file attached to the comment;
+  #     by default, no file is attached
+  # @param [String] file_mime_type if a file is attached, indicates its type;
+  #     examples: 'text/plain', 'application/pdf'
+  # @param [String] file_name name of the file attached to the comment; by 
+  #     default, 'attachment.txt'
+  # @return [Stellar::Homework::Submission] self
+  def add_comment(text, file_data = nil, file_mime_type = 'text/plain',
+                  file_name = 'attachment.txt')
+    add_page = @client.get @add_comment_url
+    add_form = add_page.form_with :action => /addcomment/i
+    
+    add_form.field_with(:name => /newCommentRaw/i).value = text
+    add_form.field_with(:name => /newComment/i).value = text
+    add_form.checkbox_with(:name => /privateComment/i).checked = :checked
+    if file_data
+      upload = add_form.file_uploads.first
+      upload.file_name = file_name
+      upload.mime_type = file_mime_type
+      upload.file_data = file_data
+    end
+    add_form.submit add_form.button_with(:name => /submit/i)
+    self
+  end
+  
+  # Reloads the problem set's comments page.
+  def reload_comments!(page = nil)
+    page ||= @client.get_nokogiri @url
+    @comments = page.css('#comments ~ table.dataTable').map { |table|
+      Comment.new table, self
+    }.reject(&:nil?)
+  end
+
+# A comment on a Stellar submission.
+class Comment
+  # Person who posted the comment.
+  attr_reader :author
+  # Comment text.
+  attr_reader :text
+  # URL to the file attached to the comment. Can be nil.
+  attr_reader :attachment_url
+  # True if the comment was deleted.
+  attr_reader :deleted
+  # True if the comment was deleted.
+  alias_method :deleted?, :deleted
+
+  # The submission that the comment was posted on.
+  attr_reader :submission
+  # Generic Stellar client used to make requests.
+  attr_reader :client
+  
+  def initialize(table, submission)
+    @submission = submission
+    @client = @submission.client
+
+    page_url = table.document.url
+    @author = table.css('thead tr th.announcedBy').first.inner_text
+    
+    unless content = table.css('tbody tr td.announcement').first
+      raise 'Invalid submission comment table'
+    end
+    if (deleted_text = table.css('tbody tr td.announcement > em').first) &&
+        deleted_text.inner_text == 'deleted'
+      @deleted = true
+      @text = nil
+      @attachment_url = nil
+    else
+      @deleted = false
+      
+      unless delete_link = table.css('thead a[href*="delete"]').first
+        raise ArgumentError, 'Invalid submission comment table'
+      end
+      @delete_url = URI.join page_url, delete_link['href']
+      @text = content.css('p').inner_text
+      attachment_links = table.css('tbody tr td.announcement > a')
+      if attachment_links.empty?
+        @attachment_url = nil
+      else
+        @attachment_url = URI.join page_url, attachment_links.first['href']
+      end
+    end
+  end
+  
+  # Deletes this comment from Stellar.
+  def delete!
+    return if @deleted
+    delete_page = @client.get @delete_url
+    delete_form = delete_page.form_with(:action => /delete/i)
+    delete_button = delete_form.button_with(:name => /delete/i)
+    delete_form.submit delete_button
+    @deleted = true
+  end
+  
+  # The contents of the file attached to this Stellar submission comment.
+  #
+  # @return [String] raw file data
+  def attachment_data
+    @attachment_url && @client.get_file(@attachment_url)
+  end
+end  # class Stellar::Homework::Submission::Comment
+  
+end  # class Stellar::Homework::Submission
+
+end  # class Stellar::Homework
+
+end  # namespace Stellar

data/lib/stellar/mitca.crt

@@ -0,0 +1,21 @@
+-----BEGIN CERTIFICATE-----
+MIIDZTCCAs6gAwIBAgIBATANBgkqhkiG9w0BAQUFADB7MQswCQYDVQQGEwJVUzEW
+MBQGA1UECBMNTWFzc2FjaHVzZXR0czEuMCwGA1UEChMlTWFzc2FjaHVzZXR0cyBJ
+bnN0aXR1dGUgb2YgVGVjaG5vbG9neTEkMCIGA1UECxMbTUlUIENlcnRpZmljYXRp
+b24gQXV0aG9yaXR5MB4XDTA2MDQwODE2NTAwNFoXDTI2MDgwMTE2NTAwNFowezEL
+MAkGA1UEBhMCVVMxFjAUBgNVBAgTDU1hc3NhY2h1c2V0dHMxLjAsBgNVBAoTJU1h
+c3NhY2h1c2V0dHMgSW5zdGl0dXRlIG9mIFRlY2hub2xvZ3kxJDAiBgNVBAsTG01J
+VCBDZXJ0aWZpY2F0aW9uIEF1dGhvcml0eTCBnzANBgkqhkiG9w0BAQEFAAOBjQAw
+gYkCgYEA09Dr51G1M3Wm2KOE6gJwXM+cIOALA4uORm4VJeF39mvEcN3UFgvMEYgx
+OAvufFkkV+mNzXX4UmPdMwzwT5+1/JGuMoWMGnVjGZiGHpIjsofz9cmmopdo8uyy
+Gq2z9e0J6sznvLRkUBXmVwAaesbe/uEwWFpdq7u0HBHsZMHTpFUCAwEAAaOB+DCB
+9TAdBgNVHQ4EFgQUU/WjDwZdZdiKj1JtafrrVS29iwwwgaUGA1UdIwSBnTCBmoAU
+U/WjDwZdZdiKj1JtafrrVS29iwyhf6R9MHsxCzAJBgNVBAYTAlVTMRYwFAYDVQQI
+Ew1NYXNzYWNodXNldHRzMS4wLAYDVQQKEyVNYXNzYWNodXNldHRzIEluc3RpdHV0
+ZSBvZiBUZWNobm9sb2d5MSQwIgYDVQQLExtNSVQgQ2VydGlmaWNhdGlvbiBBdXRo
+b3JpdHmCAQEwDAYDVR0TBAUwAwEB/zALBgNVHQ8EBAMCAQYwEQYJYIZIAYb4QgEB
+BAQDAgEGMA0GCSqGSIb3DQEBBQUAA4GBAMTjXyVdM89JlPTzoe3o5CIvUP6TrWMN
+Bm3/mSX5pXeZWbWLtdVfUgQ9mW6UBYXaQSUPmz9C09ZNBH8N3vOoDS5/jD8MMcV/
+U/rOAIb4v2bMRKpPweSINGm72Pv/Pg15t1sRcnatBK94orekYvfJa3PiPU/3pfge
+RYhCd9zByXr2
+-----END CERTIFICATE-----

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'stellar'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  
+end

data/spec/stellar/auth_spec.rb

@@ -0,0 +1,32 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe Stellar::Auth do
+  describe 'get_certificate' do
+    before :all do
+      @result = Stellar::Auth.get_certificate test_mit_kerberos
+    end
+    
+    it 'should contain a key pair' do
+      @result[:key].should be_kind_of(OpenSSL::PKey::PKey)
+      @result[:key].should be_private
+    end
+    it 'should contain a certificate' do
+      @result[:cert].should be_kind_of(OpenSSL::X509::Certificate)
+    end
+    it 'should contain a MIT certificate' do
+      @result[:cert].subject.to_s.
+                     should match(/O=Massachusetts Institute of Technology/)
+    end
+    it 'should contain a certificate matching the key' do
+      @result[:cert].public_key.to_pem.should == @result[:key].public_key.to_pem
+    end
+  end
+  
+  describe 'get_certificate with bad credentials' do
+    it 'should raise ArgumentError' do
+      lambda {
+        Stellar::Auth.get_certificate test_mit_kerberos.merge(:pass => 'fail')
+      }.should raise_error(ArgumentError)
+    end
+  end
+end

data/spec/stellar/client_spec.rb

@@ -0,0 +1,58 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe Stellar::Client do
+  let(:client) { Stellar::Client.new }
+  
+  shared_examples_for 'an authenticated client' do
+    describe 'get_nokogiri' do
+      let(:page) { client.get_nokogiri '/atstellar' }
+      
+      it 'should be a Nokogiri document' do
+        page.should be_kind_of(Nokogiri::HTML::Document)
+      end
+      
+      it 'should have course links' do
+        page.css('a[title*="class site"]').length.should > 0
+      end
+    end
+  end
+  
+  describe '#auth' do
+    describe 'with Kerberos credentials' do
+      before do
+        client.auth :kerberos => test_mit_kerberos
+      end
+      
+      it_should_behave_like 'an authenticated client'
+    end
+    
+    describe 'with a certificate' do
+      before do
+        client.auth :cert => test_mit_cert
+      end
+      
+      it_should_behave_like 'an authenticated client'
+    end
+
+    describe 'with bad Kerberos credentials' do
+      it 'should raise ArgumentError' do
+        client.auth :kerberos => test_mit_kerberos.merge(:pass => 'fail')
+      end
+    end
+  end
+
+  describe '#course' do
+    before do
+      client.auth :kerberos => test_mit_kerberos
+    end
+    let(:six) { client.course('6.006', 2011, :fall) }
+    
+    it 'should return a Course instance' do
+      six.should be_kind_of(Stellar::Course)
+    end
+    
+    it 'should return a 6.006 course' do
+      six.number.should == '6.006'
+    end
+  end
+end