spectre-ssh 1.2.3 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5d1b5e8c323569e4383e2c32e14e33801ee7b979ac6d87f86fc325f3a02d86ab
-  data.tar.gz: a60048aaab1ccd148de96941289b3e9e3bc7915dfa667661afda80b212be205c
+  metadata.gz: f13557c403d5bcd207fba8935bce62e99aed681a9383253563d8a211d0c8dc0d
+  data.tar.gz: f5493676adda1f6e8d3c765d38e410ba2b04a23549a871826afdeb356ec9594e
 SHA512:
-  metadata.gz: b85b9b58bc864555c915ca02b7198c6e1def300fe65d6726aac3b15eb7649e84f251ae61587dcd14f4b3b8c4cd2dcbea7122d50e1e434f46f4699ea43988b3b3
-  data.tar.gz: 77690b17c3374b8273259321013e8238da78fa8676ecf04ccca19376c61f56d14c2bdc47da11b3478951577d69f4ea282785453854aa4e19c325c9bc7769e586
+  metadata.gz: 625cdd34e6be526409fe86b25ea7859581d8625bc3497a88a6cfc25843b65da06e43a0b9b2d2b15b75105f9fa93622a88b5abfc082d971da75448c0ae5b1fd86
+  data.tar.gz: 4726e468350db0b4bcb7f506e749a0e12f6f3f02310fbad19f0c71eac7d484771875de7df5fa8c46d1a6884339b61e091b6d8addbd70a1b1c517b50b6257a6de

data/lib/spectre/ssh.rb

@@ -1,50 +1,52 @@
 require 'net/ssh'
-require 'logger'
-require 'spectre'
-require 'spectre/logging'
 require 'net/ssh/proxy/http'
+require 'logger'
 
 module Spectre
   module SSH
     @@cfg = {}
 
-    class SSHError < Exception
+    class SshError < StandardError
     end
 
-    class SSHConnection < Spectre::DslClass
+    class SshConnection
+      include Spectre::Delegate if defined? Spectre::Delegate
+
+      attr_reader :exit_code, :output
+
       def initialize host, username, opts, logger
         opts[:non_interactive] = true
 
-        @__logger = logger
-        @__host = host
-        @__username = username
-        @__opts = opts
-        @__session = nil
-        @__exit_code = nil
-        @__output = ''
+        @logger = logger
+        @host = host
+        @username = username
+        @opts = opts
+        @session = nil
+        @exit_code = nil
+        @output = ''
       end
 
       def username user
-        @__username = user
+        @username = user
       end
 
       def password pass
-        @__opts[:password] = pass
-        @__opts[:auth_methods].push 'password' unless @__opts[:auth_methods].include? 'password'
+        @opts[:password] = pass
+        @opts[:auth_methods].push('password') unless @opts[:auth_methods].include? 'password'
       end
 
       def private_key file_path
-        @__opts[:keys] = [file_path]
-        @__opts[:auth_methods].push 'publickey' unless @__opts[:auth_methods].include? 'publickey'
+        @opts[:keys] = [file_path]
+        @opts[:auth_methods].push('publickey') unless @opts[:auth_methods].include? 'publickey'
       end
 
       def passphrase phrase
-        @__opts[:passphrase] = phrase
+        @opts[:passphrase] = phrase
       end
 
       def file_exists path
         exec "ls #{path}"
-        exit_code == 0
+        @exit_code.nil? || @exit_code.zero?
       end
 
       def owner_of path
@@ -53,90 +55,87 @@ module Spectre
       end
 
       def connect!
-        return unless @__session == nil or @__session.closed?
+        return unless @session.nil? or @session.closed?
 
         begin
-          @__session = Net::SSH.start(@__host, @__username, @__opts)
+          @session = Net::SSH.start(@host, @username, @opts)
         rescue SocketError
-          raise SSHError.new("Unable to connect to #{@__host} with user #{@__username}")
+          raise SshError, "Unable to connect to #{@host} with user #{@username}"
         rescue Net::SSH::AuthenticationFailed
-          raise SSHError.new("Authentication failed for #{@__username}@#{@__host}. Please check password, SSH keys and passphrases.")
+          raise SshError, "Authentication failed for #{@username}@#{@host}. \
+            Please check password, SSH keys and passphrases."
         end
       end
 
       def close
-        return unless @__session and not @__session.closed?
+        return unless @session and !@session.closed?
 
-        @__session.close
+        @session.close
       end
 
       def can_connect?
-        @__output = nil
+        @output = nil
 
         begin
           connect!
-          @__session.open_channel.close
-          @__output = "successfully connected to #{@__host} with user #{@__username}"
-          @__exit_code = 0
+          @session.open_channel.close
+          @output = "successfully connected to #{@host} with user #{@username}"
+          @exit_code = 0
           return true
-        rescue Exception => e
-          @__logger.error e.message
-          @__output = "unable to connect to #{@__host} with user #{@__username}"
-          @__exit_code = 1
+        rescue StandardError => e
+          @logger.error e.message
+          @output = "unable to connect to #{@host} with user #{@username}"
+          @exit_code = 1
         end
 
-        return false
+        false
       end
 
       def exec command
         connect!
 
-        log_str = "#{@__session.options[:user]}@#{@__session.host} -p #{@__session.options[:port]} #{command}"
+        log_str = "ssh #{@username}@#{@session.host} -p #{@session.options[:port]} #{command}"
 
-        @channel = @__session.open_channel do |channel|
+        @session.open_channel do |channel|
           channel.exec(command) do |_ch, success|
-            abort "could not execute #{command} on #{@__session.host}" unless success
+            abort "could not execute #{command} on #{@session.host}" unless success
 
-            @__output = ''
+            @output = ''
 
-            channel.on_data do |_, data|
-              @__output += data
+            channel.on_data do |_ch, data|
+              @output += data
             end
 
-            channel.on_extended_data do |_, _type, data|
-              @__output += data
+            channel.on_extended_data do |_ch, _type, data|
+              @output += data
             end
 
-            channel.on_request('exit-status') do |_, data|
-              @__exit_code = data.read_long
+            channel.on_request('exit-status') do |_ch, data|
+              @exit_code = data.read_long
             end
 
-            # channel.on_request('exit-signal') do |ch, data|
-            #   exit_code = data.read_long
-            # end
+            channel.on_request('exit-signal') do |_ch, data|
+              @exit_code = data.read_long
+            end
           end
-        end
-
-        @channel.wait
-        @__session.loop
+        end.wait
 
-        log_str += "\n" + @__output
-        @__logger.info log_str
-      end
-
-      def output
-        @__output
-      end
+        @session.loop
 
-      def exit_code
-        @__exit_code
+        log_str += "\n" + @output
+        @logger.info(log_str)
       end
     end
 
+    class Client
+      def initialize config, logger
+        @config = config['ssh']
+        @logger = logger
+        @debug = config['debug']
+      end
 
-    class << self
-      def ssh name, options = {}, &block
-        cfg = @@cfg[name] || {}
+      def ssh(name, options = {}, &)
+        cfg = @config[name] || {}
 
         host = cfg['host'] || name
         username = options[:username] || cfg['username']
@@ -151,41 +150,28 @@ module Spectre
         opts[:passphrase] = options[:passphrase] || cfg['passphrase']
 
         opts[:auth_methods] = []
-        opts[:auth_methods].push 'publickey' unless opts[:keys].nil? or opts[:keys].empty?
-        opts[:auth_methods].push 'password' unless opts[:password].nil?
+        opts[:auth_methods].push('publickey') unless opts[:keys].nil? or opts[:keys].empty?
+        opts[:auth_methods].push('password') unless opts[:password].nil?
 
         proxy_host = options[:proxy_host] || cfg['proxy_host']
         proxy_port = options[:proxy_port] || cfg['proxy_port']
         opts[:proxy] = Net::SSH::Proxy::HTTP.new(proxy_host, proxy_port) unless proxy_host.nil?
 
-        if @@debug
-          opts[:logger] = @@logger.logger
+        if @debug
           opts[:verbose] = Logger::DEBUG
+          opts[:logger] = @logger
         end
 
-        ssh_con = SSHConnection.new(host, username, opts, @@logger)
+        ssh_con = SshConnection.new(host, username, opts, @logger)
 
         begin
-          ssh_con.instance_eval &block
+          ssh_con.instance_eval(&)
         ensure
           ssh_con.close
         end
       end
     end
-
-    Spectre.register do |config|
-      @@logger = Spectre::Logging::ModuleLogger.new(config, 'spectre/ssh')
-      @@debug = config['debug']
-
-      if config.key? 'ssh'
-        @@debug = config['ssh'].delete('debug') if config['ssh'].key? 'debug'
-
-        config['ssh'].each do |name, cfg|
-          @@cfg[name] = cfg
-        end
-      end
-    end
-
-    Spectre.delegate :ssh, to: self
   end
+
+  Engine.register(SSH::Client, :ssh) if defined? Engine
 end

metadata

@@ -1,17 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: spectre-ssh
 version: !ruby/object:Gem::Version
-  version: 1.2.3
+  version: 2.0.0
 platform: ruby
 authors:
 - Christian Neubauer
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-01-16 00:00:00.000000000 Z
+date: 2025-03-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: openssl
+  name: bcrypt_pbkdf
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -25,7 +24,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: net-ssh
+  name: ed25519
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -39,21 +38,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: spectre-core
+  name: net-ssh
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.14.6
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.14.6
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: ed25519
+  name: openssl
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -67,7 +66,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: bcrypt_pbkdf
+  name: stringio
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -80,7 +79,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Adds SSH access functionality to the spectre framework
+description: A SSH wrapper for nice readability. Is compatible with spectre-core.
 email:
 - christian.neubauer@ionos.com
 executables: []
@@ -90,12 +89,11 @@ files:
 - lib/spectre/ssh.rb
 homepage: https://github.com/ionos-spectre/spectre-ssh
 licenses:
-- MIT
+- GPL-3.0-or-later
 metadata:
   homepage_uri: https://github.com/ionos-spectre/spectre-ssh
   source_code_uri: https://github.com/ionos-spectre/spectre-ssh
   changelog_uri: https://github.com/ionos-spectre/spectre-ssh/blob/master/CHANGELOG.md
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -103,15 +101,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.0.0
+      version: '3.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.19
-signing_key:
+rubygems_version: 3.6.6
 specification_version: 4
-summary: SSH module for spectre
+summary: Standalone SSH wrapper compatible with spectre
 test_files: []