net-ssh-shell 0.1.0

data/CHANGELOG.rdoc

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

data/Manifest

@@ -0,0 +1,8 @@
+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

data/README.rdoc

@@ -0,0 +1,79 @@
+= Net::SSH::Shell
+
+== DESCRIPTION:
+
+Net::SSH::Shell is a library for interacting with stateful (e.g., interactive) shells on remote hosts. It hides (or tries to hide) the potentially complex Net::SSH state machines you'd otherwise need to write to interact with "su" and similar shells.
+
+One of the significant benefits you get from this library versus using Net::SSH directly is that your shell is _stateful_. With Net::SSH, if you invoke "cd /" in one exec call, and "pwd" in another, the two are done in different shells so the directory change in the first has no effect on the working directory of the second. With Net::SSH::Shell, though, commands are all invoked via the _same_ shell, so changes in directory or additions to the environment all affect subsequent commands.
+
+== FEATURES:
+
+* Interact with login shells
+* Support for "subshell" environments, like "su" or "sudo bash"
+
+== SYNOPSIS:
+
+In a nutshell:
+
+  require 'net/ssh'
+  require 'net/ssh/shell'
+
+  Net::SSH::start('host', 'user') do |ssh|
+    ssh.shell do |sh|
+      sh.execute "cd /usr/local"
+      sh.execute "pwd"
+      sh.execute "export FOO=bar"
+      sh.execute "echo $FOO"
+      p=sh.execute "grep dont /tmp/notexist"
+      puts "Exit Status:#{p.exit_status}"
+      puts "Command Executed:#{p.command}"
+    end
+  end
+
+See Net::SSH::Shell for more documentation.
+
+== REQUIREMENTS:
+
+* net-ssh (version 2)
+
+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
+
+* 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:
+* git clone http://github.com/jedi4ever/net-ssh-shell.git
+* cd net-ssh-shell
+* gem install echoe
+* rake gem
+* gem install pkg/net-ssh-shell-0.1.0.gem (might need sudo privileges)
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2009 Jamis Buck <jamis@37signals.com>
+
+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,28 @@
+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

data/lib/net/ssh/shell.rb

@@ -0,0 +1,160 @@
+require 'digest/sha1'
+require 'net/ssh'
+require 'net/ssh/shell/process'
+require 'net/ssh/shell/subshell'
+
+module Net
+  module SSH
+    class Shell
+      attr_reader :session
+      attr_reader :channel
+      attr_reader :state
+      attr_reader :shell
+      attr_reader :processes
+
+      def initialize(session, shell=:default)
+        @session = session
+        @shell = shell
+        @state = :closed
+        @processes = []
+        @when_open = []
+        open
+      end
+
+      def open(&callback)
+        if closed?
+          @state = :opening
+          @channel = session.open_channel(&method(:open_succeeded))
+          @channel.on_open_failed(&method(:open_failed))
+        end
+        when_open(&callback) if callback
+        self
+      end
+
+      def open!
+        if !open?
+          open if closed?
+          session.loop { opening? }
+        end
+        self
+      end
+
+      def when_open(&callback)
+        if open?
+          yield self
+        else
+          @when_open << callback
+        end
+        self
+      end
+
+      def open?
+        state == :open
+      end
+
+      def closed?
+        state == :closed
+      end
+
+      def opening?
+        !open? && !closed?
+      end
+
+      def execute(command, klass=Net::SSH::Shell::Process, &callback)
+        process = klass.new(self, command, callback)
+        process.run if processes.empty?
+        processes << process
+        return process
+      end
+
+      def subshell(command, &callback)
+        execute(command, Net::SSH::Shell::Subshell, &callback)
+      end
+
+      def execute!(command, &callback)
+        execute(command, &callback)
+        wait!
+	return process
+      end
+
+      def busy?
+        opening? || processes.any?
+      end
+
+      def wait!
+        session.loop { busy? }
+      end
+
+      def close!
+        channel.close if channel
+      end
+
+      def child_finished(child)
+        channel.on_close(&method(:on_channel_close)) if !channel.nil?
+        processes.delete(child)
+        processes.first.run if processes.any?
+      end
+
+      def separator
+        @separator ||= begin
+          s = Digest::SHA1.hexdigest([session.object_id, object_id, Time.now.to_i, Time.now.usec, rand(0xFFFFFFFF)].join(":"))
+          s << Digest::SHA1.hexdigest(s)
+        end
+      end
+
+      def on_channel_close(channel)
+        @state = :closed
+        @channel = nil
+      end
+
+      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))
+        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
+        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
+        end
+    end
+  end
+end
+
+class Net::SSH::Connection::Session
+  # Provides a convenient way to initialize a shell given a Net::SSH
+  # session. Yields the new shell if a block is given. Returns the shell
+  # instance.
+  def shell(*args)
+    shell = Net::SSH::Shell.new(self, *args)
+    yield shell if block_given?
+    return shell
+  end
+end

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

@@ -0,0 +1,112 @@
+module Net; module SSH; class Shell
+
+  class Process
+    attr_reader :state
+    attr_reader :command
+    attr_reader :manager
+    attr_reader :callback
+    attr_reader :exit_status
+    attr_reader :properties
+
+    def initialize(manager, command, callback)
+      @command = command
+      @manager = manager
+      @callback = callback
+      @properties = {}
+      @on_output = Proc.new { |p, data| print(data) }
+      @on_finish = nil
+      @state = :new
+    end
+
+    def [](key)
+      @properties[key]
+    end
+
+    def []=(key, value)
+      @properties[key] = value
+    end
+
+    def send_data(data)
+      manager.channel.send_data(data)
+    end
+
+    def run
+      if state == :new
+        state = :starting
+        manager.open do
+          state = :running
+          manager.channel.on_data(&method(:on_stdout))
+          @master_onclose = manager.channel.on_close(&method(:on_close))
+
+          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
+
+      self
+    end
+
+    def starting?
+      state == :starting
+    end
+
+    def running?
+      state == :running
+    end
+
+    def finished?
+      state == :finished
+    end
+
+    def busy?
+      starting? || running?
+    end
+
+    def wait!
+      manager.session.loop { busy? }
+      self
+    end
+
+    def on_output(&callback)
+      @on_output = callback
+    end
+
+    def on_finish(&callback)
+      @on_finish = callback
+    end
+
+    private
+
+      def output!(data)
+        return unless @on_output
+        @on_output.call(self, 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 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

@@ -0,0 +1,23 @@
+require 'net/ssh/shell/process'
+
+module Net; module SSH; class Shell
+
+  class Subshell < Process
+    private
+
+      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
+      end
+  end
+
+end; end; end

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

@@ -0,0 +1,22 @@
+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
+  end
+end; end; end
+

data/net-ssh-shell.gemspec

@@ -0,0 +1,33 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{net-ssh-shell}
+  s.version = "0.1.0"
+
+  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}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    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
+end

metadata

@@ -0,0 +1,101 @@
+--- !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
+platform: ruby
+authors: 
+- Jamis Buck
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-10-25 00:00:00 +04:00
+default_executable: 
+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
+  type: :runtime
+  version_requirements: *id001
+description: A simple library to aid with stateful shell interactions
+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
+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
+has_rdoc: true
+homepage: http://net-ssh.rubyforge.org/shell
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Net-ssh-shell
+- --main
+- README.rdoc
+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: 11
+      segments: 
+      - 1
+      - 2
+      version: "1.2"
+requirements: []
+
+rubyforge_project: net-ssh-shell
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: A simple library to aid with stateful shell interactions
+test_files: []
+