ftpd 0.1.1 → 0.2.0

data/ftpd.gemspec

@@ -5,18 +5,19 @@
 
 Gem::Specification.new do |s|
   s.name = "ftpd"
-  s.version = "0.1.1"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Wayne Conrad"]
-  s.date = "2013-02-23"
-  s.description = "ftpd is a pure Ruby FTP server library.  It supports implicit and explicit TLS, and is suitable for use by a program such as a test fixture or small FTP daemon."
+  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.email = "wconrad@yagni.com"
   s.extra_rdoc_files = [
     "LICENSE.md",
     "README.md"
   ]
   s.files = [
+    "Changelog.md",
     "Gemfile",
     "Gemfile.lock",
     "LICENSE.md",
@@ -27,6 +28,7 @@ Gem::Specification.new do |s|
     "examples/hello_world.rb",
     "features/example/example.feature",
     "features/example/step_definitions/example_server.rb",
+    "features/ftp_server/allo.feature",
     "features/ftp_server/command_errors.feature",
     "features/ftp_server/concurrent_sessions.feature",
     "features/ftp_server/debug.feature",
@@ -49,6 +51,7 @@ Gem::Specification.new do |s|
     "features/ftp_server/step_definitions/debug.rb",
     "features/ftp_server/step_definitions/test_server.rb",
     "features/ftp_server/syntax_errors.feature",
+    "features/ftp_server/syst.feature",
     "features/ftp_server/type.feature",
     "features/step_definitions/client.rb",
     "features/step_definitions/client_and_server_files.rb",
@@ -57,8 +60,9 @@ Gem::Specification.new do |s|
     "features/step_definitions/connect.rb",
     "features/step_definitions/delete.rb",
     "features/step_definitions/directories.rb",
-    "features/step_definitions/error.rb",
+    "features/step_definitions/error_replies.rb",
     "features/step_definitions/file_structure.rb",
+    "features/step_definitions/generic_send.rb",
     "features/step_definitions/get.rb",
     "features/step_definitions/invalid_commands.rb",
     "features/step_definitions/line_endings.rb",
@@ -72,6 +76,8 @@ Gem::Specification.new do |s|
     "features/step_definitions/quit.rb",
     "features/step_definitions/server_files.rb",
     "features/step_definitions/stop_server.rb",
+    "features/step_definitions/success_replies.rb",
+    "features/step_definitions/system.rb",
     "features/step_definitions/type.rb",
     "features/support/env.rb",
     "features/support/example_server.rb",
@@ -106,6 +112,7 @@ Gem::Specification.new do |s|
     "sandbox/em-server.rb",
     "spec/disk_file_system_spec.rb",
     "spec/exception_translator_spec.rb",
+    "spec/file_system_error_translator_spec.rb",
     "spec/spec_helper.rb",
     "spec/translate_exceptions_spec.rb"
   ]

data/lib/ftpd/disk_file_system.rb

@@ -1,136 +1,301 @@
 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.
-
   class DiskFileSystem
 
-    include TranslateExceptions
+    # DiskFileSystem mixin for path expansion.  Used by every command
+    # that accesses the disk file system.
 
-    # Make a new instance to serve a directory.  data_dir should be
-    # fully qualified.
+    module PathExpansion
 
-    def initialize(data_dir)
-      @data_dir = data_dir
-      translate_exception SystemCallError
-    end
+      # Set the data directory, the root of the disk file system.
+      # data_dir should be an absolute path.
 
-    # Return true if the path is accessible to the user.  This will be
-    # called for put, get and directory lists, so the file or
-    # directory named by the path may not exist.
+      def set_data_dir(data_dir)
+        @data_dir = data_dir
+      end
 
-    def accessible?(ftp_path)
-      # The server should never try to access a path outside of the
-      # directory (such as '../foo'), but if it does, we'll catch it
-      # here.
-      expand_ftp_path(ftp_path).start_with?(@data_dir)
-    end
+      # 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.
 
-    # Return true if the file or directory path exists.
+      def expand_ftp_path(ftp_path)
+        File.expand_path(File.join(@data_dir, ftp_path))
+      end
 
-    def exists?(ftp_path)
-      File.exists?(expand_ftp_path(ftp_path))
     end
+  end
+
+  class DiskFileSystem
+
+    # DiskFileSystem mixin providing file attributes.  These are used,
+    # alone or in combination, by nearly every command that accesses the
+    # disk file system.
+
+    module Accessors
+
+      # Return true if the path is accessible to the user.  This will be
+      # called for put, get and directory lists, so the file or
+      # directory named by the path may not exist.
+      #
+      # Called for:
+      # * STOR
+      # * RETR
+      # * DELE
+      # * CWD
+
+      def accessible?(ftp_path)
+        # The server should never try to access a path outside of the
+        # directory (such as '../foo'), but if it does, we'll catch it
+        # here.
+        expand_ftp_path(ftp_path).start_with?(@data_dir)
+      end
+
+      # Return true if the file or directory path exists.
+      #
+      # Called for:
+      # * STOR (with directory)
+      # * RETR
+      # * DELE
+      # * CWD
+
+      def exists?(ftp_path)
+        File.exists?(expand_ftp_path(ftp_path))
+      end
+
+      # Return true if the path exists and is a directory.
+      #
+      # Called for:
+      # * CWD
 
-    # Return true if the path exists and is a directory.
+      def directory?(ftp_path)
+        File.directory?(expand_ftp_path(ftp_path))
+      end
 
-    def directory?(ftp_path)
-      File.directory?(expand_ftp_path(ftp_path))
     end
+  end
+
+  class DiskFileSystem
+
+    # DiskFileSystem mixin providing file deletion
+
+    module Delete
+
+      include TranslateExceptions
 
-    # Remove a file.  Can raise FileSystemError.
+      # Remove a file.  Can raise FileSystemError.
+      #
+      # Called for:
+      # * DELE
+      #
+      # If missing, then these commands are not supported.
+
+      def delete(ftp_path)
+        FileUtils.rm expand_ftp_path(ftp_path)
+      end
+      translate_exceptions :delete
 
-    def delete(ftp_path)
-      FileUtils.rm expand_ftp_path(ftp_path)
     end
-    translate_exceptions :delete
+  end
+
+  class DiskFileSystem
+
+    # DiskFileSystem mixin providing file reading
 
-    # Read a file into memory.  Can raise FileSystemError.
+    module Read
+
+      include TranslateExceptions
+
+      # Read a file into memory.  Can raise FileSystemError.
+      #
+      # Called for:
+      # * RETR
+      #
+      # If missing, then these commands are not supported.
+
+      def read(ftp_path)
+        File.open(expand_ftp_path(ftp_path), 'rb', &:read)
+      end
+      translate_exceptions :read
 
-    def read(ftp_path)
-      File.open(expand_ftp_path(ftp_path), 'rb', &:read)
     end
-    translate_exceptions :read
+  end
+
+  class DiskFileSystem
 
-    # Write a file to disk.  Can raise FileSystemError.
+    # DiskFileSystem mixin providing file writing
 
-    def write(ftp_path, contents)
-      File.open(expand_ftp_path(ftp_path), 'wb') do |file|
-        file.write contents
+    module Write
+
+      include TranslateExceptions
+
+      # Write a file to disk.  Can raise FileSystemError.
+      #
+      # Called for:
+      # * STOR
+      #
+      # If missing, then these commands are not supported.
+
+      def write(ftp_path, contents)
+        File.open(expand_ftp_path(ftp_path), 'wb') do |file|
+          file.write contents
+        end
       end
+      translate_exceptions :write
+
     end
-    translate_exceptions :write
-
-    # 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:
-    #
-    #     -rw-r--r-- 1 wayne wayne 4 Feb 18 18:36 a
-    #     -rw-r--r-- 1 wayne wayne 8 Feb 18 18:36 b
-    #
-    # some emit a Windows style listing.  Some emit EPLF (Easily
-    # Parsed List Format):
-    #
-    #     +i8388621.48594,m825718503,r,s280, djb.html
-    #     +i8388621.50690,m824255907,/, 514
-    #     +i8388621.48598,m824253270,r,s612, 514.html
-    #
-    # EPLF is a draft internet standard for the output of LIST:
-    #
-    #     http://cr.yp.to/ftp/list/eplf.html
-    #
-    # Some FTP clients know how to parse EPLF; those clients will
-    # display the EPLF in a more user-friendly format.  Clients that
-    # don't recognize EPLF will display it raw.  The advantages of
-    # EPLF are that it's easier for clients to parse, and the client
-    # can display the LIST output in any format it likes.
-    #
-    # This class emits a *nix style listing.  It does so by shelling
-    # to the "ls" command, so it won't run on Windows at all.
-
-    def list_long(ftp_path)
-      ls(ftp_path, '-l')
+  end
+
+  class DiskFileSystem
+
+    # Ls interface used by List and NameList
+
+    module Ls
+
+      def ls(ftp_path, option)
+        path = expand_ftp_path(ftp_path)
+        dirname = File.dirname(path)
+        filename = File.basename(path)
+        command = [
+          'ls',
+          option,
+          filename,
+          '2>&1',
+        ].compact.join(' ')
+        if File.exists?(dirname)
+          list = Dir.chdir(dirname) do
+            `#{command}`
+          end
+        else
+          list = ''
+        end
+        list = "" if $? != 0
+        list = list.gsub(/^total \d+\n/, '')
+      end
+
     end
 
-    # Get a file list, short form.  Can raise FileSystemError.
-    #
-    # This returns one filename per line, and nothing else
+  end
+
+  class DiskFileSystem
+
+    # DiskFileSystem mixin providing directory listing
+
+    module List
+
+      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:
+      #
+      #     -rw-r--r-- 1 wayne wayne 4 Feb 18 18:36 a
+      #     -rw-r--r-- 1 wayne wayne 8 Feb 18 18:36 b
+      #
+      # some emit a Windows style listing.  Some emit EPLF (Easily
+      # Parsed List Format):
+      #
+      #     +i8388621.48594,m825718503,r,s280, djb.html
+      #     +i8388621.50690,m824255907,/, 514
+      #     +i8388621.48598,m824253270,r,s612, 514.html
+      #
+      # EPLF is a draft internet standard for the output of LIST:
+      #
+      #     http://cr.yp.to/ftp/list/eplf.html
+      #
+      # Some FTP clients know how to parse EPLF; those clients will
+      # display the EPLF in a more user-friendly format.  Clients that
+      # don't recognize EPLF will display it raw.  The advantages of
+      # EPLF are that it's easier for clients to parse, and the client
+      # can display the LIST output in any format it likes.
+      #
+      # This class emits a *nix style listing.  It does so by shelling
+      # to the "ls" command, so it won't run on Windows at all.
+      #
+      # Called for:
+      # * LIST
+      #
+      # If missing, then these commands are not supported.
+
+      def list(ftp_path)
+        ls(ftp_path, '-l')
+      end
 
-    def list_short(ftp_path)
-      ls(ftp_path, '-1')
     end
+  end
 
-    private
-
-    def ls(ftp_path, option)
-      path = expand_ftp_path(ftp_path)
-      dirname = File.dirname(path)
-      filename = File.basename(path)
-      command = [
-        'ls',
-        option,
-        filename,
-        '2>&1',
-      ].compact.join(' ')
-      if File.exists?(dirname)
-        list = Dir.chdir(dirname) do
-          `#{command}`
-        end
-      else
-        list = ''
+  class DiskFileSystem
+
+    # DiskFileSystem mixin providing directory name listing
+
+    module NameList
+
+      include Ls
+
+      # Get a file list, short form.  Can raise FileSystemError.
+      #
+      # This returns one filename per line, and nothing else
+      #
+      # Called for:
+      # * NLST
+      #
+      # If missing, then these commands are not supported.
+
+      def name_list(ftp_path)
+        ls(ftp_path, '-1')
       end
-      list = "" if $? != 0
-      list = list.gsub(/^total \d+\n/, '')
+
     end
+  end
+
+  class DiskFileSystem
+
+    # DiskFileSystem "omnibus" mixin, which pulls in mixins which are
+    # likely to be needed by any DiskFileSystem.
 
-    def expand_ftp_path(ftp_path)
-      File.expand_path(File.join(@data_dir, ftp_path))
+    module Base
+      include TranslateExceptions
+      include DiskFileSystem::Accessors
+      include DiskFileSystem::PathExpansion
+    end
+
+  end
+
+  # 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.
+  #
+  # 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.
+
+  class DiskFileSystem
+
+    include DiskFileSystem::Base
+
+    # Mixins that make available commands or groups of commands.  Each
+    # can be safely left out with the only effect being to make One or
+    # more commands be unimplemented.
+
+    include DiskFileSystem::Delete
+    include DiskFileSystem::List
+    include DiskFileSystem::NameList
+    include DiskFileSystem::Read
+    include DiskFileSystem::Write
+
+    # Make a new instance to serve a directory.  data_dir should be an
+    # absolute path.
+
+    def initialize(data_dir)
+      set_data_dir data_dir
+      translate_exception SystemCallError
     end
 
   end