net-ssh-shell 0.1.0 → 0.2.0

data/.gitignore

@@ -0,0 +1,4 @@
+*.swp
+pkg
+doc
+Gemfile.lock

data/CHANGELOG.md

@@ -0,0 +1,10 @@
+## 0.2.0 (unreleased)
+
+  - Loosen regex on `on_stdout` [GH-1]
+  - Capture stderr from shell. This won't capture the stderr of the processes
+    running. Instead it will just capture any error output from the shell process.
+  - Ability to specify the default process class to use for `Shell#execute`
+
+## 0.1.0 (October 24, 2010)
+
+  - Initial release

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gem "net-ssh-shell", :path => '.'

data/README.rdoc

@@ -41,12 +41,12 @@ If you want to use any of the Rake tasks, you'll need:
 * Echoe (for the Rakefile)
 
 == INSTALL:
-This gem is not yet on rubygems , so you have to install it from this source
+
+This gem is available from RubyGems, so you can install it using the "gem" command:
 
 * gem install net-ssh-shell
-ERROR: could not find gem net-ssh-shell locally or in a repository
 
-Therefor you need to build the gem yourself:
+If you'd like to build the gem for yourself from source:
 * git clone http://github.com/jedi4ever/net-ssh-shell.git
 * cd net-ssh-shell
 * gem install echoe

data/Rakefile

@@ -1,28 +1,3 @@
-require './lib/net/ssh/shell/version'
-
-begin
-  require 'echoe'
-rescue LoadError
-  abort "You'll need to have `echoe' installed to use Net::SSH::Shell's Rakefile"
-end
-
-version = Net::SSH::Shell::Version::STRING.dup
-if ENV['SNAPSHOT'].to_i == 1
-  version << "." << Time.now.utc.strftime("%Y%m%d%H%M%S")
-end
-
-Echoe.new('net-ssh-shell', version) do |p|
-  p.changelog        = "CHANGELOG.rdoc"
-
-  p.author           = "Jamis Buck"
-  p.email            = "jamis@jamisbuck.org"
-  p.summary          = "A simple library to aid with stateful shell interactions"
-  p.url              = "http://net-ssh.rubyforge.org/shell"
-
-  p.dependencies     = ["net-ssh >=2.0.9"]
-
-  p.need_zip         = true
-  p.include_rakefile = true
-
-  p.rdoc_pattern     = /^(lib|README.rdoc|CHANGELOG.rdoc)/
-end
+require 'rubygems'
+require 'bundler/setup'
+Bundler::GemHelper.install_tasks

data/lib/net/ssh/shell.rb

@@ -11,6 +11,7 @@ module Net
       attr_reader :state
       attr_reader :shell
       attr_reader :processes
+      attr_accessor :default_process_class
 
       def initialize(session, shell=:default)
         @session = session
@@ -18,6 +19,8 @@ module Net
         @state = :closed
         @processes = []
         @when_open = []
+        @on_process_run = nil
+        @default_process_class = Net::SSH::Shell::Process
         open
       end
 
@@ -26,6 +29,7 @@ module Net
           @state = :opening
           @channel = session.open_channel(&method(:open_succeeded))
           @channel.on_open_failed(&method(:open_failed))
+          @channel.on_request('exit-status', &method(:on_exit_status))
         end
         when_open(&callback) if callback
         self
@@ -60,11 +64,23 @@ module Net
         !open? && !closed?
       end
 
-      def execute(command, klass=Net::SSH::Shell::Process, &callback)
-        process = klass.new(self, command, callback)
-        process.run if processes.empty?
+      def on_process_run(&callback)
+        @on_process_run = callback
+      end
+
+      def execute(command, *args, &callback)
+        # The class is an optional second argument.
+        klass = default_process_class
+        klass = args.shift if args.first.is_a?(Class)
+
+        # The properties are expected to be the next argument.
+        props = {}
+        props = args.shift if args.first.is_a?(Hash)
+
+        process = klass.new(self, command, props, callback)
         processes << process
-        return process
+        run_next_process if processes.length == 1
+        process
       end
 
       def subshell(command, &callback)
@@ -72,9 +88,9 @@ module Net
       end
 
       def execute!(command, &callback)
-        execute(command, &callback)
+        process = execute(command, &callback)
         wait!
-	return process
+        process
       end
 
       def busy?
@@ -92,7 +108,7 @@ module Net
       def child_finished(child)
         channel.on_close(&method(:on_channel_close)) if !channel.nil?
         processes.delete(child)
-        processes.first.run if processes.any?
+        run_next_process
       end
 
       def separator
@@ -109,41 +125,55 @@ module Net
 
       private
 
-        def open_succeeded(channel)
-          @state = :pty
-          channel.on_close(&method(:on_channel_close))
-          channel.request_pty(:modes => { Net::SSH::Connection::Term::ECHO => 0 }, &method(:pty_requested))
+      def run_next_process
+        if processes.any?
+          process = processes.first
+          @on_process_run.call(self, process) if @on_process_run
+          process.run
         end
+      end
 
-        def open_failed(channel, code, description)
-          @state = :closed
-          raise "could not open channel for process manager (#{description}, ##{code})"
-        end
+      def open_succeeded(channel)
+        @state = :pty
+        channel.on_close(&method(:on_channel_close))
+        channel.request_pty(:modes => { Net::SSH::Connection::Term::ECHO => 0 }, &method(:pty_requested))
+      end
+
+      def open_failed(channel, code, description)
+        @state = :closed
+        raise "could not open channel for process manager (#{description}, ##{code})"
+      end
 
-        def pty_requested(channel, success)
-          @state = :shell
-          raise "could not request pty for process manager" unless success
-          if shell == :default
-            channel.send_channel_request("shell", &method(:shell_requested))
-          else
-            channel.exec(shell, &method(:shell_requested))
-          end
+      def on_exit_status(channel, data)
+        unless data.read_long == 0
+          raise "the shell exited unexpectedly"
         end
+      end
 
-        def shell_requested(channel, success)
-          @state = :initializing
-          raise "could not request shell for process manager" unless success
-          channel.on_data(&method(:look_for_initialization_done))
-          channel.send_data "export PS1=; echo #{separator} $?\n"
+      def pty_requested(channel, success)
+        @state = :shell
+        raise "could not request pty for process manager" unless success
+        if shell == :default
+          channel.send_channel_request("shell", &method(:shell_requested))
+        else
+          channel.exec(shell, &method(:shell_requested))
         end
+      end
+
+      def shell_requested(channel, success)
+        @state = :initializing
+        raise "could not request shell for process manager" unless success
+        channel.on_data(&method(:look_for_initialization_done))
+        channel.send_data "export PS1=; echo #{separator} $?\n"
+      end
 
-        def look_for_initialization_done(channel, data)
-          if data.include?(separator)
-            @state = :open
-            @when_open.each { |callback| callback.call(self) }
-            @when_open.clear
-          end
+      def look_for_initialization_done(channel, data)
+        if data.include?(separator)
+          @state = :open
+          @when_open.each { |callback| callback.call(self) }
+          @when_open.clear
         end
+      end
     end
   end
 end
@@ -155,6 +185,6 @@ class Net::SSH::Connection::Session
   def shell(*args)
     shell = Net::SSH::Shell.new(self, *args)
     yield shell if block_given?
-    return shell
+    shell
   end
 end

data/lib/net/ssh/shell/process.rb

@@ -1,5 +1,4 @@
 module Net; module SSH; class Shell
-
   class Process
     attr_reader :state
     attr_reader :command
@@ -8,12 +7,13 @@ module Net; module SSH; class Shell
     attr_reader :exit_status
     attr_reader :properties
 
-    def initialize(manager, command, callback)
+    def initialize(manager, command, properties, callback)
       @command = command
       @manager = manager
       @callback = callback
-      @properties = {}
-      @on_output = Proc.new { |p, data| print(data) }
+      @properties = properties
+      @on_output = nil
+      @on_error_output = nil
       @on_finish = nil
       @state = :new
     end
@@ -36,14 +36,16 @@ module Net; module SSH; class Shell
         manager.open do
           state = :running
           manager.channel.on_data(&method(:on_stdout))
-          @master_onclose = manager.channel.on_close(&method(:on_close))
+          manager.channel.on_extended_data(&method(:on_stderr))
+          manager.channel.on_close(&method(:on_close))
+
+          callback.call(self) if callback
 
           cmd = command.dup
           cmd << ";" if cmd !~ /[;&]$/
           cmd << " DONTEVERUSETHIS=$?; echo #{manager.separator} $DONTEVERUSETHIS; echo \"exit $DONTEVERUSETHIS\"|sh"
 
           send_data(cmd + "\n")
-          callback.call(self) if callback
         end
       end
 
@@ -75,38 +77,44 @@ module Net; module SSH; class Shell
       @on_output = callback
     end
 
+    def on_error_output(&callback)
+      @on_error_output = callback
+    end
+
     def on_finish(&callback)
       @on_finish = callback
     end
 
-    private
+    protected
 
-      def output!(data)
-        return unless @on_output
-        @on_output.call(self, data)
-      end
+    def output!(data)
+      @on_output.call(self, data) if @on_output
+    end
 
-      def on_stdout(ch, data)
-        if data.strip =~ /^#{manager.separator} (\d+)$/
-          before = $`
-          output!(before) unless before.empty?
-          finished!($1)
-        else
-          output!(data)
-        end
+    def on_stdout(ch, data)
+      if data.strip =~ /#{manager.separator} (\d+)$/
+        before = $`
+        output!(before) unless before.empty?
+        finished!($1)
+      else
+        output!(data)
       end
+    end
 
-      def on_close(ch)
-        manager.on_channel_close(ch)
-        finished!(-1)
-      end
+    def on_stderr(ch, type, data)
+      @on_error_output.call(self, data) if @on_error_output
+    end
 
-      def finished!(status)
-        @state = :finished
-        @exit_status = status.to_i
-        @on_finish.call(self) if @on_finish
-        manager.child_finished(self)
-      end
-  end
+    def on_close(ch)
+      manager.on_channel_close(ch)
+      finished!(-1)
+    end
 
+    def finished!(status)
+      @state = :finished
+      @exit_status = status.to_i
+      @on_finish.call(self) if @on_finish
+      manager.child_finished(self)
+    end
+  end
 end; end; end

data/lib/net/ssh/shell/subshell.rb

@@ -1,23 +1,21 @@
 require 'net/ssh/shell/process'
 
 module Net; module SSH; class Shell
-
   class Subshell < Process
-    private
+    protected
 
-      def on_stdout(ch, data)
-        if !output!(data)
-          ch.on_data(&method(:look_for_finalize_initializer))
-          ch.send_data("export PS1=; echo #{manager.separator} $?\n")
-        end
+    def on_stdout(ch, data)
+      if !output!(data)
+        ch.on_data(&method(:look_for_finalize_initializer))
+        ch.send_data("export PS1=; echo #{manager.separator} $?\n")
       end
+    end
 
-      def look_for_finalize_initializer(ch, data)
-        if data =~ /#{manager.separator} (\d+)/
-          ch.on_close(&@master_onclose)
-          finished!($1)
-        end
+    def look_for_finalize_initializer(ch, data)
+      if data =~ /#{manager.separator} (\d+)/
+        ch.on_close(&@master_onclose)
+        finished!($1)
       end
+    end
   end
-
-end; end; end
+end; end; end

data/lib/net/ssh/shell/version.rb

@@ -1,22 +1,7 @@
-require 'net/ssh/version'
-
-module Net; module SSH; module Shell
-  # A trivial class for representing the version of this library.
-  class Version < Net::SSH::Version
-    # The major component of the library's version
-    MAJOR = 0
-
-    # The minor component of the library's version
-    MINOR = 1
-
-    # The tiny component of the library's version
-    TINY  = 0
-
-    # The library's version as a Version instance
-    CURRENT = new(MAJOR, MINOR, TINY)
-
-    # The library's version as a String instance
-    STRING = CURRENT.to_s
+module Net
+  module SSH
+    class Shell
+      VERSION = "0.2.0"
+    end
   end
-end; end; end
-
+end

data/net-ssh-shell.gemspec

@@ -1,33 +1,23 @@
-# -*- encoding: utf-8 -*-
+require File.expand_path("../lib/net/ssh/shell/version", __FILE__)
 
 Gem::Specification.new do |s|
-  s.name = %q{net-ssh-shell}
-  s.version = "0.1.0"
+  s.name          = "net-ssh-shell"
+  s.version       = Net::SSH::Shell::VERSION
+  s.platform      = Gem::Platform::RUBY
+  s.authors       = ["Jamis Buck"]
+  s.email         = ["jamis@jamisbuck.org"]
+  s.homepage      = "http://github.com/mitchellh/net-ssh-shell"
+  s.summary       = "A simple library to aid with stateful shell interactions"
+  s.description   = "A simple library to aid with stateful shell interactions"
 
-  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Jamis Buck"]
-  s.date = %q{2010-10-25}
-  s.description = %q{A simple library to aid with stateful shell interactions}
-  s.email = %q{jamis@jamisbuck.org}
-  s.extra_rdoc_files = ["CHANGELOG.rdoc", "lib/net/ssh/shell/process.rb", "lib/net/ssh/shell/subshell.rb", "lib/net/ssh/shell/version.rb", "lib/net/ssh/shell.rb", "README.rdoc"]
-  s.files = ["CHANGELOG.rdoc", "lib/net/ssh/shell/process.rb", "lib/net/ssh/shell/subshell.rb", "lib/net/ssh/shell/version.rb", "lib/net/ssh/shell.rb", "Rakefile", "README.rdoc", "Manifest", "net-ssh-shell.gemspec"]
-  s.homepage = %q{http://net-ssh.rubyforge.org/shell}
-  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Net-ssh-shell", "--main", "README.rdoc"]
-  s.require_paths = ["lib"]
-  s.rubyforge_project = %q{net-ssh-shell}
-  s.rubygems_version = %q{1.3.7}
-  s.summary = %q{A simple library to aid with stateful shell interactions}
+  s.required_rubygems_version = ">= 1.3.6"
+  s.rubyforge_project         = "net-ssh-shell"
 
-  if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
-    s.specification_version = 3
+  s.add_dependency "net-ssh", "~> 2.1.0"
 
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<net-ssh>, [">= 2.0.9"])
-    else
-      s.add_dependency(%q<net-ssh>, [">= 2.0.9"])
-    end
-  else
-    s.add_dependency(%q<net-ssh>, [">= 2.0.9"])
-  end
+  s.add_development_dependency "rake"
+
+  s.files         = `git ls-files`.split("\n")
+  s.executables   = `git ls-files`.split("\n").map{|f| f =~ /^bin\/(.*)/ ? $1 : nil}.compact
+  s.require_path  = 'lib'
 end

metadata

@@ -1,13 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: net-ssh-shell
 version: !ruby/object:Gem::Version 
-  hash: 27
-  prerelease: false
-  segments: 
-  - 0
-  - 1
-  - 0
-  version: 0.1.0
+  prerelease: 
+  version: 0.2.0
 platform: ruby
 authors: 
 - Jamis Buck
@@ -15,60 +10,56 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-25 00:00:00 +04:00
-default_executable: 
+date: 2011-06-13 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: net-ssh
-  prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
-        hash: 29
-        segments: 
-        - 2
-        - 0
-        - 9
-        version: 2.0.9
+        version: 2.1.0
   type: :runtime
+  prerelease: false
   version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rake
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id002
 description: A simple library to aid with stateful shell interactions
-email: jamis@jamisbuck.org
+email: 
+- jamis@jamisbuck.org
 executables: []
 
 extensions: []
 
-extra_rdoc_files: 
-- CHANGELOG.rdoc
-- lib/net/ssh/shell/process.rb
-- lib/net/ssh/shell/subshell.rb
-- lib/net/ssh/shell/version.rb
-- lib/net/ssh/shell.rb
-- README.rdoc
+extra_rdoc_files: []
+
 files: 
-- CHANGELOG.rdoc
+- .gitignore
+- CHANGELOG.md
+- Gemfile
+- README.rdoc
+- Rakefile
+- lib/net/ssh/shell.rb
 - lib/net/ssh/shell/process.rb
 - lib/net/ssh/shell/subshell.rb
 - lib/net/ssh/shell/version.rb
-- lib/net/ssh/shell.rb
-- Rakefile
-- README.rdoc
-- Manifest
 - net-ssh-shell.gemspec
-has_rdoc: true
-homepage: http://net-ssh.rubyforge.org/shell
+homepage: http://github.com/mitchellh/net-ssh-shell
 licenses: []
 
 post_install_message: 
-rdoc_options: 
-- --line-numbers
-- --inline-source
-- --title
-- Net-ssh-shell
-- --main
-- README.rdoc
+rdoc_options: []
+
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -76,7 +67,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
+      hash: -9612031956568265
       segments: 
       - 0
       version: "0"
@@ -85,15 +76,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 11
-      segments: 
-      - 1
-      - 2
-      version: "1.2"
+      version: 1.3.6
 requirements: []
 
 rubyforge_project: net-ssh-shell
-rubygems_version: 1.3.7
+rubygems_version: 1.8.5
 signing_key: 
 specification_version: 3
 summary: A simple library to aid with stateful shell interactions

data/CHANGELOG.rdoc

@@ -1,3 +0,0 @@
-=== (unreleased)
-
-* Initial release

data/Manifest

@@ -1,8 +0,0 @@
-CHANGELOG.rdoc
-lib/net/ssh/shell/process.rb
-lib/net/ssh/shell/subshell.rb
-lib/net/ssh/shell/version.rb
-lib/net/ssh/shell.rb
-Rakefile
-README.rdoc
-Manifest