kanrisuru 0.16.9 → 0.16.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ffeb83d91c285f197ed82ea9faf1f2d4ed95f8394cd383354eebed18dc6ace91
-  data.tar.gz: 5b4d615c7754eb2d520f175d77cecafb774e2d841d9077c23b8ccb39d7fde059
+  metadata.gz: deee19d7cfafee6dd2ab48a0400ba7b18909de35a0c6f60e9e8c17c6c9ac3eab
+  data.tar.gz: 59a153f5f7b94fedfa06baf22a7a47d70a3fce9b66a04705dce91e58f063140a
 SHA512:
-  metadata.gz: eac9603360b49938e188cf36babef60f57106091f93d5ad1f7e74a45e523b5f235463653ea305b34d700c728382707496662212c83e59ad629f954c695644f33
-  data.tar.gz: 2b6214a7c61f3273f226290ad87fbf3da0eb5f401a9b6923a45779beca89b1ba7e5cbece32247136fba5b24eb8c4ea38015fc136e752d3508d62845ba24e70ba
+  metadata.gz: 0a4413a7e8da493e0059e15fc2742c17ae19977c830a77f2c3aea9432677fcecdb7f9191f4342fbc9a4d4159f2897c873f993de9db6d4f9bee0ce349251850a9
+  data.tar.gz: f6c9c82523ddad69b3b8db6ecdc9a6032d1e85e693892516a65295905b3cc2911bd484fbaeb859d5e9fe70ae660012326d01ed6da81cf7bb50dd73608f9b3e66

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## Kanrisuru 0.16.10 (December 28, 2021) ##
+*  Add `iname` and `iregex` params to `find` command.
+
 ## Kanrisuru 0.16.9 (December 27, 2021) ##
 *  Use cp intead of mv for recurisive dir overwrite on upload command.
 

data/README.md

@@ -15,15 +15,11 @@
   <img src="https://img.shields.io/codeclimate/maintainability/avamia/kanrisuru?style=flat-square" alt="Code Climate maintainability" />
 </p>
 
-Kanrisuru (manage) helps you remotely control infrastructure using Ruby. This is done over SSH. I'm working on building up some basic functionality to help quickly provision, deploy and manage a single host or cluster of hosts.
+Kanrisuru manages remote infrastructure with plain ruby objects. The goal with Kanrisuru is to provide a clean objected oriented wrapper over the most commonly used linux commands, with a clean command interface, and with any usable output, present that as parsed structured data. Kanrisuru doesn't use remote agents to run commands on hosts, nor does the project rely on a large complex set of dependencies.
 
-The idea behind this project is not to replace the numerous other projects to manage your infrastrucutre, however, I've found there usually meant to be a standalone project that have their own ecosystem. With Kanrisuru, you essentailly plug the library directly into your ruby project.
+## Getting Started
 
-At this point, Kanrisuru doesn't use a DSL, or offer idempotency, and while that may be added later on, the goal with this project is to expose helpful ways of managing your remote infrastructure with plain ruby in a procedural manner. The realization I had was when trying to deal with other open source projects, you either had to deal with a different language than ruby, use agents on remote hosts, or deal with a complex library that is meant to act in a declarative manner.
-
-If you want to dynamically interact with a host, eg: If you need to dynamically scale your infrastructure by continually monitoring specific stats from a centralized system, Kanrisuru can help you accomplish this.
-
-## Installation
+Kanrisuru requires ruby `2.5.0` at a minimum.
 
 Add this line to your application's Gemfile:
 
@@ -43,48 +39,128 @@ Or install it yourself as:
 $ gem install kanrisuru
 ```
 
-## Usage
-Run basic commands you would have access to while running on a remote host or on a cluster of hosts.
+## Documentation
+You can find the official documentation https://kanrisuru.com
 
+## Usage Guide
 ### Host
+To connect with Kanrisuru to a remote host, provide the login credentials to instantiate a `Kanrisuru::Remote::Host` instance.
+
+```ruby
+host = Kanrisuru::Remote::Host.new(
+  host: 'remote-host-name', 
+  username: 'ubuntu', 
+  keys: ['~/.ssh/id_rsa']
+)
+```
+
+#### run a simple echo command on the remote host
+```ruby
+host.env['VAR'] = 'world'
+result = host.echo('hello $VAR')
+result.success?
+true
+
+result.to_s
+'hello world'
+```
+
+#### build a custom command
+```ruby
+command = Kanrisuru::Command.new('wc')
+command << '/home/ubuntu/file1.txt'
+
+host.execute_shell(command)
+result = Kanrisuru::Result.new(command) do |cmd|
+  items = cmd.to_s.split
+  
+  struct = Kanrisuru::Core::File::FileCount.new
+  struct.lines = items[0]
+  struct.words = items[1]
+  struct.characters = items[2]
+  struct
+end
+```
+The `Kanrisuru::Result` class will only run the parsing block if the command run on the remote host was succeful. The final line will be used to build the result object to be read easily. This instance will also dynamically add getter methods to read the underlying data struct for easier querying capabiltiies.
+
 ```ruby
-host = Kanrisuru::Remote::Host.new(host: 'host', username: 'ubuntu', keys: ['~/.ssh/id_rsa'])
-result = host.whoami   
-result.to_s						# => 'ubuntu'
+result.success?
+true
 
-result = host.pwd
-result.path 					# => /home/ubuntu 
+result.lines
+8
+
+result.characters
+150
+
+result.words
+85
 ```
 
-### Cluster 
+### Cluster
+Kanrisuru can manage multiple hosts at the same time with the `Kanrisuru::Remote::Cluster`.
+
+#### To instantiate a cluster, add 1 or more hosts:
 ```ruby
 cluster = Kanrisuru::Remote::Cluster.new({
-  host: 'host1', username: 'ubuntu', keys: ['~/.ssh/id_rsa']
+  host: 'remote-host-1',
+  username: 'ubuntu',
+  keys: ['~/.ssh/remote_1_id_rsa']
+}, {
+  host: 'remote-host-2',
+  username: 'centos',
+  keys: ['~/.ssh/remote_2_id_rsa']
 }, {
-  host: 'host2', username: 'alice', keys: ['~/.ssh/id_rsa']
+  host: 'remote-host-3',
+  username: 'opensuse',
+  keys: ['~/.ssh/remote_3_id_rsa']
 })
-
-cluster.whoami   # => {host: 'host1', result: 'ubuntu'}, {host: 'host2', result: 'alice'}
-cluster.pwd      # => {host: 'host1', result: '/home/ubuntu'}, {host: 'host2', result: '/home/alice'}
-
-cluster.each do |host|
-  host.pwd.path  # => /home/ubuntu
-end
 ```
 
-### Host or Cluster with underlying command
+#### You can also add a host to a cluster that's already been created 
 ```ruby
-host = Kanrisuru::Remote::Host.new(host: 'host1', username: 'ubuntu', keys: ['~/.ssh/id_rsa'])
+host = Kanrisuru::Remote::Host.new(host: 'remote-host-4', username: 'rhel', keys: ['~/.ssh/remote_4_id_rsa'])
 
-command = Kanrisuru::Command.new('uname')
-host.execute(command)
+cluster << host 
+```
 
-command.success? #=> true
-command.to_s  #=> Linux
+Kanrisuru at this point only runs commands sequentially. We plan on creating a parallel run mode in a future release.
 
-cluster = Kanrisuru::Remote::Cluster.new(host, {host: 'host2', username: 'alice', keys: ['~/.ssh/id_rsa']})
+#### To run across all hosts with a single command, cluster will return a array of result hashes
+```ruby
+cluster.whoami
+[
+  {
+    :host => "remote-host-1",
+    :result => #<Kanrisuru::Result:0x640 @status=0 @data=#<struct Kanrisuru::Core::Path::UserName user="ubuntu"> @command=sudo -u ubuntu /bin/bash -c "whoami">
+  },
+  {
+    :host => "remote-host-2",
+    :result => #<Kanrisuru::Result:0x700 @status=0 @data=#<struct Kanrisuru::Core::Path::UserName user="centos"> @command=sudo -u centos /bin/bash -c "whoami">
+  },
+  {
+    :host => "remote-host-3",
+    :result => #<Kanrisuru::Result:0x760 @status=0 @data=#<struct Kanrisuru::Core::Path::UserName user="opensuse"> @command=sudo -u opensuse /bin/bash -c "whoami">
+  },
+  {
+    :host => "remote-host-4",
+    :result => #<Kanrisuru::Result:0x820 @status=0 @data=#<struct Kanrisuru::Core::Path::UserName user="rhel"> @command=sudo -u rhel /bin/bash -c "whoami">
+  }
+]
+```
 
-cluster.execute('uname') #=> {host: 'host1', result: 'Linux'}, {host: 'host2', result: 'Linux'}
+#### You can also access each host individually to run a command conditionaly within an iterable block
+```ruby
+cluster.each do |host|
+  case host.os.release
+  when 'ubuntu', 'debian'
+    host.apt('update')
+  when 'centos', 'redhat', 'fedora'
+    host.yum('update')
+  when 'opensuse_leap', 'sles'
+    host.zypper('update')
+  end
+end
 ```
 
 ## Development

data/lib/kanrisuru/core/find/commands/find.rb

@@ -36,6 +36,7 @@ module Kanrisuru
 
         command.append_arg('-path', opts[:path])
         command.append_arg('-name', opts[:name])
+        command.append_arg('-iname', opts[:iname])
         command.append_arg('-gid', opts[:gid])
         command.append_arg('-uid', opts[:uid])
         command.append_arg('-user', opts[:user])
@@ -58,7 +59,8 @@ module Kanrisuru
           command.append_arg('-regextype', opts[:regex_type])
         end
 
-        command.append_arg('-regex', "'#{regex}'") if Kanrisuru::Util.present?(regex)
+        command.append_arg('-regex', "'#{opts[:regex]}'") if Kanrisuru::Util.present?(opts[:regex])
+        command.append_arg('-iregex', "'#{opts[:iregex]}'") if Kanrisuru::Util.present?(opts[:iregex])
 
         if size.instance_of?(String)
           regex = Regexp.new(/^([-+])?(\d+)([bcwkMG])*$/)

data/lib/kanrisuru/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Kanrisuru
-  VERSION = '0.16.9'
+  VERSION = '0.16.10'
 end

data/spec/functional/core/find_spec.rb

@@ -64,12 +64,24 @@ RSpec.describe Kanrisuru::Core::Find do
                              mmin: '300'),
                    'find /var/log -atime +1 -ctime +2 -mtime +3 -amin 100 -cmin 200 -mmin 300')
 
+    expect_command(host.find(
+                     paths: '/dev',
+                     iname: 'tty*'
+                   ),
+                   "find /dev -iname tty*")
+
     expect_command(host.find(
                      paths: '/dev',
                      regex: '/dev/tty[0-9]*'
                    ),
                    "find /dev -regex '/dev/tty[0-9]*'")
 
+    expect_command(host.find(
+                     paths: '/dev',
+                     iregex: '/dev/tty[0-9]*'
+                   ),
+                   "find /dev -iregex '/dev/tty[0-9]*'")
+
     expect_command(host.find(
                      paths: '/dev',
                      regex_type: 'posix-egrep',

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kanrisuru
 version: !ruby/object:Gem::Version
-  version: 0.16.9
+  version: 0.16.10
 platform: ruby
 authors:
 - Ryan Mammina
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-12-27 00:00:00.000000000 Z
+date: 2021-12-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parallel_tests