lex-ssh 0.1.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 54411d088fc2c86e4dc4307af92d0926d30209f2436d17d4dda4c5d82aaca882
-  data.tar.gz: 88b360219dafe6628a962185c4e2844b57d60b884a759534d17662f810bfbdb7
+  metadata.gz: c32f876a224526e915ee6576cc5f15ac6c9d8cf5a1baf10d98a1eafaeaf867f8
+  data.tar.gz: ec41166e39202820862faa03e98fd738de9bfb55c549620d1a5bc662d30a0099
 SHA512:
-  metadata.gz: 61a88165cef8514b90669ac51468b08577a55edce5b1430460ddf460a8594d8db6314719a537a7e382a3fed813ec713b72f02b7feac023daece499bee46fc091
-  data.tar.gz: ce2d16a46fcd44eddcc85a86ec74c4ffc6f5d517c39222ee184d19e898c8f0be03e36174c8dbb1da9113f5a598fe8ad8cb8258b0ddb27ed0c84637269925a14f
+  metadata.gz: 5644622ea45307993be446f6e4ef78b12f020154651324ed7d4f3083919b5eb4acb8ace68f046ff24c508d0e5f12d70e4f0f11047a5ae42b2b03a2955b58f2d0
+  data.tar.gz: 07a56ceb7eed940b5eb743debbadf1fa102e4b373bb1d7c25edafc841f254071d59d3230ffb4bcdf8e2db65f266a563636b051264bf429d149eb3cd0a896c2e9

data/.github/workflows/ci.yml

@@ -0,0 +1,16 @@
+name: CI
+on:
+  push:
+    branches: [main]
+  pull_request:
+
+jobs:
+  ci:
+    uses: LegionIO/.github/.github/workflows/ci.yml@main
+
+  release:
+    needs: ci
+    if: github.event_name == 'push' && github.ref == 'refs/heads/main'
+    uses: LegionIO/.github/.github/workflows/release.yml@main
+    secrets:
+      rubygems-api-key: ${{ secrets.RUBYGEMS_API_KEY }}

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,48 @@
+AllCops:
+  TargetRubyVersion: 3.4
+  NewCops: enable
+  SuggestExtensions: false
+
+Layout/LineLength:
+  Max: 160
+
+Layout/SpaceAroundEqualsInParameterDefault:
+  EnforcedStyle: space
+
+Layout/HashAlignment:
+  EnforcedHashRocketStyle: table
+  EnforcedColonStyle: table
+
+Metrics/MethodLength:
+  Max: 50
+
+Metrics/ClassLength:
+  Max: 1500
+
+Metrics/ModuleLength:
+  Max: 1500
+
+Metrics/BlockLength:
+  Max: 40
+
+Metrics/AbcSize:
+  Max: 60
+
+Metrics/CyclomaticComplexity:
+  Max: 15
+
+Metrics/PerceivedComplexity:
+  Max: 17
+
+Style/Documentation:
+  Enabled: false
+
+Style/SymbolArray:
+  Enabled: true
+
+Style/FrozenStringLiteralComment:
+  Enabled: true
+  EnforcedStyle: always
+
+Naming/FileName:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,21 @@
+# Changelog
+
+## [0.2.1] - 2026-03-18
+
+### Fixed
+- Added `logger` gem as runtime dependency for Ruby 4.0 compatibility (removed from default gems)
+
+## [0.2.0] - 2026-03-15
+
+### Added
+- Standalone `Client` class including all runner modules
+- `run_multiple` alias for `run_mulitple` (typo preserved for backward compat)
+- Runner and client specs
+
+### Fixed
+- `opts.key(:timeout)` -> `opts.key?(:timeout)` in Helpers::Connection (was calling wrong Hash method)
+
+## [0.1.1] - 2026-03-13
+
+### Added
+- Initial release

data/CLAUDE.md

@@ -0,0 +1,73 @@
+# lex-ssh: SSH Remote Command Extension for LegionIO
+
+**Repository Level 3 Documentation**
+- **Parent**: `/Users/miverso2/rubymine/legion/extensions-other/CLAUDE.md`
+- **Grandparent**: `/Users/miverso2/rubymine/legion/CLAUDE.md`
+
+## Purpose
+
+Legion Extension that executes remote SSH commands and controls remote server state. Provides runners for running arbitrary commands on remote hosts and triggering reboot/shutdown via Net::SSH.
+
+**Version**: 0.2.0
+**GitHub**: https://github.com/LegionIO/lex-ssh
+**License**: MIT
+
+## Architecture
+
+```
+Legion::Extensions::Ssh
+├── Runners/
+│   ├── Command            # run, run_multiple - execute commands via SSH exec!
+│   └── State              # reboot, shutdown - system state via SSH
+├── Helpers/
+│   └── Connection         # Net::SSH session factory (password, key_data, keys, passphrase auth)
+└── Client                 # Standalone client class (includes all runners)
+```
+
+## Key Files
+
+| Path | Purpose |
+|------|---------|
+| `lib/legion/extensions/ssh.rb` | Entry point, extension registration |
+| `lib/legion/extensions/ssh/runners/command.rb` | `run`, `run_multiple` (and `alias run_multiple run_mulitple` for typo compat) |
+| `lib/legion/extensions/ssh/runners/state.rb` | `reboot(server:, user:, delay:)`, `shutdown(server:, user:, delay:)` |
+| `lib/legion/extensions/ssh/helpers/connection.rb` | `session(server:, user:, **opts)` — Net::SSH.start wrapper |
+| `lib/legion/extensions/ssh/client.rb` | Standalone `Client` class for use outside Legion framework |
+
+## Runner Methods
+
+**Command**
+- `run(command:, server:, user: 'root')` — execute a single command, returns exit status + output
+- `run_multiple(commands:, server:, user: 'root')` — execute multiple commands sequentially; also aliased as `run_mulitple` for backward compatibility
+
+**State**
+- `reboot(server:, user: 'root', delay: 0)` — reboot via `shutdown -r`; `delay` adds minutes
+- `shutdown(server:, user: 'root', delay: 0)` — halt via `shutdown -h`; `delay` adds minutes
+
+**Connection auth** (pass as task kwargs): `password:`, `key_data:`, `keys:`, `passphrase:`, `non_interactive:`, `timeout:` (default: 5s)
+
+## Bug Fixes (v0.2.0)
+
+- Fixed `opts.key(:timeout)` typo in `Helpers::Connection` — corrected to `opts.key?(:timeout)`. The old code always returned the key object (truthy) instead of checking presence, so `timeout` was never read from opts.
+
+## Dependencies
+
+| Gem | Purpose |
+|-----|---------|
+| `net-ssh` (>= 7.0) | SSH client |
+| `ed25519` | Ed25519 key support |
+| `bcrypt_pbkdf` | Bcrypt key derivation (OpenSSH private key format) |
+
+## Development
+
+9 specs total across `spec/legion/extensions/ssh/client_spec.rb`, `runners/command_spec.rb`, and `runners/state_spec.rb`.
+
+```bash
+bundle install
+bundle exec rspec
+bundle exec rubocop
+```
+
+---
+
+**Maintained By**: Matthew Iverson (@Esity)

data/Gemfile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec
+gem 'bundler', '>= 2'
+gem 'rake'
+gem 'rspec'
+gem 'rubocop'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Esity
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,77 @@
+# lex-ssh
+
+SSH remote command execution for [LegionIO](https://github.com/LegionIO/LegionIO). Run commands on remote servers and trigger reboot or shutdown via Net::SSH from within task chains.
+
+## Installation
+
+```bash
+gem install lex-ssh
+```
+
+Or add to your Gemfile:
+
+```ruby
+gem 'lex-ssh'
+```
+
+## Runners
+
+### Command
+
+| Method | Parameters | Description |
+|--------|-----------|-------------|
+| `run` | `command:`, `server:`, `user:` (default: `'root'`) | Execute a single command via SSH |
+| `run_multiple` | `commands:`, `server:`, `user:` (default: `'root'`) | Execute multiple commands sequentially |
+
+Returns `{ success:, results:, server: }` per command.
+
+### State
+
+| Method | Parameters | Description |
+|--------|-----------|-------------|
+| `reboot` | `server:`, `user:` (default: `'root'`), `delay:` (default: `0`) | Reboot the server via `shutdown -r` |
+| `shutdown` | `server:`, `user:` (default: `'root'`), `delay:` (default: `0`) | Halt the server via `shutdown -h` |
+
+`delay` is the number of minutes to wait (0 = immediate).
+
+### Authentication
+
+Pass authentication kwargs alongside other parameters:
+
+| Parameter | Description |
+|-----------|-------------|
+| `password` | Password authentication |
+| `key_data` | Inline key data |
+| `keys` | Array of key file paths |
+| `passphrase` | Key passphrase |
+| `timeout` | Connection timeout in seconds (default: 5) |
+
+## Standalone Client
+
+Use `Legion::Extensions::Ssh::Client` outside the full LegionIO framework.
+
+```ruby
+require 'legion/extensions/ssh'
+client = Legion::Extensions::Ssh::Client.new(host: 'server.example.com', user: 'deploy', keys: ['~/.ssh/id_ed25519'])
+result = client.run(command: 'uptime')
+```
+
+## Requirements
+
+- Ruby >= 3.4
+- [LegionIO](https://github.com/LegionIO/LegionIO) framework
+- SSH server access
+- `net-ssh` >= 7.0
+- `ed25519` — Ed25519 key support
+- `bcrypt_pbkdf` — OpenSSH private key format support
+
+## Changelog
+
+### v0.2.0
+
+- Added standalone `Client` class.
+- Fixed `opts.key?(:timeout)` in `Helpers::Connection` — the previous `opts.key(:timeout)` always returned a truthy key object, so the `timeout` option was never read from task kwargs.
+
+## License
+
+MIT

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lex-ssh.gemspec

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require_relative 'lib/legion/extensions/ssh/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'lex-ssh'
+  spec.version       = Legion::Extensions::Ssh::VERSION
+  spec.authors       = ['Esity']
+  spec.email         = ['matthewdiverson@gmail.com']
+
+  spec.summary       = 'LEX::SSH'
+  spec.description   = 'LEX::SSH'
+  spec.homepage      = 'https://github.com/LegionIO/lex-ssh'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = '>= 3.4'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/LegionIO/lex-ssh'
+  spec.metadata['documentation_uri'] = 'https://github.com/LegionIO/lex-ssh'
+  spec.metadata['changelog_uri'] = 'https://github.com/LegionIO/lex-ssh'
+  spec.metadata['bug_tracker_uri'] = 'https://github.com/LegionIO/lex-ssh/issues'
+  spec.metadata['rubygems_mfa_required'] = 'true'
+  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.require_paths = ['lib']
+
+  spec.add_dependency 'bcrypt_pbkdf'
+  spec.add_dependency 'ed25519'
+  spec.add_dependency 'logger'
+  spec.add_dependency 'net-ssh', '>= 7.0'
+end

data/lib/legion/extensions/ssh/client.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require_relative 'helpers/connection'
+require_relative 'runners/command'
+require_relative 'runners/state'
+
+module Legion
+  module Extensions
+    module Ssh
+      class Client
+        include Helpers::Connection
+        include Runners::Command
+        include Runners::State
+
+        attr_reader :opts
+
+        def initialize(server:, user: 'root', **extra)
+          @opts = { server: server, user: user, **extra }
+        end
+
+        def session(**override)
+          super(**@opts, **override)
+        end
+      end
+    end
+  end
+end

data/lib/legion/extensions/ssh/helpers/connection.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require 'net/ssh'
+
+module Legion
+  module Extensions
+    module Ssh
+      module Helpers
+        module Connection
+          def session(server:, user: 'root', **opts)
+            hash = {}
+            if opts.key? :password
+              hash[:password] = opts[:password]
+            elsif opts.key? :key_data
+              hash[:key_data] = opts[:key_data]
+            elsif opts.key? :keys
+              hash[:keys] = opts[:keys]
+            end
+            hash[:non_interactive] = opts.key?(:non_interactive) ? opts[:non_interactive] : true
+            hash[:passphrase] = opts[:passphrase] if opts.key? :passphrase
+            hash[:timeout] = opts.key?(:timeout) ? opts[:timeout] : 5
+
+            Net::SSH.start(server, user, **hash)
+          end
+
+          def detect_os(session)
+            session.exec!('lsb_release -a')
+          end
+        end
+      end
+    end
+  end
+end

data/lib/legion/extensions/ssh/runners/command.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Legion
+  module Extensions
+    module Ssh
+      module Runners
+        module Command
+          include Legion::Extensions::Ssh::Helpers::Connection
+
+          def run(command:, server:, user: 'root', **)
+            session = session(server: server, user: user, **)
+            results = session.exec!(command)
+            { success: results.exitstatus.zero?, results: results, server: server }
+          end
+
+          def run_mulitple(commands:, server:, user: 'root', **)
+            session = session(server: server, user: user, **)
+            final_results = []
+
+            commands.each do |command|
+              results = session.exec!(command)
+              final_results.push({ success: results.exitstatus.zero?, results: results })
+            end
+            final_results
+          end
+
+          alias run_multiple run_mulitple
+
+          include Legion::Extensions::Helpers::Lex if Legion::Extensions.const_defined?(:Helpers) &&
+                                                      Legion::Extensions::Helpers.const_defined?(:Lex)
+        end
+      end
+    end
+  end
+end

data/lib/legion/extensions/ssh/runners/state.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Legion
+  module Extensions
+    module Ssh
+      module Runners
+        module State
+          include Legion::Extensions::Ssh::Helpers::Connection
+
+          def reboot(server:, user: 'root', delay: 0, **)
+            session = session(server: server, user: user, **)
+            command = delay.zero? ? 'shutdown -r now' : "shutdown -r +#{delay}"
+            results = session.exec!(command)
+            { success: results.exitstatus.zero?, results: results, server: server, delay: delay }
+          end
+
+          def shutdown(server:, user: 'root', delay: 0, **)
+            session = session(server: server, user: user, **)
+            command = delay.zero? ? 'shutdown -h now' : "shutdown -h +#{delay}"
+            results = session.exec!(command)
+            { success: results.exitstatus.zero?, results: results, server: server, delay: delay }
+          end
+
+          include Legion::Extensions::Helpers::Lex if Legion::Extensions.const_defined?(:Helpers) &&
+                                                      Legion::Extensions::Helpers.const_defined?(:Lex)
+        end
+      end
+    end
+  end
+end

data/lib/legion/extensions/ssh/version.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Legion
+  module Extensions
+    module Ssh
+      VERSION = '0.2.1'
+    end
+  end
+end

data/lib/legion/extensions/ssh.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'legion/extensions/ssh/version'
+require 'legion/extensions/ssh/helpers/connection'
+require 'legion/extensions/ssh/runners/command'
+require 'legion/extensions/ssh/runners/state'
+require 'legion/extensions/ssh/client'
+
+module Legion
+  module Extensions
+    module Ssh
+      extend Legion::Extensions::Core if Legion::Extensions.const_defined? :Core
+    end
+  end
+end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: lex-ssh
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Esity
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-10-30 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bcrypt_pbkdf
@@ -39,7 +38,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: net-ssh
+  name: logger
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -52,23 +51,54 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: net-ssh
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
 description: LEX::SSH
 email:
 - matthewdiverson@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
-files: []
-homepage: https://bitbucket.org/legion-io/lex-ssh
+files:
+- ".github/workflows/ci.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CLAUDE.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lex-ssh.gemspec
+- lib/legion/extensions/ssh.rb
+- lib/legion/extensions/ssh/client.rb
+- lib/legion/extensions/ssh/helpers/connection.rb
+- lib/legion/extensions/ssh/runners/command.rb
+- lib/legion/extensions/ssh/runners/state.rb
+- lib/legion/extensions/ssh/version.rb
+homepage: https://github.com/LegionIO/lex-ssh
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://bitbucket.org/legion-io/lex-ssh
-  source_code_uri: https://bitbucket.org/legion-io/lex-ssh
-  documentation_uri: https://legionio.atlassian.net/wiki/spaces/LEX/pages/614891551
-  changelog_uri: https://legionio.atlassian.net/wiki/spaces/LEX/pages/612270160
-  bug_tracker_uri: https://bitbucket.org/legion-io/lex-ssh/issues
-post_install_message: 
+  homepage_uri: https://github.com/LegionIO/lex-ssh
+  source_code_uri: https://github.com/LegionIO/lex-ssh
+  documentation_uri: https://github.com/LegionIO/lex-ssh
+  changelog_uri: https://github.com/LegionIO/lex-ssh
+  bug_tracker_uri: https://github.com/LegionIO/lex-ssh/issues
+  rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib
@@ -76,15 +106,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.0
+      version: '3.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
-signing_key: 
+rubygems_version: 3.6.9
 specification_version: 4
 summary: LEX::SSH
 test_files: []