gofer 0.2.5 → 0.2.6

data/lib/gofer/host.rb

@@ -2,38 +2,41 @@ require 'tempfile'
 
 module Gofer
   class HostError < Exception # :nodoc:
-    def initialize host, message
+    attr_reader :host, :response
+    def initialize host, response, message
+      @host = host
+      @response = response
       super "#{host.hostname}: #{message}"
     end
   end
- 
+
   class Host
-    
+
     attr_reader :hostname
     attr_accessor :quiet
 
     # Create a new Host connection
-    # 
+    #
     # Options:
-    # 
+    #
     # +quiet+:: Don't print stdout output from +run+ commands
     # All other+opts+ is passed through directly to Net::SSH.start
     # See http://net-ssh.github.com/ssh/v2/api/index.html for valid arguments.
     def initialize _hostname, username, opts={}
       @hostname = _hostname
-      
+
       # support legacy positional argument use
       if opts.is_a? String
         opts = { :keys => [opts]}
       end
-      
+
       @quiet = opts.delete(:quiet)
-      
+
       # support legacy identity_file argument
       if opts[:identity_file]
         opts[:keys] = [opts.delete(:identity_file)]
       end
-      
+
       @ssh = SshWrapper.new(hostname, username, opts)
     end
 
@@ -41,10 +44,10 @@ module Gofer
     #
     # Raise an error if +command+ exits with a non-zero status.
     #
-    # Print +stdout+ and +stderr+ as they're received. 
+    # Print +stdout+ and +stderr+ as they're received.
     #
     # Return a Gofer::Response object.
-    # 
+    #
     # Options:
     #
     # +quiet+:: Don't print +stdout+, can also be set with +quiet=+ on the instance
@@ -54,19 +57,19 @@ module Gofer
       opts[:quiet] = quiet unless opts.include?(:quiet)
       response = @ssh.run command, opts
       if !opts[:capture_exit_status] && response.exit_status != 0
-        raise HostError.new(self, "Command #{command} failed with exit status #{@ssh.last_exit_status}")
+        raise HostError.new(self, response, "Command #{command} failed with exit status #{@ssh.last_exit_status}")
       end
       response
     end
-    
+
     # Run +commands+ one by one in order.
     #
     # Raise an error if a command in +commands+ exits with a non-zero status.
     #
-    # Print +stdout+ and +stderr+ as they're received. 
+    # Print +stdout+ and +stderr+ as they're received.
     #
     # Return a Gofer::Response object.
-    # 
+    #
     # Options:
     #
     # +quiet+:: Don't print +stdout+, can also be set with +quiet=+ on the instance
@@ -75,11 +78,11 @@ module Gofer
     # The behaviour of passing +capture_exit_status+ here is undefined.
     def run_multiple commands, opts={}
       return if commands.empty?
-      
+
       responses = commands.map do |command|
         run command, opts
       end
-      
+
       first_response = responses.shift
       responses.reduce(first_response) do |cursor, response|
         Response.new(cursor.stdout + response.stdout, cursor.stderr + response.stderr, cursor.output + response.output, 0)
@@ -91,7 +94,7 @@ module Gofer
       @ssh.run("sh -c '[ -e #{path} ]'").exit_status == 0
     end
 
-    # Return the contents of the file at +path+. 
+    # Return the contents of the file at +path+.
     def read path
       @ssh.read_file path
     end
@@ -107,20 +110,20 @@ module Gofer
       if response.exit_status == 0
         response.stdout.strip.split("\n")
       else
-        raise HostError.new(self, "Could not list #{path}, exit status #{response.exit_status}")
+        raise HostError.new(self, response, "Could not list #{path}, exit status #{response.exit_status}")
       end
     end
 
-    # Upload the file or directory at +from+ to +to+. 
-    def upload from, to
-      @ssh.upload from, to, :recursive => File.directory?(from)
+    # Upload the file or directory at +from+ to +to+.
+    def upload from, to, opts = {}
+      @ssh.upload from, to, {:recursive => File.directory?(from)}.merge(opts)
     end
 
     # Download the file or directory at +from+ to +to+
-    def download from, to
-      @ssh.download from, to, :recursive => directory?(from)
+    def download from, to, opts = {}
+      @ssh.download from, to, {:recursive => directory?(from)}.merge(opts)
     end
-    
+
     # Write +data+ to a file at +to+
     def write data, to
       Tempfile.open "gofer_write" do |file|

data/lib/gofer/version.rb

@@ -1,3 +1,3 @@
 module Gofer # :nodoc:
-  VERSION = "0.2.5"
-end
+  VERSION = "0.2.6"
+end

data/spec/gofer/integration_spec.rb

@@ -2,21 +2,21 @@ require 'spec_helper'
 require 'tempfile'
 
 describe Gofer do
- 
+
   HOSTNAME = ENV['TEST_HOST'] || 'localhost'
   USERNAME = ENV['TEST_USER'] || ENV['USER']
   IDENTITY_FILE = ENV['TEST_IDENTITY_FILE'] || '~/.ssh/id_rsa'
 
   def raw_ssh command
     out = `ssh -o PasswordAuthentication=no -ni #{IDENTITY_FILE} #{USERNAME}@#{HOSTNAME} #{command}`
-    raise "Command #{command} failed" unless $? == 0 
+    raise "Command #{command} failed" unless $? == 0
     out
   end
 
   def in_tmpdir path
     File.join(@tmpdir, path)
   end
-    
+
   def with_local_tmpdir template
     f = Tempfile.new template
     path = f.path
@@ -28,7 +28,7 @@ describe Gofer do
       FileUtils.rm_rf path unless ENV['KEEPTMPDIR']
     end
   end
-    
+
   before :all do
     @host = Gofer::Host.new(HOSTNAME, USERNAME, :keys => [IDENTITY_FILE], :quiet => true)
     @tmpdir = raw_ssh("mktemp -d /tmp/gofertest.XXXXX").chomp
@@ -41,17 +41,17 @@ describe Gofer do
       raw_ssh "rm -rf #{@tmpdir}" if @tmpdir && @tmpdir =~ %r{gofertest}
     end
   end
-  
+
   describe :new do
     it "should support the legacy positional argument" do
       Gofer::Host.new(HOSTNAME, USERNAME, IDENTITY_FILE).run("echo hello", :quiet => true).should == "hello\n"
     end
-    
+
     it "should support the legacy identity_file key" do
       Gofer::Host.new(HOSTNAME, USERNAME, :identity_file => IDENTITY_FILE).run("echo hello", :quiet => true).should == "hello\n"
     end
   end
-  
+
   describe :hostname do
     it "should be the hostname of the host we're connecting to" do
       @host.hostname.should == HOSTNAME
@@ -62,32 +62,38 @@ describe Gofer do
     it "and capture stdout in @response.stdout" do
       @response.stdout.should == "stdout\n"
     end
-  
+
     it "and capture stderr in @response.stderr" do
       @response.stderr.should == "stderr\n"
     end
-  
+
     it "and combine captured stdout / stderr in @response.output" do
       @response.output.should == "stdout\nstderr\n"
     end
-  
+
     it "and @response by itself should be the captured stdout" do
       @response.should == "stdout\n"
     end
   end
-  
+
   describe :run do
-      
+
     describe "with a stdout and stderr responses" do
-      before :all do 
+      before :all do
         @response = @host.run "echo stdout; echo stderr 1>&2", :quiet_stderr => true
       end
-      
+
       it_should_behave_like "an output capturer"
     end
 
     it "should error if a command returns a non-zero response" do
-      lambda {@host.run "false"}.should raise_error /failed with exit status/
+      lambda {@host.run "false"}.should raise_error(/failed with exit status/)
+      begin
+        @host.run "false"
+      rescue Gofer::HostError => e
+        e.response.should be_a Gofer::Response
+        e.host.should be_a Gofer::Host
+      end
     end
 
     it "should capture a non-zero exit status if asked" do
@@ -95,7 +101,7 @@ describe Gofer do
       response.exit_status.should == 1
     end
   end
-  
+
   describe :run_multiple do
     describe "with stdout and stderr responses" do
       before :all do
@@ -103,12 +109,12 @@ describe Gofer do
       end
       it_should_behave_like "an output capturer"
     end
-    
+
     it "should error if a command returns a non-zero response" do
       lambda {@host.run_multiple ["echo", "false"]}.should raise_error /failed with exit status/
     end
   end
-    
+
   describe :exist? do
     it "should return true if a path or file exists" do
       raw_ssh "touch #{in_tmpdir 'exists'}"
@@ -137,7 +143,7 @@ describe Gofer do
       @host.read(@tmpdir + '/hello.txt').should == "hello\n"
     end
   end
-    
+
   describe :ls do
     it "should list the contents of a directory" do
       raw_ssh "mkdir #{@tmpdir}/lstmp && touch #{@tmpdir}/lstmp/f"
@@ -165,7 +171,7 @@ describe Gofer do
       end
     end
   end
-  
+
   describe :write do
     it "should write a file to the remote server" do
       @host.write("some data\n", in_tmpdir('written'))
@@ -190,7 +196,7 @@ describe Gofer do
       with_local_tmpdir 'download_dir' do |path|
         download_dir = in_tmpdir 'download_dir'
         raw_ssh "mkdir #{download_dir} && echo 'sup' > #{download_dir}/hey"
-      
+
         @host.download(download_dir, path)
         File.open(path + '/download_dir/hey').read.should == "sup\n"
       end

metadata

@@ -1,8 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: gofer
 version: !ruby/object:Gem::Version 
+  hash: 27
   prerelease: 
-  version: 0.2.5
+  segments: 
+  - 0
+  - 2
+  - 6
+  version: 0.2.6
 platform: ruby
 authors: 
 - Michael Pearson
@@ -10,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-02 00:00:00 Z
+date: 2012-08-29 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: net-ssh
@@ -20,6 +25,11 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 33
+        segments: 
+        - 2
+        - 0
+        - 23
         version: 2.0.23
   type: :runtime
   version_requirements: *id001
@@ -31,12 +41,19 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 31
+        segments: 
+        - 1
+        - 0
+        - 4
         version: 1.0.4
   type: :runtime
   version_requirements: *id002
-description: "\n\
-  Gofer provides a flexible and reliable model for performing tasks on remote\n\
-  server using Net::SSH\n"
+description: |
+  
+  Gofer provides a flexible and reliable model for performing tasks on remote
+  server using Net::SSH
+
 email: 
 - mipearson@gmail.com
 executables: []
@@ -72,17 +89,23 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.8.3
+rubygems_version: 1.8.17
 signing_key: 
 specification_version: 3
 summary: run commands on remote servers using SSH