ftpd 0.0.1.pre → 0.1.0

data/features/support/test_client.rb

@@ -7,7 +7,7 @@ class TestClient
   include FileUtils
 
   def initialize(opts = {})
-    @temp_dir = TempDir.make
+    @temp_dir = Ftpd::TempDir.make
     @ftp = make_ftp(opts)
     @templates = TestFileTemplates.new
   end

data/features/support/test_server.rb

@@ -1,51 +1,133 @@
 require 'fileutils'
 require 'forwardable'
+require 'tempfile'
+
+require File.expand_path('test_server_files',
+                         File.dirname(__FILE__))
+
+class TestServer
+  class TestServerDriver
+
+    def initialize(temp_dir)
+      @temp_dir = temp_dir
+    end
+
+    USER = 'user'
+    PASSWORD = 'password'
+
+    def authenticate(user, password)
+      user == USER && password == PASSWORD
+    end
+
+    def file_system(user)
+      TestServerFileSystem.new(@temp_dir)
+    end
+
+  end
+end
+
+class TestServer
+  class TestServerFileSystem < Ftpd::DiskFileSystem
+
+    def accessible?(ftp_path)
+      return false if force_access_denied?(ftp_path)
+      return true if force_file_system_error?(ftp_path)
+      super
+    end
+
+    def exists?(ftp_path)
+      return true if force_file_system_error?(ftp_path)
+      super
+    end
+
+    def directory?(ftp_path)
+      return true if force_file_system_error?(ftp_path)
+      super
+    end
+
+    def delete(ftp_path)
+      force_file_system_error(ftp_path)
+      super
+    end
+
+    def read(ftp_path)
+      force_file_system_error(ftp_path)
+      super
+    end
+
+    def write(ftp_path, contents)
+      force_file_system_error(ftp_path)
+      super
+    end
+
+    private
+
+    def force_file_system_error(ftp_path)
+      if force_file_system_error?(ftp_path)
+        raise Ftpd::FileSystemError, 'Unable to do it'
+      end
+    end
+
+    def force_access_denied?(ftp_path)
+      ftp_path =~ /forbidden/
+    end
+
+    def force_file_system_error?(ftp_path)
+      ftp_path =~ /unable/
+    end
+
+  end
+end
 
 class TestServer
 
-  extend Forwardable
   include FileUtils
+  include TestServerFiles
+  include Ftpd::InsecureCertificate
 
-  def initialize
-    @temp_dir = TempDir.make
-    @server = Ftpd::FtpServer.new(@temp_dir)
+  def initialize(opts = {})
+    tls = opts[:tls] || :off
+    @temp_dir = Ftpd::TempDir.make
+    @debug_file = Tempfile.new('ftp-server-debug-output')
+    @debug_file.close
+    driver = TestServerDriver.new(@temp_dir)
+    @server = Ftpd::FtpServer.new(driver)
+    @server.tls = tls
+    @server.certfile_path = insecure_certfile_path
+    @server.debug_path = @debug_file.path
+    @server.debug = opts[:debug]
     @templates = TestFileTemplates.new
+    @server.start 
+  end
+
+  def wrote_debug_output?
+    File.size(@debug_file.path) > 0
   end
 
-  def close
-    @server.close
+  def stop
+    @server.stop
   end
 
   def host
     'localhost'
   end
 
-  def add_file(path)
-    full_path = temp_path(path)
-    mkdir_p File.dirname(full_path)
-    File.open(full_path, 'wb') do |file|
-      file.puts @templates[File.basename(full_path)]
-    end
+  def user
+    TestServerDriver::USER
   end
 
-  def has_file?(path)
-    full_path = temp_path(path)
-    File.exists?(full_path)
+  def password
+    TestServerDriver::PASSWORD
   end
 
-  def file_contents(path)
-    full_path = temp_path(path)
-    File.open(full_path, 'rb', &:read)
+  def port
+    @server.bound_port
   end
 
-  def_delegator :@server, :password
-  def_delegator :@server, :port
-  def_delegator :@server, :user
-
   private
 
-  def temp_path(path)
-    File.expand_path(path, @temp_dir)
+  def temp_dir
+    @temp_dir
   end
 
 end

data/features/support/test_server_files.rb

@@ -0,0 +1,30 @@
+module TestServerFiles
+
+  def add_file(path)
+    full_path = temp_path(path)
+    mkdir_p File.dirname(full_path)
+    File.open(full_path, 'wb') do |file|
+      file.puts @templates[File.basename(full_path)]
+    end
+  end
+
+  def add_directory(path)
+    full_path = temp_path(path)
+    mkdir_p full_path
+  end
+
+  def has_file?(path)
+    full_path = temp_path(path)
+    File.exists?(full_path)
+  end
+
+  def file_contents(path)
+    full_path = temp_path(path)
+    File.open(full_path, 'rb', &:read)
+  end
+
+  def temp_path(path)
+    File.expand_path(path, temp_dir)
+  end
+
+end

data/ftpd.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "ftpd"
-  s.version = "0.0.1.pre"
+  s.version = "0.1.0"
 
-  s.required_rubygems_version = Gem::Requirement.new("> 1.3.1") if s.respond_to? :required_rubygems_version=
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Wayne Conrad"]
-  s.date = "2013-02-11"
+  s.date = "2013-02-22"
   s.description = "ftpd is a pure Ruby FTP server library.  It supports implicit and explicit TLS, suitlble for use by a program such as a test fixture or FTP daemon."
   s.email = "wconrad@yagni.com"
   s.extra_rdoc_files = [
@@ -24,20 +24,32 @@ Gem::Specification.new do |s|
     "Rakefile",
     "VERSION",
     "examples/example.rb",
-    "features/command_errors.feature",
-    "features/concurrent_sessions.feature",
-    "features/delete.feature",
-    "features/directory_navigation.feature",
-    "features/file_structure.feature",
-    "features/get.feature",
-    "features/list.feature",
-    "features/login.feature",
-    "features/mode.feature",
-    "features/name_list.feature",
-    "features/noop.feature",
-    "features/port.feature",
-    "features/put.feature",
-    "features/quit.feature",
+    "examples/hello_world.rb",
+    "features/example/example.feature",
+    "features/example/step_definitions/example_server.rb",
+    "features/ftp_server/command_errors.feature",
+    "features/ftp_server/concurrent_sessions.feature",
+    "features/ftp_server/debug.feature",
+    "features/ftp_server/delete.feature",
+    "features/ftp_server/directory_navigation.feature",
+    "features/ftp_server/file_structure.feature",
+    "features/ftp_server/get.feature",
+    "features/ftp_server/get_tls.feature",
+    "features/ftp_server/list.feature",
+    "features/ftp_server/list_tls.feature",
+    "features/ftp_server/login.feature",
+    "features/ftp_server/mode.feature",
+    "features/ftp_server/name_list.feature",
+    "features/ftp_server/name_list_tls.feature",
+    "features/ftp_server/noop.feature",
+    "features/ftp_server/port.feature",
+    "features/ftp_server/put.feature",
+    "features/ftp_server/put_tls.feature",
+    "features/ftp_server/quit.feature",
+    "features/ftp_server/step_definitions/debug.rb",
+    "features/ftp_server/step_definitions/test_server.rb",
+    "features/ftp_server/syntax_errors.feature",
+    "features/ftp_server/type.feature",
     "features/step_definitions/client.rb",
     "features/step_definitions/client_and_server_files.rb",
     "features/step_definitions/client_files.rb",
@@ -58,56 +70,75 @@ Gem::Specification.new do |s|
     "features/step_definitions/port.rb",
     "features/step_definitions/put.rb",
     "features/step_definitions/quit.rb",
-    "features/step_definitions/server.rb",
     "features/step_definitions/server_files.rb",
+    "features/step_definitions/stop_server.rb",
     "features/step_definitions/type.rb",
     "features/support/env.rb",
+    "features/support/example_server.rb",
     "features/support/file_templates/ascii_unix",
     "features/support/file_templates/ascii_windows",
     "features/support/file_templates/binary",
     "features/support/test_client.rb",
     "features/support/test_file_templates.rb",
     "features/support/test_server.rb",
-    "features/syntax_errors.feature",
-    "features/type.feature",
+    "features/support/test_server_files.rb",
     "ftpd.gemspec",
     "insecure-test-cert.pem",
     "lib/ftpd.rb",
+    "lib/ftpd/disk_file_system.rb",
+    "lib/ftpd/error.rb",
+    "lib/ftpd/exception_translator.rb",
+    "lib/ftpd/exceptions.rb",
+    "lib/ftpd/file_system_error_translator.rb",
     "lib/ftpd/ftp_server.rb",
+    "lib/ftpd/insecure_certificate.rb",
     "lib/ftpd/server.rb",
+    "lib/ftpd/session.rb",
     "lib/ftpd/temp_dir.rb",
     "lib/ftpd/tls_server.rb",
+    "lib/ftpd/translate_exceptions.rb",
     "rake_tasks/cucumber.rake",
-    "rake_tasks/jeweler.rake"
+    "rake_tasks/default.rake",
+    "rake_tasks/jeweler.rake",
+    "rake_tasks/spec.rake",
+    "rake_tasks/test.rake",
+    "sandbox/em-server.rb",
+    "spec/disk_file_system_spec.rb",
+    "spec/exception_translator_spec.rb",
+    "spec/spec_helper.rb",
+    "spec/translate_exceptions_spec.rb"
   ]
   s.homepage = "http://github.com/wconrad/ftpd"
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
-  s.rubygems_version = "1.8.17"
+  s.rubygems_version = "1.8.24"
   s.summary = "Pure Ruby FTP server library"
 
   if s.respond_to? :specification_version then
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<memoizer>, ["~> 1.0.1"])
       s.add_development_dependency(%q<cucumber>, ["~> 1.2.1"])
       s.add_development_dependency(%q<double-bag-ftps>, ["~> 0.1.0"])
       s.add_development_dependency(%q<jeweler>, ["~> 1.8.4"])
       s.add_development_dependency(%q<rake>, ["~> 10.0.3"])
-      s.add_development_dependency(%q<rspec>, ["~> 2.0.1"])
+      s.add_development_dependency(%q<rspec>, ["~> 2.12.0"])
     else
+      s.add_dependency(%q<memoizer>, ["~> 1.0.1"])
       s.add_dependency(%q<cucumber>, ["~> 1.2.1"])
       s.add_dependency(%q<double-bag-ftps>, ["~> 0.1.0"])
       s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
       s.add_dependency(%q<rake>, ["~> 10.0.3"])
-      s.add_dependency(%q<rspec>, ["~> 2.0.1"])
+      s.add_dependency(%q<rspec>, ["~> 2.12.0"])
     end
   else
+    s.add_dependency(%q<memoizer>, ["~> 1.0.1"])
     s.add_dependency(%q<cucumber>, ["~> 1.2.1"])
     s.add_dependency(%q<double-bag-ftps>, ["~> 0.1.0"])
     s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
     s.add_dependency(%q<rake>, ["~> 10.0.3"])
-    s.add_dependency(%q<rspec>, ["~> 2.0.1"])
+    s.add_dependency(%q<rspec>, ["~> 2.12.0"])
   end
 end
 

data/lib/ftpd.rb

@@ -1,4 +1,22 @@
-require 'ftpd/ftp_server'
-require 'ftpd/server'
-require 'ftpd/temp_dir'
-require 'ftpd/tls_server'
+require 'fileutils'
+require 'memoizer'
+require 'openssl'
+require 'pathname'
+require 'socket'
+require 'tmpdir'
+
+module Ftpd
+  autoload :DiskFileSystem,            'ftpd/disk_file_system'
+  autoload :Error,                     'ftpd/error'
+  autoload :ExceptionTranslator,       'ftpd/exception_translator'
+  autoload :FileSystemErrorTranslator, 'ftpd/file_system_error_translator'
+  autoload :FtpServer,                 'ftpd/ftp_server'
+  autoload :InsecureCertificate,       'ftpd/insecure_certificate'
+  autoload :Server,                    'ftpd/server'
+  autoload :Session,                   'ftpd/session'
+  autoload :TempDir,                   'ftpd/temp_dir'
+  autoload :TlsServer,                 'ftpd/tls_server'
+  autoload :TranslateExceptions,       'ftpd/translate_exceptions'
+end
+
+require 'ftpd/exceptions'

data/lib/ftpd/disk_file_system.rb

@@ -0,0 +1,137 @@
+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
+
+    # Make a new instance to serve a directory.  data_dir should be
+    # fully qualified.
+
+    def initialize(data_dir)
+      @data_dir = data_dir
+      translate_exception SystemCallError
+    end
+
+    # 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 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.
+
+    def exists?(ftp_path)
+      File.exists?(expand_ftp_path(ftp_path))
+    end
+
+    # Return true if the path exists and is a directory.
+
+    def directory?(ftp_path)
+      File.directory?(expand_ftp_path(ftp_path))
+    end
+
+    # Remove a file.  Can raise FileSystemError.
+
+    def delete(ftp_path)
+      FileUtils.rm expand_ftp_path(ftp_path)
+    end
+    translate_exceptions :delete
+
+    # Read a file into memory.  Can raise FileSystemError.
+
+    def read(ftp_path)
+      File.open(expand_ftp_path(ftp_path), 'rb', &:read)
+    end
+    translate_exceptions :read
+
+    # Write a file to disk.  Can raise FileSystemError.
+
+    def write(ftp_path, contents)
+      File.open(expand_ftp_path(ftp_path), 'wb') do |file|
+        file.write contents
+      end
+    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
+
+    # Get a file list, short form.  Can raise FileSystemError.
+    #
+    # This returns one filename per line, and nothing else
+
+    def list_short(ftp_path)
+      ls(ftp_path, '-1')
+    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 = ''
+      end
+      list = "" if $? != 0
+      list = list.gsub(/^total \d+\n/, '')
+    end
+
+    def expand_ftp_path(ftp_path)
+      File.expand_path(File.join(@data_dir, ftp_path))
+    end
+
+  end
+end