scutil 0.4.3 → 0.4.4

data/CHANGELOG.rdoc

@@ -1,20 +1,26 @@
 
 ==Changelog
 
-===0.4.3 | 2011-03-14
+===0.4.4 | 2012-05-24
+
+* Added Net::SCP wrapper support to the module functions.
+
+* DRY'd things up a bit.
+
+===0.4.3 | 2012-03-14
 
 * Added preliminary support for a Net::SCP wrapper.
 
-===0.4.2 | 2011-02-23
+===0.4.2 | 2012-02-23
 
 * Fixed bug when using Ruby 1.8.
 
-===0.4.1 | 2011-02-22
+===0.4.1 | 2012-02-22
 
 * Fixed uninitialized constant error introduced in 0.4.0.
 * Yet more doc clean up...
 
-===0.4.0 | 2011-02-21
+===0.4.0 | 2012-02-21
 
 * Added built-in sudo password support.
 * Some new tests and documentation fixes.

data/lib/scutil.rb

@@ -29,7 +29,7 @@ require 'scutil/connection_cache'
 require 'scutil/system_connection'
 
 module Scutil
-  SCUTIL_VERSION = '0.4.3'
+  SCUTIL_VERSION = '0.4.4'
   
   # By default, buffer 10M of data before writing.
   DEFAULT_OUTPUT_BUFFER_SIZE = 0xA00000
@@ -57,7 +57,6 @@ module Scutil
     
     # Should we request a PTY?  Uses custom regex if defined in
     # +:scutil_pty_regex+.
-    #
     def check_pty_needed?(cmd, options, hostname)      
       if options[:scutil_force_pty]
         return true
@@ -124,26 +123,7 @@ module Scutil
       # Do we need a PTY?
       pty_needed = check_pty_needed? cmd, options, hostname
       
-      # Check for an existing connection in the cache based on the hostname.  If
-      # the hostname exists find a suitable connection.
-      conn = nil
-      begin
-        if (Scutil.connection_cache.exists?(hostname))
-          sys_conn = Scutil.connection_cache.fetch(hostname)
-          print "[#{hostname}] Using existing connection\n" if options[:scutil_verbose]
-          conn = sys_conn.get_connection(hostname, username, pty_needed, options)
-        else
-          sys_conn = SystemConnection.new(hostname, options)
-          # Call get_connection first.  Don't add to cache unless established.
-          conn = sys_conn.get_connection(hostname, username, pty_needed, options)
-          print "[#{hostname}] Adding new connection to cache\n" if options[:scutil_verbose]
-          Scutil.connection_cache << sys_conn
-        end
-      rescue Net::SSH::AuthenticationFailed => err
-        raise Scutil::Error.new("Authenication failed for user: #{username}", hostname)
-      rescue SocketError => err
-        raise Scutil::Error.new(err.message, hostname)
-      end
+      conn = find_connection(hostname, username, pty_needed, options)
       
       fh = $stdout
       if (output.nil?)
@@ -269,6 +249,70 @@ Define in :scutil_sudo_passwd or check :scutil_sudo_failed_passwd for the correc
       return exit_status
     end
     
+    begin
+      require 'net/scp'
+    rescue LoadError
+    end
+    
+    if defined? Net::SCP
+      # Convenience method for uploading files.  Only available if you have
+      # Net::SCP.  This function simply calls Net::SCP#upload! but reuses the
+      # SSH connection if it's available.  All options and semantics are
+      # identical to Scutil.exec_command and Net::SCP.
+      #
+      # <em>*NB:* This function currently calls the *blocking* Net::SCP#upload!
+      # function rather than the *non-blocking* #upload function.  This is by
+      # design and will most likely be changed in the near future.</em>
+      def upload(hostname, username, local, remote, new_options={}, &progress)
+        options = get_default_options
+        options.merge! new_options
+        conn = find_connection(hostname, username, false, options)
+        conn.scp.upload!(local, remote, options, &progress)
+      end
+      
+      # Convenience method for downloading files.  Only available if you have
+      # Net::SCP.  This function simply calls Net::SCP#download! but reuses the
+      # SSH connection if it's available.  All options and semantics are
+      # identical to Scutil.exec_command and Net::SCP.  If _local_ is nil the
+      # downloaded file will be stored in a string in memory returned by
+      # +download+.
+      #
+      # <em>*NB:* This function currently calls the *blocking* Net::SCP#download!
+      # function rather than the *non-blocking* #download function.  This is by
+      # design and will most likely be changed in the near future.</em>
+      def download(hostname, username, remote, local=nil, new_options={}, &progress)
+        options = get_default_options
+        options.merge! new_options
+        conn = find_connection(hostname, username, false, options)
+        conn.scp.download!(remote, local, options, &progress)
+      end
+    end
+    
+    # Check for an existing connection in the cache based on _hostname_.  If the
+    # _hostname_ exists find a suitable connection.  Otherwise establish a
+    # connection and add it to the pool.
+    def find_connection(hostname, username, pty_needed=false, options)
+      conn = nil
+      begin
+        if (Scutil.connection_cache.exists?(hostname))
+          sys_conn = Scutil.connection_cache.fetch(hostname)
+          print "[#{hostname}] Using existing connection\n" if options[:scutil_verbose]
+          conn = sys_conn.get_connection(hostname, username, pty_needed, options)
+        else
+          sys_conn = SystemConnection.new(hostname, options)
+          # Call get_connection first.  Don't add to cache unless established.
+          conn = sys_conn.get_connection(hostname, username, pty_needed, options)
+          print "[#{hostname}] Adding new connection to cache\n" if options[:scutil_verbose]
+          Scutil.connection_cache << sys_conn
+        end
+      rescue Net::SSH::AuthenticationFailed => err
+        raise Scutil::Error.new("Authenication failed for user: #{username}", hostname)
+      rescue SocketError => err
+        raise Scutil::Error.new(err.message, hostname)
+      end
+      return conn
+    end
+    
     private
     # Set the default options for connection.
     def get_default_options
@@ -282,4 +326,9 @@ Define in :scutil_sudo_passwd or check :scutil_sudo_failed_passwd for the correc
       }
     end
   end
+  
+  def method_missing(method, *args, &block)
+    return if ((method == :download) || (method == :upload))
+    super
+  end
 end

data/lib/scutil/exec.rb

@@ -20,8 +20,8 @@ module Scutil
     # specified.
     def initialize(hostname, username=nil, options={})
       @hostname = hostname
-      @username =  username.nil? ? ENV['USER'] : username
-      @options = options
+      @username = username.nil? ? ENV['USER'] : username
+      @options  = options
     end
     
     # See Scutil.exec_command.  Takes _cmd_ and optionally _output_, and
@@ -38,22 +38,12 @@ module Scutil
     # Exposes the raw Net::SSH::Connection::Session object associated
     # with +:hostname+.
     def conn(pty_needed=false)
-      sys_conn = nil
-      conn = nil
-      if Scutil.connection_cache.exists?(@hostname)
-        sys_conn = Scutil.connection_cache.fetch(@hostname)
-        conn = sys_conn.get_connection(@hostname, @username, pty_needed, @options)
-      else
-        sys_conn = SystemConnection.new(@hostname, @options)
-        conn = sys_conn.get_connection(@hostname, @username, pty_needed, @options)
-      end
-      Scutil.connection_cache << sys_conn
-      conn
+      Scutil.find_connection(@hostname, @username, pty_needed=false, @options)
     end
     
     # Alter the options set on this instance.
     def set_options(options={})
-      @options.merge!(options)      
+      @options.merge!(options)
     end
     
     begin
@@ -62,30 +52,18 @@ module Scutil
     end
     
     if defined? Net::SCP
-      # Convenience method for uploading files.  Only available if you have
-      # Net::SCP.  This function simply calls Net::SCP#upload! but reuses the
-      # SSH connection if it's available.  All options and semantics are
-      # identical to Scutil.exec_command and Net::SCP.
-      #
-      # <em>*NB:* This function currently calls the *blocking* +upload!+
-      # function rather than the *non-blocking* _upload_ function.  This is by
-      # design and will most likely be changed in the near future.</em>
+      # See Scutil.upload.  The _options_ specified here will take precedence
+      # over those specified in the constructor.
       def upload(local, remote, options={}, &progress)
         set_options options
-        conn.scp.upload!(local, remote, options={}, &progress)
+        Scutil.upload(@hostname, @username, local, remote, @options, &progress)
       end
       
-      # Convenience method for downloading files.  Only available if you have
-      # Net::SCP.  This function simply calls Net::SCP#download! but reuses the
-      # SSH connection if it's available.  All options and semantics are
-      # identical to Scutil.exec_command and Net::SCP.
-      #
-      # <em>*NB:* This function currently calls the *blocking* +download!+
-      # function rather than the *non-blocking* +download+ function.  This is by
-      # design and will most likely be changed in the near future.</em>
+      # See Scutil.download.  The _options_ specified here will take precedence
+      # over those specified in the constructor.
       def download(remote, local=nil, options={}, &progress)
         set_options options
-        conn.scp.download!(remote, local, options={}, &progress)
+        Scutil.download(@hostname, @username, remote, local, @options, &progress)
       end
     end
   end

data/scutil.gemspec

@@ -1,8 +1,8 @@
 
 Gem::Specification.new do |s|
   s.name        = 'scutil'
-  s.version     = '0.4.3'
-  s.date        = '2012-03-14'
+  s.version     = '0.4.4'
+  s.date        = '2012-05-24'
   s.summary     = 'SSH Command UTILity'
   s.description = <<-EOF
     Scutil is a library for conveniently executing commands 

data/test/test_scutil.rb

@@ -279,7 +279,7 @@ class TestScutilAlt < Test::Unit::TestCase
 end
 
 if (ARGV[0].nil? || (ARGV[0] !~ /\w+:\d+/))
-  puts "Usage: #{$0} host:port"
+  puts "Usage: #{$0} host:port [--name testname]"
   exit(1)
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: scutil
 version: !ruby/object:Gem::Version
-  version: 0.4.3
+  version: 0.4.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-14 00:00:00.000000000 Z
+date: 2012-05-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: net-ssh
@@ -72,7 +72,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.18
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: SSH Command UTILity