sshkit 1.13.1 → 1.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1e6e753e52f903eae9ac0ecb2475a33ec5b96c31
-  data.tar.gz: 00e47def1aa6b84b43395c9ff39377a16c893de2
+  metadata.gz: b21b9fc05481526fd6470265cb3afb51fcc0691a
+  data.tar.gz: 4a093de329e546b6410c01c03ab8fe8379c8c53f
 SHA512:
-  metadata.gz: 223c11ff64f9a19d422e789883e66d7d48b4d0d7a143f5b60c3f03553c81655780c2e2f3070ac146f04ef9eb592eba5e453ed0ec7d9a6475dbccbaadb4c9ea76
-  data.tar.gz: 78b90ecb8e2cd4efd4c9760de40d5338b6d8cd4efc2034264a53bf15073301e2dd1b5347c24ba3ea2064050922caf07e47a954983051379191180f4774ddb8bd
+  metadata.gz: 7f7ba415cd0b373c356ab99e1ca0624bcca5265c328e2b060def73684541eaf041b539162779a7463691428162e5758bcc025bbe8c6966f3deca4cb95aaa9f8e
+  data.tar.gz: f2907bc157c0cacfa2309725aa637deff3bf43079b5dbe255c7d00049997f46cdb574823d8ee8bd848c6e12b24a0c5bb02d8ed66e8196bb87d5fff2b14c41380

data/CHANGELOG.md

@@ -7,6 +7,16 @@ appear at the top.
 
   * Your contribution here!
 
+## [1.14.0][] (2017-06-30)
+
+### Breaking changes
+
+  * None
+
+### New features
+
+  * [#401](https://github.com/capistrano/sshkit/pull/401): Add :log_percent option to specify upload!/download! transfer log percentage - [@aubergene](https://github.com/aubergene)
+
 ## [1.13.1][] (2017-03-31)
 
 ### Breaking changes
@@ -15,7 +25,7 @@ appear at the top.
 
 ### Bug fixes
 
-  * [#397](https://github.com/capistrano/sshkt/pull/397): Fix NoMethodError assign_defaults with net-ssh older than 4.0.0 - [@shirosaki](https://github.com/shirosaki)
+  * [#397](https://github.com/capistrano/sshkit/pull/397): Fix NoMethodError assign_defaults with net-ssh older than 4.0.0 - [@shirosaki](https://github.com/shirosaki)
 
 ## [1.13.0][] (2017-03-24)
 
@@ -697,7 +707,8 @@ version `0.0.5`.
 
 First release.
 
-[Unreleased]: https://github.com/capistrano/sshkit/compare/v1.13.1...HEAD
+[Unreleased]: https://github.com/capistrano/sshkit/compare/v1.14.0...HEAD
+[1.14.0]: https://github.com/capistrano/sshkit/compare/v1.13.1...v1.14.0
 [1.13.1]: https://github.com/capistrano/sshkit/compare/v1.13.0...v1.13.1
 [1.13.0]: https://github.com/capistrano/sshkit/compare/v1.12.0...v1.13.0
 [1.12.0]: https://github.com/capistrano/sshkit/compare/v1.11.5...v1.12.0

data/README.md

@@ -72,7 +72,7 @@ For the remote backend, the file is tranferred with scp.
 ```ruby
 on '1.example.com' do
   upload! 'some_local_file.txt', '/home/some_user/somewhere'
-  download! '/home/some_user/some_remote_file.txt', 'somewhere_local'
+  download! '/home/some_user/some_remote_file.txt', 'somewhere_local', :log_percent 25
 end
 ```
 

data/Rakefile

@@ -1,5 +1,3 @@
-#!/usr/bin/env rake
-
 require 'bundler/gem_tasks'
 require 'rake/testtask'
 require 'rubocop/rake_task'

data/lib/sshkit/backends/netssh.rb

@@ -62,14 +62,14 @@ module SSHKit
       end
 
       def upload!(local, remote, options = {})
-        summarizer = transfer_summarizer('Uploading')
+        summarizer = transfer_summarizer('Uploading', options)
         with_ssh do |ssh|
           ssh.scp.upload!(local, remote, options, &summarizer)
         end
       end
 
       def download!(remote, local=nil, options = {})
-        summarizer = transfer_summarizer('Downloading')
+        summarizer = transfer_summarizer('Downloading', options)
         with_ssh do |ssh|
           ssh.scp.download!(remote, local, options, &summarizer)
         end
@@ -96,14 +96,16 @@ module SSHKit
 
       private
 
-      def transfer_summarizer(action)
+      def transfer_summarizer(action, options = {})
+        log_percent = options[:log_percent] || 10
+        log_percent = 100 if log_percent <= 0
         last_name = nil
         last_percentage = nil
         proc do |_ch, name, transferred, total|
           percentage = (transferred.to_f * 100 / total.to_f)
           unless percentage.nan?
             message = "#{action} #{name} #{percentage.round(2)}%"
-            percentage_r = (percentage / 10).truncate * 10
+            percentage_r = (percentage / log_percent).truncate * log_percent
             if percentage_r > 0 && (last_name != name || last_percentage != percentage_r)
               info message
               last_name = name

data/lib/sshkit/command.rb

@@ -21,10 +21,9 @@ module SSHKit
     def initialize(*args)
       raise ArgumentError, "Must pass arguments to Command.new" if args.empty?
       @options = default_options.merge(args.extract_options!)
-      @command = args.shift.to_s.strip.to_sym
+      @command = sanitize_command(args.shift)
       @args    = args
       @options.symbolize_keys!
-      sanitize_command!
       @stdout, @stderr, @full_stdout, @full_stderr = String.new, String.new, String.new, String.new
     end
 
@@ -222,16 +221,8 @@ module SSHKit
       }
     end
 
-    def sanitize_command!
-      command.to_s.strip!
-      if command.to_s.match("\n")
-        @command = String.new.tap do |cs|
-          command.to_s.lines.each do |line|
-            cs << line.strip
-            cs << '; ' unless line == command.to_s.lines.to_a.last
-          end
-        end
-      end
+    def sanitize_command(cmd)
+      cmd.to_s.lines.map(&:strip).join("; ")
     end
 
     def call_interaction_handler(stream_name, data, channel)

data/lib/sshkit/version.rb

@@ -1,3 +1,3 @@
 module SSHKit
-  VERSION = "1.13.1".freeze
+  VERSION = "1.14.0".freeze
 end

data/sshkit.gemspec

@@ -25,6 +25,10 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency('minitest-reporters')
   gem.add_development_dependency('rainbow', '~> 2.1.0')
   gem.add_development_dependency('rake')
-  gem.add_development_dependency('rubocop')
+  gem.add_development_dependency('rubocop', "~> 0.49.1")
   gem.add_development_dependency('mocha')
+
+  gem.add_development_dependency('bcrypt_pbkdf')
+  gem.add_development_dependency('rbnacl', '~> 3.4')
+  gem.add_development_dependency('rbnacl-libsodium')
 end

data/test/unit/test_command.rb

@@ -16,7 +16,7 @@ module SSHKit
       end
     end
 
-    def test_using_a_heredoc
+    def test_multiple_lines_are_stripped_of_extra_space_and_joined_by_semicolons
       c = Command.new <<-EOHEREDOC
         if test ! -d /var/log; then
           echo "Example"
@@ -25,6 +25,11 @@ module SSHKit
       assert_equal "if test ! -d /var/log; then; echo \"Example\"; fi", c.to_command
     end
 
+    def test_leading_and_trailing_space_is_stripped
+      c = Command.new(" echo hi ")
+      assert_equal "echo hi", c.to_command
+    end
+
     def test_including_the_env
       SSHKit.config = nil
       c = Command.new(:rails, 'server', env: {rails_env: :production})

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sshkit
 version: !ruby/object:Gem::Version
-  version: 1.13.1
+  version: 1.14.0
 platform: ruby
 authors:
 - Lee Hambley
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-31 00:00:00.000000000 Z
+date: 2017-06-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: net-ssh
@@ -111,6 +111,20 @@ dependencies:
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.49.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.49.1
+- !ruby/object:Gem::Dependency
+  name: mocha
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -124,7 +138,35 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: mocha
+  name: bcrypt_pbkdf
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rbnacl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: rbnacl-libsodium
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -251,7 +293,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.6.12
 signing_key: 
 specification_version: 4
 summary: SSHKit makes it easy to write structured, testable SSH commands in Ruby