net-ssh-cli 1.8.0 → 1.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e3557b2b202abb2f722b950d3f16d0e1c36a57716289f138d4c7f04edb453546
-  data.tar.gz: 8e58d5fa7d2e89021ffcb10751fff17526542d1d16314f79769f7e5f67451ea0
+  metadata.gz: 7056a8a1973f705133135914df49d4b16e1b9213b35b987677094b9993b3b059
+  data.tar.gz: 5520b049f17149f5a17849f396b150451a0b7f50f0ceee4e79d616f23ec876e9
 SHA512:
-  metadata.gz: 447b6ac1b58038620c3886241352e48bf5b89cbe0512a9506e08ab359378f62d3629f0007516bbcf4c360e204ea259d865d65e6396ee66d5d10c8c05275ede08
-  data.tar.gz: a898d86bf7d7fdde7977bd6161e1801606da032b96e3fb04ba6c55a6e104d1d2db0e8f68b12763afb63fee036c19e3c087af203563323543d4328a5fb61c487d
+  metadata.gz: b5d34700dc16a246ce3706828d2043993b34496d5b1a742f5dbbff366a62591ae2327bf7f9a1ec0044281962ae65f7f6297f2b49025f4acc1ba2175d2004ae12
+  data.tar.gz: 0231d51bb361bbb6181138d1f0ec3350071c804f06e0e863bbe9d97fb85e5e9a156019f0fb6e7332a3e36baeda0d67050f34bbe519b275d8b0fa4c5439331878

data/.ruby-version

@@ -1 +1 @@
-3.0
+3.1

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

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

data/lib/net/ssh/cli.rb

@@ -44,19 +44,19 @@ module Net
         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. 
+        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 
+        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 
+        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 
+        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 
+        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
@@ -64,6 +64,12 @@ module Net
         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
@@ -99,7 +105,9 @@ module Net
 
       OPTIONS.keys.select {|key| key.to_s.include? "procs"}.each do |name|
         define_method name.sub("_procs","") do |&blk|
-          self.send(name)[SecureRandom.uuid] = Proc.new {blk.call}
+          id = SecureRandom.uuid
+          self.send(name)[id] = Proc.new {blk.call}
+          id
         end
       end
 
@@ -289,7 +297,7 @@ module Net
       # removes the prompt from the given output
       # prompt should contain a named match 'prompt' /(?<prompt>.*something.*)\z/
       # 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/ 
+      # 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]
@@ -312,10 +320,10 @@ module Net
 
       # the same as #cmd but it will only run the command if the option run_impact is set to true.
       # this can be used for commands which you might not want to run in development|testing mode but in production
-      # cli.impact("reboot") 
+      # cli.impact("reboot")
       # => "skip: reboot"
       # cli.run_impact = true
-      # cli.impact("reboot") 
+      # cli.impact("reboot")
       # => "system is going to reboot NOW"
       def impact(command, **opts)
         run_impact? ? cmd(command, **opts) : "skip: #{command.inspect}"
@@ -352,7 +360,7 @@ module Net
         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)
+        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
@@ -375,7 +383,7 @@ module Net
           net_ssh.open_channel do |new_channel|
             logger.debug 'channel is open'
             self.channel = new_channel
-            new_channel.request_pty do |_ch, success|
+            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|
@@ -428,6 +436,17 @@ module Net
       ensure
         self.process_count -= 1
       end
+
+      def terminal_options
+        {
+          term: terminal_term,
+          chars_wide: terminal_chars_width,
+          chars_high: terminal_chars_height,
+          pixels_wide: terminal_pixels_width,
+          pixels_high: terminal_pixels_height,
+          modes: terminal_modes
+        }.reject {|k,v| v.nil?}
+      end
     end
   end
 end

data/net-ssh-cli.gemspec

@@ -1,19 +1,19 @@
 # frozen_string_literal: true
 
-lib = File.expand_path('lib', __dir__)
+lib = File.expand_path("lib", __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'net/ssh/cli/version'
+require "net/ssh/cli/version"
 
 Gem::Specification.new do |spec|
-  spec.name          = 'net-ssh-cli'
+  spec.name          = "net-ssh-cli"
   spec.version       = Net::SSH::CLI::VERSION
-  spec.authors       = ['Fabian Stillhart']
-  spec.email         = ['fabian.stillhart1@swisscom.com']
+  spec.authors       = ["Fabian Stillhart"]
+  spec.email         = ["fabian.stillhart1@swisscom.com"]
 
-  spec.summary       = 'Net::SSH::CLI: A library to handle CLI Sessions'
-  spec.description   = 'Net::SSH::CLI: A library to handle CLI Sessions. It allows you to write programs that invoke and interact with (long-running) CLI Sessions via NET::SSH.'
-  spec.homepage      = 'https://github.com/swisscom/net-ssh-cli'
-  spec.license       = 'MIT'
+  spec.summary       = "Net::SSH::CLI: A library to handle CLI Sessions"
+  spec.description   = "Net::SSH::CLI: A library to handle CLI Sessions. It allows you to write programs that invoke and interact with (long-running) CLI Sessions via NET::SSH."
+  spec.homepage      = "https://github.com/swisscom/net-ssh-cli"
+  spec.license       = "MIT"
 
   # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
   # to allow pushing to a single host or delete this section to allow pushing to any host.
@@ -33,14 +33,14 @@ Gem::Specification.new do |spec|
   spec.files         = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
-  spec.bindir        = 'exe'
+  spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ['lib']
+  spec.require_paths = ["lib"]
 
-  spec.add_development_dependency 'bundler'
-  spec.add_development_dependency 'bump'
-  spec.add_development_dependency 'rake', '~> 13.0'
-  spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.add_dependency 'activesupport', '>= 4.0'
-  spec.add_dependency 'net-ssh', '>= 4.0'
+  spec.add_development_dependency "bump"
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_dependency "activesupport", ">= 4.0"
+  spec.add_dependency "net-ssh", ">= 7.0"
 end

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: net-ssh-cli
 version: !ruby/object:Gem::Version
-  version: 1.8.0
+  version: 1.9.1
 platform: ruby
 authors:
 - Fabian Stillhart
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-04-19 00:00:00.000000000 Z
+date: 2022-11-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: bump
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -25,7 +25,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: bump
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -86,14 +86,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '7.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '7.0'
 description: 'Net::SSH::CLI: A library to handle CLI Sessions. It allows you to write
   programs that invoke and interact with (long-running) CLI Sessions via NET::SSH.'
 email:
@@ -125,7 +125,7 @@ homepage: https://github.com/swisscom/net-ssh-cli
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -140,8 +140,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.15
-signing_key:
+rubygems_version: 3.3.25
+signing_key: 
 specification_version: 4
 summary: 'Net::SSH::CLI: A library to handle CLI Sessions'
 test_files: []