net-ssh-simple 0.9.0 → 1.0.0

data/README.rdoc

@@ -2,6 +2,15 @@
 
 Net::SSH::Simple is a simple wrapper around Net::SSH and Net::SCP.
 
+== Features
+
+* Friendly, flexible API for SSH and SCP (synchronous and asynchronous)
+* 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
+* Lots of documentation
+* 100% test coverage
+
 == Installation
 
  gem install net-ssh-simple
@@ -9,6 +18,7 @@ Net::SSH::Simple is a simple wrapper around Net::SSH and Net::SCP.
 == Examples
 
 === Block Syntax (synchronous)
+
  Net::SSH::Simple.sync do
    r = ssh 'example1.com', 'echo "Hello World."'
    puts r.stdout #=> "Hello World."
@@ -18,6 +28,7 @@ Net::SSH::Simple is a simple wrapper around Net::SSH and Net::SCP.
  end
 
 === 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'
@@ -42,3 +53,25 @@ Net::SSH::Simple is a simple wrapper around Net::SSH and Net::SCP.
 
 See {Net::SSH::Simple}[http://rubydoc.info/gems/net-ssh-simple/Net/SSH/Simple] for more examples and full API.
 
+== License (MIT)
+
+Copyright (C) 2011 by moe@busyloop.net
+
+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 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/lib/net/ssh/simple/core.rb

@@ -139,7 +139,7 @@ module Net
       include Blockenspiel::DSL
 
       #
-      # Result of a Net::SSH::Simple::Operation.
+      # Result of the current Net::SSH::Simple::Operation.
       #
       # @return [Net::SSH::Simple::Result] Result of the current operation
       attr_reader :result
@@ -205,6 +205,7 @@ module Net
       # @param (see Net::SSH::Simple#scp_dl)
       # @raise [Net::SSH::Simple::Error]
       # @return [Net::SSH::Simple::Result] Result
+      #
       def self.scp_dl(*args, &block)
         s = self.new
         r = s.scp_dl(*args, &block)
@@ -469,8 +470,7 @@ module Net
       end
 
       #
-      # Encapsulates any Errors that may occur
-      # during a Net::SSH::Simple operation.
+      # Error that occured during a Net::SSH::Simple operation.
       #
       class Error < RuntimeError
         # Reference to the underlying Net::SSH Exception
@@ -492,8 +492,18 @@ module Net
       #
       # Result of a Net::SSH::Simple operation.
       #
-      # This Mash contains various information that may
-      # be relevant to your interests.
+      # @attr [String] host Hostname/IP address
+      # @attr [String] cmd Shell command (SSH only)
+      # @attr [Time] start_at Operation start timestamp
+      # @attr [Time] finish_at Operation finish timestamp
+      # @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 [Integer] total Size of requested file (in bytes, SCP only)
+      # @attr [Integer] sent Number of bytes transferred (SCP only)
+      # @attr [String] exit_signal
+      #   Only present if the remote command terminates due to a signal (SSH only)
       #
       class Result < Hashie::Mash; end
     end

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

@@ -1,7 +1,7 @@
 module Net
   module SSH
     class Simple
-      VERSION = "0.9.0"
+      VERSION = "1.0.0"
     end
   end
 end

metadata

@@ -3,10 +3,10 @@ name: net-ssh-simple
 version: !ruby/object:Gem::Version 
   prerelease: false
   segments: 
+  - 1
   - 0
-  - 9
   - 0
-  version: 0.9.0
+  version: 1.0.0
 platform: ruby
 authors: 
 - Moe
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-10-22 00:00:00 +02:00
+date: 2011-10-23 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -149,7 +149,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 1030525555759223160
+      hash: -2521828447030537518
       segments: 
       - 0
       version: "0"
@@ -158,7 +158,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 1030525555759223160
+      hash: -2521828447030537518
       segments: 
       - 0
       version: "0"