oode 0.1.5 → 0.1.6

data/CONTRIBUTORS

@@ -0,0 +1,6 @@
+Contributors
+============
+
+* Chris Brown (xoebus)
+
+For an up to date list see here: http://github.com/xoebus/oode/contributors.

data/HISTORY.md

@@ -0,0 +1,39 @@
+## 0.1.6 (2010-05-01)
+
+* Don't try and print directories.
+* More house keeping.
+
+## 0.1.5 (2010-04-30)
+
+* Warn the user that the file is very large when they print it.
+
+## 0.1.4 (2010-04-30)
+
+* Better error messages.
+* Check printers before printing.
+* Added -4 and -2 printing options.
+
+## 0.1.2 (2010-04-29)
+
+* Added --number argument.
+* Fixed a bug that stopped files being printed if they had spaces in.
+
+## 0.1.1 (2010-04-28)
+
+* New prompts for user and password.
+
+## 0.1.0 (2010-04-28)
+
+* Lots of housekeeping.
+
+## 0.0.3 (2010-04-26)
+
+* Fixed a bug that was caused by the gateway not printing files.
+
+## 0.0.2 (2010-04-26)
+
+* Code now works.
+
+## 0.0.1 (2010-04-26)
+
+* First release

data/README.md

@@ -1,43 +1,44 @@
-oode(1) -- print from a laptop to an AT printer
-===============================================
+oode
+====
 
-## SYNOPSIS
+*print from a laptop to an AT printer*
 
-`oode` [<OPTIONS>] <FILE>...<br>
+`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.
 
-## DESCRIPTION
+## SAMPLE USAGE
 
-`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 -p at3 file.pdf`
+	* Print `file.pdf` to the printer `at3`.
 
-## CONFIGURATION
+* `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`.
+
+## CONFIGURATION FILE
 
-`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:
+`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:
 
 	:user: <username>
 	:password: <password>
 
-Either of these can be missed if you would rather enter them yourself
-each time.
+Either of these can be missed if you would rather enter them yourself each time.
 
 ## OPTIONS
 The following options and flags can be used with `oode`:
 
 ### Authentication
 
-* `-u`, `--user`=<USERNAME>:
+* `-u`, `--user`:
 	Your DICE username so that `oode` can authenticate.
 	
-* `-a`, `--password`=<PASSWORD>:
+* `-a`, `--password`:
 	Your DICE password so that `oode` can authenticate.
 	
 ### Miscellaneous
 
-* `-p`, `--printer`=<PRINTER>:
+* `-p`, `--printer`:
 	Use the printer, <PRINTER>, to print the <FILES>.
 
 * `-f`, `--force`:
@@ -45,7 +46,7 @@ The following options and flags can be used with `oode`:
 
 ### Printing
 
-* `-n`, `--number`=<NUMBER>:
+* `-n`, `--number`:
 	Print <NUMBER> copies of the <FILES>.
 
 * `-2`, `--two-up`:

data/bin/oode

@@ -21,13 +21,18 @@ end
 
 optparse = OptionParser.new do |opts|
   opts.banner = "Usage: oode [options] filename"
+  opts.program_name = "oode"
+  opts.version = Oode::Version
   options[:options] = {}
-  
+
   opts.on( "-h", "--help", "Display this screen." ) do
     puts opts
     exit
   end
   
+  opts.separator ""
+  opts.separator "General"
+
   options[:printer] = nil
   opts.on( "-p", "--printer PRINTER", "The printer to send the file to." ) do |printer|
     options[:printer] = printer
@@ -36,21 +41,27 @@ optparse = OptionParser.new do |opts|
   opts.on( "-f", "--force", "Force the print job no matter what state the printer is in." ) do |force|
     options[:options][:force] = true
   end
-  
-  opts.on( "-n", "--number COPIES", "The number of copies of FILE you would like to print." ) do |copies|
-    options[:options][:copies] = copies
-  end
+
+  opts.separator ""
+  opts.separator "Authentication"
   
   options[:user] = config[:user]
   opts.on( "-u", "--user USER", "The user to log into DICE with." ) do |user|
     options[:user] = user
   end
-  
+
   options[:password] = config[:password]
   opts.on( "-a", "--password PASSWORD", "The password to log into DICE with." ) do |password|
     options[:password] = password
   end
-  
+
+  opts.separator ""
+  opts.separator "Printing Options"
+
+  opts.on( "-n", "--number COPIES", "The number of copies of FILE you would like to print." ) do |copies|
+    options[:options][:copies] = copies
+  end
+
   opts.on( "-4", "--four-up", "Print the document as four pages to a sheet." ) do |opt|
     options[:options][:four] = true
   end
@@ -62,6 +73,11 @@ end
 
 optparse.parse!
 
+if ARGV.empty?
+	puts optparse.help
+	exit
+end
+
 if options[:printer].nil?
   error "No printer was specified.\nPlease specify one with the '--printer' or '-p' flags."
 end
@@ -77,7 +93,14 @@ end
 print_queue = Oode::OodeQueue.new options[:user], options[:password], options[:printer], options[:options]
 
 ARGV.each do |filename|
-  print_queue.enqueue filename
+  unless File.directory?(filename)
+    print_queue.enqueue filename
+  else
+    warning "#{filename} is a directory and will not be printed..."
+    exit
+  end
 end
 
-print_queue.print
+unless print_queue.empty?
+  print_queue.print
+end

data/lib/oode/file.rb

@@ -13,18 +13,16 @@ module Oode
       path = File.join directory, @remote_filename
       command = "lpr -P #{printer} #{args}#{path}"
       session.exec!("ssh student.login #{command}")
-      #puts command.blue
+      # puts command.blue
     end
 
     def check_size
       limit = 5242880 # 5MB
       file_size = File.size(@filename)
 
-      warning "Your file is pretty big (#{file_size.to_human}). It may take a while to print..."
-    end
-
-    def remote_path
-       File.join File.expand_path("/home/.oode/"), @filename
+      if file_size > limit
+        warning "Your file is pretty big (#{file_size.to_human}). It may take a while to print..."
+      end
     end
   end
 end

data/lib/oode/queue.rb

@@ -27,7 +27,7 @@ module Oode
       check_printer
       upload_files
     
-      notify "Printing files on #{@printer.red}..."
+      notify "Printing files on #{@printer.red}#{"...".yellow}"
       @queue.each do |file|
         file.check_size
         file.print @ssh, remote_oode_path, @printer, @args
@@ -36,7 +36,7 @@ module Oode
       # Make sure the job has been sent to the printer.
       sleep 1
       
-      clean @ssh
+      clean
     end
     
     def upload_files
@@ -86,12 +86,12 @@ module Oode
       "/home/#{@user}"
     end
     
-    def clean session
+    def clean
       notify "Cleaning up this mess..."
       
       command = "rm -r /home/#{@user}/.oode"
-      session.exec!("ssh student.login #{command}")
-      #puts command.blue
+      @ssh.exec!("ssh student.login #{command}")
+      # puts command.blue
     end
     
     def remote_oode_path
@@ -101,6 +101,10 @@ module Oode
     def length
       @queue.length
     end
+
+    def empty?
+      length.zero?
+    end
   
     def enqueue(filename)
       file = OodeFile.new(filename)

data/lib/oode/version.rb

@@ -1,3 +1,3 @@
 module Oode
-  Version = VERSION = '0.1.5'
+  Version = VERSION = '0.1.6'
 end

data/man/oode.1

@@ -1,7 +1,7 @@
 .\" generated with Ronn/v0.5
 .\" http://github.com/rtomayko/ronn/
 .
-.TH "OODE" "1" "April 2010" "XOEBUS" "Oode Manual"
+.TH "OODE" "1" "May 2010" "XOEBUS" "Oode Manual"
 .
 .SH "NAME"
 \fBoode\fR \-\- print from a laptop to an AT printer
@@ -16,6 +16,20 @@
 from laptops by automating some of the tediousness from the sequence
 of tasks required.
 .
+.SH "SAMPLE USAGE"
+.
+.TP
+\fBoode \-p at3 file.pdf\fR
+  Print \fBfile.pdf\fR to the printer \fBat3\fR.
+.
+.TP
+\fBoode \-p at13c \-4 \-n 5 file.pdf\fR
+  Print 5 copies of \fBfile.pdf\fR to printer \fBat13c\fR using the 4\-up layout.
+.
+.TP
+\fBoode \-p at13c \-u s08xxxxx \-a passw0rd file.pdf\fR
+  Print \fBfile.pdf\fR to \fBat13c\fR as user \fBs08xxxxx\fR authenticating with password \fBpassw0rd\fR.
+.
 .SH "CONFIGURATION"
 \fBoode\fR can read SSH authentication usernames and passwords from a
 configuration file so you don't have to type them in every time. A

data/man/oode.1.html

@@ -75,6 +75,15 @@
 from laptops by automating some of the tediousness from the sequence
 of tasks required.</p>
 
+<h2>SAMPLE USAGE</h2>
+
+<dl>
+<dt><code>oode -p at3 file.pdf</code></dt><dd><p>  Print <code>file.pdf</code> to the printer <code>at3</code>.</p></dd>
+<dt><code>oode -p at13c -4 -n 5 file.pdf</code></dt><dd><p>  Print 5 copies of <code>file.pdf</code> to printer <code>at13c</code> using the 4-up layout.</p></dd>
+<dt><code>oode -p at13c -u s08xxxxx -a passw0rd file.pdf</code></dt><dd><p>  Print <code>file.pdf</code> to <code>at13c</code> as user <code>s08xxxxx</code> authenticating with password <code>passw0rd</code>.</p></dd>
+</dl>
+
+
 <h2>CONFIGURATION</h2>
 
 <p><code>oode</code> can read SSH authentication usernames and passwords from a
@@ -134,7 +143,7 @@ each time.</p>
 
 <ol class='foot man'>
   <li class='tl'>XOEBUS</li>
-  <li class='tc'>April 2010</li>
+  <li class='tc'>May 2010</li>
   <li class='tr'>oode(1)</li>
 </ol>
 

data/man/oode.1.ronn

@@ -11,6 +11,17 @@ oode(1) -- print from a laptop to an AT printer
 from laptops by automating some of the tediousness from the sequence
 of tasks required.
 
+## SAMPLE USAGE
+
+* `oode -p at3 file.pdf`:
+	Print `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`.
+
 ## CONFIGURATION
 
 `oode` can read SSH authentication usernames and passwords from a

data/test/helper.rb

@@ -0,0 +1,21 @@
+require 'test/unit'
+
+begin
+  require 'redgreen'
+rescue LoadError
+end
+
+$LOAD_PATH.unshift File.dirname(__FILE__) + '/../lib'
+require 'oode'
+
+class Test::Unit::TestCase
+  # Asserts that `haystack` includes `needle`.
+  def assert_includes(needle, haystack)
+    assert haystack.include?(needle)
+  end
+
+  # Asserts that `haystack` does not include `needle`.
+  def assert_not_includes(needle, haystack)
+    assert !haystack.include?(needle)
+  end
+end

data/test/test_oodefile.rb

@@ -0,0 +1,8 @@
+$LOAD_PATH.unshift File.dirname(__FILE__)
+require 'helper'
+
+class OodeFileTest < Test::Unit::TestCase
+  def test_test
+    assert_equal true, true
+  end
+end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 1
-  - 5
-  version: 0.1.5
+  - 6
+  version: 0.1.6
 platform: ruby
 authors: 
 - Chris Brown
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-30 00:00:00 +01:00
+date: 2010-05-01 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -53,7 +53,7 @@ dependencies:
         version: "0"
   type: :runtime
   version_requirements: *id003
-description: oode prints to AT printers from laptops
+description: "  `oode` makes printing to the printers in Appleton Tower much\n  easier from laptops by automating some of the tediousness\n  from the sequence of tasks required.\n"
 email: cb@tardis.ed.ac.uk
 executables: 
 - oode
@@ -65,6 +65,8 @@ files:
 - README.md
 - Rakefile
 - LICENSE
+- CONTRIBUTORS
+- HISTORY.md
 - lib/oode/colour.rb
 - lib/oode/file.rb
 - lib/oode/helper.rb
@@ -75,6 +77,8 @@ files:
 - man/oode.1
 - man/oode.1.html
 - man/oode.1.ronn
+- test/helper.rb
+- test/test_oodefile.rb
 has_rdoc: true
 homepage: http://github.com/xoebus/oode
 licenses: []