net-ssh-cli 1.2.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: df1b678f96b5758f1c1d5c17af957b177d2ca266e3c184a1e1df0e6124c3cd2f
-  data.tar.gz: a645c159917d066d1c86f7a6afb69fc7932c1ff7059524cbf296864673fc6454
+  metadata.gz: fab3c1030af162f3166a59820d542a60e020b1cb14dbf11cf9ebc4421242fa3a
+  data.tar.gz: cb0391c25fea6a1a2f5762eb6131a737bd51bf6a00e48807fdf486a3d9a4aa96
 SHA512:
-  metadata.gz: fa3eef297fc1650a67a4c5245bee743640ab146e615e683afd2349a0d996760d7ad7076a29fb3922880f92a76532f1b69f54d0209241925f1fb53d2b6ef3509a
-  data.tar.gz: c438a6ec62a4416847dec30ce3fd2c0365bf05c5e9a18f3791b6c8405ac1e516dbad45e452c8f9d781008d2992a40a50b4a8364e789fb1b37c1db888e57dce38
+  metadata.gz: 825b5a40f8ffd7ad64ba817c8de01bd9a9fdc15289ea400f18da3dd2f60b2e6ccf5a5ae75f453d1a3649a05fcf9e0a9722e6194ad264337f71211836290e5695
+  data.tar.gz: ecfefd65bb0c0f9132bfd911e4a42b8640e85281dabd19311fc6fd7240549d9220f2280bb461fd440780ff1df8b903c812cb1620e16a9fd7ce33c0996fd1f244

data/README.md

@@ -69,6 +69,15 @@ Remove the command and the prompt for #cmd & #dialog by default
   # => "bananas"
 ```
 
+### #cmds
+
+It's the same as #cmd but for multiple commands.
+
+```ruby
+  cli.cmds ["echo 'bananas'", "echo 'apples'"], rm_command: true, rm_prompt: true
+  # => ["bananas", "apples"]
+```
+
 ### #dialog
 ```ruby
   cli.dialog "echo 'are you sure?' && read -p 'yes|no>'", /\nyes|no>/
@@ -76,6 +85,25 @@ Remove the command and the prompt for #cmd & #dialog by default
   cli.cmd "yes"
 ```
 
+### #impact
+
+The very same as `#cmd` but it respects a flag whether to run commands with 'impact'.
+This can be used in a setup where you don't want to run certain commands under certain conditions.
+For example in testing. 
+
+```ruby
+  cli.run_impact?
+  # => false
+  cli.impact "reboot now"
+  # => "skip: 'reboot now'"
+```
+
+```ruby
+  cli.run_impact = true
+  cli.impact "reboot now"
+  # => connection closed
+```
+
 ### #read & #write
 
 ```ruby
@@ -94,17 +122,28 @@ Remove the command and the prompt for #cmd & #dialog by default
 ### #read_till
 keep on processing till the stdout matches to given|default prompt and then read the whole stdin.
 ```ruby
-  cli.write "\n"
+  cli.write "echo 'hello'\n"
   # => "echo 'hello'\n"
   cli.read_till
   # => "echo 'hello'\nhello\nuser@host:"
 ```
 
-This method is used by #cmd
+This method is used by #cmd, see ``lib/net/ssh/cli.rb#cmd``
+
+### #read_for
+
+```ruby
+  cli.write_n "sleep 180"
+  # => ""
+  cli.read_for(seconds: 181)
+  # => "..."
+```
 
 ## Configuration
 
-Have a deep look at ``Net::SSH::CLI::OPTIONS`` at ``lib/net/ssh/cli.rb``
+Have a deep look at the various Options configured by ``Net::SSH::CLI::OPTIONS`` in ``lib/net/ssh/cli.rb``
+Nearly everything can be configured.
+
 
 ### Callbacks
 
@@ -120,6 +159,36 @@ cli.before_open_channel do
 end
 ```
 
+```ruby
+cli.after_open_channel do
+  cmd "logger 'Net::SSH::CLI works'"
+  cmd "sudo -i"
+end
+```
+
+### #hostname #host #to_s
+
+```ruby
+  cli.to_s
+  # => "localhost"
+  cli.hostname
+  # => "localhost"
+  cli.host
+  # => "localhost"
+```
+
+### #detect_prompt
+
+NET::SSH::CLI can try to guess the prompt by waiting for it and using the last line.
+This works usually, but is not guaranteed to work well.
+
+```ruby
+  cli.open_channel
+  # => ...
+  cli.detect_prompt(seconds: 3)
+  # => "[my prompt]"
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/net/ssh/cli.rb

@@ -32,10 +32,11 @@ module Net
         options.merge!(opts)
         self.net_ssh = options.delete(:net_ssh)
         self.logger = options.delete(:logger) || Logger.new(STDOUT, level: Logger::WARN)
+        self.process_count = 0
         @new_data = String.new
       end
 
-      attr_accessor :channel, :stdout, :net_ssh, :logger, :new_data
+      attr_accessor :channel, :stdout, :net_ssh, :logger, :new_data, :process_count
 
       OPTIONS = ActiveSupport::HashWithIndifferentAccess.new(
         default_prompt:            /\n?^(\S+@.*)\z/,                             # the default prompt to search for
@@ -106,7 +107,9 @@ module Net
         before_on_stdout_procs.each { |_name, a_proc| instance_eval(&a_proc) }
         stdout << new_data
         after_on_stdout_procs.each { |_name, a_proc| instance_eval(&a_proc) }
-        process # if we receive data, we probably receive more - improves performance
+        self.process_count += 1
+        process unless process_count > 100 # if we receive data, we probably receive more - improves performance - but on a lot of data, this leads to a stack level too deep
+        self.process_count -= 1
         stdout
       end
 

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

@@ -3,7 +3,7 @@
 module Net
   module SSH
     module CLI
-      VERSION = '1.2.0'
+      VERSION = '1.2.1'
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: net-ssh-cli
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.2.1
 platform: ruby
 authors:
 - Fabian Stillhart
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-05-10 00:00:00.000000000 Z
+date: 2019-06-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler