oode 0.1.3 → 0.1.4

data/bin/oode

@@ -21,6 +21,7 @@ end
 
 optparse = OptionParser.new do |opts|
   opts.banner = "Usage: oode [options] filename"
+  options[:options] = {}
   
   opts.on( "-h", "--help", "Display this screen." ) do
     puts opts
@@ -32,7 +33,10 @@ optparse = OptionParser.new do |opts|
     options[:printer] = printer
   end
   
-  options[:options] = {}
+  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
@@ -43,18 +47,23 @@ optparse = OptionParser.new do |opts|
   end
   
   options[:password] = config[:password]
-  opts.on( "-a", "--password PASSWORD",
-           "The password to log into DICE with." ) do |password|
+  opts.on( "-a", "--password PASSWORD", "The password to log into DICE with." ) do |password|
     options[:password] = password
   end
+  
+  opts.on( "-4", "--four-up", "Print the document as four pages to a sheet." ) do |opt|
+    options[:options][:four] = true
+  end
+  
+  opts.on( "-2", "--two-up", "Print the document as two pages to a sheet." ) do |opt|
+    options[:options][:two] = true
+  end
 end
 
 optparse.parse!
 
 if options[:printer].nil?
-  puts "No printer was specified.".red
-  puts "Please specify one with the '--printer' or '-p' flags."
-  exit
+  error "No printer was specified.\nPlease specify one with the '--printer' or '-p' flags."
 end
 
 if options[:user].nil?

data/lib/oode.rb

@@ -1,4 +1,5 @@
 require "oode/colour"
+require "oode/helper"
 require "oode/queue"
 require "oode/file"
 require "oode/version"

data/lib/oode/helper.rb

@@ -0,0 +1,7 @@
+def error message
+  abort "ERROR: #{message}".red
+end
+
+def notify message
+  puts "INFO: #{message}".yellow
+end

data/lib/oode/queue.rb

@@ -7,34 +7,48 @@ module Oode
       @user = user
       @password = password
       @printer = printer
+      @options = options
       
-      args_from_options options
+      args_from_options @options
+      
+      begin
+        notify "Connecting to remote server..."
+        @ssh = Net::SSH.start('ssh.inf.ed.ac.uk', @user, :password => @password)
+        @sftp = @ssh.sftp
+      rescue Net::SSH::AuthenticationFailed
+        error "Your login credentials were incorrect. Please fix this and try again."
+      rescue Net::SSH::Exception
+        error "Something went wrong with your SSH connection. Please file a bug report at:\nhttp://github.com/xoebus/oode/issues"
+      end
     end
   
     def print
-      Net::SSH.start('ssh.inf.ed.ac.uk', @user, :password => @password) do |ssh|
-        sftp = ssh.sftp
-        
-        puts "Checking remote destination...".yellow
-        unless sftp.dir.entries(remote_user_path).map { |d| d.name }.include? ".oode"
-          sftp.mkdir! remote_oode_path
-        end
-        
-        puts "Uploading files for printing...".yellow
-        @queue.each do |file|
-          file.upload sftp, remote_oode_path
-        end
-        
-        puts "Printing files on #{@printer.red}...".yellow
-        @queue.each do |file|
-          file.print ssh, remote_oode_path, @printer, @args
-        end
-        
-        # Make sure the job has been sent to the printer.
-        sleep 1
-        
-        puts "Cleaning up this mess...".yellow
-        clean ssh, remote_oode_path
+      check_server
+      check_printer
+      upload_files
+    
+      notify "Printing files on #{@printer.red}..."
+      @queue.each do |file|
+        file.print @ssh, remote_oode_path, @printer, @args
+      end
+    
+      # Make sure the job has been sent to the printer.
+      sleep 1
+      
+      clean @ssh
+    end
+    
+    def upload_files
+      notify "Uploading files for printing..."
+      @queue.each do |file|
+        file.upload @sftp, remote_oode_path
+      end
+    end
+    
+    def check_server
+      notify "Checking remote server..."
+      unless @sftp.dir.entries(remote_user_path).map { |d| d.name }.include? ".oode"
+        @sftp.mkdir! remote_oode_path
       end
     end
     
@@ -45,16 +59,36 @@ module Oode
       if options.has_key? :copies
         @args << "-# #{options[:copies]} "
       end
-      
-      @args
+
+      if options.has_key? :four
+        @args << "-Z 4up "
+      elsif options.has_key? :two
+        @args << "-Z 2up "
+      end
+    end
+    
+    def check_printer
+      unless @options.has_key? :force
+        notify "Checking your printer is working..."
+        
+        command = "lpq -P #{@printer}"
+        output = @ssh.exec!("ssh student.login #{command}")
+        print_jobs = output.split("\n").length - 2
+
+        if (print_jobs > 5) || !(output =~ /is not ready/).nil?
+          error "#{@printer} isn't doing too well at the moment. Try another printer."
+        end
+      end
     end
     
     def remote_user_path
       "/home/#{@user}"
     end
     
-    def clean session, directory
-      command = "rm -r #{directory}"
+    def clean session
+      notify "Cleaning up this mess..."
+      
+      command = "rm -r /home/#{@user}/.oode"
       session.exec!("ssh student.login #{command}")
       #puts command.blue
     end

data/lib/oode/version.rb

@@ -1,3 +1,3 @@
 module Oode
-  Version = VERSION = '0.1.3'
+  Version = VERSION = '0.1.4'
 end

data/man/oode.1

@@ -7,11 +7,72 @@
 \fBoode\fR \-\- print from a laptop to an AT printer
 .
 .SH "SYNOPSIS"
-\fBoode\fR \fIOPTIONS\fR \fIFILENAMES\fR
+\fBoode\fR [\fIOPTIONS\fR] \fIFILE\fR...
+.
+.br
 .
 .SH "DESCRIPTION"
+\fBoode\fR makes printing to the printers in Appleton Tower much easier
+from laptops by automating some of the tediousness from the sequence
+of tasks required.
 .
 .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
+file called \fB.ooderc\fR should be placed in your home directory with
+the following contents:
+.
+.IP "" 4
+.
+.nf
+
+:user: <username>
+:password: <password>
+.
+.fi
+.
+.IP "" 0
+.
+.P
+Either of these can be missed if you would rather enter them yourself
+each time.
+.
+.SH "OPTIONS"
+The following options and flags can be used with \fBoode\fR:
+.
+.SS "Authentication"
+.
+.TP
+\fB\-u\fR, \fB\-\-user\fR=\fIUSERNAME\fR
+  Your DICE username so that \fBoode\fR can authenticate.
+.
+.TP
+\fB\-a\fR, \fB\-\-password\fR=\fIPASSWORD\fR
+  Your DICE password so that \fBoode\fR can authenticate.
+.
+.SS "Miscellaneous"
+.
+.TP
+\fB\-p\fR, \fB\-\-printer\fR=\fIPRINTER\fR
+  Use the printer, \fIPRINTER\fR, to print the \fIFILES\fR.
+.
+.TP
+\fB\-f\fR, \fB\-\-force\fR
+  Force \fBoode\fR to use a certain printer even if it is not desired.
+.
+.SS "Printing"
+.
+.TP
+\fB\-n\fR, \fB\-\-number\fR=\fINUMBER\fR
+  Print \fINUMBER\fR copies of the \fIFILES\fR.
+.
+.TP
+\fB\-2\fR, \fB\-\-two\-up\fR
+  Print the files in the 2\-up style.
+.
+.TP
+\fB\-4\fR, \fB\-\-four\-up\fR
+  Print the files in the 4\-up style.
 .
 .SH "BUGS"
 \fIhttp://github.com/xoebus/oode/issues\fR

data/man/oode.1.html

@@ -67,12 +67,57 @@
 
 <h2>SYNOPSIS</h2>
 
-<p><code>oode</code> <var>OPTIONS</var> <var>FILENAMES</var></p>
+<p><code>oode</code> [<var>OPTIONS</var>] <var>FILE</var>...<br /></p>
 
 <h2>DESCRIPTION</h2>
 
+<p><code>oode</code> makes printing to the printers in Appleton Tower much easier
+from laptops by automating some of the tediousness from the sequence
+of tasks required.</p>
+
 <h2>CONFIGURATION</h2>
 
+<p><code>oode</code> 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 <code>.ooderc</code> should be placed in your home directory with
+the following contents:</p>
+
+<pre><code>:user: &lt;username>
+:password: &lt;password>
+</code></pre>
+
+<p>Either of these can be missed if you would rather enter them yourself
+each time.</p>
+
+<h2>OPTIONS</h2>
+
+<p>The following options and flags can be used with <code>oode</code>:</p>
+
+<h3>Authentication</h3>
+
+<dl>
+<dt><code>-u</code>, <code>--user</code>=<var>USERNAME</var></dt><dd><p>  Your DICE username so that <code>oode</code> can authenticate.</p></dd>
+<dt><code>-a</code>, <code>--password</code>=<var>PASSWORD</var></dt><dd><p>  Your DICE password so that <code>oode</code> can authenticate.</p></dd>
+</dl>
+
+
+<h3>Miscellaneous</h3>
+
+<dl>
+<dt><code>-p</code>, <code>--printer</code>=<var>PRINTER</var></dt><dd><p>  Use the printer, <var>PRINTER</var>, to print the <var>FILES</var>.</p></dd>
+<dt><code>-f</code>, <code>--force</code></dt><dd><p>  Force <code>oode</code> to use a certain printer even if it is not desired.</p></dd>
+</dl>
+
+
+<h3>Printing</h3>
+
+<dl>
+<dt><code>-n</code>, <code>--number</code>=<var>NUMBER</var></dt><dd><p>  Print <var>NUMBER</var> copies of the <var>FILES</var>.</p></dd>
+<dt><code>-2</code>, <code>--two-up</code></dt><dd><p>  Print the files in the 2-up style.</p></dd>
+<dt><code>-4</code>, <code>--four-up</code></dt><dd><p>  Print the files in the 4-up style.</p></dd>
+</dl>
+
+
 <h2>BUGS</h2>
 
 <p><a href="http://github.com/xoebus/oode/issues">http://github.com/xoebus/oode/issues</a></p>

data/man/oode.1.ronn

@@ -3,13 +3,56 @@ oode(1) -- print from a laptop to an AT printer
 
 ## SYNOPSIS
 
-`oode` <OPTIONS> <FILENAMES>
+`oode` [<OPTIONS>] <FILE>...<br>
 
 ## 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.
 
 ## 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:
+
+	:user: <username>
+	:password: <password>
+
+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>:
+	Your DICE username so that `oode` can authenticate.
+	
+* `-a`, `--password`=<PASSWORD>:
+	Your DICE password so that `oode` can authenticate.
+	
+### Miscellaneous
+
+* `-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`:
+	Print the files in the 2-up style.
+
+* `-4`, `--four-up`:
+	Print the files in the 4-up style.
 
 ## BUGS
 

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 1
-  - 3
-  version: 0.1.3
+  - 4
+  version: 0.1.4
 platform: ruby
 authors: 
 - Chris Brown
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-29 00:00:00 +01:00
+date: 2010-04-30 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -67,6 +67,7 @@ files:
 - LICENSE
 - lib/oode/colour.rb
 - lib/oode/file.rb
+- lib/oode/helper.rb
 - lib/oode/queue.rb
 - lib/oode/version.rb
 - lib/oode.rb