fake_ftp 0.2.0 → 0.3.0

data/Rakefile

@@ -1,10 +1,15 @@
-require 'bundler'
-Bundler::GemHelper.install_tasks
+# frozen_string_literal: true
 
-require 'rspec/core'
-require 'rspec/core/rake_task'
+begin
+  require 'bundler'
+  require 'rspec/core/rake_task'
+  require 'rubocop/rake_task'
+rescue LoadError => e
+  warn e
+end
 
-RSpec::Core::RakeTask.new('spec')
+Bundler::GemHelper.install_tasks if defined?(Bundler)
+RSpec::Core::RakeTask.new if defined?(RSpec)
+RuboCop::RakeTask.new if defined?(RuboCop)
 
-# If you want to make this the default task
-task :default => :spec
+task default: %i[rubocop spec]

data/fake_ftp.gemspec

@@ -1,22 +1,21 @@
 # -*- encoding: utf-8 -*-
-$:.push File.expand_path("../lib", __FILE__)
-require "fake_ftp/version"
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift(File.expand_path('../lib', __FILE__))
+require 'fake_ftp/version'
 
 Gem::Specification.new do |s|
-  s.name        = "fake_ftp"
-  s.version     = FakeFtp::VERSION
-  s.platform    = Gem::Platform::RUBY
-  s.authors     = ["Colin Shield", "Eric Saxby"]
-  s.email       = ["sax+github@livinginthepast.org"]
-  s.homepage    = "http://rubygems.org/gems/fake_ftp"
-  s.summary     = %q{Creates a fake FTP server for use in testing}
-  s.description = %q{Testing FTP? Use this!}
-  s.license     = 'MIT'
+  s.name = 'fake_ftp'
+  s.version = FakeFtp::VERSION
+  s.platform = Gem::Platform::RUBY
+  s.authors = ['Colin Shield', 'Eric Saxby']
+  s.email = ['sax+github@livinginthepast.org']
+  s.homepage = 'http://rubygems.org/gems/fake_ftp'
+  s.summary = 'Creates a fake FTP server for use in testing'
+  s.description = 'Testing FTP? Use this!'
+  s.license = 'MIT'
 
-  s.required_rubygems_version = ">= 1.3.6"
-  
-  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"]
+  s.files = `git ls-files -z`.split("\0")
+  s.test_files = `git ls-files -z -- spec/*`.split("\0")
+  s.require_paths = %w[lib]
 end

data/lib/fake_ftp.rb

@@ -1,5 +1,6 @@
-require 'fake_ftp/server'
-require 'fake_ftp/file'
+# frozen_string_literal: true
 
 module FakeFtp
+  autoload :Server, 'fake_ftp/server'
+  autoload :File, 'fake_ftp/file'
 end

data/lib/fake_ftp/file.rb

@@ -1,23 +1,29 @@
+# frozen_string_literal: true
+
 module FakeFtp
   class File
-    attr_accessor :bytes, :name, :last_modified_time
+    attr_accessor :bytes, :data, :name, :last_modified_time
     attr_writer :type
-    attr_accessor :data
     attr_reader :created
 
-    def initialize(name = nil, data = nil, type = nil, last_modified_time = Time.now)
+    def initialize(name = nil, data = nil, type = nil,
+                   last_modified_time = Time.now)
       @created = Time.now
       @name = name
       @data = data
-      # FIXME this is far too ambiguous. args should not mean different
+      # FIXME: this is far too ambiguous. args should not mean different
       # things in different contexts.
-      data_is_bytes = (data.nil? || Integer === data)
+      data_is_bytes = (data.nil? || data.is_a?(Integer))
       @bytes = data_is_bytes ? data : data.to_s.length
       @data = data_is_bytes ? nil : data
       @type = type
       @last_modified_time = last_modified_time.utc
     end
 
+    def basename
+      ::File.basename(@name)
+    end
+
     def data=(data)
       @data = data
       @bytes = @data.nil? ? nil : data.length

data/lib/fake_ftp/server.rb

@@ -1,63 +1,67 @@
+# frozen_string_literal: true
+
 require 'socket'
 require 'thread'
 require 'timeout'
 
 module FakeFtp
   class Server
+    attr_accessor :client, :command_state, :data_server, :passive_port
+    attr_accessor :port, :store, :workdir
 
-    attr_accessor :port, :passive_port
-    attr_reader :mode, :path
-
-    CMDS = %w(
-      acct
-      cwd
-      cdup
-      dele
-      list
-      mdtm
-      mkd
-      nlst
-      pass
-      pasv
-      port
-      pwd
-      quit
-      size
-      stor
-      retr
-      rnfr
-      rnto
-      type
-      user
-    )
-    LNBK = "\r\n"
+    alias path workdir
 
     def initialize(control_port = 21, data_port = nil, options = {})
-      self.port = control_port
-      self.passive_port = data_port
-      raise(Errno::EADDRINUSE, "#{port}") if !control_port.zero? && is_running?
-      raise(Errno::EADDRINUSE, "#{passive_port}") if passive_port && !passive_port.zero? && is_running?(passive_port)
-      @connection = nil
+      @port = control_port
+      @passive_port = data_port
+      @store = {}
+      @workdir = '/pub'
       @options = options
-      @files = []
-      @mode = :active
-      @path = "/pub"
+      @command_state = {}
+
+      @connection = nil
+      @data_server = nil
+      @server = nil
+      @client = nil
+
+      raise Errno::EADDRINUSE, port.to_s if !control_port.zero? && running?
+
+      if passive_port && !passive_port.zero? && running?(passive_port)
+        raise Errno::EADDRINUSE, passive_port.to_s
+      end
+
+      self.mode = options.fetch(:mode, :active)
+      self.absolute = options.fetch(:absolute, false)
     end
 
     def files
-      @files.map(&:name)
+      @store.values.map do |f|
+        if absolute?
+          abspath(f.name)
+        else
+          f.name
+        end
+      end
     end
 
     def file(name)
-      @files.detect { |file| file.name == name }
+      @store.values.detect do |f|
+        if absolute?
+          abspath(f.name) == name
+        else
+          f.name == name
+        end
+      end
     end
 
     def reset
-      @files.clear
+      @store.clear
     end
 
     def add_file(filename, data, last_modified_time = Time.now)
-      @files << FakeFtp::File.new(::File.basename(filename.to_s), data, @mode, last_modified_time)
+      @store[abspath(filename)] = FakeFtp::File.new(
+        filename.to_s, data, options[:mode], last_modified_time
+      )
     end
 
     def start
@@ -66,20 +70,36 @@ module FakeFtp
       @port = @server.addr[1]
       @thread = Thread.new do
         while @started
-          @client = @server.accept rescue nil
-          if @client
-            respond_with('220 Can has FTP?')
-            @connection = Thread.new(@client) do |socket|
-              while @started && !socket.nil? && !socket.closed?
-                input = socket.gets rescue nil
-                respond_with parse(input) if input
-              end
-              unless @client.nil?
-                @client.close unless @client.closed?
-                @client = nil
+          debug('enter client loop')
+          @client = begin
+                      @server.accept
+                    rescue => e
+                      debug("error on accept: #{e}")
+                      nil
+                    end
+          next unless @client
+          respond_with('220 Can has FTP?')
+          @connection = Thread.new(@client) do |socket|
+            debug('enter request thread')
+            while @started && !socket.nil? && !socket.closed?
+              input = begin
+                        socket.gets
+                      rescue
+                        debug("error on socket.gets: #{e}")
+                        nil
+                      end
+              if input
+                debug("server client raw: <- #{input.inspect}")
+                respond_with(handle_request(input))
               end
             end
+            unless @client.nil?
+              @client.close unless @client.closed?
+              @client = nil
+            end
+            debug('leave request thread')
           end
+          debug('leave client loop')
         end
         unless @server.nil?
           @server.close unless @server.closed?
@@ -87,258 +107,110 @@ module FakeFtp
         end
       end
 
-      if passive_port
-        @data_server = ::TCPServer.new('127.0.0.1', passive_port)
-        @passive_port = @data_server.addr[1]
-      end
+      return unless passive_port
+      @data_server = ::TCPServer.new('127.0.0.1', passive_port)
+      @passive_port = @data_server.addr[1]
     end
 
     def stop
       @started = false
-      @client.close if @client
-      @server.close if @server
+      @client&.close
+      @server&.close
       @server = nil
-      @data_server.close if @data_server
+      @data_server&.close
       @data_server = nil
     end
 
-    def is_running?(tcp_port = nil)
-      tcp_port.nil? ? port_is_open?(port) : port_is_open?(tcp_port)
-    end
-
-    private
-
-    def respond_with(stuff)
-      @client.print stuff << LNBK unless stuff.nil? or @client.nil? or @client.closed?
-    end
-
-    def parse(request)
-      return if request.nil?
-      puts request if @options[:debug]
-      command = request[0, 4].downcase.strip
-      contents = request.split
-      message = contents[1..contents.length]
-      case command
-      when *CMDS
-        __send__ "_#{command}", *message
-      else
-        '500 Unknown command'
-      end
-    end
-
-
-    ## FTP commands
-    #
-    #  Methods are prefixed with an underscore to avoid conflicts with internal server
-    #  methods. Methods map 1:1 to FTP command words.
-    #
-    def _acct(*args)
-      '230 WHATEVER!'
-    end
-
-    def _cwd(*args)
-      @path = args[0]
-      @path = "/#{path}" if path[0].chr != "/"
-      '250 OK!'
-    end
-
-    def _cdup(*args)
-      '250 OK!'
-    end
-
-    def _list(*args)
-      respond_with('425 Ain\'t no data port!') && return if active? && @active_connection.nil?
-
-      respond_with('150 Listing status ok, about to open data connection')
-      data_client = active? ? @active_connection : @data_server.accept
-
-      wildcards = build_wildcards(args)
-      files = matching_files(@files, wildcards)
-
-      files = files.map do |f|
-        "-rw-r--r--\t1\towner\tgroup\t#{f.bytes}\t#{f.created.strftime('%b %d %H:%M')}\t#{f.name}\n"
-      end
-      data_client.write(files.join)
-      data_client.close
-      @active_connection = nil
-
-      '226 List information transferred'
-    end
-
-    def _mdtm(filename = '', local = false)
-      respond_with('501 No filename given') && return if filename.empty?
-      server_file = file(filename)
-      respond_with('550 File not found') && return if server_file.nil?
-
-      respond_with("213 #{server_file.last_modified_time.strftime("%Y%m%d%H%M%S")}")
+    def running?(tcp_port = nil)
+      return port_is_open?(port) if tcp_port.nil?
+      port_is_open?(tcp_port)
     end
 
-    def _nlst(*args)
-      respond_with('425 Ain\'t no data port!') && return if active? && @active_connection.nil?
-
-      respond_with('150 Listing status ok, about to open data connection')
-      data_client = active? ? @active_connection : @data_server.accept
+    alias is_running? running?
 
-      wildcards = build_wildcards(args)
-      files = matching_files(@files, wildcards)
-
-      files = files.map do |file|
-        "#{file.name}\n"
+    def mode=(value)
+      unless %i[active passive].include?(value)
+        raise ArgumentError, "invalid mode #{value.inspect}"
       end
-
-      data_client.write(files.join)
-      data_client.close
-      @active_connection = nil
-
-      '226 List information transferred'
+      options[:mode] = value
     end
 
-    def _pass(*args)
-      '230 logged in'
+    def mode
+      options[:mode]
     end
 
-    def _pasv(*args)
-      if passive_port
-        @mode = :passive
-        p1 = (passive_port / 256).to_i
-        p2 = passive_port % 256
-        "227 Entering Passive Mode (127,0,0,1,#{p1},#{p2})"
-      else
-        '502 Aww hell no, use Active'
-      end
+    def absolute?
+      options[:absolute]
     end
 
-    def _port(remote = '')
-      remote = remote.split(',')
-      remote_port = remote[4].to_i * 256 + remote[5].to_i
-      unless @active_connection.nil?
-        @active_connection.close
-        @active_connection = nil
+    def absolute=(value)
+      unless [true, false].include?(value)
+        raise ArgumentError, "invalid absolute #{value}"
       end
-      @mode = :active
-      @active_connection = ::TCPSocket.open('127.0.0.1', remote_port)
-      '200 Okay'
+      options[:absolute] = value
     end
 
-    def _pwd(*args)
-      "257 \"#{path}\" is current directory"
-    end
+    attr_reader :options
+    private :options
 
-    def _quit(*args)
-      respond_with '221 OMG bye!'
-      @client.close if @client
-      @client = nil
+    def abspath(filename)
+      return filename if filename.start_with?('/')
+      [@workdir.to_s, filename].join('/').gsub('//', '/')
     end
 
-    def _retr(filename = '')
-      respond_with('501 No filename given') if filename.empty?
-
-      file = file(::File.basename(filename.to_s))
-      return respond_with('550 File not found') if file.nil?
-
-      respond_with('425 Ain\'t no data port!') && return if active? && @active_connection.nil?
-
-      respond_with('150 File status ok, about to open data connection')
-      data_client = active? ? @active_connection : @data_server.accept
-
-      data_client.write(file.data)
-
-      data_client.close
-      @active_connection = nil
-      '226 File transferred'
-    end
-
-    def _rnfr(rename_from='')
-      return '501 Send path name.' if rename_from.nil? || rename_from.size < 1
-
-      @rename_from = rename_from
-      '350 Send RNTO to complete rename.'
-    end
-
-    def _rnto(rename_to='')
-      return '501 Send path name.' if rename_to.nil? || rename_to.size < 1
-
-      return '503 Send RNFR first.' unless @rename_from
-
-      if file = file(@rename_from)
-        file.name = rename_to
-        @rename_from = nil
-        '250 Path renamed.'
-      else
-        @rename_from = nil
-        '550 File not found.'
-      end
-    end
-
-    def _size(filename)
-      file_size = file(filename).bytes
-      respond_with("213 #{file_size}")
-    end
-
-    def _stor(filename = '')
-      respond_with('425 Ain\'t no data port!') && return if active? && @active_connection.nil?
-
-      respond_with('125 Do it!')
-      data_client = active? ? @active_connection : @data_server.accept
-
-      data = data_client.read(nil).chomp
-      file = FakeFtp::File.new(::File.basename(filename.to_s), data, @mode)
-      @files << file
-
-      data_client.close
-      @active_connection = nil
-      '226 Did it!'
+    def respond_with(stuff)
+      return if stuff.nil? || @client.nil? || @client.closed?
+      debug("server client raw: -> #{stuff.inspect}")
+      @client.print(stuff + "\r\n")
     end
 
-    def _dele(filename = '')
-      files_to_delete = @files.select{ |file| file.name == filename }
-      return '550 Delete operation failed.' if files_to_delete.count == 0
-
-      @files = @files - files_to_delete
+    private def handle_request(request)
+      return if request.nil?
+      debug("raw request: #{request.inspect}")
+      command = request[0, 4].downcase.strip
+      contents = request.split
+      message = contents[1..contents.length]
 
-      '250 Delete operation successful.'
+      inst = load_command_instance(command)
+      return "500 Unknown command #{command.inspect}" if inst.nil?
+      debug(
+        "running command #{command.inspect} " \
+        "#{inst.class.name}#run(*#{message.inspect})"
+      )
+      inst.run(*([self] + message))
     end
 
-    def _type(type = 'A')
-      case type.to_s
-      when 'A'
-        '200 Type set to A.'
-      when 'I'
-        '200 Type set to I.'
-      else
-        '504 We don\'t allow those'
+    private def load_command_instance(command)
+      require "fake_ftp/server_commands/#{command}"
+      FakeFtp::ServerCommands.constants.each do |const_name|
+        next unless const_name.to_s.downcase == command
+        return FakeFtp::ServerCommands.const_get(const_name).new
       end
-    end
-
-    def _user(name = '')
-      (name.to_s == 'anonymous') ? '230 logged in' : '331 send your password'
-    end
-
-    def _mkd(directory)
-      "257 OK!"
+      nil
+    rescue LoadError => e
+      debug("failed to require #{command.inspect} class: #{e}")
+      nil
     end
 
     def active?
-      @mode == :active
+      options[:mode] == :active
     end
 
-    private
-
-    def port_is_open?(port)
+    private def port_is_open?(port)
       begin
-        Timeout::timeout(1) do
+        Timeout.timeout(1) do
           begin
-            s = TCPSocket.new("127.0.0.1", port)
-            s.close
+            TCPSocket.new('127.0.0.1', port).close
             return true
           rescue Errno::ECONNREFUSED, Errno::EHOSTUNREACH
             return false
           end
         end
-      rescue Timeout::Error
+      rescue Timeout::Error => e
+        debug("timeout while checking port #{port}: #{e}")
       end
 
-      return false
+      false
     end
 
     def build_wildcards(args)
@@ -350,14 +222,19 @@ module FakeFtp
       wildcards
     end
 
-    def matching_files(files, wildcards)
-      if not wildcards.empty?
-        files.select do |f|
+    def matching_files(wildcards)
+      if !wildcards.empty?
+        @store.values.select do |f|
           wildcards.any? { |wildcard| f.name =~ /#{wildcard}/ }
         end
       else
-        files
+        @store.values
       end
     end
+
+    def debug(msg)
+      return unless options[:debug]
+      $stderr.puts("DEBUG:fake_ftp:#{msg}")
+    end
   end
 end