vx-lib-shell 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e6ec3c4fb191b7d319d873ecaff749fcafc884f2
+  data.tar.gz: 267c293ac98e6b054d42df08186623bb83536c36
+SHA512:
+  metadata.gz: db0a3405492bbd6c4001730fe31b3680e2bcd03d7a1ea65a692bd965ecfcf000d1b38032930dc296df40caebd7abdb3226c0e91cc299d5d8f298e70dbf082500
+  data.tar.gz: f0d1a8a57a3675dc830a86e3adb2fcd62071968d113ca875cc126c50a85a227b0ba25cda9c8675b32958413d98e58da93e3ef6a27b033b9471b7620e6afbffd7

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--order=rand
+-fd

data/.travis.yml

@@ -0,0 +1,16 @@
+rvm:
+  - 1.9.3
+  - 2.0
+  - 2.1
+before_install:
+  - echo 'travis:travis' | sudo chpasswd
+  - echo 'PasswordAuthentication yes' | sudo tee -a /etc/ssh/sshd_config
+  - sudo service ssh restart
+before_script:
+  - export SSH_USER=travis
+  - export SSH_PASS=travis
+  - export SSH_HOST=localhost
+  - export SSH_PORT=22
+  - env
+  - sudo -u postgres psql -c "select version()"
+script: bundle exec rake SPEC_OPTS='-fd --color --order=rand'

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in vx-common-spawn.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,276 @@
+Copyright (c) 2013 Dmitry Galinsky
+
+The GNU General Public License, Version 2, June 1991 (GPLv2)
+============================================================
+
+> Copyright (C) 1989, 1991 Free Software Foundation, Inc.
+> 59 Temple Place, Suite 330
+> Boston, MA  02111-1307 USA
+
+Everyone is permitted to copy and distribute verbatim copies of this license
+document, but changing it is not allowed.
+
+
+Preamble
+--------
+
+The licenses for most software are designed to take away your freedom to share
+and change it. By contrast, the GNU General Public License is intended to
+guarantee your freedom to share and change free software--to make sure the
+software is free for all its users. This General Public License applies to most
+of the Free Software Foundation's software and to any other program whose
+authors commit to using it. (Some other Free Software Foundation software is
+covered by the GNU Library General Public License instead.) You can apply it to
+your programs, too.
+
+When we speak of free software, we are referring to freedom, not price. Our
+General Public Licenses are designed to make sure that you have the freedom to
+distribute copies of free software (and charge for this service if you wish),
+that you receive source code or can get it if you want it, that you can change
+the software or use pieces of it in new free programs; and that you know you can
+do these things.
+
+To protect your rights, we need to make restrictions that forbid anyone to deny
+you these rights or to ask you to surrender the rights. These restrictions
+translate to certain responsibilities for you if you distribute copies of the
+software, or if you modify it.
+
+For example, if you distribute copies of such a program, whether gratis or for a
+fee, you must give the recipients all the rights that you have. You must make
+sure that they, too, receive or can get the source code. And you must show them
+these terms so they know their rights.
+
+We protect your rights with two steps: (1) copyright the software, and (2) offer
+you this license which gives you legal permission to copy, distribute and/or
+modify the software.
+
+Also, for each author's protection and ours, we want to make certain that
+everyone understands that there is no warranty for this free software. If the
+software is modified by someone else and passed on, we want its recipients to
+know that what they have is not the original, so that any problems introduced by
+others will not reflect on the original authors' reputations.
+
+Finally, any free program is threatened constantly by software patents. We wish
+to avoid the danger that redistributors of a free program will individually
+obtain patent licenses, in effect making the program proprietary. To prevent
+this, we have made it clear that any patent must be licensed for everyone's free
+use or not licensed at all.
+
+The precise terms and conditions for copying, distribution and modification
+follow.
+
+
+Terms And Conditions For Copying, Distribution And Modification
+---------------------------------------------------------------
+0.  This License applies to any program or other work which contains a notice
+    placed by the copyright holder saying it may be distributed under the terms
+    of this General Public License. The "Program", below, refers to any such
+    program or work, and a "work based on the Program" means either the Program
+    or any derivative work under copyright law: that is to say, a work
+    containing the Program or a portion of it, either verbatim or with
+    modifications and/or translated into another language. (Hereinafter,
+    translation is included without limitation in the term "modification".)
+    Each licensee is addressed as "you".
+
+    Activities other than copying, distribution and modification are not
+    covered by this License; they are outside its scope. The act of running the
+    Program is not restricted, and the output from the Program is covered only
+    if its contents constitute a work based on the Program (independent of
+    having been made by running the Program). Whether that is true depends on
+    what the Program does.
+
+1.  You may copy and distribute verbatim copies of the Program's source code as
+    you receive it, in any medium, provided that you conspicuously and
+    appropriately publish on each copy an appropriate copyright notice and
+    disclaimer of warranty; keep intact all the notices that refer to this
+    License and to the absence of any warranty; and give any other recipients
+    of the Program a copy of this License along with the Program.
+
+    You may charge a fee for the physical act of transferring a copy, and you
+    may at your option offer warranty protection in exchange for a fee.
+
+2.  You may modify your copy or copies of the Program or any portion of it,
+    thus forming a work based on the Program, and copy and distribute such
+    modifications or work under the terms of Section 1 above, provided that you
+    also meet all of these conditions:
+
+    a)  You must cause the modified files to carry prominent notices stating
+        that you changed the files and the date of any change.
+
+    b)  You must cause any work that you distribute or publish, that in whole
+        or in part contains or is derived from the Program or any part thereof,
+        to be licensed as a whole at no charge to all third parties under the
+        terms of this License.
+
+    c)  If the modified program normally reads commands interactively when run,
+        you must cause it, when started running for such interactive use in the
+        most ordinary way, to print or display an announcement including an
+        appropriate copyright notice and a notice that there is no warranty (or
+        else, saying that you provide a warranty) and that users may
+        redistribute the program under these conditions, and telling the user
+        how to view a copy of this License. (Exception: if the Program itself
+        is interactive but does not normally print such an announcement, your
+        work based on the Program is not required to print an announcement.)
+
+    These requirements apply to the modified work as a whole. If identifiable
+    sections of that work are not derived from the Program, and can be
+    reasonably considered independent and separate works in themselves, then
+    this License, and its terms, do not apply to those sections when you
+    distribute them as separate works. But when you distribute the same
+    sections as part of a whole which is a work based on the Program, the
+    distribution of the whole must be on the terms of this License, whose
+    permissions for other licensees extend to the entire whole, and thus to
+    each and every part regardless of who wrote it.
+
+    Thus, it is not the intent of this section to claim rights or contest your
+    rights to work written entirely by you; rather, the intent is to exercise
+    the right to control the distribution of derivative or collective works
+    based on the Program.
+
+    In addition, mere aggregation of another work not based on the Program with
+    the Program (or with a work based on the Program) on a volume of a storage
+    or distribution medium does not bring the other work under the scope of
+    this License.
+
+3.  You may copy and distribute the Program (or a work based on it, under
+    Section 2) in object code or executable form under the terms of Sections 1
+    and 2 above provided that you also do one of the following:
+
+    a)  Accompany it with the complete corresponding machine-readable source
+        code, which must be distributed under the terms of Sections 1 and 2
+        above on a medium customarily used for software interchange; or,
+
+    b)  Accompany it with a written offer, valid for at least three years, to
+        give any third party, for a charge no more than your cost of physically
+        performing source distribution, a complete machine-readable copy of the
+        corresponding source code, to be distributed under the terms of
+        Sections 1 and 2 above on a medium customarily used for software
+        interchange; or,
+
+    c)  Accompany it with the information you received as to the offer to
+        distribute corresponding source code. (This alternative is allowed only
+        for noncommercial distribution and only if you received the program in
+        object code or executable form with such an offer, in accord with
+        Subsection b above.)
+
+    The source code for a work means the preferred form of the work for making
+    modifications to it. For an executable work, complete source code means all
+    the source code for all modules it contains, plus any associated interface
+    definition files, plus the scripts used to control compilation and
+    installation of the executable. However, as a special exception, the source
+    code distributed need not include anything that is normally distributed (in
+    either source or binary form) with the major components (compiler, kernel,
+    and so on) of the operating system on which the executable runs, unless
+    that component itself accompanies the executable.
+
+    If distribution of executable or object code is made by offering access to
+    copy from a designated place, then offering equivalent access to copy the
+    source code from the same place counts as distribution of the source code,
+    even though third parties are not compelled to copy the source along with
+    the object code.
+
+4.  You may not copy, modify, sublicense, or distribute the Program except as
+    expressly provided under this License. Any attempt otherwise to copy,
+    modify, sublicense or distribute the Program is void, and will
+    automatically terminate your rights under this License. However, parties
+    who have received copies, or rights, from you under this License will not
+    have their licenses terminated so long as such parties remain in full
+    compliance.
+
+5.  You are not required to accept this License, since you have not signed it.
+    However, nothing else grants you permission to modify or distribute the
+    Program or its derivative works. These actions are prohibited by law if you
+    do not accept this License. Therefore, by modifying or distributing the
+    Program (or any work based on the Program), you indicate your acceptance of
+    this License to do so, and all its terms and conditions for copying,
+    distributing or modifying the Program or works based on it.
+
+6.  Each time you redistribute the Program (or any work based on the Program),
+    the recipient automatically receives a license from the original licensor
+    to copy, distribute or modify the Program subject to these terms and
+    conditions. You may not impose any further restrictions on the recipients'
+    exercise of the rights granted herein. You are not responsible for
+    enforcing compliance by third parties to this License.
+
+7.  If, as a consequence of a court judgment or allegation of patent
+    infringement or for any other reason (not limited to patent issues),
+    conditions are imposed on you (whether by court order, agreement or
+    otherwise) that contradict the conditions of this License, they do not
+    excuse you from the conditions of this License. If you cannot distribute so
+    as to satisfy simultaneously your obligations under this License and any
+    other pertinent obligations, then as a consequence you may not distribute
+    the Program at all. For example, if a patent license would not permit
+    royalty-free redistribution of the Program by all those who receive copies
+    directly or indirectly through you, then the only way you could satisfy
+    both it and this License would be to refrain entirely from distribution of
+    the Program.
+
+    If any portion of this section is held invalid or unenforceable under any
+    particular circumstance, the balance of the section is intended to apply
+    and the section as a whole is intended to apply in other circumstances.
+
+    It is not the purpose of this section to induce you to infringe any patents
+    or other property right claims or to contest validity of any such claims;
+    this section has the sole purpose of protecting the integrity of the free
+    software distribution system, which is implemented by public license
+    practices. Many people have made generous contributions to the wide range
+    of software distributed through that system in reliance on consistent
+    application of that system; it is up to the author/donor to decide if he or
+    she is willing to distribute software through any other system and a
+    licensee cannot impose that choice.
+
+    This section is intended to make thoroughly clear what is believed to be a
+    consequence of the rest of this License.
+
+8.  If the distribution and/or use of the Program is restricted in certain
+    countries either by patents or by copyrighted interfaces, the original
+    copyright holder who places the Program under this License may add an
+    explicit geographical distribution limitation excluding those countries, so
+    that distribution is permitted only in or among countries not thus excluded.
+    In such case, this License incorporates the limitation as if written in
+    the body of this License.
+
+9.  The Free Software Foundation may publish revised and/or new versions of the
+    General Public License from time to time. Such new versions will be similar
+    in spirit to the present version, but may differ in detail to address new
+    problems or concerns.
+
+    Each version is given a distinguishing version number. If the Program
+    specifies a version number of this License which applies to it and "any
+    later version", you have the option of following the terms and conditions
+    either of that version or of any later version published by the Free
+    Software Foundation. If the Program does not specify a version number of
+    this License, you may choose any version ever published by the Free
+    Software Foundation.
+
+10. If you wish to incorporate parts of the Program into other free programs
+    whose distribution conditions are different, write to the author to ask for
+    permission. For software which is copyrighted by the Free Software
+    Foundation, write to the Free Software Foundation; we sometimes make
+    exceptions for this. Our decision will be guided by the two goals of
+    preserving the free status of all derivatives of our free software and of
+    promoting the sharing and reuse of software generally.
+
+
+No Warranty
+-----------
+
+11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR
+    THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
+    OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
+    PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
+    OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+    MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO
+    THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM
+    PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR
+    CORRECTION.
+
+12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL
+    ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE
+    THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
+    GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
+    USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
+    DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
+    PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
+    EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
+    SUCH DAMAGES.

data/README.md

@@ -0,0 +1,77 @@
+# Vx::Lib::Spawn
+
+This gem helps to spawn processes in a shell capturing output in realtime.
+It also allows to set the temeouts.
+
+## Requirements
+
+MRI 1.9.3, 2.0.0, 2.1.x.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'vx-lib-spawn'
+
+And then execute the bundler:
+
+    $ bundle
+
+Or install it via `gem` command:
+
+    $ gem install vx-lib-spawn
+
+## Quick Start
+
+The following snippet demonstrates the usage:
+
+```ruby
+include Vx::Lib::Spawn
+
+spawn "ls -la" do |output|
+  print output
+  # prints directory listing
+end
+
+spawn("echo value", timeout: 10) do |output|
+  print output
+  #  its print "value\n"
+end
+```
+
+```ruby
+# Spawn remote processes example
+
+open_ssh('localhost', 'user') do |ssh|
+  ssh.spawn("ls -la") do |output|
+    print output
+    # prints directory listing
+  end
+
+  spawn("echo value", read_timeout: 10) do |output|
+    print output
+    #  its print "value\n"
+  end
+end
+
+```
+
+### Timeouts
+
+When a timeout is reached spawn raises ```Vx::Lib::Spawn::TimeoutError``` or
+```Vx::Lib::Spawn::ReadTimeoutError```. Both exceptions inherit
+from Timeout::Error
+
+### Return values
+
+Both ```spawn``` methods return process exit code. If a process was terminated by a signal, for example
+KILL or INT, the methods return negative number identical to a signal number (-9 for KILL, etc.)
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/vx/lib/shell.rb

@@ -0,0 +1,47 @@
+require File.expand_path("../shell/version", __FILE__)
+
+module Vx
+  module Lib
+    module Shell
+
+      autoload :Process,          File.expand_path("../shell/process",      __FILE__)
+      autoload :SSH,              File.expand_path("../shell/ssh",          __FILE__)
+      autoload :Docker,           File.expand_path("../shell/docker",       __FILE__)
+      autoload :Timeout,          File.expand_path("../shell/timeout",      __FILE__)
+      autoload :ReadTimeout,      File.expand_path("../shell/read_timeout", __FILE__)
+      autoload :TimeoutError,     File.expand_path("../shell/error",        __FILE__)
+      autoload :ReadTimeoutError, File.expand_path("../shell/error",        __FILE__)
+
+      class << self
+        @@pool_interval = 1.0
+
+        def pool_interval
+          @@pool_interval
+        end
+
+        def pool_interval=(val)
+          @@pool_interval = val
+        end
+      end
+
+      def open_ssh(*args, &block)
+        Lib::Shell::SSH.open(*args, &block)
+      end
+
+      def sh(*args)
+        case args.first
+        when :ssh
+          args.shift
+          Shell::SSH.new(*args)
+        else
+          Shell::Process.new
+        end
+      end
+
+      def spawn(*args, &block)
+        Lib::Shell::Process.spawn(*args, &block)
+      end
+
+    end
+  end
+end

data/lib/vx/lib/shell/error.rb

@@ -0,0 +1,34 @@
+require 'timeout'
+
+module Vx
+  module Lib
+    module Shell
+
+      class TimeoutError < ::Timeout::Error
+
+        def initialize(cmd, seconds)
+          @cmd = cmd
+          @seconds = seconds
+        end
+
+        def to_s
+          "Execution expired, command did not finish within #{@seconds} seconds"
+        end
+
+      end
+
+      class ReadTimeoutError < ::Timeout::Error
+
+        def initialize(cmd, seconds)
+          @cmd = cmd
+          @seconds = seconds
+        end
+
+        def to_s
+          "No output has been received in the last #{@seconds} seconds"
+        end
+      end
+
+    end
+  end
+end

data/lib/vx/lib/shell/process.rb

@@ -0,0 +1,107 @@
+require 'timeout'
+require 'pty'
+require 'shellwords'
+require 'io/console'
+
+module Vx
+  module Lib
+    module Shell
+      class Process
+
+        def exec(*args, &block)
+          options        = args.last.is_a?(Hash) ? args.pop : {}
+          command        = args.first
+
+          select_timeout = options.delete(:pool_interval) || Shell.pool_interval
+          timeout        = Shell::Timeout.new options.delete(:timeout)
+          read_timeout   = Shell::ReadTimeout.new options.delete(:read_timeout)
+
+          if command
+            command = "/bin/bash -l -c #{Shellwords.escape command}"
+          else
+            command = "/bin/bash -l"
+          end
+
+          status = spawn_command_internal(command, options) do |r|
+            read_loop r, timeout, read_timeout, select_timeout, &block
+          end
+
+          compute_exit_code command, status, timeout, read_timeout
+        end
+
+        private
+
+          def request_pipes(options)
+            m,s   = PTY.open
+            r1,w1 = IO.pipe
+
+            s.raw! # disable newline conversion.
+            m.sync = true
+            s.sync = true
+
+            [m, s, r1, w1]
+          end
+
+          def spawn_command_internal(command, options)
+            r1, w1, r2, w2 = request_pipes(options)
+
+            pid = ::Process.spawn(command, in: r2, out: w1, err: w1)
+
+            begin
+              if i = options[:stdin]
+                IO.copy_stream i, w2
+              end
+              w2.close
+              w1.close
+
+              yield r1
+            rescue Errno::EIO
+            end
+
+            ::Process.kill 'KILL', pid
+            _, status = ::Process.wait2(pid)
+
+            r1.close
+            r2.close
+
+            status
+          end
+
+          def compute_exit_code(command, status, timeout, read_timeout)
+            case
+            when read_timeout.happened?
+              raise Shell::ReadTimeoutError.new command, read_timeout.value
+            when timeout.happened?
+              raise Shell::TimeoutError.new command, timeout.value
+            else
+              termsig   = status && status.termsig
+              exit_code = status && status.exitstatus
+              exit_code || (termsig && termsig * -1) || -1
+            end
+          end
+
+          def read_loop(reader, timeout, read_timeout, interval, &block)
+            read_timeout.reset
+
+            loop do
+              break if timeout.happened?
+
+              rs, _, _ = IO.select([reader], nil, nil, interval)
+
+              if rs
+                break if rs[0].eof?
+                re = rs[0].readpartial(8192)
+                if block_given?
+                  yield re
+                end
+                read_timeout.reset
+              else
+                break if read_timeout.happened?
+              end
+            end
+          end
+
+      end
+    end
+  end
+end

data/lib/vx/lib/shell/read_timeout.rb

@@ -0,0 +1,30 @@
+module Vx
+  module Lib
+    module Shell
+      class ReadTimeout
+
+        def initialize(val)
+          @value    = val.to_f > 0 ? val.to_f : nil
+          @happened = false
+          @tm       = nil
+        end
+
+        def reset
+          @tm = Time.new if @value
+        end
+
+        def happened?
+          return true if @happened
+          return false unless @tm
+
+          @happened = Time.now > (@tm + @value)
+        end
+
+        def value
+          @value
+        end
+
+      end
+    end
+  end
+end

data/lib/vx/lib/shell/ssh.rb

@@ -0,0 +1,112 @@
+require 'net/ssh'
+require 'timeout'
+require 'shellwords'
+
+module Vx
+  module Lib
+    module Shell
+      class SSH
+
+        attr_reader :host, :user, :options, :connection
+
+        def initialize(ssh)
+          @connection = ssh
+        end
+
+        def exec(*args, &block)
+          options       = args.last.is_a?(Hash) ? args.pop : {}
+          command       = args.first
+
+          exit_code     = nil
+          timeout       = Shell::Timeout.new options.delete(:timeout)
+          read_timeout  = Shell::ReadTimeout.new options.delete(:read_timeout)
+
+          if command
+            command = "/bin/bash -l -c #{Shellwords.escape command}"
+          else
+            command = "/bin/bash -l"
+          end
+
+          channel = spawn_channel command, read_timeout, options, &block
+
+          channel.on_request("exit-status") do |_,data|
+            exit_code = data.read_long
+          end
+
+          channel.on_request("exit-signal") do |_,data|
+            exit_code = data.read_long * -1
+          end
+
+          pool channel, timeout, read_timeout
+
+          compute_exit_code command, exit_code, timeout, read_timeout
+        end
+
+        private
+
+          def request_pty(channel, options)
+            channel.request_pty term: "ansi" do |_, pty_status|
+              raise StandardError, "could not obtain pty (ssh.channel.request_pty)" unless pty_status
+              yield if block_given?
+            end
+          end
+
+          def pool(channel, timeout, read_timeout)
+            @connection.loop Shell.pool_interval do
+              if read_timeout.happened? || timeout.happened?
+                false
+              else
+                channel.active?
+              end
+            end
+          end
+
+          def compute_exit_code(command, exit_code, timeout, read_timeout)
+            case
+            when read_timeout.happened?
+              raise Shell::ReadTimeoutError.new command, read_timeout.value
+            when timeout.happened?
+              raise Shell::TimeoutError.new command, timeout.value
+            else
+              exit_code || -1 # nil exit_code means that the process is killed
+            end
+          end
+
+          def spawn_channel(command, read_timeout, options, &block)
+            @connection.open_channel do |channel|
+
+              request_pty channel, options do
+
+                read_timeout.reset
+
+                channel.exec command do |_, success|
+
+                  unless success
+                    raise StandardError, "FAILED: couldn't execute command (ssh.channel.exec)"
+                  end
+
+                  if i = options[:stdin]
+                    channel.send_data i.read
+                    channel.eof!
+                  end
+
+                  channel.on_data do |_, data|
+                    yield data if block_given?
+                    read_timeout.reset
+                  end
+
+                  channel.on_extended_data do |_, _, data|
+                    yield data if block_given?
+                    read_timeout.reset
+                  end
+
+                end
+              end
+            end
+
+          end
+
+      end
+    end
+  end
+end

data/lib/vx/lib/shell/timeout.rb

@@ -0,0 +1,26 @@
+module Vx
+  module Lib
+    module Shell
+      class Timeout
+        def initialize(value)
+          @value = (value.to_f > 0) ? value.to_f : nil
+          if @value
+            @time_end = Time.now + @value
+          end
+          @happened = false
+        end
+
+        def happened?
+          return false unless @value
+          return true if @happened
+
+          @happened = Time.now > @time_end
+        end
+
+        def value
+          @value
+        end
+      end
+    end
+  end
+end

data/lib/vx/lib/shell/version.rb

@@ -0,0 +1,7 @@
+module Vx
+  module Lib
+    module Shell
+      VERSION = "0.1.0"
+    end
+  end
+end

data/spec/lib/process_spec.rb

@@ -0,0 +1,99 @@
+require 'spec_helper'
+require 'timeout'
+
+describe Vx::Lib::Shell::Process do
+  let(:collected) { "" }
+  let(:user)      { ENV['USER'] }
+  let(:pty)       { true }
+
+  subject { collected }
+
+  it "run command successfuly" do
+    code = run "echo $USER", pty: pty
+    expect(subject.strip).to eq "#{user}"
+    expect(code).to eq 0
+  end
+
+  it "run command with error" do
+    code = run "false", pty: pty
+    expect(subject).to eq ""
+    expect(code).to eq 1
+  end
+
+  context "timeout" do
+    it 'run command with timeout' do
+      expect {
+        run("echo $USER && sleep 0.5", timeout: 0.2, pty: pty)
+      }.to raise_error(::Vx::Lib::Shell::TimeoutError)
+      expect(subject.strip).to eq "#{user}"
+    end
+
+    it 'run command with timeout successfuly' do
+      code = run("echo BAR && sleep 0.1", timeout: 0.5, pty: pty)
+      expect(subject.strip).to eq "BAR"
+      expect(code).to eq 0
+    end
+  end
+
+  context "read_timeout" do
+    it 'run command with read timeout' do
+      expect{
+        run('sleep 0.5', read_timeout: 0.2, pty: pty)
+      }.to raise_error(Vx::Lib::Shell::ReadTimeoutError)
+      expect(collected).to eq ""
+    end
+
+    it 'run command with read timeout in loop' do
+      expect{
+        run('sleep 0.1 ; echo $USER ; sleep 0.5', read_timeout: 0.3, pty: pty)
+      }.to raise_error(Vx::Lib::Shell::ReadTimeoutError)
+      expect(collected.strip).to eq "#{user}"
+    end
+
+    it 'run command with read timeout successfuly' do
+      code = run('echo $USER; sleep 0.1', read_timeout: 0.5, pty: pty)
+      expect(collected.strip).to eq "#{user}"
+      expect(code).to eq 0
+    end
+
+    it 'run command with read timeout in loop successfuly' do
+      code = run('sleep 0.3 ; echo $USER; sleep 0.3 ; echo $USER', read_timeout: 0.5, pty: pty)
+      expect(collected).to eq "#{user}\n#{user}\n"
+      expect(code).to eq 0
+    end
+  end
+
+  it 'run and kill process' do
+    code = run( "echo $USER; kill -KILL $$", pty: pty)
+    expect(subject).to eq "#{user}\n"
+    expect(code).to eq(-9)
+  end
+
+  it 'run and interupt process' do
+    code = run( "echo $USER; kill -INT $$", pty: pty)
+    expect(subject).to eq "#{user}\n"
+    expect(code).to eq(-2)
+  end
+
+  it "should copy stdin" do
+    io = StringIO.new("echo foo ; exit")
+    code = run(stdin: io)
+    expect(subject).to eq "foo\n"
+    expect(code).to eq 0
+  end
+
+  def run(*args, &block)
+    @proxy ||= ShellTest.new
+    timeout do
+      @proxy.sh.exec(*args) do |out|
+        collected << out
+      end
+    end
+  end
+
+  def timeout
+    Timeout.timeout(3) do
+      yield
+    end
+  end
+end

data/spec/lib/read_timeout_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+describe Vx::Lib::Shell::ReadTimeout do
+  subject { described_class.new 0.2 }
+
+  it "just created" do
+    expect(subject.value).to eq 0.2
+    expect(subject).to_not be_happened
+  end
+
+  it "should be work" do
+    subject.reset
+    sleep 0.1
+    expect(subject).to_not be_happened
+
+    subject.reset
+    sleep 0.3
+    expect(subject).to be_happened
+  end
+
+  it "do nothing unless value" do
+    expect(subject).to_not be_happened
+  end
+
+  it "do nothing unless timeout" do
+    subject.reset
+    sleep 0.1
+    expect(subject).to_not be_happened
+  end
+end

data/spec/lib/ssh_spec.rb

@@ -0,0 +1,119 @@
+require 'spec_helper'
+require 'timeout'
+require 'net/ssh'
+
+describe Vx::Lib::Shell::SSH, ssh: true do
+
+  let(:user) { ENV['SSH_USER'] || 'vagrant' }
+  let(:host) { ENV['SSH_HOST'] || 'localhost' }
+  let(:pass) { ENV['SSH_PASS'] || 'vagrant' }
+  let(:port) { ENV['SSH_PORT'] || 2222 }
+  let(:collected) { '' }
+
+  def conn
+    @conn ||=
+      Net::SSH.start(
+        host, user, {
+          password: pass,
+          port:     port,
+          verbose:  2
+        }
+      )
+  end
+
+  it "run command successfuly with pty" do
+    code = run_ssh 'env'
+    expect(collected).to match(/SSH_TTY=/)
+    expect(code).to eq 0
+  end
+
+  it "run command with error" do
+    code = run_ssh 'false'
+    expect(collected).to eq ""
+    expect(code).to eq 1
+  end
+
+  context "timeout" do
+    it 'run command with timeout' do
+      expect{
+        run_ssh('echo $USER; sleep 0.5', timeout: 0.2)
+      }.to raise_error(Vx::Lib::Shell::TimeoutError)
+    end
+
+    it 'run command with timeout successfuly' do
+      code = run_ssh('echo $USER; sleep 0.2', timeout: 1)
+      expect(collected).to eq "#{user}\r\n"
+      expect(code).to eq 0
+    end
+  end
+
+  context "read_timeout" do
+    it 'run command with read timeout' do
+      expect{
+        run_ssh('sleep 0.5', read_timeout: 0.2)
+      }.to raise_error(Vx::Lib::Shell::ReadTimeoutError)
+      expect(collected).to eq ""
+    end
+
+    it 'run command with read timeout in loop' do
+      expect{
+        run_ssh('sleep 0.1 ; echo $USER ; sleep 0.5', read_timeout: 0.3)
+      }.to raise_error(Vx::Lib::Shell::ReadTimeoutError)
+      expect(collected).to eq "#{user}\r\n"
+    end
+
+    it 'run command with read timeout successfuly' do
+      code = run_ssh('echo $USER; sleep 0.1', read_timeout: 0.5)
+      expect(collected).to eq "#{user}\r\n"
+      expect(code).to eq 0
+    end
+
+    it 'run command with read timeout in loop successfuly' do
+      code = run_ssh('sleep 0.3 ; echo $USER; sleep 0.3 ; echo $USER', read_timeout: 0.5)
+      expect(collected).to eq "#{user}\r\n#{user}\r\n"
+      expect(code).to eq 0
+    end
+  end
+
+  it 'run and kill process' do
+    code = run_ssh("echo $USER; kill -9 $$")
+    expect(collected).to eq "#{user}\r\n"
+    expect(code).to eq(-4)
+  end
+
+  it 'run and interupt process' do
+    code = run_ssh("echo $USER; kill -9 $$")
+    expect(collected).to eq "#{user}\r\n"
+    expect(code).to eq(-4)
+  end
+
+  it "should copy stdin" do
+    io = StringIO.new("echo foo ; exit\n")
+    code = run_ssh(stdin: io)
+    expect(collected).to match "foo\r\n"
+    expect(code).to eq 0
+  end
+
+  def open_ssh(&block)
+    described_class.open(host, user, password: pass, paranoid: false, verbose: 2, port: port, &block)
+  end
+
+  def re(s)
+    Regexp.escape s
+  end
+
+  def run_ssh(*args)
+    @proxy ||= ShellTest.new
+    timeout do
+      @proxy.sh(:ssh, conn).exec(*args) do |out|
+        collected << out
+      end
+    end
+  end
+
+  def timeout
+    Timeout.timeout(3) do
+      yield
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+require File.expand_path('../../lib/vx/lib/shell', __FILE__)
+
+class ShellTest
+  include Vx::Lib::Shell
+end
+
+RSpec.configure do |c|
+  unless ENV['USE_DOCKER']
+    c.filter_run_excluding docker: true
+  end
+end
+

data/vx-lib-shell.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'vx/lib/shell/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "vx-lib-shell"
+  spec.version       = Vx::Lib::Shell::VERSION
+  spec.authors       = ["Dmitry Galinsky"]
+  spec.email         = ["dima@vexor.io"]
+  spec.description   = %q{ Spawn processes in a shell capturing output in realtime. It also allows to set the temeouts. }
+  spec.summary       = %q{ This gem helps to spawn processes in a shell capturing output in realtime. It also allows to set the temeouts. }
+  spec.homepage      = "https://github.com/vexor/vx-lib-shell"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency     "net-ssh", "= 2.9.1"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "pry"
+end

metadata

@@ -0,0 +1,139 @@
+--- !ruby/object:Gem::Specification
+name: vx-lib-shell
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Dmitry Galinsky
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: net-ssh
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.9.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.9.1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: " Spawn processes in a shell capturing output in realtime. It also allows
+  to set the temeouts. "
+email:
+- dima@vexor.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/vx/lib/shell.rb
+- lib/vx/lib/shell/error.rb
+- lib/vx/lib/shell/process.rb
+- lib/vx/lib/shell/read_timeout.rb
+- lib/vx/lib/shell/ssh.rb
+- lib/vx/lib/shell/timeout.rb
+- lib/vx/lib/shell/version.rb
+- spec/lib/process_spec.rb
+- spec/lib/read_timeout_spec.rb
+- spec/lib/ssh_spec.rb
+- spec/spec_helper.rb
+- vx-lib-shell.gemspec
+homepage: https://github.com/vexor/vx-lib-shell
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: This gem helps to spawn processes in a shell capturing output in realtime.
+  It also allows to set the temeouts.
+test_files:
+- spec/lib/process_spec.rb
+- spec/lib/read_timeout_spec.rb
+- spec/lib/ssh_spec.rb
+- spec/spec_helper.rb