niftp 1.0.1 → 1.0.2

data/README.md

@@ -3,15 +3,25 @@ use. It abstracts away the FTP plumbing, such as establishing and closing
 connections. Options include retrying your commands on flakey FTP servers, and
 forced timeouts. FTP Secure (FTPS) is also supported.
 
-## Examples  
-                 
-    # get a file with no username, password or other options
-    ftp("localhost") { |ftp| ftp.get("some_file.txt") }
+## Usage
 
-    # put a file to an FTP Secure (FTPS) server
-    ftp("localhost", { username: "anonymous", password: "FTP_FTL", ftps: true }) do |ftp|
-      ftp.put("some_file.txt")
-    end  
+    # Mixin the +NiFTP+ module, which provides the +ftp+ method.
+    class SomeObject
+      include NiFTP
+
+      def ftp_stuff
+        # put a file using no username, password or other options
+        ftp("localhost") { |client| client.put("some_file.txt") }
+
+        # get a file on an FTP Secure (FTPS) server
+        ftp("ftp.secure.com", { username: "some_user", password: "FTP_FTL",
+                                 ftps: true }) do |client|
+          client.resume = true
+          file = client.get("some_file.txt")
+          # ...
+        end
+      end
+    end
 
 ## Options
 
@@ -19,20 +29,20 @@ forced timeouts. FTP Secure (FTPS) is also supported.
 * **password**: The password, if required by the host (default: "").
 * **port**: The port for the host (default: 21).
 * **ftps**: Set to true if connecting to a FTP Secure server (default: false).
-* **retries**: The number of times to re-try the given FTP commands upon any 
+* **retries**: The number of times to re-try the given FTP commands upon any
   exception, before raising the exception (Default: 1).
-* **timeout**: The number of seconds to wait before timing out (default: 5). 
+* **timeout**: The number of seconds to wait before timing out (default: 5).
   Use 0 to disable the timeout.
 * **passive**: Set to false to prevent a connection in passive mode (default:
   true).
-    
+
 ## Caveats
 
   Based on the way the [retryable]("https://github.com/nfedyashev/retryable")
   gem works, any FTP commands will be retried at least once upon any
   exception. Setting the :retries option to 0 will raise a runtime error.  I'm
   fine with this for now as I prefer this behavior.
-  
+
 ## Testing
 
 Tests are written with Shoulda and Mocha. This gem is tested in Ruby 1.8.7

data/lib/niftp/version.rb

@@ -1,3 +1,3 @@
 module NiFTP
-  VERSION = "1.0.1"
+  VERSION = "1.0.2"
 end

metadata

@@ -2,7 +2,7 @@
 name: niftp
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors: 
 - Christopher R. Murphy
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-18 00:00:00 -04:00
+date: 2011-05-19 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency