sftp_wrapper 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e2e0e228c73646e79c09685f1b70acc11cf5f65ac18c5c2fd37441f3b75c5b2a
+  data.tar.gz: 0b76e0a5149bbc6d2e79c942121aacc5dcb83069647d95347824777812c452f1
+SHA512:
+  metadata.gz: a66da813d9e6a2519afb0bd9fe2b0c5d40433ca7b63025cf7a53bda52bd3afe40e7230513c081feda33d8d9169c7fdca472ea4ae3a7de702f6045b2c1da07935
+  data.tar.gz: 6741c93b50de825182c507c62c45b412083094ee355f3f93529d5438ca9b08ed3638dd96905d649258dc88527fa6f37827618d89d5e3a6221932ff87e9a64f57

data/.github/workflows/continuous-integration-workflow.yml

@@ -0,0 +1,76 @@
+name: Continuous Integration
+on: [push]
+jobs:
+  build:
+    name: Test
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os:
+          - ubuntu-latest
+        ruby:
+          - "2.3"
+          - "2.4"
+          - "2.5"
+          - "2.6"
+    services:
+      sftp:
+        image: atmoz/sftp:alpine
+        ports:
+          - "2222:22"
+        env:
+          SFTP_USERS: "test:pass:::upload"
+    steps:
+      - uses: actions/checkout@v1
+      - name: Use Ruby ${{ matrix.ruby_version }}
+        uses: actions/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          architecture: 'x64'
+      - name: install curl (enabled SFTP support)
+        run: |
+          sudo apt purge curl
+          sudo apt update
+          sudo apt install -y libssh2-1-dev libssl-dev ca-certificates
+          sudo apt install -y binutils g++ make
+          cd /tmp
+          wget https://curl.haxx.se/download/curl-7.65.3.tar.gz
+          tar xzvf curl-7.65.3.tar.gz
+          cd curl-7.65.3
+          ./configure --disable-libcurl-option --disable-shared --with-libssh2 --with-ssl
+          make
+          sudo make install
+      - name: bundle install, run test
+        run: |
+          gem install bundler -v1.17 --force --no-document
+          bundle install
+          bundle exec rake
+  release:
+    name: Release Gem
+    needs: build
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@master
+      - name: Setup Ruby
+        uses: actions/setup-ruby@v1
+        with:
+          ruby-version: "2.6"
+          architecture: "x64"
+      - name: Setup RubyGems
+        run: |
+          # NOTE: use rubygems v3.0.5+ to works GEM_HOST_API_KEY.
+          gem update --system
+          # NOTE: set `--force` option to avoid error: `"bundle" from bundler conflicts with ...`
+          gem install bundler -v1.17 --force --no-document
+      - name: Build Gem
+        run: |
+          bundle
+          bundle exec rake build
+          bundle exec rake install
+      - name: Push Gem
+        if: startsWith(github.event.ref, 'refs/tags/v')
+        env:
+          GEM_HOST_API_KEY: ${{ secrets.GEM_HOST_API_KEY }}
+        run: |
+          gem -v
+          gem push pkg/sftp_wrapper-*.gem

data/.gitignore

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

data/.rubocop.yml

@@ -0,0 +1,19 @@
+AllCops:
+  TargetRubyVersion: 2.3
+
+Metrics/BlockLength:
+  Exclude:
+    - "test/**/*_test.rb"
+    - "*.gemspec"
+
+Metrics/ClassLength:
+  Exclude:
+    - "test/**/*_test.rb"
+
+Metrics/LineLength:
+  Max: 120
+  Exclude:
+    - sftp_wrapper.gemspec
+
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: consistent_comma

data/CHANGELOG.md

@@ -0,0 +1,10 @@
+Changelog
+====
+
+[v0.1.0](https://github.com/koshigoe/sftp_wrapper/releases/tag/v0.1.0)
+----
+
+The first release.
+
+- Implement wrapper for `sftp` (OpenSSH)
+- Implement wrapper for `curl`

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in sftp_wrapper.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Masataka SUZUKI
+
+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,44 @@
+# SftpWrapper
+
+The wrapper for sftp CLI.
+
+_**NOTE: This is an experimental wrapper to download faster than [net-sftp](https://github.com/net-ssh/net-sftp).**_
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sftp_wrapper'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sftp_wrapper
+
+## Usage
+
+```ruby
+require 'sftp_wrapper'
+
+SftpWrapper::OpenSSH.new('localhost', 2222, 'test', 'pass').download('/upload/file', './file')
+SftpWrapper::Curl.new('localhost', 2222, 'test', 'pass').download('/upload/file', './file')
+```
+
+## 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.
+
+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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/koshigoe/sftp_wrapper.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task default: :test

data/benchmark/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+gem 'net-sftp'
+gem 'sftp_wrapper', path: '..'

data/benchmark/Gemfile.lock

@@ -0,0 +1,21 @@
+PATH
+  remote: ..
+  specs:
+    sftp_wrapper (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    net-sftp (2.1.2)
+      net-ssh (>= 2.6.5)
+    net-ssh (5.2.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  net-sftp
+  sftp_wrapper!
+
+BUNDLED WITH
+   1.17.2

data/benchmark/benchmark_download.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+require 'benchmark'
+require 'net/sftp'
+require 'sftp_wrapper'
+require 'tempfile'
+
+data = ' ' * (1024 * 1024 * 100)
+
+ssh_options = {
+  auth_methods: %w[password],
+  config: false,
+  non_interactive: true,
+  user_known_hosts_file: IO::NULL,
+  verify_host_key: :never,
+  port: 2222,
+  password: 'pass',
+}
+
+Tempfile.create('temp') do |temp|
+  temp.write(data)
+  temp.close
+
+  Net::SFTP.start('localhost', 'test', ssh_options) do |session|
+    session.upload!(temp.path, '/upload/benchmark-download')
+  end
+end
+
+Benchmark.bm(16) do |x|
+  x.report('OpenSSH sftp CLI') do
+    Tempfile.create('temp') do |temp|
+      temp.close
+
+      wrapper = SftpWrapper::OpenSSH.new('localhost', 2222, 'test', 'pass')
+      wrapper.download('/upload/benchmark-download', 'downloaded')
+    end
+  end
+
+  x.report('curl CLI') do
+    Tempfile.create('temp') do |temp|
+      temp.close
+
+      wrapper = SftpWrapper::Curl.new('localhost', 2222, 'test', 'pass')
+      wrapper.download('/upload/benchmark-download', 'downloaded')
+    end
+  end
+
+  x.report('net-sftp') do
+    Tempfile.create('temp') do |temp|
+      temp.close
+
+      Net::SFTP.start('localhost', 'test', ssh_options) do |session|
+        session.download!('/upload/benchmark-download', temp.path)
+      end
+    end
+  end
+end
+
+__END__
+
+$ ruby -v
+ruby 2.6.4p104 (2019-08-28 revision 67798) [x86_64-linux]
+$ bundle exec ruby benchmark_download.rb
+                       user     system      total        real
+OpenSSH sftp CLI   0.000382   0.003365   0.003747 (  3.044737)
+curl CLI           0.015933   0.000000   2.115820 (  3.375170)
+net-sftp           6.210004   0.744365   6.954369 ( 10.792968)

data/benchmark/benchmark_upload.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require 'benchmark'
+require 'net/sftp'
+require 'sftp_wrapper'
+require 'tempfile'
+
+data = ' ' * (1024 * 1024 * 100)
+
+Tempfile.create('temp') do |temp|
+  temp.write(data)
+  temp.close
+
+  Benchmark.bm(16) do |x|
+    x.report('OpenSSH sftp CLI') do
+      wrapper = SftpWrapper::OpenSSH.new('localhost', 2222, 'test', 'pass')
+      wrapper.upload(temp.path, '/upload/benchmark-download')
+    end
+
+    x.report('curl CLI') do
+      wrapper = SftpWrapper::Curl.new('localhost', 2222, 'test', 'pass')
+      wrapper.upload(temp.path, '/upload/benchmark-download')
+    end
+
+    x.report('net-sftp') do
+      ssh_options = {
+        auth_methods: %w[password],
+        config: false,
+        non_interactive: true,
+        user_known_hosts_file: IO::NULL,
+        verify_host_key: :never,
+        port: 2222,
+        password: 'pass',
+      }
+      Net::SFTP.start('localhost', 'test', ssh_options) do |session|
+        session.upload!(temp.path, '/upload/benchmark-upload')
+      end
+    end
+  end
+end
+
+__END__
+
+$ ruby -v
+ruby 2.6.4p104 (2019-08-28 revision 67798) [x86_64-linux]
+$ bundle exec ruby benchmark_upload.rb
+                       user     system      total        real
+OpenSSH sftp CLI   0.004058   0.000321   0.004379 (  1.749079)
+curl CLI           0.007233   0.003560   0.676544 (  2.184746)
+net-sftp           0.852571   0.099383   0.951954 (  2.413606)

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'sftp_wrapper'
+
+# 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(__FILE__)

data/bin/setup

@@ -0,0 +1,9 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here
+docker-compose up -d

data/docker-compose.yml

@@ -0,0 +1,9 @@
+version: '3'
+
+services:
+  sftp:
+    image: atmoz/sftp:alpine
+    container_name: sftp
+    ports:
+      - "2222:22"
+    command: "test:pass:::upload"

data/lib/sftp_wrapper/curl.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+require 'uri'
+require 'erb'
+require 'open3'
+
+module SftpWrapper
+  # The wrapper for curl.
+  class Curl
+    attr_reader :host, :port, :username, :password, :curl_command, :curl_options
+
+    # lookup table of curl errors.
+    CURL_ERRORS = {
+      # Failed to connect to host.
+      7 => SftpWrapper::Errors::ConnectionError,
+      # The user name, password, or similar was not accepted and curl failed to log in.
+      67 => SftpWrapper::Errors::AuthenticationFailure,
+    }.freeze
+
+    # Initialize SFTP wrapper.
+    #
+    # @param host [String] host address of SFTP server
+    # @param port [Integer] port number of SFTP server
+    # @param username [String] user name of SFTP server
+    # @param password [String] password of SFTP server
+    # @param curl_options [Hash] curl options. (e.g. --connect-timeout 1 => connect_timeout: 1)
+    #
+    def initialize(host, port, username, password, curl_options = {})
+      @host = host
+      @port = port
+      @username = username
+      @password = password
+      @curl_command = curl_options.key?(:command_path) ? curl_options.delete(:command_path) : 'curl'
+      @curl_options = curl_options
+    end
+
+    # Get remote file.
+    #
+    # @param source [String] source file path
+    # @param destination [String] destination path
+    # @raise [SftpWrapper::Errors::ConnectionError]
+    # @raise [SftpWrapper::Errors::AuthenticationFailure]
+    # @raise [SftpWrapper::Errors::CommandError]
+    #
+    def download(source, destination)
+      userinfo = [username, password].map(&ERB::Util.method(:url_encode)).join(':')
+      uri = URI::Generic.build(scheme: 'sftp', userinfo: userinfo, host: host, port: port, path: source)
+      cmd = %W[#{curl_command} -s --insecure -o #{destination}] + build_curl_options + [uri.to_s]
+
+      execute(*cmd)
+    end
+
+    # Put local file.
+    #
+    # @param source [String] source file path
+    # @param destination [String] destination path
+    # @raise [SftpWrapper::Errors::ConnectionError]
+    # @raise [SftpWrapper::Errors::AuthenticationFailure]
+    # @raise [SftpWrapper::Errors::CommandError]
+    #
+    def upload(source, destination)
+      userinfo = [username, password].map(&ERB::Util.method(:url_encode)).join(':')
+      uri = URI::Generic.build(scheme: 'sftp', userinfo: userinfo, host: host, port: port, path: destination)
+      cmd = %W[#{curl_command} -s --insecure -T #{source}] + build_curl_options + [uri.to_s]
+
+      execute(*cmd)
+    end
+
+    private
+
+    def build_curl_options
+      curl_options.map { |k, v| ["--#{k.tr('_', '-')}", v] }.flatten
+    end
+
+    def execute(*cmd)
+      _, stderr, status = Open3.capture3(*cmd)
+
+      return if status.success?
+
+      exception_class = CURL_ERRORS[status.exitstatus] || SftpWrapper::Errors::CommandError
+
+      raise exception_class, "exit status #{status.exitstatus}: #{stderr}"
+    end
+  end
+end

data/lib/sftp_wrapper/errors.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module SftpWrapper
+  # Exceptions.
+  module Errors
+    # Base class for exceptions.
+    class Error < StandardError; end
+
+    # Can't establish connection.
+    class ConnectionError < Error; end
+
+    # Can't authenticate user.
+    class AuthenticationFailure < Error; end
+
+    # Command timed out.
+    class TimeoutError < Error; end
+
+    # Command failed.
+    class CommandError < Error; end
+  end
+end

data/lib/sftp_wrapper/open_ssh.rb

@@ -0,0 +1,166 @@
+# frozen_string_literal: true
+
+require 'pty'
+require 'expect'
+require 'shellwords'
+
+module SftpWrapper
+  # The wrapper for OpenSSH's sftp command.
+  class OpenSSH
+    attr_reader :host,
+                :port,
+                :username,
+                :password,
+                :ssh_options,
+                :ssh_config,
+                :open_timeout,
+                :read_timeout,
+                :command_timeout,
+                :debug
+
+    # Default value of open timeout.
+    DEFAULT_OPEN_TIMEOUT = 10
+    # Default value of read timeout.
+    DEFAULT_READ_TIMEOUT = 10
+    # Default value of command timeout.
+    DEFAULT_COMMAND_TIMEOUT = 9_999_999
+    # Default value of ssh options
+    DEFAULT_SSH_OPTIONS = {
+      PasswordAuthentication: 'yes',
+      PreferredAuthentications: 'password',
+      PubkeyAuthentication: 'no',
+      NumberOfPasswordPrompts: 1,
+      StrictHostKeyChecking: 'no',
+      UserKnownHostsFile: '/dev/null',
+      TCPKeepAlive: 'yes',
+      ServerAliveInterval: 60,
+      ServerAliveCountMax: 3,
+    }.freeze
+    # Default value of ssh config file path.
+    DEFAULT_SSH_CONFIG = '/dev/null'
+    # pattern of password prompt.
+    PASSWORD_PROMPT_RE = / password: /.freeze
+    # sftp prompt.
+    SFTP_PROMPT = 'sftp> '
+    # pattern of sftp prompt.
+    SFTP_PROMPT_RE = /^#{SFTP_PROMPT}/.freeze
+
+    # Initialize SFTP wrapper.
+    #
+    # @param host [String] host address of SFTP server
+    # @param port [Integer] port number of SFTP server
+    # @param username [String] user name of SFTP server
+    # @param password [String] password of SFTP server
+    # @param ssh_options [Hash] SSH options (set as -o options)
+    # @param ssh_config [String] path of SSH config file (set as -F option unless nil)
+    # @param open_timeout [Integer, Float]
+    # @param read_timeout [Integer, Float]
+    # @param command_timeout [Integer, Float]
+    # @param debug [Boolean]
+    #
+    # rubocop:disable Metrics/ParameterLists
+    def initialize(host, port, username, password,
+                   ssh_options: {},
+                   ssh_config: DEFAULT_SSH_CONFIG,
+                   open_timeout: DEFAULT_OPEN_TIMEOUT,
+                   read_timeout: DEFAULT_READ_TIMEOUT,
+                   command_timeout: DEFAULT_COMMAND_TIMEOUT,
+                   debug: false)
+      @host = host
+      @port = port
+      @username = username
+      @password = password
+      @ssh_options = DEFAULT_SSH_OPTIONS.merge(ssh_options)
+      @ssh_config = ssh_config
+      @open_timeout = open_timeout
+      @read_timeout = read_timeout
+      @command_timeout = command_timeout
+      @debug = debug
+    end
+    # rubocop:enable Metrics/ParameterLists
+
+    # Get remote file.
+    #
+    # @param source [String] source file path
+    # @param destination [String] destination path
+    # @raise [SftpWrapper::Errors::ConnectionError]
+    # @raise [SftpWrapper::Errors::AuthenticationFailure]
+    # @raise [SftpWrapper::Errors::TimeoutError]
+    # @raise [SftpWrapper::Errors::CommandError]
+    #
+    def download(source, destination)
+      execute(%W[get #{source} #{destination}].shelljoin)
+    end
+
+    # Put local file.
+    #
+    # @param source [String] source file path
+    # @param destination [String] destination path
+    # @raise [SftpWrapper::Errors::ConnectionError]
+    # @raise [SftpWrapper::Errors::AuthenticationFailure]
+    # @raise [SftpWrapper::Errors::TimeoutError]
+    # @raise [SftpWrapper::Errors::CommandError]
+    #
+    def upload(source, destination)
+      execute(%W[put #{source} #{destination}].shelljoin)
+    end
+
+    private
+
+    # Execute sftp command.
+    #
+    # @param command [String] SFTP command
+    # @raise [SftpWrapper::Errors::ConnectionError]
+    # @raise [SftpWrapper::Errors::AuthenticationFailure]
+    # @raise [SftpWrapper::Errors::TimeoutError]
+    # @raise [SftpWrapper::Errors::CommandError]
+    #
+    def execute(command) # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
+      cli = %w[sftp] + build_cli_args + [host]
+      PTY.getpty(cli.shelljoin) do |r, w, _pid|
+        w.sync = true
+
+        unless safe_expect(r, PASSWORD_PROMPT_RE, open_timeout)
+          raise SftpWrapper::Errors::ConnectionError, 'connection error.'
+        end
+
+        w.puts(password)
+
+        unless safe_expect(r, SFTP_PROMPT_RE, read_timeout)
+          raise SftpWrapper::Errors::AuthenticationFailure, 'authentication failure'
+        end
+
+        w.puts(command)
+
+        res = safe_expect(r, SFTP_PROMPT_RE, command_timeout)
+        raise SftpWrapper::Errors::TimeoutError, 'command timed out' unless res
+
+        skip = command.bytesize + 2
+        error_message = res[0].byteslice(skip..-1).chomp.sub(/#{SFTP_PROMPT}\z/, '').chomp
+        raise SftpWrapper::Errors::CommandError, error_message unless error_message.empty?
+
+        w.puts('quit')
+      end
+    end
+
+    def build_cli_args
+      args = []
+      args << '-q'
+      args += %W[-F #{ssh_config}] if ssh_config
+      args += %W[-P #{port} -o User=#{username}]
+      args += ssh_options.map { |k, v| %W[-o #{k}=#{v}] }.flatten
+      args
+    end
+
+    # @see https://github.com/ruby/ruby/blob/13b692200dba1056fa9033f2c64c43453f6d6a98/ext/pty/pty.c#L716-L723
+    def safe_expect(io, pattern, timeout)
+      expect_verbose = $expect_verbose # rubocop:disable Style/GlobalVars
+      $expect_verbose = debug # rubocop:disable Style/GlobalVars
+      io.expect(pattern, timeout)
+    rescue Errno::EIO
+      nil
+    ensure
+      $expect_verbose = expect_verbose # rubocop:disable Style/GlobalVars
+    end
+  end
+end

data/lib/sftp_wrapper/version.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module SftpWrapper
+  # version number.
+  VERSION = '0.1.0'
+end

data/lib/sftp_wrapper.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+# The wrapper for SFTP client CLI.
+module SftpWrapper
+  autoload :Errors, 'sftp_wrapper/errors'
+  autoload :OpenSSH, 'sftp_wrapper/open_ssh'
+  autoload :Curl, 'sftp_wrapper/curl'
+end

data/sftp_wrapper.gemspec

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sftp_wrapper/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'sftp_wrapper'
+  spec.version       = SftpWrapper::VERSION
+  spec.authors       = ['Masataka SUZUKI']
+  spec.email         = ['koshigoeb@gmail.com']
+
+  spec.summary       = 'The wrapper for sftp CLI.'
+  spec.description   = 'The wrapper for sftp CLI.'
+  spec.homepage      = 'https://github.com/koshigoe/sftp_wrapper'
+  spec.license       = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['homepage_uri'] = spec.homepage
+    spec.metadata['source_code_uri'] = spec.homepage
+    spec.metadata['changelog_uri'] = 'https://github.com/koshigoe/sftp_wrapper/CHANGELOG.md'
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against ' \
+      'public gem pushes.'
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.required_ruby_version = '>= 2.3.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.17'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'net-sftp', '~> 2.1'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rubocop', '~> 0.74'
+  spec.add_development_dependency 'simplecov', '~> 0.17'
+  spec.add_development_dependency 'yard', '~> 0.9'
+end

metadata

@@ -0,0 +1,165 @@
+--- !ruby/object:Gem::Specification
+name: sftp_wrapper
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Masataka SUZUKI
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-09-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: net-sftp
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !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: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.74'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.74'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.17'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+description: The wrapper for sftp CLI.
+email:
+- koshigoeb@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/continuous-integration-workflow.yml"
+- ".gitignore"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- benchmark/Gemfile
+- benchmark/Gemfile.lock
+- benchmark/benchmark_download.rb
+- benchmark/benchmark_upload.rb
+- bin/console
+- bin/setup
+- docker-compose.yml
+- lib/sftp_wrapper.rb
+- lib/sftp_wrapper/curl.rb
+- lib/sftp_wrapper/errors.rb
+- lib/sftp_wrapper/open_ssh.rb
+- lib/sftp_wrapper/version.rb
+- sftp_wrapper.gemspec
+homepage: https://github.com/koshigoe/sftp_wrapper
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/koshigoe/sftp_wrapper
+  source_code_uri: https://github.com/koshigoe/sftp_wrapper
+  changelog_uri: https://github.com/koshigoe/sftp_wrapper/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.6
+signing_key: 
+specification_version: 4
+summary: The wrapper for sftp CLI.
+test_files: []