net-ssh-simple 1.2.0 → 1.2.1

data/README.rdoc

@@ -33,18 +33,19 @@ Net::SSH::Simple is a simple wrapper around Net::SSH and Net::SCP.
 
  require 'net/ssh/simple'
 
- a = Net::SSH::Simple.async do
-   ssh    'example1.com', 'echo "Hello World."'
-   scp_ul 'example2.com', '/tmp/local_foo', '/tmp/remote_bar'
-   scp_dl 'example3.com', '/tmp/remote_foo', '/tmp/local_bar'
+ t1 = Net::SSH::Simple.async do
+   scp_ul 'example1.com', '/tmp/local_foo', '/tmp/remote_bar'
+   ssh    'example3.com', 'echo "Hello World A."'
  end
- b = Net::SSH::Simple.async do
-   ssh    'example4.com', 'echo "Hello World."'
-   scp_ul 'example5.com', '/tmp/local_foo', '/tmp/remote_bar'
+ t2 = Net::SSH::Simple.async do
    scp_dl 'example6.com', '/tmp/remote_foo', '/tmp/local_bar'
+   ssh    'example7.com', 'echo "Hello World B."'
  end
- a.value # Wait for thread A to finish and capture result
- b.value # Wait for thread B to finish and capture result
+ r1 = t1.value # wait for t1 to finish and grab return value
+ r2 = t2.value # wait for t1 to finish and grab return value
+
+ puts r1.stdout #=> "Hello World A."
+ puts r2.stdout #=> "Hello World B."
 
 === Using an instance
 

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

@@ -15,18 +15,19 @@ module Net
     #
     # @example
     #   # Block Syntax (asynchronous)
-    #   a = Net::SSH::Simple.async do
-    #     ssh    'example1.com', 'echo "Hello World."'
-    #     scp_ul 'example2.com', '/tmp/local_foo', '/tmp/remote_bar'
-    #     scp_dl 'example3.com', '/tmp/remote_foo', '/tmp/local_bar'
+    #   t1 = Net::SSH::Simple.async do
+    #     scp_ul 'example1.com', '/tmp/local_foo', '/tmp/remote_bar'
+    #     ssh    'example3.com', 'echo "Hello World A."'
     #   end
-    #   b = Net::SSH::Simple.async do
-    #     ssh    'example4.com', 'echo "Hello World."'
-    #     scp_ul 'example5.com', '/tmp/local_foo', '/tmp/remote_bar'
+    #   t2 = Net::SSH::Simple.async do
     #     scp_dl 'example6.com', '/tmp/remote_foo', '/tmp/local_bar'
+    #     ssh    'example7.com', 'echo "Hello World B."'
     #   end
-    #   a.value # Wait for thread A to finish and capture result
-    #   b.value # Wait for thread B to finish and capture result
+    #   r1 = t1.value # wait for t1 to finish and grab return value
+    #   r2 = t2.value # wait for t1 to finish and grab return value
+    #
+    #   puts r1.stdout #=> "Hello World A."
+    #   puts r2.stdout #=> "Hello World B."
     #
     # @example
     #   # Using an instance
@@ -53,12 +54,12 @@ module Net
     #         puts "Success! I Helloed World."
     #       end
     #
-    #       scp_ul 'example2.com', '/tmp/local_foo', '/tmp/remote_bar'
+    #       r = scp_ul 'example2.com', '/tmp/local_foo', '/tmp/remote_bar'
     #       if r.success and r.sent == r.total
     #         puts "Success! Uploaded #{r.sent} of #{r.total} bytes."
     #       end
     #
-    #       scp_dl 'example3.com', '/tmp/remote_foo', '/tmp/local_bar'
+    #       r = scp_dl 'example3.com', '/tmp/remote_foo', '/tmp/local_bar'
     #       if r.success and r.sent == r.total
     #         puts "Success! Downloaded #{r.sent} of #{r.total} bytes."
     #       end
@@ -67,29 +68,28 @@ module Net
     #     puts "Something bad happened!"
     #     puts e          # Human readable error
     #     puts e.wrapped  # Original Exception
-    #     puts e.result   # Net::SSH::Simple::Result (partial result)
+    #     puts e.result   # Net::SSH::Simple::Result
     #   end
     #
     # @example
     #   # Error Handling with Block Syntax (asynchronous)
     #   #
-    #   # Exceptions are thrown inside your thread.
+    #   # Exceptions are raised inside your thread.
     #   # You are free to handle them or pass them outwards.
-    #   #
     #
     #   a = Net::SSH::Simple.async do
     #     begin
     #       ssh    'example1.com', 'echo "Hello World."'
     #       scp_ul 'example2.com', '/tmp/local_foo', '/tmp/remote_bar'
     #       scp_dl 'example3.com', '/tmp/remote_foo', '/tmp/local_bar'
-    #     rescue Net::SSH::Result => e
+    #     rescue Net::SSH::Simple::Error => e
     #       # return our exception to the parent thread
     #       e
     #     end
     #   end
     #   r = a.value # Wait for thread to finish and capture result
     #
-    #   unless r.is_a? Net::SSH::Result
+    #   unless r.is_a? Net::SSH::Simple::Result
     #     puts "Something bad happened!"
     #     puts r
     #   end
@@ -122,7 +122,7 @@ module Net
     #   end
     #
     # @example
-    #   # Parametrizing Net::SSH
+    #   # Parameters
     #   Net::SSH::Simple.sync do
     #     ssh('example1.com', 'echo "Hello World."',
     #         {:user => 'tom', :password => 'jerry', :port => 1234})
@@ -590,13 +590,13 @@ module Net
         # Reference to the underlying Exception
         attr_reader :wrapped
 
-        # Context for the operation that failed, as an Array: [host, opts, result].
+        # Context of the operation that failed, as an Array: [host, opts, result].
         #
         # @deprecated
         #   This will be removed soon, use {#result} instead!
         attr_reader :context
 
-        # {Net::SSH::Simple::Result} for the interrupted operation.
+        # {Net::SSH::Simple::Result} of the interrupted operation.
         attr_reader :result
 
         def initialize(msg, e=$!)

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

@@ -1,7 +1,7 @@
 module Net
   module SSH
     class Simple
-      VERSION = "1.2.0"
+      VERSION = "1.2.1"
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: net-ssh-simple
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.2.1
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2011-10-25 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: net-ssh
-  requirement: &7024800 !ruby/object:Gem::Requirement
+  requirement: &17315940 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 2.1.4
   type: :runtime
   prerelease: false
-  version_requirements: *7024800
+  version_requirements: *17315940
 - !ruby/object:Gem::Dependency
   name: net-scp
-  requirement: &7024140 !ruby/object:Gem::Requirement
+  requirement: &17315180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 1.0.4
   type: :runtime
   prerelease: false
-  version_requirements: *7024140
+  version_requirements: *17315180
 - !ruby/object:Gem::Dependency
   name: blockenspiel
-  requirement: &7023480 !ruby/object:Gem::Requirement
+  requirement: &17314420 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: 0.4.3
   type: :runtime
   prerelease: false
-  version_requirements: *7023480
+  version_requirements: *17314420
 - !ruby/object:Gem::Dependency
   name: hashie
-  requirement: &7022900 !ruby/object:Gem::Requirement
+  requirement: &17311140 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: 1.1.0
   type: :runtime
   prerelease: false
-  version_requirements: *7022900
+  version_requirements: *17311140
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &7022240 !ruby/object:Gem::Requirement
+  requirement: &17310360 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,10 +65,10 @@ dependencies:
         version: 0.9.2.2
   type: :development
   prerelease: false
-  version_requirements: *7022240
+  version_requirements: *17310360
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &7021660 !ruby/object:Gem::Requirement
+  requirement: &17309700 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *7021660
+  version_requirements: *17309700
 - !ruby/object:Gem::Dependency
   name: cover_me
-  requirement: &7020960 !ruby/object:Gem::Requirement
+  requirement: &17308880 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,7 +87,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *7020960
+  version_requirements: *17308880
 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: 2238180045890726956
+      hash: -219310430856691553
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.10