ssh 1.0.0

data/.autotest

@@ -0,0 +1,27 @@
+# -*- ruby -*-
+
+require 'autotest/isolate'
+require "autotest/restart"
+
+Autotest.add_hook :initialize do |at|
+  at.testlib = "minitest/autorun"
+  at.add_exception "tmp"
+
+#   at.extra_files << "../some/external/dependency.rb"
+#
+#   at.libs << ":../some/external"
+#
+#   at.add_exception "vendor"
+#
+#   at.add_mapping(/dependency.rb/) do |f, _|
+#     at.files_matching(/test_.*rb$/)
+#   end
+#
+#   %w(TestA TestB).each do |klass|
+#     at.extra_class_map[klass] = "test/test_misc.rb"
+#   end
+end
+
+# Autotest.add_hook :run_command do |at|
+#   system "rake build"
+# end

data/History.txt

@@ -0,0 +1,5 @@
+=== 1.0.0 / 2011-11-03
+
+* 1 major enhancement
+
+  * Birthday! Sorta... Extracted from rake-remote_task 2.0.5.

data/Manifest.txt

@@ -0,0 +1,7 @@
+.autotest
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+lib/ssh.rb
+test/test_ssh.rb

data/README.txt

@@ -0,0 +1,58 @@
+= SSH
+
+home :: https://github.com/seattlerb/ssh
+rdoc :: http://docs.seattlerb.org/ssh
+
+== DESCRIPTION:
+
+SSH provides a simple streaming ssh command runner. That's it.
+This is a one trick pony.
+
+    ssh = SSH.new "example.com", "/var/log"
+    puts ssh.run "ls"
+
+SSH was extracted from rake-remote_task which was extracted from vlad.
+
+== FEATURES/PROBLEMS:
+
+* Provides a simple streaming ssh command runner.
+* There is no 2
+* How the hell was this gem name not used already?
+
+== SYNOPSIS:
+
+    ssh = SSH.new "example.com", "/var/log"
+    puts ssh.run "ls"
+
+== REQUIREMENTS:
+
+* open4
+
+== INSTALL:
+
+* sudo gem install ssh
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) Ryan Davis, seattle.rb
+
+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/Rakefile

@@ -0,0 +1,16 @@
+# -*- ruby -*-
+
+require "rubygems"
+require "hoe"
+
+Hoe.plugin :isolate
+Hoe.plugin :seattlerb
+
+Hoe.spec "ssh" do
+  developer "Ryan Davis", "ryand-ruby@zenspider.com"
+
+#  dependency 'rake',     '~> 0.8'
+  dependency 'open4',    '~> 1.0'
+end
+
+# vim: syntax=ruby

data/lib/ssh.rb

@@ -0,0 +1,110 @@
+require 'rubygems'
+require 'open4'
+
+##
+# SSH provides a simple streaming ssh command runner. That's it.
+# This is a one trick pony.
+#
+#   ssh = SSH.new "example.com", "/var/log"
+#   puts ssh.run "ls"
+#
+# SSH was extracted from rake-remote_task which was extracted from vlad.
+#
+# SSH's idea contributed by Joel Parker Henderson.
+
+class SSH
+  VERSION = "1.0.0"
+
+  class Error < RuntimeError; end
+
+  class CommandFailedError < Error
+    attr_reader :status
+    def initialize status
+      @status = status
+    end
+  end
+
+  include Open4
+
+  attr_accessor :ssh_cmd, :ssh_flags, :target_host, :target_dir
+  attr_accessor :sudo_prompt, :sudo_password
+
+  def initialize target_host = nil, target_dir = nil
+    self.ssh_cmd       = "ssh"
+    self.ssh_flags     = []
+    self.target_host   = target_host
+    self.target_dir    = target_dir
+
+    self.sudo_prompt   = /^Password:/
+    self.sudo_password = nil
+  end
+
+  def run command
+    command = "cd #{target_dir} && #{command}" if target_dir
+    cmd     = [ssh_cmd, ssh_flags, target_host, command].flatten
+
+    if $DEBUG then
+      trace = [ssh_cmd, ssh_flags, target_host, "'#{command}'"]
+      warn trace.flatten.join ' '
+    end
+
+    pid, inn, out, err = popen4(*cmd)
+
+    status, result = empty_streams pid, inn, out, err
+
+    unless status.success? then
+      e = status.exitstatus
+      c = cmd.join ' '
+      raise(CommandFailedError.new(status), "Failed with status #{e}: #{c}")
+    end
+
+    result.join
+  ensure
+    inn.close rescue nil
+    out.close rescue nil
+    err.close rescue nil
+  end
+
+  def empty_streams pid, inn, out, err
+    result  = []
+    inn.sync   = true
+    streams    = [out, err]
+    out_stream = {
+      out => $stdout,
+      err => $stderr,
+    }
+
+    # Handle process termination ourselves
+    status = nil
+    Thread.start do
+      status = Process.waitpid2(pid).last
+    end
+
+    until streams.empty? do
+      # don't busy loop
+      selected, = select streams, nil, nil, 0.1
+
+      next if selected.nil? or selected.empty?
+
+      selected.each do |stream|
+        if stream.eof? then
+          streams.delete stream if status # we've quit, so no more writing
+          next
+        end
+
+        data = stream.readpartial(1024)
+        out_stream[stream].write data
+
+        if stream == err and data =~ sudo_prompt then
+          inn.puts sudo_password
+          data << "\n"
+          $stderr.write "\n"
+        end
+
+        result << data
+      end
+    end
+
+    return status, result
+  end
+end

data/test/test_ssh.rb

@@ -0,0 +1,132 @@
+require "minitest/autorun"
+require "ssh"
+
+require 'stringio'
+
+class StringIO
+  def readpartial(size) read end # suck!
+end
+
+module Process
+  def self.expected status
+    @@expected ||= []
+    @@expected << status
+  end
+
+  class << self
+    alias :waitpid2_old :waitpid2
+
+    def waitpid2(pid)
+      [ @@expected.shift ]
+    end
+  end
+end
+
+class SSH
+  attr_accessor :commands, :action, :input, :output, :error
+
+  class Status < Struct.new :exitstatus
+    def success?() exitstatus == 0 end
+  end
+
+  def popen4 *command
+    @commands << command
+
+    @input = StringIO.new
+    out    = StringIO.new @output.shift.to_s
+    err    = StringIO.new @error.shift.to_s
+
+    raise if block_given?
+
+    status = self.action ? self.action[command.join(' ')] : 0
+    Process.expected Status.new(status)
+
+    return 42, @input, out, err
+  end
+
+  def select reads, writes, errs, timeout
+    [reads, writes, errs]
+  end
+end
+
+class TestSSH < MiniTest::Unit::TestCase
+  def setup
+    super
+    @ssh = SSH.new
+    @ssh.commands = []
+    @ssh.output   = []
+    @ssh.error    = []
+    @ssh.action   = nil
+  end
+
+  def test_run
+    @ssh.output << "file1\nfile2\n"
+    @ssh.target_host = "app.example.com"
+    result = nil
+
+    out, err = capture_io do
+      result = @ssh.run("ls")
+    end
+
+    commands = @ssh.commands
+
+    assert_equal 1, commands.size, 'not enough commands'
+    assert_equal ["ssh", "app.example.com", "ls"],
+                 commands.first, 'app'
+    assert_equal "file1\nfile2\n", result
+
+    assert_equal "file1\nfile2\n", out
+    assert_equal '', err
+  end
+
+  def test_run_dir
+    @ssh.target_host = "app.example.com"
+    @ssh.target_dir  = "/www/dir1"
+
+    @ssh.run("ls")
+
+    commands = @ssh.commands
+
+    assert_equal [["ssh", "app.example.com", "cd /www/dir1 && ls"]], commands
+  end
+
+  def test_run_failing_command
+    @ssh.input = StringIO.new "file1\nfile2\n"
+    @ssh.target_host =  'app.example.com'
+    @ssh.action = proc { 1 }
+
+    e = assert_raises(SSH::CommandFailedError) { @ssh.run("ls") }
+    assert_equal "Failed with status 1: ssh app.example.com ls", e.message
+
+    assert_equal [["ssh", "app.example.com", "ls"]], @ssh.commands
+  end
+
+  def test_run_sudo
+    @ssh.output << "file1\nfile2\n"
+    @ssh.error << 'Password:'
+    @ssh.target_host = "app.example.com"
+    @ssh.sudo_password = "my password"
+    result = nil
+
+    out, err = capture_io do
+      result = @ssh.run("sudo ls")
+    end
+
+    commands = @ssh.commands
+
+    assert_equal 1, commands.size, 'not enough commands'
+    assert_equal ['ssh', 'app.example.com', 'sudo ls'],
+                 commands.first
+
+    assert_equal "my password\n", @ssh.input.string
+
+    # WARN: Technically incorrect, the password line should be
+    # first... this is an artifact of changes to the IO code in run
+    # and the fact that we have a very simplistic (non-blocking)
+    # testing model.
+    assert_equal "file1\nfile2\nPassword:\n", result
+
+    assert_equal "file1\nfile2\n", out
+    assert_equal "Password:\n", err
+  end
+end

metadata

@@ -0,0 +1,163 @@
+--- !ruby/object:Gem::Specification 
+name: ssh
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: 
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Ryan Davis
+autorequire: 
+bindir: bin
+cert_chain: 
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIDPjCCAiagAwIBAgIBADANBgkqhkiG9w0BAQUFADBFMRMwEQYDVQQDDApyeWFu
+  ZC1ydWJ5MRkwFwYKCZImiZPyLGQBGRYJemVuc3BpZGVyMRMwEQYKCZImiZPyLGQB
+  GRYDY29tMB4XDTA5MDMwNjE4NTMxNVoXDTEwMDMwNjE4NTMxNVowRTETMBEGA1UE
+  AwwKcnlhbmQtcnVieTEZMBcGCgmSJomT8ixkARkWCXplbnNwaWRlcjETMBEGCgmS
+  JomT8ixkARkWA2NvbTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBALda
+  b9DCgK+627gPJkB6XfjZ1itoOQvpqH1EXScSaba9/S2VF22VYQbXU1xQXL/WzCkx
+  taCPaLmfYIaFcHHCSY4hYDJijRQkLxPeB3xbOfzfLoBDbjvx5JxgJxUjmGa7xhcT
+  oOvjtt5P8+GSK9zLzxQP0gVLS/D0FmoE44XuDr3iQkVS2ujU5zZL84mMNqNB1znh
+  GiadM9GHRaDiaxuX0cIUBj19T01mVE2iymf9I6bEsiayK/n6QujtyCbTWsAS9Rqt
+  qhtV7HJxNKuPj/JFH0D2cswvzznE/a5FOYO68g+YCuFi5L8wZuuM8zzdwjrWHqSV
+  gBEfoTEGr7Zii72cx+sCAwEAAaM5MDcwCQYDVR0TBAIwADALBgNVHQ8EBAMCBLAw
+  HQYDVR0OBBYEFEfFe9md/r/tj/Wmwpy+MI8d9k/hMA0GCSqGSIb3DQEBBQUAA4IB
+  AQAY59gYvDxqSqgC92nAP9P8dnGgfZgLxP237xS6XxFGJSghdz/nI6pusfCWKM8m
+  vzjjH2wUMSSf3tNudQ3rCGLf2epkcU13/rguI88wO6MrE0wi4ZqLQX+eZQFskJb/
+  w6x9W1ur8eR01s397LSMexySDBrJOh34cm2AlfKr/jokKCTwcM0OvVZnAutaovC0
+  l1SVZ0ecg88bsWHA0Yhh7NFxK1utWoIhtB6AFC/+trM0FQEB/jZkIS8SaNzn96Rl
+  n0sZEf77FLf5peR8TP/PtmIg7Cyqz23sLM4mCOoTGIy5OcZ8TdyiyINUHtb5ej/T
+  FBHgymkyj/AOSqKRIpXPhjC6
+  -----END CERTIFICATE-----
+
+date: 2011-11-15 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: open4
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 1
+        - 0
+        version: "1.0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rdoc
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 21
+        segments: 
+        - 3
+        - 9
+        version: "3.9"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: minitest
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 2
+        - 7
+        version: "2.7"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 27
+        segments: 
+        - 2
+        - 12
+        version: "2.12"
+  type: :development
+  version_requirements: *id004
+description: |-
+  SSH provides a simple streaming ssh command runner. That's it.
+  This is a one trick pony.
+  
+      ssh = SSH.new "example.com", "/var/log"
+      puts ssh.run "ls"
+  
+  SSH was extracted from rake-remote_task which was extracted from vlad.
+email: 
+- ryand-ruby@zenspider.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.txt
+files: 
+- .autotest
+- History.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- lib/ssh.rb
+- test/test_ssh.rb
+- .gemtest
+homepage: https://github.com/seattlerb/ssh
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: ssh
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: SSH provides a simple streaming ssh command runner
+test_files: 
+- test/test_ssh.rb