scutil 0.4.2 → 0.4.3

data/CHANGELOG.rdoc

@@ -1,6 +1,10 @@
 
 ==Changelog
 
+===0.4.3 | 2011-03-14
+
+* Added preliminary support for a Net::SCP wrapper.
+
 ===0.4.2 | 2011-02-23
 
 * Fixed bug when using Ruby 1.8.

data/README.rdoc

@@ -33,6 +33,10 @@ All of this syntactic sugar can be used as a simple class method with
 Scutil.exec_command, as an instantiable class with Scutil::Exec, or as a mixin
 with the module Scutil.
 
+You can now you scutil to manage you Net::SCP connections as well.  Two wrapper
+functions will be defined if you have Net::SCP installed.  Still in early steps,
+see Scutil::Exec.
+
 ==Synopsis:
 
 You can use scutil in a few different ways, for more usage examples see Scutil.

data/lib/scutil.rb

@@ -29,7 +29,7 @@ require 'scutil/connection_cache'
 require 'scutil/system_connection'
 
 module Scutil
-  SCUTIL_VERSION = '0.4.2'
+  SCUTIL_VERSION = '0.4.3'
   
   # By default, buffer 10M of data before writing.
   DEFAULT_OUTPUT_BUFFER_SIZE = 0xA00000
@@ -212,7 +212,6 @@ Define in :scutil_sudo_passwd.", hostname)
               sudo_passwd_state = :done
             end
           when :waiting
-#            if (data == "\n")
             if (data =~ passwd_failed_regex)
               # Bad sudo password
               raise Scutil::Error.new("[#{conn.host}:#{channel.local_id}] Password failed for sudo.  

data/lib/scutil/exec.rb

@@ -16,7 +16,7 @@ module Scutil
     include Scutil
     attr_reader :hostname,:username
     
-    # Defaults to current user (ENV['USER'] if _username_ is not
+    # Defaults to current user (ENV['USER']) if _username_ is not
     # specified.
     def initialize(hostname, username=nil, options={})
       @hostname = hostname
@@ -24,25 +24,21 @@ module Scutil
       @options = options
     end
     
-    # See Scutil.exec_command.  Takes _cmd_ and optionally _output_,
-    # and _options_.  Other arguments specified at class
-    # initialization.
+    # See Scutil.exec_command.  Takes _cmd_ and optionally _output_, and
+    # _options_.  Other arguments specified at class initialization.
     #
-    # The _options_ specified here will take precedence over those
-    # specified in the constructor.
+    # The _options_ specified here will take precedence over those specified in
+    # the constructor.
     def exec_command(cmd, output=nil, options={})
       # Local map has precedence.
       set_options(options)
       Scutil.exec_command(@hostname, @username, cmd, output, @options)
     end
     
-    def set_options(options={})
-      @options.merge!(options)      
-    end
-    
-    # Exposes the raw Net:SSH::Connection::Session object associated
-    # with @hostname.
+    # 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)
@@ -51,7 +47,46 @@ module Scutil
         sys_conn = SystemConnection.new(@hostname, @options)
         conn = sys_conn.get_connection(@hostname, @username, pty_needed, @options)
       end
+      Scutil.connection_cache << sys_conn
       conn
     end
+    
+    # Alter the options set on this instance.
+    def set_options(options={})
+      @options.merge!(options)      
+    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* +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(local, remote, options={}, &progress)
+        set_options 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.
+      #
+      # <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>
+      def download(remote, local=nil, options={}, &progress)
+        set_options options
+        conn.scp.download!(remote, local, options={}, &progress)
+      end
+    end
   end
 end

data/scutil.gemspec

@@ -1,8 +1,8 @@
 
 Gem::Specification.new do |s|
   s.name        = 'scutil'
-  s.version     = '0.4.2'
-  s.date        = '2012-02-23'
+  s.version     = '0.4.3'
+  s.date        = '2012-03-14'
   s.summary     = 'SSH Command UTILity'
   s.description = <<-EOF
     Scutil is a library for conveniently executing commands 
@@ -14,7 +14,7 @@ EOF
   s.homepage    = 'http://marcantonio.github.com/scutil'
   s.rdoc_options << '--title' << 'SSH Command UTILity' << '--main' << 'README.rdoc'
   s.extra_rdoc_files = ['README.rdoc', 'THANKS.rdoc', 'CHANGELOG.rdoc']
-  s.add_runtime_dependency 'net-ssh', '>= 2.1.0'
+  s.add_runtime_dependency 'net-ssh', '>= 2.1'
   s.files = %w(
 lib/scutil.rb
 lib/scutil/connection_cache.rb

data/test/test_scutil.rb

@@ -101,7 +101,7 @@ class TestScutil < Test::Unit::TestCase
     assert_instance_of(Net::SSH::Connection::Session, conn.connection)
     assert_nil(conn.pty_connection)
   end
-  
+
   def test_pty_requested
     # XXX: check retvals everywhere!
     ret_val = @exec.exec_command("sudo " + TRUE_COMMAND)
@@ -161,6 +161,20 @@ class TestScutil < Test::Unit::TestCase
     assert_match(/\[#{TestScutil.hostname}\]/, @output.string)
   end
   
+  def test_download_file
+    @exec.download("/bin/ls", "./ls-binary")
+    conn = Scutil.connection_cache.fetch(TestScutil.hostname)
+    assert_not_nil(conn.connection)
+    assert_instance_of(Net::SSH::Connection::Session, conn.connection)
+  end
+  
+  def test_upload_file
+    @exec.upload("./ls-binary", "ls-binary-up")
+    conn = Scutil.connection_cache.fetch(TestScutil.hostname)
+    assert_not_nil(conn.connection)
+    assert_instance_of(Net::SSH::Connection::Session, conn.connection)
+  end
+
 #  def test_sudo_passwd
 #    ret_val = @exec.exec_command('sudo ' + TRUE_COMMAND, nil, { :scutil_sudo_passwd => "p4ssw0rd", :scutil_sudo_passwd_regex => /^Password:/ })
 #    conn = Scutil.connection_cache.fetch(TestScutil.hostname)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: scutil
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.4.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,19 +9,24 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-23 00:00:00.000000000 Z
+date: 2012-03-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: net-ssh
-  requirement: &19755500 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 2.1.0
+        version: '2.1'
   type: :runtime
   prerelease: false
-  version_requirements: *19755500
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '2.1'
 description: ! "    Scutil is a library for conveniently executing commands \n    remotely
   via SSH.\n"
 email: marcantoniosr@gmail.com
@@ -67,7 +72,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.17
+rubygems_version: 1.8.18
 signing_key: 
 specification_version: 3
 summary: SSH Command UTILity