niftp 2.0.1 → 2.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4ecdd6f91f41ec89d5f2f51e87d06aa829999a0b
+  data.tar.gz: def6a841b38631985ea3e1dd5203a034f55f822f
+SHA512:
+  metadata.gz: 8661c3de51ddb34af10bb16982ef174c6d34a5d9a75f5717e4f47ab308733de1b3acef4359af4287c36043c64ee64c1b84e81f7be0d3aa2cb36b72f33431705a
+  data.tar.gz: aa51e846a3efae363e2e458193609d4701a6c192ef1b6351a6ed2f44beb9f54116a99000eaccdd75ac7b6034351c5c87cd5c8c428b0c160d2f8b76a149b41885

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - "1.9.3"
+  - "2.0.0"
+  - "2.1.0"
+  - "2.2.0"
+  - jruby-19mode # JRuby in 1.9 mode

data/CONTRIBUTING.md

@@ -0,0 +1,30 @@
+Pull requests are very welcome. Please follow these guidelines (modeled after
+thoughtbot's):
+
+1. Fork the repo.
+
+1. Run the tests.  All changes made to the code have passing tests: `bundle && rake`
+
+1. Add a test for your change/fix. Only refactoring and documentation changes
+require no new tests.
+
+1. Push to your fork and submit a pull request.
+
+I will respond as quickly as possible and may suggest some changes,
+improvements or alternatives.  Some things that will increase the chance that
+your pull request is accepted, taken straight from the Ruby on Rails guide:
+
+* Use Rails idioms and helpers
+* Include tests that fail without your code, and pass with it
+* Update the documentation, the surrounding one or whatever is affected by
+your contribution
+
+Syntax:
+
+* Follow the conventions you see used in the source already.
+* [No trailing whitespace](http://blogobaggins.com/2009/03/31/waging-war-on-whitespace.html).
+Blank lines should not have any space.
+* Two spaces, no tabs.
+* Prefer &&/|| over and/or.
+* MyClass.my_method(my_arg) not my_method( my_arg ) or my_method my_arg.
+* a = b and not a=b.

data/Guardfile

@@ -0,0 +1,7 @@
+group :ruby do
+  guard :minitest, all_on_start: false do
+    watch(%r{^test/.+_test\.rb$})
+    watch('test/test_helper.rb') { "test" }
+    watch(%r{^lib/(.+)\.rb$})    { |m| "test/#{m[1]}_test.rb" }
+  end
+end

data/README.md

@@ -3,6 +3,9 @@ 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.
 
+[![Code Climate](https://codeclimate.com/github/chmurph2/NiFTP.png)](https://codeclimate.com/github/chmurph2/NiFTP)
+[![Build Status](https://travis-ci.org/chmurph2/NiFTP.png)](https://travis-ci.org/chmurph2/NiFTP)
+
 ## Usage
     # Without NiFTP:
     begin
@@ -18,6 +21,7 @@ forced timeouts. FTP Secure (FTPS) is also supported.
     # A more concrete example:
 
     # Mixin the +NiFTP+ module, which provides the +ftp+ method.
+    require 'niftp'
     class SomeObject
       include NiFTP
 
@@ -49,8 +53,8 @@ forced timeouts. FTP Secure (FTPS) is also supported.
 * **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.
+* **timeout**: The number of seconds to wait before timing out authentication
+  (default: 30). Use 0 to disable the authentication timeout.
 * **passive**: Set to false to prevent a connection in passive mode (default:
   true).
 
@@ -62,5 +66,4 @@ forced timeouts. FTP Secure (FTPS) is also supported.
 
 ## Testing
 
-Tests are written with Shoulda and Mocha. This gem is tested in Ruby 1.8.7
-(REE) and 1.9.2.
+Tests are written using minitest-spec and Mocha.

data/Rakefile

@@ -1,6 +1,5 @@
 require 'bundler'
 require 'rake/testtask'
-require 'rake/rdoctask'
 
 desc 'Default: run unit tests.'
 task :default => :test
@@ -11,13 +10,4 @@ Rake::TestTask.new(:test) do |test|
   test.libs << 'lib' << 'test'
   test.pattern = 'test/**/*_test.rb'
   test.verbose = true
-end
-
-Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
-
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "NiFTP #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
 end

data/lib/niftp.rb

@@ -2,7 +2,6 @@ require "net/ftp"
 require "ftpfxp"
 require "retryable"
 require "timeout"
-require "active_support/core_ext"
 
 # Abstracts away File Transfer Protocol plumbing, such as establishing and
 # closing connections.
@@ -13,26 +12,57 @@ module NiFTP
   #
   # See the README for available options and examples.
   def ftp(host, options = {}, &block)
-    options.reverse_merge!(
-      :username => "", :password => "", :port => 21, :ftps => false,
-      :passive => true, :timeout => 30.seconds, :tries => 2, :sleep => 1.second,
-      :on => StandardError,  :matching => /.*/)
+    options = default_options.merge(options)
     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]
+    Retryable.retryable(retryable_options(options)) do
+      ftp = instantiate_ftp_per_options(options)
       begin
-        Timeout::timeout(options[:timeout]) do
-          ftp.connect host, options[:port]
-          ftp.login options[:username], options[:password]
-        end
-        yield ftp if ftp.present? && block_given?
+        login_with_timeout(ftp, host, options)
+        yield ftp if ftp && block_given?
       ensure
-        ftp.try(:close)
+        ftp.close if ftp
       end
     end
   end
+
+  private
+
+  def login_with_timeout(ftp, host, options)
+    Timeout::timeout(options[:timeout]) do
+      ftp.connect host, options[:port]
+      ftp.login options[:username], options[:password]
+    end
+  end
+
+  def instantiate_ftp_per_options(options)
+    (options[:ftps] ? Net::FTPFXPTLS.new : Net::FTP.new).tap do |ftp|
+      ftp.passive = options[:passive]
+    end
+  end
+
+  def default_options
+    {
+      :username => "",
+      :password => "",
+      :port     => 21,
+      :ftps     => false,
+      :passive  => true,
+      :timeout  => 30, # seconds
+      :tries    => 2,
+      :sleep    => 1,  # second
+      :on       => StandardError,
+      :matching => /.*/
+    }
+  end
+
+  def retryable_options(options)
+    {
+      :tries    => options[:tries],
+      :sleep    => options[:sleep],
+      :on       => options[:on],
+      :matching => options[:matching]
+    }
+  end
 end
 
 # Alias for those that prefer a conventional module name.

data/lib/niftp/version.rb

@@ -1,3 +1,3 @@
 module NiFTP
-  VERSION = "2.0.1"
+  VERSION = "2.1.0"
 end

data/niftp.gemspec

@@ -12,6 +12,7 @@ Gem::Specification.new do |s|
   s.summary     = %q{NiFTP makes Ruby's decidedly un-nifty Net::FTP library
     easier to use.}
   s.description = s.summary
+  s.license     = "MIT"
 
   s.rubyforge_project = "niftp"
 
@@ -27,12 +28,12 @@ Gem::Specification.new do |s|
   s.extra_rdoc_files = ["README.md"] + Dir.glob("doc/*")
 
   # Dependencies
-  s.add_dependency "ftpfxp",    ">= 0.0.4"
-  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"
-  s.add_development_dependency "mocha", ">= 0.9"
-  s.add_development_dependency "xml-simple", ">= 1.0"
-  s.add_development_dependency "rake", ">= 0.8"
+  s.add_dependency "ftpfxp",                     ">= 0.0.4"
+  s.add_dependency "retryable",                  ">= 2.0"
+  s.add_dependency "i18n",                       ">= 0.5"
+  s.add_development_dependency "minitest",       "~> 4.7"
+  s.add_development_dependency "guard",          "~> 1.8.3"
+  s.add_development_dependency "guard-minitest", "~> 1.0.1"
+  s.add_development_dependency "mocha",          "~> 0.14"
+  s.add_development_dependency "rake"
 end

data/test/niftp_test.rb

@@ -1,113 +1,113 @@
 require "test_helper"
 require File.expand_path('../../lib/niftp', __FILE__)
 
-class NiFTPTest < Test::Unit::TestCase
-  context "An object mixing in the NiFTP module" do
-    setup do
-      @object = Object.new.extend NiFTP
-      @options = {}
-      @host = "localhost"
-      @ftp = stub_everything
-    end
+module NiFTP
+  class NiFTPTest < TestCase
+    describe "An object mixing in the NiFTP module" do
 
-    should "be accessible via the Niftp shortcut" do
-      assert_equal Niftp, NiFTP
-    end
+      let(:object) { Object.new.extend NiFTP }
+      let(:host)   { "localhost" }
+      let(:ftp)    { stub_everything }
 
-    should "raise a runtime errors if the :tries option is less than 1" do
-      assert_raise(RuntimeError) { @object.ftp(@host, { :tries => 0 }) }
-    end
+      it "must be accessible via the Niftp shortcut" do
+        Niftp.must_equal NiFTP
+      end
 
-    should "connect to the FTP server with the default port" do
-      stub_ftp
-      @ftp.expects(:connect).with(@host, 21).once.returns(stub_everything)
-      @object.ftp(@host)
-    end
+      it "must raise a runtime errors if the :tries option is less than 1" do
+        assert_raises(RuntimeError) { object.ftp(host, { :tries => 0 }) }
+      end
 
-    should "connect to the FTP server with the optional port" do
-      stub_ftp
-      @ftp.expects(:connect).with(@host, 2121).once.returns(stub_everything)
-      @object.ftp(@host, { :port => 2121 })
-    end
+      it "must connect to the FTP server with the default port" do
+        stub_ftp
+        ftp.expects(:connect).with(host, 21).once.returns(stub_everything)
+        object.ftp(host)
+      end
 
-    should "login to the FTP server with the default username and password" do
-      stub_ftp
-      @ftp.expects(:login).with("", "")
-      @object.ftp(@host)
-    end
+      it "must connect to the FTP server with the optional port" do
+        stub_ftp
+        ftp.expects(:connect).with(host, 2121).once.returns(stub_everything)
+        object.ftp(host, { :port => 2121 })
+      end
 
-    should "login to the FTP server with the optional username" do
-      stub_ftp
-      @ftp.expects(:login).with("anonymous", "")
-      @object.ftp(@host, { :username => "anonymous" })
-    end
+      it "must login to the FTP server with the default username and password" do
+        stub_ftp
+        ftp.expects(:login).with("", "")
+        object.ftp(host)
+      end
 
-    should "login to the FTP server with the optional password" do
-      stub_ftp
-      @ftp.expects(:login).with("", "some password")
-      @object.ftp(@host, { :password => "some password" })
-    end
+      it "must login to the FTP server with the optional username" do
+        stub_ftp
+        ftp.expects(:login).with("anonymous", "")
+        object.ftp(host, { :username => "anonymous" })
+      end
 
-    should "execute any arbitrary FTP code (i.e. the block)" do
-      stub_ftp
-      block_output = nil
-      @object.ftp(@host) do |ftp|
-        block_output = "block was executed"
+      it "must login to the FTP server with the optional password" do
+        stub_ftp
+        ftp.expects(:login).with("", "some password")
+        object.ftp(host, { :password => "some password" })
       end
-      assert_equal "block was executed", block_output
-    end
 
-    should "close the FTP connection" do
-      stub_ftp
-      @ftp.expects(:close).once
-      @object.ftp(@host)
-    end
+      it "must execute any arbitrary FTP code (i.e. the block)" do
+        stub_ftp
+        block_output = nil
+        object.ftp(host) do |ftp|
+          block_output = "block was executed"
+        end
+        "block was executed".must_equal block_output
+      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
+      it "must close the FTP connection" do
+        stub_ftp
+        ftp.expects(:close).once
+        object.ftp(host)
+      end
 
-    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, {:tries => 3 }) do |ftp_client|
-          raise "testing retryable gem"
+      it "must use the retryable defauls when they're not explicitly set" do
+        Net::FTP.stubs(:new => ftp)
+        Retryable.expects(:retryable).with(:tries => 2, :sleep => 1,
+          :on => StandardError, :matching => /.*/)
+        object.ftp(host) { }
+      end
+
+      it "must use the :tries option instead of the default" do
+        Net::FTP.expects(:new).times(3).returns(ftp)
+        assert_raises(RuntimeError) do
+          object.ftp(host, {:tries => 3 }) do |ftp_client|
+            raise "testing retryable gem"
+          end
         end
       end
-    end
 
-    should "close the FTP connection when there is an exception" do
-      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"}
+      it "must close the FTP connection when there is an exception" do
+        Net::FTP.expects(:new).times(2).returns(ftp)
+        ftp.expects(:close).times(2)
+        assert_raises(RuntimeError) do
+          object.ftp(host) { |ftp_client| raise "testing close"}
+        end
       end
-    end
 
-    should "use a five second (default) timeout when connecting" do
-      stub_ftp
-      Timeout.expects(:timeout).with(30)
-      @object.ftp(@host)
-    end
+      it "must use a 30 second (default) timeout when connecting" do
+        stub_ftp
+        Timeout.expects(:timeout).with(30)
+        object.ftp(host)
+      end
 
-    should "use the :timeout option instead of the default" do
-      stub_ftp
-      Timeout.expects(:timeout).with(1)
-      @object.ftp(@host, { :timeout => 1 })
-    end
+      it "must use the :timeout option instead of the default" do
+        stub_ftp
+        Timeout.expects(:timeout).with(1)
+        object.ftp(host, { :timeout => 1 })
+      end
 
-    should "use the FTPFXP (FTPS) library when instructed" do
-      Net::FTPFXPTLS.expects(:new).once.returns(@ftp)
-      @object.ftp(@host, options = { :ftps => true })
+      it "must use the FTPFXP (FTPS) library when instructed" do
+        Net::FTPFXPTLS.expects(:new).once.returns(ftp)
+        object.ftp(host, { :ftps => true })
+      end
     end
-  end
 
-  private
+    private
 
-  def stub_ftp
-    Net::FTP.stubs(:new => @ftp)
+    def stub_ftp
+      Net::FTP.stubs(:new => ftp)
+    end
   end
-end
+end

data/test/test_helper.rb

@@ -1,7 +1,8 @@
-require 'rubygems'
-require 'test/unit'
-require 'shoulda'
-require 'mocha'
+require "minitest/autorun"
+require "minitest/pride"
+require 'mocha/setup'
 
-class Test::Unit::TestCase
+module NiFTP
+  class TestCase < Minitest::Spec
+  end
 end

metadata

@@ -1,104 +1,127 @@
 --- !ruby/object:Gem::Specification
 name: niftp
 version: !ruby/object:Gem::Version
-  version: 2.0.1
-  prerelease: 
+  version: 2.1.0
 platform: ruby
 authors:
 - Christopher R. Murphy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-05 00:00:00.000000000Z
+date: 2015-05-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ftpfxp
-  requirement: &2160535080 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.0.4
   type: :runtime
   prerelease: false
-  version_requirements: *2160535080
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.4
 - !ruby/object:Gem::Dependency
   name: retryable
-  requirement: &2160533960 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '2.0'
   type: :runtime
   prerelease: false
-  version_requirements: *2160533960
-- !ruby/object:Gem::Dependency
-  name: activesupport
-  requirement: &2160532840 !ruby/object:Gem::Requirement
-    none: false
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: *2160532840
 - !ruby/object:Gem::Dependency
   name: i18n
-  requirement: &2160531900 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0.5'
   type: :runtime
   prerelease: false
-  version_requirements: *2160531900
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.5'
 - !ruby/object:Gem::Dependency
-  name: shoulda
-  requirement: &2160531280 !ruby/object:Gem::Requirement
-    none: false
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.11'
+        version: '4.7'
   type: :development
   prerelease: false
-  version_requirements: *2160531280
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
 - !ruby/object:Gem::Dependency
-  name: mocha
-  requirement: &2160530200 !ruby/object:Gem::Requirement
-    none: false
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: 1.8.3
   type: :development
   prerelease: false
-  version_requirements: *2160530200
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.3
 - !ruby/object:Gem::Dependency
-  name: xml-simple
-  requirement: &2160528740 !ruby/object:Gem::Requirement
-    none: false
+  name: guard-minitest
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: 1.0.1
   type: :development
   prerelease: false
-  version_requirements: *2160528740
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &2160527100 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2160527100
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: NiFTP makes Ruby's decidedly un-nifty Net::FTP library easier to use.
 email:
 - chmurph2+git@gmail.com
@@ -107,8 +130,11 @@ extensions: []
 extra_rdoc_files:
 - README.md
 files:
-- .gitignore
+- ".gitignore"
+- ".travis.yml"
+- CONTRIBUTING.md
 - Gemfile
+- Guardfile
 - MIT-LICENSE
 - README.md
 - Rakefile
@@ -118,29 +144,29 @@ files:
 - test/niftp_test.rb
 - test/test_helper.rb
 homepage: https://github.com/chmurph2/NiFTP
-licenses: []
+licenses:
+- MIT
+metadata: {}
 post_install_message: 
 rdoc_options:
-- --include=examples --main README.md
+- "--include=examples --main README.md"
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: niftp
-rubygems_version: 1.8.17
+rubygems_version: 2.2.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: NiFTP makes Ruby's decidedly un-nifty Net::FTP library easier to use.
 test_files:
 - test/niftp_test.rb