xftp 0.1.0.pre.alpha → 0.2.0.pre.alpha

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4fadf37a688351959fd702257a6e2efb8e9600a8
-  data.tar.gz: 0459bf1922cabbcc204bba768700a9148f483a3a
+  metadata.gz: 347ece5447998ac33bf75349479fb55391c9b7fe
+  data.tar.gz: 7fa737d776c1bd974c7dfdaf444ae86410b02525
 SHA512:
-  metadata.gz: 3a758097ffcd936285221424b9bedf7c5c4906b97e3ad2f90073a7ad20963990053ab1b3065f2e8dd30d6ded38f0c94c96793cfcbb12e806ac963dae5904226f
-  data.tar.gz: e48ed2864845c10837de4ae37999b765cee5ab9957eca157888267616bab73e1e9cec2ea77189d03e53b5026d79034c0fcc41824d5103f81ccfc0c95f27ddc80
+  metadata.gz: 03049d13008de6b272594542c33632c5c99fe82eea58656f73c94743ea56a65f6a5b0e22cede36078731a50dd42dc8b28a3e599b39aae3a9f96f9260b9e91a19
+  data.tar.gz: 6abf399fe37f1715f070b0a3005a6ef9252c42fec7e1796d84fcccac6798f3f6849d8c907dd6dc2b4a13b0600089b630f9b69d4a78c6a5d6e8d79ba6a86b5c54

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Vasiliy Yorkin
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -18,18 +18,14 @@ $ gem install xftp
 ## Usage
 
 ```ruby
-XFTP.start('ftps://hostname', login: 'login', password: 'pass') do |x|
+XFTP.start('ftps://hostname', credentials: { login: 'login', password: 'pass' }) do |x|
     x.chdir 'remote-src-path'
     x.mkdir 'new-remote-dir'
     x.rmdir 'dir-to-remove'
 
-    x.glob '**/*.{xls,xlsx}' do |io|
-        # process entry
-    end
-
-    x.download '**/*.{xls,xlsx}', to: 'local-dst-path' do |file|
+    x.glob '**/*.{xls,xlsx}' do |entry|
         # process file
-        x.move file, to: 'remote-archive-path'
+        x.move entry.remote, to: File.join('remote-archive-path', entry.remote)
     end
 end
 ```

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

@@ -1,7 +1,11 @@
 module XFTP
   module Operations
     module FTP
+      # Provides a naive glob operation implementation, using (see FTP#nlst) method
       # @api private
+      # @see Net::FTP#nslt
+      # @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
         def initialize(ftp)
           @ftp = ftp
@@ -11,12 +15,9 @@ module XFTP
         # as matches or as arguments given to the block
         # @param [String] pattern the search pattern
         # @param [Proc] callback
-        # :reek:UnusedParameters
-        # rubocop:disable Lint/UnusedMethodArgument
         def call(pattern, &callback)
-          fail NotImplementedError
+          @ftp.nlst(pattern).each { |filename| callback.call(filename) }
         end
-        # rubocop:enable Lint/UnusedMethodArgument
       end
     end
   end

data/lib/xftp/session/ftp.rb

@@ -29,6 +29,11 @@ module XFTP
         options.each { |key, val| @ftp.public_send("#{key}=", val) }
       end
 
+      # @return [Boolean] `true` if the argument refers to a directory on the remote host
+      def exists?(dirname)
+        entries.include? dirname
+      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
@@ -36,15 +41,42 @@ module XFTP
         @ftp.rename(from, to)
       end
 
+      # Calls the block once for each entry in the current directory
+      # on the remote server and yields a filename to the block
+      def each_file
+        files.each { |filename| yield filename }
+      end
+
       # @see XFTP::Operations::FTP::Glob
       def glob(pattern, &callback)
         Operations::Glob.new(@ftp).call(pattern, &callback)
       end
 
+      # Initiates a download from remote to local, synchronously
+      # @param [String] from the source remote file name
+      # @param [String] to the target local file name
+      # @param [Integer] block_size the size of file chunk
+      # @see Net::FTP#get
+      def download(from, to: File.basename(from), block_size: Net::FTP::DEFAULT_BLOCKSIZE)
+        @ftp.get(from, to, block_size)
+      end
+
+      # @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 '*.*'
+      end
+
+      # @param [String] pattern the wildcard search pattern
+      # @return [Array<String>] an array of entries (including directories)
+      #   in the remote directory
+      def entries(pattern = nil)
+        @ftp.nlst pattern
+      end
+
       protected
 
-      # Opens a new FTP connection and
-      # authenticates on the remote server
+      # Opens a new FTP connection and authenticates on the remote server
       def open
         @ftp.connect(@uri.host, @port)
         @ftp.login(@credentials[:login], @credentials[:password])

data/lib/xftp/session/sftp.rb

@@ -20,13 +20,13 @@ module XFTP
         super
         @path = Pathname '.'
         @settings.merge!(password: @credentials[:password])
-        @options = XFTP.config.sftp.deep_merge(@settings)
+        @ssh_options = XFTP.config.ssh.deep_merge(@settings)
       end
 
       # Changes the current (remote) working directory
       # @param [String] path the relative (remote) path
       def chdir(path)
-        @path /= path
+        @path += path
       end
 
       # Creates a remote directory
@@ -35,20 +35,40 @@ module XFTP
       # @param [Hash] attrs the attributes of new directory
       #   supported by the the version of SFTP protocol in use
       def mkdir(dirname, attrs = {})
-        @sftp.mkdir! pathname(dirname), attrs
+        @sftp.mkdir!(remote_path(dirname), attrs)
+      end
+
+      # @return [Boolean] `true` if the file exists
+      # in a current working directory on the remote host
+      def exists?(filename)
+        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)
       end
 
       # Removes the remote directory
       # @param [String] dirname the name of directory to be removed
       def rmdir(dirname)
-        @sftp.rmdir! pathname(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
       def move(from, to:, flags: RENAME_OPERATION_FLAGS)
-        @sftp.rename(from, to, flags)
+        @sftp.rename!(remote_path(from), remote_path(to), flags)
+      end
+
+      # Calls the block once for each entry in the current directory
+      # on the remote server and (asynchronously) yields a filename to the block
+      def each_file
+        @sftp.dir.foreach(@path.to_s) do |entry|
+          filename = entry.name
+          yield filename unless directory? filename
+        end
       end
 
       # For more info (see Dir#glob), it's almost of the same nature
@@ -57,7 +77,29 @@ module XFTP
       # @param [Integer] (see File.fnmatch) for the meaning of the flags parameter.
       #   Default value is `File::FNM_EXTGLOB`
       def glob(pattern, flags: GLOB_OPERATION_FLAGS)
-        @sftp.dir.glob(@path.to_s, pattern, flags)
+        @sftp.dir.glob(@path.to_s, pattern, flags) { |entry| yield entry.name }
+      end
+
+      # Initiates a download from remote to local, synchronously
+      # @param [String] from the source remote file name
+      # @param [String] to the target local file name
+      # @param [Hash] options the download operation options
+      # @see Net::SFTP::Operations::Download
+      def download(from, to: File.basename(from), **options)
+        remote = remote_path(from)
+        local = (Pathname.pwd + to).to_s
+        @sftp.download!(remote, local, options)
+      end
+
+      # @return [Array<String>] an array of filenames in the remote directory
+      def files
+        entries.reject { |filename| directory? filename }
+      end
+
+      # @return [Array<String>] an array of entries (including directories)
+      #   in the remote directory
+      def entries
+        @sftp.dir.entries(@path.to_s).map(&:name)
       end
 
       protected
@@ -83,14 +125,14 @@ module XFTP
       private
 
       def connect
-        @ssh = Net::SSH.start(@uri.host, @credentials[:login], @options)
+        @ssh = Net::SSH.start(@uri.host, @credentials[:login], @ssh_options)
         @sftp = Net::SFTP::Session.new @ssh
         @sftp.connect!
       end
 
       # @return [String] a path name relative to the current working directory
-      def pathname(relative)
-        (@path / relative).to_s
+      def remote_path(relative)
+        (@path + relative).to_s
       end
     end
   end

data/lib/xftp/version.rb

@@ -2,7 +2,7 @@ module XFTP
   # Gem version builder module
   module VERSION
     MAJOR = 0
-    MINOR = 1
+    MINOR = 2
     PATCH = 0
     SUFFIX = 'alpha'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: xftp
 version: !ruby/object:Gem::Version
-  version: 0.1.0.pre.alpha
+  version: 0.2.0.pre.alpha
 platform: ruby
 authors:
 - Vasiliy Yorkin
 autorequire: 
-bindir: bin
+bindir: exe
 cert_chain: []
-date: 2015-04-20 00:00:00.000000000 Z
+date: 2015-04-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -43,6 +43,9 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.8.7
   type: :development
@@ -50,6 +53,9 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.8.7
 - !ruby/object:Gem::Dependency
@@ -71,6 +77,9 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.2.0
   type: :development
@@ -78,6 +87,9 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.2.0
 - !ruby/object:Gem::Dependency
@@ -85,6 +97,9 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.9.2
   type: :development
@@ -92,6 +107,9 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.9.2
 - !ruby/object:Gem::Dependency
@@ -99,6 +117,9 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.1.1
   type: :development
@@ -106,6 +127,9 @@ dependencies:
   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
@@ -113,6 +137,9 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.6.0
   type: :runtime
@@ -120,6 +147,9 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.6.0
 - !ruby/object:Gem::Dependency
@@ -127,6 +157,9 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.1.2
   type: :runtime
@@ -134,6 +167,9 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.1.2
 - !ruby/object:Gem::Dependency
@@ -141,6 +177,9 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.2.21
   type: :runtime
@@ -148,31 +187,21 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.2.21
-description: Unified interface for ftp/sftp
+description: Unified interface for ftp/sftp protocols, specific protocol is selected
+  by uri scheme
 email:
 - vasiliy.yorkin@gmail.com
-executables:
-- console
-- rspec
-- setup
+executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".overcommit.yml"
-- ".reek"
-- ".rspec"
-- ".rubocop.yml"
-- ".ruby-version"
-- ".travis.yml"
-- Gemfile
+- LICENSE.txt
 - README.md
-- Rakefile
-- bin/console
-- bin/rspec
-- bin/setup
 - lib/configuration.rb
 - lib/initializers/i18n.rb
 - lib/xftp.rb
@@ -186,9 +215,9 @@ files:
 - lib/xftp/session/sftp.rb
 - lib/xftp/validator/settings.rb
 - lib/xftp/version.rb
-- xftp.gemspec
 homepage: https://github.com/vyorkin/xftp
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -209,6 +238,6 @@ rubyforge_project:
 rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: Unified interface for ftp/sftp
+summary: xftp-0.2.0-alpha
 test_files: []
 has_rdoc: 

data/.gitignore

@@ -1,9 +0,0 @@
-/.bundle/
-/.yardoc
-/Gemfile.lock
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/

data/.overcommit.yml

@@ -1,42 +0,0 @@
-# Use this file to configure the Overcommit hooks you wish to use. This will
-# extend the default configuration defined in:
-# https://github.com/brigade/overcommit/blob/master/config/default.yml
-#
-# At the topmost level of this YAML file is a key representing type of hook
-# being run (e.g. pre-commit, commit-msg, etc.). Within each type you can
-# customize each hook, such as whether to only run it on certain files (via
-# `include`), whether to only display output if it fails (via `quiet`), etc.
-#
-# For a complete list of hooks, see:
-# https://github.com/brigade/overcommit/tree/master/lib/overcommit/hook
-#
-# For a complete list of options that you can use to customize hooks, see:
-# https://github.com/brigade/overcommit#configuration
-#
-# Uncomment the following lines to make the configuration take effect.
-
-CommitMsg:
-  HardTabs:
-    enabled: true
-
-PreCommit:
-  Rubocop:
-    enabled: true
-    on_warn: fail
-  HardTabs:
-    enabled: true
-  Reek:
-    enabled: true
-  LocalPathsInGemfile:
-    enabled: true
-  TrailingWhitespace:
-    enabled: true
-  BundleCheck:
-    enabled: true
-
-PostCheckout:
-  SubmoduleStatus:
-    enabled: true
-  GitGuilt:
-    enabled: true
-

data/.reek

@@ -1,3 +0,0 @@
----
-PrimaDonnaMethod:
-  enabled: false

data/.rspec

@@ -1,2 +0,0 @@
---color
---require spec_helper

data/.rubocop.yml

@@ -1,2 +0,0 @@
-Metrics/LineLength:
-  Max: 120

data/.ruby-version

@@ -1 +0,0 @@
-2.1.5

data/.travis.yml

@@ -1,3 +0,0 @@
-language: ruby
-rvm:
-  - 2.2.1

data/Gemfile

@@ -1,19 +0,0 @@
-source 'https://rubygems.org'
-
-gemspec
-
-group :development, :test do
-  gem 'pry-byebug'
-end
-
-group :development do
-  gem 'reek', require: false
-  gem 'brakeman', require: false
-  gem 'rubocop', require: false
-  gem 'overcommit'
-end
-
-group :test do
-  gem 'mutant'
-  gem 'mutant-rspec'
-end

data/Rakefile

@@ -1 +0,0 @@
-require 'bundler/gem_tasks'

data/bin/console

@@ -1,14 +0,0 @@
-#!/usr/bin/env ruby
-
-require "bundler/setup"
-require "xftp"
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require "irb"
-IRB.start

data/bin/rspec

@@ -1,16 +0,0 @@
-#!/usr/bin/env ruby
-#
-# This file was generated by Bundler.
-#
-# The application 'rspec' is installed as part of a gem, and
-# this file is here to facilitate running it.
-#
-
-require 'pathname'
-ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
-  Pathname.new(__FILE__).realpath)
-
-require 'rubygems'
-require 'bundler/setup'
-
-load Gem.bin_path('rspec-core', 'rspec')

data/bin/setup

@@ -1,7 +0,0 @@
-#!/bin/bash
-set -euo pipefail
-IFS=$'\n\t'
-
-bundle install
-
-# Do any other automated setup that you need to do here

data/xftp.gemspec

@@ -1,35 +0,0 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'xftp/version'
-
-TEST_FILES = %r{^(test|spec|features)/}
-
-Gem::Specification.new do |spec|
-  spec.name          = 'xftp'
-  spec.version       = XFTP::VERSION::STRING
-  spec.authors       = ['Vasiliy Yorkin']
-  spec.email         = ['vasiliy.yorkin@gmail.com']
-
-  spec.summary       = 'Unified interface for ftp/sftp'
-  spec.description   = spec.summary
-  spec.homepage      = 'https://github.com/vyorkin/xftp'
-
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match TEST_FILES }
-  spec.bindir        = 'bin'
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(TEST_FILES)
-  spec.require_paths = ['lib']
-
-  spec.add_development_dependency 'bundler', '~> 1.8'
-  spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'yard', '~> 0.8.7'
-  spec.add_development_dependency 'yard-rspec', '~> 0.1'
-  spec.add_development_dependency 'rspec', '~> 3.2.0'
-  spec.add_development_dependency 'simplecov', '~> 0.9.2'
-  spec.add_development_dependency 'fake_ftp', '~> 0.1.1'
-
-  spec.add_runtime_dependency 'i18n', '~> 0.6.0'
-  spec.add_runtime_dependency 'net-sftp', '~> 2.1.2'
-  spec.add_runtime_dependency 'activesupport', '~> 3.2.21'
-end