niftp 1.0.0

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+rdoc

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in niftp.gemspec
+gemspec

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Christopher R. Murphy
+
+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/README.md

@@ -0,0 +1,39 @@
+NiFTP, a Ruby gem, makes Ruby's decidedly un-nifty Net::FTP library easier to
+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") }
+
+    # 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  
+
+## Options
+
+* **username**: The user name, if required by the host (default: "").
+* **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).
+* **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
+(REE) and 1.9.2.

data/Rakefile

@@ -0,0 +1,23 @@
+require 'bundler'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+Bundler::GemHelper.install_tasks
+
+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 = "service_helpers #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/lib/niftp/version.rb

@@ -0,0 +1,3 @@
+module NiFTP
+  VERSION = "1.0.0"
+end

data/lib/niftp.rb

@@ -0,0 +1,37 @@
+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.
+module NiFTP
+
+  # Connects to the +host+ FTP server, executes the given block then closes
+  # the connection.
+  #
+  # 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
+      ftp = options[:ftps] ? Net::FTPFXPTLS.new : Net::FTP.new
+      ftp.passive = options[:passive]
+      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?
+      ensure
+        ftp.try(:close)
+      end
+    end
+  end
+end
+
+# Alias for those that prefer a conventional module name.
+Niftp = NiFTP

data/niftp.gemspec

@@ -0,0 +1,37 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "niftp/version"
+
+Gem::Specification.new do |s|
+  s.name        = "niftp"
+  s.version     = NiFTP::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Christopher R. Murphy"]
+  s.email       = ["chmurph2+git@gmail.com"]
+  s.homepage    = "http://www.blogobaggins.net"
+  s.summary     = %q{NiFTP abstracts away the ceremony from Ruby's Net::FTP class.}
+  s.description = %q{Please see this project's README.}
+
+  s.rubyforge_project = "niftp"
+
+  # files
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # RDoc
+  s.has_rdoc = true
+  s.rdoc_options = '--include=examples --main README.md'
+  s.extra_rdoc_files = ["README.md"] + Dir.glob("doc/*")
+
+  # Dependencies
+  s.add_dependency "ftpfxp",    ">= 0.0.4"
+  s.add_dependency "retryable", ">= 1.2"
+  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"
+end

data/test/niftp_test.rb

@@ -0,0 +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
+
+    should "be accessible via the Niftp shortcut" do
+      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 }) }
+    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
+
+    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
+
+    should "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 username" do
+      stub_ftp
+      @ftp.expects(:login).with("anonymous", "")
+      @object.ftp(@host, { :username => "anonymous" })
+    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
+
+    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"
+      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
+
+    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
+    end
+
+    should "use the :retries option instead of the default" do
+      Net::FTP.expects(:new).times(5).returns(@ftp)
+      assert_raise(RuntimeError) do
+        @object.ftp(@host, {:retries => 5 }) 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)
+      assert_raise(RuntimeError) do
+        @object.ftp(@host) { |ftp_client| raise "testing close"}
+      end
+    end
+
+    should "use a five second (default) timeout when connecting" do
+      stub_ftp
+      Timeout.expects(:timeout).with(5)
+      @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
+
+    should "use the FTPFXP (FTPS) library when instructed" do
+      Net::FTPFXPTLS.expects(:new).once.returns(@ftp)
+      @object.ftp(@host, options = { :ftps => true })
+    end
+  end
+
+  private
+
+  def stub_ftp
+    Net::FTP.stubs(:new => @ftp)
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,7 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+require 'mocha'
+
+class Test::Unit::TestCase
+end

metadata

@@ -0,0 +1,154 @@
+--- !ruby/object:Gem::Specification 
+name: niftp
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 1.0.0
+platform: ruby
+authors: 
+- Christopher R. Murphy
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-05-18 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: ftpfxp
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    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 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "1.2"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    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 
+    none: false
+    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 
+    none: false
+    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 
+    none: false
+    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 
+    none: false
+    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 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0.8"
+  type: :development
+  version_requirements: *id008
+description: Please see this project's README.
+email: 
+- chmurph2+git@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.md
+files: 
+- .gitignore
+- Gemfile
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/niftp.rb
+- lib/niftp/version.rb
+- niftp.gemspec
+- test/niftp_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://www.blogobaggins.net
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --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.6.2
+signing_key: 
+specification_version: 3
+summary: NiFTP abstracts away the ceremony from Ruby's Net::FTP class.
+test_files: 
+- test/niftp_test.rb
+- test/test_helper.rb