herd-rb 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 84702715cdf7b1c28fe203c5c88a0b0f7a3c0a77bf5bfb237c027a82585be7c0
-  data.tar.gz: d61aa1dcbe955f6ab0bd56c535612cf490891ed2589425af1ac23baf6e085636
+  metadata.gz: f0b080c1095b56bac42536acc7df54cd20c97bac52f2367301e2b951eb8a60be
+  data.tar.gz: 397b3c9636a2dc20310f8e70fbe3911049bde76183fe8650f30d0cff4bb40402
 SHA512:
-  metadata.gz: c2f6c111802762b7c5e642a1a8f073d9bad60c138f5d607870a4989154777aa2691997ca514ef440237d73b4112107a72dffe17b1c3221aab0d7663440be70bf
-  data.tar.gz: b65a40974cee1729989bfc9c65a95b937e101c71072daa2da4cf70475cd04ce8de65ab4483e1dfbf4301bcc27a4bcbe149a9c07119619190bde82f052c1eee1e
+  metadata.gz: 514947c517caa05fc2229c6d293042bf6065ad2d067574087d479772fac271802279f769a6f98d33ae0c7a09720bd99e6592b475e2e6cc3934c515d970323bc1
+  data.tar.gz: 7962d18779bc695f3858adcbf40dc75350e9d88ec00a29b0ab71b8e9ab8ffd21b18f28e8078c2e012b33612c400941d7394ce5254fa52520be8988bc59d11784

data/.ruby-version

@@ -0,0 +1 @@
+3.4.2

data/README.md

@@ -4,9 +4,9 @@ Fast host configuration tool.
 
 ## TODO
 
-* [ ] Commands with arguments
+* [x] Run with `sudo`
+* [x] Commands with arguments
 * [ ] Reading and writing files
-* [ ] Run with `sudo`
 
 ## Installation
 
@@ -55,6 +55,25 @@ runner.exec("hostname") # ["alpha001\n", "omega001\n"]
 runner.exec { hostname + uptime } # ["alpha001\n2000 years\n", "omega001\2500 years\n"]
 ```
 
+### Something more complex
+
+```ruby
+public_key_path = File.expand_path("~/.ssh/id_ed25519.pub")
+my_key = File.read(public_key_path).chomp
+
+result = runner.exec do
+  h = hostname
+  keys = authorized_keys
+
+  if keys.include?(my_key)
+    puts "Key already in authorized_keys on host #{h}"
+  else
+    add_authorized_key my_key
+    puts "Added new key for host #{h}"
+  end
+end
+```
+
 ## 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/TODO.md

@@ -0,0 +1,20 @@
+# TODO
+
+- [x] Load session commands automatically from `lib/herd/session/commands`.
+- [x] Extract existing `Session` command helpers (e.g., `add_authorized_key`) into the commands directory.
+- [x] Ensure new command loading approach is covered by specs.
+- [ ] Add explicit `logger` dependency to address net-ssh warning on Ruby 3.4.2.
+- [ ] Document new command-extension flow with YARD annotations.
+
+# Log
+
+- Initialized planning file and seeded initial task list.
+- Updated project configuration to target Ruby 3.4.2 (Gemfile, gemspec, .ruby-version, lockfile).
+- Synced RuboCop config with Ruby 3.4.2 and confirmed clean lint run.
+- Moved development dependencies from gemspec to Gemfile; bundle, lint, and tests still pass (with net-ssh logger warning).
+- Fixed `Session#method_missing` to avoid extra spaces when building commands; specs now green.
+- Implemented automatic session command loading via prepended modules, moved authorized key helpers, added YARD dependency, and expanded specs accordingly.
+
+# Notes
+
+- Keep command implementations in English and back them with tests.

data/lib/herd/host.rb

@@ -5,7 +5,7 @@ require "net/ssh"
 module Herd
   # Target host
   class Host
-    attr_reader :host, :user, :ssh_options
+    attr_reader :host, :user, :ssh_options, :password
 
     def initialize(host, user, port: 22, private_key_path: nil, password: nil)
       @host = host
@@ -17,15 +17,18 @@ module Herd
       else
         @ssh_options[:password] = password
       end
+
+      @password = password
     end
 
-    def exec(command = nil, &block)
+    def exec(command = nil, &)
       Net::SSH.start(host, user, ssh_options) do |ssh|
-        session = Herd::Session.new(ssh)
+        session = Herd::Session.new(ssh, password)
 
         output = nil
         output = session.send(command) if command
-        output = session.instance_exec(&block) if block_given?
+        output = session.instance_exec(&) if block_given?
+
         output
       end
     end

data/lib/herd/runner.rb

@@ -9,9 +9,9 @@ module Herd
       @hosts = hosts
     end
 
-    def exec(command = nil, &block)
+    def exec(command = nil, &)
       threads = hosts.map do |host|
-        Thread.new { host.exec(command, &block) }
+        Thread.new { host.exec(command, &) }
       end
 
       threads.each(&:join)

data/lib/herd/session/commands/authorized_keys.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Herd
+  module SessionCommands
+    # Commands for inspecting and managing authorized SSH keys.
+    module AuthorizedKeys
+      def authorized_keys
+        cat("~/.ssh/authorized_keys")&.chomp&.split("\n") || []
+      end
+
+      def add_authorized_key(key)
+        touch("~/.ssh/authorized_keys")
+        chmod("600 ~/.ssh/authorized_keys")
+        echo("'#{key}' >> ~/.ssh/authorized_keys")
+      end
+    end
+  end
+end

data/lib/herd/session/commands/packages.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Herd
+  module SessionCommands
+    # Working with package managers, like apt for Ubuntu
+    module Packages
+      def install_packages(packages)
+        packages = [packages].flatten.join(" ")
+        echo %(-e '#{password}\n' | sudo -S apt install -qq -y #{packages})
+      end
+    end
+  end
+end

data/lib/herd/session.rb

@@ -3,37 +3,82 @@
 module Herd
   # Session for executing commands on the remote host
   class Session
-    COMMANDS = %i[cat chmod echo hostname touch].freeze
+    OS_COMMANDS = %i[cat chmod echo hostname touch].freeze
+    CUSTOM_COMMANDS_DIR = File.expand_path("session/commands", __dir__)
 
-    attr_reader :ssh
+    attr_reader :ssh, :password
 
-    def initialize(ssh)
+    def initialize(ssh, password = nil)
       @ssh = ssh
+      @password = password
     end
 
-    def authorized_keys
-      cat("~/.ssh/authorized_keys")&.chomp&.split("\n") || []
+    def method_missing(cmd, *args)
+      command_parts = [cmd.to_s]
+      command_parts.concat(args.map(&:to_s)) if args.any?
+      command = command_parts.join(" ")
+
+      run(command)
     end
 
-    def add_authorized_key(key)
-      touch("~/.ssh/authorized_keys")
-      chmod("600 ~/.ssh/authorized_keys")
-      echo "'#{key}' >> ~/.ssh/authorized_keys"
+    def run(command)
+      result = []
+      ssh.open_channel do |channel|
+        channel.request_pty do |ch, success|
+          raise ::Herd::CommandError, "could not obtain pty" unless success
+
+          channel_run(ch, command, result)
+        end
+      end
+      ssh.loop
+      result.join
     end
 
-    def method_missing(cmd, *args)
-      command = cmd.to_s
-      command = "#{command} #{args.join(" ")}" if args
+    def respond_to_missing?(cmd)
+      OS_COMMANDS.include?(cmd) || super
+    end
+
+    class << self
+      def load_command_modules
+        command_files.each { |file| require file }
 
-      ssh.exec! command do |_, stream, data|
-        raise ::Herd::CommandError, data if stream == :stderr
+        session_command_modules.each do |mod|
+          next if self <= mod
 
-        return data
+          prepend mod
+        end
+      end
+
+      private
+
+      def command_files
+        Dir[File.join(CUSTOM_COMMANDS_DIR, "*.rb")]
+      end
+
+      def session_command_modules
+        return [] unless defined?(Herd::SessionCommands)
+
+        Herd::SessionCommands.constants
+                             .sort
+                             .map { |const_name| Herd::SessionCommands.const_get(const_name) }
+                             .select { |value| value.is_a?(Module) }
       end
     end
 
-    def respond_to_missing?(cmd)
-      COMMANDS.include?(cmd) || super
+    private
+
+    def channel_run(channel, command, result)
+      channel.exec(command) do |c, _|
+        c.on_data do |_, data|
+          result << data
+        end
+
+        c.on_extended_data do |_, _, data|
+          raise ::Herd::CommandError, data
+        end
+      end
     end
   end
 end
+
+Herd::Session.load_command_modules

data/lib/herd/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Herd
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,70 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: herd-rb
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Yury Kotlyarov
 bindir: exe
 cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.21'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.21'
-- !ruby/object:Gem::Dependency
-  name: rubocop-rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rubocop-rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
+dependencies: []
 description: |
   Simple ruby DSL for fast host configuration. Supports Ubuntu and requires
   SSH server running on each targets host.
@@ -74,14 +18,18 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".ruby-version"
 - CODE_OF_CONDUCT.md
 - LICENSE.txt
 - README.md
 - Rakefile
+- TODO.md
 - lib/herd.rb
 - lib/herd/host.rb
 - lib/herd/runner.rb
 - lib/herd/session.rb
+- lib/herd/session/commands/authorized_keys.rb
+- lib/herd/session/commands/packages.rb
 - lib/herd/version.rb
 - sig/herd.rbs
 homepage: https://github.com/yura/herd
@@ -91,6 +39,7 @@ metadata:
   allowed_push_host: https://rubygems.org
   homepage_uri: https://github.com/yura/herd
   source_code_uri: https://github.com/yura/herd
+  rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib
@@ -98,7 +47,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.2.0
+      version: 3.4.2
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="