investtools-ftpd 1.0.1

data/examples/example_spec.rb

@@ -0,0 +1,93 @@
+# encoding: utf-8
+
+# Authour: Michael de Silva <michael@mwdesilva.com>
+# CEO @ http://omakaselabs.com / Mentor @ http://railsphd.com
+# https://twitter.com/bsodmike / https://github.com/bsodmike
+
+# This is an example for using Ftpd as a means for spec driving
+# interaction with a 'dummy' ftp server via RSpec.  In this example we
+# assume the client is implemented via `Fetcher::FTPFetcher`.
+
+unless $:.include?(File.dirname(__FILE__) + '/../lib')
+  $:.unshift(File.dirname(__FILE__) + '/../lib')
+end
+
+require 'net/ftp'
+require 'ftpd'
+require 'tmpdir'
+
+# This is an example client spec driven via the use of Ftpd within the
+# specs.  The specs spawn a 'dummy' Ftpd server and ensure this client
+# operates as expected.
+
+module Fetcher
+
+  # This is the code under test, a simple fetcher that logs into an
+  # FTP site, changes to a directory, and gets a list of files.
+
+  class FTPFetcher
+
+    # @param host [String] ftp host to connect to.
+    # @param user [String] username.
+    # @param pwd [String] password.
+    # @param dir [String] remote directory to change to.
+
+    def initialize(host, user, pwd, dir)
+      @host = host
+      @user = user
+      @pwd = pwd
+      @dir = dir
+      @ftp = Net::FTP.new
+    end
+
+    # @param port [Fixnum] port to connect to, 21 by default.
+    # @return [Array] list of files in the current directory.
+
+    def connect_and_list(port = 21)
+      @ftp.debug_mode = true if ENV['DEBUG'] == "true"
+      @ftp.passive = true
+      @ftp.connect @host, port
+      @ftp.login @user, @pwd
+      @ftp.chdir @dir
+      @ftp.nlst
+    end
+
+  end
+end
+
+describe Fetcher::FTPFetcher do
+
+  # This `Driver` tells Ftpd how to authenticate and how to interact
+  # with the file system.  In this example, the file system is
+  # read-only and contains a single file.
+
+  class Driver
+    def initialize
+      @data_dir = Dir.mktmpdir
+      at_exit {FileUtils.rm_rf(@data_dir)}
+      FileUtils.touch File.expand_path('report.txt', @data_dir)
+    end
+    def authenticate(user, pwd); true; end
+    def file_system(user); Ftpd::ReadOnlyDiskFileSystem.new(@data_dir); end
+  end
+
+  let(:server) do
+    server = Ftpd::FtpServer.new(Driver.new)
+    server.interface = "127.0.0.1"
+    server.start
+    server
+  end
+
+  let(:subject) do
+    Fetcher::FTPFetcher.new('127.0.0.1', 'user', 'password', '/')
+  end
+
+  describe "#connect_and_list" do
+
+    it "should connect to the FTP server and find 'report.txt' in the Array returned" do
+      result = subject.connect_and_list(server.bound_port)
+      expect(result).to include('report.txt')
+    end
+
+  end
+end

data/examples/hello_world.rb

@@ -0,0 +1,32 @@
+#!/usr/bin/env ruby
+
+unless $:.include?(File.dirname(__FILE__) + '/../lib')
+  $:.unshift(File.dirname(__FILE__) + '/../lib')
+end
+
+require 'ftpd'
+require 'tmpdir'
+
+class Driver
+
+  def initialize(temp_dir)
+    @temp_dir = temp_dir
+  end
+
+  def authenticate(user, password)
+    true
+  end
+
+  def file_system(user)
+    Ftpd::DiskFileSystem.new(@temp_dir)
+  end
+
+end
+
+Dir.mktmpdir do |temp_dir|
+  driver = Driver.new(temp_dir)
+  server = Ftpd::FtpServer.new(driver)
+  server.start
+  puts "Server listening on port #{server.bound_port}"
+  gets
+end

data/features/example/eplf.feature

@@ -0,0 +1,14 @@
+Feature: Example
+
+  As a programmer
+  I want to enable EPLF list format
+  So that I can test this library with an EPLF client
+
+  Background:
+    Given the example has argument "--eplf"
+    And the example server is started
+
+  Scenario: List directory
+    Given a successful login
+    When the client successfully lists the directory
+    Then the list should be in EPLF format

data/features/example/example.feature

@@ -0,0 +1,18 @@
+Feature: Example
+
+  As a programmer
+  I want to connect to the example
+  So that I can try this libary with an arbitrary FTP client
+
+  Background:
+    Given the example server is started
+
+  Scenario: Normal connection
+    Given a successful login
+    Then the server returns no error
+    And the client should be logged in
+
+  Scenario: Fetch README
+    Given a successful login
+    When the client successfully gets text "README"
+    Then the local file "README" should match the remote file

data/features/example/read_only.feature

@@ -0,0 +1,63 @@
+Feature: Example
+
+  As a programmer
+  I want to start a read-only server
+  So that nobody can modify the file system I expose
+
+  Background:
+    Given the example has argument "--read-only"
+    And the example server is started
+
+  Scenario: Fetch README
+    Given a successful login
+    When the client successfully gets text "README"
+    Then the local file "README" should match the remote file
+
+  Scenario: Fetch README
+    Given a successful login
+    When the client successfully gets text "README"
+    Then the local file "README" should match the remote file
+
+  Scenario: List
+    Given a successful login
+    When the client successfully lists the directory
+    Then the file list should be in long form
+    And the file list should contain "README"
+
+  Scenario: Name List
+    Given a successful login
+    When the client successfully name-lists the directory
+    Then the file list should be in short form
+    And the file list should contain "README"
+
+  Scenario: Put
+    Given a successful login
+    And the client has file "foo"
+    When the client puts text "foo"
+    Then the server returns an unimplemented command error
+
+  Scenario: Put unique
+    Given a successful login
+    And the client has file "foo"
+    When the client stores unique "foo"
+    Then the server returns an unimplemented command error
+
+  Scenario: Delete
+    Given a successful login
+    When the client deletes "README"
+    Then the server returns an unimplemented command error
+
+  Scenario: Mkdir
+    Given a successful login
+    When the client makes directory "foo"
+    Then the server returns an unimplemented command error
+
+  Scenario: Rename
+    Given a successful login
+    When the client renames "README" to "foo"
+    Then the server returns an unimplemented command error
+
+  Scenario: Rmdir
+    Given a successful login
+    When the client removes directory "foo"
+    Then the server returns an unimplemented command error

data/features/example/step_definitions/example_server.rb

@@ -0,0 +1,11 @@
+def example_args
+  @example_args ||= []
+end
+
+Given /^the example has argument "(.*?)"$/ do |arg|
+  example_args << arg
+end
+
+Given /^the example server is started$/ do
+  @server = ExampleServer.new(example_args)
+end

data/features/ftp_server/abort.feature

@@ -0,0 +1,13 @@
+Feature: Abort
+
+  As a client
+  I want to know this command is not supported
+  So that I can avoid using it
+
+  Background:
+    Given the test server is started
+
+  Scenario: Unimplemented
+    Given a successful connection
+    When the client sends command "ABOR"
+    Then the server returns an unimplemented command error

data/features/ftp_server/allo.feature

@@ -0,0 +1,33 @@
+Feature: ALLO
+
+  As a client
+  I want to reserve file system space
+  So that my put will succeed
+
+  Background:
+    Given the test server is started
+
+  Scenario: With count
+    Given a successful login
+    When the client successfully sends "ALLO 1024"
+    Then the server returns a not necessary reply
+
+  Scenario: With count and record size
+    Given a successful login
+    When the client successfully sends "ALLO 1024 R 128"
+    Then the server returns a not necessary reply
+
+  Scenario: Not logged in
+    Given a successful connection
+    When the client sends "ALLO 1024"
+    Then the server returns a not logged in error
+
+  Scenario: Missing argument
+    Given a successful login
+    When the client sends "ALLO"
+    Then the server returns a syntax error
+
+  Scenario: Invalid argument
+    Given a successful login
+    When the client sends "ALLO XYZ"
+    Then the server returns a syntax error

data/features/ftp_server/append.feature

@@ -0,0 +1,94 @@
+Feature: Append
+
+  As a client
+  I want to append to a file
+  Because it is a log
+
+  Background:
+    Given the test server is started
+
+  Scenario: ASCII file with *nix line endings
+    Given a successful login
+    And the server has file "foo"
+    And the client has file "ascii_unix"
+    When the client successfully appends text "ascii_unix" onto "foo"
+    Then the remote file "foo" should match "foo" + "ascii_unix"
+
+  Scenario: ASCII file with windows line endings
+    Given a successful login
+    And the server has file "foo"
+    And the client has file "ascii_windows"
+    When the client successfully appends text "ascii_windows" onto "foo"
+    Then the remote file "foo" should match "foo" + "ascii_unix"
+
+  Scenario: Binary file
+    Given a successful login
+    And the server has file "foo"
+    And the client has file "binary"
+    When the client successfully appends binary "binary" onto "foo"
+    Then the remote file "foo" should match "foo" + "binary"
+
+  Scenario: Passive
+    Given a successful login
+    And the server has file "foo"
+    And the client has file "binary"
+    And the client is in passive mode
+    When the client successfully appends binary "binary" onto "foo"
+    Then the remote file "foo" should match "foo" + "binary"
+
+  Scenario: Destination missing
+    Given a successful login
+    And the client has file "binary"
+    When the client successfully appends binary "binary" onto "foo"
+    Then the remote file "foo" should match "binary"
+
+  Scenario: Subdir
+    Given a successful login
+    And the server has file "subdir/foo"
+    And the client has file "binary"
+    When the client successfully appends binary "binary" onto "subdir/foo"
+    Then the remote file "subdir/foo" should match "foo" + "binary"
+
+  Scenario: Non-root working directory
+    Given a successful login
+    And the server has file "subdir/foo"
+    And the client has file "binary"
+    And the client successfully cd's to "subdir"
+    When the client successfully appends binary "binary" onto "foo"
+    Then the remote file "subdir/foo" should match "foo" + "binary"
+
+  Scenario: Access denied
+    Given a successful login
+    And the client has file "foo"
+    When the client appends binary "foo" onto "forbidden"
+    Then the server returns an access denied error
+
+  Scenario: Missing directory
+    Given a successful login
+    And the client has file "binary"
+    When the client appends binary "binary" onto "subdir/foo"
+    Then the server returns a not found error
+
+  Scenario: Not logged in
+    Given a successful connection
+    And the client has file "foo"
+    When the client appends binary "foo" onto "foo"
+    Then the server returns a not logged in error
+
+  Scenario: Missing path
+    Given a successful login
+    When the client sends "APPE"
+    Then the server returns a syntax error
+
+  Scenario: File system error
+    Given a successful login
+    And the client has file "foo"
+    When the client appends text "foo" onto "unable"
+    Then the server returns an action not taken error
+
+  Scenario: Append not enabled
+    Given the test server lacks append
+    And a successful login
+    And the client has file "foo"
+    When the client appends text "foo" onto "bar"
+    Then the server returns an unimplemented command error

data/features/ftp_server/cdup.feature

@@ -0,0 +1,36 @@
+Feature: Change Directory
+
+  As a client
+  I want to change to the parent directory
+
+  Background:
+    Given the test server is started
+
+  Scenario: From subdir
+    Given a successful login
+    And the server has directory "subdir"
+    And the client successfully cd's to "subdir"
+    When the client successfully cd's up
+    Then the current directory should be "/"
+
+  Scenario: From root
+    Given a successful login
+    When the client successfully cd's up
+    Then the current directory should be "/"
+
+  Scenario: XCUP
+    Given a successful login
+    And the server has directory "subdir"
+    And the client successfully cd's to "subdir"
+    When the client successfully sends "XCUP"
+    Then the current directory should be "/"
+
+  Scenario: With argument
+    Given a successful login
+    When the client sends "CDUP abc"
+    Then the server returns a syntax error
+
+  Scenario: Not logged in
+    Given a successful connection
+    When the client cd's to "subdir"
+    Then the server returns a not logged in error

data/features/ftp_server/command_errors.feature

@@ -0,0 +1,13 @@
+Feature: Command Errors
+
+  As a client
+  I want good error messages
+  So that I can figure out what went wrong
+
+  Background:
+    Given the test server is started
+
+  Scenario: Unknown command
+    Given a successful connection
+    When the client sends command "foo"
+    Then the server returns a command unrecognized error

data/features/ftp_server/concurrent_sessions.feature

@@ -0,0 +1,14 @@
+Feature: Concurrent Sessions
+
+  As a client
+  I want to start a session when there is another session
+  So that my session doesn't have to wait on the other
+
+  Background:
+    Given the test server is started
+
+  Scenario: Stream
+    Given a successful login
+    And the server has file "ascii_unix"
+    And the second client connects and logs in
+    Then the second client successfully does nothing