net-sftp 0.5.0 → 0.9.0

data/examples/get-put.rb

@@ -0,0 +1,45 @@
+#--
+# =============================================================================
+# Copyright (c) 2004, Jamis Buck (jgb3@email.byu.edu)
+# 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/ssh-service.rb

@@ -21,7 +21,6 @@ require 'net/sftp'
 Net::SSH.start( 'localhost' ) do |session|
   session.sftp.connect do |sftp|
     h = sftp.opendir( "." )
-    session.loop { sftp.state != :open }
     sftp.readdir( h ).sort { |a,b| a.filename <=> b.filename }.each do |item|
       puts "%06o %6d %-20s" %
         [ item.attributes.permissions, item.attributes.size, item.filename ]

data/examples/synchronous.rb

@@ -22,21 +22,30 @@ Net::SFTP.start( 'localhost',
 ) do |sftp|
   puts "----------------------------------------------"
   puts "getting handle..."
-  handle = sftp.open( "temp/out" )
+  handle = sftp.open_handle( "temp/out" )
   puts "got handle: #{handle.inspect}"
   puts "reading..."
   data = sftp.read( handle )
   puts "got data: #{data.length} bytes"
   sftp.close_handle( handle )
 
+  puts "----------------------------------------------"
+  puts "getting handle..."
+  sftp.open_handle( "temp/out" ) do |handle|
+    puts "got handle: #{handle.inspect}"
+    puts "reading..."
+    data = sftp.read( handle )
+    puts "got data: #{data.length} bytes"
+  end
+
   puts "----------------------------------------------"
   puts "opening handle for writing..."
-  handle = sftp.open( "temp/blah", IO::WRONLY | IO::CREAT )
-  puts "got handle: #{handle.inspect}"
-  data = "1234567890" * 100
-  puts "writing #{data.length} bytes..."
-  p sftp.write( handle, data ).code
-  sftp.close_handle( handle )
+  sftp.open_handle( "temp/blah", "w" ) do |handle|
+    puts "got handle: #{handle.inspect}"
+    data = "1234567890" * 100
+    puts "writing #{data.length} bytes..."
+    p sftp.write( handle, data ).code
+  end
 
   puts "----------------------------------------------"
   puts "opening handle for writing..."

data/lib/net/sftp/operations/abstract.rb

@@ -49,12 +49,13 @@ module Net ; module SFTP ; module Operations
       @log.debug "executing" if @log.debug?
 
       unless block_given?
+        status = result = nil
         callback = Proc.new do |status, *pargs|
-          @session.status = status
-          case
-            when pargs.empty? then return @session.status
-            when pargs.length == 1 then return pargs.first
-            else return pargs
+          status = status
+          result = case
+            when pargs.empty? then @session.status
+            when pargs.length == 1 then pargs.first
+            else pargs
           end
         end
       end
@@ -64,7 +65,11 @@ module Net ; module SFTP ; module Operations
       @log.debug "received request id #{@id}"
       @session.register( @id, self )
 
-      @session.loop unless block_given?
+      unless block_given?
+        @session.loop { status.nil? }
+        @session.status = status
+        return result
+      end
     end
 
     # A callback for SFTP status packets. By default, raises an exception unless

data/lib/net/sftp/session.rb

@@ -114,7 +114,7 @@ module Net ; module SFTP
     # the SFTP protocol has not yet been negotiated and no underlying driver has
     # been selected.
     #
-    # If no block is given, it teturns +self+, so it can be chained easily to
+    # If no block is given, it returns +self+, so it can be chained easily to
     # other method calls. If a block _is_ given, the session is yielded to the
     # block as soon as the driver successfully reports it's state as +open+,
     # with the session's channel being closed automatically when the block
@@ -143,6 +143,54 @@ module Net ; module SFTP
         self
       end
     end
+
+    # Opens the given remote file and returns a handle to it, which may be used
+    # with other operations (read, write, etc.). If a block is given, the handle
+    # will be yielded to it and closed when the block finishes, otherwise the
+    # handle will be returned. If the flags parameter is a numeric value, it
+    # must be a combination of IO constants, otherwise, it should be a string
+    # such as given to File.open.
+    def open_handle( path, flags=IO::RDONLY, mode=0660 )
+      if String === flags
+        flags = case flags
+          when "r" then IO::RDONLY
+          when "r+" then IO:RDWR
+          when "w" then IO::WRONLY | IO::CREAT | IO::TRUNC
+          when "w+" then IO::RDWR | IO::CREAT | IO::TRUNC
+          when "a" then IO::APPEND | IO::CREAT
+          when "a+" then IO::APPEND | IO::CREAT
+          else IO::RDONLY
+        end
+      end
+
+      handle = self.open( path, flags, mode )
+      if block_given?
+        begin
+          yield handle
+        ensure
+          close_handle( handle )
+        end
+      else
+        return handle
+      end
+    end
+
+    # Retrieves the given remote file to the given local path. This will
+    # overwrite any file at the local path name. The remote file must
+    # exist.
+    def get_file( remote_path, local_path )
+      open_handle( remote_path ) do |handle|
+        contents = read( handle )
+        File.open( local_path, "w" ) { |f| f.write contents }
+      end
+    end
+
+    # This stores the given local file at the given remote path. This will
+    # overwrite any file at the remote path name. The local file must exist.
+    def put_file( local_path, remote_path )
+      contents = File.read( local_path )
+      open_handle( remote_path, "w" ) { |handle| write( handle, contents ) }
+    end
     
     #--
     # ====================================================================

data/lib/net/sftp/version.rb

@@ -17,7 +17,7 @@
 module Net ; module SFTP ; module Version
 
   MAJOR = 0
-  MINOR = 5
+  MINOR = 9
   TINY  = 0
 
   STRING = [MAJOR,MINOR,TINY].join('.')

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.8.1
+rubygems_version: 0.8.4
 specification_version: 1
 name: net-sftp
 version: !ruby/object:Gem::Version 
-  version: 0.5.0
-date: 2004-12-01
+  version: 0.9.0
+date: 2005-01-11
 summary: Net::SFTP is a pure-Ruby implementation of the SFTP client protocol.
 require_paths: 
   - lib
-author: Jamis Buck
 email: jgb3@email.byu.edu
 homepage: http://net-ssh.rubyforge.org/sftp
 rubyforge_project: 
@@ -25,6 +24,8 @@ required_ruby_version: !ruby/object:Gem::Version::Requirement
         version: 0.0.0
   version: 
 platform: ruby
+authors: 
+  - Jamis Buck
 files: 
   - doc/LICENSE-RUBY
   - doc/LICENSE-BSD
@@ -80,6 +81,7 @@ files:
   - lib/net/sftp/protocol/04/services.rb
   - lib/net/sftp/protocol/04/impl.rb
   - lib/net/sftp/protocol/05/services.rb
+  - examples/get-put.rb
   - examples/ssh-service.rb
   - examples/synchronous.rb
   - examples/asynchronous.rb