oode 0.1.6 → 0.2.0

data/man/oode.1.ronn

@@ -1,68 +1,67 @@
-oode(1) -- print from a laptop to an AT printer
-===============================================
+oode(1) -- work with DICE from a laptop
+=======================================
 
 ## SYNOPSIS
 
-`oode` [<OPTIONS>] <FILE>...<br>
+`oode` [<GLOBAL OPTIONS>] <COMMAND> [<OPTIONS>] <FILE>...
 
 ## DESCRIPTION
 
-`oode` makes printing to the printers in Appleton Tower much easier
-from laptops by automating some of the tediousness from the sequence
-of tasks required.
+`oode` is a program that simplifies working with the DICE network from
+a laptop in Appleton Tower. As of the current version `oode` is able to
+print to any of the printers on the DICE network with more functionality
+in the near future.
 
 ## SAMPLE USAGE
 
-* `oode -p at3 file.pdf`:
-	Print `file.pdf` to the printer `at3`.
+* `oode print -P at3 file.pdf`:
+	Print the file *file.pdf* to the printer *at3*.
 
-* `oode -p at13c -4 -n 5 file.pdf`:
-	Print 5 copies of `file.pdf` to printer `at13c` using the 4-up layout.
-	
-* `oode -p at13c -u s08xxxxx -a passw0rd file.pdf`:
-	Print `file.pdf` to `at13c` as user `s08xxxxx` authenticating with password `passw0rd`.
+* `oode print -P at13c -2 -n 3 file.pdf`:
+  Print *3* copies of the file *file.pdf* to the printer *at3* in the
+  *two-up* page layout.
 
 ## CONFIGURATION
 
 `oode` can read SSH authentication usernames and passwords from a
-configuration file so you don't have to type them in every time. A
-file called `.ooderc` should be placed in your home directory with
-the following contents:
+configuration file so you don't have to type them in every time.
 
-	:user: <username>
-	:password: <password>
+The following command will create the file `~/.ooderc` that contains
+global options so that you don't have to type them each time.
 
-Either of these can be missed if you would rather enter them yourself
-each time.
+  `oode -u s0xxxxxx -p passw0rd initconfig`
 
-## OPTIONS
-The following options and flags can be used with `oode`:
+Either of these can be omitted if you would rather enter them yourself
+each time or you can specify them at the command line like above for
+individual commands.
 
-### Authentication
+### GLOBAL OPTIONS
 
-* `-u`, `--user`=<USERNAME>:
+* `-u`, `--username`=<USERNAME>:
 	Your DICE username so that `oode` can authenticate.
 	
-* `-a`, `--password`=<PASSWORD>:
+* `-p`, `--password`=<PASSWORD>:
 	Your DICE password so that `oode` can authenticate.
 	
-### Miscellaneous
+## COMMANDS
+
+The following options and flags can be used with `oode`:
+
+### Print
 
-* `-p`, `--printer`=<PRINTER>:
+* `-P`, `--printer`=<PRINTER>:
 	Use the printer, <PRINTER>, to print the <FILES>.
 
 * `-f`, `--force`:
 	Force `oode` to use a certain printer even if it is not desired.
 
-### Printing
-
 * `-n`, `--number`=<NUMBER>:
 	Print <NUMBER> copies of the <FILES>.
 
-* `-2`, `--two-up`:
+* `-2`, `--two`:
 	Print the files in the 2-up style.
 
-* `-4`, `--four-up`:
+* `-4`, `--four`:
 	Print the files in the 4-up style.
 
 ## BUGS
@@ -75,5 +74,4 @@ Chris Brown :: cb@tardis.ed.ac.uk :: @xoebus
 
 ## SEE ALSO
 
-<http://github.com>,
-<http://github.com/xoebus/oode>
+<http://github.com>, <http://github.com/xoebus/oode>

data/test/domain/oodefile_test.rb

@@ -0,0 +1,59 @@
+$LOAD_PATH.unshift File.dirname(File.dirname(__FILE__))
+require 'helper'
+
+class OodeFileTest < Test::Unit::TestCase
+  def setup
+    @user = Oode::User.new('s0812345', 'passw0rd')
+    
+    @file_relative = Oode::File.new('LICENSE', @user)
+    @file_absolute = Oode::File.new(File.join(Dir.pwd, 'LICENSE'), @user)
+  end
+  
+  def test_relative_path
+    assert_equal 'LICENSE', @file_relative.path
+  end
+  
+  def test_relative_remote_path
+    assert_equal '/home/s0812345/.oode/LICENSE', @file_relative.remote_path
+  end
+  
+  def test_relative_extension
+    assert_equal '', @file_relative.extension
+  end
+  
+  def test_relative_extension_ruby
+    file_ruby = Oode::File.new(__FILE__, @user)
+    assert_equal 'rb', file_ruby.extension
+  end
+  
+  def test_relative_basename
+    assert_equal 'LICENSE', @file_relative.basename
+  end
+  
+  def test_relative_size
+    assert_equal 1054, @file_relative.size
+    assert_equal '1.029KB', @file_relative.size.to_human
+  end
+  
+  def test_absolute_remote_path
+    assert_equal '/home/s0812345/.oode/LICENSE', @file_absolute.remote_path
+  end
+  
+  def test_absolute_extension
+    assert_equal '', @file_absolute.extension
+  end
+  
+  def test_absolute_extension_ruby
+    file_ruby = Oode::File.new(File.expand_path(__FILE__), @user)
+    assert_equal 'rb', file_ruby.extension
+  end
+  
+  def test_absolute_basename
+    assert_equal 'LICENSE', @file_absolute.basename
+  end
+  
+  def test_absolute_size
+    assert_equal 1054, @file_absolute.size
+    assert_equal '1.029KB', @file_absolute.size.to_human
+  end
+end

data/test/domain/oodeuser_test.rb

@@ -0,0 +1,20 @@
+$LOAD_PATH.unshift File.dirname(File.dirname(__FILE__))
+require 'helper'
+
+class OodeUserTest < Test::Unit::TestCase
+  def setup
+    @user = Oode::User.new('s0812345', 'passw0rd')
+  end
+  
+  def test_username
+    assert_equal 's0812345', @user.username
+  end
+  
+  def test_password
+    assert_equal 'passw0rd', @user.password
+  end
+  
+  def test_homedir
+    assert_equal '/home/s0812345', @user.home
+  end
+end

data/test/helper.rb

@@ -1,9 +1,6 @@
-require 'test/unit'
+require 'minitest/unit'
 
-begin
-  require 'redgreen'
-rescue LoadError
-end
+begin; require 'turn'; rescue LoadError; end
 
 $LOAD_PATH.unshift File.dirname(__FILE__) + '/../lib'
 require 'oode'
@@ -19,3 +16,25 @@ class Test::Unit::TestCase
     assert !haystack.include?(needle)
   end
 end
+
+# Used for testing private methods
+class Class
+  def publicize_methods
+    saved_private_instance_methods = self.private_instance_methods
+    self.class_eval { public *saved_private_instance_methods }
+    yield
+    self.class_eval { private *saved_private_instance_methods }
+  end
+end
+
+# Since tests can't have a usernames and passwords in them we can grab
+# them from the tester's config.
+def config var
+  data = ''
+  f = File.open(File.expand_path('~/.ooderc'), 'r') 
+  f.each_line do |line|
+    if line =~ /^:#{var}:/
+      return line.split(" ")[1]
+    end
+  end
+end

data/test/net/oodedownloader_test.rb

@@ -0,0 +1,20 @@
+$LOAD_PATH.unshift File.dirname(File.dirname(__FILE__))
+require 'helper'
+
+class OodeDownloaderTest < Test::Unit::TestCase
+  def setup
+    user = Oode::User.new(config('u'), config('p'))
+    @downloader = Oode::Downloader.new(user)
+  end
+
+  def test_download_file
+    @downloader.download!("/home/#{config 'u'}/.bashrc")
+
+    expected = @downloader.exec!("sha1sum ~/.bashrc",
+                                  :machine => 'raycroft').split.first
+    actual = `shasum ./.bashrc`.split.first
+    assert_equal expected, actual
+
+    `rm ./.bashrc`
+  end
+end

data/test/net/oodesession_test.rb

@@ -0,0 +1,21 @@
+$LOAD_PATH.unshift File.dirname(File.dirname(__FILE__))
+require 'helper'
+
+class OodeSessionTest < Test::Unit::TestCase
+  def setup
+    user = Oode::User.new(config('u'), config('p'))
+    @session = Oode::Session.new(user)
+  end
+
+  def test_exec_machine_default
+    expected = 'shackleton.inf.ed.ac.uk'
+    actual = @session.exec!("hostname")
+    assert_equal expected, actual
+  end
+
+  def test_exec_machine_raycroft
+    expected = 'raycroft.inf.ed.ac.uk'
+    actual = @session.exec!("hostname", :machine => 'raycroft')
+    assert_equal expected, actual
+  end
+end

data/test/net/oodeuploader_test.rb

@@ -0,0 +1,23 @@
+$LOAD_PATH.unshift File.dirname(File.dirname(__FILE__))
+require 'helper'
+
+class OodeUploaderTest < Test::Unit::TestCase
+  def setup
+    user = Oode::User.new(config('u'), config('p'))
+    @uploader = Oode::Uploader.new(user)
+    @file = Oode::File.new(__FILE__, user)
+
+    @uploader.clean!
+  end
+
+  def test_upload_file
+    @uploader.upload!(@file)
+
+    expected = `shasum #{__FILE__}`.split.first
+    actual = @uploader.exec!("sha1sum ~/.oode/#{@file.basename}",
+                                        :machine => 'raycroft').split.first
+    assert_equal expected, actual
+
+    @uploader.clean!
+  end
+end

data/test/print/oodeprinter_test.rb

@@ -0,0 +1,255 @@
+$LOAD_PATH.unshift File.dirname(File.dirname(__FILE__))
+require 'helper'
+
+class MockSession
+  def exec!(command, options = {})
+    command
+  end
+end
+
+PRINTER_WORKING = <<EOS
+lp is ready and printing
+Rank   Owner      Job  Files                            Total Size
+active cantin     625  scourse.ps                       38467 bytes
+1st    cantin     626  history.ps                       44529 bytes
+EOS
+
+PRINTER_OVERFULL = <<EOS
+lp is ready and printing
+Rank   Owner      Job  Files                            Total Size
+active cantin     625  scourse.ps                       38467 bytes
+1st    cantin     626  history.ps                       44529 bytes
+2nd    cantin     627  history.ps                       44529 bytes
+3rd    cantin     628  history.ps                       44529 bytes
+4th    cantin     629  history.ps                       44529 bytes
+5th    cantin     630  history.ps                       44529 bytes
+6th    cantin     631  history.ps                       44529 bytes
+EOS
+
+PRINTER_ON_FIRE = <<EOS
+lp is not ready
+EOS
+
+class MockBrokenPrinterSession
+  def exec!(command, options = {})
+     return PRINTER_ON_FIRE.strip
+  end
+end
+
+class MockOverfullPrinterSession
+  def exec!(command, options = {})
+     return PRINTER_OVERFULL.strip
+  end
+end
+
+class MockWorkingPrinterSession
+  def exec!(command, options = {})
+     return PRINTER_WORKING.strip
+  end
+end
+
+class MockLargeFile
+  def size
+    # HUGE FILE!
+    9999999999
+  end
+end
+
+class MockSmallFile
+  def size
+    1
+  end
+end
+
+def error message
+  puts "ERROR: #{message}".red
+end
+
+class OodePrinterTest < Test::Unit::TestCase
+  PRINTER_NAME = 'at3'
+  
+  def setup
+    user = Oode::User.new('s0812345', 'passw0rd')
+    @file = Oode::File.new(__FILE__, user)
+    @session = MockSession.new
+    
+    @printer = Oode::Printer.new(PRINTER_NAME, @session)
+  end
+  
+  def test_print!
+    expected = 'lpr -P at3 /home/s0812345/.oode/oodeprinter_test.rb'
+    command = @printer.print!(@file)
+    assert_equal expected, command 
+  end
+  
+  def test_check_size_small
+    Oode::Printer.publicize_methods do
+      small_file = MockSmallFile.new
+      assert @printer.check_size(small_file)
+    end
+  end
+  
+  def test_check_size_small_io
+    Oode::Printer.publicize_methods do
+      small_file = MockSmallFile.new
+      
+      out, err = capture_io do
+        @printer.check_size(small_file)
+      end
+      
+      assert_empty out
+    end
+  end
+  
+  def test_check_size_large
+    Oode::Printer.publicize_methods do
+      large_file = MockLargeFile.new
+      refute @printer.check_size(large_file)
+    end
+  end
+  
+  def test_check_size_large_io
+    Oode::Printer.publicize_methods do
+      large_file = MockLargeFile.new
+
+      out, err = capture_io do
+        @printer.check_size(large_file)
+      end
+      
+      assert_match(/big/, out)
+    end
+  end
+  
+  def test_check_printer_working
+    Oode::Printer.publicize_methods do
+      session = MockWorkingPrinterSession.new
+      working_printer = Oode::Printer.new(PRINTER_NAME, session)
+      
+      assert working_printer.check_working
+    end
+  end
+  
+  def test_check_printer_working_io
+    Oode::Printer.publicize_methods do
+      session = MockWorkingPrinterSession.new
+      working_printer = Oode::Printer.new(PRINTER_NAME, session)
+      
+      out, err = capture_io do
+        working_printer.check_working
+      end
+      
+      assert_empty out
+    end
+  end
+  
+  def test_check_printer_force
+    Oode::Printer.publicize_methods do
+      session = MockBrokenPrinterSession.new
+      force_printer = Oode::Printer.new(PRINTER_NAME, session, :force => true)
+      
+      assert force_printer.check_working
+    end
+  end
+  
+  def test_check_printer_broken
+    Oode::Printer.publicize_methods do
+      session = MockBrokenPrinterSession.new
+      broken_printer = Oode::Printer.new(PRINTER_NAME, session)
+      
+      refute broken_printer.check_working
+    end
+  end
+  
+  def test_check_printer_broken_io
+    Oode::Printer.publicize_methods do
+      session = MockBrokenPrinterSession.new
+      broken_printer = Oode::Printer.new(PRINTER_NAME, session)
+      
+      out, err = capture_io do
+        broken_printer.check_working
+      end
+      
+      assert_match(/isn\'t doing too well/, out)
+    end
+  end
+  
+  def test_check_printer_overfull
+    Oode::Printer.publicize_methods do
+      session = MockOverfullPrinterSession.new
+      overfull_printer = Oode::Printer.new(PRINTER_NAME, session)
+      
+      refute overfull_printer.check_working
+    end
+  end
+  
+  def test_check_printer_overfull_io
+    Oode::Printer.publicize_methods do
+      session = MockOverfullPrinterSession.new
+      overfull_printer = Oode::Printer.new(PRINTER_NAME, session)
+      
+      out, err = capture_io do
+        overfull_printer.check_working
+      end
+      
+      assert_match(/isn\'t doing too well/, out)
+    end
+  end
+  
+  def test_print_command_default
+    Oode::Printer.publicize_methods do
+      expected = "lpr -P at3 /home/s0812345/.oode/oodeprinter_test.rb"
+      actual = @printer.print_command(@file)
+      assert_equal expected, actual
+    end
+  end
+  
+  def test_print_command_copies
+    Oode::Printer.publicize_methods do
+      copies_printer = Oode::Printer.new(PRINTER_NAME, @session, :number => 6)
+      
+      expected = "lpr -P at3 -# 6 /home/s0812345/.oode/oodeprinter_test.rb"
+      actual = copies_printer.print_command(@file)
+      assert_equal expected, actual
+    end
+  end
+  
+  def test_print_command_two_up
+    Oode::Printer.publicize_methods do
+      two_printer = Oode::Printer.new(PRINTER_NAME, @session, :format => :two)
+      
+      expected = "lpr -P at3 -Z 2up /home/s0812345/.oode/oodeprinter_test.rb"
+      actual = two_printer.print_command(@file)
+      assert_equal expected, actual
+    end
+  end
+  
+  def test_print_command_four_up
+    Oode::Printer.publicize_methods do
+      four_printer = Oode::Printer.new(PRINTER_NAME, @session, :format => :four)
+      
+      expected = "lpr -P at3 -Z 4up /home/s0812345/.oode/oodeprinter_test.rb"
+      actual = four_printer.print_command(@file)
+      assert_equal expected, actual
+    end
+  end
+  
+  def test_print_command_copies_and_two_up
+    Oode::Printer.publicize_methods do
+      options_printer = Oode::Printer.new(PRINTER_NAME, @session, :number => 3, :format => :two)
+      
+      expected = "lpr -P at3 -# 3 -Z 2up /home/s0812345/.oode/oodeprinter_test.rb"
+      actual = options_printer.print_command(@file)
+      assert_equal expected, actual
+    end
+  end
+  
+  def test_print_command_copies_and_four_up
+    Oode::Printer.publicize_methods do
+      options_printer = Oode::Printer.new(PRINTER_NAME, @session, :number => 3, :format => :four)
+      
+      expected = "lpr -P at3 -# 3 -Z 4up /home/s0812345/.oode/oodeprinter_test.rb"
+      actual = options_printer.print_command(@file)
+      assert_equal expected, actual
+    end
+  end
+end