net-ssh-session 0.1.4 → 0.1.5

data/.travis.yml

@@ -3,6 +3,7 @@ rvm:
   - 1.8.7
   - 1.9.2
   - 1.9.3
+  - 2.0.0
   - ruby-head
   - jruby-18mode
-  - jruby-19mode
+  - jruby-19mode

data/Gemfile

@@ -1,2 +1,2 @@
-source :rubygems
-gemspec
+source 'https://rubygems.org'
+gemspec

data/LICENSE

@@ -1,7 +1,18 @@
 Copyright (c) 2012-2013 Dan Sosedoff.
 
-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:
+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 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.
+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/README.md

@@ -118,6 +118,8 @@ session.run_multiple(commands, :break => true)
 To get each command result after execution, you can supply a block:
 
 ```ruby
+commands = ["mkdir /tmp", "echo test > /tmp/file", "rm -rf /tmp"]
+
 session.run_multiple(commands) do |cmd|
   puts "Original command: #{cmd.command}"
   puts "Exit code: #{cmd.exit_code}"
@@ -174,12 +176,23 @@ s.run("bundler install --path .")
 s.close
 ```
 
-You can also disable histroy for the whole session:
+You can also disable history for the whole session:
 
 ```ruby
 Net::SSH::Session.new(host, user, password, :history => false)
 ```
 
+## Execute any command with timeout
+
+To enable session-wide command execution timeout, pass an extra option:
+
+```ruby
+session = Net::SSH::Session.new(host, user, password, :timeout => 10)
+```
+
+This will limit any command execution time to 10 seconds. Error `Timeout::Error`
+will be raised when timeout is exceeded.
+
 ## Credits
 
 Library code was extracted and modified from multiple sources:
@@ -188,4 +201,8 @@ Library code was extracted and modified from multiple sources:
 - Mitchell Hashimoto (@mitchellh)
 - Michael Klishin (@michaelklishin)
 - Sven Fuchs (@svenfuchs)
-- Travis-CI (@travis-ci)
+- Travis-CI (@travis-ci)
+
+## License
+
+See LICENSE file for details

data/lib/net-ssh-session/version.rb

@@ -1,7 +1,7 @@
 module Net
   module SSH
     class Session
-      VERSION = '0.1.4'
+      VERSION = '0.1.5'
     end
   end
 end

data/lib/net/ssh/session.rb

@@ -14,6 +14,7 @@ module Net
       attr_reader :options
       attr_reader :logger
       attr_reader :history
+      attr_reader :timeout
 
       # Initialize a new ssh session
       # @param [String] remote hostname or ip address
@@ -26,10 +27,15 @@ module Net
         @password      = password
         @history       = []
         @track_history = true
+        @timeout       = options[:timeout]
 
         if options[:history] == false
           @track_history = false
         end
+
+        if @timeout && !@timeout.kind_of?(Integer)
+          raise ArgumentError, "Timeout value should be numeric"
+        end
       end
 
       # Establish connection with remote server
@@ -59,12 +65,17 @@ module Net
       # @return [Integer] command execution exit code
       def exec(command, &on_output)
         status = nil
-        shell.execute(command) do |process|
-          process.on_output(&on_output)
-          process.on_error_output(&on_output)
-          process.on_finish { |p| status = p.exit_status }
+
+        handle_timeout do
+          shell.execute(command) do |process|
+            process.on_output(&on_output)
+            process.on_error_output(&on_output)
+            process.on_finish { |p| status = p.exit_status }
+          end
+
+          shell.session.loop(1) { status.nil? }
         end
-        shell.session.loop(1) { status.nil? }
+
         status
       end
 
@@ -133,6 +144,9 @@ module Net
         history.last
       end
 
+      # Execute a dynamic command
+      # @param [String] command name
+      # @params [Array] command arguments
       def method_missing(name, *args)
         run("#{name} #{args.join(' ')}".strip)
       end
@@ -143,6 +157,14 @@ module Net
         @connection = Net::SSH.start(host, user, :password => password)
         @shell = @connection.shell
       end
+
+      def handle_timeout(&block)
+        if timeout
+          Timeout.timeout(timeout) { block.call(self) }
+        else
+          block.call(self)
+        end
+      end
     end
   end
 end

data/net-ssh-session.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |s|
   s.email       = ["dan.sosedoff@gmail.com"]
   
   s.add_development_dependency 'rake'
-  s.add_development_dependency 'rspec',     '~> 2.11'
+  s.add_development_dependency 'rspec',     '~> 2.13'
   s.add_development_dependency 'simplecov', '~> 0.4'
 
   s.add_dependency 'net-ssh', '~> 2.6'
@@ -19,4 +19,4 @@ Gem::Specification.new do |s|
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{|f| File.basename(f)}
   s.require_paths = ["lib"]
-end
+end

data/spec/session_spec.rb

@@ -1,12 +1,47 @@
 require 'spec_helper'
 
 describe Net::SSH::Session do
+  describe '#initialize' do
+    context 'with :timeout option' do
+      it 'raises error if timeout value is not numeric' do
+        expect {
+          Net::SSH::Session.new('host', 'user', 'password', :timeout => 'data')
+        }.to raise_error ArgumentError, "Timeout value should be numeric"
+      end
+
+      it 'sets global session timeout value' do
+        session = Net::SSH::Session.new('host', 'user', 'password', :timeout => 1)
+        expect(session.timeout).to eq 1
+      end
+    end
+  end 
+
   describe '#method_missing' do
     let(:session) { Net::SSH::Session.new('host', 'user', 'password') }
+    before { session.stub(:run).with("uname").and_return(fake_run("uname", "Linux")) }
 
     it 'runs a command based on missing method name' do
-      session.stub(:run).with("uname").and_return(fake_run("uname", "Linux"))
-      session.uname.output.should eq("Linux")
+      expect(session.uname.output).to eq "Linux"
+    end
+  end
+
+  describe '#run' do
+    context 'when session timeout is set' do
+      let(:process) do
+        proc { sleep 5 }
+      end
+
+      let(:session) do
+        Net::SSH::Session.new('host', 'user', 'password', :timeout => 1)
+      end
+
+      before do
+        session.stub_chain(:shell, :execute).with('foo') { process.call }
+      end
+
+      it 'raises error if operation timed out' do
+        expect { session.run('foo') }.to raise_error Timeout::Error
+      end
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: net-ssh-session
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-11 00:00:00.000000000 Z
+date: 2013-04-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -34,7 +34,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '2.11'
+        version: '2.13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -42,7 +42,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '2.11'
+        version: '2.13'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -123,7 +123,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: Shell session for Net::SSH connections
@@ -133,4 +133,3 @@ test_files:
 - spec/session_helpers_spec.rb
 - spec/session_spec.rb
 - spec/spec_helper.rb
-has_rdoc: