net-ssh-simple 1.5.3 → 1.5.4

data/README.rdoc

@@ -25,6 +25,10 @@ synchronously or asynchronously.
 
 == Examples
 
+Note: If you are reading this on github then {click here}[http://rubydoc.info/gems/net-ssh-simple/file/README.rdoc] for a more readable
+version with syntax highlighting.
+
+
 === Block Syntax (synchronous)
 
  require 'net/ssh/simple'
@@ -65,6 +69,70 @@ synchronously or asynchronously.
  s.scp_dl 'example3.com', '/tmp/remote_foo', '/tmp/local_bar'
  s.close
 
+== Thread safety
+
+Do _not_ share a Net::SSH::Simple instance across threads.
+
+That's the only rule to watch out for. Other than that you're
+free to use Net::SSH::Simple concurrently in different Threads.
+
+If you want to use the instance syntax in a threaded environment
+then the following idiom will provide the best performance:
+
+ require 'net/ssh/simple'
+ 
+ # Create and re-use one instance per thread, with a default username.
+ def ss
+   Thread.current[:simplessh] ||= Net::SSH::Simple.new({:user => 'bob'})
+ end
+
+ # Strictly optional. You may use this method to close the
+ # SSH connections early. Otherwise our instance will tear
+ # down automatically when the enclosing thread finishes.
+ def ss_close
+   ss.close
+   Thread.current[:simplessh] = nil
+ end
+
+ # By sharing the same Net::SSH::Simple instance across calls
+ # to this method our ssh transport connections get re-used
+ # when the same remote host is accessed multiple times.
+ def do_something_involving_ssh
+   # The connections to example1-5.com are re-used across
+   # multiple calls to this method.
+   ss.ssh    'example1.com', 'echo "Hello World."', {:user => 'not_bob'}
+   ss.scp_ul 'example2.com', '/tmp/local_foo', '/tmp/remote_bar'
+   ss.scp_dl 'example3.com', '/tmp/remote_foo', '/tmp/local_bar'
+
+   t = ss.async do
+     scp_ul 'example4.com', '/tmp/local_foo', '/tmp/remote_bar'
+   end
+
+   ss.sync do
+     scp_ul 'example5.com', '/tmp/local_foo', '/tmp/remote_bar'
+   end
+
+   # wait for our async call to finish
+   t.value
+
+   # Below we explicitly do _not_ use the shared instance
+   # because we want these connections to close immediately
+   # after the block finishes. This is useful when you know
+   # that some hosts will be connected to only once during
+   # the lifetime of a thread (there's no point in keeping
+   # these open).
+   Net::SSH::Simple.sync do
+     # opens connections to example8.com, example9.com
+     ssh 'example8.com', 'echo "Hello World."'
+     ssh 'example9.com', 'echo "Hello World."'
+
+     # connections are reused
+     ssh 'example8.com', 'echo "World Hello."'
+     ssh 'example9.com', 'echo "World Hello."'
+
+     # both connections close at the end of this block
+   end
+ end
 
 == Documentation
 

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

@@ -1,7 +1,7 @@
 module Net
   module SSH
     class Simple
-      VERSION = "1.5.3"
+      VERSION = "1.5.4"
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: net-ssh-simple
 version: !ruby/object:Gem::Version
-  version: 1.5.3
+  version: 1.5.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-03 00:00:00.000000000Z
+date: 2012-04-14 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: net-ssh
-  requirement: &18901260 !ruby/object:Gem::Requirement
+  requirement: &17323340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 2.2.1
   type: :runtime
   prerelease: false
-  version_requirements: *18901260
+  version_requirements: *17323340
 - !ruby/object:Gem::Dependency
   name: net-scp
-  requirement: &18900420 !ruby/object:Gem::Requirement
+  requirement: &17322560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 1.0.4
   type: :runtime
   prerelease: false
-  version_requirements: *18900420
+  version_requirements: *17322560
 - !ruby/object:Gem::Dependency
   name: blockenspiel
-  requirement: &18899400 !ruby/object:Gem::Requirement
+  requirement: &17321620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: 0.4.3
   type: :runtime
   prerelease: false
-  version_requirements: *18899400
+  version_requirements: *17321620
 - !ruby/object:Gem::Dependency
   name: hashie
-  requirement: &18896720 !ruby/object:Gem::Requirement
+  requirement: &17320880 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: 1.1.0
   type: :runtime
   prerelease: false
-  version_requirements: *18896720
+  version_requirements: *17320880
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &18895020 !ruby/object:Gem::Requirement
+  requirement: &17317060 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,10 +65,10 @@ dependencies:
         version: 0.9.2.2
   type: :development
   prerelease: false
-  version_requirements: *18895020
+  version_requirements: *17317060
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &18893060 !ruby/object:Gem::Requirement
+  requirement: &17316460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *18893060
+  version_requirements: *17316460
 - !ruby/object:Gem::Dependency
   name: cover_me
-  requirement: &18892280 !ruby/object:Gem::Requirement
+  requirement: &17315240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,7 +87,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *18892280
+  version_requirements: *17315240
 description: Net::SSH::Simple is a simple wrapper around Net::SSH and Net::SCP.
 email:
 - moe@busyloop.net
@@ -123,7 +123,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2495961166063881363
+      hash: -4150931459409160842
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.10