net-ssh-cli 1.9.1 → 1.9.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7056a8a1973f705133135914df49d4b16e1b9213b35b987677094b9993b3b059
-  data.tar.gz: 5520b049f17149f5a17849f396b150451a0b7f50f0ceee4e79d616f23ec876e9
+  metadata.gz: 0e1db663e9e79a41c9c5fbb7b0dce5918a0bd61b83fb98f8d9314f1a4602a698
+  data.tar.gz: d7841ea18aefa288771a8ef64459373824b2c307b5f4b8e89a0b636fdfceb172
 SHA512:
-  metadata.gz: b5d34700dc16a246ce3706828d2043993b34496d5b1a742f5dbbff366a62591ae2327bf7f9a1ec0044281962ae65f7f6297f2b49025f4acc1ba2175d2004ae12
-  data.tar.gz: 0231d51bb361bbb6181138d1f0ec3350071c804f06e0e863bbe9d97fb85e5e9a156019f0fb6e7332a3e36baeda0d67050f34bbe519b275d8b0fa4c5439331878
+  metadata.gz: 5e33f5fd908ea9c927913692add3a4a112359e85875eb64af988c4f8d9b6d0fc6e3fa877583ec5be8ebb2f6dd62c83c2c5eebd8df858d07897e08c62bfa0452e
+  data.tar.gz: 92007ac57dd811683cc6715592c2544ab28e7a0be42237e65f8d3d71ed44e2c3d2df815d1bb6395b1f73294e00529b6a5f8a11cd257396b6a2623b34dcab7126

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

@@ -3,7 +3,7 @@
 module Net
   module SSH
     module CLI
-      VERSION = '1.9.1'
+      VERSION = '1.9.2'
     end
   end
 end

data/lib/net/ssh/cli.rb

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
 
-require 'net/ssh/cli/version'
-require 'net/ssh'
-require 'active_support/core_ext/hash/indifferent_access'
-require 'active_support/core_ext/object/blank'
-require 'timeout'
-require 'logger'
+require "net/ssh/cli/version"
+require "net/ssh"
+require "active_support/core_ext/hash/indifferent_access"
+require "active_support/core_ext/object/blank"
+require "timeout"
+require "logger"
 
 module Net
   module SSH
@@ -40,36 +40,36 @@ module Net
       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. It is recommended to use \z to ensure you don't match the prompt too early.
-        cmd_rm_prompt:             false,                                        # whether the prompt should be removed in the output of #cmd
-        cmd_rm_command:            false,                                        # whether the given command should be removed in the output of #cmd
-        cmd_rm_command_tail:       "\n",                                         # which format does the end of line return after a command has been submitted. Could be something like "ls\n" "ls\r\n" or "ls \n" (extra spaces)
-        cmd_minimum_duration:      0,                                            # how long do you want to wait/sleep after sending the command. After this waiting time, the output will be processed and the prompt will be searched.
-        run_impact:                false,                                        # whether to run #impact commands. This might align with testing|development|production. example #impact("reboot")
-        read_till_timeout:         nil,                                          # timeout for #read_till to find the match
-        read_till_hard_timeout:    nil,                                          # hard timeout for #read_till to find the match using Timeout.timeout(hard_timeout) {}. Might creates unpredicted sideffects
-        read_till_hard_timeout_factor: 1.2,                                      # hard timeout factor in case read_till_hard_timeout is true
-        named_prompts:             ActiveSupport::HashWithIndifferentAccess.new, # you can used named prompts for #with_prompt {}
-        before_cmd_procs:          ActiveSupport::HashWithIndifferentAccess.new, # procs to call before #cmd
-        after_cmd_procs:           ActiveSupport::HashWithIndifferentAccess.new, # procs to call after  #cmd
-        before_on_stdout_procs:    ActiveSupport::HashWithIndifferentAccess.new, # procs to call before data arrives from the underlying connection
-        after_on_stdout_procs:     ActiveSupport::HashWithIndifferentAccess.new, # procs to call after  data arrives from the underlying connection
-        before_on_stdin_procs:     ActiveSupport::HashWithIndifferentAccess.new, # procs to call before data is sent to the underlying channel
-        after_on_stdin_procs:      ActiveSupport::HashWithIndifferentAccess.new, # procs to call after  data is sent to the underlying channel
+        default_prompt: /\n?^(\S+@.*)\z/, # the default prompt to search for. It is recommended to use \z to ensure you don't match the prompt too early.
+        cmd_rm_prompt: false, # whether the prompt should be removed in the output of #cmd
+        cmd_rm_command: false, # whether the given command should be removed in the output of #cmd
+        cmd_rm_command_tail: "\n", # which format does the end of line return after a command has been submitted. Could be something like "ls\n" "ls\r\n" or "ls \n" (extra spaces)
+        cmd_minimum_duration: 0, # how long do you want to wait/sleep after sending the command. After this waiting time, the output will be processed and the prompt will be searched.
+        run_impact: false, # whether to run #impact commands. This might align with testing|development|production. example #impact("reboot")
+        read_till_timeout: nil, # timeout for #read_till to find the match
+        read_till_hard_timeout: nil, # hard timeout for #read_till to find the match using Timeout.timeout(hard_timeout) {}. Might creates unpredicted sideffects
+        read_till_hard_timeout_factor: 1.2, # hard timeout factor in case read_till_hard_timeout is true
+        named_prompts: ActiveSupport::HashWithIndifferentAccess.new, # you can used named prompts for #with_prompt {}
+        before_cmd_procs: ActiveSupport::HashWithIndifferentAccess.new, # procs to call before #cmd
+        after_cmd_procs: ActiveSupport::HashWithIndifferentAccess.new, # procs to call after  #cmd
+        before_on_stdout_procs: ActiveSupport::HashWithIndifferentAccess.new, # procs to call before data arrives from the underlying connection
+        after_on_stdout_procs: ActiveSupport::HashWithIndifferentAccess.new, # procs to call after  data arrives from the underlying connection
+        before_on_stdin_procs: ActiveSupport::HashWithIndifferentAccess.new, # procs to call before data is sent to the underlying channel
+        after_on_stdin_procs: ActiveSupport::HashWithIndifferentAccess.new, # procs to call after  data is sent to the underlying channel
         before_open_channel_procs: ActiveSupport::HashWithIndifferentAccess.new, # procs to call before opening a channel
-        after_open_channel_procs:  ActiveSupport::HashWithIndifferentAccess.new, # procs to call after  opening a channel, for example you could call #detect_prompt or #read_till
-        open_channel_timeout:      nil,                                          # timeout to open the channel
-        net_ssh_options:           ActiveSupport::HashWithIndifferentAccess.new, # a wrapper for options to pass to Net::SSH.start in case net_ssh is undefined
-        process_time:              0.00001,                                      # how long #process is processing net_ssh#process or sleeping (waiting for something)
-        background_processing:     false,                                        # default false, whether the process method maps to the underlying net_ssh#process or the net_ssh#process happens in a separate loop
-        on_stdout_processing:      100,                                          # whether to optimize the on_stdout performance by calling #process #optimize_on_stdout-times in case more data arrives
-        sleep_procs:               ActiveSupport::HashWithIndifferentAccess.new, # procs to call instead of Kernel.sleep(), perfect for async hooks
-        terminal_chars_width:      320,                                          # Sets and sends the terminal dimensions during the opening of the channel. It does not send a channel_request on change.
-        terminal_chars_height:     120,                                          # See also https://github.com/net-ssh/net-ssh/blob/master/lib/net/ssh/connection/channel.rb#L220 section 'def request_pty'
-        terminal_pixels_width:     1920,                                         # See also https://www.ietf.org/rfc/rfc4254.txt section pty-req and section window-change
-        terminal_pixels_height:    1080,                                         #
-        terminal_term:             nil,                                          # Sets the terminal term, usually xterm
-        terminal_modes:            nil,                                          #
+        after_open_channel_procs: ActiveSupport::HashWithIndifferentAccess.new, # procs to call after  opening a channel, for example you could call #detect_prompt or #read_till
+        open_channel_timeout: nil, # timeout to open the channel
+        net_ssh_options: ActiveSupport::HashWithIndifferentAccess.new, # a wrapper for options to pass to Net::SSH.start in case net_ssh is undefined
+        process_time: 0.00001, # how long #process is processing net_ssh#process or sleeping (waiting for something)
+        background_processing: false, # default false, whether the process method maps to the underlying net_ssh#process or the net_ssh#process happens in a separate loop
+        on_stdout_processing: 100, # whether to optimize the on_stdout performance by calling #process #optimize_on_stdout-times in case more data arrives
+        sleep_procs: ActiveSupport::HashWithIndifferentAccess.new, # procs to call instead of Kernel.sleep(), perfect for async hooks
+        terminal_chars_width: 320, # Sets and sends the terminal dimensions during the opening of the channel. It does not send a channel_request on change.
+        terminal_chars_height: 120,                                          # See also https://github.com/net-ssh/net-ssh/blob/master/lib/net/ssh/connection/channel.rb#L220 section 'def request_pty'
+        terminal_pixels_width: 1920,                                         # See also https://www.ietf.org/rfc/rfc4254.txt section pty-req and section window-change
+        terminal_pixels_height: 1080, #
+        terminal_term: nil,                                          # Sets the terminal term, usually xterm
+        terminal_modes: nil                                          #
       )
 
       def options
@@ -103,10 +103,10 @@ module Net
         end
       end
 
-      OPTIONS.keys.select {|key| key.to_s.include? "procs"}.each do |name|
-        define_method name.sub("_procs","") do |&blk|
+      OPTIONS.keys.select { |key| key.to_s.include? "procs" }.each do |name|
+        define_method name.sub("_procs", "") do |&blk|
           id = SecureRandom.uuid
-          self.send(name)[id] = Proc.new {blk.call}
+          send(name)[id] = proc { blk.call }
           id
         end
       end
@@ -168,12 +168,10 @@ module Net
       # end
       # cmd("exit")
       #
-      def with_named_prompt(name)
+      def with_named_prompt(name, &block)
         raise Error::UndefinedMatch, "unknown named_prompt #{name}" unless named_prompts[name]
 
-        with_prompt(named_prompts[name]) do
-          yield
-        end
+        with_prompt(named_prompts[name], &block)
       end
 
       # tries to detect the prompt
@@ -217,17 +215,17 @@ module Net
       #  - hard_timeout_factor: nil, true, or a number
       #  -   when hard_timeout == true, this will set the hard_timeout as (read_till_hard_timeout_factor * read_till_timeout), defaults to 1.2 = +20%
       def read_till(prompt: current_prompt, timeout: read_till_timeout, hard_timeout: read_till_hard_timeout, hard_timeout_factor: read_till_hard_timeout_factor, **_opts)
-        raise Error::UndefinedMatch, 'no prompt given or default_prompt defined' unless prompt
+        raise Error::UndefinedMatch, "no prompt given or default_prompt defined" unless prompt
+
         hard_timeout = (read_till_hard_timeout_factor * timeout) if timeout and hard_timeout == true
         hard_timeout = nil if hard_timeout == true
 
         with_prompt(prompt) do
           ::Timeout.timeout(hard_timeout, Error::ReadTillTimeout, "#{current_prompt.inspect} didn't match on #{stdout.inspect} within #{hard_timeout}s") do
             soft_timeout = Time.now + timeout if timeout
-            until prompt_in_stdout? do
-              if timeout and soft_timeout < Time.now
-                raise Error::ReadTillTimeout, "#{current_prompt.inspect} didn't match on #{stdout.inspect} within #{timeout}s"
-              end
+            until prompt_in_stdout?
+              raise Error::ReadTillTimeout, "#{current_prompt.inspect} didn't match on #{stdout.inspect} within #{timeout}s" if timeout and soft_timeout < Time.now
+
               process
               sleep 0.01 # don't race for CPU
             end
@@ -253,7 +251,7 @@ module Net
       end
 
       def dialog(command, prompt, **opts)
-        opts = opts.clone.merge(prompt: prompt)
+        opts = opts.clone.merge(prompt:)
         cmd(command, **opts)
       end
 
@@ -265,7 +263,7 @@ module Net
       # Hint: 'read' first on purpose as a feature. once you cmd you ignore what happend before. otherwise use read|write directly.
       #       this should avoid many horrible state issues where the prompt is not the last prompt
       def cmd(command, pre_read: true, rm_prompt: cmd_rm_prompt, rm_command: cmd_rm_command, prompt: current_prompt, minimum_duration: cmd_minimum_duration, **opts)
-        opts = opts.clone.merge(pre_read: pre_read, rm_prompt: rm_prompt, rm_command: rm_command, prompt: prompt)
+        opts = opts.clone.merge(pre_read:, rm_prompt:, rm_command:, prompt:)
         if pre_read
           pre_read_data = read
           logger.debug { "#cmd ignoring pre-command output: #{pre_read_data.inspect}" } if pre_read_data.present?
@@ -291,7 +289,7 @@ module Net
       alias commands cmds
 
       def rm_command!(output, command, **opts)
-        output[command + cmd_rm_command_tail] = '' if rm_command?(**opts) && output[command + cmd_rm_command_tail]
+        output[command + cmd_rm_command_tail] = "" if rm_command?(**opts) && output[command + cmd_rm_command_tail]
       end
 
       # removes the prompt from the given output
@@ -299,19 +297,17 @@ module Net
       # for backwards compatibility it also tries to replace the first match of the prompt /(something)\z/
       # it removes the whole match if no matches are given /something\z/
       def rm_prompt!(output, prompt: current_prompt, **opts)
-        if rm_prompt?(**opts)
-          if output[prompt]
-            case prompt
-            when String then output[prompt] = ''
-            when Regexp
-              if prompt.names.include?("prompt")
-                output[prompt, "prompt"] = ''
-              else
-                begin
-                  output[prompt, 1] = ''
-                rescue IndexError
-                  output[prompt] = ''
-                end
+        if rm_prompt?(**opts) && (output[prompt])
+          case prompt
+          when String then output[prompt] = ""
+          when Regexp
+            if prompt.names.include?("prompt")
+              output[prompt, "prompt"] = ""
+            else
+              begin
+                output[prompt, 1] = ""
+              rescue IndexError
+                output[prompt] = ""
               end
             end
           end
@@ -359,8 +355,8 @@ module Net
       def net_ssh
         return @net_ssh if @net_ssh
 
-        logger.debug { 'Net:SSH #start' }
-        self.net_ssh = Net::SSH.start(net_ssh_options[:ip] || net_ssh_options[:host] || 'localhost', net_ssh_options[:user] || ENV['USER'], **formatted_net_ssh_options)
+        logger.debug { "Net:SSH #start" }
+        self.net_ssh = Net::SSH.start(net_ssh_options[:ip] || net_ssh_options[:host] || "localhost", net_ssh_options[:user] || ENV["USER"], **formatted_net_ssh_options)
       rescue StandardError => error
         self.net_ssh = nil
         raise
@@ -381,13 +377,13 @@ module Net
         before_open_channel_procs.each { |_name, a_proc| instance_eval(&a_proc) }
         ::Timeout.timeout(open_channel_timeout, Error::OpenChannelTimeout) do
           net_ssh.open_channel do |new_channel|
-            logger.debug 'channel is open'
+            logger.debug "channel is open"
             self.channel = new_channel
             new_channel.request_pty(terminal_options) do |_ch, success|
               raise Error::Pty, "#{host || ip} Failed to open ssh pty" unless success
             end
-            new_channel.send_channel_request('shell') do |_ch, success|
-              raise Error::RequestShell, 'Failed to open ssh shell' unless success
+            new_channel.send_channel_request("shell") do |_ch, success|
+              raise Error::RequestShell, "Failed to open ssh shell" unless success
             end
             new_channel.on_data do |_ch, data|
               on_stdout(data)
@@ -395,9 +391,9 @@ module Net
             # new_channel.on_extended_data do |_ch, type, data| end
             # new_channel.on_close do end
           end
-          until channel do process end
+          process until channel
         end
-        logger.debug 'channel is ready, running callbacks now'
+        logger.debug "channel is ready, running callbacks now"
         after_open_channel_procs.each { |_name, a_proc| instance_eval(&a_proc) }
         process
         self
@@ -415,7 +411,7 @@ module Net
       end
 
       def formatted_net_ssh_options
-        net_ssh_options.symbolize_keys.reject {|k,v| [:host, :ip, :user].include?(k)}
+        net_ssh_options.symbolize_keys.reject { |k, _v| [:host, :ip, :user].include?(k) }
       end
 
       def rm_prompt?(**opts)
@@ -445,7 +441,7 @@ module Net
           pixels_wide: terminal_pixels_width,
           pixels_high: terminal_pixels_height,
           modes: terminal_modes
-        }.reject {|k,v| v.nil?}
+        }.reject { |_k, v| v.nil? }
       end
     end
   end
@@ -457,8 +453,9 @@ end
 
 class Net::SSH::Connection::Session
   attr_accessor :cli_channels
+
   def cli(**opts)
-    cli_session = Net::SSH::CLI::Session.new({ net_ssh: self }.merge(opts))
+    cli_session = Net::SSH::CLI::Session.new(**{ net_ssh: self }.merge(opts))
     cli_session.open_channel
     cli_session
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: net-ssh-cli
 version: !ruby/object:Gem::Version
-  version: 1.9.1
+  version: 1.9.2
 platform: ruby
 authors:
 - Fabian Stillhart
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-11-21 00:00:00.000000000 Z
+date: 2022-11-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bump
@@ -140,7 +140,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.25
+rubygems_version: 3.3.26
 signing_key: 
 specification_version: 4
 summary: 'Net::SSH::CLI: A library to handle CLI Sessions'