xftp 0.3.3 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0959975377a49b36adef1ae39718a0b40064a3da
-  data.tar.gz: d347086da5b53feb27daea0519e5007b3c2b8238
+  metadata.gz: 519e2c6a592998d81cfcff39a0b07896de6d107a
+  data.tar.gz: 7c964302e0290616bb71e32fa2da427804c0a839
 SHA512:
-  metadata.gz: 5d3313732ffa95e9703406ef8512c3b05c6a3d98949e84e72d8e740cbbe30c034bd57cf16cd01f8f611a10c09b91e4fedf9758ae7f4f21cb5b40e1e24bdbe932
-  data.tar.gz: c6529b38a432105281887a42a7c15acb2e27cb8b7f541400acbcf7b04fcf4f8fc3e55efa91f61317df2ac76095771a67aafd8f585e0ed30d65541a4b5e4f757f
+  metadata.gz: 21e2e2c9f5d002ea1cbb48bafb28fb08f1e6645ba5eac6d1131dcf1093b8b1f1458cbc0ea077c951cdf6ac4267e38fdd9728f0f46b33a4432504900a91cf3b4a
+  data.tar.gz: 06b5984a465cefa1e955550d5dfc0859d5f995fa7ce3294c7f7985e66c2e4cf9afcbc3cd4a31e86d9047c335f28952932bf10598386182f7acfa8c31f2703249

data/README.md

@@ -17,8 +17,9 @@ or
 $ gem install xftp
 ```
 
-## Usage
+## Usage examples
 
+Basic example:
 ```ruby
 XFTP.start('ftps://hostname', credentials: { login: 'login', password: 'pass' }) do |x|
     x.chdir 'remote-src-path'
@@ -32,6 +33,37 @@ XFTP.start('ftps://hostname', credentials: { login: 'login', password: 'pass' })
 end
 ```
 
+Connection as anonymous with emtpy password, checking remote dir existence, globbing and getting `StringIO`'s:
+```ruby
+XFTP.start('ftp://hostname') do |x|
+    x.mkdir 'some-dir' unless x.exist? 'some-dir'
+    x.glob '*.csv' do |filename|
+        io = x.get filename
+    end
+end
+```
+
+Example using `each_io`:
+```ruby
+XFTP.start('ftps://hostname', credentials: { login: 'login', password: 'password' }) do |x|
+    x.chdir 'some-dir'
+    x.each_io do |filename, io|
+        # do smth with it
+    end
+end
+```
+
+Wihout block argument (ntoe that you should rely on you local execution context objects):
+```ruby
+XFTP.start('ftps://hostname', credentials: credentials)
+    chdir 'blahblah'
+    each_file do |filename|
+        download filename, to: File.join('local-dir', filename)
+        move filename, to: File.join('remote-archive-path', filename)
+    end
+end
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/xftp/operations/ftp/glob.rb

@@ -7,6 +7,8 @@ module XFTP
       # @note It isn't tested on Windows OS and chances are that it won't work,
       #   that's why it is implemented as a separate "command"
       class Glob
+        NO_SUCH_FILE_OR_DIRECTORY_CODE = 450
+
         def initialize(ftp)
           @ftp = ftp
         end
@@ -17,6 +19,9 @@ module XFTP
         # @param [Proc] callback
         def call(pattern, &callback)
           @ftp.nlst(pattern).each { |filename| callback.call(filename) }
+        rescue Net::FTPTempError => err
+          code = err.to_s[0, 3].try(:to_i)
+          raise err unless code == NO_SUCH_FILE_OR_DIRECTORY_CODE
         end
       end
     end

data/lib/xftp/session/base.rb

@@ -29,6 +29,12 @@ module XFTP
         close
         log 'done'
       end
+
+      protected
+
+      def ensure_relative_path!(operation, path)
+        fail ArgumentError, "Absolute path can't be specified for `#{operation}`" if Pathname.new(path).absolute?
+      end
     end
   end
 end

data/lib/xftp/session/ftp.rb

@@ -1,5 +1,4 @@
 require 'active_support/core_ext/hash/deep_merge'
-require 'forwardable'
 require 'net/ftp'
 
 require 'xftp/session/base'
@@ -10,12 +9,6 @@ module XFTP
     # FTP session adapter
     # @api private
     class FTP < Base
-      extend Forwardable
-
-      # Delegate methods which have the same method signature
-      # directly to Net::FTP session
-      def_delegators :@ftp, :chdir, :mkdir, :rmdir
-
       # Creates an FTP session adapter instance
       # @param [URI] uri the remote uri
       # @param [Hash] settings the adapter connection settings
@@ -30,14 +23,40 @@ module XFTP
         options.each { |key, val| @ftp.public_send("#{key}=", val) }
       end
 
+      # Changes the current (remote) working directory
+      # @param [String] path the relative (remote) path
+      def chdir(path)
+        ensure_relative_path! :chdir, path
+        @ftp.chdir path
+      end
+
+      # Creates a remote directory
+      # @param [String] dirname the name of new directory
+      #   relative to the current (remote) working directory
+      def mkdir(dirname)
+        ensure_relative_path! :mkdir, dirname
+        @ftp.mkdir dirname
+      end
+
+      # Removes the remote directory
+      # @param [String] dirname the name of directory to be removed
+      def rmdir(dirname)
+        ensure_relative_path! :rmdir, dirname
+        @ftp.rmdir dirname
+      end
+
       # @return [Boolean] `true` if the argument refers to a directory on the remote host
       def exists?(dirname)
         entries.include? dirname
       end
 
+      # HACK: It looks ridiculous, but its the only way to find out
+      # if the given remote path is a file or directory
+
       # @return [Boolean] `true` if the argument refers to
       # a directory on the remote host
       def directory?(path)
+        ensure_relative_path! :directory?, path
         chdir path
         chdir '..'
         true
@@ -65,6 +84,21 @@ module XFTP
         files.each { |filename| yield filename }
       end
 
+      # Calls the block once for each entry in the current directory
+      # on the remote server and yields a filename and `StringIO` object to the block
+      def each_io
+        each_file do |filename|
+          io = get filename
+          yield filename, io
+        end
+      end
+
+      # Downloads file into IO object
+      # @return [StringIO] the remote file data
+      def get(filename)
+        @ftp.getbinaryfile(filename, nil)
+      end
+
       # @see XFTP::Operations::FTP::Glob
       def glob(pattern, &callback)
         Operations::FTP::Glob.new(@ftp).call(pattern, &callback)

data/lib/xftp/session/sftp.rb

@@ -8,6 +8,31 @@ module XFTP
     # SFTP session adapter
     # @api private
     class SFTP < Base
+      # Helper class for progress monitoring
+      class ProgressHandler
+        include Helpers::Logging
+
+        def on_open(_downloader, file)
+          log "starting download: #{file.remote} -> #{file.local} (#{file.size} bytes)"
+        end
+
+        def on_get(_downloader, file, offset, data)
+          log "writing #{data.length} bytes to #{file.local} starting at #{offset}"
+        end
+
+        def on_close(_downloader, file)
+          log "finished with #{file.remote}"
+        end
+
+        def on_mkdir(_downloader, path)
+          log "creating directory #{path}"
+        end
+
+        def on_finish(_downloader)
+          log 'done'
+        end
+      end
+
       # Default flags for rename operation
       RENAME_OPERATION_FLAGS = 0x0004
       # Default flags for glob operation
@@ -26,6 +51,7 @@ module XFTP
       # Changes the current (remote) working directory
       # @param [String] path the relative (remote) path
       def chdir(path)
+        ensure_relative_path! :chdir, path
         @path += path
       end
 
@@ -35,9 +61,17 @@ module XFTP
       # @param [Hash] attrs the attributes of new directory
       #   supported by the the version of SFTP protocol in use
       def mkdir(dirname, attrs = {})
+        ensure_relative_path! :mkdir, path
         @sftp.mkdir!(remote_path(dirname), attrs)
       end
 
+      # Removes the remote directory
+      # @param [String] dirname the name of directory to be removed
+      def rmdir(dirname)
+        ensure_relative_path! :rmdir, path
+        @sftp.rmdir! remote_path(dirname)
+      end
+
       # @return [Boolean] `true` if the file exists
       # in a current working directory on the remote host
       def exists?(filename)
@@ -47,6 +81,7 @@ module XFTP
       # @return [Boolean] `true` if the argument refers to
       # a directory on the remote host
       def directory?(path)
+        ensure_relative_path! :directory?, path
         @sftp.file.directory? remote_path(path)
       end
 
@@ -56,12 +91,6 @@ module XFTP
         !directory?(path)
       end
 
-      # Removes the remote directory
-      # @param [String] dirname the name of directory to be removed
-      def rmdir(dirname)
-        @sftp.rmdir! remote_path(dirname)
-      end
-
       # Renames (moves) a file on the server
       # @param [String] from the path to move from
       # @param [String] to the path to move to
@@ -79,6 +108,21 @@ module XFTP
         end
       end
 
+      # Calls the block once for each entry in the current directory
+      # on the remote server and (asynchronously) yields a filename and `StringIO` object to the block
+      def each_io
+        each_file do |filename|
+          io = get filename
+          yield filename, io
+        end
+      end
+
+      # Downloads file into IO object
+      # @return [StringIO] the remote file data
+      def get(filename)
+        @sftp.download!(remote_path(filename), nil, progress: ProgressHandler)
+      end
+
       # For more info (see Dir#glob), it's almost of the same nature
       # @param [String] pattern the search pattern relative
       #   the the current working directory
@@ -105,8 +149,7 @@ module XFTP
         entries.reject { |filename| directory? filename }
       end
 
-      # @return [Array<String>] an array of entries (including directories)
-      #   in the remote directory
+      # @return [Array<String>] an array of entries (including directories) in the remote directory
       def entries
         @sftp.dir.entries(@path.to_s).map(&:name)
       end

data/lib/xftp/version.rb

@@ -2,8 +2,8 @@ module XFTP
   # Gem version builder module
   module VERSION
     MAJOR = 0
-    MINOR = 3
-    PATCH = 3
+    MINOR = 4
+    PATCH = 1
     SUFFIX = ''
 
     NUMBER = [MAJOR, MINOR, PATCH].compact.join('.')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: xftp
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.4.1
 platform: ruby
 authors:
 - Vasiliy Yorkin
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-04-28 00:00:00.000000000 Z
+date: 2015-04-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -239,6 +239,6 @@ rubyforge_project:
 rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: xftp-0.3.3
+summary: xftp-0.4.1
 test_files: []
 has_rdoc: