oode 0.1.6 → 0.2.0

data/README.md

@@ -1,69 +1,27 @@
-oode
-====
+# oode
 
-*print from a laptop to an AT printer*
+<a href="http://stillmaintained.com/xoebus/oode">
+    <img src="http://stillmaintained.com/xoebus/oode.png" />
+</a>
 
-`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` makes working in Appleton Tower with a laptop a little less soul
+destroying.
 
-## SAMPLE USAGE
+## Getting Help
+There are a couple of ways to get help for using `oode`.
 
-* `oode -p at3 file.pdf`
-	* Print `file.pdf` to the printer `at3`.
+1. If you use `gem man` then there is a man page avaliable.
 
-* `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`.
+2. Come on IRC and ask me a question. (I'm **xoebus** on *Freenode* and
+   *ImaginaryNet*.
 
-## CONFIGURATION FILE
+3. Find me in Appleton Tower!
 
-`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:
+## Bugs
+Report any you find here: <http://github.com/xoebus/oode/issues>
 
-	:user: <username>
-	:password: <password>
+## Authors
+* Chris Brown ([xoebus](http://github.com/xoebus/))
 
-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`:
-	Your DICE username so that `oode` can authenticate.
-	
-* `-a`, `--password`:
-	Your DICE password so that `oode` can authenticate.
-	
-### Miscellaneous
-
-* `-p`, `--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`:
-	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
-
-<http://github.com/xoebus/oode/issues>
-
-## AUTHOR
-
-Chris Brown :: cb@tardis.ed.ac.uk :: @xoebus
-
-## SEE ALSO
-
-<http://github.com>,
-<http://github.com/xoebus/oode>
+## See Also
+<http://github.com/xoebus>, <http://github.com/xoebus/oode>

data/Rakefile

@@ -1,7 +1,16 @@
+require 'rake/testtask'
+require 'metric_fu'
+
+MetricFu::Configuration.run do |config|
+  config.metrics  = [:churn, :flog, :roodi, :flay, :reek]
+  config.graphs   = [:flog, :flay, :reek]
+end
+
+task :default => [:test]
+
 #
 # Helpers
 #
-
 def command?(command)
   `type -t #{command}`
   $?.success?
@@ -18,16 +27,14 @@ task :check_dirty do
   end
 end
 
-
 #
 # Tests
 #
-
 if command? :turn
   desc "Run tests"
   task :test do
     suffix = "-n #{ENV['TEST']}" if ENV['TEST']
-    sh "turn test/*.rb #{suffix}"
+    sh "turn -m test/**/*_test.rb #{suffix}"
   end
 else
   Rake::TestTask.new do |t|
@@ -38,11 +45,9 @@ else
   end
 end
 
-
 #
-# Ron
+# Ronn
 #
-
 if command? :ronn
   desc "Show the manual"
   task :man => "man:build" do
@@ -51,15 +56,25 @@ if command? :ronn
 
   desc "Build the manual"
   task "man:build" do
-    sh "ronn -br5 --organization=XOEBUS --manual='Oode Manual' man/*.ronn"
+    sh "ronn -i --date=`date +%Y-%m-%d` --organization=Lolsoft --manual='Oode Manual' -sprint,toc -w man/*.ronn"
   end
 end
 
+desc "Publish to GitHub Pages"
+task :pages => [ "man:build", :check_dirty ] do
+  cp "man/oode.1.html", "html"
+  sh "git checkout gh-pages"
+  sh "mv html index.html"
+  sh "git add index.html"
+  sh "git commit -m 'update man page'"
+  sh "git push origin gh-pages"
+  sh "git checkout develop"
+  puts :done
+end
 
 #
-# Gems
+# Gem
 #
-
 begin
   require 'mg'
   MG.new('oode.gemspec')
@@ -68,7 +83,6 @@ rescue LoadError
   warn "Install it with: gem install mg"
 end
 
-
 desc "Push a new version."
 task :publish => "gem:publish" do
   require 'oode/version'

data/bin/oode

@@ -1,106 +1,109 @@
 #!/usr/bin/env ruby
 
-require "optparse"
-require "yaml"
-
-require "rubygems"
-require "net/ssh"
-require "net/sftp"
-require "highline/import"
-
-$LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'lib')
-require "oode"
-
-options = {}
-
-begin
-  config = YAML.load_file(File.expand_path('~/.ooderc'))
-rescue
-  config = { :user => nil, :password => nil}
-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
-  end
-  
-  opts.on( "-f", "--force", "Force the print job no matter what state the printer is in." ) do |force|
-    options[:options][:force] = true
-  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
+require 'gli'
+require 'gli_version'
+require 'highline/import'
+
+$: << File.expand_path(File.join('..', __FILE__, '/../lib'))
+require 'oode'
+
+include GLI
+
+# Commands that require authentication
+AUTH_COMMANDS = [:print, :push]
+
+# Oode Information
+version Oode::VERSION 
+config_file '.ooderc'
+
+# Global Flags
+desc 'DICE username'
+arg_name 'username'
+flag [:u, :username]
+
+desc 'DICE password'
+arg_name 'password'
+flag [:p, :password]
+
+# Print Command
+desc 'Print files to DICE printers'
+arg_name '[files]'
+long_desc <<EOS
+This command allows for the printing of local files to any of the
+printers on the DICE network.
+EOS
+command [:print] do |c|
+  c.desc 'The printer to send the files to.'
+  c.arg_name 'NAME'
+  c.flag [:P, :printer]
+
+  c.desc 'Force the job to print no matter what state the printer is in.'
+  c.default_value false
+  c.switch [:f, :force]
+
+  c.desc 'The number of copies of each file yo would like to print.'
+  c.arg_name 'COPIES'
+  c.default_value 1
+  c.flag [:n, :number]
+
+  c.desc 'Print the document as four pages to a sheet.'
+  c.switch ['4', :four]
+
+  c.desc 'Print the document as two pages to a sheet.'
+  c.switch ['2', :two]
+
+  c.action do |global_options,options,args|
+    user = Oode::User.new(global_options[:username], global_options[:password])
+    print_session = Oode::Uploader.new(user)
+    
+    config = Hash.new
+    
+    if config[:two]
+      config[:format] = :two
+    elsif config[:four]
+      config[:format] = :four
+    end
+    
+    config[:number] = options[:number] if options[:number] != 1
+    config[:force] = true if options[:force]
+    
+    error "You must specify a printer." unless options[:printer]
+    
+    printer = Oode::Printer.new(options[:printer], print_session, config)
+    
+    files = Array.new
+    args.each do |arg|
+      files << Oode::File.new(arg, user)
+    end
+    
+    files.each do |file|
+      print_session.upload!(file)
+    end
+    
+    files.each do |file|
+      printer.print!(file)
+    end
+    
+    print_session.clean!
   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 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
-
-if options[:user].nil?
-  options[:user] = ask("Username: ")
-end
-
-if options[:password].nil?
-  options[:password] = ask("Password: ") { |q| q.echo = false}
-end
-
-print_queue = Oode::OodeQueue.new options[:user], options[:password], options[:printer], options[:options]
-
-ARGV.each do |filename|
-  unless File.directory?(filename)
-    print_queue.enqueue filename
-  else
-    warning "#{filename} is a directory and will not be printed..."
-    exit
+pre do |global_options,command,options,args|
+  if (!command.nil? && AUTH_COMMANDS.include?(command.name))
+    # No Username
+    if global_options[:username].nil?
+      username = ask("Username: ")    
+      global_options.update({ :u => username, :username => username })
+    end
+  
+    # No Password
+    if global_options[:password].nil?
+      password = ask("Password: ") { |q| q.echo = "*" * rand(3) }    
+      global_options.update({ :p => password, :password => password })
+    end
   end
+    
+  true
 end
 
-unless print_queue.empty?
-  print_queue.print
-end
+GLI.run(ARGV)

data/lib/oode.rb

@@ -1,5 +1,18 @@
-require "oode/colour"
-require "oode/helper"
-require "oode/queue"
-require "oode/file"
-require "oode/version"
+# Version
+require 'oode/version'
+
+# Extension Classes
+require 'oode/ext/ext'
+
+# Domain Models
+require 'oode/domain/user'
+require 'oode/domain/file' 
+
+# Network
+require 'oode/net/session'
+require 'oode/net/transferer'
+require 'oode/net/uploader'
+require 'oode/net/downloader'
+
+# Printing
+require 'oode/print/printer'

data/lib/oode/domain/file.rb

@@ -0,0 +1,27 @@
+module Oode
+  class File
+    attr_reader :path
+    attr_reader :user
+    
+    def initialize(path, user)
+      @path = path
+      @user = user
+    end
+    
+    def remote_path
+      ::File.expand_path(::File.join(@user.home, ".oode", basename))
+    end
+    
+    def extension
+      ::File.extname(path).split(".")[1].to_s
+    end
+    
+    def basename
+      ::File.basename(path)
+    end
+    
+    def size
+      ::File.size(::File.expand_path(path))
+    end
+  end
+end

data/lib/oode/domain/user.rb

@@ -0,0 +1,16 @@
+module Oode
+  class User
+    attr_reader :username
+    attr_reader :password
+    
+    def initialize(username, password)
+      @username = username
+      @password = password
+    end
+    
+    def home
+      "/home/#{username}"
+    end
+  end
+end
+