rubysl-net-ftp 1.0.0

data/spec/delete_spec.rb

@@ -0,0 +1,58 @@
+require 'net/ftp'
+require File.expand_path('../fixtures/server', __FILE__)
+
+describe "Net::FTP#delete" do
+  before(:each) do
+    @server = NetFTPSpecs::DummyFTP.new
+    @server.serve_once
+
+    @ftp = Net::FTP.new
+    @ftp.connect("localhost", 9921)
+  end
+
+  after(:each) do
+    @ftp.quit rescue nil
+    @ftp.close
+    @server.stop
+  end
+
+  it "sends the DELE command with the passed filename to the server" do
+    @ftp.delete("test.file")
+    @ftp.last_response.should == "250 Requested file action okay, completed. (DELE test.file)\n"
+  end
+
+  it "raises a Net::FTPTempError when the response code is 450" do
+    @server.should_receive(:dele).and_respond("450 Requested file action not taken.")
+    lambda { @ftp.delete("test.file") }.should raise_error(Net::FTPTempError)
+  end
+
+  it "raises a Net::FTPPermError when the response code is 550" do
+    @server.should_receive(:dele).and_respond("550 Requested action not taken.")
+    lambda { @ftp.delete("test.file") }.should raise_error(Net::FTPPermError)
+  end
+
+  it "raises a Net::FTPPermError when the response code is 500" do
+    @server.should_receive(:dele).and_respond("500 Syntax error, command unrecognized.")
+    lambda { @ftp.delete("test.file") }.should raise_error(Net::FTPPermError)
+  end
+
+  it "raises a Net::FTPPermError when the response code is 501" do
+    @server.should_receive(:dele).and_respond("501 Syntax error in parameters or arguments.")
+    lambda { @ftp.delete("test.file") }.should raise_error(Net::FTPPermError)
+  end
+
+  it "raises a Net::FTPPermError when the response code is 502" do
+    @server.should_receive(:dele).and_respond("502 Command not implemented.")
+    lambda { @ftp.delete("test.file") }.should raise_error(Net::FTPPermError)
+  end
+
+  it "raises a Net::FTPTempError when the response code is 421" do
+    @server.should_receive(:dele).and_respond("421 Service not available, closing control connection.")
+    lambda { @ftp.delete("test.file") }.should raise_error(Net::FTPTempError)
+  end
+
+  it "raises a Net::FTPPermError when the response code is 530" do
+    @server.should_receive(:dele).and_respond("530 Not logged in.")
+    lambda { @ftp.delete("test.file") }.should raise_error(Net::FTPPermError)
+  end
+end

data/spec/dir_spec.rb

@@ -0,0 +1,7 @@
+require 'net/ftp'
+require File.expand_path('../fixtures/server', __FILE__)
+require File.expand_path('../shared/list', __FILE__)
+
+describe "Net::FTP#dir" do
+  it_behaves_like :net_ftp_list, :dir
+end

data/spec/fixtures/putbinaryfile

@@ -0,0 +1,3 @@
+This is an example file
+which is going to be transmitted
+using #putbinaryfile.

data/spec/fixtures/puttextfile

@@ -0,0 +1,3 @@
+This is an example file
+which is going to be transmitted
+using #puttextfile.

data/spec/fixtures/server.rb

@@ -0,0 +1,265 @@
+module NetFTPSpecs
+  class DummyFTP
+    attr_accessor :connect_message
+    attr_reader :login_user, :login_pass, :login_acct
+
+    def initialize(port = 9921)
+      @server = TCPServer.new("localhost", port)
+
+      @handlers = {}
+      @commands = []
+      @connect_message = nil
+    end
+
+    def serve_once
+      @thread = Thread.new do
+        @socket = @server.accept
+        handle_request
+        @socket.close
+      end
+    end
+
+    def handle_request
+      # Send out the welcome message.
+      response @connect_message || "220 Dummy FTP Server ready!"
+
+      begin
+        loop do
+          command = @socket.recv(1024)
+          break if command.nil?
+
+          command, argument = command.chomp.split(" ", 2)
+
+          if command == "QUIT"
+            self.response("221 OK, bye")
+            break
+          elsif proc_handler = @handlers[command.downcase.to_sym]
+            if argument.nil?
+              proc_handler.call(self)
+            else
+              proc_handler.call(self, argument)
+            end
+          else
+            if argument.nil?
+              self.send(command.downcase.to_sym)
+            else
+              self.send(command.downcase.to_sym, argument)
+            end
+          end
+        end
+      rescue => e
+        self.error_response("Exception: #{e} #{e.backtrace.inspect}")
+      end
+    end
+
+    def error_response(text)
+      self.response("451 #{text}")
+    end
+
+    def response(text)
+      @socket.puts(text) unless @socket.closed?
+    end
+
+    def stop
+      @datasocket.close unless @datasocket.nil? || @datasocket.closed?
+      @server.close
+      @thread.join
+    end
+
+
+    ##
+    def handle(sym, &block)
+      @handlers[sym] = block
+    end
+
+    def should_receive(method)
+      @handler_for = method
+      self
+    end
+
+    def and_respond(text)
+      @handlers[@handler_for] = lambda { |s, *args| s.response(text) }
+    end
+
+    ##
+    # FTP methods
+    ##
+
+    def abor
+      self.response("226 Closing data connection. (ABOR)")
+    end
+
+    def acct(account)
+      @login_acct = account
+      self.response("230 User '#{account}' logged in, proceed. (ACCT)")
+    end
+
+    def cdup
+      self.response("200 Command okay. (CDUP)")
+    end
+
+    def cwd(dir)
+      self.response("200 Command okay. (CWD #{dir})")
+    end
+
+    def dele(file)
+      self.response("250 Requested file action okay, completed. (DELE #{file})")
+    end
+
+    def eprt(arg)
+      _, _, host, port = arg.split("|")
+
+      @datasocket = TCPSocket.new(host, port)
+      self.response("200 port opened")
+    end
+
+    def help(param = :default)
+      if param == :default
+        self.response("211 System status, or system help reply. (HELP)")
+      else
+        self.response("211 System status, or system help reply. (HELP #{param})")
+      end
+    end
+
+    def list(folder)
+      self.response("150 opening ASCII connection for file list")
+      @datasocket.puts("-rw-r--r--  1 spec  staff  507 17 Jul 18:41 last_response_code.rb")
+      @datasocket.puts("-rw-r--r--  1 spec  staff   50 17 Jul 18:41 list.rb")
+      @datasocket.puts("-rw-r--r--  1 spec  staff   48 17 Jul 18:41 pwd.rb")
+      @datasocket.close()
+      self.response("226 transfer complete (LIST #{folder})")
+    end
+
+    def mdtm(filename)
+      self.response("213 19980705132316")
+    end
+
+    def mkd(foldername)
+      self.response(%Q{257 "#{foldername.gsub('"', '""')}" created.})
+    end
+
+    def nlst(folder = nil)
+      self.response("150 opening ASCII connection for file list")
+      @datasocket.puts("last_response_code.rb")
+      @datasocket.puts("list.rb")
+      @datasocket.puts("pwd.rb")
+      @datasocket.close()
+      self.response("226 transfer complete (NLST#{folder ? " #{folder}" : ""})")
+    end
+
+    def noop
+      self.response("200 Command okay. (NOOP)")
+    end
+
+    def pass(password)
+      @login_pass = password
+      self.response("230 User logged in, proceed. (PASS #{password})")
+    end
+
+    def port(arg)
+      nums = arg.split(",")
+
+      if nums[0] == "::1"
+        # IPv6
+        port = nums[1].to_i * 256 + nums[2].to_i
+        host = nums[0]
+      else
+        # IPv4
+        port = nums[4].to_i * 256 + nums[5].to_i
+        host = nums[0..3].join(".")
+      end
+
+      @datasocket = TCPSocket.new(host, port)
+      self.response("200 port opened")
+    end
+
+    def pwd
+      self.response('257 "/some/dir/" - current directory')
+    end
+
+    def retr(file)
+      self.response("125 Data transfer starting")
+      if @restart_at && @restart_at == 20
+        @datasocket.puts("of the file named '#{file}'.")
+        @restart_at = nil
+      else
+        @datasocket.puts("This is the content")
+        @datasocket.puts("of the file named '#{file}'.")
+      end
+      @datasocket.close()
+      self.response("226 Closing data connection. (RETR #{file})")
+    end
+
+    def rest(at_bytes)
+      @restart_at = at_bytes.to_i
+      self.response("350 Requested file action pending further information. (REST)")
+    end
+
+    def rmd(folder)
+      self.response("250 Requested file action okay, completed. (RMD #{folder})")
+    end
+
+    def rnfr(from)
+      @rename_from = from
+      self.response("350 Requested file action pending further information.")
+    end
+
+    def rnto(to)
+      self.response("250 Requested file action okay, completed. (Renamed #{@rename_from} to #{to})")
+      @rename_from = nil
+    end
+
+    def site(param)
+      self.response("200 Command okay. (SITE #{param})")
+    end
+
+    def size(filename)
+      if filename == "binary"
+        self.response("213 24")
+      else
+        self.response("213 1024")
+      end
+    end
+
+    def stat
+      self.response("211 System status, or system help reply. (STAT)")
+    end
+
+    def stor(file)
+      tmp_file = tmp("#{file}file", false)
+
+      self.response("125 Data transfer starting.")
+
+      mode = @restart_at ? "a" : "w"
+
+      File.open(tmp_file, mode + "b") do |f|
+        loop do
+          data = @datasocket.recv(1024)
+          break if !data || data.empty?
+          f << data
+        end
+      end
+
+      #@datasocket.close()
+      self.response("200 OK, Data received. (STOR #{file})")
+    end
+
+    def appe(file)
+      @restart_at = true
+      stor(file)
+    end
+
+    def syst
+      self.response("215 FTP Dummy Server (SYST)")
+    end
+
+    def type(type)
+      self.response("200 TYPE switched to #{type}")
+    end
+
+    def user(name)
+      @login_user = name
+      self.response("230 User logged in, proceed. (USER #{name})")
+    end
+  end
+end

data/spec/get_spec.rb

@@ -0,0 +1,20 @@
+require 'net/ftp'
+require File.expand_path('../fixtures/server', __FILE__)
+require File.expand_path('../shared/gettextfile', __FILE__)
+require File.expand_path('../shared/getbinaryfile', __FILE__)
+
+describe "Net::FTP#get (binary mode)" do
+  before(:each) do
+    @binary_mode = true
+  end
+
+  it_behaves_like :net_ftp_getbinaryfile, :get
+end
+
+describe "Net::FTP#get (text mode)" do
+  before(:each) do
+    @binary_mode = false
+  end
+
+  it_behaves_like :net_ftp_gettextfile, :get
+end

data/spec/getbinaryfile_spec.rb

@@ -0,0 +1,7 @@
+require 'net/ftp'
+require File.expand_path('../fixtures/server', __FILE__)
+require File.expand_path('../shared/getbinaryfile', __FILE__)
+
+describe "Net::FTP#getbinaryfile" do
+  it_behaves_like :net_ftp_getbinaryfile, :getbinaryfile
+end

data/spec/getdir_spec.rb

@@ -0,0 +1,6 @@
+require 'net/ftp'
+require File.expand_path('../shared/pwd', __FILE__)
+
+describe "Net::FTP#getdir" do
+  it_behaves_like :net_ftp_pwd, :getdir
+end

data/spec/gettextfile_spec.rb

@@ -0,0 +1,7 @@
+require 'net/ftp'
+require File.expand_path('../fixtures/server', __FILE__)
+require File.expand_path('../shared/gettextfile', __FILE__)
+
+describe "Net::FTP#gettextfile" do
+  it_behaves_like :net_ftp_gettextfile, :gettextfile
+end

data/spec/help_spec.rb

@@ -0,0 +1,65 @@
+require 'net/ftp'
+require File.expand_path('../fixtures/server', __FILE__)
+
+describe "Net::FTP#help" do
+  def with_connection
+    yield
+  end
+
+  before(:each) do
+    @server = NetFTPSpecs::DummyFTP.new
+    @server.serve_once
+
+    @ftp = Net::FTP.new
+    @ftp.connect("localhost", 9921)
+  end
+
+  after(:each) do
+    @ftp.quit rescue nil
+    @ftp.close
+    @server.stop
+  end
+
+  it "writes the HELP command to the server" do
+    @ftp.help
+    @ftp.last_response.should == "211 System status, or system help reply. (HELP)\n"
+  end
+
+  it "returns the server's response" do
+    @ftp.help.should == "211 System status, or system help reply. (HELP)\n"
+  end
+
+  it "writes the HELP command with an optional parameter to the socket" do
+    @ftp.help("some parameter").should == "211 System status, or system help reply. (HELP some parameter)\n"
+  end
+
+  it "does not raise any error when the response code is 211" do
+    @server.should_receive(:help).and_respond("211 System status, or system help reply.")
+    lambda { @ftp.help }.should_not raise_error
+  end
+
+  it "does not raise any error when the response code is 214" do
+    @server.should_receive(:help).and_respond("214 Help message.")
+    lambda { @ftp.help }.should_not raise_error
+  end
+
+  it "raises a Net::FTPPermError when the response code is 500" do
+    @server.should_receive(:help).and_respond("500 Syntax error, command unrecognized.")
+    lambda { @ftp.help }.should raise_error(Net::FTPPermError)
+  end
+
+  it "raises a Net::FTPPermError when the response code is 501" do
+    @server.should_receive(:help).and_respond("501 Syntax error in parameters or arguments.")
+    lambda { @ftp.help }.should raise_error(Net::FTPPermError)
+  end
+
+  it "raises a Net::FTPPermError when the response code is 502" do
+    @server.should_receive(:help).and_respond("502 Command not implemented.")
+    lambda { @ftp.help }.should raise_error(Net::FTPPermError)
+  end
+
+  it "raises a Net::FTPTempError when the response code is 421" do
+    @server.should_receive(:help).and_respond("421 Service not available, closing control connection.")
+    lambda { @ftp.help }.should raise_error(Net::FTPTempError)
+  end
+end