scutil 0.2.2 → 0.2.3

data/CHANGELOG

@@ -1,5 +1,11 @@
 
-===Changelog
+==Changelog
+
+===0.2.3 | 2011-09-27
+
+* Fixed bug in Scutil.clear!
+* Added beginnings of a test suite.
+* Restructured code into a more sane file structure.
 
 ===0.2.2 | 2011-09-25
 

data/lib/scutil.rb

@@ -24,53 +24,13 @@ THE SOFTWARE.
 =end
 
 require 'net/ssh'
+require 'scutil/exec'
+require 'scutil/error'
+require 'scutil/connection_cache'
+require 'scutil/system_connection'
 
 module Scutil
-  # Utiliy class to hold all the connections created, possibly for
-  # reuse later.
-  class ConnectionCache
-    attr_reader :cache
-    include Enumerable
-
-    def initialize
-      @cache = []
-    end
-
-    # Need each to mixin Enumerable
-    def each
-      @cache.each do |c|
-        yield c
-      end
-    end
-    
-    def fetch(hostname)
-      each do |c|
-        return c if c.hostname == hostname
-      end
-    end
-    
-    def exists?(hostname)
-      each do |c|
-        return true if c.hostname == hostname
-      end
-      false
-    end
-
-    # Remove all instances of _hostname_.
-    def remove(hostname)
-      @cache.delete_if { |c| c.hostname == hostname }
-    end
-    
-    def <<(conn)
-      @cache << conn
-    end
-    
-    def to_s
-      @cache.join("\n")
-    end
-  end
-  
-  SCUTIL_VERSION = '0.2.2'
+  SCUTIL_VERSION = '0.2.3'
   # By default, buffer 10M of data before writing.
   DEFAULT_OUTPUT_BUFFER_SIZE = 0xA00000
   # Checks for a command starting with _sudo_ by default.
@@ -85,105 +45,6 @@ module Scutil
     # Set to 10M by default, this can be adjusted to tell scutil when
     # to write command output to _output_.
     attr_accessor :output_buffer_size
-  end
-  
-  # Wrapper for each connection to a system.  Capabile of holding a
-  # standard connect (@connection) and and PTY connection
-  # (@pty_connection) for each system.
-  class SystemConnection
-    attr_reader :hostname,:pty_connection,:connection
-    def initialize(hostname, options={})
-      @hostname = hostname
-      @connection = nil
-      @pty_connection = nil
-      @options = options
-    end
-    
-    # Return a connection for system.  Checks to see if an established
-    # connection exists.  If not it creates a new one.  Requests a PTY
-    # if needed.
-    def get_connection(hostname, username, pty_needed=false, options={})
-      conn = nil
-      # Local map has precedence.
-      @options.merge!(options)
-      
-      scrub_options @options
-      
-      if (pty_needed)
-        if !@pty_connection.nil?
-          # Existing PTY connection
-          $stderr.print "[#{hostname}] Using existing connection (pty)\n" if @options[:scutil_verbose]
-          return @pty_connection
-        end
-        
-        # New PTY connection
-        $stderr.print "[#{hostname}] Opening new channel (pty) to system...\n" if @options[:scutil_verbose]
-        conn = Net::SSH.start(hostname, username, @options)
-        @pty_connection = conn
-      else
-        if !@connection.nil?
-          # Existing non-PTY connection
-          $stderr.print "[#{hostname}] Using existing connection (non-pty)\n" if @options[:scutil_verbose]
-          return @connection
-        end
-        
-        # New non-PTY connection
-        $stderr.print "[#{hostname}] Opening channel (non-pty) to system...\n" if @options[:scutil_verbose]
-        conn = Net::SSH.start(hostname, username, @options)
-        @connection = conn
-      end
-  
-      return conn
-    end
-    
-    # Remove scutil specific options.  The rest go to Net::SSH.
-    def scrub_options(options)
-      options.delete(:scutil_verbose) if (options.has_key?(:scutil_verbose))
-      options.delete(:scutil_force_pty) if (options.has_key?(:scutil_force_pty))
-      options.delete(:scutil_pty_regex) if (options.has_key?(:scutil_pty_regex))
-    end
-    
-    def to_s
-      "#{self.class}: #{@name}, @connection = #{@connection}, @pty_connection = #{@pty_connection}"
-    end
-  end
-  
-  # Instantiate this class if you wish to use scutil as an object.
-  # For example:
-  #
-  #   exec = Scutil::Exec.new('severname', 'mas')
-  #
-  #   exec.exec_command('echo "foo"')
-  #
-  #   exec.exec_command('echo "bar"; sudo whoami', "", 
-  #                     { :scutil_force_pty => true, 
-  #                       :scutil_verbose => true 
-  #                     })
-  #
-  class Exec
-    include Scutil
-    attr_reader :hostname,:username
-    
-    def initialize(hostname, username, options={})
-      @hostname = hostname
-      @username = username
-      @options = options
-    end
-    
-    # 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.
-    def exec_command(cmd, output=nil, options={})
-      # Local map has precedence.
-      @options.merge!(options)
-      Scutil.exec_command(@hostname, @username, cmd, output, @options)
-    end
-  end
-  
-  class << self
 
     # Should we request a PTY?  Uses custom regex if defined in
     # +:scutil_pty_regex+.
@@ -205,16 +66,16 @@ module Scutil
         return options[:scutil_force_pty] ? true : false
       end
     end
-
+    
     # Drops all instances of +hostname+ from connection_cache.
     def clear!(hostname)
       if (Scutil.connection_cache.exists?(hostname))
-        Scutil.connection_cache.clear(hostname)
+        Scutil.connection_cache.remove(hostname)
       else
         raise Scutil::Error.new("Error: :scutil_pty_regex must be a kind of Regexp", hostname)
       end
     end
-
+    
     # Scutil.exec_command is used to execute a command, specified in
     # _cmd_, on a remote system.  The return value and any ouput of
     # the command are captured.
@@ -265,12 +126,13 @@ module Scutil
       begin
         if (Scutil.connection_cache.exists?(hostname))
           sys_conn = Scutil.connection_cache.fetch(hostname)
+          $stderr.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)
-          $stderr.print "[#{hostname}] Adding new connection to cache\n" if options[:scutil_verbose]
           # Call get_connection first.  Don't add to cache unless established.
           conn = sys_conn.get_connection(hostname, username, pty_needed, options)
+          $stderr.print "[#{hostname}] Adding new connection to cache\n" if options[:scutil_verbose]
           Scutil.connection_cache << sys_conn
         end
       rescue Net::SSH::AuthenticationFailed => err
@@ -330,7 +192,11 @@ module Scutil
         channel.on_request("exit-status") do |ch, data|
           exit_status = data.read_long
         end
-
+        
+#        channel.on_open_failed do |ch, code, desc|
+#          
+#        end
+        
         channel.exec(cmd)
 #        channel.wait
       end
@@ -352,34 +218,3 @@ module Scutil
   
   #  end
 end
-
-# Exception class for scutil.  The system, error message, and return
-# value of the remote command are stored here on error.
-#
-#   begin
-#     Scutil.exec_command('ls -al /root')
-#   rescue Scutil::Error => err
-#     puts "Message: " + err.message
-#     puts "Hostname: " + err.hostname
-#     puts "Exit status: #{err.command_exit_status}"
-#   end
-#
-# Will produce:
-#
-#   Message: Error: ls: /root: Permission denied
-#   Hostname: server.name.com
-#   Exit status: 2
-#
-class Scutil::Error < StandardError
-  attr_reader :hostname,:message,:command_exit_status
-  
-  def initialize(message=nil, hostname=nil, command_exit_status=-1)
-    @message = message
-    @hostname = hostname
-    @command_exit_status = command_exit_status
-  end
-
-  def to_s
-    "Message: #{@message}\nHostname: #{@hostname}\nExit status: #{command_exit_status}\n"
-  end
-end

data/lib/scutil/connection_cache.rb

@@ -0,0 +1,46 @@
+
+module Scutil
+  # Utiliy class to hold all the connections created, possibly for
+  # reuse later.
+  class ConnectionCache
+    attr_reader :cache
+    include Enumerable
+    
+    def initialize
+      @cache = []
+    end
+    
+    # Need each to mixin Enumerable
+    def each
+      @cache.each do |c|
+        yield c
+      end
+    end
+    
+    def fetch(hostname)
+      each do |c|
+        return c if c.hostname == hostname
+      end
+    end
+    
+    def exists?(hostname)
+      each do |c|
+        return true if c.hostname == hostname
+      end
+      false
+    end
+
+    # Remove all instances of _hostname_.
+    def remove(hostname)
+      @cache.delete_if { |c| c.hostname == hostname }
+    end
+    
+    def <<(conn)
+      @cache << conn
+    end
+    
+    def to_s
+      @cache.join("\n")
+    end
+  end
+end

data/lib/scutil/error.rb

@@ -0,0 +1,31 @@
+
+# Exception class for scutil.  The system, error message, and return
+# value of the remote command are stored here on error.
+#
+#   begin
+#     Scutil.exec_command('ls -al /root')
+#   rescue Scutil::Error => err
+#     puts "Message: " + err.message
+#     puts "Hostname: " + err.hostname
+#     puts "Exit status: #{err.command_exit_status}"
+#   end
+#
+# Will produce:
+#
+#   Message: Error: ls: /root: Permission denied
+#   Hostname: server.name.com
+#   Exit status: 2
+#
+class Scutil::Error < StandardError
+  attr_reader :hostname,:message,:command_exit_status
+  
+  def initialize(message=nil, hostname=nil, command_exit_status=-1)
+    @message = message
+    @hostname = hostname
+    @command_exit_status = command_exit_status
+  end
+
+  def to_s
+    "Message: #{@message}\nHostname: #{@hostname}\nExit status: #{command_exit_status}\n"
+  end
+end

data/lib/scutil/exec.rb

@@ -0,0 +1,37 @@
+
+module Scutil  
+  # Instantiate this class if you wish to use scutil as an object.
+  # For example:
+  #
+  #   exec = Scutil::Exec.new('severname', 'mas')
+  #
+  #   exec.exec_command('echo "foo"')
+  #
+  #   exec.exec_command('echo "bar"; sudo whoami', "", 
+  #                     { :scutil_force_pty => true, 
+  #                       :scutil_verbose => true 
+  #                     })
+  #
+  class Exec
+    include Scutil
+    attr_reader :hostname,:username
+    
+    def initialize(hostname, username, options={})
+      @hostname = hostname
+      @username = username
+      @options = options
+    end
+    
+    # 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.
+    def exec_command(cmd, output=nil, options={})
+      # Local map has precedence.
+      @options.merge!(options)
+      Scutil.exec_command(@hostname, @username, cmd, output, @options)
+    end
+  end
+end

data/lib/scutil/system_connection.rb

@@ -0,0 +1,63 @@
+
+module Scutil
+  # Wrapper for each connection to a system.  Capabile of holding a
+  # standard connect (@connection) and and PTY connection
+  # (@pty_connection) for each system.
+  class SystemConnection
+    attr_reader :hostname,:pty_connection,:connection
+    def initialize(hostname, options={})
+      @hostname = hostname
+      @connection = nil
+      @pty_connection = nil
+      @options = options
+    end
+    
+    # Return a connection for system.  Checks to see if an established
+    # connection exists.  If not it creates a new one.  Requests a PTY
+    # if needed.
+    def get_connection(hostname, username, pty_needed=false, options={})
+      conn = nil
+      # Local map has precedence.
+      @options.merge!(options)
+      
+      scrub_options @options
+      
+      if (pty_needed)
+        if !@pty_connection.nil?
+          # Existing PTY connection
+          $stderr.print "[#{hostname}] Using existing connection (pty)\n" if @options[:scutil_verbose]
+          return @pty_connection
+        end
+        
+        # New PTY connection
+        $stderr.print "[#{hostname}] Opening new channel (pty) to system...\n" if @options[:scutil_verbose]
+        conn = Net::SSH.start(hostname, username, @options)
+        @pty_connection = conn
+      else
+        if !@connection.nil?
+          # Existing non-PTY connection
+          $stderr.print "[#{hostname}] Using existing connection (non-pty)\n" if @options[:scutil_verbose]
+          return @connection
+        end
+        
+        # New non-PTY connection
+        $stderr.print "[#{hostname}] Opening channel (non-pty) to system...\n" if @options[:scutil_verbose]
+        conn = Net::SSH.start(hostname, username, @options)
+        @connection = conn
+      end
+      
+      return conn
+    end
+    
+    # Remove scutil specific options.  The rest go to Net::SSH.
+    def scrub_options(options)
+      options.delete(:scutil_verbose) if (options.has_key?(:scutil_verbose))
+      options.delete(:scutil_force_pty) if (options.has_key?(:scutil_force_pty))
+      options.delete(:scutil_pty_regex) if (options.has_key?(:scutil_pty_regex))
+    end
+    
+    def to_s
+      "#{self.class}: #{@name}, @connection = #{@connection}, @pty_connection = #{@pty_connection}"
+    end
+  end
+end

data/scutil.gemspec

@@ -0,0 +1,29 @@
+Gem::Specification.new do |s|
+  s.name        = 'scutil'
+  s.version     = '0.2.3'
+  s.date        = '2011-09-27'
+  s.summary     = 'SSH Command UTILity'
+  s.description = <<-EOF
+    Scutil is a library for conveniently executing commands 
+    remotely via SSH.
+EOF
+  s.author      = 'Marc Soda'
+  s.email       = 'marcantoniosr@gmail.com'
+  s.license     = 'MIT'
+  s.homepage    = 'http://marcantonio.github.com/scutil'
+  s.rdoc_options << '--title' << 'SSH Command UTILity' << '--main' << 'README'
+  s.extra_rdoc_files = ['README', 'THANKS', 'CHANGELOG']
+  s.add_runtime_dependency 'net-ssh', '>= 2.1.0'
+  s.files = %w(
+lib/scutil.rb
+lib/scutil/connection_cache.rb
+lib/scutil/error.rb
+lib/scutil/exec.rb
+lib/scutil/system_connection.rb
+scutil.gemspec
+README
+CHANGELOG
+THANKS
+test/test_scutil.rb
+)
+end

data/test/test_scutil.rb

@@ -0,0 +1,50 @@
+#!/usr/bin/ruby -I../lib -w
+
+require 'test/unit'
+require 'scutil'
+require 'stringio'
+
+class TestScutil < Test::Unit::TestCase
+  def setup
+    @hostname = ARGV[0]
+    @port = ARGV[1]
+    @user = 'mas'
+    @exec = Scutil::Exec.new(@hostname, @user, 
+                             { :port => @port,
+                               # :keys => '~mas/.ssh/id_rsa', 
+                             })
+    @output = nil
+    @t_output = nil
+  end
+  
+  def divert_stdout
+    @t_output = $stdout
+    $stdout = StringIO.new
+  end
+  
+  def revert_stdout
+    @output = $stdout
+    $stdout = @t_output
+  end
+  
+  def test_initialize_exec_object
+    assert_not_nil @exec
+  end
+  
+  def test_is_correct_instance
+    assert_instance_of Scutil::Exec, @exec
+  end
+  
+  def test_run_command
+    divert_stdout
+    retval = @exec.exec_command('echo "alpha"')
+    revert_stdout
+    assert_equal "alpha", @output.string.chomp
+    assert_equal 0, retval
+  end
+end
+
+if ARGV[1].nil?
+  puts "Usage: #{$0} host1 [host2 host3] port"
+  exit(1)
+end

metadata

@@ -2,7 +2,7 @@
 name: scutil
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors: 
 - Marc Soda
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-09-25 00:00:00 Z
+date: 2011-09-27 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: net-ssh
@@ -35,9 +35,15 @@ extra_rdoc_files:
 - CHANGELOG
 files: 
 - lib/scutil.rb
+- lib/scutil/connection_cache.rb
+- lib/scutil/error.rb
+- lib/scutil/exec.rb
+- lib/scutil/system_connection.rb
+- scutil.gemspec
 - README
-- THANKS
 - CHANGELOG
+- THANKS
+- test/test_scutil.rb
 homepage: http://marcantonio.github.com/scutil
 licenses: 
 - MIT
@@ -45,6 +51,8 @@ post_install_message:
 rdoc_options: 
 - --title
 - SSH Command UTILity
+- --main
+- README
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement