niftp 1.0.3 → 2.0.0

data/README.md

@@ -39,8 +39,16 @@ 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
-  exception, before raising the exception (Default: 1).
+* **tries**: The number of times to try the given FTP commands upon any
+  exception, before raising the exception (Default: 2, meaning it will *retry
+  once* upon any exception).
+* **sleep**: The number of seconds to sleep in between tries (default: 1).
+* **on**: An array of errors to limit when the code block is retried
+  (default: StandardError).  See the
+  [retryable](https://github.com/nfedyashev/retryable) gem for usage details
+* **matching**: An exception message regex to limit when the code block is
+  retried (default: /.*/).  See the
+  [retryable](https://github.com/nfedyashev/retryable) gem for usage details
 * **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:
@@ -48,10 +56,9 @@ forced timeouts. FTP Secure (FTPS) is also supported.
 
 ## 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.
+  Setting the :tries option to 0 will raise a runtime error, otherwise the
+  codeblock would never execute.
+
 
 ## Testing
 

data/Rakefile

@@ -17,7 +17,7 @@ Rake::RDocTask.new do |rdoc|
   version = File.exist?('VERSION') ? File.read('VERSION') : ""
 
   rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "service_helpers #{version}"
+  rdoc.title = "NiFTP #{version}"
   rdoc.rdoc_files.include('README*')
   rdoc.rdoc_files.include('lib/**/*.rb')
 end

data/lib/niftp.rb

@@ -14,10 +14,12 @@ module NiFTP
   # See the README for available options and examples.
   def ftp(host, options = {}, &block)
     options.reverse_merge!(:username => "", :password => "", :port => 21,
-                           :ftps => false, :retries => 1, :timeout => 5,
-                           :passive => true)
-    raise "The :retries option must be > 0." if options[:retries] < 1
-    retryable(:tries => options[:retries]) do
+                           :ftps => false, :tries => 2, :sleep => 1,
+                           :on => StandardError, :matching => /.*/,
+                           :timeout => 5, :passive => true)
+    raise "The :tries option must be > 0." if options[:tries] < 1
+    retryable(:tries => options[:tries], :sleep => options[:sleep],
+    :on => options[:on], :matching => options[:matching]) do
       ftp = options[:ftps] ? Net::FTPFXPTLS.new : Net::FTP.new
       ftp.passive = options[:passive]
       begin
@@ -34,4 +36,4 @@ module NiFTP
 end
 
 # Alias for those that prefer a conventional module name.
-Niftp = NiFTP
+Niftp = NiFTP

data/lib/niftp/version.rb

@@ -1,3 +1,3 @@
 module NiFTP
-  VERSION = "1.0.3"
+  VERSION = "2.0.0"
 end

data/niftp.gemspec

@@ -28,7 +28,7 @@ Gem::Specification.new do |s|
 
   # Dependencies
   s.add_dependency "ftpfxp",    ">= 0.0.4"
-  s.add_dependency "retryable", ">= 1.2"
+  s.add_dependency "retryable", ">= 1.3"
   s.add_dependency "activesupport", ">= 2.0"
   s.add_dependency "i18n", ">= 0.5"
   s.add_development_dependency "shoulda", ">= 2.11"

data/test/niftp_test.rb

@@ -14,8 +14,8 @@ class NiFTPTest < Test::Unit::TestCase
       assert_equal Niftp, NiFTP
     end
 
-    should "raise a runtime errors if the :retries option is less than 1" do
-      assert_raise(RuntimeError) { @object.ftp(@host, { :retries => 0 }) }
+    should "raise a runtime errors if the :tries option is less than 1" do
+      assert_raise(RuntimeError) { @object.ftp(@host, { :tries => 0 }) }
     end
 
     should "connect to the FTP server with the default port" do
@@ -63,25 +63,25 @@ class NiFTPTest < Test::Unit::TestCase
       @object.ftp(@host)
     end
 
-    should "retry once (by default) when an exception is raised" do
-      Net::FTP.expects(:new).once.returns(@ftp)
-      assert_raise(RuntimeError) do
-        @object.ftp(@host) { |ftp_client| raise "testing retryable gem"}
-      end
+    should "use the retryable defauls when they're not explicitly set" do
+      Net::FTP.stubs(:new => @ftp)
+      @object.expects(:retryable).with(:tries => 2, :sleep => 1,
+        :on => StandardError, :matching => /.*/)
+      @object.ftp(@host) { }
     end
 
-    should "use the :retries option instead of the default" do
-      Net::FTP.expects(:new).times(2).returns(@ftp)
+    should "use the :tries option instead of the default" do
+      Net::FTP.expects(:new).times(3).returns(@ftp)
       assert_raise(RuntimeError) do
-        @object.ftp(@host, {:retries => 2 }) do |ftp_client|
+        @object.ftp(@host, {:tries => 3 }) do |ftp_client|
           raise "testing retryable gem"
         end
       end
     end
 
     should "close the FTP connection when there is an exception" do
-      Net::FTP.expects(:new).once.returns(@ftp)
-      @ftp.expects(:close).times(1)
+      Net::FTP.expects(:new).times(2).returns(@ftp)
+      @ftp.expects(:close).times(2)
       assert_raise(RuntimeError) do
         @object.ftp(@host) { |ftp_client| raise "testing close"}
       end

metadata

@@ -1,116 +1,112 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: niftp
-version: !ruby/object:Gem::Version 
+version: !ruby/object:Gem::Version
+  version: 2.0.0
   prerelease: 
-  version: 1.0.3
 platform: ruby
-authors: 
+authors:
 - Christopher R. Murphy
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-05-21 00:00:00 -04:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-07-12 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: ftpfxp
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &2157248480 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 0.0.4
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: retryable
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *2157248480
+- !ruby/object:Gem::Dependency
+  name: retryable
+  requirement: &2157247860 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "1.2"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '1.3'
   type: :runtime
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: activesupport
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: *2157247860
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &2157247280 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "2.0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '2.0'
   type: :runtime
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: i18n
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: *2157247280
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: &2157246680 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0.5"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0.5'
   type: :runtime
-  version_requirements: *id004
-- !ruby/object:Gem::Dependency 
-  name: shoulda
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  version_requirements: *2157246680
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: &2157246120 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "2.11"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '2.11'
   type: :development
-  version_requirements: *id005
-- !ruby/object:Gem::Dependency 
-  name: mocha
   prerelease: false
-  requirement: &id006 !ruby/object:Gem::Requirement 
+  version_requirements: *2157246120
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: &2157245600 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0.9"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0.9'
   type: :development
-  version_requirements: *id006
-- !ruby/object:Gem::Dependency 
-  name: xml-simple
   prerelease: false
-  requirement: &id007 !ruby/object:Gem::Requirement 
+  version_requirements: *2157245600
+- !ruby/object:Gem::Dependency
+  name: xml-simple
+  requirement: &2157245080 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "1.0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '1.0'
   type: :development
-  version_requirements: *id007
-- !ruby/object:Gem::Dependency 
-  name: rake
   prerelease: false
-  requirement: &id008 !ruby/object:Gem::Requirement 
+  version_requirements: *2157245080
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &2157244500 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0.8"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0.8'
   type: :development
-  version_requirements: *id008
+  prerelease: false
+  version_requirements: *2157244500
 description: NiFTP makes Ruby's decidedly un-nifty Net::FTP library easier to use.
-email: 
+email:
 - chmurph2+git@gmail.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - README.md
-files: 
+files:
 - .gitignore
 - Gemfile
 - MIT-LICENSE
@@ -121,34 +117,31 @@ files:
 - niftp.gemspec
 - test/niftp_test.rb
 - test/test_helper.rb
-has_rdoc: true
 homepage: https://github.com/chmurph2/NiFTP
 licenses: []
-
 post_install_message: 
-rdoc_options: 
+rdoc_options:
 - --include=examples --main README.md
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: niftp
-rubygems_version: 1.6.2
+rubygems_version: 1.8.17
 signing_key: 
 specification_version: 3
 summary: NiFTP makes Ruby's decidedly un-nifty Net::FTP library easier to use.
-test_files: 
+test_files:
 - test/niftp_test.rb
 - test/test_helper.rb