ghaki-net-ssh 2011.11.30.1

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2010 Gerald Kalafut
+
+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 the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README

@@ -0,0 +1,23 @@
+= Ghaki Net SSH - Secure Shell helpers
+
+Ghaki Net SSH is a collection of extensions for the Net SSH gem library.
+
+== Download
+
+The latest version of Ghaki Net SSH can be found at
+
+* git@github.com:ghaki/ghaki-net-ssh.git
+
+== Installation
+
+The preferred method of installing Ghaki Net SSH is through its GEM file.
+
+  % [sudo] gem install ghaki-net-ssh-1.0.0.gem
+
+== License
+
+Ghaki Net SSH is released under the MIT license.
+
+== Support
+
+Contact mailto:gerald@kalafut.org

data/VERSION

@@ -0,0 +1 @@
+2011.11.30.1

data/lib/ghaki/net_ssh/account.rb

@@ -0,0 +1,38 @@
+require 'ghaki/account/base'
+require 'ghaki/net_ssh/shell'
+
+module Ghaki  #:nodoc:
+module NetSSH #:nodoc:
+
+class Account < Ghaki::Account::Base
+  attr_accessor :logger
+
+  def initialize opts={}; super opts
+    @logger = opts[:logger]
+  end
+
+  def start_shell opts={}, &block
+    Ghaki::NetSSH::Shell.start \
+      setup_shell_opts(opts), &block
+  end
+
+  def start_ftp opts={}, &block
+    Ghaki::NetSSH::FTP.start \
+      setup_shell_opts(opts), &block
+  end
+
+  def start_telnet opts={}, &block
+    Ghaki::NetSSH::Telnet.start \
+      setup_shell_opts(opts), &block
+  end
+
+  protected
+
+  def setup_shell_opts opts
+    opts[:account] = self
+    opts[:logger] ||= @logger unless @logger.nil?
+    opts
+  end
+
+end
+end end

data/lib/ghaki/net_ssh/errors.rb

@@ -0,0 +1,3 @@
+module Ghaki
+  class RemoteCommandError < RuntimeError; end
+end

data/lib/ghaki/net_ssh/ftp.rb

@@ -0,0 +1,72 @@
+require 'delegate'
+require 'forwardable'
+require 'net/ssh'
+require 'net/sftp'
+require 'ghaki/core_ext/file/with_temp'
+require 'ghaki/net_ssh/shell'
+
+module Ghaki  #:nodoc:
+module NetSSH #:nodoc:
+
+class FTP < DelegateClass(::Net::SFTP)
+  extend Forwardable
+
+  attr_accessor :raw_ftp, :shell
+  def_delegators :@shell,
+    :log_command_on,  :log_output_on,  :log_all_on,
+    :log_command_off, :log_output_off, :log_all_off,
+    :log_exec!, :log_command!
+
+  def self.start *args
+    ssh_gak = Ghaki::NetSSH::Shell.start( *args )
+    ftp_gak = Ghaki::NetSSH::FTP.new( ssh_gak )
+    if block_given?
+      begin
+        yield ftp_gak
+      ensure
+        ssh_gak.close
+      end
+    else
+      return ftp_gak
+    end
+  end
+
+  def close
+    @shell.close
+  end
+
+  def initialize ssh
+    @shell = ssh
+    @raw_ftp = @shell.raw_ssh.sftp
+    super(@raw_ftp)
+  end
+
+  def remove! fname
+    begin
+      log_command! 'SFTP', "remove #{fname}"
+      @raw_ftp.remove! fname
+    rescue ::Net::SFTP::StatusException
+      raise unless $!.message =~ %r{ \b no \s such \s file \b }oix
+    end
+  end
+
+  def upload! loc_file, rem_file
+    tmp_file = ::File.join( ::File.dirname(rem_file),
+      '_tmp_' + $$.to_s + '.' + ::File.basename(rem_file) )
+    log_command! 'SFTP', "upload #{loc_file}, #{tmp_file}"
+    @raw_ftp.upload! loc_file, tmp_file
+    log_command! 'SFTP', "rename #{tmp_file}, #{rem_file}"
+    @raw_ftp.rename! tmp_file, rem_file
+  ensure
+    self.remove! tmp_file
+  end
+
+  def download! rem_file, loc_file
+    log_command! 'SFTP', "download #{rem_file}, #{loc_file}"
+    File.with_named_temp loc_file do |tmp_file|
+      @raw_ftp.download! rem_file, tmp_file
+    end
+  end
+
+end
+end end

data/lib/ghaki/net_ssh/logger.rb

@@ -0,0 +1,136 @@
+require 'ghaki/logger/mixin'
+
+module Ghaki  #:nodoc:
+module NetSSH #:nodoc:
+
+module Logger
+  include Ghaki::Logger::Mixin
+
+  attr_accessor :should_log_command, :should_log_output
+
+  NO_OUTPUT = '** NO OUTPUT **'
+
+  def setup_logger opts
+    @logger = opts[:logger]
+    @should_log_command = opts[:log_ssh_command]
+    @should_log_command = true if @should_log_command.nil?
+    @should_log_output  = opts[:log_ssh_output]
+    @should_log_output  = true if @should_log_output.nil?
+  end
+
+  ######################################################################
+  # TURN ON/OFF ALL LOGGING
+  ######################################################################
+
+  def log_all_on &block
+    out = ''
+    old_out,old_cmd = @should_log_output,@should_log_command
+    @should_log_output = @should_log_command  = true
+    if not block.nil?
+      begin
+        out = block.call
+      ensure
+        @should_log_output,@should_log_command = old_out,old_cmd
+      end
+    end
+    out
+  end
+
+  def log_all_off &block
+    out = ''
+    old_out,old_cmd = @should_log_output,@should_log_command
+    @should_log_output = @should_log_command  = false
+    if not block.nil?
+      begin
+        out = block.call
+      ensure
+        @should_log_output,@should_log_command = old_out,old_cmd
+      end
+    end
+    out
+  end
+
+  ######################################################################
+  # TURN COMMAND LOGGIN ON/OFF
+  ######################################################################
+
+  def log_command_on &block
+    out = ''
+    orig,@should_log_command = @should_log_command,true
+    if not block.nil?
+      begin
+        out = block.call
+      ensure
+        @should_log_command = orig
+      end
+    end
+    out
+  end
+
+  def log_command_off &block
+    out = ''
+    orig,@should_log_command = @should_log_command,false
+    if not block.nil?
+      begin
+        out = block.call
+      ensure
+        @should_log_command = orig
+      end
+    end
+    out
+  end
+
+  ######################################################################
+  # TURN OUTPUT LOGGIN ON/OFF
+  ######################################################################
+
+  def log_output_on &block
+    out = ''
+    orig,@should_log_output = @should_log_output,true
+    if not block.nil?
+      begin
+        out = block.call
+      ensure
+        @should_log_output = orig
+      end
+    end
+    out
+  end
+
+  def log_output_off &block
+    out = ''
+    orig,@should_log_output = @should_log_output,false
+    if not block.nil?
+      begin
+        out = block.call
+      ensure
+        @should_log_output = orig
+      end
+    end
+    out
+  end
+
+  ######################################################################
+  # DO THE ACTUAL LOGGING WORK
+  ######################################################################
+
+  def log_exec! title, cmd, &block
+    log_command! title, cmd
+    out = block.call || ''
+    return out unless @should_log_output
+    if out == ''
+      logger.puts( NO_OUTPUT )
+    else
+      logger.liner
+      logger.puts( out )
+      logger.liner
+    end
+    out
+  end
+
+  def log_command! title, cmd
+    logger.puts "#{title} #{@account.hostname} : #{cmd}" if @should_log_command
+  end
+
+end
+end end

data/lib/ghaki/net_ssh/shell.rb

@@ -0,0 +1,179 @@
+require 'net/ssh'
+require 'net/ssh/telnet'
+require 'net/sftp'
+
+require 'ghaki/account/base'
+require 'ghaki/core_ext/file/with_temp'
+
+require 'ghaki/net_ssh/errors'
+require 'ghaki/net_ssh/ftp'
+require 'ghaki/net_ssh/logger'
+require 'ghaki/net_ssh/telnet'
+
+module Ghaki  #:nodoc:
+module NetSSH #:nodoc:
+
+class Shell < DelegateClass(::Net::SSH)
+  include Ghaki::NetSSH::Logger
+
+  DEF_TIMEOUT = 30
+  DEF_AUTH_METHODS = %w{
+    password
+    keyboard-interactive
+    publickey
+    hostbased
+  }
+
+  ######################################################################
+  protected
+  ######################################################################
+
+  def self.raw_opts_log cur_opts, raw_opts
+    if cur_opts.has_key?(:logger)
+      if cur_opts[:logger].nil?
+        # doesn't handle nil correctly
+        raw_opts.delete(:logger)
+      elsif cur_opts[:logger].level < ::Logger::WARN
+        # anything over WARN is insane
+        raw_opts[:logger] = cur_opts[:logger].dup
+        raw_opts[:logger].level = ::Logger::WARN 
+      end
+    end
+    raw_opts
+  end
+
+  def self.raw_opts_setup cur_opts
+    raw_opts = raw_opts_log( cur_opts, cur_opts.dup )
+    raw_opts[:timeout] ||= DEF_TIMEOUT
+    raw_opts[:auth_methods] ||= DEF_AUTH_METHODS
+    raw_opts.delete(:log_ssh_output)
+    raw_opts.delete(:log_ssh_command)
+    raw_opts.delete(:account)
+    unless cur_opts[:account].password.nil?
+      raw_opts[:password] = cur_opts[:account].password
+    end
+    raw_opts
+  end
+
+  def self.args_to_opts args
+    case args.length
+    when 2
+      return Hash.new
+    when 1, 3
+      return args.pop
+    else
+      raise ArgumentError, "Invalid Arguments Passed: (1..3) != #{args.length}"
+    end
+  end
+
+  def self.args_to_account args, cur_opts
+    if args.length == 0
+      acc = Ghaki::Account::Base.from_opts cur_opts
+    else
+      acc = Ghaki::Account::Base.new \
+        :hostname => args.shift,
+        :username => args.shift
+      acc.password = Ghaki::Account::Password.parse_opts(cur_opts)
+    end
+    raise ArgumentError, 'Missing Hostname' if acc.hostname.nil?
+    raise ArgumentError, 'Missing Username' if acc.username.nil?
+    acc.collapse_opts(cur_opts)
+    acc
+  end
+
+  ######################################################################
+  public
+  ######################################################################
+
+  def self.start *args
+    cur_opts = args_to_opts( args )
+    acc = args_to_account( args, cur_opts )
+    raw_opts = raw_opts_setup( cur_opts )
+    begin
+      raw_ssh = ::Net::SSH.start( acc.hostname, acc.username, raw_opts )
+      cur_ssh = Ghaki::NetSSH::Shell.new( raw_ssh, cur_opts )
+      if block_given?
+        begin yield cur_ssh ensure raw_ssh.close end
+      else
+        return cur_ssh
+      end
+    rescue ::Net::SSH::HostKeyMismatch
+      $!.remember_host!
+      retry
+    rescue Net::SSH::AuthenticationFailed
+      if acc.retry_password?
+        acc.fail_password
+        unless cur_opts[:logger].nil?
+          cur_opts[:logger].warn "failed password attempt for: #{acc}"
+        end
+        retry
+      else
+        raise
+      end
+    end
+  end
+
+  attr_accessor :raw_ssh, :account
+
+  def initialize obj, opts={}
+    setup_logger opts
+    @account = opts[:account]
+    @raw_ssh = obj
+    super obj
+  end
+
+  def sftp
+    ftp_obj = Ghaki::NetSSH::FTP.new( self )
+    if block_given?
+      yield ftp_obj
+    else
+      return ftp_obj
+    end
+  end
+
+  def telnet opts={}
+    tel_obj = Ghaki::NetSSH::Telnet.new( self, opts )
+    if block_given?
+      begin
+        yield tel_obj
+      ensure
+        tel_obj.close
+      end
+    else
+      return tel_obj
+    end
+  end
+
+  def exec! cmd
+    self.log_exec! 'SSH', cmd do
+      @raw_ssh.exec!( cmd )
+    end
+  end
+
+  def remove! rem_file
+    sftp.remove! rem_file
+  end
+
+  def upload! loc_file, rem_file
+    sftp.upload! loc_file, rem_file
+  end
+
+  def download! rem_file, loc_file
+    sftp.download! rem_file, loc_file
+  end
+
+  def discover cmd, lookup
+    return lookup.match_lines( self.exec!(cmd).split("\n") ) do
+      raise RemoteCommandError, 'SSH Discovery Output Not Matched'
+    end
+  end
+
+  def redirect rem_file, loc_file, &block
+    sftp.remove! rem_file
+    out = block.call
+    sftp.download! rem_file, loc_file
+    out
+  end
+
+end
+end end

data/lib/ghaki/net_ssh/spec_helper.rb

@@ -0,0 +1,65 @@
+require 'ghaki/net_ssh/shell'
+require 'ghaki/logger/spec_helper'
+
+module Ghaki  #:nodoc:
+module NetSSH #:nodoc:
+
+module SpecHelper
+  include Ghaki::Logger::SpecHelper
+
+  def stub_raw_net_ssh
+    @tel_raw = stub_everything('Net::Telnet')
+    ::Net::SSH::Telnet.stubs({
+      :new => @tel_raw,
+    })
+    @ssh_raw = stub_everything('Net::SSH')
+    ::Net::SSH.stubs({
+      :start => @ssh_raw,
+    })
+    @ftp_raw = stub_everything('Net::SFTP')
+    @ssh_raw.stubs({
+      :sftp => @ftp_raw,
+    })
+  end
+
+  def stub_gak_net_ssh
+    stub_raw_net_ssh
+    @ftp_gak = stub_everything('Ghaki::NetSSH::FTP')
+    Ghaki::NetSSH::FTP.stubs({
+      :new => @ftp_gak,
+    })
+    @tel_gak = stub_everything('Ghaki::NetSSH::Telnet')
+    Ghaki::NetSSH::Telnet.stubs({
+      :new => @tel_gak,
+    })
+  end
+
+  def clear_safe_gak_net_ssh
+    @ssh_gak = nil
+  end
+
+  def setup_safe_gak_net_ssh opts={}
+    return unless @ssh_gak.nil?
+    setup_safe_logger
+    stub_gak_net_ssh
+    opts[:hostname] ||= 'host'
+    opts[:username] ||= 'user'
+    opts[:password] ||= 'secret'
+    opts[:logger] ||= @logger
+    @ssh_gak = Ghaki::NetSSH::Shell.start(opts)
+    @ssh_gak.stubs({
+      :sftp   => @ftp_gak,
+      :telnet => @tel_gak,
+    })
+    Ghaki::NetSSH::Shell.stubs({
+      :new => @ssh_gak,
+    })
+  end
+
+  def reset_safe_gak_net_ssh opts={}
+    clear_safe_gak_net_ssh
+    setup_safe_gak_net_ssh opts
+  end
+
+end
+end end

data/lib/ghaki/net_ssh/telnet.rb

@@ -0,0 +1,72 @@
+require 'delegate'
+require 'forwardable'
+require 'net/ssh'
+require 'net/ssh/telnet'
+require 'ghaki/net_ssh/shell'
+
+module Ghaki  #:nodoc:
+module NetSSH #:nodoc:
+
+class Telnet < DelegateClass(::Net::SSH::Telnet)
+  extend Forwardable
+
+  attr_accessor :raw_telnet, :shell, :auto_close
+
+  def_delegators :@shell,
+    :log_command_on,  :log_output_on,  :log_all_on,
+    :log_command_off, :log_output_off, :log_all_off,
+    :log_exec!, :log_command!
+
+  def self.args_to_tel_opts args
+    case args.length
+    when 2
+      return Hash.new
+    when 1, 3
+      return args.last[:telnet_options] || {}
+    else
+      raise ArgumentError, "Invalid Arguments Passed: (1..3) != #{args.length}"
+    end
+  end
+
+  def self.start *args, &block
+    tel_opt = args_to_tel_opts( args )
+    gak_ssh = Shell.start( *args )
+    gak_tel = Telnet.new( gak_ssh, tel_opt )
+    gak_tel.auto_close = true
+    if block_given?
+      begin
+        block.call( gak_tel )
+      ensure
+        gak_tel.close
+      end
+    else
+      return gak_tel
+    end
+  end
+
+  def auto_close?
+    @auto_close
+  end
+
+  def close
+    super
+    @shell.close if @auto_close
+  end
+
+  def initialize ssh, in_opts={}
+    @auto_close = false
+    @shell = ssh
+    out_opts = in_opts.dup
+    out_opts['Session'] = @shell.raw_ssh
+    @raw_telnet = ::Net::SSH::Telnet.new(out_opts)
+    super @raw_telnet
+  end
+
+  def exec! cmd
+    log_exec!( 'TELNET', cmd ) do
+      @raw_telnet.cmd( cmd )
+    end
+  end
+
+end
+end end

data/lib/ghaki/net_ssh.rb

@@ -0,0 +1,12 @@
+require 'net/ssh'
+require 'net/ssh/telnet'
+require 'net/sftp'
+
+require 'ghaki/account/base'
+require 'ghaki/core_ext/file/with_temp'
+
+require 'ghaki/net_ssh/errors'
+require 'ghaki/net_ssh/shell'
+require 'ghaki/net_ssh/ftp'
+require 'ghaki/net_ssh/logger'
+require 'ghaki/net_ssh/telnet'

data/spec/ghaki/net_ssh/account_spec.rb

@@ -0,0 +1,42 @@
+require 'ghaki/net_ssh/common_helper'
+require 'ghaki/net_ssh/account'
+
+module Ghaki module NetSSH module Account_Testing
+describe Account do
+  include CommonHelper
+    
+  before(:each) do
+    setup_common
+    @account = Ghaki::NetSSH::Account.new(@user_opts)
+  end
+
+  it { should be_kind_of(Ghaki::Account::Base) }
+  it { should respond_to :logger }
+  it { should respond_to :logger= }
+
+  describe '#start_shell' do
+    it 'should create shell connection' do
+      Ghaki::NetSSH::Shell.expects(:start).
+        with( :account => subject ).returns(:shell_started)
+      subject.start_shell.should == :shell_started
+    end
+  end
+
+  describe '#start_ftp' do
+    it 'should create ftp connection' do
+      Ghaki::NetSSH::FTP.expects(:start).
+        with( :account => subject ).returns(:sftp_started)
+      subject.start_ftp.should == :sftp_started
+    end
+  end
+
+  describe '#start_telnet' do
+    it 'should create telnet connection' do
+      Ghaki::NetSSH::Telnet.expects(:start).
+        with( :account => subject ).returns(:telnet_started)
+      subject.start_telnet.should == :telnet_started
+    end
+  end
+
+end
+end end end

data/spec/ghaki/net_ssh/common_helper.rb

@@ -0,0 +1,22 @@
+require 'ghaki/account/base'
+require 'ghaki/net_ssh/spec_helper'
+
+module CommonHelper
+  include Ghaki::NetSSH::SpecHelper
+
+  def setup_common
+    setup_safe_logger
+    stub_raw_net_ssh
+    @user_opts = {
+      :username => 'user',
+      :hostname => 'host',
+      :password => 'secret',
+    }
+    @account = Ghaki::Account::Base.new @user_opts
+    @test_opts = {
+      :account  => @account,
+      :logger   => @logger,
+    }
+  end
+
+end

data/spec/ghaki/net_ssh/ftp_spec.rb

@@ -0,0 +1,75 @@
+require 'ghaki/net_ssh/ftp'
+require 'ghaki/net_ssh/common_helper'
+
+module Ghaki module NetSSH module FTP_Testing
+describe FTP do
+  include CommonHelper
+
+  before(:each) do
+    setup_common
+  end
+
+  context 'class' do
+    subject { FTP }
+    describe '#start' do
+      it 'should yield ftp' do
+        @ssh_raw.expects(:close).once
+        FTP.start(@test_opts) do |sftp| 
+          sftp.should be_an_instance_of(FTP)
+        end
+      end
+      it 'should return ftp' do
+        @ssh_raw.expects(:close).once
+        sftp = FTP.start(@test_opts)
+        sftp.should be_an_instance_of(FTP)
+        sftp.close
+      end
+    end
+  end
+
+  context 'object' do
+
+    before(:each) do
+      @ftp_gak = FTP.start(@test_opts)
+    end
+    subject { @ftp_gak }
+
+    context 'logging delegates' do
+      [ :log_command_on,  :log_output_on,  :log_all_on,
+        :log_command_off, :log_output_off, :log_all_off,
+        :log_exec!, :log_command!,
+      ].each do |token|
+        it { should respond_to token }
+      end
+    end
+
+    describe '#remove!' do
+      it 'should delegate remove' do
+        @ftp_raw.expects(:remove!).with('remote_file')
+        @ftp_gak.remove! 'remote_file'
+      end
+    end
+
+    describe '#upload!' do
+      it 'should delegate upload, rename, and remove' do
+        seq = sequence('uploader')
+        src = 'local_file'; dst = 'remote_file'
+        @ftp_raw.expects(:upload!).with(src,is_a(String)).in_sequence(seq)
+        @ftp_raw.expects(:rename!).with(is_a(String),dst).in_sequence(seq)
+        @ftp_raw.expects(:remove!).with(is_a(String)).in_sequence(seq)
+        @ftp_gak.upload! src, dst
+      end
+    end
+
+    describe '#download!' do
+      it 'should delegate download' do
+        src = 'remote_file'; dst = 'local_file'; tmp = 'tmp_file'
+        ::File.expects(:with_named_temp).yields(tmp)
+        @ftp_raw.expects(:download!).with(src,tmp)
+        @ftp_gak.download! src, dst
+      end
+    end
+  end
+
+end
+end end end

data/spec/ghaki/net_ssh/logger_spec.rb

@@ -0,0 +1,180 @@
+require 'ghaki/net_ssh/logger'
+require 'ghaki/net_ssh/common_helper'
+
+module Ghaki module NetSSH module Logger_Testing
+describe Logger do
+  include CommonHelper
+
+  before(:each) do
+    setup_common
+  end
+
+  class UsingLogger
+    include Logger
+    attr_accessor :account
+    def initialize opts={}
+      setup_logger opts
+      @account = opts[:account]
+    end
+  end
+
+  context 'objects including' do
+
+    describe '#setup_logger'    do
+      it 'should accept opt <log_ssh_command>' do
+        @subj = UsingLogger.new( :logger => @logger, :log_ssh_command => false )
+        @subj.should_log_command.should be_false
+      end
+      it 'should default opt <log_ssh_command>' do
+        @subj = UsingLogger.new( :logger => @logger )
+        @subj.should_log_command.should be_true
+      end
+      it 'should accept opt <log_ssh_output>' do
+        @subj = UsingLogger.new( :logger => @logger, :log_ssh_output => false )
+        @subj.should_log_output.should be_false
+      end
+      it 'should default opt <log_ssh_output>' do
+        @subj = UsingLogger.new( :logger => @logger )
+        @subj.should_log_output.should be_true
+      end
+    end
+
+    before(:each) do
+      @subj = UsingLogger.new(@test_opts)
+    end
+    subject { @subj }
+
+    describe '#log_command!' do
+      it 'should log title, command, and host' do
+        @logger.expects(:puts).with('SSH host : who').once
+        @subj.log_command! 'SSH', 'who'
+      end
+      it 'should not log when supressed' do
+        @subj.should_log_command = false
+        @logger.expects(:puts).never
+        @subj.log_command! 'SSH', 'who'
+      end
+    end
+
+    describe '#log_exec!' do
+      it 'should log title and output' do
+        @logger.expects(:puts).with('SSH host : who').once
+        @logger.expects(:puts).with('output').once
+        @logger.expects(:liner).twice
+        @subj.log_exec!('SSH', 'who') do 'output' end.should == 'output'
+      end
+      it 'should log only output when command is supressed' do
+        @subj.should_log_command = false
+        @logger.expects(:puts).with('SSH host : who').never
+        @logger.expects(:puts).with('output').once
+        @logger.expects(:liner).twice
+        @subj.log_exec!('SSH', 'who') do 'output' end.should == 'output'
+      end
+      it 'should not log when both are supressed' do
+        @subj.should_log_command = false
+        @subj.should_log_output = false
+        @logger.expects(:puts).never
+        @logger.expects(:liner).never
+        @subj.log_exec!('SSH', 'who') do 'output' end.should == 'output'
+      end
+      it 'should default for no output' do
+        @subj.should_log_command = false
+        @logger.expects(:puts).with('** NO OUTPUT **').once
+        @logger.expects(:liner).never
+        @subj.log_exec!('SSH', 'who') do nil end.should == ''
+      end
+    end
+
+    describe '#log_all_on' do
+      before(:each) do
+        @subj.should_log_command = @subj.should_log_output = false
+      end
+      it 'should apply only within block' do
+        @subj.log_all_on do
+          @subj.should_log_command.should be_true
+          @subj.should_log_output.should be_true
+        end
+        @subj.should_log_command.should be_false
+        @subj.should_log_output.should be_false
+      end
+      it 'should set permanently' do
+        @subj.log_all_on
+        @subj.should_log_command.should be_true
+        @subj.should_log_output.should be_true
+      end
+    end
+
+    describe '#log_all_off' do
+      it 'should apply only within block' do
+        @subj.log_all_off do
+          @subj.should_log_command.should be_false
+          @subj.should_log_output.should be_false
+        end
+        @subj.should_log_command.should be_true
+        @subj.should_log_output.should be_true
+      end
+      it 'should set permanently' do
+        @subj.log_all_off
+        @subj.should_log_command.should be_false
+        @subj.should_log_output.should be_false
+      end
+    end
+
+    describe '#log_command_on' do
+      before(:each) do @subj.should_log_command = false end
+      it 'should apply only within block' do
+        @subj.log_command_on do
+          @subj.should_log_command.should be_true
+        end
+        @subj.should_log_command.should be_false
+      end
+      it 'should set permanently' do
+        @subj.log_command_on
+        @subj.should_log_command.should be_true
+      end
+    end
+
+    describe '#log_command_off' do
+      it 'should apply only within block' do
+        @subj.log_command_off do
+          @subj.should_log_command.should be_false
+        end
+        @subj.should_log_command.should be_true
+      end
+      it 'should set permanently' do
+        @subj.log_command_off
+        @subj.should_log_command.should be_false
+      end
+    end
+
+    describe '#log_output_on' do
+      before(:each) do @subj.should_log_output = false end
+      it 'should apply only within block' do
+        @subj.log_output_on do
+          @subj.should_log_output.should be_true
+        end
+        @subj.should_log_output.should be_false
+      end
+      it 'should set permanently' do
+        @subj.log_output_on
+        @subj.should_log_output.should be_true
+      end
+    end
+
+    describe '#log_output_off' do
+      it 'should apply only within block' do
+        @subj.log_output_off do
+          @subj.should_log_output.should be_false
+        end
+        @subj.should_log_output.should be_true
+      end
+      it 'should set permanently' do
+        @subj.log_output_off
+        @subj.should_log_output.should be_false
+      end
+    end
+
+  end
+
+end
+end end end

data/spec/ghaki/net_ssh/shell_spec.rb

@@ -0,0 +1,138 @@
+require 'ghaki/net_ssh/shell'
+require 'ghaki/net_ssh/common_helper'
+require 'ghaki/match/parser/base'
+
+module Ghaki module NetSSH module Shell_Testing
+describe Shell do
+  include CommonHelper
+
+  before(:each) do
+    setup_common
+  end
+
+  context 'eigen class' do
+    subject { Shell }
+
+    describe '#start' do
+      it 'returns ssh' do
+        subject.start(@test_opts).should be_an_instance_of(Shell)
+      end
+      it 'yields ssh' do
+        @ssh_raw.expects(:close).once
+        subject.start(@test_opts) do |ssh|
+          ssh.should be_an_instance_of(Shell)
+        end
+      end
+      it 'handles password retries' do
+        @account.passwords = ['invalid','secret']
+        ::Net::SSH.expects(:start).raises(::Net::SSH::AuthenticationFailed).then.returns(@ssh_raw)
+        @logger.expects(:warn).with(regexp_matches(%r{failed\spassword\sattempt}))
+        subject.start(@test_opts).should be_an_instance_of(Shell)
+        @account.failed_passwords?.should be_true
+      end
+    end
+
+  end
+
+  context 'object instance' do
+    before(:each) do
+      @ssh_gak = Shell.start(@test_opts)
+    end
+    subject { @ssh_gak }
+
+    describe '#exec!' do
+      it 'delegates to ssh' do
+        @ssh_raw.expects(:exec!).with('who').returns('nobody')
+        @ssh_gak.exec! 'who'
+      end
+    end
+    
+    describe '#telnet' do
+      it 'creates telnet' do
+        tel = @ssh_gak.telnet
+        tel.should be_an_instance_of(Telnet)
+      end
+      it 'yields telnet' do
+        @tel_raw.expects(:close).once
+        @ssh_gak.telnet do |tel|
+          tel.should be_an_instance_of(Telnet)
+        end
+      end
+    end
+
+    describe '#discover' do
+      before(:each) do
+        @matcher = Ghaki::Match::Parser::Base.new({
+          %r{foo}o => :foo,
+        })
+      end
+      it 'matches if found' do
+        @ssh_raw.expects(:exec!).with('who').returns('foo')
+        @ssh_gak.discover( 'who', @matcher ).should == :foo
+      end
+      it 'rejects if not found' do
+        lambda do
+          @ssh_raw.expects(:exec!).with('who').returns('bar')
+          @ssh_gak.discover( 'who', @matcher )
+        end.should raise_error(RemoteCommandError)
+      end
+    end
+
+    describe '#sftp' do
+      it 'creates ftp' do
+        ftp = @ssh_gak.sftp
+        ftp.should be_an_instance_of(FTP)
+      end
+      it 'yields ftp' do
+        @ssh_gak.sftp do |ftp|
+          ftp.should be_an_instance_of(FTP)
+        end
+      end
+    end
+
+    ####################################################################
+    describe 'sftp helpers' do
+
+      before(:each) do
+        @ftp_gak = mock('Ghaki::NetSSH::FTP')
+        FTP.stubs( :new => @ftp_gak )
+      end
+
+      describe '#remove!' do
+        it 'delegates to ftp' do
+          trg = 'remote_file'
+          @ftp_gak.expects(:remove!).with(trg)
+          @ssh_gak.remove! trg
+        end
+      end
+
+      describe '#upload!' do
+        it 'delegates to ftp' do
+          src,dst = 'local_file', 'remote_file'
+          @ftp_gak.expects(:upload!).with(src,dst)
+          @ssh_gak.upload! src, dst
+        end
+      end
+
+      describe '#download!' do
+        it 'delegates to ftp' do
+          src,dst = 'remote_file', 'local_file'
+          @ftp_gak.expects(:download!).with(src,dst)
+          @ssh_gak.download! src, dst
+        end
+      end
+
+      describe '#redirect' do
+        it 'delegates to ftp' do
+          src,dst = 'remote_file', 'local_file'
+          put = 'output'
+          @ftp_gak.expects(:remove!).with(src)
+          @ftp_gak.expects(:download!).with(src,dst)
+          @ssh_gak.redirect(src,dst) do put end.should == put
+        end
+      end
+    end
+
+  end
+end
+end end end

data/spec/ghaki/net_ssh/telnet_spec.rb

@@ -0,0 +1,67 @@
+require 'ghaki/net_ssh/telnet'
+require 'ghaki/net_ssh/common_helper'
+
+module Ghaki module NetSSH module Telnet_Testing
+describe Telnet do
+  include CommonHelper
+
+  before(:each) do
+    setup_common
+  end
+
+  ########################################################################
+  context 'class' do
+
+    subject { Telnet }
+
+    describe '#start' do
+
+      it 'should yield telnet' do
+        @tel_raw.expects(:close).once
+        @ssh_raw.expects(:close).once
+        Telnet.start(@test_opts) do |tel|
+          tel.should be_an_instance_of(Telnet)
+        end
+      end
+
+      it 'should return telnet' do
+        @tel_raw.expects(:close).once
+        @ssh_raw.expects(:close).once
+        tel = Telnet.start(@test_opts)
+        tel.should be_an_instance_of(Telnet)
+        tel.close
+      end
+
+    end
+
+  end
+
+  ########################################################################
+  context 'object' do
+
+    before(:each) do
+      @tel_gak = Telnet.start(@test_opts)
+    end
+    subject { @tel_gak }
+
+    context 'logging delegates' do
+      [ :log_command_on,  :log_output_on,  :log_all_on,
+        :log_command_off, :log_output_off, :log_all_off,
+        :log_exec!, :log_command!,
+      ].each do |token|
+        it { should respond_to token }
+      end
+    end
+
+    describe '#exec!' do
+      it 'should delegate to telnet' do
+        @tel_raw.expects(:cmd).with('who').returns('moo')
+        @tel_gak.exec!('who').should == 'moo'
+      end
+    end
+
+  end
+
+end
+end end end
+############################################################################

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'bundler/setup'
+require 'mocha'
+
+RSpec.configure do |cfg|
+  cfg.mock_with :mocha
+  cfg.color_enabled = true
+end

metadata

@@ -0,0 +1,202 @@
+--- !ruby/object:Gem::Specification
+name: ghaki-net-ssh
+version: !ruby/object:Gem::Version
+  version: 2011.11.30.1
+  prerelease: 
+platform: ruby
+authors:
+- Gerald Kalafut
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-11-30 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ghaki-account
+  requirement: &74945690 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2011.11.29.1
+  type: :runtime
+  prerelease: false
+  version_requirements: *74945690
+- !ruby/object:Gem::Dependency
+  name: ghaki-app
+  requirement: &74945450 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2011.11.29.1
+  type: :runtime
+  prerelease: false
+  version_requirements: *74945450
+- !ruby/object:Gem::Dependency
+  name: ghaki-ext-file
+  requirement: &74945230 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2011.11.29.1
+  type: :runtime
+  prerelease: false
+  version_requirements: *74945230
+- !ruby/object:Gem::Dependency
+  name: ghaki-logger
+  requirement: &74945000 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2011.11.29.1
+  type: :runtime
+  prerelease: false
+  version_requirements: *74945000
+- !ruby/object:Gem::Dependency
+  name: highline
+  requirement: &74944780 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.6.1
+  type: :runtime
+  prerelease: false
+  version_requirements: *74944780
+- !ruby/object:Gem::Dependency
+  name: net-ssh
+  requirement: &74944530 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: *74944530
+- !ruby/object:Gem::Dependency
+  name: net-ssh-telnet
+  requirement: &74944270 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: *74944270
+- !ruby/object:Gem::Dependency
+  name: net-sftp
+  requirement: &74944030 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.0.5
+  type: :runtime
+  prerelease: false
+  version_requirements: *74944030
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &74943800 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.6.0
+  type: :development
+  prerelease: false
+  version_requirements: *74943800
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: &74943570 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.9.4
+  type: :development
+  prerelease: false
+  version_requirements: *74943570
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: &74943320 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.12
+  type: :development
+  prerelease: false
+  version_requirements: *74943320
+- !ruby/object:Gem::Dependency
+  name: ghaki-match
+  requirement: &74943090 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2011.11.30.1
+  type: :development
+  prerelease: false
+  version_requirements: *74943090
+description: Ghaki Net SSH is a collection of extensions for the Net SSH gem library.
+email: gerald@kalafut.org
+executables: []
+extensions: []
+extra_rdoc_files:
+- README
+files:
+- lib/ghaki/net_ssh/logger.rb
+- lib/ghaki/net_ssh/ftp.rb
+- lib/ghaki/net_ssh/account.rb
+- lib/ghaki/net_ssh/telnet.rb
+- lib/ghaki/net_ssh/spec_helper.rb
+- lib/ghaki/net_ssh/errors.rb
+- lib/ghaki/net_ssh/shell.rb
+- lib/ghaki/net_ssh.rb
+- README
+- LICENSE
+- VERSION
+- spec/ghaki/net_ssh/account_spec.rb
+- spec/ghaki/net_ssh/logger_spec.rb
+- spec/ghaki/net_ssh/ftp_spec.rb
+- spec/ghaki/net_ssh/telnet_spec.rb
+- spec/ghaki/net_ssh/shell_spec.rb
+- spec/spec_helper.rb
+- spec/ghaki/net_ssh/common_helper.rb
+homepage: http://github.com/ghaki
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.3.6
+requirements: []
+rubyforge_project: ghaki-net-ssh
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Secure Shell helpers
+test_files:
+- spec/ghaki/net_ssh/account_spec.rb
+- spec/ghaki/net_ssh/logger_spec.rb
+- spec/ghaki/net_ssh/ftp_spec.rb
+- spec/ghaki/net_ssh/telnet_spec.rb
+- spec/ghaki/net_ssh/shell_spec.rb
+- spec/spec_helper.rb
+- spec/ghaki/net_ssh/common_helper.rb