ftpd 0.0.0.pre1

data/lib/ftpd/FakeServer.rb

@@ -0,0 +1,57 @@
+require 'socket'
+
+class FakeServer
+
+  def initialize
+    @server_socket = make_server_socket
+    @server_thread = make_server_thread
+  end
+
+  def port
+    @server_socket.addr[1]
+  end
+
+  def close
+    # An apparent race condition causes this to sometimes not stop the
+    # thread.  When this happens, the thread remains blocked in the
+    # accept method; I hypothesize that this happens whenever the
+    # close happens first.  Once this bug is fixed, join on the
+    # thread.
+    @server_socket.close
+  end
+
+  private
+
+  def make_server_socket
+    return TCPServer.new('localhost', 0)
+  end
+
+  def make_server_thread
+    Thread.new do
+      Thread.abort_on_exception = true
+      loop do
+        begin
+          begin
+            socket = accept
+          rescue Errno::EAGAIN, Errno::ECONNABORTED, Errno::EPROTO, Errno::EINVAL
+            IO.select([@server_socket])
+            sleep(0.2)
+            retry
+          end
+          begin
+            session(socket)
+          ensure
+            socket.close
+          end
+        rescue IOError
+          break
+        end
+      end
+    end
+  end
+
+  def accept
+    @server_socket.accept
+  end
+
+end

data/lib/ftpd/FakeTlsServer.rb

@@ -0,0 +1,52 @@
+require 'openssl'
+require File.expand_path('FakeServer', File.dirname(__FILE__))
+require File.expand_path('ObjectUtil', File.dirname(__FILE__))
+
+class FakeTlsServer < FakeServer
+
+  private
+
+  def make_server_socket
+    ssl_server_socket = OpenSSL::SSL::SSLServer.new(super, ssl_context);
+    ssl_server_socket.start_immediately = false
+    ssl_server_socket
+  end
+
+  def accept
+    socket = @server_socket.accept
+    add_tls_methods_to_socket(socket)
+    socket
+  end
+
+  def ssl_context
+    context = OpenSSL::SSL::SSLContext.new
+    File.open(certfile_path) do |certfile|
+      context.cert = OpenSSL::X509::Certificate.new(certfile)
+      certfile.rewind
+      context.key = OpenSSL::PKey::RSA.new(certfile)
+    end
+    context
+  end
+  once :ssl_context
+
+  def certfile_path
+    File.expand_path('../../insecure-test-cert.pem',
+                     File.dirname(__FILE__))
+  end
+
+  def add_tls_methods_to_socket(socket)
+    context = ssl_context
+    class << socket
+      def ssl_context
+        context
+      end
+      def encrypted?
+        !!cipher
+      end
+      def encrypt
+        accept
+      end
+    end
+  end
+
+end

data/lib/ftpd/ObjectUtil.rb

@@ -0,0 +1,66 @@
+require 'thread'
+
+class Object
+
+  def deep_copy
+    Marshal.load(Marshal.dump(self))
+  end
+
+  # So that the tests for once can force thread-safety issues to come
+  # out of hiding
+
+  def once_hook_set_value
+  end
+
+end
+
+class Module
+
+  def implement_once(ids, variable_prefix)
+    for id in ids
+      alphanumeric_name = id.to_s.gsub('?', 'q')
+      new_name = "gen_#{alphanumeric_name}"
+      mutex_name = "mutex_#{alphanumeric_name}"
+      return if private_method_defined?(new_name)
+      module_eval <<-"end;"
+      alias_method :#{new_name}, :#{id}
+        private :#{new_name}
+        def #{id}(*args, &block)
+          Thread.exclusive do
+            @#{mutex_name} ||= Mutex.new
+          end
+          @#{mutex_name}.synchronize do
+            unless #{variable_prefix}#{new_name}
+              once_hook_set_value
+              #{variable_prefix}#{new_name} = [#{new_name}(*args, &block)]
+            end
+            #{variable_prefix}#{new_name}[0]
+          end
+        end
+      end;
+    end
+  end
+
+  # Modified from code in the Pickaxe book
+  #
+  # Warning: Does not work on inherited or redefined methods
+
+  def once(*ids)
+    implement_once(ids, '@')
+  end
+
+  # Modified from code in the Pickaxe book
+  #
+  # Warning: Does not work on inherited or redefined methods
+
+  def global_once(*ids)
+    implement_once(ids, '$')
+  end
+
+end
+
+module Kernel
+  def with(o, &block)
+    o.instance_eval(&block)
+  end
+end

data/lib/ftpd/TempDir.rb

@@ -0,0 +1,54 @@
+require 'tempfile'
+
+class TempDir
+
+  attr_reader :path
+
+  class << self
+
+    def make(basename = nil)
+      temp_dir = TempDir.new(basename)
+      begin
+        yield(temp_dir)
+      ensure
+        temp_dir.rm unless temp_dir.kept
+      end
+    end
+
+  end
+
+  attr_reader :kept
+
+  def initialize(basename = nil)
+    @path = unique_path(basename)
+    @kept = false
+    ObjectSpace.define_finalizer(self, TempDir.cleanup(path))
+    Dir.mkdir(@path)
+  end
+
+  def keep
+    @kept = true
+    ObjectSpace.undefine_finalizer(self)
+  end
+
+  def rm
+    keep
+    system("rm -rf #{path.inspect}")
+  end
+
+  private
+
+  def unique_path(basename)
+    tempfile = Tempfile.new(File.basename(basename || $0 || ''))
+    path = tempfile.path
+    tempfile.close!
+    path
+  end
+
+  def TempDir.cleanup(path)
+    proc { |id|
+      system("/bin/rm -rf #{path.inspect}")
+    }
+  end
+
+end

data/lib/ftpd/q.rb

@@ -0,0 +1,92 @@
+if RUBY_VERSION >= '1.8'
+  require 'pp'
+  require 'yaml'
+end
+
+class Object
+
+  def tapq
+    tap do |o|
+      q o
+    end
+  end
+
+  def tapqq
+    tap do |o|
+      qq o
+    end
+  end
+
+  # Mostly Like p, but writes to $stderr instead of $stdout But not
+  # exactly like p: you can give it a block that returns a list of
+  # expressions as strings or symbols.  Those expressions will be
+  # evaluted and displayed with labels.
+
+  def q(*stuff, &block)
+    qprint(nil, *stuff, &block)
+  end
+
+  def ql(*stuff, &block)
+    qprint(process_caller_line(caller[0], true), *stuff, &block)
+  end
+
+  def qlf(*stuff, &block)
+    qprint(process_caller_line(caller[0], false), *stuff, &block)
+  end
+
+  def qprint(prefix, *stuff, &block)
+    if block
+      s = Array(block[]).collect do |expression|
+        value = eval(expression.to_s, block.binding).inspect
+        "#{expression} = #{value}"
+      end.join(', ')
+      s = "#{prefix} " + s if prefix
+      $stderr.puts s
+    else
+      if prefix
+        $stderr.print prefix
+        if stuff.empty?
+          $stderr.print "\n"
+        end
+      end
+      stuff.each_with_index do |thing, i|
+        s = thing.inspect + "\n"
+        if prefix
+          if i != 0
+            s = " " * prefix.size + s
+          end
+          s = " " + s
+        end
+        $stderr.print(s)
+      end
+    end
+  end
+
+  def process_caller_line(str, basename_only)
+    parts = str.split(':')[0..1]
+    if basename_only
+      parts[0] = File.basename(parts[0])
+    end
+    parts.join(':') + ":"
+  end
+  # like pp, but writes to $stderr instead of $stdout
+
+  if RUBY_VERSION >= '1.8'
+    def qq(*objs)
+      for obj in objs
+        PP.pp(obj, $stderr)
+      end
+    end
+  end
+
+  # like y, but writes to $stderr instead of $stdout
+
+  if RUBY_VERSION >= '1.8'
+    def yy(*objs)
+      for obj in objs
+        $stderr.puts obj.to_yaml(:SortKeys=>true)
+      end
+    end
+  end
+
+end

data/rake_tasks/cucumber.rake

@@ -0,0 +1,7 @@
+require 'cucumber/rake/task'
+
+Cucumber::Rake::Task.new(:features) do |t|
+  t.fork = true
+end
+
+task :cucumber => [:features]

data/rake_tasks/jeweler.rake

@@ -0,0 +1,25 @@
+# encoding: utf-8
+
+require 'jeweler'
+
+README_PATH = File.expand_path('../README.md', File.dirname(__FILE__))
+
+def extract_description_from_readme
+  readme = File.open(README_PATH, 'r', &:read)
+  s = readme[/^# FTPD\n+((?:.*\n)+?)\n*##/, 1]
+  s.gsub(/\n/, ' ').strip
+end
+
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see
+  # http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = 'ftpd'
+  gem.homepage = 'http://github.com/wconrad/ftpd'
+  gem.license = 'MIT'
+  gem.summary = %Q{Pure Ruby FTP server library}
+  gem.description = extract_description_from_readme
+  gem.email = 'wconrad@yagni.com'
+  gem.authors = ['Wayne Conrad']
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new

metadata

@@ -0,0 +1,164 @@
+--- !ruby/object:Gem::Specification
+name: ftpd
+version: !ruby/object:Gem::Version
+  version: 0.0.0.pre1
+  prerelease: 6
+platform: ruby
+authors:
+- Wayne Conrad
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  requirement: &68632020 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.1
+  type: :development
+  prerelease: false
+  version_requirements: *68632020
+- !ruby/object:Gem::Dependency
+  name: double-bag-ftps
+  requirement: &68631220 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :development
+  prerelease: false
+  version_requirements: *68631220
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: &68630210 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.4
+  type: :development
+  prerelease: false
+  version_requirements: *68630210
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &68629160 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 10.0.3
+  type: :development
+  prerelease: false
+  version_requirements: *68629160
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &68627620 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+  type: :development
+  prerelease: false
+  version_requirements: *68627620
+description: ftpd is a pure Ruby FTP server library.  It supports implicit and explicit
+  TLS, and can be used by a text fixture or FTP daemon.
+email: wconrad@yagni.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.md
+- README.md
+files:
+- Gemfile
+- Gemfile.lock
+- LICENSE.md
+- README.md
+- Rakefile
+- VERSION
+- features/command_errors.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
+- features/step_definitions/client_and_server_files.rb
+- features/step_definitions/client_files.rb
+- features/step_definitions/command.rb
+- features/step_definitions/connect.rb
+- features/step_definitions/delete.rb
+- features/step_definitions/directories.rb
+- features/step_definitions/error.rb
+- features/step_definitions/file_structure.rb
+- features/step_definitions/get.rb
+- features/step_definitions/invalid_commands.rb
+- features/step_definitions/line_endings.rb
+- features/step_definitions/list.rb
+- features/step_definitions/login.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/server.rb
+- features/step_definitions/server_files.rb
+- features/step_definitions/type.rb
+- features/support/env.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
+- ftpd.gemspec
+- insecure-test-cert.pem
+- lib/ftpd.rb
+- lib/ftpd/FakeFtpServer.rb
+- lib/ftpd/FakeServer.rb
+- lib/ftpd/FakeTlsServer.rb
+- lib/ftpd/ObjectUtil.rb
+- lib/ftpd/TempDir.rb
+- lib/ftpd/q.rb
+- rake_tasks/cucumber.rake
+- rake_tasks/jeweler.rake
+homepage: http://github.com/wconrad/ftpd
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>'
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.17
+signing_key: 
+specification_version: 3
+summary: Pure Ruby FTP server library
+test_files: []