ssh-shell 0.4.1

data/.gitignore

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

data/.hound.yml

@@ -0,0 +1,35 @@
+---
+StringLiterals:
+  EnforcedStyle: single_quotes
+  Enabled: true
+
+DotPosition:
+  Description: 'Checks the position of the dot in multi-line method calls.'
+  EnforcedStyle: leading
+  Enabled: true
+
+Documentation:
+  Description: 'Document classes and non-namespace modules.'
+  Enabled: false
+
+Encoding:
+  EnforcedStyle: when_needed
+
+ClassAndModuleChildren:
+  Enabled: false
+
+TrivialAccessors:
+  Enabled: false
+
+LineLength:
+  Description: 'Limit lines to 137 characters.'
+  Max: 120
+
+MethodLength:
+  Description: 'Avoid methods longer than 10 lines of code.'
+  Max: 15
+
+ClassLength:
+  Description: 'Avoid classes longer than 100 lines of code.'
+  CountComments: false  # count full line comments?
+  Max: 137

data/.rubocop.yml

@@ -0,0 +1 @@
+inherit_from: .hound.yml

data/CHANGELOG.md

@@ -0,0 +1,14 @@
+## 0.3.0 (unreleased)
+
+  - Loosen dependency on net-ssh version
+
+## 0.2.0 (June 13, 2011)
+
+  - 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,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in foreplay.gemspec
+gemspec

data/README.md

@@ -0,0 +1,84 @@
+# Net::SSH::Shell
+
+![Gem Version](http://img.shields.io/gem/v/ssh-shell.svg?style=flat) [![Code Climate](http://img.shields.io/codeclimate/github/Xenapto/ssh-shell.svg?style=flat)](https://codeclimate.com/github/Xenapto/ssh-shell)
+[![Developer status](http://img.shields.io/badge/developer-awesome-brightgreen.svg?style=flat)](http://xenapto.com)
+
+## 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:
+
+```ruby
+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 available from RubyGems, so you can install it using the "gem" command:
+
+* gem install net-ssh-shell
+
+If you'd like to build the gem for yourself from source:
+* `git clone http://github.com/Xenapto/ssh-shell.git`
+* `cd 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 @@
+require 'bundler/gem_tasks'

data/lib/net/ssh/shell.rb

@@ -0,0 +1,185 @@
+require 'digest/sha1'
+require 'net/ssh'
+require 'net/ssh/shell/process'
+require 'net/ssh/shell/subshell'
+
+class Net::SSH::Shell
+  attr_reader :session
+  attr_reader :channel
+  attr_reader :state
+  attr_reader :shell
+  attr_reader :processes
+  attr_accessor :default_process_class
+
+  def initialize(session, shell = :default)
+    @session = session
+    @shell = shell
+    @state = :closed
+    @processes = []
+    @when_open = []
+    @on_process_run = nil
+    @default_process_class = Net::SSH::Shell::Process
+    open
+  end
+
+  def open(&callback)
+    if closed?
+      @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
+  end
+
+  def open!
+    unless 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 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
+    run_next_process if processes.length == 1
+    process
+  end
+
+  def subshell(command, &callback)
+    execute(command, Net::SSH::Shell::Subshell, &callback)
+  end
+
+  def execute!(command, &callback)
+    process = execute(command, &callback)
+    wait!
+    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)) unless channel.nil?
+    processes.delete(child)
+    run_next_process
+  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 run_next_process
+    return unless processes.any?
+    process = processes.first
+    @on_process_run.call(self, process) if @on_process_run
+    process.run
+  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
+    fail "could not open channel for process manager (#{description}, ##{code})"
+  end
+
+  def on_exit_status(_channel, data)
+    fail 'the shell exited unexpectedly' unless data.read_long == 0
+  end
+
+  def pty_requested(channel, success)
+    @state = :shell
+    fail '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
+    fail '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)
+    return unless data.include?(separator)
+    @state = :open
+    @when_open.each { |callback| callback.call(self) }
+    @when_open.clear
+  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?
+    shell
+  end
+end

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

@@ -0,0 +1,120 @@
+class Net::SSH::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, properties, callback)
+      @command = command
+      @manager = manager
+      @callback = callback
+      @properties = properties
+      @on_output = nil
+      @on_error_output = nil
+      @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))
+          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")
+        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_error_output(&callback)
+      @on_error_output = callback
+    end
+
+    def on_finish(&callback)
+      @on_finish = callback
+    end
+
+    protected
+
+    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!(Regexp.last_match[1])
+      else
+        output!(data)
+      end
+    end
+
+    def on_stderr(_ch, _type, data)
+      @on_error_output.call(self, data) if @on_error_output
+    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

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

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

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

@@ -0,0 +1,7 @@
+module Net
+  module SSH
+    class Shell
+      VERSION = '0.4.0'
+    end
+  end
+end

data/lib/ssh_shell/version.rb

@@ -0,0 +1,7 @@
+module Net
+  module SSH
+    class Shell
+      VERSION = '0.4.1'
+    end
+  end
+end

data/ssh-shell.gemspec

@@ -0,0 +1,23 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ssh_shell/version'
+
+Gem::Specification.new do |s|
+  s.name          = '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/Xenapto/ssh-shell'
+  s.description   = 'A simple library to aid with stateful shell interactions'
+  s.summary       = 'Updated version based on net-ssh-shell gem'
+  s.license       = 'MIT'
+
+  s.add_runtime_dependency 'net-ssh', '~> 2'
+
+  s.add_development_dependency 'gem-release', '~> 0.7'
+
+  s.files         = `git ls-files`.split("\n")
+  s.executables   = `git ls-files`.split("\n").map { |f| f =~ /^bin\/(.*)/ ? Regexp.last_match[1] : nil }.compact
+  s.require_path  = 'lib'
+end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: ssh-shell
+version: !ruby/object:Gem::Version
+  version: 0.4.1
+  prerelease: 
+platform: ruby
+authors:
+- Jamis Buck
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: net-ssh
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: gem-release
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.7'
+description: A simple library to aid with stateful shell interactions
+email:
+- jamis@jamisbuck.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .hound.yml
+- .rubocop.yml
+- CHANGELOG.md
+- Gemfile
+- README.md
+- 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/ssh_shell/version.rb
+- ssh-shell.gemspec
+homepage: http://github.com/Xenapto/ssh-shell
+licenses:
+- MIT
+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: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.28
+signing_key: 
+specification_version: 3
+summary: Updated version based on net-ssh-shell gem
+test_files: []
+has_rdoc: