remotus 0.1.0

data/lib/remotus/version.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Remotus
+  # Remotus gem version
+  VERSION = "0.1.0"
+end

data/lib/remotus/winrm_connection.rb

@@ -0,0 +1,186 @@
+# frozen_string_literal: true
+
+require "remotus"
+require "remotus/result"
+require "remotus/auth"
+require "winrm"
+require "winrm-fs"
+
+module Remotus
+  # Class representing a WinRM connection to a host
+  class WinrmConnection
+    # Standard WinRM remote port
+    REMOTE_PORT = 5985
+
+    # @return [Integer] Remote port
+    attr_reader :port
+
+    # @return [String] host hostname
+    attr_reader :host
+
+    #
+    # Creates a WinrmConnection
+    #
+    # @param [String] host hostname
+    # @param [Integer] port remote port
+    #
+    def initialize(host, port = REMOTE_PORT)
+      @host = host
+      @port = port
+    end
+
+    #
+    # Connection type
+    #
+    # @return [Symbol] returns :winrm
+    #
+    def type
+      :winrm
+    end
+
+    #
+    # Retrieves/creates the base WinRM connection for the host
+    # If the base connection already exists, the existing connection will be retrieved
+    #
+    # @return [WinRM::Connection] base WinRM remote connection
+    #
+    def base_connection(reload: false)
+      return @base_connection if !reload && !restart_base_connection?
+
+      Remotus.logger.debug { "Initializing WinRM connection to #{Remotus::Auth.credential(self).user}@#{@host}:#{@port}" }
+      @base_connection = WinRM::Connection.new(
+        endpoint: "http://#{@host}:#{@port}/wsman",
+        transport: :negotiate,
+        user: Remotus::Auth.credential(self).user,
+        password: Remotus::Auth.credential(self).password
+      )
+    end
+
+    #
+    # Retrieves/creates the WinRM shell connection for the host
+    # If the connection already exists, the existing connection will be retrieved
+    #
+    # @return [WinRM::Shells::Powershell] remote connection
+    #
+    def connection
+      return @connection unless restart_connection?
+
+      @connection = base_connection(reload: true).shell(:powershell)
+    end
+
+    #
+    # Whether the remote host's WinRM port is available
+    #
+    # @return [Boolean] true if available, false otherwise
+    #
+    def port_open?
+      Remotus.port_open?(@host, @port)
+    end
+
+    #
+    # Runs a command on the host
+    #
+    # @param [String] command command to run
+    # @param [Array] args command arguments
+    # @param [Hash] _options unused command options
+    #
+    # @return [Remotus::Result] result describing the stdout, stderr, and exit status of the command
+    #
+    def run(command, *args, **_options)
+      command = "#{command}#{args.empty? ? "" : " "}#{args.join(" ")}"
+      run_result = connection.run(command)
+      Remotus::Result.new(command, run_result.stdout, run_result.stderr, run_result.output, run_result.exitcode)
+    rescue WinRM::WinRMAuthorizationError => e
+      raise Remotus::AuthenticationError, e.to_s
+    end
+
+    #
+    # Uploads a script and runs it on the host
+    #
+    # @param [String] local_path local path of the script (source)
+    # @param [String] remote_path remote path for the script (destination)
+    # @param [Array] args script arguments
+    # @param [Hash] options command options
+    #
+    # @return [Remotus::Result] result describing the stdout, stderr, and exit status of the command
+    #
+    def run_script(local_path, remote_path, *args, **options)
+      upload(local_path, remote_path)
+      run(remote_path, *args, **options)
+    end
+
+    #
+    # Uploads a file from the local host to the remote host
+    #
+    # @param [String] local_path local path to upload the file from (source)
+    # @param [String] remote_path remote path to upload the file to (destination)
+    # @param [Hash] _options unused upload options
+    #
+    # @return [String] remote path
+    #
+    def upload(local_path, remote_path, _options = {})
+      Remotus.logger.debug { "Uploading file #{local_path} to #{@host}:#{remote_path}" }
+      WinRM::FS::FileManager.new(base_connection).upload(local_path, remote_path)
+      remote_path
+    end
+
+    #
+    # Downloads a file from the remote host to the local host
+    #
+    # @param [String] remote_path remote path to download the file from (source)
+    # @param [String] local_path local path to download the file to (destination)
+    # @param [Hash] _options unused download options
+    #
+    # @return [String] local path
+    #
+    def download(remote_path, local_path, _options = {})
+      Remotus.logger.debug { "Downloading file #{local_path} from #{@host}:#{remote_path}" }
+      WinRM::FS::FileManager.new(base_connection).download(remote_path, local_path)
+      local_path
+    end
+
+    #
+    # Checks if a remote file or directory exists
+    #
+    # @param [String] remote_path remote path to the file or directory
+    # @param [Hash] _options unused command options
+    #
+    # @return [Boolean] true if the file or directory exists, false otherwise
+    #
+    def file_exist?(remote_path, **_options)
+      Remotus.logger.debug { "Checking if file #{remote_path} exists on #{@host}" }
+      WinRM::FS::FileManager.new(base_connection).exists?(remote_path)
+    end
+
+    private
+
+    #
+    # Whether to restart the current WinRM base connection
+    #
+    # @return [Boolean] whether to restart the current base connection
+    #
+    def restart_base_connection?
+      return restart_connection? if @connection
+      return true unless @base_connection
+      return true if @host != @base_connection.instance_values["connection_opts"][:endpoint].scan(%r{//(.*):}).flatten.first
+      return true if Remotus::Auth.credential(self).user != @base_connection.instance_values["connection_opts"][:user]
+      return true if Remotus::Auth.credential(self).password != @base_connection.instance_values["connection_opts"][:password]
+
+      false
+    end
+
+    #
+    # Whether to restart the current WinRM connection
+    #
+    # @return [Boolean] whether to restart the current connection
+    #
+    def restart_connection?
+      return true unless @connection
+      return true if @host != @connection.connection_opts[:endpoint].scan(%r{//(.*):}).flatten.first
+      return true if Remotus::Auth.credential(self).user != @connection.connection_opts[:user]
+      return true if Remotus::Auth.credential(self).password != @connection.connection_opts[:password]
+
+      false
+    end
+  end
+end

data/remotus.gemspec

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require_relative "lib/remotus/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "remotus"
+  spec.version       = Remotus::VERSION
+  spec.authors       = ["Matthew Newell"]
+  spec.email         = ["matthewtnewell@gmail.com"]
+
+  spec.summary       = "Ruby gem for connecting to remote systems seamlessly via WinRM or SSH."
+  spec.description   = "Ruby gem for connecting to remote systems seamlessly via WinRM or SSH."
+  spec.homepage      = "https://github.com/wheatevo/remotus"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.4.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/wheatevo/remotus"
+  spec.metadata["documentation_uri"] = "https://wheatevo.github.io/remotus/"
+  spec.metadata["changelog_uri"] = "https://github.com/wheatevo/remotus/blob/master/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Dependencies
+  spec.add_dependency "connection_pool", "~> 2.2"
+  spec.add_dependency "net-scp", "~> 3.0"
+  spec.add_dependency "net-ssh", "~> 6.1"
+  spec.add_dependency "winrm", "~> 2.3"
+  spec.add_dependency "winrm-fs", "~> 1.3"
+
+  # Development dependencies
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rubocop", "~> 1.7"
+  spec.add_development_dependency "rubocop-rake", "~> 0.5"
+  spec.add_development_dependency "rubocop-rspec", "~> 2.2"
+  spec.add_development_dependency "yard", "~> 0.9"
+end

metadata

@@ -0,0 +1,226 @@
+--- !ruby/object:Gem::Specification
+name: remotus
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Matthew Newell
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-03-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: connection_pool
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: net-scp
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: net-ssh
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.1'
+- !ruby/object:Gem::Dependency
+  name: winrm
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: winrm-fs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !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.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+description: Ruby gem for connecting to remote systems seamlessly via WinRM or SSH.
+email:
+- matthewtnewell@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/main.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/remotus.rb
+- lib/remotus/auth.rb
+- lib/remotus/auth/credential.rb
+- lib/remotus/auth/hash_store.rb
+- lib/remotus/auth/store.rb
+- lib/remotus/host_pool.rb
+- lib/remotus/logger.rb
+- lib/remotus/pool.rb
+- lib/remotus/result.rb
+- lib/remotus/ssh_connection.rb
+- lib/remotus/version.rb
+- lib/remotus/winrm_connection.rb
+- remotus.gemspec
+homepage: https://github.com/wheatevo/remotus
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/wheatevo/remotus
+  source_code_uri: https://github.com/wheatevo/remotus
+  documentation_uri: https://wheatevo.github.io/remotus/
+  changelog_uri: https://github.com/wheatevo/remotus/blob/master/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key: 
+specification_version: 4
+summary: Ruby gem for connecting to remote systems seamlessly via WinRM or SSH.
+test_files: []