stellar 0.2.0 → 0.3.0

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.3.0

data/lib/stellar.rb

@@ -1,4 +1,5 @@
 # Standard library.
+require 'date'
 require 'json'
 require 'openssl'
 require 'uri'
@@ -23,3 +24,4 @@ require 'stellar/client.rb'
 require 'stellar/courses.rb'
 require 'stellar/gradebook.rb'
 require 'stellar/homework.rb'
+require 'stellar/members.rb'

data/lib/stellar/courses.rb

@@ -99,7 +99,7 @@ class Course
       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'])]
+      [link.inner_text.strip, URI.join(course_page.url, link['href'])]
     end]
   end
   
@@ -112,6 +112,11 @@ class Course
   def gradebook
     @gradebook ||= Stellar::Gradebook.new self
   end
+
+  # Client scoped to the course's Members module.
+  def members
+    @members ||= Stellar::Members.new self
+  end
 end  # class Stellar::Course
 
 end  # namespace Stellar

data/lib/stellar/gradebook.rb

@@ -23,8 +23,8 @@ class Gradebook
     @url = course.navigation['Gradebook']
     
     page = @client.get_nokogiri @url
-    @navigation = Hash[page.css('#toolBox.dashboard dd a').map { |link|
-      [link.inner_text, URI.join(page.url, link['href'])]
+    @navigation = Hash[page.css('#toolBox dd a').map { |link|
+      [link.inner_text.strip, URI.join(page.url, link['href'])]
     }]
   end
 

data/lib/stellar/homework.rb

@@ -83,10 +83,13 @@ class Submission
   # URL to the last file that the student submitted.
   attr_reader :file_url
   
+  # Submission time.
+  attr_reader :time
+  
   # Name of the student who authored this submission.
   attr_reader :name
   
-  # Email of the student who authorted this submission.
+  # Email of the student who authored this submission.
   attr_reader :email
 
   # Comments posted on this submission.
@@ -117,7 +120,7 @@ class Submission
     page = @client.get_nokogiri @url
 
     unless author_link = page.css('#content h4 a[href^="mailto:"]').first
-      raise ArgumentError, 'Invalud submission-listing <tr>'
+      raise ArgumentError, 'Invalid submission-listing <tr>'
     end
     @name = author_link.inner_text
     @email = author_link['href'].sub /^mailto:/, ''
@@ -125,6 +128,13 @@ class Submission
       next nil unless link.inner_text == homework.name
       URI.join @url.to_s, link['href']
     }.reject(&:nil?).first
+    @time = page.css('#rosterBox .instruction').map { |span|
+      unless span.css('strong').any? { |strong| /date/i =~ strong.inner_text }
+        next nil
+      end
+      time_string = span.inner_text.split(':', 2).last.strip
+      time = DateTime.parse(time_string + ' GMT-4').to_time
+    }.reject(&:nil?).first
     
     @add_comment_url = URI.join @url.to_s,
         page.css('#comments a[href*="add"]').first['href']

data/lib/stellar/members.rb

@@ -0,0 +1,142 @@
+# :nodoc: namespace
+module Stellar
+
+# Stellar client scoped to a course's Members module.
+class Members
+  # Maps the text in navigation links to URI objects.
+  #
+  # Example: navigation['Homework'] => <# URI: .../ >
+  attr_reader :navigation
+  
+  # The course whose membership is exposed by this client.
+  attr_reader :course
+  
+  # Generic Stellar client used to make requests.
+  attr_reader :client
+  
+  # Creates a Stellar client scoped to a course's Membership module.
+  #
+  # @param [Stellar::Course] the course whose membership info is desired
+  def initialize(course)
+    @course = course
+    @client = course.client
+    @url = course.navigation['Membership']
+    
+    page = @client.get_nokogiri @url
+    @navigation = Hash[page.css('#toolBox dd a').map { |link|
+      [link.inner_text.strip, URI.join(page.url, link['href'])]
+    }]
+  end
+
+  # All member photos in this course's Membership module.
+  # @return [Stellar::Gradebook::PhotoList] list of member photos for students
+  def photos
+    @students ||= Stellar::Members::PhotoList.new self
+  end  
+
+# Collection of member photos in a course's Membership module.
+class PhotoList
+  # Client scoped to the Membership module supplying this list of photos.
+  attr_reader :course
+  
+  # Generic Stellar client used to make requests.
+  attr_reader :client
+  
+  # Creates a list of member photos for a class.
+  #
+  # @param [Stellar::Members] members client scoped to a course's membership
+  def initialize(members)
+    @course = members.course
+    @client = members.client
+    
+    @url = members.navigation['Member Photos']
+    reload!
+  end
+  
+  # All member photos listed in this course's Membership module.
+  # @return [Array<Stellar::Members::Photo>] photos of students in this course
+  def all
+    @photos
+  end
+  
+  # A photo in the course's Membership module.
+  # @param [String] name the name of the desired member
+  # @return [Stellar::Members::Photo] a photo for a member with the given name,
+  #     or nil if no such member exists
+  def named(name)
+    @photos.find { |a| a.name == name }
+  end
+
+  # A photo in the course's Membership module.
+  # @param [String] email the e-mail of the desired member
+  # @return [Stellar::Members::Photo] a photo for a member with the given name,
+  #     or nil if no such member exists
+  def with_email(email)
+    @photos.find { |a| a.email == email }
+  end
+  
+  # Reloads the contents of this student list.
+  #
+  # @return [Stellar::Gradebook::StudentList] self, for easy call chaining
+  def reload!
+    photo_page = @client.get_nokogiri @url
+    
+    @photos = photo_page.css('#content .cols > div').map { |div|
+      begin
+        Stellar::Members::Photo.new div, @course
+      rescue ArgumentError
+        nil
+      end
+    }.reject(&:nil?)
+    
+    self
+  end
+end  # class Stellar::Members::Photo
+
+# Information about a member's photo
+class Photo
+  # The member's full name.
+  attr_reader :name
+  
+  # The member's e-mail.
+  attr_reader :email
+
+  # URL of the member's photo.
+  attr_reader :url
+  
+  # The course this member belongs to.
+  attr_reader :course
+  
+  # Generic Stellar client used to make requests.
+  attr_reader :client
+  
+  # Creates a Stellar client scoped to a student's Gradebook page.
+  #
+  # @param [Nokogiri::XML::Element] div a <div> representing a member's photo
+  #     and info in the Members Photo page
+  # @param [Stellar::Course] course Stellar client scoped to the
+  #     course that this student belongs to
+  def initialize(div, course)
+    @course = course
+    @client = course.client
+
+    unless img = div.css('img[src*="pictures"]').first
+      raise ArgumentError, 'Invalid photo-listing <div>'
+    end
+    @url = URI.join div.document.url, img['src'].gsub('/half/', '/full/') 
+    unless mail_link = div.css('a[href*="mailto"]').first
+      raise ArgumentError, 'Invalid photo-listing <div>'
+    end
+    @email = mail_link['href'].sub(/^mailto\:/, '')
+    @name = mail_link.inner_text
+  end
+  
+  # The member's photo bits.
+  def data
+    @client.get_file @url
+  end
+end  # class Stellar::Members::Photo
+
+end  # class Stellar::Members
+
+end  # namespace Stellar

data/spec/stellar/courses_spec.rb

@@ -25,10 +25,12 @@ describe Stellar::Courses do
 end
 
 describe Stellar::Course do
-  let(:six) { test_client.course("6.006", 2011, :fall) }
+  before :all do
+    @six = test_client.course("6.006", 2011, :fall)
+  end
   
   describe '#navigation' do
-    let(:nav) { six.navigation }
+    let(:nav) { @six.navigation }
     
     it 'should have a Gradebook link' do
       nav['Gradebook'].should be_kind_of(URI)
@@ -37,5 +39,9 @@ describe Stellar::Course do
     it 'should have a Homework link' do
       nav['Homework'].should be_kind_of(URI)
     end
+
+    it 'should have a Membership link' do
+      nav['Membership'].should be_kind_of(URI)
+    end
   end
 end

data/spec/stellar/homework_submissions_spec.rb

@@ -14,12 +14,15 @@ describe Stellar::Homework::Submission do
   it "should have the author's email" do
     one.email.reverse.should == 'ude.tim@ytsirhc'
   end
+  it 'should have a submission time' do
+    one.time.to_s.should == '2011-09-15 19:55:00 -0400'
+  end
   it 'should have a submission URL' do
     one.file_url.should be_kind_of(URI)
   end
   it 'should have the right bits in the submission' do
     one.file_data.should match(/\% 6\.006/)
-  end  
+  end
   
   it 'should have at least one feedback comment' do
     one.comments.should have_at_least(1).comment

data/spec/stellar/members_spec.rb

@@ -0,0 +1,47 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe Stellar::Members do
+  before :all do
+    @members = test_client.course("6.006", 2011, :fall).members
+  end
+  
+  describe '#navigation' do
+    it 'should have a Member Photos section' do
+      @members.navigation['Member Photos'].should be_kind_of(URI)
+    end
+  end
+
+  describe '#photos' do
+    before :all do
+      @photos = @members.photos
+    end
+
+    describe '#all' do
+      let(:all) { @photos.all} 
+    end 
+    
+    shared_examples_for 'a photo' do
+      it "should have the member's name" do
+        one.name.should == 'Christianne B. Swartz'
+      end
+      it "should have the member's email" do
+        one.email.reverse.should == 'ude.tim@ytsirhc'
+      end
+      it 'should have a photo URL' do
+        one.url.should be_kind_of(URI)
+      end
+      it 'should have the right bits in the photo' do
+        one.data.should match(/JFIF/)
+      end
+    end
+
+    describe '#named' do
+      let(:one) { @photos.named('Christianne B. Swartz') }      
+      it_should_behave_like 'a photo'
+    end
+    describe '#with_email' do
+      let(:one) { @photos.with_email('ude.tim@ytsirhc'.reverse) }      
+      it_should_behave_like 'a photo'
+    end
+  end
+end

data/spec/support/test-credentials.rb

@@ -19,6 +19,6 @@ end
 
 class TestCredentialsCache
   def self.test_client
-    @__test_client ||= Stellar::Client.new.auth :kerberos => test_mit_kerberos  
+    @__test_client ||= Stellar::Client.new.auth :cert => test_mit_cert  
   end
 end

data/stellar.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "stellar"
-  s.version = "0.2.0"
+  s.version = "0.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Victor Costan"]
-  s.date = "2011-10-28"
+  s.date = "2011-10-31"
   s.description = "So we don't have to put up with Stellar's craptastic ui"
   s.email = "victor@costan.us"
   s.extra_rdoc_files = [
@@ -32,6 +32,7 @@ Gem::Specification.new do |s|
     "lib/stellar/courses.rb",
     "lib/stellar/gradebook.rb",
     "lib/stellar/homework.rb",
+    "lib/stellar/members.rb",
     "lib/stellar/mitca.crt",
     "spec/fixtures/.gitkeep",
     "spec/spec_helper.rb",
@@ -42,6 +43,7 @@ Gem::Specification.new do |s|
     "spec/stellar/gradebook_student_spec.rb",
     "spec/stellar/homework_spec.rb",
     "spec/stellar/homework_submissions_spec.rb",
+    "spec/stellar/members_spec.rb",
     "spec/stellar_spec.rb",
     "spec/support/test-credentials.rb",
     "stellar.gemspec"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: stellar
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-10-28 00:00:00.000000000Z
+date: 2011-10-31 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mechanize
-  requirement: &19824800 !ruby/object:Gem::Requirement
+  requirement: &12124280 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: 2.0.2
   type: :runtime
   prerelease: false
-  version_requirements: *19824800
+  version_requirements: *12124280
 - !ruby/object:Gem::Dependency
   name: nokogiri
-  requirement: &19823840 !ruby/object:Gem::Requirement
+  requirement: &12123720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: 1.5.0
   type: :runtime
   prerelease: false
-  version_requirements: *19823840
+  version_requirements: *12123720
 - !ruby/object:Gem::Dependency
   name: rdoc
-  requirement: &19812300 !ruby/object:Gem::Requirement
+  requirement: &12123100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: 3.9.4
   type: :development
   prerelease: false
-  version_requirements: *19812300
+  version_requirements: *12123100
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &19811720 !ruby/object:Gem::Requirement
+  requirement: &12122440 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: 2.6.0
   type: :development
   prerelease: false
-  version_requirements: *19811720
+  version_requirements: *12122440
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &19811080 !ruby/object:Gem::Requirement
+  requirement: &12121800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: 0.7.2
   type: :development
   prerelease: false
-  version_requirements: *19811080
+  version_requirements: *12121800
 - !ruby/object:Gem::Dependency
   name: yard-rspec
-  requirement: &19810280 !ruby/object:Gem::Requirement
+  requirement: &12121120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0.1'
   type: :development
   prerelease: false
-  version_requirements: *19810280
+  version_requirements: *12121120
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &19809620 !ruby/object:Gem::Requirement
+  requirement: &12120540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,10 +87,10 @@ dependencies:
         version: 1.0.21
   type: :development
   prerelease: false
-  version_requirements: *19809620
+  version_requirements: *12120540
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &19809040 !ruby/object:Gem::Requirement
+  requirement: &12119600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -98,10 +98,10 @@ dependencies:
         version: 1.6.4
   type: :development
   prerelease: false
-  version_requirements: *19809040
+  version_requirements: *12119600
 - !ruby/object:Gem::Dependency
   name: rcov
-  requirement: &19808300 !ruby/object:Gem::Requirement
+  requirement: &12114640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -109,10 +109,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *19808300
+  version_requirements: *12114640
 - !ruby/object:Gem::Dependency
   name: ruby-debug
-  requirement: &19806780 !ruby/object:Gem::Requirement
+  requirement: &12113840 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -120,10 +120,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *19806780
+  version_requirements: *12113840
 - !ruby/object:Gem::Dependency
   name: ruby-debug19
-  requirement: &19805900 !ruby/object:Gem::Requirement
+  requirement: &12112920 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -131,10 +131,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *19805900
+  version_requirements: *12112920
 - !ruby/object:Gem::Dependency
   name: highline
-  requirement: &19804800 !ruby/object:Gem::Requirement
+  requirement: &12111740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -142,10 +142,10 @@ dependencies:
         version: 1.6.2
   type: :development
   prerelease: false
-  version_requirements: *19804800
+  version_requirements: *12111740
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &19793180 !ruby/object:Gem::Requirement
+  requirement: &12110680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -153,7 +153,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *19793180
+  version_requirements: *12110680
 description: So we don't have to put up with Stellar's craptastic ui
 email: victor@costan.us
 executables: []
@@ -177,6 +177,7 @@ files:
 - lib/stellar/courses.rb
 - lib/stellar/gradebook.rb
 - lib/stellar/homework.rb
+- lib/stellar/members.rb
 - lib/stellar/mitca.crt
 - spec/fixtures/.gitkeep
 - spec/spec_helper.rb
@@ -187,6 +188,7 @@ files:
 - spec/stellar/gradebook_student_spec.rb
 - spec/stellar/homework_spec.rb
 - spec/stellar/homework_submissions_spec.rb
+- spec/stellar/members_spec.rb
 - spec/stellar_spec.rb
 - spec/support/test-credentials.rb
 - stellar.gemspec
@@ -205,7 +207,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1478260872774288007
+      hash: -1213779627807188058
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: