sftp_downloader 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 496b7e381253bd4984bcb2e1c72a84c332106f67
+  data.tar.gz: 0991c6846531d9bbfa605e831a24bb0eacca295c
+SHA512:
+  metadata.gz: b44d97a0eed49be27078aaf228d8a142dc944047511bf7531b45edcfee97d9ca43dc0b3a71add39d701bbcb8e85df8627354efa3f3d433b03885ff4965de2a26
+  data.tar.gz: 4bf3dca3de13e0bb1fb6ededaa19c853b3ac1a0b9959ff0eafb2122b8a646b0195b326b7f09baa7fe7601562ec0c2310040bc20c2b2e98657507451a03d744d6

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in sftp_downloader.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,45 @@
+The MIT License (MIT)
+
+             ,,########################################,,
+          .*##############################################*
+        ,*####*:::*########***::::::::**######:::*###########,
+      .*####:    *#####*.                 :*###,.#######*,####*.
+     *####:    *#####*                      .###########*  ,####*
+  .*####:    ,#######,                        ##########*    :####*
+  *####.    :#########*,                       ,,,,,,,,.      ,####:
+    ####*  ,##############****************:,,               .####*
+     :####*#####################################**,        *####.
+       *#####Copyright (c) 2015, Maurizio De Magnis#*,   :####:
+        .#############################################*,####*
+          :#####:*****#####################################.
+            *####:                  .,,,:*****###########,
+             .*####,                            *######*
+               .####* :*#######*               ,#####*
+                 *###############*,,,,,,,,::**######,
+                   *##############################:
+                     *####*****##########**#####*
+                      .####*.            :####*
+                        :####*         .#####,
+                          *####:      *####:
+                           .*####,  *####*
+                             :####*####*
+                               *######,
+                                 *##,
+
+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

@@ -0,0 +1,85 @@
+# SFTP Downloader
+
+This is a gem that performs asynchronous SFTP downloads, ensuring that notifications of succesful downloads respect a sequential order.
+
+For example, this means that if you download the following files:
+
+- /my/files/a.txt
+- /my/files/b.txt
+- /my/files/c.txt
+
+from the remote host, all downloads will start concurrently but the notification related to `b.txt` will happen only after the notification related to `a.txt`.
+This is especially useful when you need to import and parse files respecting the remote filename ordering.
+
+You can also specify if the downloaded files should be removed from the remote location once the downloads are completed.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sftp_downloader'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sftp_downloader
+
+## Usage
+
+### Command line
+
+```bash
+sftp_downloader --help
+```
+
+### Ruby
+
+```ruby
+require 'sftp_downloader'
+require 'logger'
+
+logger = Logger.new(STDOUT)
+
+credentials = {
+  host: 'INSERT_FTP_HOST_HERE',
+  username: 'INSERT_FTP_USERNAME_HERE',
+  password: 'INSERT_FTP_PASSWORD_HERE',
+}
+
+downloader = SftpDownloader::Client.new(
+  credentials: credentials,         # required
+  download_path: './tmp/downloads', # default: './'
+  remote_path: '/out/',             # default: '/'
+  file_pattern: /.+\.csv/,          # default: /.*\..*/
+  logger: logger,                   # default: nil (doesn't log debugging info)
+  remove_after_download: true,      # default: false
+)
+
+downloader.perform do |local_path|
+  puts "dealing with #{local_path}"
+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. Run `bundle exec sftp_downloader` to use the code located in this directory, ignoring other installed copies of this gem.
+
+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` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## To do
+
+- add some tests (duh!)
+- allow the *"classic mode"* in which files are downloaded regardless their naming order
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/sftp_downloader/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "sftp_downloader"
+
+# 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/setup

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

data/exe/sftp_downloader

@@ -0,0 +1,83 @@
+#!/usr/bin/env ruby
+
+require "sftp_downloader"
+require 'optparse'
+require 'logger'
+
+default_logger = Logger.new(STDOUT)
+default_logger.formatter = proc do |severity, datetime, progname, msg|
+  "#{datetime}: #{msg}\n"
+end
+
+options = {
+  credentials: {},
+}
+cli_options = {}
+
+opt_parse = OptionParser.new do |opts|
+  opts.banner = "Usage: sftp_downloader [options]"
+
+  opts.on("-u username", "--username=username", "Specify the username [required]") do |username|
+    options[:credentials][:username] = username
+  end
+
+  opts.on("-p password", "--password=password", "Specify the password [required]") do |password|
+    options[:credentials][:password] = password
+  end
+
+  opts.on("-h host", "--host=host", "Specify the host [required]") do |host|
+    options[:credentials][:host] = host
+  end
+
+  opts.on("-fp file_pattern", "--file-pattern=file_pattern", "Specify the regexp to use to select the files to deal with") do |file_pattern|
+    options[:file_pattern] = Regexp.new(file_pattern)
+  end
+
+  opts.on("-r", "--remove-after-download", "Delete the downloaded files in the remote location") do
+    options[:remove_after_download] = true
+  end
+
+  opts.on("-lp path", "--local-path=path", "Specify the local path to save the files to") do |path|
+    options[:local_path] = path
+  end
+
+  opts.on("-rp path", "--remote-path=path", "Specify the remote path to download the files from") do |path|
+    options[:remote_path] = path
+  end
+
+  opts.on_tail("-h", "--help", "Show this message") do
+    puts opts
+    exit
+  end
+
+  opts.on_tail("--version", "Show version") do
+    puts SftpDownloader::VERSION
+    exit
+  end
+
+  opts.on('-v', '--verbose', 'Run verbosely') do
+    cli_options[:verbose] = true
+  end
+
+  opts.on('-d', '--debug', 'Show debug info') do
+    cli_options[:debug] = true
+    options[:logger] = default_logger
+  end
+end
+
+opt_parse.parse!
+
+required_arguments = %i[host username password]
+required_arguments.each do |argument|
+  if options[:credentials][argument].nil?
+    puts opt_parse
+    exit
+  end
+end
+
+client = SftpDownloader::Client.new(options)
+client.perform do |local_path|
+  if cli_options[:verbose]
+    puts local_path
+  end
+end

data/lib/sftp_downloader.rb

@@ -0,0 +1,95 @@
+require "sftp_downloader/version"
+require 'fileutils'
+require 'net/sftp'
+
+module SftpDownloader
+
+  class Client
+    def initialize(credentials:, download_path: './', remote_path: '/', file_pattern: /.*\..*/, remove_after_download: false, logger: nil)
+      @credentials = credentials
+      @download_path = download_path
+      @remote_path = remote_path
+      @logger = logger
+      @file_pattern = file_pattern
+      @remove_after_download = remove_after_download
+    end
+
+    def perform(&block)
+      check_download_directory_and_create_if_necessary
+      Net::SFTP.start(@credentials[:host], @credentials[:username], password: @credentials[:password]) do |sftp|
+        log "Connected to: #{@credentials[:host]}"
+        files = get_files(sftp: sftp)
+        downloads = get_downloads(sftp: sftp, files: files)
+        removal_tasks = wait_downloads_completion_yield_and_start_removal_if_necessary(sftp: sftp, downloads: downloads, block: block)
+        wait_removal_tasks_if_any(removal_tasks: removal_tasks)
+      end
+    end
+
+    private
+
+      def check_download_directory_and_create_if_necessary
+        if File.exists?(@download_path)
+          unless File.directory?(@download_path)
+            raise "#{@download_path} already exists but isn't a directory"
+          end
+        else
+          FileUtils.mkdir_p(@download_path)
+        end
+      end
+
+      def get_files(sftp:)
+        sftp.
+          dir.
+          entries(@remote_path).
+          select(&:file?).
+          map(&:name).
+          grep(@file_pattern).
+          sort
+      end
+
+      def get_downloads(sftp:, files:)
+        files.map do |file|
+          log "Starting download: #{file}"
+          sftp.download(File.join(@remote_path, file), File.join(@download_path, file))
+        end
+      end
+
+      def wait_downloads_completion_yield_and_start_removal_if_necessary(sftp:, downloads:, block:)
+        downloads.map do |download|
+          log "Waiting for download: #{download.remote}"
+          download.wait
+          log "Completed download: #{download.remote}"
+
+          block.call(download.local)
+
+          if @remove_after_download
+            perform_remove(sftp: sftp, download: download)
+          end
+        end
+      end
+
+      def perform_remove(sftp:, download:)
+        log "Starting removal: #{download.remote}"
+        {
+          remote: download.remote,
+          request: sftp.remove(download.remote)
+        }
+      end
+
+      def wait_removal_tasks_if_any(removal_tasks:)
+        removal_tasks.compact.each do |removal_task|
+          log "Waiting for removal: #{removal_task[:remote]}"
+          removal_task[:request].wait
+          log "Completed removal: #{removal_task[:remote]}"
+        end
+      end
+
+      def log(message)
+        if @logger
+          @logger.debug(message)
+        end
+      end
+
+  end
+
+end

data/lib/sftp_downloader/version.rb

@@ -0,0 +1,3 @@
+module SftpDownloader
+  VERSION = "0.1.0"
+end

data/sftp_downloader.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sftp_downloader/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "sftp_downloader"
+  spec.version       = SftpDownloader::VERSION
+  spec.authors       = ["Maurizio De Magnis"]
+  spec.email         = ["maurizio.demagnis@gmail.com"]
+
+  spec.summary       = %q{Asynchronous SFTP downloads that respect filename ordering.}
+  spec.description   = %q{This is a gem that performs asynchronous SFTP downloads, ensuring that notifications of succesful downloads respect a sequential order.}
+  spec.homepage      = "https://github.com/olistik/sftp_downloader"
+  spec.license       = "MIT"
+
+  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"]
+
+  if spec.respond_to?(:metadata)
+  end
+
+  spec.add_development_dependency "bundler", "~> 1.8"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_runtime_dependency "net-sftp", "~> 2.1.2"
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: sftp_downloader
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Maurizio De Magnis
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-03-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: net-sftp
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.2
+description: This is a gem that performs asynchronous SFTP downloads, ensuring that
+  notifications of succesful downloads respect a sequential order.
+email:
+- maurizio.demagnis@gmail.com
+executables:
+- sftp_downloader
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/sftp_downloader
+- lib/sftp_downloader.rb
+- lib/sftp_downloader/version.rb
+- sftp_downloader.gemspec
+homepage: https://github.com/olistik/sftp_downloader
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Asynchronous SFTP downloads that respect filename ordering.
+test_files: []