sshkit 1.19.1 → 1.20.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1b8cc968102708cd224132592b522e059c57c29a68b7c0feced32ef905fb6f1e
-  data.tar.gz: d5a2ad7b2a09ba796ad5def0a211e793e7e27334fdf2296cc557fc92e9e92597
+  metadata.gz: 15fa13df6228673b8f0f084b8df88cadaff79d93bb78b83fcaf37d5c4f390419
+  data.tar.gz: 42f9c9401241796a150ef6c3f0d7f735c8fac91eed61975f22654df33c4200f5
 SHA512:
-  metadata.gz: 67f29e165c1d9612f157323a638a04054688a50c0bb302620756c3590a854929fcbac166b3f9f7671f32c21de2a22c5ca2e3ba7c3edb35c8918f7fc4ddc38d1d
-  data.tar.gz: 70c0ada0ed66f2b92032f7fc9adda13f3a2bb1d31207733072772817a795f7342de7b88acee6dc154c52a14c4aaaef051c4922118a87669c433320606ea2e0e6
+  metadata.gz: eb3b2a5df2f9706fc659e4cd901ffcea0487cae4009431f14b8606edd650d99229b63ff893ac45c6ce2501b860504d651430b2b98cb8f2368782e4f656dd50bd
+  data.tar.gz: 466488b99bfa4a768d2901edf9e63924e0aa76f099b5ba67f938d15881fc548d39c7dd26e89782eafa63d0f35a55f0dca8ff58b4be0272e63e6e61e05c0f10fa

data/CHANGELOG.md

@@ -7,6 +7,10 @@ appear at the top.
 
   * Your contribution here!
 
+## [1.20.0][] (2019-08-03)
+
+  * [#468](https://github.com/capistrano/sshkit/pull/468): Make `upload!` take a `:verbosity` option like `exec` does - [@grosser](https://github.com/grosser)
+
 ## [1.19.1][] (2019-07-02)
 
   * [#465](https://github.com/capistrano/sshkit/pull/456): Fix a regression in 1.19.0 that prevented `~` from being used in Capistrano paths, e.g. `:deploy_to`, etc. - [@grosser](https://github.com/grosser)
@@ -768,7 +772,8 @@ version `0.0.5`.
 
 First release.
 
-[Unreleased]: https://github.com/capistrano/sshkit/compare/v1.19.1...HEAD
+[Unreleased]: https://github.com/capistrano/sshkit/compare/v1.20.0...HEAD
+[1.20.0]: https://github.com/capistrano/sshkit/compare/v1.19.1...v1.20.0
 [1.19.1]: https://github.com/capistrano/sshkit/compare/v1.19.0...v1.19.1
 [1.19.0]: https://github.com/capistrano/sshkit/compare/v1.18.2...v1.19.0
 [1.18.2]: https://github.com/capistrano/sshkit/compare/v1.18.1...v1.18.2

data/README.md

@@ -6,29 +6,31 @@ more servers.
 [![Gem Version](https://badge.fury.io/rb/sshkit.svg)](https://rubygems.org/gems/sshkit)
 [![Build Status](https://travis-ci.org/capistrano/sshkit.svg?branch=master)](https://travis-ci.org/capistrano/sshkit)
 
-## How might it work?
+## Example
 
-The typical use-case looks something like this:
+ - Connect to 2 servers
+ - Execute commands as `deploy` user with `RAILS_ENV=production`
+ - Execute commands in serial (default is `:parallel`)
 
 ```ruby
 require 'sshkit'
 require 'sshkit/dsl'
 include SSHKit::DSL
 
-on %w{1.example.com 2.example.com}, in: :sequence, wait: 5 do |host|
+on ["1.example.com", "2.example.com"], in: :sequence do |host|
+  puts "Now executing on #{host}"
   within "/opt/sites/example.com" do
     as :deploy  do
-      with rails_env: :production do
-        rake   "assets:precompile"
-        runner "S3::Sync.notify"
-        execute :node, "socket_server.js"
+      with RAILS_ENV: 'production' do
+        execute :rake, "assets:precompile"
+        execute :rails, "runner", "S3::Sync.notify"
       end
     end
   end
 end
 ```
 
-You can find many other examples of how to use SSHKit over in [EXAMPLES.md](EXAMPLES.md).
+Many other examples are in [EXAMPLES.md](EXAMPLES.md).
 
 ## Basic usage
 
@@ -37,7 +39,7 @@ You can pass one or more hosts as parameters; this runs commands via SSH. Altern
 pass `:local` to run commands locally. By default SSKit will run the commands on all hosts in
 parallel.
 
-#### Running commands
+### Running commands
 
 All backends support the `execute(*args)`, `test(*args)` & `capture(*args)` methods
 for executing a command. You can call any of these methods in the context of an `on()`
@@ -63,7 +65,7 @@ end
 By default the `capture` methods strips whitespace. If you need to preserve whitespace
 you can pass the `strip: false` option: `capture(:ls, '-l', strip: false)`
 
-#### Transferring files
+### Transferring files
 
 All backends also support the `upload!` and `download!` methods for transferring files.
 For the remote backend, the file is transferred with scp.
@@ -75,7 +77,7 @@ on '1.example.com' do
 end
 ```
 
-#### Users, working directories, environment variables and umask
+### Users, working directories, environment variables and umask
 
 When running commands, you can tell SSHKit to set up the context for those
 commands using the following methods:
@@ -113,6 +115,11 @@ the raised error.
 Helpers such as `runner()` and `rake()` which expand to `execute(:rails, "runner", ...)` and
 `execute(:rake, ...)` are convenience helpers for Ruby, and Rails based apps.
 
+### Verbosity / Silence
+
+ - raise verbosity of a command: `execute "echo DEAD", verbosity: :ERROR`
+ - hide a command from output: `execute "echo HIDDEN", verbosity: :DEBUG`
+
 ## Parallel
 
 Notice on the `on()` call the `in: :sequence` option, the following will do
@@ -567,6 +574,20 @@ In order to do special gymnastics with SSH, tunneling, aliasing, complex options
 
 These system level files are the preferred way of setting up tunneling and proxies because the system implementations of these things are faster and better than the Ruby implementations you would get if you were to configure them through Net::SSH. In cases where it's not possible (Windows?), it should be possible to make use of the Net::SSH APIs to setup tunnels and proxy commands before deferring control to Capistrano/SSHKit..
 
+## Proxying
+
+To connect to the target host via a jump/bastion host, use a `Net::SSH::Proxy::Jump`
+
+```ruby
+host = SSHKit::Host.new(
+  hostname: 'target.host.com',
+  ssh_options: { proxy: Net::SSH::Proxy::Jump.new("proxy.bar.com") }
+)
+on [host] do
+  execute :echo, '1'
+end
+```
+
 ## SSHKit Related Blog Posts
 
 [SSHKit Gem Basics](http://www.rubyplus.com/articles/591)

data/examples/simple_connection.rb

@@ -0,0 +1,10 @@
+# tiny example so you can play with the sshkit or make a failing example for an issue
+require 'bundler/setup'
+require 'sshkit'
+require 'sshkit/dsl'
+include SSHKit::DSL
+
+on [ENV.fetch("HOST")] do
+  execute "echo hello"
+end
+

data/lib/sshkit/backends/netssh.rb

@@ -109,7 +109,8 @@ module SSHKit
             message = "#{action} #{name} #{percentage.round(2)}%"
             percentage_r = (percentage / log_percent).truncate * log_percent
             if percentage_r > 0 && (last_name != name || last_percentage != percentage_r)
-              info message
+              verbosity = (options[:verbosity] || :INFO).downcase # TODO: ideally reuse command.rb logic
+              public_send verbosity, message
               last_name = name
               last_percentage = percentage_r
             else

data/lib/sshkit/version.rb

@@ -1,3 +1,3 @@
 module SSHKit
-  VERSION = "1.19.1".freeze
+  VERSION = "1.20.0".freeze
 end

data/test/unit/backends/test_netssh.rb

@@ -54,6 +54,13 @@ module SSHKit
         end
       end
 
+      def test_transfer_summarizer_uses_verbosity
+        netssh = Netssh.new(Host.new('fake'))
+        summarizer = netssh.send(:transfer_summarizer, 'Transferring', verbosity: :ERROR)
+        netssh.expects(:error).with { |msg| msg.include?('Transferring afile 15.0%') }
+        summarizer.call(nil,'afile',15,100)
+      end
+
       if Net::SSH::Version::CURRENT >= Net::SSH::Version[3, 1, 0]
         def test_known_hosts_for_when_all_hosts_are_recognized
           perform_known_hosts_test('github', 'github.com')

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sshkit
 version: !ruby/object:Gem::Version
-  version: 1.19.1
+  version: 1.20.0
 platform: ruby
 authors:
 - Lee Hambley
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-02 00:00:00.000000000 Z
+date: 2019-08-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: net-ssh
@@ -199,6 +199,7 @@ files:
 - Vagrantfile
 - examples/images/example_output.png
 - examples/images/logo.png
+- examples/simple_connection.rb
 - lib/core_ext/array.rb
 - lib/core_ext/hash.rb
 - lib/sshkit.rb