net-ssh-simple 1.4.5 → 1.5.0

data/README.rdoc

@@ -8,6 +8,7 @@ Net::SSH::Simple is a simple wrapper around Net::SSH and Net::SCP.
 * All results are returned as {Net::SSH::Simple::Result}[http://rubydoc.info/gems/net-ssh-simple/Net/SSH/Simple/Result]
 * All errors are raised as {Net::SSH::Simple::Error}[http://rubydoc.info/gems/net-ssh-simple/Net/SSH/Simple/Error]
 * Efficient by default; re-uses transport connections where possible
+* Maintains Keep-Alive to prevent unexpected connection timeouts
 * Lots of documentation
 * {100%}[https://busyloop.net/oss/net-ssh-simple/coverage/] test coverage
 

data/lib/net/ssh/simple/core.rb

@@ -451,6 +451,10 @@ module Net
       #   maximum time before aborting an operation (0 = disable).
       #   you may use this to guard against run-away processes.
       #
+      # @option opts [Integer] :keepalive_interval (60)
+      #   send keep-alive probes at this interval to prevent connections
+      #   from timing out unexpectedly.
+      #
       # @option opts [Integer] :close_timeout (5)
       #  grace-period on close before the connection will be terminated forcefully
       #  (0 = terminate immediately).
@@ -512,7 +516,7 @@ module Net
               block.call(:start, ch, nil) if block
             end
           end
-          wait_for_channel session, channel, @result, opts[:timeout]
+          wait_for_channel session, channel, @result, opts
           @result[:finish_at] = Time.new
           block.call(:finish, channel, nil) if block
           @result
@@ -585,7 +589,7 @@ module Net
 
 
       private
-      EXTRA_OPTS = [:operation_timeout, :close_timeout]
+      EXTRA_OPTS = [:operation_timeout, :close_timeout, :keepalive_interval]
 
       def with_session(host, opts={}, &block)
         opts[:timeout] ||= 60
@@ -593,6 +597,7 @@ module Net
         opts[:operation_timeout] ||= 3600
         opts[:operation_timeout] = 2**32 if opts[:operation_timeout] == 0
         opts[:close_timeout] ||= 5
+        opts[:keepalive_interval] ||= 60
         begin
           net_ssh_opts = opts.reject{|k,v| EXTRA_OPTS.include? k }
           Timeout.timeout(opts[:operation_timeout]) do
@@ -611,11 +616,17 @@ module Net
         end
       end
 
-      def wait_for_channel(session, channel, result, timeout)
+      def wait_for_channel(session, channel, result, opts)
         session.loop(1) do
-          if timeout < Time.now - result[:last_event_at]
+          if opts[:timeout] < Time.now - result[:last_event_at]
             raise Timeout::Error, 'idle timeout'
           end
+
+          # Send keep-alive probes at the configured interval.
+          if opts[:keepalive_interval] < Time.now.to_i - (@result[:last_keepalive_at]||0).to_i
+            session.send_global_request('keep-alive@openssh.com')
+            @result[:last_keepalive_at] = Time.now
+          end
           channel.active?
         end
       end
@@ -635,7 +646,7 @@ module Net
             @result[:last_event_at] = Time.new
             block.call(sent, total) unless block.nil?
           end
-          wait_for_channel session, channel, @result, opts[:timeout]
+          wait_for_channel session, channel, @result, opts
           @result[:finish_at] = Time.new
           @result[:success] = @result[:sent] == @result[:total]
           @result
@@ -669,14 +680,15 @@ module Net
       # @attr [String] host Hostname/IP address
       # @attr [Symbol] op :ssh or :scp
       # @attr [String] cmd Shell command (SSH only)
-      # @attr [Time] start_at Operation start timestamp
-      # @attr [Time] finish_at Operation finish timestamp
+      # @attr [Time] start_at Timestamp of operation start
+      # @attr [Time] finish_at Timestamp of operation finish
+      # @attr [Time] last_keepalive_at Timestamp of last keepalive (if any)
       # @attr [Time] last_event_at Timestamp of last activity
-      # @attr [Boolean] timed_out Set to true if the operation timed out
+      # @attr [Boolean] timed_out True if the operation timed out
       # @attr [String] stdout Output to stdout (SSH only)
       # @attr [String] stderr Output to stderr (SSH only)
       # @attr [boolean] success
-      # @attr [String] exit_code UNIX exit code of the remote command (SSH only)
+      # @attr [String] exit_code UNIX exit code (SSH only)
       # @attr [Integer] total Size of requested file (in bytes, SCP only)
       # @attr [Integer] sent Number of bytes transferred (SCP only)
       # @attr [String] exit_signal

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

@@ -1,7 +1,7 @@
 module Net
   module SSH
     class Simple
-      VERSION = "1.4.5"
+      VERSION = "1.5.0"
     end
   end
 end

data/spec/net-ssh-simple.rb

@@ -45,7 +45,7 @@ describe Net::SSH::Simple do
     it "enforces idle timeout" do
       raised = false
       begin
-        r = Net::SSH::Simple.ssh('localhost', 'sleep 60', {:timeout => 1})
+        r = Net::SSH::Simple.ssh('localhost', 'sleep 60', {:timeout => 5, :keepalive_interval => 1})
       rescue => e
         raised = true
         e.to_s.should match /^idle timeout @ .*/
@@ -126,6 +126,14 @@ describe Net::SSH::Simple do
       Net::SSH::Simple.ssh('localhost', 'true').success.should == true
     end
 
+    it "sends keep-alive" do
+      r = Net::SSH::Simple.ssh('localhost', 'sleep 3', {:keepalive_interval=>1})
+      (Time.now - r.last_keepalive_at).to_i.should < 3
+
+      r = Net::SSH::Simple.ssh('localhost', 'sleep 3', {:keepalive_interval=>5})
+      (Time.now - r.last_keepalive_at).to_i.should > 2
+    end
+
     it "recognizes exit-codes" do
       Net::SSH::Simple.ssh('localhost', 'true').exit_code.should == 0
       Net::SSH::Simple.ssh('localhost', 'false').exit_code.should == 1

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: net-ssh-simple
 version: !ruby/object:Gem::Version
-  version: 1.4.5
+  version: 1.5.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-11-07 00:00:00.000000000Z
+date: 2011-11-25 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: net-ssh
-  requirement: &13039960 !ruby/object:Gem::Requirement
+  requirement: &19079780 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 2.1.4
   type: :runtime
   prerelease: false
-  version_requirements: *13039960
+  version_requirements: *19079780
 - !ruby/object:Gem::Dependency
   name: net-scp
-  requirement: &13039140 !ruby/object:Gem::Requirement
+  requirement: &19079300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 1.0.4
   type: :runtime
   prerelease: false
-  version_requirements: *13039140
+  version_requirements: *19079300
 - !ruby/object:Gem::Dependency
   name: blockenspiel
-  requirement: &13038360 !ruby/object:Gem::Requirement
+  requirement: &19078800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: 0.4.3
   type: :runtime
   prerelease: false
-  version_requirements: *13038360
+  version_requirements: *19078800
 - !ruby/object:Gem::Dependency
   name: hashie
-  requirement: &13037600 !ruby/object:Gem::Requirement
+  requirement: &19078340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: 1.1.0
   type: :runtime
   prerelease: false
-  version_requirements: *13037600
+  version_requirements: *19078340
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &13036620 !ruby/object:Gem::Requirement
+  requirement: &19077840 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,10 +65,10 @@ dependencies:
         version: 0.9.2.2
   type: :development
   prerelease: false
-  version_requirements: *13036620
+  version_requirements: *19077840
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &13036020 !ruby/object:Gem::Requirement
+  requirement: &19077460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *13036020
+  version_requirements: *19077460
 - !ruby/object:Gem::Dependency
   name: cover_me
-  requirement: &13035440 !ruby/object:Gem::Requirement
+  requirement: &19076980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,7 +87,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *13035440
+  version_requirements: *19076980
 description: Net::SSH::Simple is a simple wrapper around Net::SSH and Net::SCP.
 email:
 - moe@busyloop.net
@@ -124,7 +124,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3584124677711427707
+      hash: 2921598519931635186
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.10