rubysl-net-ftp 1.0.0

data/spec/resume_spec.rb

@@ -0,0 +1,22 @@
+require 'net/ftp'
+
+describe "Net::FTP#resume" do
+  it "returns true when self is set to resume uploads/downloads" do
+    ftp = Net::FTP.new
+    ftp.resume.should be_false
+
+    ftp.resume = true
+    ftp.resume.should be_true
+  end
+end
+
+describe "Net::FTP#resume=" do
+  it "sets self to resume uploads/downloads when set to true" do
+    ftp = Net::FTP.new
+    ftp.resume = true
+    ftp.resume.should be_true
+
+    ftp.resume = false
+    ftp.resume.should be_false
+  end
+end

data/spec/retrbinary_spec.rb

@@ -0,0 +1,29 @@
+require 'net/ftp'
+require File.expand_path('../fixtures/server', __FILE__)
+
+describe "Net::FTP#retrbinary" 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 passed command to the server" do
+    @ftp.retrbinary("RETR test", 4096) {}
+    @ftp.last_response.should == "226 Closing data connection. (RETR test)\n"
+  end
+
+  it "yields the received content as binary blocks of the passed size" do
+    res = []
+    @ftp.retrbinary("RETR test", 10) { |bin| res << bin }
+    res.should == [ "This is th", "e content\n", "of the fil", "e named 't", "est'.\n" ]
+  end
+end

data/spec/retrlines_spec.rb

@@ -0,0 +1,33 @@
+require 'net/ftp'
+require File.expand_path('../fixtures/server', __FILE__)
+
+describe "Net::FTP#retrlines" 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 passed command over the socket" do
+    @ftp.retrlines("LIST test.dir") {}
+    @ftp.last_response.should == "226 transfer complete (LIST test.dir)\n"
+  end
+
+  it "yields each received line to the passed block" do
+    res = []
+    @ftp.retrlines("LIST test.dir") { |x| res << x }
+    res.should == [
+      "-rw-r--r--  1 spec  staff  507 17 Jul 18:41 last_response_code.rb",
+      "-rw-r--r--  1 spec  staff   50 17 Jul 18:41 list.rb",
+      "-rw-r--r--  1 spec  staff   48 17 Jul 18:41 pwd.rb"
+    ]
+  end
+end

data/spec/return_code_spec.rb

@@ -0,0 +1,23 @@
+require 'net/ftp'
+
+describe "Net::FTP#return_code" do
+  before(:each) do
+    @ftp = Net::FTP.new
+  end
+
+  it "outputs a warning and returns a newline" do
+    lambda do
+      @ftp.return_code.should == "\n"
+    end.should complain("warning: Net::FTP#return_code is obsolete and do nothing\n")
+  end
+end
+
+describe "Net::FTP#return_code=" do
+  before(:each) do
+    @ftp = Net::FTP.new
+  end
+
+  it "outputs a warning" do
+    lambda { @ftp.return_code = 123 }.should complain("warning: Net::FTP#return_code= is obsolete and do nothing\n")
+  end
+end

data/spec/rmdir_spec.rb

@@ -0,0 +1,57 @@
+require 'net/ftp'
+require File.expand_path('../fixtures/server', __FILE__)
+
+describe "Net::FTP#rmdir" 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 RMD command with the passed pathname to the server" do
+    @ftp.rmdir("test.folder")
+    @ftp.last_response.should == "250 Requested file action okay, completed. (RMD test.folder)\n"
+  end
+
+  it "returns nil" do
+    @ftp.rmdir("test.folder").should be_nil
+  end
+
+  it "raises a Net::FTPPermError when the response code is 500" do
+    @server.should_receive(:rmd).and_respond("500 Syntax error, command unrecognized.")
+    lambda { @ftp.rmdir("test.folder") }.should raise_error(Net::FTPPermError)
+  end
+
+  it "raises a Net::FTPPermError when the response code is 501" do
+    @server.should_receive(:rmd).and_respond("501 Syntax error in parameters or arguments.")
+    lambda { @ftp.rmdir("test.folder") }.should raise_error(Net::FTPPermError)
+  end
+
+  it "raises a Net::FTPPermError when the response code is 502" do
+    @server.should_receive(:rmd).and_respond("502 Command not implemented.")
+    lambda { @ftp.rmdir("test.folder") }.should raise_error(Net::FTPPermError)
+  end
+
+  it "raises a Net::FTPTempError when the response code is 421" do
+    @server.should_receive(:rmd).and_respond("421 Service not available, closing control connection.")
+    lambda { @ftp.rmdir("test.folder") }.should raise_error(Net::FTPTempError)
+  end
+
+  it "raises a Net::FTPPermError when the response code is 530" do
+    @server.should_receive(:rmd).and_respond("530 Not logged in.")
+    lambda { @ftp.rmdir("test.folder") }.should raise_error(Net::FTPPermError)
+  end
+
+  it "raises a Net::FTPPermError when the response code is 550" do
+    @server.should_receive(:rmd).and_respond("550 Requested action not taken.")
+    lambda { @ftp.rmdir("test.folder") }.should raise_error(Net::FTPPermError)
+  end
+end

data/spec/sendcmd_spec.rb

@@ -0,0 +1,53 @@
+require 'net/ftp'
+require File.expand_path('../fixtures/server', __FILE__)
+
+describe "Net::FTP#sendcmd" 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 passed command to the server" do
+    @ftp.sendcmd("HELP")
+    @ftp.last_response.should == "211 System status, or system help reply. (HELP)\n"
+  end
+
+  it "returns the server's response" do
+    @ftp.sendcmd("HELP").should == "211 System status, or system help reply. (HELP)\n"
+  end
+
+  it "raises no error when the response code is 1xx, 2xx or 3xx" do
+    @server.should_receive(:help).and_respond("120 Service ready in nnn minutes.")
+    lambda { @ftp.sendcmd("HELP") }.should_not raise_error
+
+    @server.should_receive(:help).and_respond("200 Command okay.")
+    lambda { @ftp.sendcmd("HELP") }.should_not raise_error
+
+    @server.should_receive(:help).and_respond("350 Requested file action pending further information.")
+    lambda { @ftp.sendcmd("HELP") }.should_not raise_error
+  end
+
+  it "raises a Net::FTPTempError when the response code is 4xx" do
+    @server.should_receive(:help).and_respond("421 Service not available, closing control connection.")
+    lambda { @ftp.sendcmd("HELP") }.should raise_error(Net::FTPTempError)
+  end
+
+  it "raises a Net::FTPPermError when the response code is 5xx" do
+    @server.should_receive(:help).and_respond("500 Syntax error, command unrecognized.")
+    lambda { @ftp.sendcmd("HELP") }.should raise_error(Net::FTPPermError)
+  end
+
+  it "raises a Net::FTPProtoError when the response code is not between 1xx-5xx" do
+    @server.should_receive(:help).and_respond("999 Invalid response.")
+    lambda { @ftp.sendcmd("HELP") }.should raise_error(Net::FTPProtoError)
+  end
+end

data/spec/set_socket_spec.rb

@@ -0,0 +1,7 @@
+require 'net/ftp'
+
+describe "Net::FTP#set_socket" do
+  # TODO: I won't spec this method, as it is not used
+  #       anywhere and it should be private anyway.
+  #it "needs to be reviewed for spec completeness"
+end

data/spec/shared/getbinaryfile.rb

@@ -0,0 +1,179 @@
+describe :net_ftp_getbinaryfile, :shared => true do
+  before(:each) do
+    @fixture_file = File.dirname(__FILE__) + "/../fixtures/getbinaryfile"
+    @tmp_file = tmp("getbinaryfile")
+
+    @server = NetFTPSpecs::DummyFTP.new
+    @server.serve_once
+
+    @ftp = Net::FTP.new
+    @ftp.connect("localhost", 9921)
+    @ftp.binary = @binary_mode
+  end
+
+  after(:each) do
+    @ftp.quit rescue nil
+    @ftp.close
+    @server.stop
+
+    rm_r @tmp_file
+  end
+
+  it "sends the RETR command to the server" do
+    @ftp.send(@method, "test", @tmp_file)
+    @ftp.last_response.should == "226 Closing data connection. (RETR test)\n"
+  end
+
+  it "returns nil" do
+    @ftp.send(@method, "test", @tmp_file).should be_nil
+  end
+
+  it "saves the contents of the passed remote file to the passed local file" do
+    @ftp.send(@method, "test", @tmp_file)
+    File.read(@tmp_file).should == "This is the content\nof the file named 'test'.\n"
+  end
+
+  describe "when passed a block" do
+    it "yields the received content as binary blocks of the passed size" do
+      res = []
+      @ftp.send(@method, "test", @tmp_file, 10) { |bin| res << bin }
+      res.should == [ "This is th", "e content\n", "of the fil", "e named 't", "est'.\n" ]
+    end
+  end
+
+  describe "when resuming an existing file" do
+    before(:each) do
+      @tmp_file = tmp("getbinaryfile_resume")
+
+      File.open(@tmp_file, "wb") do |f|
+        f << "This is the content\n"
+      end
+
+      @ftp.resume = true
+    end
+
+    it "saves the remaining content of the passed remote file to the passed local file" do
+      @ftp.send(@method, "test", @tmp_file)
+      File.read(@tmp_file).should == "This is the content\nof the file named 'test'.\n"
+    end
+
+    describe "and the REST command fails" do
+      it "raises a Net::FTPProtoError when the response code is 550" do
+        @server.should_receive(:rest).and_respond("Requested action not taken.")
+        lambda { @ftp.send(@method, "test", @tmp_file) }.should raise_error(Net::FTPProtoError)
+      end
+
+      it "raises a Net::FTPPermError when the response code is 500" do
+        @server.should_receive(:rest).and_respond("500 Syntax error, command unrecognized.")
+        lambda { @ftp.send(@method, "test", @tmp_file) }.should raise_error(Net::FTPPermError)
+      end
+
+      it "raises a Net::FTPPermError when the response code is 501" do
+        @server.should_receive(:rest).and_respond("501 Syntax error, command unrecognized.")
+        lambda { @ftp.send(@method, "test", @tmp_file) }.should raise_error(Net::FTPPermError)
+      end
+
+      it "raises a Net::FTPPermError when the response code is 502" do
+        @server.should_receive(:rest).and_respond("502 Command not implemented.")
+        lambda { @ftp.send(@method, "test", @tmp_file) }.should raise_error(Net::FTPPermError)
+      end
+
+      it "raises a Net::FTPTempError when the response code is 421" do
+        @server.should_receive(:rest).and_respond("421 Service not available, closing control connection.")
+        lambda { @ftp.send(@method, "test", @tmp_file) }.should raise_error(Net::FTPTempError)
+      end
+
+      it "raises a Net::FTPPermError when the response code is 530" do
+        @server.should_receive(:rest).and_respond("530 Not logged in.")
+        lambda { @ftp.send(@method, "test", @tmp_file) }.should raise_error(Net::FTPPermError)
+      end
+    end
+  end
+
+  describe "when the RETR command fails" do
+    it "raises a Net::FTPTempError when the response code is 450" do
+      @server.should_receive(:retr).and_respond("450 Requested file action not taken.")
+      lambda { @ftp.send(@method, "test", @tmp_file) }.should raise_error(Net::FTPTempError)
+    end
+
+    it "raises a Net::FTPProtoError when the response code is 550" do
+      @server.should_receive(:retr).and_respond("Requested action not taken.")
+      lambda { @ftp.send(@method, "test", @tmp_file) }.should raise_error(Net::FTPProtoError)
+    end
+
+    it "raises a Net::FTPPermError when the response code is 500" do
+      @server.should_receive(:retr).and_respond("500 Syntax error, command unrecognized.")
+      lambda { @ftp.send(@method, "test", @tmp_file) }.should raise_error(Net::FTPPermError)
+    end
+
+    it "raises a Net::FTPPermError when the response code is 501" do
+      @server.should_receive(:retr).and_respond("501 Syntax error, command unrecognized.")
+      lambda { @ftp.send(@method, "test", @tmp_file) }.should raise_error(Net::FTPPermError)
+    end
+
+    it "raises a Net::FTPTempError when the response code is 421" do
+      @server.should_receive(:retr).and_respond("421 Service not available, closing control connection.")
+      lambda { @ftp.send(@method, "test", @tmp_file) }.should raise_error(Net::FTPTempError)
+    end
+
+    it "raises a Net::FTPPermError when the response code is 530" do
+      @server.should_receive(:retr).and_respond("530 Not logged in.")
+      lambda { @ftp.send(@method, "test", @tmp_file) }.should raise_error(Net::FTPPermError)
+    end
+  end
+
+  ruby_version_is "" ... "1.9" do
+    describe "when switching type fails" do
+      it "raises a Net::FTPPermError when the response code is 500" do
+	@server.should_receive(:type).and_respond("500 Syntax error, command unrecognized.")
+	lambda { @ftp.send(@method, "test", @tmp_file) }.should raise_error(Net::FTPPermError)
+      end
+
+      it "raises a Net::FTPPermError when the response code is 501" do
+	@server.should_receive(:type).and_respond("501 Syntax error in parameters or arguments.")
+	lambda { @ftp.send(@method, "test", @tmp_file) }.should raise_error(Net::FTPPermError)
+      end
+
+      it "raises a Net::FTPPermError when the response code is 504" do
+	@server.should_receive(:type).and_respond("504 Command not implemented for that parameter.")
+	lambda { @ftp.send(@method, "test", @tmp_file) }.should raise_error(Net::FTPPermError)
+      end
+
+      it "raises a Net::FTPTempError when the response code is 421" do
+	@server.should_receive(:type).and_respond("421 Service not available, closing control connection.")
+	lambda { @ftp.send(@method, "test", @tmp_file) }.should raise_error(Net::FTPTempError)
+      end
+
+      it "raises a Net::FTPPermError when the response code is 530" do
+	@server.should_receive(:type).and_respond("530 Not logged in.")
+	lambda { @ftp.send(@method, "test", @tmp_file) }.should raise_error(Net::FTPPermError)
+      end
+    end
+  end
+
+  describe "when opening the data port fails" do
+    it "raises a Net::FTPPermError when the response code is 500" do
+      @server.should_receive(:eprt).and_respond("500 Syntax error, command unrecognized.")
+      @server.should_receive(:port).and_respond("500 Syntax error, command unrecognized.")
+      lambda { @ftp.send(@method, "test", @tmp_file) }.should raise_error(Net::FTPPermError)
+    end
+
+    it "raises a Net::FTPPermError when the response code is 501" do
+      @server.should_receive(:eprt).and_respond("501 Syntax error in parameters or arguments.")
+      @server.should_receive(:port).and_respond("501 Syntax error in parameters or arguments.")
+      lambda { @ftp.send(@method, "test", @tmp_file) }.should raise_error(Net::FTPPermError)
+    end
+
+    it "raises a Net::FTPTempError when the response code is 421" do
+      @server.should_receive(:eprt).and_respond("421 Service not available, closing control connection.")
+      @server.should_receive(:port).and_respond("421 Service not available, closing control connection.")
+      lambda { @ftp.send(@method, "test", @tmp_file) }.should raise_error(Net::FTPTempError)
+    end
+
+    it "raises a Net::FTPPermError when the response code is 530" do
+      @server.should_receive(:eprt).and_respond("530 Not logged in.")
+      @server.should_receive(:port).and_respond("530 Not logged in.")
+      lambda { @ftp.send(@method, "test", @tmp_file) }.should raise_error(Net::FTPPermError)
+    end
+  end
+end

data/spec/shared/gettextfile.rb

@@ -0,0 +1,129 @@
+describe :net_ftp_gettextfile, :shared => true do
+  before(:each) do
+    @tmp_file = tmp("gettextfile")
+
+    @server = NetFTPSpecs::DummyFTP.new
+    @server.serve_once
+
+    @ftp = Net::FTP.new
+    @ftp.connect("localhost", 9921)
+    @ftp.binary = @binary_mode
+  end
+
+  after(:each) do
+    @ftp.quit rescue nil
+    @ftp.close
+    @server.stop
+
+    rm_r @tmp_file
+  end
+
+  it "sends the RETR command to the server" do
+    @ftp.send(@method, "test", @tmp_file)
+    @ftp.last_response.should == "226 Closing data connection. (RETR test)\n"
+  end
+
+  it "returns nil" do
+    @ftp.send(@method, "test", @tmp_file).should be_nil
+  end
+
+  it "saves the contents of the passed remote file to the passed local file" do
+    @ftp.send(@method, "test", @tmp_file)
+    File.read(@tmp_file).should == "This is the content\nof the file named 'test'.\n"
+  end
+
+  describe "when passed a block" do
+    it "yields each line of the retrieved file to the passed block" do
+      res = []
+      @ftp.send(@method, "test", @tmp_file) { |line| res << line }
+      res.should == [ "This is the content", "of the file named 'test'."]
+    end
+  end
+
+  describe "when the RETR command fails" do
+    it "raises a Net::FTPTempError when the response code is 450" do
+      @server.should_receive(:retr).and_respond("450 Requested file action not taken.")
+      lambda { @ftp.send(@method, "test", @tmp_file) }.should raise_error(Net::FTPTempError)
+    end
+
+    it "raises a Net::FTPProtoError when the response code is 550" do
+      @server.should_receive(:retr).and_respond("Requested action not taken.")
+      lambda { @ftp.send(@method, "test", @tmp_file) }.should raise_error(Net::FTPProtoError)
+    end
+
+    it "raises a Net::FTPPermError when the response code is 500" do
+      @server.should_receive(:retr).and_respond("500 Syntax error, command unrecognized.")
+      lambda { @ftp.send(@method, "test", @tmp_file) }.should raise_error(Net::FTPPermError)
+    end
+
+    it "raises a Net::FTPPermError when the response code is 501" do
+      @server.should_receive(:retr).and_respond("501 Syntax error, command unrecognized.")
+      lambda { @ftp.send(@method, "test", @tmp_file) }.should raise_error(Net::FTPPermError)
+    end
+
+    it "raises a Net::FTPTempError when the response code is 421" do
+      @server.should_receive(:retr).and_respond("421 Service not available, closing control connection.")
+      lambda { @ftp.send(@method, "test", @tmp_file) }.should raise_error(Net::FTPTempError)
+    end
+
+    it "raises a Net::FTPPermError when the response code is 530" do
+      @server.should_receive(:retr).and_respond("530 Not logged in.")
+      lambda { @ftp.send(@method, "test", @tmp_file) }.should raise_error(Net::FTPPermError)
+    end
+  end
+
+  ruby_version_is "" ... "1.9" do
+    describe "when switching type fails" do
+      it "raises a Net::FTPPermError when the response code is 500" do
+	@server.should_receive(:type).and_respond("500 Syntax error, command unrecognized.")
+	lambda { @ftp.send(@method, "test", @tmp_file) }.should raise_error(Net::FTPPermError)
+      end
+
+      it "raises a Net::FTPPermError when the response code is 501" do
+	@server.should_receive(:type).and_respond("501 Syntax error in parameters or arguments.")
+	lambda { @ftp.send(@method, "test", @tmp_file) }.should raise_error(Net::FTPPermError)
+      end
+
+      it "raises a Net::FTPPermError when the response code is 504" do
+	@server.should_receive(:type).and_respond("504 Command not implemented for that parameter.")
+	lambda { @ftp.send(@method, "test", @tmp_file) }.should raise_error(Net::FTPPermError)
+      end
+
+      it "raises a Net::FTPTempError when the response code is 421" do
+	@server.should_receive(:type).and_respond("421 Service not available, closing control connection.")
+	lambda { @ftp.send(@method, "test", @tmp_file) }.should raise_error(Net::FTPTempError)
+      end
+
+      it "raises a Net::FTPPermError when the response code is 530" do
+	@server.should_receive(:type).and_respond("530 Not logged in.")
+	lambda { @ftp.send(@method, "test", @tmp_file) }.should raise_error(Net::FTPPermError)
+      end
+    end
+  end
+
+  describe "when opening the data port fails" do
+    it "raises a Net::FTPPermError when the response code is 500" do
+      @server.should_receive(:eprt).and_respond("500 Syntax error, command unrecognized.")
+      @server.should_receive(:port).and_respond("500 Syntax error, command unrecognized.")
+      lambda { @ftp.send(@method, "test", @tmp_file) }.should raise_error(Net::FTPPermError)
+    end
+
+    it "raises a Net::FTPPermError when the response code is 501" do
+      @server.should_receive(:eprt).and_respond("501 Syntax error in parameters or arguments.")
+      @server.should_receive(:port).and_respond("501 Syntax error in parameters or arguments.")
+      lambda { @ftp.send(@method, "test", @tmp_file) }.should raise_error(Net::FTPPermError)
+    end
+
+    it "raises a Net::FTPTempError when the response code is 421" do
+      @server.should_receive(:eprt).and_respond("421 Service not available, closing control connection.")
+      @server.should_receive(:port).and_respond("421 Service not available, closing control connection.")
+      lambda { @ftp.send(@method, "test", @tmp_file) }.should raise_error(Net::FTPTempError)
+    end
+
+    it "raises a Net::FTPPermError when the response code is 530" do
+      @server.should_receive(:eprt).and_respond("530 Not logged in.")
+      @server.should_receive(:port).and_respond("530 Not logged in.")
+      lambda { @ftp.send(@method, "test", @tmp_file) }.should raise_error(Net::FTPPermError)
+    end
+  end
+end