ftpsync 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: db10fcf198d487b4f57ee1e49aa36e4981a3fd66
-  data.tar.gz: 0a34e060f2d4873b9b6d62b91f38b1459e0231dc
+SHA256:
+  metadata.gz: 0ffec10f36bb727a2bf78b5f132b52c9e9ecf37b0f6e93e6af3fc0666135c4a1
+  data.tar.gz: 135414d933aa32bd53aab2326f07adbf91003a02687bb33e3e3b554c11448232
 SHA512:
-  metadata.gz: e3ecf68e8679553c7009559c59d3de5ee97fa2cf391033b9d62883634f74270b3003011d6830f619cbdd71bd5b6ac041c36d4c1f36c170e496d4437449d744cc
-  data.tar.gz: 15aeb322eeec85eb5b19ccac2b87bd1f7b29be8aa68233d9ab7ccfe1732742649645b5dabfd0fa09147cb6c8bfa7eacbca5d08db9cb1ab23e39c85e1ec590427
+  metadata.gz: 1e4d8864990232bd31db836e22f8afa6deacecac19a548d8575ea5d4e326cbd39c5a215df63889643f0ffc616daed52c968334a5de0ed9215e0d26df4a99de47
+  data.tar.gz: b8f91ae8839dab6182e94441096589f12ecc9341a1dd1e62ad9d5e23971bb9acead7d5b2da364e5170e6dc6feec3f08515c030ac35096293aab0e00f193e9d29

data/.rubocop.yml

@@ -0,0 +1,16 @@
+plugins:
+  - rubocop-minitest
+  - rubocop-rake
+
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 2.6
+
+Metrics/AbcSize:
+  Max: 20
+
+Metrics/ClassLength:
+  Max: 200
+
+Metrics/MethodLength:
+  Max: 20

data/Gemfile

@@ -1,4 +1,14 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in ftpsync.gemspec
 gemspec
+
+group :development, :test do
+  gem 'minitest', '~> 5.0'
+  gem 'rake', '~> 13.0'
+  gem 'rubocop', '~> 1.0'
+  gem 'rubocop-minitest', '~> 0.40'
+  gem 'rubocop-rake', '~> 0.7'
+end

data/README.md

@@ -1,5 +1,7 @@
 # FtpSync
 
+[![CI](https://github.com/Quintasan/ftpsync/actions/workflows/ci.yml/badge.svg)](https://github.com/Quintasan/ftpsync/actions/workflows/ci.yml)
+
 A simple library for synchronizing from/to FTP servers.
 
 ## Installation
@@ -25,22 +27,80 @@ example = FtpSync::Simple.new "ftp.example.com", "username", "password"
 example.pull_dir('remotepath', 'localpath')
 ```
 
+### Options
+
+`FtpSync::Simple#new` accepts an options hash:
+
+| Option     | Default | Description                        |
+|------------|---------|------------------------------------|
+| `:port`    | `21`    | FTP port to connect to             |
+| `:passive` | `false` | Use passive mode                   |
+| `:verbose` | `false` | Log progress to stderr             |
+
+`FtpSync::Simple#pull_dir` accepts an options hash:
+
+| Option         | Description                                                |
+|----------------|------------------------------------------------------------|
+| `:since`       | Skip files that already exist locally and are up to date   |
+| `:skip_errors` | Rescue `Net::FTPPermError` and continue instead of raising |
+
+> **Note:** `:since` compares size and the mtime reported by the server's
+> `LIST` output, which usually has minute precision. A remote file of the
+> same size that was modified within the same minute as the local copy may
+> therefore be skipped.
+
+Passing a block to `pull_dir` invokes it with the local path of each
+downloaded file:
+
+```ruby
+example.pull_dir('remotepath', 'localpath', since: true) do |file|
+  process(file)
+end
+```
+
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake` to run the tests and RuboCop (or `rake test` / `rake rubocop` individually). You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+### Integration tests (requires Docker)
 
-## Contributing
+The integration suite runs against a real FTP server
+([garethflowers/ftp-server](https://garethflowers.dev/docker-ftp-server/),
+vsftpd) in a Docker container:
+
+    $ rake test:integration
+
+The container listens on `127.0.0.1:2121` (control) and
+`127.0.0.1:40000-40009` (passive data). The tests are skipped automatically
+if Docker is not available, and the container is created and removed for
+each run. Override the credentials and control port with the
+`FTPSYNC_TEST_USER`, `FTPSYNC_TEST_PASS` and `FTPSYNC_TEST_FTP_PORT`
+environment variables.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+### Releasing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/quintasan/ftpsync. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+Releases are published to [rubygems.org](https://rubygems.org) with
+[trusted publishing](https://guides.rubygems.org/trusted-publishing/),
+so no API key is needed. The `.github/workflows/publish.yml` workflow runs
+the tests and RuboCop, builds the gem, and pushes it whenever you push a
+`v*` tag.
 
+1. Bump the version in `lib/ftpsync/version.rb` and commit it.
+2. Create and push a tag:
+
+       $ git tag v0.1.0
+       $ git push --tags
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/quintasan/ftpsync. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](https://www.contributor-covenant.org) code of conduct.
 
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
 
-
 ## Credits
 
 This gem is a basically stripped down version of [orlando/ftp_sync](https://github.com/orlando/ftp_sync) which I couldn't get to work.

data/Rakefile

@@ -1,10 +1,22 @@
-require "bundler/gem_tasks"
-require "rake/testtask"
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+require 'rubocop/rake_task'
 
 Rake::TestTask.new(:test) do |t|
-  t.libs << "test"
-  t.libs << "lib"
-  t.test_files = FileList['test/**/*_test.rb']
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/*_test.rb']
+end
+
+desc 'Run integration tests against a Dockerized FTP server'
+Rake::TestTask.new(:'test:integration') do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/integration/**/*_test.rb']
 end
 
-task :default => :test
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/bin/console

@@ -1,7 +1,8 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-require "bundler/setup"
-require "ftpsync"
+require 'bundler/setup'
+require 'ftpsync'
 
 # 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.
@@ -10,5 +11,5 @@ require "ftpsync"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start

data/ftpsync.gemspec

@@ -1,26 +1,32 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'ftpsync/version'
+# frozen_string_literal: true
+
+require_relative 'lib/ftpsync/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "ftpsync"
-  spec.version       = FtpSync::VERSION
-  spec.authors       = ["Michał Zając"]
-  spec.email         = ["rubygems.org@quintasan.pl"]
+  spec.name = 'ftpsync'
+  spec.version = FtpSync::VERSION
+  spec.authors = ['Michał Zając']
+  spec.email = ['rubygems.org@quintasan.pl']
 
-  spec.summary       = %q{A simple library for synchronizing from/to FTP servers.}
-  spec.homepage      = "https://github.com/Quintasan/ftpsync"
-  spec.license       = "MIT"
+  spec.summary = 'A simple library for synchronizing from/to FTP servers.'
+  spec.description = 'Recursively pull directory trees from FTP servers, with support ' \
+                     'for incremental syncs and per-file callbacks.'
+  spec.homepage = 'https://github.com/Quintasan/ftpsync'
+  spec.license = 'MIT'
+  spec.required_ruby_version = '>= 2.6.0'
 
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.metadata = {
+    'source_code_uri' => spec.homepage,
+    'rubygems_mfa_required' => 'true'
+  }
 
-  spec.add_dependency "net-ftp-list", ">= 3.2.8"
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      f.match?(%r{^(test|spec|features)/|^\.github/}) || !File.file?(f)
+    end
+  end
+  spec.require_paths = ['lib']
 
-  spec.add_development_dependency "bundler", "~> 1.10"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "minitest"
+  spec.add_dependency 'net-ftp'
+  spec.add_dependency 'net-ftp-list', '>= 3.2.8'
 end

data/lib/ftpsync/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module FtpSync
-  VERSION = "0.0.4"
+  VERSION = '0.0.5'
 end

data/lib/ftpsync.rb

@@ -1,96 +1,122 @@
-require "ftpsync/version"
-require "net/ftp"
-require "net/ftp/list"
+# frozen_string_literal: true
+
 require 'fileutils'
+require 'ftpsync/version'
+require 'net/ftp'
+require 'net/ftp/list'
 
 module FtpSync
+  # Synchronizes directories against an FTP server.
   class Simple
     attr_accessor :server, :port, :username, :password, :passive
 
     def initialize(server, username, password, options = {})
       @server = server
-      @port = options[:port] || 21
+      @port = options.fetch(:port, 21)
       @username = username
       @password = password
-      @passive = options[:passive] || false
-      @verbose = options[:verbose] || false
+      @passive = options.fetch(:passive, false)
+      @verbose = options.fetch(:verbose, false)
 
       @connection = nil
       @level = 0
     end
 
+    # Recursively pulls +remotepath+ into +localpath+.
+    #
+    # Options:
+    #   :since       skip files that already exist locally and are up to date
+    #   :skip_errors rescue Net::FTPPermError and keep going
+    #
+    # If a block is given, it is invoked with the local path of each
+    # downloaded file.
     def pull_dir(remotepath, localpath, options = {}, &block)
-      FileUtils.mkpath(localpath) unless File.exist?(localpath) and log "Creating #{localpath} directory"
+      ensure_local_directory(localpath)
       connect! unless @connection
       @level += 1
 
-      todelete = Dir.glob(File.join(localpath, '*'))
-      directories = []
-      files = []
-
-      @connection.list(remotepath) do |e|
-        entry = Net::FTP::List.parse(e)
-
-        paths = [ "#{remotepath}/#{entry.basename}".gsub(/\/+/, '/'),  File.join(localpath, entry.basename)]
+      directories, files = scan_directory(remotepath, localpath, options)
 
-        if entry.dir?
-          if entry.name == "." or entry.name == ".."
-            next
-          else
-            directories << paths
-          end
-        elsif entry.file?
-          if options[:since]
-            files << paths unless File.exist?(paths[1]) and entry.mtime < File.mtime(paths[1]) and entry.filesize == File.size(paths[1])
-          else
-            files << paths
-          end
-        end
-        todelete.delete paths[1]
+      directories.each do |remote_dir, local_dir|
+        pull_dir(remote_dir, local_dir, options, &block)
       end
 
-      directories.each do |paths|
-        remotedir, localdir = paths
-        pull_dir(remotedir, localdir, options, &block)
-      end
-
-      files.each do |paths|
-        remotefile, localfile = paths
-        begin
-          log "#{remotefile} => #{localfile}"
-          @connection.get(remotefile, localfile)
-          if block_given?
-            log "Executing block"
-            yield(localfile)
-          end
-        rescue Net::FTPPermError
-          log "Error when reading #{remotefile}"
-          raise Net::FTPPermError unless options[:skip_errors]
-        end
+      files.each do |remote_file, local_file|
+        download(remote_file, local_file, options, &block)
       end
 
       @level -= 1
-      close! if @level == 0
+      close! if @level.zero?
     end
 
     def connect!
       @connection = Net::FTP.new
-      log "Connecting to #{@server}:#{@port} in #{@passive ? "passive" : "active"} mode"
+      log "Connecting to #{@server}:#{@port} in #{@passive ? 'passive' : 'active'} mode"
       @connection.connect(@server, @port)
       @connection.passive = @passive
-      log "Logging in as #{@username}:#{@password}"
+      log "Logging in as #{@username}"
       @connection.login(@username, @password)
       log "Successfully opened connection to #{@server}:#{@port}"
     end
 
     def close!
       @connection.close
+      @connection = nil
       log "Closed connection to #{@server}:#{@port}"
     end
 
     def log(message)
-      $stderr.puts message if @verbose
+      warn message if @verbose
+    end
+
+    private
+
+    def ensure_local_directory(localpath)
+      return if File.directory?(localpath)
+
+      FileUtils.mkpath(localpath)
+      log "Creating #{localpath} directory"
+    end
+
+    def scan_directory(remotepath, localpath, options)
+      directories = []
+      files = []
+
+      @connection.list(remotepath) do |line|
+        entry = Net::FTP::List.parse(line)
+        next if %w[. ..].include?(entry.name)
+
+        remote_child = join_remote(remotepath, entry.basename)
+        local_child = File.join(localpath, entry.basename)
+
+        if entry.dir?
+          directories << [remote_child, local_child]
+        elsif entry.file?
+          files << [remote_child, local_child] unless skip_file?(local_child, entry, options)
+        end
+      end
+
+      [directories, files]
+    end
+
+    def skip_file?(local_path, entry, options)
+      return false unless options[:since]
+      return false unless File.file?(local_path)
+
+      entry.mtime < File.mtime(local_path) && entry.filesize == File.size(local_path)
+    end
+
+    def download(remote_file, local_file, options)
+      log "#{remote_file} => #{local_file}"
+      @connection.get(remote_file, local_file)
+      yield(local_file) if block_given?
+    rescue Net::FTPPermError => e
+      log "Error when reading #{remote_file}"
+      raise e unless options[:skip_errors]
     end
 
+    def join_remote(remote_dir, basename)
+      "#{remote_dir}/#{basename}".gsub(%r{/+}, '/')
+    end
   end
 end

metadata

@@ -1,72 +1,44 @@
 --- !ruby/object:Gem::Specification
 name: ftpsync
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Michał Zając
-autorequire: 
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2015-07-28 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: net-ftp-list
+  name: net-ftp
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.2.8
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.2.8
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.10'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.10'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: net-ftp-list
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+        version: 3.2.8
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
-description: 
+        version: 3.2.8
+description: Recursively pull directory trees from FTP servers, with support for incremental
+  syncs and per-file callbacks.
 email:
 - rubygems.org@quintasan.pl
 executables: []
@@ -74,7 +46,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
-- ".travis.yml"
+- ".rubocop.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
@@ -88,8 +60,9 @@ files:
 homepage: https://github.com/Quintasan/ftpsync
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  source_code_uri: https://github.com/Quintasan/ftpsync
+  rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib
@@ -97,16 +70,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.6
-signing_key: 
+rubygems_version: 4.0.16
 specification_version: 4
 summary: A simple library for synchronizing from/to FTP servers.
 test_files: []

data/.travis.yml

@@ -1,4 +0,0 @@
-language: ruby
-rvm:
-  - 2.2.1
-before_install: gem install bundler -v 1.10.5