net-ssh-cli 1.3.1 → 1.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: edf3e84c80ca5ee2c6b67efee26c5f5b4f4b51a6c3425c4b7093e1d20eee4816
-  data.tar.gz: 59b804e5249298c0f6de5debb26a89eacc3221e0a7d1bf3fe47aa08c5c2e89fa
+  metadata.gz: 8d734f75313a3aea3cbb85a47335ddf7296a3e8f14decdc9f7b20e1ee0b54471
+  data.tar.gz: c9a577d837e7b5854e7b5e88ee7efa0838872948eb3d6fe51cdf39e57acdd970
 SHA512:
-  metadata.gz: 0d1046b9eab50cf26d5a1acab9d9301fa90225204df55168c64dcb9d985310aacdee023fe2c4ce2628cf016847e891feed6f94da3c0423c6555f41f3727262da
-  data.tar.gz: 2c70b909d56f711d972b8381f4eef838e785b1b78d63d11786fded541b00d0b03b487fa66418b791965d4c13c0a02c28f65751cab5fa917a459c5ccdffa00ae6
+  metadata.gz: 74d34dc0d28a962a801ba14f0d0accbd36b7ba88eecf99c845714a23cc79ca1f196e626ab88c9f178aa9dc01cf1af0285d9f395bb2103670ecbcc34afd629702
+  data.tar.gz: 107dd734b5d01ec26edb80e3bcfd0bc023358e16f77ebf6c1b4157ae5ccc4d81a26a9669634e84bd64b16e0dadbd9839aac7690c77b156477d1c0cd633b81f95

data/README.md

@@ -79,12 +79,22 @@ It's the same as #cmd but for multiple commands.
 ```
 
 ### #dialog
+
+Use this method to specify a differnt 'prompt' for once. This is perfect for interactive commands. 
+
 ```ruby
   cli.dialog "echo 'are you sure?' && read -p 'yes|no>'", /\nyes|no>/
   # => "echo 'are you sure?' && read -p 'yes|no>'\nyes|no>"
   cli.cmd "yes"
 ```
 
+```ruby
+cli.dialog "passwd", /Current Password:/i
+cli.dialog "Old Password", /New Password:/i
+cli.dialog "New Password", /Repeat Password:/i
+cli.cmd "New Password"
+```
+
 ### #impact
 
 The very same as `#cmd` but it respects a flag whether to run commands with 'impact'.
@@ -148,10 +158,10 @@ Nearly everything can be configured.
 ### Callbacks
 
 The following callbacks are available
- - #before_open_channel
- - #after_open_channel
- - #before_on_data
- - #before_on_data
+ - before_open_channel
+ - after_open_channel
+ - before_on_stdout
+ - after_on_stdout
 
 ```ruby
 cli.before_open_channel do
@@ -166,6 +176,20 @@ cli.after_open_channel do
 end
 ```
 
+Using the callbacks you can define a debugger which shows the `stdout` buffer content each time new data is received.
+
+```ruby
+cli.after_on_stdout do
+  warn stdout
+end
+```
+
+```ruby
+cli.after_on_stdout do
+  stdout.gsub!("\r\n", "\n")
+end
+```
+
 ### #hostname #host #to_s
 
 ```ruby

data/lib/net/ssh/cli.rb

@@ -176,12 +176,12 @@ module Net
 
         hard_timeout = timeout
         hard_timeout += 0.5 if timeout
-        ::Timeout.timeout(hard_timeout, Error::ReadTillTimeout) do
+        ::Timeout.timeout(hard_timeout, Error::ReadTillTimeout, "#{current_prompt.inspect} didn't match on #{stdout.inspect} within #{timeout}s") do
           with_prompt(prompt) do
             soft_timeout = Time.now + timeout if timeout
             until stdout[current_prompt] do
               if timeout and soft_timeout < Time.now
-                raise Error::ReadTillTimeout, "Timeout after #{timeout}s, #{current_prompt.inspect} never matched #{stdout.inspect}"
+                raise Error::ReadTillTimeout, "#{current_prompt.inspect} didn't match on #{stdout.inspect} within #{timeout}s"
               end
               process
               sleep 0.1
@@ -198,7 +198,7 @@ module Net
 
       def dialog(command, prompt, **opts)
         opts = opts.clone.merge(prompt: prompt)
-        cmd(command, opts)
+        cmd(command, **opts)
       end
 
       # 'read' first on purpuse as a feature. once you cmd you ignore what happend before. otherwise use read|write directly.
@@ -210,9 +210,9 @@ module Net
           logger.debug { "#cmd ignoring pre-command output: #{pre_read_data.inspect}" } if pre_read_data.present?
         end
         write_n command
-        output = read_till(opts)
-        rm_prompt!(output, opts)
-        rm_command!(output, command, opts)
+        output = read_till(**opts)
+        rm_prompt!(output, **opts)
+        rm_command!(output, command, **opts)
         output
       end
       alias command cmd
@@ -224,11 +224,11 @@ module Net
       alias commands cmds
 
       def rm_command!(output, command, **opts)
-        output[command + "\n"] = '' if rm_command?(opts) && output[command + "\n"]
+        output[command + "\n"] = '' if rm_command?(**opts) && output[command + "\n"]
       end
 
       def rm_prompt!(output, **opts)
-        if rm_prompt?(opts)
+        if rm_prompt?(**opts)
           prompt = opts[:prompt] || current_prompt
           if output[prompt]
             prompt.is_a?(Regexp) ? output[prompt, 1] = '' : output[prompt] = ''

data/lib/net/ssh/cli/version.rb

@@ -3,7 +3,7 @@
 module Net
   module SSH
     module CLI
-      VERSION = '1.3.1'
+      VERSION = '1.4.1'
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: net-ssh-cli
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.4.1
 platform: ruby
 authors:
 - Fabian Stillhart
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-07-15 00:00:00.000000000 Z
+date: 2020-03-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -140,7 +140,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.4
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: 'Net::SSH::CLI: A library to handle CLI Sessions'