net-sftp 1.1.1 → 2.0.0

data/test/test_upload.rb

@@ -0,0 +1,219 @@
+require "common"
+
+class UploadTest < Net::SFTP::TestCase
+  def setup
+    prepare_progress!
+  end
+
+  def test_upload_file_should_send_file_contents
+    expect_file_transfer("/path/to/local", "/path/to/remote", "here are the contents")
+    assert_scripted_command { sftp.upload("/path/to/local", "/path/to/remote") }
+  end
+
+  def test_upload_file_with_progress_should_report_progress
+    expect_file_transfer("/path/to/local", "/path/to/remote", "here are the contents")
+
+    assert_scripted_command do
+      sftp.upload("/path/to/local", "/path/to/remote") { |*args| record_progress(args) }
+    end
+
+    assert_progress_reported_open(:remote => "/path/to/remote")
+    assert_progress_reported_put(0, "here are the contents", :remote => "/path/to/remote")
+    assert_progress_reported_close(:remote => "/path/to/remote")
+    assert_progress_reported_finish
+    assert_no_more_reported_events
+  end
+
+  def test_upload_file_with_progress_handler_should_report_progress
+    expect_file_transfer("/path/to/local", "/path/to/remote", "here are the contents")
+
+    assert_scripted_command do
+      sftp.upload("/path/to/local", "/path/to/remote", :progress => ProgressHandler.new(@progress))
+    end
+
+    assert_progress_reported_open(:remote => "/path/to/remote")
+    assert_progress_reported_put(0, "here are the contents", :remote => "/path/to/remote")
+    assert_progress_reported_close(:remote => "/path/to/remote")
+    assert_progress_reported_finish
+    assert_no_more_reported_events
+  end
+
+  def test_upload_file_should_read_chunks_of_size(requested_size=nil)
+    size = requested_size || Net::SFTP::Operations::Upload::DEFAULT_READ_SIZE
+    expect_sftp_session :server_version => 3 do |channel|
+      channel.sends_packet(FXP_OPEN, :long, 0, :string, "/path/to/remote", :long, 0x1A, :long, 0)
+      channel.gets_packet(FXP_HANDLE, :long, 0, :string, "handle")
+      channel.sends_packet(FXP_WRITE, :long, 1, :string, "handle", :int64, 0, :string, "a" * size)
+      channel.sends_packet(FXP_WRITE, :long, 2, :string, "handle", :int64, size, :string, "b" * size)
+      channel.sends_packet(FXP_WRITE, :long, 3, :string, "handle", :int64, size*2, :string, "c" * size)
+      channel.gets_packet(FXP_STATUS, :long, 1, :long, 0)
+      channel.sends_packet(FXP_WRITE, :long, 4, :string, "handle", :int64, size*3, :string, "d" * size)
+      channel.gets_packet(FXP_STATUS, :long, 2, :long, 0)
+      channel.sends_packet(FXP_CLOSE, :long, 5, :string, "handle")
+      channel.gets_packet(FXP_STATUS, :long, 3, :long, 0)
+      channel.gets_packet(FXP_STATUS, :long, 4, :long, 0)
+      channel.gets_packet(FXP_STATUS, :long, 5, :long, 0)
+    end
+
+    expect_file("/path/to/local", "a" * size + "b" * size + "c" * size + "d" * size)
+
+    assert_scripted_command do
+      opts = {}
+      opts[:read_size] = size if requested_size
+      sftp.upload("/path/to/local", "/path/to/remote", opts)
+    end
+  end
+
+  def test_upload_file_with_custom_read_size_should_read_chunks_of_that_size
+    test_upload_file_should_read_chunks_of_size(100)
+  end
+
+  def test_upload_file_with_custom_requests_should_start_that_many_writes
+    size = Net::SFTP::Operations::Upload::DEFAULT_READ_SIZE
+    expect_sftp_session :server_version => 3 do |channel|
+      channel.sends_packet(FXP_OPEN, :long, 0, :string, "/path/to/remote", :long, 0x1A, :long, 0)
+      channel.gets_packet(FXP_HANDLE, :long, 0, :string, "handle")
+      channel.sends_packet(FXP_WRITE, :long, 1, :string, "handle", :int64, 0, :string, "a" * size)
+      channel.sends_packet(FXP_WRITE, :long, 2, :string, "handle", :int64, size, :string, "b" * size)
+      channel.sends_packet(FXP_WRITE, :long, 3, :string, "handle", :int64, size*2, :string, "c" * size)
+      channel.sends_packet(FXP_WRITE, :long, 4, :string, "handle", :int64, size*3, :string, "d" * size)
+      channel.gets_packet(FXP_STATUS, :long, 1, :long, 0)
+      channel.sends_packet(FXP_CLOSE, :long, 5, :string, "handle")
+      channel.gets_packet(FXP_STATUS, :long, 2, :long, 0)
+      channel.gets_packet(FXP_STATUS, :long, 3, :long, 0)
+      channel.gets_packet(FXP_STATUS, :long, 4, :long, 0)
+      channel.gets_packet(FXP_STATUS, :long, 5, :long, 0)
+    end
+
+    expect_file("/path/to/local", "a" * size + "b" * size + "c" * size + "d" * size)
+
+    assert_scripted_command do
+      sftp.upload("/path/to/local", "/path/to/remote", :requests => 3)
+    end
+  end
+
+  def test_upload_directory_should_mirror_directory_structure_remotely
+    prepare_directory
+
+    assert_scripted_command do
+      sftp.upload("/path/to/local", "/path/to/remote")
+    end
+  end
+
+  def test_upload_directory_with_handler_should_report_progress
+    prepare_directory
+
+    assert_scripted_command do
+      sftp.upload("/path/to/local", "/path/to/remote") { |*args| record_progress(args) }
+    end
+
+    assert_progress_reported_open(:remote => "/path/to/remote/file1")
+    assert_progress_reported_open(:remote => "/path/to/remote/file2")
+    assert_progress_reported_open(:remote => "/path/to/remote/file3")
+    assert_progress_reported_mkdir("/path/to/remote/subdir")
+    assert_progress_reported_open(:remote => "/path/to/remote/subdir/other1")
+    assert_progress_reported_open(:remote => "/path/to/remote/subdir/other2")
+    assert_progress_reported_put(0, "contents of file1", :remote => "/path/to/remote/file1")
+    assert_progress_reported_put(0, "contents of file2", :remote => "/path/to/remote/file2")
+    assert_progress_reported_put(0, "contents of file3", :remote => "/path/to/remote/file3")
+    assert_progress_reported_close(:remote => "/path/to/remote/file1")
+    assert_progress_reported_put(0, "contents of other1", :remote => "/path/to/remote/subdir/other1")
+    assert_progress_reported_put(0, "contents of other2", :remote => "/path/to/remote/subdir/other2")
+    assert_progress_reported_close(:remote => "/path/to/remote/file2")
+    assert_progress_reported_close(:remote => "/path/to/remote/file3")
+    assert_progress_reported_close(:remote => "/path/to/remote/subdir/other1")
+    assert_progress_reported_close(:remote => "/path/to/remote/subdir/other2")
+    assert_progress_reported_finish
+    assert_no_more_reported_events
+  end
+
+  def test_upload_io_should_send_io_as_file
+    expect_sftp_session :server_version => 3 do |channel|
+      channel.sends_packet(FXP_OPEN, :long, 0, :string, "/path/to/remote", :long, 0x1A, :long, 0)
+      channel.gets_packet(FXP_HANDLE, :long, 0, :string, "handle")
+      channel.sends_packet(FXP_WRITE, :long, 1, :string, "handle", :int64, 0, :string, "this is some text")
+      channel.sends_packet(FXP_CLOSE, :long, 2, :string, "handle")
+      channel.gets_packet(FXP_STATUS, :long, 1, :long, 0)
+      channel.gets_packet(FXP_STATUS, :long, 2, :long, 0)
+    end
+
+    assert_scripted_command do
+      sftp.upload(StringIO.new("this is some text"), "/path/to/remote")
+    end
+  end
+
+  private
+
+    def prepare_directory
+      expect_directory("/path/to/local", %w(. .. file1 file2 file3 subdir))
+      expect_directory("/path/to/local/subdir", %w(. .. other1 other2))
+      expect_file("/path/to/local/file1", "contents of file1")
+      expect_file("/path/to/local/file2", "contents of file2")
+      expect_file("/path/to/local/file3", "contents of file3")
+      expect_file("/path/to/local/subdir/other1", "contents of other1")
+      expect_file("/path/to/local/subdir/other2", "contents of other2")
+
+      expect_sftp_session :server_version => 3 do |ch|
+        ch.sends_packet(FXP_MKDIR, :long, 0, :string, "/path/to/remote", :long, 0)
+        ch.gets_packet(FXP_STATUS, :long, 0, :long, 0)
+        ch.sends_packet(FXP_OPEN, :long, 1, :string, "/path/to/remote/file1", :long, 0x1A, :long, 0)
+        ch.sends_packet(FXP_OPEN, :long, 2, :string, "/path/to/remote/file2", :long, 0x1A, :long, 0)
+        ch.sends_packet(FXP_OPEN, :long, 3, :string, "/path/to/remote/file3", :long, 0x1A, :long, 0)
+        ch.sends_packet(FXP_MKDIR, :long, 4, :string, "/path/to/remote/subdir", :long, 0)
+        ch.sends_packet(FXP_OPEN, :long, 5, :string, "/path/to/remote/subdir/other1", :long, 0x1A, :long, 0)
+        ch.sends_packet(FXP_OPEN, :long, 6, :string, "/path/to/remote/subdir/other2", :long, 0x1A, :long, 0)
+        ch.gets_packet(FXP_HANDLE, :long, 1, :string, "hfile1")
+        ch.sends_packet(FXP_WRITE, :long, 7, :string, "hfile1", :int64, 0, :string, "contents of file1")
+        ch.gets_packet(FXP_HANDLE, :long, 2, :string, "hfile2")
+        ch.sends_packet(FXP_WRITE, :long, 8, :string, "hfile2", :int64, 0, :string, "contents of file2")
+        ch.gets_packet(FXP_HANDLE, :long, 3, :string, "hfile3")
+        ch.sends_packet(FXP_WRITE, :long, 9, :string, "hfile3", :int64, 0, :string, "contents of file3")
+        ch.gets_packet(FXP_STATUS, :long, 4, :long, 0)
+        ch.gets_packet(FXP_HANDLE, :long, 5, :string, "hother1")
+        ch.sends_packet(FXP_CLOSE, :long, 10, :string, "hfile1")
+        ch.sends_packet(FXP_WRITE, :long, 11, :string, "hother1", :int64, 0, :string, "contents of other1")
+        ch.gets_packet(FXP_HANDLE, :long, 6, :string, "hother2")
+        ch.sends_packet(FXP_WRITE, :long, 12, :string, "hother2", :int64, 0, :string, "contents of other2")
+        ch.gets_packet(FXP_STATUS, :long, 7, :long, 0)
+        ch.sends_packet(FXP_CLOSE, :long, 13, :string, "hfile2")
+        ch.gets_packet(FXP_STATUS, :long, 8, :long, 0)
+        ch.sends_packet(FXP_CLOSE, :long, 14, :string, "hfile3")
+        ch.gets_packet(FXP_STATUS, :long, 9, :long, 0)
+        ch.sends_packet(FXP_CLOSE, :long, 15, :string, "hother1")
+        ch.gets_packet(FXP_STATUS, :long, 10, :long, 0)
+        ch.sends_packet(FXP_CLOSE, :long, 16, :string, "hother2")
+        ch.gets_packet(FXP_STATUS, :long, 11, :long, 0)
+        ch.gets_packet(FXP_STATUS, :long, 12, :long, 0)
+        ch.gets_packet(FXP_STATUS, :long, 13, :long, 0)
+        ch.gets_packet(FXP_STATUS, :long, 14, :long, 0)
+        ch.gets_packet(FXP_STATUS, :long, 15, :long, 0)
+        ch.gets_packet(FXP_STATUS, :long, 16, :long, 0)
+      end
+    end
+
+    def expect_file(path, data)
+      File.stubs(:directory?).with(path).returns(false)
+      File.stubs(:exists?).with(path).returns(true)
+      file = StringIO.new(data)
+      file.stubs(:stat).returns(stub("stat", :size => data.length))
+      File.stubs(:open).with(path).returns(file)
+    end
+
+    def expect_directory(path, entries)
+      Dir.stubs(:entries).with(path).returns(entries)
+      File.stubs(:directory?).with(path).returns(true)
+    end
+
+    def expect_file_transfer(local, remote, data)
+      expect_sftp_session :server_version => 3 do |channel|
+        channel.sends_packet(FXP_OPEN, :long, 0, :string, remote, :long, 0x1A, :long, 0)
+        channel.gets_packet(FXP_HANDLE, :long, 0, :string, "handle")
+        channel.sends_packet(FXP_WRITE, :long, 1, :string, "handle", :int64, 0, :string, data)
+        channel.sends_packet(FXP_CLOSE, :long, 2, :string, "handle")
+        channel.gets_packet(FXP_STATUS, :long, 1, :long, 0)
+        channel.gets_packet(FXP_STATUS, :long, 2, :long, 0)
+      end
+
+      expect_file(local, data)
+    end
+end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification 
 name: net-sftp
 version: !ruby/object:Gem::Version 
-  version: 1.1.1
+  version: 2.0.0
 platform: ruby
 authors: 
 - Jamis Buck
-autorequire: net/sftp
+autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2008-02-25 00:00:00 -07:00
+date: 2008-05-01 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -19,12 +19,9 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 1.0.0
-    - - <
-      - !ruby/object:Gem::Version 
-        version: 1.99.0
+        version: 1.99.1
     version: 
-description: 
+description: A pure Ruby implementation of the SFTP client protocol
 email: jamis@jamisbuck.org
 executables: []
 
@@ -33,111 +30,62 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
-- doc/faq
-- doc/faq/faq.html
-- doc/faq/faq.rb
-- doc/faq/faq.yml
-- doc/LICENSE-BSD
-- doc/LICENSE-GPL
-- doc/LICENSE-RUBY
-- lib/net
-- lib/net/sftp
+- CHANGELOG.rdoc
+- lib/net/sftp/constants.rb
 - lib/net/sftp/errors.rb
-- lib/net/sftp/operations
-- lib/net/sftp/operations/abstract.rb
-- lib/net/sftp/operations/close.rb
-- lib/net/sftp/operations/errors.rb
-- lib/net/sftp/operations/fsetstat.rb
-- lib/net/sftp/operations/fstat.rb
-- lib/net/sftp/operations/lstat.rb
-- lib/net/sftp/operations/mkdir.rb
-- lib/net/sftp/operations/open.rb
-- lib/net/sftp/operations/opendir.rb
-- lib/net/sftp/operations/read.rb
-- lib/net/sftp/operations/readdir.rb
-- lib/net/sftp/operations/realpath.rb
-- lib/net/sftp/operations/remove.rb
-- lib/net/sftp/operations/rename.rb
-- lib/net/sftp/operations/rmdir.rb
-- lib/net/sftp/operations/services.rb
-- lib/net/sftp/operations/setstat.rb
-- lib/net/sftp/operations/stat.rb
-- lib/net/sftp/operations/write.rb
-- lib/net/sftp/protocol
-- lib/net/sftp/protocol/01
+- lib/net/sftp/operations/dir.rb
+- lib/net/sftp/operations/download.rb
+- lib/net/sftp/operations/file.rb
+- lib/net/sftp/operations/file_factory.rb
+- lib/net/sftp/operations/upload.rb
+- lib/net/sftp/packet.rb
 - lib/net/sftp/protocol/01/attributes.rb
-- lib/net/sftp/protocol/01/impl.rb
-- lib/net/sftp/protocol/01/packet-assistant.rb
-- lib/net/sftp/protocol/01/services.rb
-- lib/net/sftp/protocol/02
-- lib/net/sftp/protocol/02/impl.rb
-- lib/net/sftp/protocol/02/packet-assistant.rb
-- lib/net/sftp/protocol/02/services.rb
-- lib/net/sftp/protocol/03
-- lib/net/sftp/protocol/03/impl.rb
-- lib/net/sftp/protocol/03/packet-assistant.rb
-- lib/net/sftp/protocol/03/services.rb
-- lib/net/sftp/protocol/04
+- lib/net/sftp/protocol/01/base.rb
+- lib/net/sftp/protocol/01/name.rb
+- lib/net/sftp/protocol/02/base.rb
+- lib/net/sftp/protocol/03/base.rb
 - lib/net/sftp/protocol/04/attributes.rb
-- lib/net/sftp/protocol/04/impl.rb
-- lib/net/sftp/protocol/04/packet-assistant.rb
-- lib/net/sftp/protocol/04/services.rb
-- lib/net/sftp/protocol/05
-- lib/net/sftp/protocol/05/impl.rb
-- lib/net/sftp/protocol/05/packet-assistant.rb
-- lib/net/sftp/protocol/05/services.rb
-- lib/net/sftp/protocol/constants.rb
-- lib/net/sftp/protocol/driver.rb
-- lib/net/sftp/protocol/packet-assistant.rb
-- lib/net/sftp/protocol/services.rb
+- lib/net/sftp/protocol/04/base.rb
+- lib/net/sftp/protocol/04/name.rb
+- lib/net/sftp/protocol/05/base.rb
+- lib/net/sftp/protocol/06/attributes.rb
+- lib/net/sftp/protocol/06/base.rb
+- lib/net/sftp/protocol/base.rb
+- lib/net/sftp/protocol.rb
+- lib/net/sftp/request.rb
+- lib/net/sftp/response.rb
 - lib/net/sftp/session.rb
 - lib/net/sftp/version.rb
 - lib/net/sftp.rb
-- lib/uri
-- lib/uri/open-sftp.rb
-- lib/uri/sftp.rb
-- examples/asynchronous.rb
-- examples/get-put.rb
-- examples/sftp-open-uri.rb
-- examples/ssh-service.rb
-- examples/synchronous.rb
-- test/ALL-TESTS.rb
-- test/operations
-- test/operations/tc_abstract.rb
-- test/operations/tc_close.rb
-- test/operations/tc_fsetstat.rb
-- test/operations/tc_fstat.rb
-- test/operations/tc_lstat.rb
-- test/operations/tc_mkdir.rb
-- test/operations/tc_open.rb
-- test/operations/tc_opendir.rb
-- test/operations/tc_read.rb
-- test/operations/tc_readdir.rb
-- test/operations/tc_realpath.rb
-- test/operations/tc_remove.rb
-- test/operations/tc_rmdir.rb
-- test/operations/tc_setstat.rb
-- test/operations/tc_stat.rb
-- test/operations/tc_write.rb
-- test/protocol
-- test/protocol/01
-- test/protocol/01/tc_attributes.rb
-- test/protocol/01/tc_impl.rb
-- test/protocol/01/tc_packet_assistant.rb
-- test/protocol/02
-- test/protocol/02/tc_impl.rb
-- test/protocol/02/tc_packet_assistant.rb
-- test/protocol/03
-- test/protocol/03/tc_impl.rb
-- test/protocol/03/tc_packet_assistant.rb
-- test/protocol/04
-- test/protocol/04/tc_attributes.rb
-- test/protocol/04/tc_impl.rb
-- test/protocol/04/tc_packet_assistant.rb
-- test/protocol/05
-- test/protocol/05/tc_impl.rb
-- test/protocol/05/tc_packet_assistant.rb
-- test/protocol/tc_driver.rb
+- Rakefile
+- README.rdoc
+- setup.rb
+- test/common.rb
+- test/protocol/01/test_attributes.rb
+- test/protocol/01/test_base.rb
+- test/protocol/01/test_name.rb
+- test/protocol/02/test_base.rb
+- test/protocol/03/test_base.rb
+- test/protocol/04/test_attributes.rb
+- test/protocol/04/test_base.rb
+- test/protocol/04/test_name.rb
+- test/protocol/05/test_base.rb
+- test/protocol/06/test_attributes.rb
+- test/protocol/06/test_base.rb
+- test/protocol/test_base.rb
+- test/test_all.rb
+- test/test_dir.rb
+- test/test_download.rb
+- test/test_file.rb
+- test/test_file_factory.rb
+- test/test_packet.rb
+- test/test_protocol.rb
+- test/test_request.rb
+- test/test_response.rb
+- test/test_session.rb
+- test/test_upload.rb
+- Manifest
+- net-sftp.gemspec
 has_rdoc: true
 homepage: http://net-ssh.rubyforge.org/sftp
 post_install_message: 
@@ -159,10 +107,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   version: 
 requirements: []
 
-rubyforge_project: 
-rubygems_version: 1.0.0
+rubyforge_project: net-ssh
+rubygems_version: 1.1.1
 signing_key: 
 specification_version: 2
-summary: Net::SFTP is a pure-Ruby implementation of the SFTP client protocol.
+summary: A pure Ruby implementation of the SFTP client protocol
 test_files: 
-- test/ALL-TESTS.rb
+- test/test_all.rb

data/doc/LICENSE-BSD

@@ -1,27 +0,0 @@
-Copyright (c) 2004, Jamis Buck (jamis@37signals.com)
-All rights reserved.
-
-Redistribution and use in source and binary forms, with or without
-modification, are permitted provided that the following conditions are met:
-
-    * Redistributions of source code must retain the above copyright notice,
-      this list of conditions and the following disclaimer.
-
-    * Redistributions in binary form must reproduce the above copyright
-      notice, this list of conditions and the following disclaimer in the
-      documentation and/or other materials provided with the distribution.
-
-    * The names of its contributors may not be used to endorse or promote
-      products derived from this software without specific prior written
-      permission.
-
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
-AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
-IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
-DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
-FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
-DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
-SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
-CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
-OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.