ftpd 1.1.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f15991457aaefd1d3575b3a81e365a5bf406353b
-  data.tar.gz: 5a555e7a075a1b67ea97f34610a3f46564fa0c27
+  metadata.gz: da62814ce49fab3ad30c35b6841810728722bc99
+  data.tar.gz: fd68f590b35708037f0ca1678dd84936dee7d4e1
 SHA512:
-  metadata.gz: e110f5914d7c9ffe19aee3f0ad93eff70a31cf971b787d0035ddb107cd48ef1e437edac2e1bf1ebc69576f1330e38c2db13cbacdb24046fca682a30f3d77f736
-  data.tar.gz: 51e353cafeb9d122030717415b981e1ae366ae2d53fbe805462cd04887625455d273285c63bf55dde5af59c740ef5b560335a8723dcd944c19759376de4bbf55
+  metadata.gz: a84a4a7d0554c71e71816376b7cac3268d0f6250a58d34ffa0a9bc1f5116468b73e36c5f09a333f28b173cf9c4dd9e7427ac5c9f9cb93cf12f63344ae7bfd09e
+  data.tar.gz: ffd9e7e5477c2afd9301158be878968ed7e601677433f5c8e2b0dfee050106f580026235368a726e05a84da0f92a25369de649ddf19a1fa03ff8b2e7d591ce98

data/.travis.yml

@@ -3,3 +3,4 @@ rvm:
 - 1.9.3
 - 2.0
 - 2.1
+- 2.2

data/Changelog.md

@@ -2,6 +2,21 @@ This is the change log for the main branch of ftpd, which supports
 Ruby 1.9 and greater.  For ruby 1.8.7, please use the latest version
 before 0.8.0.
 
+### Development
+
+Breaking changes:
+
+* Freeze strings by default.  This is an unlikely but potential
+  breaking change for users of Ruby >= 2.3.
+
+Non-breaking changes
+
+* Added option #nat_ip to configure the advertised IP for passive mode
+  connections.
+
+* Added option #passive_ports to configure the port range for passive
+  mode server sockets.
+
 ### 1.1.1 (2014-11-22)
 
 Administration

data/Gemfile

@@ -3,10 +3,10 @@ source 'http://rubygems.org'
 gem 'memoizer', '~> 1.0'
 
 group :development do
-  gem 'cucumber', '~> 1.3'
+  gem 'cucumber', '~> 2.0'
   gem 'double-bag-ftps', '~> 0.1'
   gem 'jeweler', '~> 2.0'
-  gem 'rake', '~> 10.3'
+  gem 'rake', '~> 11.1'
   gem 'redcarpet', '~> 3.1'
   gem 'rspec', '~> 3.1'
   gem 'rspec-its', '~> 1.0'

data/Gemfile.lock

@@ -1,34 +1,37 @@
 GEM
   remote: http://rubygems.org/
   specs:
-    addressable (2.3.6)
+    addressable (2.4.0)
     builder (3.2.2)
-    cucumber (1.3.17)
+    cucumber (2.3.3)
       builder (>= 2.1.2)
+      cucumber-core (~> 1.4.0)
+      cucumber-wire (~> 0.0.1)
       diff-lcs (>= 1.1.3)
-      gherkin (~> 2.12)
+      gherkin (~> 3.2.0)
       multi_json (>= 1.7.5, < 2.0)
-      multi_test (>= 0.1.1)
+      multi_test (>= 0.1.2)
+    cucumber-core (1.4.0)
+      gherkin (~> 3.2.0)
+    cucumber-wire (0.0.1)
     descendants_tracker (0.0.4)
       thread_safe (~> 0.3, >= 0.3.1)
     diff-lcs (1.2.5)
     double-bag-ftps (0.1.2)
-    faraday (0.9.0)
+    faraday (0.9.2)
       multipart-post (>= 1.2, < 3)
-    gherkin (2.12.2)
-      multi_json (~> 1.3)
-    git (1.2.8)
-    github_api (0.12.1)
-      addressable (~> 2.3)
+    gherkin (3.2.0)
+    git (1.3.0)
+    github_api (0.13.1)
+      addressable (~> 2.4.0)
       descendants_tracker (~> 0.0.4)
       faraday (~> 0.8, < 0.10)
-      hashie (>= 3.2)
+      hashie (>= 3.4)
       multi_json (>= 1.7.5, < 2.0)
-      nokogiri (~> 1.6.3)
       oauth2
-    hashie (3.3.1)
-    highline (1.6.21)
-    jeweler (2.0.1)
+    hashie (3.4.3)
+    highline (1.7.8)
+    jeweler (2.1.1)
       builder
       bundler (>= 1.0)
       git (>= 1.2.5)
@@ -37,57 +40,63 @@ GEM
       nokogiri (>= 1.5.10)
       rake
       rdoc
-    json (1.8.1)
-    jwt (1.0.0)
+      semver
+    json (1.8.3)
+    jwt (1.5.1)
     memoizer (1.0.1)
-    mini_portile (0.6.0)
-    multi_json (1.10.1)
-    multi_test (0.1.1)
+    mini_portile2 (2.0.0)
+    multi_json (1.11.2)
+    multi_test (0.1.2)
     multi_xml (0.5.5)
     multipart-post (2.0.0)
-    nokogiri (1.6.3.1)
-      mini_portile (= 0.6.0)
-    oauth2 (1.0.0)
+    nokogiri (1.6.7.2)
+      mini_portile2 (~> 2.0.0.rc2)
+    oauth2 (1.1.0)
       faraday (>= 0.8, < 0.10)
-      jwt (~> 1.0)
+      jwt (~> 1.0, < 1.5.2)
       multi_json (~> 1.3)
       multi_xml (~> 0.5)
-      rack (~> 1.2)
-    rack (1.5.2)
-    rake (10.3.2)
-    rdoc (4.1.2)
+      rack (>= 1.2, < 3)
+    rack (1.6.4)
+    rake (11.1.2)
+    rdoc (4.2.2)
       json (~> 1.4)
-    redcarpet (3.1.2)
-    rspec (3.1.0)
-      rspec-core (~> 3.1.0)
-      rspec-expectations (~> 3.1.0)
-      rspec-mocks (~> 3.1.0)
-    rspec-core (3.1.4)
-      rspec-support (~> 3.1.0)
-    rspec-expectations (3.1.2)
+    redcarpet (3.3.4)
+    rspec (3.4.0)
+      rspec-core (~> 3.4.0)
+      rspec-expectations (~> 3.4.0)
+      rspec-mocks (~> 3.4.0)
+    rspec-core (3.4.4)
+      rspec-support (~> 3.4.0)
+    rspec-expectations (3.4.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-its (1.2.0)
+      rspec-core (>= 3.0.0)
+      rspec-expectations (>= 3.0.0)
+    rspec-mocks (3.4.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.1.0)
-    rspec-its (1.0.1)
-      rspec-core (>= 2.99.0.beta1)
-      rspec-expectations (>= 2.99.0.beta1)
-    rspec-mocks (3.1.2)
-      rspec-support (~> 3.1.0)
-    rspec-support (3.1.1)
-    thread_safe (0.3.4)
-    timecop (0.7.1)
-    yard (0.8.7.4)
+      rspec-support (~> 3.4.0)
+    rspec-support (3.4.1)
+    semver (1.0.1)
+    thread_safe (0.3.5)
+    timecop (0.8.1)
+    yard (0.8.7.6)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  cucumber (~> 1.3)
+  cucumber (~> 2.0)
   double-bag-ftps (~> 0.1)
   jeweler (~> 2.0)
   memoizer (~> 1.0)
-  rake (~> 10.3)
+  rake (~> 11.1)
   redcarpet (~> 3.1)
   rspec (~> 3.1)
   rspec-its (~> 1.0)
   timecop (~> 0.7)
   yard (~> 0.8.7)
+
+BUNDLED WITH
+   1.11.2

data/README.md

@@ -4,7 +4,6 @@
 [![Build Status](https://travis-ci.org/wconrad/ftpd.png)](https://travis-ci.org/wconrad/ftpd)
 [![Code Climate](https://codeclimate.com/github/wconrad/ftpd.png)](https://codeclimate.com/github/wconrad/ftpd)
 
-
 ftpd is a pure Ruby FTP server library.  It supports implicit and
 explicit TLS, IPV6, passive and active mode, and is unconditionally
 compliant per [RFC-1123][1].  It can be used as part of a test fixture
@@ -175,6 +174,8 @@ server.start
 
 You can set any of these attributes before starting the server:
 
+# {Ftpd::FtpServer#nat_ip}
+# {Ftpd::FtpServer#passive_ports}
 * {Ftpd::FtpServer#allow_low_data_ports}
 * {Ftpd::FtpServer#auth_level}
 * {Ftpd::FtpServer#exception_handler}
@@ -284,6 +285,12 @@ that branch, use this line in your Gemfile:
 Does it work for you?  Is it busted?  Please report your experience
 [here](https://github.com/wconrad/ftpd/issues/3).
 
+## Versioning
+
+This library uses [Semantic Versioning](http://semver.org/).  Ftpd
+promises not to make breaking changes to its API without bumping the
+major version.
+
 ## Development
 
 ### Tests

data/VERSION

@@ -1 +1 @@
-1.1.1
+2.0.0

data/examples/example.rb

@@ -19,6 +19,8 @@ module Example
     attr_reader :debug
     attr_reader :eplf
     attr_reader :interface
+    attr_reader :nat_ip
+    attr_reader :passive_ports
     attr_reader :password
     attr_reader :port
     attr_reader :read_only
@@ -36,6 +38,8 @@ module Example
       @account = ''
       @session_timeout = default_session_timeout
       @log = nil
+      @nat_ip = nil
+      @passive_ports = nil
       op = option_parser
       op.parse!(argv)
     rescue OptionParser::ParseError => e
@@ -88,6 +92,12 @@ module Example
         op.on('-d', '--debug', 'Write server debug log to stdout') do |t|
           @debug = t
         end
+        op.on('--nat-ip IP', 'Set advertised passive mode IP') do |t|
+          @nat_ip = t
+        end
+        op.on('--ports MIN..MAX', 'Port numbers for passive mode sockets') do |v|
+          @passive_ports = Range.new(*v.split(/\.\./).map(&:to_i))
+        end
       end
     end
 
@@ -181,6 +191,7 @@ module Example
       @server.interface = @args.interface
       @server.port = @args.port
       @server.tls = @args.tls
+      @server.passive_ports = @args.passive_ports
       @server.certfile_path = insecure_certfile_path
       if @args.eplf
         @server.list_formatter = Ftpd::ListFormat::Eplf
@@ -188,6 +199,7 @@ module Example
       @server.auth_level = auth_level
       @server.session_timeout = @args.session_timeout
       @server.log = make_log
+      @server.nat_ip = @args.nat_ip
     end
 
     def auth_level

data/features/example/step_definitions/example_server.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 def example_args
   @example_args ||= []
 end

data/features/ftp_server/eprt.feature

@@ -5,6 +5,7 @@ Feature: EPRT
   So that I can correct problems
 
   Background:
+    Given the stack supports ipv6
     Given the test server is bound to "::"
     Given the test server is started
 

data/features/ftp_server/epsv.feature

@@ -5,6 +5,7 @@ Feature: EPSV
   So that I can correct problems
 
   Background:
+    Given the stack supports ipv6
     Given the test server is bound to "::"
     And the test server is started
 

data/features/ftp_server/get_ipv6.feature

@@ -4,6 +4,9 @@ Feature: Get IPV6
   I want to get a file
   So that I have it on my computer
 
+  Background:
+    Given the stack supports ipv6
+
   Scenario: Active
     Given the test server is bound to "::1"
     And the test server is started

data/features/ftp_server/pasv.feature

@@ -4,20 +4,27 @@ Feature: PASV
   I want good error messages
   So that I can correct problems
 
-  Background:
-    Given the test server is started
-
   Scenario: No argument
+    Given the test server is started
     Given a successful login
     Then the client successfully sends "PASV"
 
   Scenario: After "EPSV ALL"
+    Given the test server is started
     Given a successful login
     Given the client successfully sends "EPSV ALL"
     When the client sends "PASV"
     Then the server sends a not allowed after epsv all error
 
   Scenario: Not logged in
+    Given the test server is started
     Given a successful connection
     When the client sends "EPSV"
     Then the server returns a not logged in error
+
+  Scenario: Configured with NAT IP
+    Given the test server has a NAT IP of 10.1.2.3
+    Given the test server is started
+    And a successful login
+    When the client successfully sends "PASV"
+    Then the server advertises passive IP 10.1.2.3

data/features/ftp_server/step_definitions/logging.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 Then /^the server should have written( no)? log output$/ do |neg|
   verb = if neg
            :to

data/features/ftp_server/step_definitions/test_server.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 def server
   @server ||= TestServer.new
 end
@@ -63,3 +65,7 @@ end
 Given /^the test server has a failed login delay of (\S+) seconds$/ do |s|
   server.failed_login_delay = s.to_f
 end
+
+Given /^the test server has a NAT IP of (\S+)$/ do |s|
+  server.nat_ip = s
+end

data/features/step_definitions/append.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 When /^the client appends (.*)$/ do |args|
   capture_error do
     step "the client successfully appends #{args}"

data/features/step_definitions/client.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'singleton'
 
 class Clients
@@ -20,5 +22,6 @@ end
 
 def client(client_name = nil)
   client_name ||= 'client'
+  client_name = client_name.strip
   Clients.instance[client_name]
 end

data/features/step_definitions/client_and_server_files.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 def unix_line_endings(exactly, s)
   return s if exactly
   s.gsub(/\r\n/, "\n")

data/features/step_definitions/client_files.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 Given /^the client has file "(.*?)"$/ do |local_path|
   client.add_file local_path
 end

data/features/step_definitions/command.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 When /^the client sends command "(.*?)"$/ do |command|
   capture_error do
     client.raw command

data/features/step_definitions/connect.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'double_bag_ftps'
 require 'net/ftp'
 

data/features/step_definitions/delete.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 When /^the client deletes "(.*?)"$/ do |path|
   capture_error do
     step %Q(the client successfully deletes "#{path}")

data/features/step_definitions/directory_navigation.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 When /^the client cd's to "(.*?)"$/ do |path|
   capture_error do
     step %Q(the client successfully cd's to "#{path}")

data/features/step_definitions/error_replies.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 def capture_error
   yield
   @error = nil