RubyGems - net-sftp - Versions diffs - 1.1.1 → 2.0.0 - Mend

net-sftp 1.1.1 → 2.0.0

Files changed (138) hide show

data/CHANGELOG.rdoc +23 -0
data/Manifest +55 -0
data/README.rdoc +96 -0
data/Rakefile +30 -0
data/lib/net/sftp.rb +53 -38
data/lib/net/sftp/constants.rb +187 -0
data/lib/net/sftp/errors.rb +34 -20
data/lib/net/sftp/operations/dir.rb +93 -0
data/lib/net/sftp/operations/download.rb +364 -0
data/lib/net/sftp/operations/file.rb +176 -0
data/lib/net/sftp/operations/file_factory.rb +60 -0
data/lib/net/sftp/operations/upload.rb +387 -0
data/lib/net/sftp/packet.rb +21 -0
data/lib/net/sftp/protocol.rb +32 -0
data/lib/net/sftp/protocol/01/attributes.rb +265 -96
data/lib/net/sftp/protocol/01/base.rb +268 -0
data/lib/net/sftp/protocol/01/name.rb +43 -0
data/lib/net/sftp/protocol/02/base.rb +31 -0
data/lib/net/sftp/protocol/03/base.rb +35 -0
data/lib/net/sftp/protocol/04/attributes.rb +120 -195
data/lib/net/sftp/protocol/04/base.rb +94 -0
data/lib/net/sftp/protocol/04/name.rb +67 -0
data/lib/net/sftp/protocol/05/base.rb +66 -0
data/lib/net/sftp/protocol/06/attributes.rb +107 -0
data/lib/net/sftp/protocol/06/base.rb +63 -0
data/lib/net/sftp/protocol/base.rb +50 -0
data/lib/net/sftp/request.rb +91 -0
data/lib/net/sftp/response.rb +76 -0
data/lib/net/sftp/session.rb +914 -238
data/lib/net/sftp/version.rb +14 -21
data/net-sftp.gemspec +60 -0
data/setup.rb +1331 -0
data/test/common.rb +173 -0
data/test/protocol/01/test_attributes.rb +97 -0
data/test/protocol/01/test_base.rb +210 -0
data/test/protocol/01/test_name.rb +27 -0
data/test/protocol/02/test_base.rb +26 -0
data/test/protocol/03/test_base.rb +27 -0
data/test/protocol/04/test_attributes.rb +148 -0
data/test/protocol/04/test_base.rb +74 -0
data/test/protocol/04/test_name.rb +49 -0
data/test/protocol/05/test_base.rb +62 -0
data/test/protocol/06/test_attributes.rb +124 -0
data/test/protocol/06/test_base.rb +51 -0
data/test/protocol/test_base.rb +42 -0
data/test/test_all.rb +3 -0
data/test/test_dir.rb +47 -0
data/test/test_download.rb +252 -0
data/test/test_file.rb +159 -0
data/test/test_file_factory.rb +48 -0
data/test/test_packet.rb +9 -0
data/test/test_protocol.rb +17 -0
data/test/test_request.rb +71 -0
data/test/test_response.rb +53 -0
data/test/test_session.rb +741 -0
data/test/test_upload.rb +219 -0
metadata +59 -111
data/doc/LICENSE-BSD +0 -27
data/doc/LICENSE-GPL +0 -280
data/doc/LICENSE-RUBY +0 -56
data/doc/faq/faq.html +0 -298
data/doc/faq/faq.rb +0 -154
data/doc/faq/faq.yml +0 -183
data/examples/asynchronous.rb +0 -57
data/examples/get-put.rb +0 -45
data/examples/sftp-open-uri.rb +0 -30
data/examples/ssh-service.rb +0 -30
data/examples/synchronous.rb +0 -131
data/lib/net/sftp/operations/abstract.rb +0 -108
data/lib/net/sftp/operations/close.rb +0 -31
data/lib/net/sftp/operations/errors.rb +0 -76
data/lib/net/sftp/operations/fsetstat.rb +0 -36
data/lib/net/sftp/operations/fstat.rb +0 -32
data/lib/net/sftp/operations/lstat.rb +0 -31
data/lib/net/sftp/operations/mkdir.rb +0 -33
data/lib/net/sftp/operations/open.rb +0 -32
data/lib/net/sftp/operations/opendir.rb +0 -32
data/lib/net/sftp/operations/read.rb +0 -88
data/lib/net/sftp/operations/readdir.rb +0 -55
data/lib/net/sftp/operations/realpath.rb +0 -37
data/lib/net/sftp/operations/remove.rb +0 -31
data/lib/net/sftp/operations/rename.rb +0 -32
data/lib/net/sftp/operations/rmdir.rb +0 -31
data/lib/net/sftp/operations/services.rb +0 -42
data/lib/net/sftp/operations/setstat.rb +0 -33
data/lib/net/sftp/operations/stat.rb +0 -31
data/lib/net/sftp/operations/write.rb +0 -63
data/lib/net/sftp/protocol/01/impl.rb +0 -251
data/lib/net/sftp/protocol/01/packet-assistant.rb +0 -82
data/lib/net/sftp/protocol/01/services.rb +0 -47
data/lib/net/sftp/protocol/02/impl.rb +0 -39
data/lib/net/sftp/protocol/02/packet-assistant.rb +0 -32
data/lib/net/sftp/protocol/02/services.rb +0 -44
data/lib/net/sftp/protocol/03/impl.rb +0 -42
data/lib/net/sftp/protocol/03/packet-assistant.rb +0 -35
data/lib/net/sftp/protocol/03/services.rb +0 -44
data/lib/net/sftp/protocol/04/impl.rb +0 -86
data/lib/net/sftp/protocol/04/packet-assistant.rb +0 -45
data/lib/net/sftp/protocol/04/services.rb +0 -44
data/lib/net/sftp/protocol/05/impl.rb +0 -90
data/lib/net/sftp/protocol/05/packet-assistant.rb +0 -34
data/lib/net/sftp/protocol/05/services.rb +0 -44
data/lib/net/sftp/protocol/constants.rb +0 -60
data/lib/net/sftp/protocol/driver.rb +0 -235
data/lib/net/sftp/protocol/packet-assistant.rb +0 -84
data/lib/net/sftp/protocol/services.rb +0 -55
data/lib/uri/open-sftp.rb +0 -54
data/lib/uri/sftp.rb +0 -42
data/test/ALL-TESTS.rb +0 -23
data/test/operations/tc_abstract.rb +0 -124
data/test/operations/tc_close.rb +0 -40
data/test/operations/tc_fsetstat.rb +0 -48
data/test/operations/tc_fstat.rb +0 -40
data/test/operations/tc_lstat.rb +0 -40
data/test/operations/tc_mkdir.rb +0 -48
data/test/operations/tc_open.rb +0 -42
data/test/operations/tc_opendir.rb +0 -40
data/test/operations/tc_read.rb +0 -103
data/test/operations/tc_readdir.rb +0 -88
data/test/operations/tc_realpath.rb +0 -54
data/test/operations/tc_remove.rb +0 -40
data/test/operations/tc_rmdir.rb +0 -40
data/test/operations/tc_setstat.rb +0 -48
data/test/operations/tc_stat.rb +0 -40
data/test/operations/tc_write.rb +0 -91
data/test/protocol/01/tc_attributes.rb +0 -138
data/test/protocol/01/tc_impl.rb +0 -294
data/test/protocol/01/tc_packet_assistant.rb +0 -81
data/test/protocol/02/tc_impl.rb +0 -41
data/test/protocol/02/tc_packet_assistant.rb +0 -31
data/test/protocol/03/tc_impl.rb +0 -48
data/test/protocol/03/tc_packet_assistant.rb +0 -34
data/test/protocol/04/tc_attributes.rb +0 -174
data/test/protocol/04/tc_impl.rb +0 -91
data/test/protocol/04/tc_packet_assistant.rb +0 -38
data/test/protocol/05/tc_impl.rb +0 -61
data/test/protocol/05/tc_packet_assistant.rb +0 -32
data/test/protocol/tc_driver.rb +0 -219

data/doc/faq/faq.rb DELETED Viewed

@@ -1,154 +0,0 @@
-#--
-# =============================================================================
-# Copyright (c) 2005, Jamis Buck (jamis@jamisbuck.org)
-# 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.
-# =============================================================================
-#++
-require 'yaml'
-require 'redcloth'
-def process_faq_list( faqs )
-  puts "<ul>"
-  faqs.each do |faq|
-    process_faq_list_item faq
-  end
-  puts "</ul>"
-end
-def process_faq_list_item( faq )
-  question = faq.keys.first
-  answer = faq.values.first
-  print "<li>"
-  question_text = RedCloth.new(question).to_html.gsub( %r{</?p>},"" )
-  if answer.is_a?( Array )
-    puts question_text
-    process_faq_list answer
-  else
-    print "<a href='##{question.object_id}'>#{question_text}</a>"
-  end
-  puts "</li>"
-end
-def process_faq_descriptions( faqs, path=nil )
-  faqs.each do |faq|
-    process_faq_description faq, path
-  end
-end
-def process_faq_description( faq, path )
-  question = faq.keys.first
-  path = ( path ? path + " " : "" ) + question
-  answer = faq.values.first
-  if answer.is_a?( Array )
-    process_faq_descriptions( answer, path )
-  else
-    title = RedCloth.new( path ).to_html.gsub( %r{</?p>}, "" )
-    answer = RedCloth.new( answer || "" )
-    puts "<a name='#{question.object_id}'></a>"
-    puts "<div class='faq-title'>#{title}</div>"
-    puts "<div class='faq-answer'>#{answer.to_html}</div>"
-  end
-end
-faqs = YAML.load( File.read( "faq.yml" ) )
-puts <<-EOF
-<html>
-  <head>
-    <title>Net::SFTP FAQ</title>
-    <style type="text/css">
-      a, a:visited, a:active {
-        color: #00F;
-        text-decoration: none;
-      }
-      a:hover {
-        text-decoration: underline;
-      }
-      .faq-list {
-        color: #000;
-        font-family: vera-sans, verdana, arial, sans-serif;
-      }
-      .faq-title {
-        background: #007;
-        color: #FFF;
-        font-family: vera-sans, verdana, arial, sans-serif;
-        padding-left: 1em;
-        padding-top: 0.5em;
-        padding-bottom: 0.5em;
-        font-weight: bold;
-        font-size: large;
-        border: 1px solid #000;
-      }
-      .faq-answer {
-        margin-left: 1em;
-        color: #000;
-        font-family: vera-sans, verdana, arial, sans-serif;
-      }
-      .faq-answer pre {
-        margin-left: 1em;
-        color: #000;
-        background: #FFE;
-        font-size: normal;
-        border: 1px dotted #CCC;
-        padding: 1em;
-      }
-      h1 {
-        background: #005;
-        color: #FFF;
-        font-family: vera-sans, verdana, arial, sans-serif;
-        padding-left: 1em;
-        padding-top: 1em;
-        padding-bottom: 1em;
-        font-weight: bold;
-        font-size: x-large;
-        border: 1px solid #00F;
-      }
-    </style>
-  </head>
-  <body>
-  <h1>Net::SFTP FAQ</h1>
-  <div class="faq-list">
-EOF
-process_faq_list( faqs )
-puts "</div>"
-process_faq_descriptions( faqs )
-puts "</body></html>"

data/doc/faq/faq.yml DELETED Viewed

@@ -1,183 +0,0 @@
----
-- "What is Net::SFTP?": |
-    Net::SFTP is a pure-Ruby implementation of the SFTP protocol. That's
-    "SFTP" as in "Secure File Transfer Protocol", as defined as an adjuct to the
-    SSH specification. _Not_ "SFTP" as in "Secure FTP" (a _completely_ different
-    beast). Nor is it an implementation of the "Simple File Transfer Protocol"
-    (which is in no way secure).
-- "How do I...":
-  - "...connect to an SFTP server?":
-    - "I'd like to connect without first getting a Net::SSH connection...": |
-        Something like this:
-        <code><pre>
-          require 'net/sftp'
-          Net::SFTP.start(host, user, password) do |sftp|
-            ...
-          end
-        </pre></code>
-        @Net::SFTP.start@ accepts the same parameters as @Net::SSH.start@,
-        so I'll direct you to that documentation for all the particulars.
-    - "I already have an open Net::SSH connection...": |
-        You can piggy-back an SFTP connection on an existing Net::SSH
-        connection, which can be useful if you've already got an SSH
-        connection that you're using for port forwarding or whatever.
-        <code><pre>
-          require 'net/ssh'
-          require 'net/sftp'
-          Net::SSH.start(host, user, password) do |ssh|
-            ...
-            ssh.sftp.connect do |sftp|
-              ...
-            end
-            ...
-          end
-        </pre></code>
-  - "...upload data?":
-    - "I want to upload an entire file on disk...": |
-        Assuming you already have an SFTP connection:
-        <code><pre>
-          sftp.put_file "/path/to/local.file", "/path/to/remote.file"
-        </pre></code>
-    - "I want to upload bytes from a string or other object...": |
-        Assuming you already have an SFTP connection, and your data is stored
-        in a string named @data@:
-        <code><pre>
-          sftp.open_handle("/path/to/remote.file", "w") do |handle|
-            result = sftp.write(handle, data)
-            puts result.code # the result of the operation
-          end
-        </pre></code>
-        If (for whatever reason) you'd rather not use blocks, you can do
-        without, but be sure to call @close_handle@ when you're done:
-        <code><pre>
-          handle = sftp.open_handle("/path/to/remote.file", "w")
-          result = sftp.write(handle, data)
-          puts result.code # the result of the operation
-          sftp.close_handle(handle)
-        </pre></code>
-  - "...download data?":
-    - "I want to download directly to a local file...": |
-        Assuming you already have an SFTP connection:
-        <code><pre>
-          sftp.get_file "/path/to/remote.file", "/path/to/local.file"
-        </pre></code>
-    - "I want to download to a string in memory...": |
-        Assuming you already have an SFTP connection:
-        <code><pre>
-          data = nil
-          sftp.open_handle("/path/to/remote.file") do |handle|
-            data = sftp.read(handle)
-          end
-        </pre></code>
-    - "I want to be notified of the progress of the download...": |
-        You can specify both a "chunk size" and a "progress callback". The
-        callback will be invoked for every "chunk size" bytes that are
-        received:
-        <code><pre>
-          sftp.open_handle("/path/to/remote.file") do |handle|
-            begin
-              STDOUT.sync = true
-              data = sftp.read(handle, :chunk_size => 4096,
-                :progress_callback => lambda { |data| print "." })
-              puts
-            ensure
-              STDOUT.sync = false
-            end
-          end
-        </pre></code>
-  - "...manage file permissions?":
-      - "I want to query a file's permissions...": |
-          File permissions are one of the @stat@ attributes of files and
-          directories:
-          <code><pre>
-            p sftp.stat("/path/to/remote.file").permissions
-          </pre></code>
-      - "I want to change a file's permissions...": |
-          Just use @setstat@ to change the permissions of an existing file:
-          <code><pre>
-            sftp.setstat("/path/to/remote.file", :permissions => 0644)
-          </pre></code>
-      - "I already have an open handle for the remote file...": |
-          If you have a handle for the remote file, you can use @fstat@ and
-          @fsetstat@ to query and set the permissions:
-          <code><pre>
-            sftp.open_handle("/path/to/remote.file") do |handle|
-              permissions = sftp.fstat(handle)
-              sftp.fsetstat(handle, :permissions => permissions | 0444)
-            end
-          </pre></code>
-  - "...manage directories?":
-    - "I want to query the contents of a directory...": |
-        You query the contents of a directory by calling @opendir@ to obtain
-        a handle to the directory, and then using @readdir@ on the handle to
-        obtain a list of directory entries. Be sure to close the handle when
-        you're done:
-        <code><pre>
-          handle = sftp.opendir("/usr/lib")
-          items = sftp.readdir(handle)
-          items.each do |item|
-            puts item.filename
-            puts item.longname
-            p item.attributes # permissions, atime, etc.
-          end
-          sftp.close_handle(handle)
-        </pre></code>
-    - "I want to create a directory...": |
-        Use @mkdir@:
-        <code><pre>
-          sftp.mkdir("/path/to/remote/dir", :permissions => 0500)
-        </pre></code>
-    - "I want to remove a directory...": |
-        Use @rmdir@:
-        <code><pre>
-          sftp.rmdir("/path/to/remote/dir")
-        </pre></code>
-  - "...delete a file?": |
-      Use @remove@:
-      <code><pre>
-        sftp.remove("/path/to/remote.file")
-      </pre></code>
-  - "...rename a file?": |
-      Use @rename@:
-      <code><pre>
-        sftp.rename("/path/to/remote.file", "/path/to/new.file")
-      </pre></code>
-      It should be noted that @rename@ is only supported by version 2 or
-      later of the SFTP protocol, so if you're using an older SFTP server you
-      might not be able to use this operation.

data/examples/asynchronous.rb DELETED Viewed

@@ -1,57 +0,0 @@
-#--
-# =============================================================================
-# Copyright (c) 2004, Jamis Buck (jamis@37signals.com)
-# All rights reserved.
-#
-# This source file is distributed as part of the Net::SFTP Secure FTP Client
-# library for Ruby. This file (and the library as a whole) may be used only as
-# allowed by either the BSD license, or the Ruby license (or, by association
-# with the Ruby license, the GPL). See the "doc" subdirectory of the Net::SFTP
-# distribution for the texts of these licenses.
-# -----------------------------------------------------------------------------
-# net-sftp website: http://net-ssh.rubyforge.org/sftp
-# project website : http://rubyforge.org/projects/net-ssh
-# =============================================================================
-#++
-$:.unshift "../lib"
-require 'net/sftp'
-Net::SFTP.start( 'localhost',
-  :registry_options => { :logs => { :levels => { "sftp.*" => :debug } } }
-) do |sftp|
-  closed = 0
-  size = sftp.stat( "temp/out" ).size
-  # setting this to a higher value typically causes problems...looks like it
-  # might be a problem with OpenSSH, but I'm not sure.
-  parts = 5
-  chunk_size = size / parts
-  chunks = []
-  # Set up 'parts' read operations, each one pulling from a different segment
-  # of the file. Each of these will be run in parallel.
-  parts.times do |part|
-    sftp.open( "temp/out" ) do |s,h|
-      puts "----------------------------------------------"
-      puts "got handle ##{part+1} (#{h.inspect})"
-      sftp.read( h, chunk_size*part, chunk_size ) do |s,data|
-        puts "----------------------------------------------"
-        puts "got data ##{part+1} (#{data.length} bytes)"
-        chunks[part] = data
-        sftp.close_handle( h ) do
-          closed += 1
-          sftp.close_channel if closed == parts
-        end
-      end
-    end
-  end
-  sftp.loop
-  puts "----------------------------------------------"
-  data = chunks.join
-  puts "done! (#{data.length} bytes)"
-end

data/examples/get-put.rb DELETED Viewed

@@ -1,45 +0,0 @@
-#--
-# =============================================================================
-# Copyright (c) 2004, Jamis Buck (jamis@37signals.com)
-# All rights reserved.
-#
-# This source file is distributed as part of the Net::SFTP Secure FTP Client
-# library for Ruby. This file (and the library as a whole) may be used only as
-# allowed by either the BSD license, or the Ruby license (or, by association
-# with the Ruby license, the GPL). See the "doc" subdirectory of the Net::SFTP
-# distribution for the texts of these licenses.
-# -----------------------------------------------------------------------------
-# net-sftp website: http://net-ssh.rubyforge.org/sftp
-# project website : http://rubyforge.org/projects/net-ssh
-# =============================================================================
-#++
-$:.unshift "../lib"
-require 'net/sftp'
-Net::SFTP.start( 'localhost',
-  :registry_options => { :logs => { :levels => { "sftp.*" => :debug } } }
-) do |sftp|
-  File.open( "test.data", "w" ) { |f| f.write "012345789"*10000 }
-  puts "putting local file to remote location..."
-  sftp.put_file "test.data", "temp/blah.data"
-  puts "getting remote file to local location..."
-  sftp.get_file "temp/blah.data", "new.data"
-  sftp.remove "temp/blah.data"
-  if !File.exist? "new.data"
-    warn "----\n" +
-         "something went wrong---'new.data' was apparently not created..." +
-         "----\n"
-  else
-    File.delete "new.data"
-  end
-  File.delete "test.data"
-  puts "----------------------------------------------"
-  puts "done!"
-end

data/examples/sftp-open-uri.rb DELETED Viewed

@@ -1,30 +0,0 @@
-#--
-# =============================================================================
-# Copyright (c) 2004, Jamis Buck (jamis@37signals.com)
-# All rights reserved.
-#
-# This source file is distributed as part of the Net::SFTP Secure FTP Client
-# library for Ruby. This file (and the library as a whole) may be used only as
-# allowed by either the BSD license, or the Ruby license (or, by association
-# with the Ruby license, the GPL). See the "doc" subdirectory of the Net::SFTP
-# distribution for the texts of these licenses.
-# -----------------------------------------------------------------------------
-# net-sftp website: http://net-ssh.rubyforge.org/sftp
-# project website : http://rubyforge.org/projects/net-ssh
-# =============================================================================
-#++
-$:.unshift "../lib"
-require 'uri/open-sftp'
-uri = URI.parse( "sftp://localhost" +
-                 "/home/jgb3/temp/out" +
-                 "?encryption=blowfish-cbc&compression=zlib" )
-data = uri.open.read
-p data.length
-stream = uri.open( :chunk_size=>128,
-                   :progress_proc => proc { |d| print "."; $stdout.flush } )
-puts
-p stream.read.length