ftpd 0.2.0 → 0.2.1

data/features/step_definitions/{directories.rb → directory_navigation.rb}

@@ -20,3 +20,7 @@ end
 Then /^the current directory should be "(.*?)"$/ do |path|
   @client.pwd.should == path
 end
+
+Then /^the XPWD directory should be "(.*?)"$/ do |path|
+  @client.xpwd.should == path
+end

data/features/step_definitions/error_replies.rb

@@ -13,10 +13,6 @@ Then /^the server returns a "(.*?)" error$/ do |error_message|
   (@error || '').should include error_message
 end
 
-Then /^the server returns a no such file error$/ do
-  step 'the server returns a "550 No such file or directory" error'
-end
-
 Then /^the server returns a not a directory error$/ do
   step 'the server returns a "550 Not a directory" error'
 end
@@ -90,5 +86,9 @@ Then /^the server returns an unimplemented command error$/ do
 end
 
 Then /^the server returns an action not taken error$/ do
-  step 'the server returns a "450 Unable to do it" error'
+  step 'the server returns a "550 Unable to do it" error'
+end
+
+Then /^the server returns an already exists error$/ do
+  step 'the server returns a "550 Already exists" error'
 end

data/features/step_definitions/login.rb

@@ -9,11 +9,11 @@ def login(user, password, client_name = nil)
   end
 end
 
-Given /^a successful connection( with TLS)?$/ do |with_tls|
+Given /^a successful connection( with \w+ TLS)?$/ do |with_tls|
   step "the client connects#{with_tls}"
 end
 
-Given /^a successful login( with TLS)?$/ do |with_tls|
+Given /^a successful login( with \w+ TLS)?$/ do |with_tls|
   step "a successful connection#{with_tls}"
   step 'the client logs in'
 end

data/features/step_definitions/mkdir.rb

@@ -0,0 +1,9 @@
+When /^the client makes directory "(.*?)"$/ do |path|
+  capture_error do
+    step %Q(the client successfully makes directory "#{path}")
+  end
+end
+
+When /^the client successfully makes directory "(.*?)"$/ do |path|
+  mkdir_response = @client.mkdir path
+end

data/features/step_definitions/rename.rb

@@ -0,0 +1,11 @@
+When /^the client renames "(.*?)" to "(.*?)"$/ do
+|from_path, to_path|
+  capture_error do
+    step %Q'the client successfully renames "#{from_path}" to "#{to_path}"'
+  end
+end
+
+When /^the client successfully renames "(.*?)" to "(.*?)"$/ do
+|from_path, to_path|
+  @client.rename(from_path, to_path)
+end

data/features/step_definitions/rmdir.rb

@@ -0,0 +1,9 @@
+When /^the client removes directory "(.*?)"$/ do |path|
+  capture_error do
+    step %Q(the client successfully removes directory "#{path}")
+  end
+end
+
+When /^the client successfully removes directory "(.*?)"$/ do |path|
+  mkdir_response = @client.rmdir path
+end

data/features/step_definitions/server_files.rb

@@ -15,6 +15,15 @@ Then /^the server should( not)? have file "(.*?)"$/ do |neg, path|
   @server.has_file?(path).should send(matcher)
 end
 
+Then /^the server should( not)? have directory "(.*?)"$/ do |neg, path|
+  matcher = if neg
+              :be_false
+            else
+              :be_true
+            end
+  @server.has_directory?(path).should send(matcher)
+end
+
 Then /^the remote file "(.*?)" should have (unix|windows) line endings$/ do
 |remote_path, line_ending_type|
   line_ending_type(@server.file_contents(remote_path)).should ==

data/features/support/test_client.rb

@@ -24,10 +24,13 @@ class TestClient
   :gettextfile,
   :login,
   :ls,
+  :mkdir,
   :nlst,
   :noop,
   :passive=,
   :pwd,
+  :rename,
+  :rmdir,
   :quit,
   :system
 
@@ -57,6 +60,11 @@ class TestClient
     File.open(temp_path(path), 'rb', &:read)
   end
 
+  def xpwd
+    response = raw('XPWD')
+    response[/"(.+)"/, 1]
+  end
+
   private
 
   RAW_METHOD_REGEX = /^send_(.*)$/
@@ -70,20 +78,26 @@ class TestClient
   end
 
   def make_ftp(opts)
-    tls = opts[:tls]
-    if tls
-      make_tls_ftp
-    else
+    tls_mode = opts[:tls] || :off
+    case tls_mode
+    when :off
       make_non_tls_ftp
+    when :implicit
+      make_tls_ftp(:implicit)
+    when :explicit
+      make_tls_ftp(:explicit)
+    else
+      raise "Unknown TLS mode: #{tls_mode}"
     end
   end
 
-  def make_tls_ftp
+  def make_tls_ftp(ftps_mode)
     ftp = DoubleBagFTPS.new
     context_opts = {
       :verify_mode => OpenSSL::SSL::VERIFY_NONE
     }
     ftp.ssl_context = DoubleBagFTPS.create_ssl_context(context_opts)
+    ftp.ftps_mode = ftps_mode
     ftp
   end
 

data/features/support/test_server.rb

@@ -15,16 +15,22 @@ class TestServer
 
     attr_accessor :delete
     attr_accessor :list
+    attr_accessor :mkdir
     attr_accessor :name_list
     attr_accessor :read
+    attr_accessor :rename
+    attr_accessor :rmdir
     attr_accessor :write
 
     def initialize(temp_dir)
       @temp_dir = temp_dir
       @delete = true
       @list = true
+      @mkdir = true
       @name_list = true
       @read = true
+      @rename = true
+      @rmdir = true
       @write = true
     end
 
@@ -36,8 +42,11 @@ class TestServer
       TestServerFileSystem.new(@temp_dir,
                                :delete => @delete,
                                :list => @list,
+                               :mkdir => @mkdir,
                                :name_list => @name_list,
                                :read => @read,
+                               :rename => @rename,
+                               :rmdir => @rmdir,
                                :write => @write)
     end
 
@@ -88,7 +97,7 @@ class TestServer
         define_method method_name do |*args|
           ftp_path = args.first
           if force_file_system_error?(ftp_path)
-            raise Ftpd::FileSystemError, 'Unable to do it'
+            raise Ftpd::PermanentFileSystemError, 'Unable to do it'
           end
           original_method.bind(self).call *args
         end
@@ -142,11 +151,24 @@ class TestServer
           include Ftpd::DiskFileSystem::NameList
         end
 
+        if opts[:mkdir]
+          include Ftpd::DiskFileSystem::Mkdir
+        end
+
         if opts[:read]
           include Ftpd::DiskFileSystem::Read
           raise_on_file_system_error :read
         end
 
+        if opts[:rename]
+          include Ftpd::DiskFileSystem::Rename
+          raise_on_file_system_error :rename
+        end
+
+        if opts[:rmdir]
+          include Ftpd::DiskFileSystem::Rmdir
+        end
+
         if opts[:write]
           include Ftpd::DiskFileSystem::Write
           raise_on_file_system_error :write
@@ -195,8 +217,11 @@ class TestServer
 
   def_delegator :@driver, :'delete='
   def_delegator :@driver, :'list='
+  def_delegator :@driver, :'mkdir='
   def_delegator :@driver, :'name_list='
+  def_delegator :@driver, :'rmdir='
   def_delegator :@driver, :'read='
+  def_delegator :@driver, :'rename='
   def_delegator :@driver, :'write='
 
   def start
@@ -207,8 +232,8 @@ class TestServer
     @server.stop
   end
 
-  def wrote_debug_output?
-    File.size(@debug_file.path) > 0
+  def debug_output
+    IO.read(@debug_file.path)
   end
 
   def host

data/features/support/test_server_files.rb

@@ -18,6 +18,11 @@ module TestServerFiles
     File.exists?(full_path)
   end
 
+  def has_directory?(path)
+    full_path = temp_path(path)
+    File.directory?(full_path)
+  end
+
   def file_contents(path)
     full_path = temp_path(path)
     File.open(full_path, 'rb', &:read)

data/ftpd.gemspec

@@ -5,12 +5,12 @@
 
 Gem::Specification.new do |s|
   s.name = "ftpd"
-  s.version = "0.2.0"
+  s.version = "0.2.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Wayne Conrad"]
-  s.date = "2013-02-24"
-  s.description = "ftpd is a pure Ruby FTP server library.  It supports implicit and explicit TLS, and can be used as part of a test fixture or to embed in another program."
+  s.date = "2013-02-28"
+  s.description = "ftpd is a pure Ruby FTP server library.  It supports implicit and explicit TLS, passive and active mode, and most of the commands specified in RFC 969.  It an be used as part of a test fixture or embedded in a program."
   s.email = "wconrad@yagni.com"
   s.extra_rdoc_files = [
     "LICENSE.md",
@@ -24,11 +24,13 @@ Gem::Specification.new do |s|
     "README.md",
     "Rakefile",
     "VERSION",
+    "doc/rfc.md",
     "examples/example.rb",
     "examples/hello_world.rb",
     "features/example/example.feature",
     "features/example/step_definitions/example_server.rb",
     "features/ftp_server/allo.feature",
+    "features/ftp_server/cdup.feature",
     "features/ftp_server/command_errors.feature",
     "features/ftp_server/concurrent_sessions.feature",
     "features/ftp_server/debug.feature",
@@ -37,9 +39,11 @@ Gem::Specification.new do |s|
     "features/ftp_server/file_structure.feature",
     "features/ftp_server/get.feature",
     "features/ftp_server/get_tls.feature",
+    "features/ftp_server/implicit_tls.feature",
     "features/ftp_server/list.feature",
     "features/ftp_server/list_tls.feature",
     "features/ftp_server/login.feature",
+    "features/ftp_server/mkdir.feature",
     "features/ftp_server/mode.feature",
     "features/ftp_server/name_list.feature",
     "features/ftp_server/name_list_tls.feature",
@@ -48,6 +52,8 @@ Gem::Specification.new do |s|
     "features/ftp_server/put.feature",
     "features/ftp_server/put_tls.feature",
     "features/ftp_server/quit.feature",
+    "features/ftp_server/rename.feature",
+    "features/ftp_server/rmdir.feature",
     "features/ftp_server/step_definitions/debug.rb",
     "features/ftp_server/step_definitions/test_server.rb",
     "features/ftp_server/syntax_errors.feature",
@@ -59,7 +65,7 @@ Gem::Specification.new do |s|
     "features/step_definitions/command.rb",
     "features/step_definitions/connect.rb",
     "features/step_definitions/delete.rb",
-    "features/step_definitions/directories.rb",
+    "features/step_definitions/directory_navigation.rb",
     "features/step_definitions/error_replies.rb",
     "features/step_definitions/file_structure.rb",
     "features/step_definitions/generic_send.rb",
@@ -68,12 +74,15 @@ Gem::Specification.new do |s|
     "features/step_definitions/line_endings.rb",
     "features/step_definitions/list.rb",
     "features/step_definitions/login.rb",
+    "features/step_definitions/mkdir.rb",
     "features/step_definitions/mode.rb",
     "features/step_definitions/noop.rb",
     "features/step_definitions/passive.rb",
     "features/step_definitions/port.rb",
     "features/step_definitions/put.rb",
     "features/step_definitions/quit.rb",
+    "features/step_definitions/rename.rb",
+    "features/step_definitions/rmdir.rb",
     "features/step_definitions/server_files.rb",
     "features/step_definitions/stop_server.rb",
     "features/step_definitions/success_replies.rb",
@@ -109,7 +118,6 @@ Gem::Specification.new do |s|
     "rake_tasks/spec.rake",
     "rake_tasks/test.rake",
     "rake_tasks/yard.rake",
-    "sandbox/em-server.rb",
     "spec/disk_file_system_spec.rb",
     "spec/exception_translator_spec.rb",
     "spec/file_system_error_translator_spec.rb",
@@ -119,7 +127,7 @@ Gem::Specification.new do |s|
   s.homepage = "http://github.com/wconrad/ftpd"
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
-  s.rubygems_version = "1.8.25"
+  s.rubygems_version = "1.8.24"
   s.summary = "Pure Ruby FTP server library"
 
   if s.respond_to? :specification_version then
@@ -131,6 +139,7 @@ Gem::Specification.new do |s|
       s.add_development_dependency(%q<double-bag-ftps>, [">= 0"])
       s.add_development_dependency(%q<jeweler>, [">= 0"])
       s.add_development_dependency(%q<rake>, [">= 0"])
+      s.add_development_dependency(%q<redcarpet>, [">= 0"])
       s.add_development_dependency(%q<rspec>, [">= 0"])
       s.add_development_dependency(%q<yard>, [">= 0"])
     else
@@ -139,6 +148,7 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<double-bag-ftps>, [">= 0"])
       s.add_dependency(%q<jeweler>, [">= 0"])
       s.add_dependency(%q<rake>, [">= 0"])
+      s.add_dependency(%q<redcarpet>, [">= 0"])
       s.add_dependency(%q<rspec>, [">= 0"])
       s.add_dependency(%q<yard>, [">= 0"])
     end
@@ -148,6 +158,7 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<double-bag-ftps>, [">= 0"])
     s.add_dependency(%q<jeweler>, [">= 0"])
     s.add_dependency(%q<rake>, [">= 0"])
+    s.add_dependency(%q<redcarpet>, [">= 0"])
     s.add_dependency(%q<rspec>, [">= 0"])
     s.add_dependency(%q<yard>, [">= 0"])
   end

data/lib/ftpd.rb

@@ -10,6 +10,7 @@ module Ftpd
   autoload :Error,                     'ftpd/error'
   autoload :ExceptionTranslator,       'ftpd/exception_translator'
   autoload :FileSystemErrorTranslator, 'ftpd/file_system_error_translator'
+  autoload :FileSystemMethodMissing,   'ftpd/file_system_method_missing'
   autoload :FtpServer,                 'ftpd/ftp_server'
   autoload :InsecureCertificate,       'ftpd/insecure_certificate'
   autoload :Server,                    'ftpd/server'

data/lib/ftpd/disk_file_system.rb

@@ -17,8 +17,8 @@ module Ftpd
       # Expand an ftp_path to an absolute file system path.
       #
       # ftp_path is an absolute path relative to the FTP file system.
-      # @data_dir is an absolute path relative to the disk file system.
-      # The return value is an absolute path relative to the disk file system.
+      # The return value is an absolute path relative to the disk file
+      # system.
 
       def expand_ftp_path(ftp_path)
         File.expand_path(File.join(@data_dir, ftp_path))
@@ -44,6 +44,8 @@ module Ftpd
       # * RETR
       # * DELE
       # * CWD
+      # * MKD
+      # * RMD
 
       def accessible?(ftp_path)
         # The server should never try to access a path outside of the
@@ -59,6 +61,7 @@ module Ftpd
       # * RETR
       # * DELE
       # * CWD
+      # * MKD
 
       def exists?(ftp_path)
         File.exists?(expand_ftp_path(ftp_path))
@@ -68,6 +71,7 @@ module Ftpd
       #
       # Called for:
       # * CWD
+      # * MKD
 
       def directory?(ftp_path)
         File.directory?(expand_ftp_path(ftp_path))
@@ -84,7 +88,7 @@ module Ftpd
 
       include TranslateExceptions
 
-      # Remove a file.  Can raise FileSystemError.
+      # Remove a file.
       #
       # Called for:
       # * DELE
@@ -107,7 +111,7 @@ module Ftpd
 
       include TranslateExceptions
 
-      # Read a file into memory.  Can raise FileSystemError.
+      # Read a file into memory.
       #
       # Called for:
       # * RETR
@@ -130,7 +134,7 @@ module Ftpd
 
       include TranslateExceptions
 
-      # Write a file to disk.  Can raise FileSystemError.
+      # Write a file to disk.
       #
       # Called for:
       # * STOR
@@ -147,6 +151,54 @@ module Ftpd
     end
   end
 
+  class DiskFileSystem
+
+    # DiskFileSystem mixing providing mkdir
+
+    module Mkdir
+
+      include TranslateExceptions
+
+      # Create a directory.
+      #
+      # Called for:
+      # * MKD
+      #
+      # If missing, then these commands are not supported.
+
+      def mkdir(ftp_path)
+        Dir.mkdir expand_ftp_path(ftp_path)
+      end
+      translate_exceptions :mkdir
+
+    end
+
+  end
+
+  class DiskFileSystem
+
+    # DiskFileSystem mixing providing mkdir
+
+    module Rmdir
+
+      include TranslateExceptions
+
+      # Remove a directory.
+      #
+      # Called for:
+      # * RMD
+      #
+      # If missing, then these commands are not supported.
+
+      def rmdir(ftp_path)
+        Dir.rmdir expand_ftp_path(ftp_path)
+      end
+      translate_exceptions :rmdir
+
+    end
+
+  end
+
   class DiskFileSystem
 
     # Ls interface used by List and NameList
@@ -186,10 +238,10 @@ module Ftpd
 
       include TranslateExceptions
 
-      # Get a file list, long form.  Can raise FileSystemError.  This
-      # returns a long-form directory listing.  The FTP standard does
-      # not specify the format of the listing, but many systems emit a
-      # *nix style directory listing:
+      # Get a file list, long form.  This returns a long-form
+      # directory listing.  The FTP standard does not specify the
+      # format of the listing, but many systems emit a *nix style
+      # directory listing:
       #
       #     -rw-r--r-- 1 wayne wayne 4 Feb 18 18:36 a
       #     -rw-r--r-- 1 wayne wayne 8 Feb 18 18:36 b
@@ -234,7 +286,7 @@ module Ftpd
 
       include Ls
 
-      # Get a file list, short form.  Can raise FileSystemError.
+      # Get a file list, short form.
       #
       # This returns one filename per line, and nothing else
       #
@@ -250,6 +302,30 @@ module Ftpd
     end
   end
 
+  class DiskFileSystem
+
+    # DiskFileSystem mixin providing file/directory rename/move
+
+    module Rename
+
+      include TranslateExceptions
+
+      # Rename or move a file or directory
+      #
+      # Called for:
+      # * RNTO
+      #
+      # If missing, then these commands are not supported.
+
+      def rename(from_ftp_path, to_ftp_path)
+        FileUtils.mv(expand_ftp_path(from_ftp_path),
+                     expand_ftp_path(to_ftp_path))
+      end
+      translate_exceptions :rename
+
+    end
+  end
+
   class DiskFileSystem
 
     # DiskFileSystem "omnibus" mixin, which pulls in mixins which are
@@ -266,15 +342,17 @@ module Ftpd
   # An FTP file system mapped to a disk directory.  This can serve as
   # a template for creating your own specialized driver.
   #
-  # Some methods may raise FileSystemError; some may not.  The
-  # predicates (methods ending with a question mark) may not; other
-  # methods may.  FileSystemError is the _only_ exception which a file
-  # system driver may raise.
+  # Any method may raise a PermanentFileSystemError (e.g. "file not
+  # found") or TransientFileSystemError (e.g. "file busy").  A
+  # PermanentFileSystemError will cause a "550" error response to be
+  # sent; a TransientFileSystemError will cause a "450" error response
+  # to be sent.
   #
   # The class is divided into modules that may be included piecemeal.
   # By including some mixins and not others, you can compose a disk
-  # file system driver "a la cart."  This is useful if you want an FTP
-  # server that, for example, allows reading but not writing files.
+  # file system driver "a la carte."  This is useful if you want an
+  # FTP server that, for example, allows reading but not writing
+  # files.
 
   class DiskFileSystem
 
@@ -286,8 +364,11 @@ module Ftpd
 
     include DiskFileSystem::Delete
     include DiskFileSystem::List
+    include DiskFileSystem::Mkdir
     include DiskFileSystem::NameList
     include DiskFileSystem::Read
+    include DiskFileSystem::Rename
+    include DiskFileSystem::Rmdir
     include DiskFileSystem::Write
 
     # Make a new instance to serve a directory.  data_dir should be an