remotus 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a719c4faff9f018cf95614e68886b53475218bb27a73cde4579bbf7eb90d638b
-  data.tar.gz: f66e7025b43d7d343f269c076824eda4061b7565b418ee3637a57e17c404d9d6
+  metadata.gz: 11e887a11735554ddeb7ebc280bb8c76881d3c00fa174964ecf2c3360c70028d
+  data.tar.gz: 92c02029466a391a243b78de329413bdbccf1f591a89bc0bcbb060a7ad51d5ca
 SHA512:
-  metadata.gz: a078c9a5e63f20059d6148e48356efead6f2520f47d0225c94a33cf3721b5294f9f6e893e166e53fb4a4609f3e5c62dee9872ea023d460d0731581d812eeb9bf
-  data.tar.gz: b7595d1ab8c6c7df4506e590a19a6ab0653d27edcfec4a1eef1764c21e3d9eb2d2edaffae6beff4bbf09465b2d84d029bf15c89a7a5cb944104e712543ea5347
+  metadata.gz: 0c1967843958647f1c782bbda27d5b03519febf34faa841a7fe92f190a0ed29d733b50d4fe0b304fea624c8a1de7f3140f34fd5bb9068cc8d9c2fa8401bda0b6
+  data.tar.gz: cfd15ef457c8aaa9188588fcbd53d55fd62378f4e224d33df57b4a818ad69b839789be32e3ee893588f278e2be6885d23572d32065df707b4f5a6735ad120c04

data/.rubocop.yml

@@ -39,3 +39,6 @@ Metrics/CyclomaticComplexity:
 Metrics/PerceivedComplexity:
   Exclude:
     - lib/remotus/ssh_connection.rb
+
+Metrics/ParameterLists:
+  Max: 6

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    remotus (0.1.0)
+    remotus (0.2.0)
       connection_pool (~> 2.2)
       net-scp (~> 3.0)
       net-ssh (~> 6.1)
@@ -88,6 +88,7 @@ GEM
     yard (0.9.26)
 
 PLATFORMS
+  ruby
   x86_64-linux
 
 DEPENDENCIES
@@ -100,4 +101,4 @@ DEPENDENCIES
   yard (~> 0.9)
 
 BUNDLED WITH
-   2.2.9
+   2.2.14

data/README.md

@@ -27,6 +27,9 @@ connection = Remotus.connect("remotehost.local")
 # Initialize a new connection pool to remotehost.local with a defined protocol and port
 connection = Remotus.connect("remotehost.local", proto: :ssh, port: 2222)
 
+# Initialize a new connection pool to remotehost.local with a defined protocol and port and arbitrary metadata
+connection = Remotus.connect("remotehost.local", proto: :ssh, port: 2222, company: "Test Corp", location: "Oslo")
+
 # Create a credential for the new connection pool
 connection.credential = Remotus::Auth::Credential.new("username", "password")
 

data/lib/remotus.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require "remotus/core_ext/string"
 require "remotus/version"
 require "remotus/logger"
 require "remotus/pool"
@@ -139,4 +140,7 @@ module Remotus
 
   # Failed to find credential password when executing sudo command
   class MissingSudoPassword < Error; end
+
+  # Raised when an invalid metadata key is provided to a Remotus HostPool
+  class InvalidMetadataKey < Error; end
 end

data/lib/remotus/core_ext/string.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Remotus
+  # Core Ruby extensions
+  module CoreExt
+    # String extension module
+    module String
+      unless method_defined?(:to_method_name)
+        #
+        # Converts a string into a safe method name that can be used for instance variables
+        #
+        # @return [Symbol] Method name
+        #
+        def to_method_name
+          gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
+            .gsub(/([a-z])([A-Z])/, '\1_\2')
+            .tr(" ", "_")
+            .gsub(/(?:[^_a-zA-Z0-9]|^\d+)/, "")
+            .downcase
+            .to_sym
+        end
+      end
+    end
+  end
+end
+
+String.include(Remotus::CoreExt::String)

data/lib/remotus/host_pool.rb

@@ -4,6 +4,7 @@ require "remotus"
 require "remotus/auth"
 require "remotus/ssh_connection"
 require "remotus/winrm_connection"
+require "remotus/core_ext/string"
 require "connection_pool"
 
 module Remotus
@@ -38,10 +39,16 @@ module Remotus
     # @param [Integer] timeout amount of time to wait for a connection from the pool (optional)
     # @param [Integer] port port to use for the connection
     # @param [Symbol] proto protocol to use for the connection (:winrm, :ssh), must be specified if port is specified
+    # @param [Hash] metadata metadata for this connection. Useful for providing additional information to various authentication stores
+    #                        should be specified using snake_case symbol keys. If keys are not snake_case, they will be converted.
     #
-    def initialize(host, size: DEFAULT_POOL_SIZE, timeout: DEFAULT_EXPIRATION_SECONDS, port: nil, proto: nil)
+    def initialize(host, size: DEFAULT_POOL_SIZE, timeout: DEFAULT_EXPIRATION_SECONDS, port: nil, proto: nil, **metadata)
       Remotus.logger.debug { "Creating host pool for #{host}" }
 
+      # Update metadata information and generate the necessary accessor methods
+      @metadata = metadata
+      update_metadata_methods
+
       @host = host
       @proto = proto || Remotus.host_type(host)
 
@@ -177,5 +184,49 @@ module Remotus
       credential = Remotus::Auth::Credential.from_hash(credential) unless credential.is_a?(Remotus::Auth::Credential)
       Remotus::Auth.cache[host] = credential
     end
+
+    #
+    # Gets HostPool metadata at key
+    #
+    # @param [Object] key metadata key
+    #
+    # @return [Object] metadata value
+    #
+    def [](key)
+      @metadata[key]
+    end
+
+    #
+    # Sets HostPool metadata value at key
+    #
+    # @param [Object] key metadata key
+    # @param [Object] value new metadata value
+    #
+    def []=(key, value)
+      @metadata[key] = value
+      update_metadata_methods
+    end
+
+    private
+
+    #
+    # Updates accessor methods for any defined metadata in @metadata
+    #
+    def update_metadata_methods
+      @metadata.each do |k, _v|
+        safe_key = k.to_s.to_method_name
+
+        # Do not allow metadata to be set that conflicts with base HostPool instance methods
+        if RESERVED_METHOD_NAMES.include?(safe_key)
+          raise Remotus::InvalidMetadataKey, "Cannot use reserved method name #{safe_key} for a metadata key"
+        end
+
+        define_singleton_method(safe_key) { @metadata[k] } unless respond_to?(safe_key)
+        define_singleton_method("#{safe_key}=".to_sym) { |new_value| @metadata[k] = new_value } unless respond_to?("#{safe_key}=".to_sym)
+      end
+    end
+
+    # Array of all reserved method names, must set after all methods are defined
+    RESERVED_METHOD_NAMES = Remotus::HostPool.instance_methods.freeze
   end
 end

data/lib/remotus/pool.rb

@@ -145,6 +145,9 @@ module Remotus
 
         options.each do |k, v|
           Remotus.logger.debug { "Checking if option #{k} => #{v} has changed" }
+
+          next unless pool[host].respond_to?(k.to_sym)
+
           host_value = pool[host].send(k.to_sym)
 
           if v != host_value

data/lib/remotus/version.rb

@@ -2,5 +2,5 @@
 
 module Remotus
   # Remotus gem version
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: remotus
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Matthew Newell
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-03-10 00:00:00.000000000 Z
+date: 2021-03-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: connection_pool
@@ -188,6 +188,7 @@ files:
 - lib/remotus/auth/credential.rb
 - lib/remotus/auth/hash_store.rb
 - lib/remotus/auth/store.rb
+- lib/remotus/core_ext/string.rb
 - lib/remotus/host_pool.rb
 - lib/remotus/logger.rb
 - lib/remotus/pool.rb