scutil 0.4.6 → 0.4.7

data/CHANGELOG.rdoc

@@ -1,6 +1,13 @@
 
 ==Changelog
 
+===0.4.7 | 2013-04-26
+
+* Better handling of binary streams in Ruby 1.9+.
+* Add option to not throw exceptions when there's data on STDERR.
+  Thanks @mclazarus!
+* Some never ending doc clean-up.
+
 ===0.4.6 | 2012-08-23
 
 * Handle connection timeouts with a Scutil::Error.

data/README.rdoc

@@ -34,8 +34,13 @@ 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.
+functions will be defined if you have Net::SCP installed.
+
+See Scutil::Exec for more details.
+
+Scutil works great with {Rails}[http://rubyonrails.org/] to perform tasks via SSH.  
+Particularly when used with {Delayed::Job}[https://github.com/collectiveidea/delayed_job], 
+{Resque}[https://github.com/resque/resque] et al.
 
 ==Synopsis:
 
@@ -44,7 +49,7 @@ You can use scutil in a few different ways, for more usage examples see Scutil.
   require 'scutil'
 
   # Class method executed immediately:  
-  Scutil.exec_command('servername1', 'username', nil,
+  Scutil.exec_command('servername1', 'username', 'command', nil,
                     { 
                       :keys => '~mas/.ssh/id_rsa',  
                       :scutil_verbose => true 
@@ -52,8 +57,7 @@ You can use scutil in a few different ways, for more usage examples see Scutil.
                     
 
   # Object to be used and reused:
-  exec = Scutil::Exec.new('servername2', 'mas',
-                        { :password => 'myPassw0rd' })
+  exec = Scutil::Exec.new('servername2', 'mas')
   exec.exec_command("ls -l /")
 
   return_value = exec.exec_command("grep -q ...")
@@ -73,7 +77,8 @@ You can use scutil in a few different ways, for more usage examples see Scutil.
   require 'stringio'
 
   command_output = StringIO.new
-  Scutil.exec_command('servername1', 'sudo cat /root/secrets.txt', command_output)
+  Scutil.exec_command('servername1', 'sudo cat /root/secrets.txt', command_output, nil,
+                        { :password => 'myPassw0rd' })
   puts command_output.string
 
 == Installation:
@@ -84,7 +89,7 @@ You can use scutil in a few different ways, for more usage examples see Scutil.
 
 The MIT License (MIT)
 
-Copyright (c) 2012 by Marc Soda
+Copyright (c) 2013 by Marc Soda
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of
 this software and associated documentation files (the "Software"), to deal in

data/lib/scutil.rb

@@ -2,7 +2,7 @@
 =begin
 The MIT License (MIT)
 
-Copyright (C) 2012 by Marc Soda
+Copyright (C) 2013 by Marc Soda
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of
 this software and associated documentation files (the "Software"), to deal in
@@ -29,7 +29,7 @@ require 'scutil/connection_cache'
 require 'scutil/system_connection'
 
 module Scutil
-  SCUTIL_VERSION = '0.4.6'
+  SCUTIL_VERSION = '0.4.7'
   
   # By default, buffer 10M of data before writing.
   DEFAULT_OUTPUT_BUFFER_SIZE = 0xA00000
@@ -98,12 +98,13 @@ module Scutil
     #
     # Scutil.exec_command takes the following options:
     #
-    # * :scutil_verbose                  => Extra output.
-    # * :scutil_force_pty                => Force a PTY request (or not) for every channel.
-    # * :scutil_pty_regex                => Specific a custom regex here for use when scutil decides whether or not to request a PTY.
-    # * :scutil_sudo_passwd_regex        => If sudo requires a password you can specify the prompt to look for, e.g., _Password:_ .
-    # * :scutil_sudo_passwd_failed_regex => Regular expression for a sudo password failure.
-    # * :scutil_sudo_passwd              => The sudo password.
+    # * :scutil_verbose                   => Extra output.
+    # * :scutil_force_pty                 => Force a PTY request (or not) for every channel.
+    # * :scutil_pty_regex                 => Specific a custom regex here for use when scutil decides whether or not to request a PTY.
+    # * :scutil_sudo_passwd_regex         => If sudo requires a password you can specify the prompt to look for, e.g., _Password:_ .
+    # * :scutil_sudo_passwd_failed_regex  => Regular expression for a sudo password failure.
+    # * :scutil_sudo_passwd               => The sudo password.
+    # * :scutil_suppress_stderr_exception => Prevent exception if we get data on stderr.
     #
     # In addition, any other options passed Scutil.exec_command will be passed
     # on to Net::SSH, _except_ those prefixed with _scutil__.
@@ -131,7 +132,7 @@ module Scutil
       elsif (output.respond_to? :write)  # XXX: This may not be a safe assumuption...
         fh = output
       elsif (output.class == String)
-        fh = File.open(output, 'w') unless output.empty?
+        fh = File.open(output, 'wb') unless output.empty?
       else
         raise Scutil::Error.new("Invalid output object type: #{output.class}.", hostname)
       end
@@ -233,7 +234,7 @@ Define in :scutil_sudo_passwd or check :scutil_sudo_failed_passwd for the correc
       fh.close unless fh == $stdout
       
       # If extended_data was recieved there was a problem...
-      raise Scutil::Error.new("Error: #{edata}", hostname, exit_status) unless (edata.empty?)
+      raise Scutil::Error.new("Error: #{edata}", hostname, exit_status) unless (edata.empty?) || options[:scutil_suppress_stderr_exception]
       
       # The return value of the remote command.
       return exit_status

data/scutil.gemspec

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

data/test/test_scutil.rb

@@ -1,8 +1,7 @@
 #!/usr/bin/ruby -I../lib -I.
 
-if RUBY_VERSION =~ /^1.8/
-  require 'rubygems'
-end
+require 'rubygems' if RUBY_VERSION =~ /^1.8/
+
 require 'test/unit'
 require 'scutil'
 require 'stringio'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: scutil
 version: !ruby/object:Gem::Version
-  version: 0.4.6
+  version: 0.4.7
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-23 00:00:00.000000000 Z
+date: 2013-04-26 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.24
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: SSH Command UTILity