sftp_wrapper 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e2e0e228c73646e79c09685f1b70acc11cf5f65ac18c5c2fd37441f3b75c5b2a
-  data.tar.gz: 0b76e0a5149bbc6d2e79c942121aacc5dcb83069647d95347824777812c452f1
+  metadata.gz: e165201ad7f2d7cb97746ca0f0e13f4796a1a7fd254ef07158bd7f49837969fd
+  data.tar.gz: 982118802dc86453fc18d0fb927e5cf0673308e2d2c6b232f188ec32accaec48
 SHA512:
-  metadata.gz: a66da813d9e6a2519afb0bd9fe2b0c5d40433ca7b63025cf7a53bda52bd3afe40e7230513c081feda33d8d9169c7fdca472ea4ae3a7de702f6045b2c1da07935
-  data.tar.gz: 6741c93b50de825182c507c62c45b412083094ee355f3f93529d5438ca9b08ed3638dd96905d649258dc88527fa6f37827618d89d5e3a6221932ff87e9a64f57
+  metadata.gz: 2a59acb94542d3c88e1685fc986a14864e0c62e57c17e354b828e46eec7fdab4226fe71c3fa109cd742a69665f419dec049d259e9d49876a223a8489fbceb225
+  data.tar.gz: 8af2ef626911b7ec3fbcdb66b6686e3e22e0c2eb36a79c2c9176eee97489f4665aa761761f132930553c08b6ed22a2f30ff0f2b56e6609f31623b65f25f06a6e

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

@@ -40,10 +40,18 @@ jobs:
           ./configure --disable-libcurl-option --disable-shared --with-libssh2 --with-ssl
           make
           sudo make install
-      - name: bundle install, run test
+      - name: setup rubygems
         run: |
           gem install bundler -v1.17 --force --no-document
           bundle install
+      - name: rubocop
+        run: |
+          bundle exec rubocop
+      - name: yard
+        run: |
+          bundle exec yard --fail-on-warning
+      - name: run test
+        run: |
           bundle exec rake
   release:
     name: Release Gem

data/.rubocop.yml

@@ -4,6 +4,7 @@ AllCops:
 Metrics/BlockLength:
   Exclude:
     - "test/**/*_test.rb"
+    - "benchmark/*.rb"
     - "*.gemspec"
 
 Metrics/ClassLength:

data/CHANGELOG.md

@@ -1,6 +1,14 @@
 Changelog
 ====
 
+[v0.2.0](https://github.com/koshigoe/sftp_wrapper/releases/tag/v0.2.0)
+----
+
+### Breaking Change
+
+- [#1](https://github.com/koshigoe/sftp_wrapper/pull/1) Change method signature of `SftpWrapper::Curl#initialize`.
+
+
 [v0.1.0](https://github.com/koshigoe/sftp_wrapper/releases/tag/v0.1.0)
 ----
 

data/README.md

@@ -26,7 +26,7 @@ Or install it yourself as:
 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')
+SftpWrapper::Curl.new('localhost', 2222, 'test', 'pass', curl_args: ['--silent', '--insecure']).download('/upload/file', './file')
 ```
 
 ## Development

data/lib/sftp_wrapper/curl.rb

@@ -7,7 +7,7 @@ require 'open3'
 module SftpWrapper
   # The wrapper for curl.
   class Curl
-    attr_reader :host, :port, :username, :password, :curl_command, :curl_options
+    attr_reader :host, :port, :username, :password, :curl_path, :curl_args
 
     # lookup table of curl errors.
     CURL_ERRORS = {
@@ -23,15 +23,17 @@ module SftpWrapper
     # @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)
+    # @param options [Hash] curl options.
+    # @option options [String] :curl_path path of `curl` command.
+    # @option options [Array<String>] :curl_args command line arguments of `curl`.
     #
-    def initialize(host, port, username, password, curl_options = {})
+    def initialize(host, port, username, password, 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
+      @curl_path = options[:curl_path] || 'curl'
+      @curl_args = options[:curl_args] || []
     end
 
     # Get remote file.
@@ -45,7 +47,7 @@ module SftpWrapper
     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]
+      cmd = %W[#{curl_path} -o #{destination}] + curl_args + [uri.to_s]
 
       execute(*cmd)
     end
@@ -61,17 +63,13 @@ module SftpWrapper
     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]
+      cmd = %W[#{curl_path} -T #{source}] + curl_args + [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)
 

data/lib/sftp_wrapper/version.rb

@@ -2,5 +2,5 @@
 
 module SftpWrapper
   # version number.
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sftp_wrapper
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Masataka SUZUKI
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-09-12 00:00:00.000000000 Z
+date: 2019-09-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler