gofer 0.1.1 → 0.1.2

data/HISTORY.md

@@ -1,5 +1,9 @@
 # Revision History
 
+### v0.1.2 03/05/2011
+
+ * Pass through Gofer::Host instantiation options straight through to Net::SSH.
+
 ### v0.1.1 23/04/2011
 
  * Minimal RDoc added.
@@ -11,4 +15,4 @@
  
 ### v0.0.1 03/04/2011
 
- * Initial release
+ * Initial release

data/README.md

@@ -8,12 +8,13 @@
   * print and capture STDOUT and STDERR automatically
   * allow you to access captured STDOUT and STDERR individually or as a combined string
   * override the above: return non-zero exit status instead of raising an error, suppress output
+  * persist the SSH connection so that multiple commands don't incur connection penalties
 
 ## Examples
 
 ### Instantiation
 
-    h = Gofer::Host.new('ubuntu', 'my.host.com', :identity_file => 'key.pem')
+    h = Gofer::Host.new('ubuntu', 'my.host.com', :keys => ['key.pem'])
 
 ### Run a command
 
@@ -76,7 +77,7 @@
  
 * ls, exists?, directory? should use sftp if available rather than shell commands
 * wrap STDOUT with host prefix for easy identification of system output
-* RDoc
+* Deal with timeouts/disconnects on persistent connections
 
 ## License
 

data/lib/gofer/host.rb

@@ -9,9 +9,13 @@ module Gofer
     
     attr_reader :hostname
 
-    def initialize username, _hostname, identity_file=nil
+    # Create a new Host connection
+    # 
+    # +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 username, _hostname, opts={}
       @hostname = _hostname
-      @ssh = SshWrapper.new(username, hostname, identity_file)
+      @ssh = SshWrapper.new(username, hostname, opts)
     end
 
     # Run +command+.

data/lib/gofer/ssh_wrapper.rb

@@ -6,53 +6,53 @@ module Gofer
 
     attr_reader :last_output, :last_exit_status
 
-    def initialize username, hostname, identity_file = nil
+    def initialize username, hostname, opts={}
       @username = username
       @hostname = hostname
-      @identity_file = identity_file
       @last_exit_status = nil
       @last_output = nil
+      
+      # support legacy positional argument use
+      if opts.is_a? String
+        opts = { :keys => [opts]}
+      end
+      
+      # support legacy identity_file argument
+      if opts[:identity_file]
+        opts[:keys] = [opts.delete(:identity_file)]
+      end
+      
+      @net_ssh_options = opts
     end
 
     def run command, opts={}
-      response = nil
-      Net::SSH.start(*net_ssh_credentials) do |ssh|
-        response = ssh_execute(ssh, command, opts)
-      end
-      response
+      ssh_execute(ssh, command, opts)
     end
     
     def read_file path
-      a = nil
-      with_scp do |scp|
-        a = scp.download! path
-      end
-      a
+      scp.download! path
     end
 
     def download from, to, opts={}
-      with_scp do |scp|
-        scp.download! from, to, opts
-      end
+      scp.download! from, to, opts
     end
 
     def upload from, to, opts={}
-      with_scp do |scp|
-        scp.upload! from, to, opts
-      end
+      scp.upload! from, to, opts
     end
 
     private
   
-    def with_scp 
-      Net::SCP.start(*net_ssh_credentials) do |scp|
-        yield scp
-      end
+    def ssh
+      @ssh ||= Net::SSH.start(*net_ssh_credentials)
+    end
+    
+    def scp 
+      @scp ||= Net::SCP.new(ssh)
     end
 
     def net_ssh_credentials
-      creds = [@hostname, @username]
-      creds << {:keys => [@identity_file] } if @identity_file
+      creds = [@hostname, @username, @net_ssh_options]
       creds
     end
 

data/lib/gofer/version.rb

@@ -1,3 +1,3 @@
 module Gofer # :nodoc:
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

data/spec/gofer/integration_spec.rb

@@ -30,7 +30,7 @@ describe Gofer do
   end
     
   before :all do
-    @host = Gofer::Host.new(USERNAME, HOSTNAME, IDENTITY_FILE)
+    @host = Gofer::Host.new(USERNAME, HOSTNAME, :keys => [IDENTITY_FILE])
     @tmpdir = raw_ssh("mktemp -d /tmp/gofertest.XXXXX").chomp
   end
 
@@ -42,6 +42,16 @@ describe Gofer do
     end
   end
   
+  describe :new do
+    it "should support the legacy positional argument" do
+      Gofer::Host.new(USERNAME, HOSTNAME, IDENTITY_FILE).run("echo hello", :quiet => true).should == "hello\n"
+    end
+    
+    it "should support the legacy identity_file key" do
+      Gofer::Host.new(USERNAME, HOSTNAME, :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

metadata

@@ -2,7 +2,7 @@
 name: gofer
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors: 
 - Michael Pearson
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-23 00:00:00 +10:00
+date: 2011-05-03 00:00:00 +10:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency