scutil 0.3.1 → 0.3.2

data/CHANGELOG.rdoc

@@ -1,9 +1,16 @@
 
 ==Changelog
 
+===0.3.2 | 2011-11-03
+
+* Instance initialization will default to current user if username is
+  not specified.
+* More documentation corrections.
+
 ===0.3.1 | 2011-10-26
 
-* Added conn method to instance to expose Net::SSH::Session object.
+* Added conn method to instance to expose
+  Net::SSH::Connection::Session object.
 * Documentation corrections.
 
 ===0.3.0 | 2011-10-11

data/README.rdoc

@@ -43,7 +43,7 @@ see Scutil.
   require 'scutil'
 
   # Class method executed immediately:  
-  Scutil.exec_command('servername1', 'username', 'pwd', nil,
+  Scutil.exec_command('servername1', 'username', nil,
                     { 
                       :keys => '~mas/.ssh/id_rsa',  
                       :scutil_verbose => true 

data/lib/scutil.rb

@@ -30,7 +30,7 @@ require 'scutil/connection_cache'
 require 'scutil/system_connection'
 
 module Scutil
-  SCUTIL_VERSION = '0.3.1'
+  SCUTIL_VERSION = '0.3.2'
   # By default, buffer 10M of data before writing.
   DEFAULT_OUTPUT_BUFFER_SIZE = 0xA00000
   # Checks for a command starting with _sudo_ by default.
@@ -67,7 +67,7 @@ module Scutil
       end
     end
     
-    # Drops all instances of +hostname+ from connection_cache.
+    # Drops all instances of +hostname+ from @connection_cache.
     def clear!(hostname)
       if (Scutil.connection_cache.exists?(hostname))
         Scutil.connection_cache.remove(hostname)

data/lib/scutil/exec.rb

@@ -7,7 +7,7 @@ module Scutil
   #
   #   exec.exec_command('echo "foo"')
   #
-  #   exec.exec_command('echo "bar"; sudo whoami', "", 
+  #   exec.exec_command('echo "bar"; sudo whoami', nil, 
   #                     { :scutil_force_pty => true, 
   #                       :scutil_verbose => true 
   #                     })
@@ -16,9 +16,11 @@ module Scutil
     include Scutil
     attr_reader :hostname,:username
 
-    def initialize(hostname, username, options={})
+    # Defaults to current user (ENV['USER'] if _username_ is not
+    # specified.
+    def initialize(hostname, username=nil, options={})
       @hostname = hostname
-      @username = username
+      @username =  username.nil? ? ENV['USER'] : username
       @options = options
     end
     
@@ -39,14 +41,16 @@ module Scutil
       @options.merge!(options)      
     end
     
+    # Exposes the raw Net:SSH::Connection::Session object associated
+    # with @hostname.
     def conn(pty_needed=false)
       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 
+      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
-        conn = sys_conn.get_connection @hostname, @username, pty_needed, @options
+        sys_conn = SystemConnection.new(@hostname)
+        conn = sys_conn.get_connection(@hostname, @username, pty_needed, @options)
       end
       conn
     end

data/scutil.gemspec

@@ -1,8 +1,8 @@
 
 Gem::Specification.new do |s|
   s.name        = 'scutil'
-  s.version     = '0.3.1'
-  s.date        = '2011-10-26'
+  s.version     = '0.3.2'
+  s.date        = '2011-11-03'
   s.summary     = 'SSH Command UTILity'
   s.description = <<-EOF
     Scutil is a library for conveniently executing commands 
@@ -25,6 +25,6 @@ scutil.gemspec
 README.rdoc
 CHANGELOG.rdoc
 THANKS.rdoc
-test/test_scutil.rb
 )
+  s.test_files = ['test/test_scutil.rb']
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: scutil
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-10-26 00:00:00.000000000Z
+date: 2011-11-03 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: net-ssh
-  requirement: &19449700 !ruby/object:Gem::Requirement
+  requirement: &25161580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,7 +21,7 @@ dependencies:
         version: 2.1.0
   type: :runtime
   prerelease: false
-  version_requirements: *19449700
+  version_requirements: *25161580
 description: ! "    Scutil is a library for conveniently executing commands \n    remotely
   via SSH.\n"
 email: marcantoniosr@gmail.com
@@ -71,4 +71,5 @@ rubygems_version: 1.8.11
 signing_key: 
 specification_version: 3
 summary: SSH Command UTILity
-test_files: []
+test_files:
+- test/test_scutil.rb