ftpd 1.0.1 → 1.1.0

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    NmM2NzYzZmUzMDY2YzRiMGVmMWI5NTMxNjM0Y2Y1Zjk3MGZjYTUzMA==
-  data.tar.gz: !binary |-
-    MDEwOTRkNjJkY2QwMGVkNTg3NzU0ZGU1ZmE0ZDYzOWYzYWViNzJjMQ==
+SHA1:
+  metadata.gz: 189a61ebfe79058fbf8ab5079be2e57dad494898
+  data.tar.gz: a4e2b09abc12890a8b2729e44a1e172aa4201fac
 SHA512:
-  metadata.gz: !binary |-
-    OTVlOTZiZmVjNTQ3OTRiMzE2M2FkMDZiZTIxMmY5ZDU4MDJkMjViZTk5OGNl
-    NTRmODI4ZWU4MTJiMmFiN2Q3NDBkNmQ5NzhhZDE5OGMyNjZjY2E5NzhmMTM0
-    ODc4OTA3M2VjMjc0YWY2NzJmMTM0NTI4ZmQ1ZWQ3ODc1ZDlmOWU=
-  data.tar.gz: !binary |-
-    MzU5MjIzOGZlZjE0ZGVhZGI2NGUxNmZlZDUzMDhkOWQwYjZhY2I0NWE0N2E0
-    ZjQ3NTgyNjM2NTMzYTljZmIwMGZiYThlOTEwZmE4NzY5MTU4MDBjMjA1YTc0
-    OWU4ODRiZmQ1OGU3NWRkZmVjZTk5MTY0OTAzMzY0YzA1NzhjOTE=
+  metadata.gz: ab7e3e91a03ce1c0c5ad9d116e5c88166a872351ee10c428ce57ae086380fbb2dcfa49cc9c486d23b5c82e6aa6e5a02f50be418cbc62eb09cd2457af840e2260
+  data.tar.gz: db4c4e093358a41d1c12194f440b413160ed4a9aa0fd5cfbdef7b7d52f29dc5ec1d0d0e08beecd713468b562ea19576e5571e779ee06de5bd78ec6ded3374bd0

data/Changelog.md

@@ -2,6 +2,11 @@ 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
+
+* Added Server#exception_handler= (thanks akelmanson)
+* Added Server#join (thanks akelmanson)	
+
 ### 1.0.1
 
 * Less strict gem dependencies

data/Gemfile.lock

@@ -3,7 +3,7 @@ GEM
   specs:
     addressable (2.3.6)
     builder (3.2.2)
-    cucumber (1.3.16)
+    cucumber (1.3.17)
       builder (>= 2.1.2)
       diff-lcs (>= 1.1.3)
       gherkin (~> 2.12)
@@ -55,24 +55,24 @@ GEM
       rack (~> 1.2)
     rack (1.5.2)
     rake (10.3.2)
-    rdoc (4.1.1)
+    rdoc (4.1.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.0)
+    rspec-core (3.1.4)
       rspec-support (~> 3.1.0)
-    rspec-expectations (3.1.0)
+    rspec-expectations (3.1.2)
       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.0)
+    rspec-mocks (3.1.2)
       rspec-support (~> 3.1.0)
-    rspec-support (3.1.0)
+    rspec-support (3.1.1)
     thread_safe (0.3.4)
     timecop (0.7.1)
     yard (0.8.7.4)

data/README.md

@@ -27,12 +27,6 @@ probability that it contains critical flaws (or even security
 vulnarabilities) that have not been discovered in its use as a test
 harness.
 
-In this 0.X.X release, the API is changing at least a little with
-almost every release.  If you need to keep those changes from
-impacting you (or at least want to let many of them build up before
-you have to deal with them), then lock your Gemfile down to a minor
-release (e.g. :version => '~> 0.5.0').
-
 ## Hello World
 
 This is examples/hello_world.rb, a bare minimum FTP server.  It allows
@@ -183,6 +177,7 @@ You can set any of these attributes before starting the server:
 
 * {Ftpd::FtpServer#allow_low_data_ports}
 * {Ftpd::FtpServer#auth_level}
+* {Ftpd::FtpServer#exception_handler}
 * {Ftpd::FtpServer#failed_login_delay}
 * {Ftpd::FtpServer#list_formatter}
 * {Ftpd::FtpServer#log}
@@ -355,6 +350,7 @@ and granted permission to donate it to the community.
 Among those who have improved ftpd are:
 
 * Alfonso Cora
+* André Aizim Kelmanson
 * Bjoern B. Dorra
 * Joshua Rutherford
 * Larry. W. Cashdollar

data/VERSION

@@ -1 +1 @@
-1.0.1
+1.1.0

data/ftpd.gemspec

@@ -2,16 +2,16 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: ftpd 1.0.1 ruby lib
+# stub: ftpd 1.1.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "ftpd"
-  s.version = "1.0.1"
+  s.version = "1.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib"]
   s.authors = ["Wayne Conrad"]
-  s.date = "2014-09-05"
+  s.date = "2014-11-22"
   s.description = "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.  It can be used as part of a test fixture or embedded in a program."
   s.email = "wconrad@yagni.com"
   s.extra_rdoc_files = [
@@ -197,6 +197,7 @@ Gem::Specification.new do |s|
     "lib/ftpd/file_info.rb",
     "lib/ftpd/file_system_helper.rb",
     "lib/ftpd/ftp_server.rb",
+    "lib/ftpd/gets_peer_address.rb",
     "lib/ftpd/insecure_certificate.rb",
     "lib/ftpd/list_format/eplf.rb",
     "lib/ftpd/list_format/ls.rb",
@@ -237,7 +238,7 @@ Gem::Specification.new do |s|
   ]
   s.homepage = "http://github.com/wconrad/ftpd"
   s.licenses = ["MIT"]
-  s.rubygems_version = "2.2.2"
+  s.rubygems_version = "2.4.4"
   s.summary = "Pure Ruby FTP server library"
 
   if s.respond_to? :specification_version then

data/lib/ftpd/command_loop.rb

@@ -27,6 +27,9 @@ module Ftpd
               execute_command command, argument
             rescue FtpServerError => e
               reply e.message_with_code
+            rescue => e
+              reply "451 Requested action aborted. Local error in processing."
+              config.exception_handler.call(e) unless config.exception_handler.nil?
             end
           end
         rescue Errno::ECONNRESET, Errno::EPIPE

data/lib/ftpd/connection_tracker.rb

@@ -1,9 +1,13 @@
+require_relative "gets_peer_address"
+
 module Ftpd
 
   # This class keeps track of connections
 
   class ConnectionTracker
 
+    include GetsPeerAddress
+
     def initialize
       @mutex = Mutex.new
       @connections = {}
@@ -18,7 +22,7 @@ module Ftpd
       end
     end
 
-    # Return the number of connections for a socket
+    # Return the number of connections for a socket's peer IP
 
     def connections_for(socket)
       @mutex.synchronize do
@@ -39,18 +43,6 @@ module Ftpd
       end
     end
 
-    # Return the number of known IPs.  This exists for the benefit of
-    # the test, so that it can know the tracker has properly forgotten
-    # about an IP with no connections.
-
-    def known_ip_count
-      @mutex.synchronize do
-        @connections.size
-      end
-    end
-
-    private
-
     # Start tracking a connection
 
     def start_track(socket)
@@ -73,37 +65,17 @@ module Ftpd
       end
     end
 
-    # Obtain the IP that the client connected _from_.
-    #
-    # How this is done depends upon which type of socket (SSL or not)
-    # and what version of Ruby.
-    #
-    # * SSL socket
-    #   * #peeraddr.  Uses BasicSocket.do_not_reverse_lookup.
-    # * Ruby 1.8.7
-    #   * #peeraddr, which does not take the "reverse lookup"
-    #     argument, relying instead using
-    #     BasicSocket.do_not_reverse_lookup.
-    #   * #getpeername, which does not do a reverse lookup.  It is a
-    #     little uglier than #peeraddr.
-    # * Ruby >=1.9.3
-    #   * #peeraddr, which takes the "reverse lookup" argument.
-    #   * #getpeername - same as 1.8.7
-
-    # @return [String] IP address
-
-    def peer_ip(socket)
-      if socket.respond_to?(:getpeername)
-        # Non SSL
-        sockaddr = socket.getpeername
-        port, host = Socket.unpack_sockaddr_in(sockaddr)
-        host
-      else
-        # SSL
-        BasicSocket.do_not_reverse_lookup = true
-        socket.peeraddr.last
+    # Return the number of known IPs.  This exists for the benefit of
+    # the test, so that it can know the tracker has properly forgotten
+    # about an IP with no connections.
+
+    def known_ip_count
+      @mutex.synchronize do
+        @connections.size
       end
-     end
+    end
+
+    private
 
   end
 

data/lib/ftpd/ftp_server.rb

@@ -127,6 +127,22 @@ module Ftpd
 
     attr_accessor :session_timeout
 
+    # The exception handler. When there is an unknown exception,
+    # server replies 451 and calls exception_handler. If nil,
+    # then it's ignored.
+    #
+    # Set this before calling #start.
+    #
+    # @return [Proc]
+
+    attr_accessor :exception_handler
+
+    # Defines the exception_handler.
+
+    def on_exception(&block)
+      self.exception_handler = block
+    end
+
     # Create a new FTP server.  The server won't start until the
     # #start method is called.
     #
@@ -183,6 +199,7 @@ module Ftpd
       config.server_version = @server_version
       config.session_timeout = @session_timeout
       config.tls = @tls
+      config.exception_handler = exception_handler
       session = Session.new(config, socket)
       session.run
     end

data/lib/ftpd/gets_peer_address.rb

@@ -0,0 +1,41 @@
+require_relative "gets_peer_address"
+
+module Ftpd
+
+  module GetsPeerAddress
+
+    # Obtain the IP that the client connected _from_.
+    #
+    # How this is done depends upon which type of socket (SSL or not)
+    # and what version of Ruby.
+    #
+    # * SSL socket
+    #   * #peeraddr.  Uses BasicSocket.do_not_reverse_lookup.
+    # * Ruby 1.8.7
+    #   * #peeraddr, which does not take the "reverse lookup"
+    #     argument, relying instead using
+    #     BasicSocket.do_not_reverse_lookup.
+    #   * #getpeername, which does not do a reverse lookup.  It is a
+    #     little uglier than #peeraddr.
+    # * Ruby >=1.9.3
+    #   * #peeraddr, which takes the "reverse lookup" argument.
+    #   * #getpeername - same as 1.8.7
+    #
+    # @return [String] IP address
+
+    def peer_ip(socket)
+      if socket.respond_to?(:getpeername)
+        # Non SSL
+        sockaddr = socket.getpeername
+        port, host = Socket.unpack_sockaddr_in(sockaddr)
+        host
+      else
+        # SSL
+        BasicSocket.do_not_reverse_lookup = true
+        socket.peeraddr.last
+      end
+    end
+
+  end
+
+end

data/lib/ftpd/server.rb

@@ -37,6 +37,14 @@ module Ftpd
       @server_socket.addr[1]
     end
 
+    # The calling thread will suspend execution until the server is
+    # stopped.
+
+    def join
+      raise 'Server is not started!' if @server_thread.nil?
+      @server_thread.join
+    end
+
     # Start the server.  This creates the server socket, and the
     # thread to service it.
 

data/lib/ftpd/session_config.rb

@@ -98,6 +98,14 @@ module Ftpd
 
     attr_accessor :tls
 
+    # The exception handler. When there is an unknown exception,
+    # server replies 451 and calls exception_handler. If nil,
+    # then it's ignored.
+    #
+    # @return [Proc]
+
+    attr_accessor :exception_handler
+
   end
 
 end

data/spec/connection_tracker_spec.rb

@@ -17,53 +17,6 @@ module Ftpd
       socket
     end
 
-    # Since the connection tracker only keeps track of a connection
-    # until the block to which it yields returns, we need a way to
-    # keep a block active.
-
-    class Connector
-
-      # Enable the rspec expect syntax in this class.
-      # This uses an internal API of rspec-mock.
-      # See: http://stackoverflow.com/q/25692786/238886
-      RSpec::Mocks::Syntax.enable_expect self
-
-      def initialize(connection_tracker)
-        @connection_tracker = connection_tracker
-        @tracked = Queue.new
-        @end_session = Queue.new
-        @session_ended = Queue.new
-      end
-
-      # Start tracking a connection.  Does not return until it is
-      # being tracked.
-
-      def start_session(socket)
-        Thread.new do
-          @connection_tracker.track(socket) do
-            @tracked.enq :go
-            command = @end_session.deq
-            if command == :close
-              allow(socket).to receive(:getpeername)
-              .and_raise(RuntimeError, "Socket closed")
-            end
-          end
-          @session_ended.enq :go
-        end
-        @tracked.deq
-      end
-
-      # Stop tracking a connection.  Does not return until it is no
-      # longer tracked.
-
-      def end_session(command = :normally)
-        @end_session.enq command
-        @session_ended.deq
-      end
-
-    end
-
-    let(:connector) {Connector.new(connection_tracker)}
     subject(:connection_tracker) {ConnectionTracker.new}
 
     describe '#connections' do
@@ -74,21 +27,9 @@ module Ftpd
 
         it 'should track the total number of connection' do
           expect(connection_tracker.connections).to eq 0
-          connector.start_session socket
+          connection_tracker.start_track socket
           expect(connection_tracker.connections).to eq 1
-          connector.end_session
-          expect(connection_tracker.connections).to eq 0
-        end
-
-      end
-
-      context '(socket disconnected during session)' do
-
-        it 'should track the total number of connection' do
-          expect(connection_tracker.connections).to eq 0
-          connector.start_session socket
-          expect(connection_tracker.connections).to eq 1
-          connector.end_session :close
+          connection_tracker.stop_track socket
           expect(connection_tracker.connections).to eq 0
         end
 
@@ -103,10 +44,10 @@ module Ftpd
         socket2 = socket_bound_to('127.0.0.2')
         expect(connection_tracker.connections_for(socket1)).to eq 0
         expect(connection_tracker.connections_for(socket2)).to eq 0
-        connector.start_session socket1
+        connection_tracker.start_track socket1
         expect(connection_tracker.connections_for(socket1)).to eq 1
         expect(connection_tracker.connections_for(socket2)).to eq 0
-        connector.end_session
+        connection_tracker.stop_track socket1
         expect(connection_tracker.connections_for(socket1)).to eq 0
         expect(connection_tracker.connections_for(socket2)).to eq 0
       end
@@ -119,14 +60,38 @@ module Ftpd
 
       it 'should forget about an IP that has no connection' do
         expect(connection_tracker.known_ip_count).to eq 0
-        connector.start_session socket
+        connection_tracker.start_track socket
         expect(connection_tracker.known_ip_count).to eq 1
-        connector.end_session
+        connection_tracker.stop_track socket
         expect(connection_tracker.known_ip_count).to eq 0
       end
 
     end
 
+    describe '#track' do
+
+      let(:socket) {socket_bound_to('127.0.0.1')}
+
+      context '(session ends normally)' do
+        specify do
+          expect(connection_tracker.connections_for(socket)).to eq 0
+          connection_tracker.track(socket) do
+            expect(connection_tracker.connections_for(socket)).to eq 1
+          end
+          expect(connection_tracker.connections_for(socket)).to eq 0
+        end
+      end
+
+      context '(session ends with exception)' do
+        specify do
+          expect(connection_tracker.connections_for(socket)).to eq 0
+          connection_tracker.track(socket) { raise } rescue
+          expect(connection_tracker.connections_for(socket)).to eq 0
+        end
+      end
+
+    end
+
   end
 
 end

data/spec/server_spec.rb

@@ -4,6 +4,21 @@ module Ftpd
 
   describe Server do
 
+    describe '#join' do
+      it 'calls server_thread#join' do
+        expect_any_instance_of(Thread).to receive(:join)
+        server = Server.new
+        server.start
+        server.join
+      end
+      context 'when server is not started' do
+        it 'raises an error' do
+          server = Server.new
+          expect { server.join }.to raise_error('Server is not started!')
+        end
+      end
+    end
+
     describe 'reuse explicit port (github #23)' do
 
       # The bug being tested involves a race condition.  Monkey patch

metadata

@@ -1,153 +1,153 @@
 --- !ruby/object:Gem::Specification
 name: ftpd
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Wayne Conrad
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-05 00:00:00.000000000 Z
+date: 2014-11-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: memoizer
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
 - !ruby/object:Gem::Dependency
   name: cucumber
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
   name: double-bag-ftps
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.1'
 - !ruby/object:Gem::Dependency
   name: jeweler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.3'
 - !ruby/object:Gem::Dependency
   name: redcarpet
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.1'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.1'
 - !ruby/object:Gem::Dependency
   name: rspec-its
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
 - !ruby/object:Gem::Dependency
   name: timecop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.7'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.8.7
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.8.7
 description: ftpd is a pure Ruby FTP server library.  It supports implicit and explicit
@@ -160,8 +160,8 @@ extra_rdoc_files:
 - LICENSE.md
 - README.md
 files:
-- .travis.yml
-- .yardopts
+- ".travis.yml"
+- ".yardopts"
 - Changelog.md
 - Gemfile
 - Gemfile.lock
@@ -338,6 +338,7 @@ files:
 - lib/ftpd/file_info.rb
 - lib/ftpd/file_system_helper.rb
 - lib/ftpd/ftp_server.rb
+- lib/ftpd/gets_peer_address.rb
 - lib/ftpd/insecure_certificate.rb
 - lib/ftpd/list_format/eplf.rb
 - lib/ftpd/list_format/ls.rb
@@ -385,17 +386,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.4
 signing_key: 
 specification_version: 4
 summary: Pure Ruby FTP server library