scutil 0.4.5 → 0.4.6

data/CHANGELOG.rdoc

@@ -1,6 +1,10 @@
 
 ==Changelog
 
+===0.4.6 | 2012-08-23
+
+* Handle connection timeouts with a Scutil::Error.
+
 ===0.4.5 | 2012-05-25
 
 * Minor bug when running scutil with Ruby 1.8.

data/lib/scutil.rb

@@ -29,7 +29,7 @@ require 'scutil/connection_cache'
 require 'scutil/system_connection'
 
 module Scutil
-  SCUTIL_VERSION = '0.4.5'
+  SCUTIL_VERSION = '0.4.6'
   
   # By default, buffer 10M of data before writing.
   DEFAULT_OUTPUT_BUFFER_SIZE = 0xA00000
@@ -137,20 +137,10 @@ module Scutil
       end
       
       # If a custom password prompt regex has been defined, use it.
-      if (!options[:scutil_sudo_passwd_regex].nil? && 
-          (options[:scutil_sudo_passwd_regex].kind_of? Regexp))
-        passwd_regex = options[:scutil_sudo_passwd_regex]
-      else
-        raise Scutil::Error.new(":scutil_sudo_passwd_regex must be a kind of Regexp", hostname)
-      end
+      passwd_regex = set_sudo_password_prompt(options)
       
       # If a custom bad password prompt regex has been defined, use it.
-      if (!options[:scutil_sudo_passwd_failed_regex].nil? && 
-          (options[:scutil_sudo_passwd_failed_regex].kind_of? Regexp))
-        passwd_failed_regex = options[:scutil_sudo_passwd_failed_regex]
-      else
-        raise Scutil::Error.new(":scutil_sudo_passwd_failed_regex must be a kind of Regexp", hostname)
-      end
+      passwd_failed_regex = set_sudo_password_failed(options)
       
       # Setup channel callbacks
       odata = ""
@@ -177,23 +167,23 @@ module Scutil
           #  :waiting => Password sent, wating for reply.
           #  :done    => Authenication complete or not required.
           case (sudo_passwd_state)
+          when :done
+            odata += data
           when :new
-            if (data =~ passwd_regex)
-              if (options[:scutil_sudo_passwd].nil?)
-                # No password defined
+            if (data =~ passwd_regex) # We have been prompted for a sudo password
+              if (options[:scutil_sudo_passwd].nil?) # No password defined, bail
                 raise Scutil::Error.new("[#{conn.host}:#{channel.local_id}] Password required for sudo.  
 Define in :scutil_sudo_passwd.", hostname)
                 channel.close
               end
               ch.send_data options[:scutil_sudo_passwd] + "\n"
               sudo_passwd_state = :waiting
-            else
+            else # No sudo password needed, grab the data and move on.
               odata += data
               sudo_passwd_state = :done
             end
           when :waiting
-            if (data =~ passwd_failed_regex)
-              # Bad sudo password
+            if (data =~ passwd_failed_regex) # Bad sudo password
               raise Scutil::Error.new("[#{conn.host}:#{channel.local_id}] Password failed for sudo.  
 Define in :scutil_sudo_passwd or check :scutil_sudo_failed_passwd for the correct failure response.", 
                                       hostname)
@@ -203,7 +193,7 @@ Define in :scutil_sudo_passwd or check :scutil_sudo_failed_passwd for the correc
               # NoOp for "\n"
             end
           else
-            odata += data
+            raise Scutil::Error.new("[#{conn.host}:#{channel.local_id}] Invalid connection state.", hostname)
           end
           
           # Only buffer some of the output before writing to disk (10M by default).
@@ -309,6 +299,8 @@ Define in :scutil_sudo_passwd or check :scutil_sudo_failed_passwd for the correc
         raise Scutil::Error.new("Authenication failed for user: #{username}", hostname)
       rescue SocketError => err
         raise Scutil::Error.new(err.message, hostname)
+      rescue Errno::ETIMEDOUT => err
+        raise Scutil::Error.new(err.message, hostname)
       end
       return conn
     end
@@ -325,10 +317,28 @@ Define in :scutil_sudo_passwd or check :scutil_sudo_failed_passwd for the correc
         :scutil_sudo_passwd              => nil
       }
     end
-  end
-  
-  def method_missing(method, *args, &block)
-    return if ((method == :download) || (method == :upload))
-    super
+    
+    def set_sudo_password_prompt(options)
+      if (!options[:scutil_sudo_passwd_regex].nil? && 
+          (options[:scutil_sudo_passwd_regex].kind_of? Regexp))
+        return options[:scutil_sudo_passwd_regex]
+      else
+        raise Scutil::Error.new(":scutil_sudo_passwd_regex must be a kind of Regexp", hostname)
+      end
+    end
+    
+    def set_sudo_password_failed(options)
+      if (!options[:scutil_sudo_passwd_failed_regex].nil? && 
+          (options[:scutil_sudo_passwd_failed_regex].kind_of? Regexp))
+        return options[:scutil_sudo_passwd_failed_regex]
+      else
+        raise Scutil::Error.new(":scutil_sudo_passwd_failed_regex must be a kind of Regexp", hostname)
+      end
+    end
+    
+    def method_missing(method, *args, &block)
+      return if ((method == :download) || (method == :upload))
+      super
+    end
   end
 end

data/lib/scutil/system_connection.rb

@@ -19,7 +19,7 @@ module Scutil
       conn = nil
       # Local map has precedence.
       @options.merge!(options)
-
+      
       ssh_options = scrub_options @options
       options = @options
       if (pty_needed)

data/scutil.gemspec

@@ -1,8 +1,8 @@
 
 Gem::Specification.new do |s|
   s.name        = 'scutil'
-  s.version     = '0.4.5'
-  s.date        = '2012-05-25'
+  s.version     = '0.4.6'
+  s.date        = '2012-08-23'
   s.summary     = 'SSH Command UTILity'
   s.description = <<-EOF
     Scutil is a library for conveniently executing commands 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: scutil
 version: !ruby/object:Gem::Version
-  version: 0.4.5
+  version: 0.4.6
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-25 00:00:00.000000000 Z
+date: 2012-08-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: net-ssh