xftp 0.2.0.pre.alpha → 0.2.1.pre.alpha

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 347ece5447998ac33bf75349479fb55391c9b7fe
-  data.tar.gz: 7fa737d776c1bd974c7dfdaf444ae86410b02525
+  metadata.gz: d82f44266494fe12bc8cf104135f043b3689e2c1
+  data.tar.gz: 5f5ccac9192ec65a366bc958ee625b31fc582602
 SHA512:
-  metadata.gz: 03049d13008de6b272594542c33632c5c99fe82eea58656f73c94743ea56a65f6a5b0e22cede36078731a50dd42dc8b28a3e599b39aae3a9f96f9260b9e91a19
-  data.tar.gz: 6abf399fe37f1715f070b0a3005a6ef9252c42fec7e1796d84fcccac6798f3f6849d8c907dd6dc2b4a13b0600089b630f9b69d4a78c6a5d6e8d79ba6a86b5c54
+  metadata.gz: 1b8ed8dffdf2737832b99cb3849f3bf3c1340da21eb5b49f3385cacae2d0ade0cf3cfdb2e6dc387323d7a11bb40e6768aa8d80ff4b2e963c750e30576d55bbd9
+  data.tar.gz: 49778fb1e45dc2468e49de0ef63e410b5fe180764f24953631afc5a73ffcef2b37d1ff359e18e8fdaa6e024edd261df828ef033d5436e1603bf162bf5c7203a2

data/README.md

@@ -23,9 +23,9 @@ XFTP.start('ftps://hostname', credentials: { login: 'login', password: 'pass' })
     x.mkdir 'new-remote-dir'
     x.rmdir 'dir-to-remove'
 
-    x.glob '**/*.{xls,xlsx}' do |entry|
-        # process file
-        x.move entry.remote, to: File.join('remote-archive-path', entry.remote)
+    x.each_file do |file|
+        x.download file
+        x.move file, to: File.join('remote-archive-path', file)
     end
 end
 ```

data/lib/xftp.rb

@@ -4,21 +4,12 @@ require 'active_support/core_ext/hash'
 require 'configuration'
 require 'xftp/version'
 require 'xftp/errors'
-require 'xftp/validator/settings'
-require 'xftp/session/ftp'
-require 'xftp/session/sftp'
+require 'xftp/client'
 
 require_relative 'initializers/i18n'
 
-# The XFTP entry point (facade)
+# Interface unification for FTP/SFTP protocols
 module XFTP
-  include Errors
-
-  SCHEME_ADAPTERS = {
-    ftp:  XFTP::Session::FTP,
-    ftps: XFTP::Session::SFTP
-  }
-
   # Config accessor
   def self.config
     @configuration ||= Configuration.new
@@ -30,10 +21,6 @@ module XFTP
     yield config
   end
 
-  def self.validator
-    @validator ||= Validator::Settings.new
-  end
-
   # Initiates a new session
   #
   # @param [String] :url the remote host url
@@ -46,22 +33,7 @@ module XFTP
   #
   # @see Net::SSH
   # @see Net::FTP
-  #
-  # @see XFTP::Validator::Settings
-  def self.start(url, settings = {}, &block)
-    uri = URI.parse(url)
-    validator.call!(uri, settings)
-    klass = adapter_class(uri.scheme)
-    session = klass.new(uri, settings.deep_dup)
-    session.start(&block)
-  end
-
-  private
-
-  # Detects a session adapter class
-  # @param [String, Symbol] scheme the uri scheme
-  # @return [Class] session adapter class
-  def self.adapter_class(scheme)
-    SCHEME_ADAPTERS[scheme.to_sym] || not_supported_protocol!(scheme)
+  def self.start(url, settings = {}, &callback)
+    Client.start(url, settings, &callback)
   end
 end

data/lib/xftp/client.rb

@@ -0,0 +1,41 @@
+require 'xftp/session/ftp'
+require 'xftp/session/sftp'
+
+module XFTP
+  # The XFTP entry point
+  # @api private
+  class Client
+    SCHEME_ADAPTERS = {
+      ftp:  XFTP::Session::FTP,
+      ftps: XFTP::Session::SFTP
+    }
+
+    def self.start(url, settings, &callback)
+      new(SCHEME_ADAPTERS).call(url, settings, &callback)
+    end
+
+    def initialize(scheme_adapters)
+      @scheme_adapters = scheme_adapters
+    end
+
+    # Initiates a new session
+    # @see XFTP::Validator::Settings
+    def call(url, settings, &block)
+      uri = URI.parse(url)
+      klass = adapter_class(uri.scheme)
+      session = klass.new(uri, settings.deep_dup)
+      session.start(&block)
+    end
+
+    private
+
+    # Detects a session adapter class
+    # @param [String, Symbol] scheme the uri scheme
+    # @return [Class] session adapter class
+    def adapter_class(scheme)
+      @scheme_adapters.fetch(scheme.to_sym) do
+        fail NotSupportedProtocol, "Not supported protocol '#{scheme}'"
+      end
+    end
+  end
+end

data/lib/xftp/errors.rb

@@ -1,20 +1,4 @@
 module XFTP
-  # Raises when the given argument does not match required format
-  class InvalidArgument < ArgumentError; end
-  # Raises when required argument is missing or blank
-  class MissingArgument < ArgumentError; end
-  # Raise when the given protocol is not supported
+  # Raises when the given protocol is not supported
   class NotSupportedProtocol < ArgumentError; end
-
-  # Shortcut method to fail
-  # with a localized error message
-  module Errors
-    def missing_setting!(setting)
-      fail MissingArgument, I18n.t('errors.missing_setting', key: setting)
-    end
-
-    def not_supported_protocol!(protocol)
-      fail NotSupportedProtocol, I18n.t('errors.not_supported_protocol', protocol: protocol)
-    end
-  end
 end

data/lib/xftp/locale/en.yml

@@ -1,5 +1,2 @@
 ---
 en:
-  errors:
-    missing_setting: 'missing setting %{key}'
-    not_supported_protocol: 'protocol %{protocol} is not supported'

data/lib/xftp/locale/ru.yml

@@ -1,5 +1,2 @@
 ---
 ru:
-  errors:
-    missed_config_option: 'не указан параметр подключения %{key}'
-    not_supported_protocol: 'протокол %{protocol} не поддерживается'

data/lib/xftp/session/ftp.rb

@@ -22,7 +22,7 @@ module XFTP
         super
 
         @ftp = Net::FTP.new
-        @port = uri.port || settings.delete(:port) || Net::FTP::FTP_PORT
+        @port = settings.delete(:port) || uri.port || Net::FTP::FTP_PORT
         @credentials[:login] ||= 'anonymous'
 
         options = XFTP.config.ftp.deep_merge(@settings)
@@ -34,6 +34,22 @@ module XFTP
         entries.include? dirname
       end
 
+      # @return [Boolean] `true` if the argument refers to
+      # a directory on the remote host
+      def directory?(path)
+        chdir path
+        chdir '..'
+        true
+      rescue
+        false
+      end
+
+      # @return [Boolean] `true` if the argument refers to
+      # a file on the remote host
+      def file?(path)
+        !directory?(path)
+      end
+
       # Renames (moves) a file on the server
       # @param [String] from the path to move from
       # @param [String] to the new path to move to
@@ -63,8 +79,7 @@ module XFTP
 
       # @return [Array<String>] an array of filenames in the remote directory
       def files
-        # FIXME: This won't work in case of file name without extension
-        entries '*.*'
+        entries.select { |entry| file? entry }
       end
 
       # @param [String] pattern the wildcard search pattern

data/lib/xftp/session/sftp.rb

@@ -19,7 +19,7 @@ module XFTP
       def initialize(uri, settings = {})
         super
         @path = Pathname '.'
-        @settings.merge!(password: @credentials[:password])
+        @settings[:password] = @credentials[:password]
         @ssh_options = XFTP.config.ssh.deep_merge(@settings)
       end
 
@@ -44,9 +44,16 @@ module XFTP
         entries.include? filename
       end
 
-      # @return [Boolean] `true` if the argument refers to a directory on the remote host
-      def directory?(dirname)
-        @sftp.file.directory? remote_path(dirname)
+      # @return [Boolean] `true` if the argument refers to
+      # a directory on the remote host
+      def directory?(path)
+        @sftp.file.directory? remote_path(path)
+      end
+
+      # @return [Boolean] `true` if the argument refers to
+      # a file on the remote host
+      def file?(path)
+        !directory?(path)
       end
 
       # Removes the remote directory

data/lib/xftp/version.rb

@@ -3,7 +3,7 @@ module XFTP
   module VERSION
     MAJOR = 0
     MINOR = 2
-    PATCH = 0
+    PATCH = 1
     SUFFIX = 'alpha'
 
     NUMBER = [MAJOR, MINOR, PATCH].compact.join('.')

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: xftp
 version: !ruby/object:Gem::Version
-  version: 0.2.0.pre.alpha
+  version: 0.2.1.pre.alpha
 platform: ruby
 authors:
 - Vasiliy Yorkin
@@ -112,26 +112,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.9.2
-- !ruby/object:Gem::Dependency
-  name: fake_ftp
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.1'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.1.1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.1'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.1.1
 - !ruby/object:Gem::Dependency
   name: i18n
   requirement: !ruby/object:Gem::Requirement
@@ -205,6 +185,7 @@ files:
 - lib/configuration.rb
 - lib/initializers/i18n.rb
 - lib/xftp.rb
+- lib/xftp/client.rb
 - lib/xftp/dsl/block_evaluator.rb
 - lib/xftp/errors.rb
 - lib/xftp/locale/en.yml
@@ -213,7 +194,6 @@ files:
 - lib/xftp/session/base.rb
 - lib/xftp/session/ftp.rb
 - lib/xftp/session/sftp.rb
-- lib/xftp/validator/settings.rb
 - lib/xftp/version.rb
 homepage: https://github.com/vyorkin/xftp
 licenses:
@@ -238,6 +218,6 @@ rubyforge_project:
 rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: xftp-0.2.0-alpha
+summary: xftp-0.2.1-alpha
 test_files: []
 has_rdoc: 

data/lib/xftp/validator/settings.rb

@@ -1,25 +0,0 @@
-module XFTP
-  module Validator
-    # Connection settings validator
-    # @api private
-    class Settings
-      include Errors
-
-      # Validates the given connection settings
-      # @param [URI] uri the remote uri
-      # @param [Hash] settings the session connection settings
-      # @raise [XFTP::MissingArgument] if some of the required settings are missing
-      def call!(uri, settings)
-        validate_credentials!(settings[:credentials]) if uri.scheme == 'ftps'
-      end
-
-      private
-
-      def validate_credentials!(credentials)
-        missing_setting!(:credentials) unless credentials.present?
-        missing_setting!(:login) unless credentials[:login].present?
-        missing_setting!(:password) unless credentials[:password].present?
-      end
-    end
-  end
-end