kanrisuru 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3a02ab5fbc9ef38c054d2c336b630e9a48c209a393044056a2262dec3a00d373
-  data.tar.gz: 80d925b3b5b3c884a9bea23b81423607130f021da7fc55ad2bc5f8bfbb8ab245
+  metadata.gz: bb8de477e2168c782b7cb082a6a6760fd56aa6925f1820ee80e45baff76a7b27
+  data.tar.gz: ad21e0b9787a2e42d8626a367f11b44ff97ec27f000a6ec8f7967d7b22da066d
 SHA512:
-  metadata.gz: be886466d7bd57cf325d84dc5d254a7c7c638f3cbafe328b875426c95ceb81c6d2b38564a390d8a7f9f42831a514f9bdc5ec0c0d0201166776aed389bcab590f
-  data.tar.gz: f72ecffd89742fd13df20362044f1618ef45618ba3eaf58c4d688a7b0fe31682b052effd28f60d5bc6e2dbd90dbe33394827d304e456b3ccba2608a9c8d5d17e
+  metadata.gz: 0cdeb2cda038612234429eb9ca172f294f60bb8bdcb0d5db2490231dfc4ab4205ae240b3f8ef8ebab41b5de6ef9d2599c7db76dd0ebe229b8b896e3a831c8805
+  data.tar.gz: b32d4fe02fe5897a8f56d827290516ceb393db63068f9cba3a4396b79e667dd62a332013fbb6fe674cd680ccd374faff877441f92f57048d5b782e244b23ec20

data/.github/CONTRIBUTING.md

@@ -0,0 +1,17 @@
+# How to contribute
+Thank you for your interest in contributing to the Kanrisuru project. We appreciate any volunteers that want to help improve, grow and sustain the Kanrisuru code base!
+
+## Submitting a bug
+* Do not open up a GitHub issue if the bug is a security vulnerability with the Kanrisuru project, instead send an email to engineeering@avamia.com for any security realted issues.
+* Check if there's already an existing issue before submitting a [similar one](https://github.com/avamia/kanrisuru/issues).
+* If you can't find a similar issue [open a new one](https://github.com/avamia/kanrisuru/issues/new?assignees=&labels=&template=bug_report.md). Be sure to include a **title and clear description**, as much relevant information as possible, and a **code sample** or an **executable test case** demonstrating the expected behavior that is not occurring.
+
+## Adding a core feature
+* We always welcome improving the core Kanrisuru project. If we are missing a core command available on most linux distros, this would be a place to add that type of functionality.
+* Other ideas like performance optimization, additional testing, and ease of use are great ways of improving the project.
+* If you want to create something outside of the core project, see the next section.
+
+## Adding a new module
+* If you want to extent Kanrisuru beyond the underlying system code base or core module packages, the best way is to create a new gem, in the format of `kanrisuru-package`. 
+* This helps keep the core Kanrisuru package from too much bloat.
+* See our developer module section to see how to build a new Kanrisuru module.

data/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,33 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Desktop (please complete the following information):**
+ - OS: [e.g. Ubuntu]
+ - Version [e.g. 22]
+ - Ruby version: [e.g 2.7.4]
+
+
+**Additional context**
+Add any other context about the problem here.

data/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

data/.rubocop.yml

@@ -20,6 +20,10 @@ Naming/InclusiveLanguage:
     - lib/kanrisuru/core/dmi.rb
     - spec/unit/core/dmi_spec.rb
 
+Naming/MethodParameterName:
+  Exclude:
+    - spec/functional/os_package_spec.rb
+
 Metrics/AbcSize:
   Enabled: false
 

data/CHANGELOG.md

@@ -1,5 +1,13 @@
+## Kanrisuru 0.7.0 (August 8, 2021) ##
+* Simplify `FileInfo` struct for return object of `ls` command.
+* Rename `size` to `fsize` for the `OpenFile` struct to avoid method naming conflicts of the struct class. 
+* Allow `os_include` and `os_collection` to define multiple groupings of methods with the same namespace.
+* Add `clear` method for remote env class, to remove any session based env variables.
+* Add `to_s` method to result for quick analysis of string based return values. 
+* Remove duplicate `numeric` method in the utils module.
+
 ## Kanrisuru 0.6.0 (August 1, 2021) ##
-* Add lsof implementation in system core module
+* Add `lsof` implementation in system core module
 * Fix changelog formatting
 * Add changelog url to gemspec
 
@@ -42,7 +50,6 @@
 * Fix `address_size` in `cpu` method call.
 
 ## Kanrisuru 0.3.0 (July 22, 2021) ##
-
 * Add `lscpu` system core module 
 * Replace `cpu` module internal fetching of data from `cpu_info` to `lscpu` struct.
  

data/README.md

@@ -2,6 +2,10 @@
 [![Latest version](https://img.shields.io/github/license/avamia/kanrisuru)](https://github.com/avamia/kanrisuru/blob/main/LICENSE.txt) 
 ![GitHub repo size](https://img.shields.io/github/repo-size/avamia/kanrisuru) 
 
+<p align='center'>
+  <img src="https://s3.us-east-2.amazonaws.com/kanrisuru.com/kanrisuru-banner-02.png" width="600" />
+</p>
+
 # Kanrisuru
 
 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.

data/kanrisuru.gemspec

@@ -28,6 +28,6 @@ Gem::Specification.new do |gem|
 
   gem.metadata = {
     'source_code_uri' => 'https://github.com/avamia/kanrisuru/',
-    'changelog_uri'   => 'https://github.com/avamia/kanrisuru/blob/main/CHANGELOG.md'
+    'changelog_uri' => 'https://github.com/avamia/kanrisuru/blob/main/CHANGELOG.md'
   }
 end

data/lib/kanrisuru/core/path.rb

@@ -9,10 +9,10 @@ module Kanrisuru
 
       os_define :linux, :ls
       os_define :linux, :pwd
-      os_define :linux, :whoami
-      os_define :linux, :which
       os_define :linux, :realpath
       os_define :linux, :readlink
+      os_define :linux, :whoami
+      os_define :linux, :which
 
       FilePath = Struct.new(:path)
       FileInfoId = Struct.new(:inode, :mode, :memory_blocks, :uid, :gid, :fsize, :date, :path, :type)
@@ -46,7 +46,7 @@ module Kanrisuru
             type = values[1].include?('d') ? 'directory' : 'file'
             items <<
               if id
-                FileInfoId.new(
+                FileInfo.new(
                   values[0].to_i,
                   Kanrisuru::Mode.new(values[1]),
                   values[2].to_i,

data/lib/kanrisuru/core/system.rb

@@ -111,7 +111,7 @@ module Kanrisuru
         :file_descriptor,
         :type,
         :device,
-        :size,
+        :fsize,
         :inode,
         :name
       )
@@ -220,9 +220,9 @@ module Kanrisuru
       end
 
       def cpu_info(spec)
-        Kanrisuru.logger.info {
+        Kanrisuru.logger.info do
           'DEPRECATION WARNING: cpu_info will be removed in the upcoming major release. Use lscpu instead.'
-        }
+        end
 
         name =
           case spec
@@ -320,7 +320,7 @@ module Kanrisuru
         Kanrisuru::Result.new(command)
       end
 
-      def lsof(opts = {})
+      def lsof(_opts = {})
         command = Kanrisuru::Command.new('lsof -F pcuftDsin')
 
         execute_shell(command)
@@ -331,7 +331,7 @@ module Kanrisuru
           current_pid = nil
           current_user = nil
           current_command = nil
-          
+
           rows = []
 
           lines.each do |line|
@@ -343,22 +343,20 @@ module Kanrisuru
             when /^u/
               current_user = parse_lsof(line, 'u').to_i
             when /^f/
-              if current_row
-                rows << current_row
-              end
+              rows << current_row if current_row
 
               current_row = OpenFile.new
               current_row.pid = current_pid
               current_row.command = current_command
               current_row.uid = current_user
 
-              current_row.file_descriptor = parse_lsof(line, 'f') 
+              current_row.file_descriptor = parse_lsof(line, 'f')
             when /^t/
               current_row.type = parse_lsof(line, 't')
             when /^D/
               current_row.device = parse_lsof(line, 'D')
             when /^s/
-              current_row.size = parse_lsof(line, 's').to_i
+              current_row.fsize = parse_lsof(line, 's').to_i
             when /^i/
               current_row.inode = parse_lsof(line, 'i').to_i
             when /^n/
@@ -366,9 +364,7 @@ module Kanrisuru
             end
           end
 
-          if current_row
-            rows << current_row
-          end
+          rows << current_row if current_row
 
           rows
         end

data/lib/kanrisuru/os_package.rb

@@ -46,13 +46,19 @@ module Kanrisuru
           ## Define the namespace as an eigen class instance on the host.
           ## Namespaced instances will access core host methods
           ## with @host instance variable.
-          namespace_class    = Kanrisuru::Remote::Cluster.const_set(Kanrisuru::Util.camelize(namespace), Class.new)
-          namespace_instance = Kanrisuru::Remote::Cluster.instance_variable_set("@#{namespace}", namespace_class.new)
 
-          class_eval do
-            define_method namespace do
-              namespace_instance.instance_variable_set(:@cluster, self)
-              namespace_instance
+          if Kanrisuru::Remote::Cluster.instance_variable_defined?("@#{namespace}")
+            namespace_class = Kanrisuru::Remote::Cluster.const_get(Kanrisuru::Util.camelize(namespace))
+            namespace_instance = instance_variable_get("@#{namespace}")
+          else
+            namespace_class    = Kanrisuru::Remote::Cluster.const_set(Kanrisuru::Util.camelize(namespace), Class.new)
+            namespace_instance = Kanrisuru::Remote::Cluster.instance_variable_set("@#{namespace}", namespace_class.new)
+
+            class_eval do
+              define_method namespace do
+                namespace_instance.instance_variable_set(:@cluster, self)
+                namespace_instance
+              end
             end
           end
 
@@ -132,17 +138,25 @@ module Kanrisuru
           ## Define the namespace as an eigen class instance within the host class.
           ## Namespaced instances will access core host methods
           ## with @host instance variable.
-          namespace_class    = Kanrisuru::Remote::Host.const_set(Kanrisuru::Util.camelize(namespace), Class.new)
-          namespace_instance = Kanrisuru::Remote::Host.instance_variable_set("@#{namespace}", namespace_class.new)
-
-          namespace_class.class_eval(&include_method_bindings)
 
-          class_eval do
-            define_method namespace do
-              namespace_instance.instance_variable_set(:@host, self)
-              namespace_instance
+          ## Check to see if the namespace was defined. If so, additional methods will be appended to the
+          ## existing namespace class definition, otherwise, a new namespace class and instance will be
+          ## defined with the methods added.
+          if Kanrisuru::Remote::Host.instance_variable_defined?("@#{namespace}")
+            namespace_class = Kanrisuru::Remote::Host.const_get(Kanrisuru::Util.camelize(namespace))
+            namespace_instance = instance_variable_get("@#{namespace}")
+          else
+            namespace_class    = Kanrisuru::Remote::Host.const_set(Kanrisuru::Util.camelize(namespace), Class.new)
+            namespace_instance = Kanrisuru::Remote::Host.instance_variable_set("@#{namespace}", namespace_class.new)
+            class_eval do
+              define_method namespace do
+                namespace_instance.instance_variable_set(:@host, self)
+                namespace_instance
+              end
             end
           end
+
+          namespace_class.class_eval(&include_method_bindings)
         else
           class_eval(&include_method_bindings)
         end

data/lib/kanrisuru/remote/env.rb

@@ -11,6 +11,10 @@ module Kanrisuru
         @env
       end
 
+      def clear
+        @env = {}
+      end
+
       def to_s
         string = ''
         @env.each.with_index do |(key, value), index|

data/lib/kanrisuru/result.rb

@@ -31,6 +31,10 @@ module Kanrisuru
       @data[prop]
     end
 
+    def to_s
+      @data.to_s
+    end
+
     def to_a
       @data.instance_of?(Array) ? @data : [@data]
     end

data/lib/kanrisuru/version.rb

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

data/spec/functional/os_package_spec.rb

@@ -16,7 +16,7 @@ module Kanrisuru
   module TestNamespace
     extend Kanrisuru::OsPackage::Define
 
-    os_define :unix_like, :tester
+    os_define :linux, :tester
     os_define :centos, :test_not_correct
 
     def tester
@@ -25,17 +25,34 @@ module Kanrisuru
 
     def test_not_correct; end
   end
+
+  module TestNamespaceAdditions
+    extend Kanrisuru::OsPackage::Define
+
+    os_define :linux, :add
+    os_define :linux, :minus
+
+    def add(a, b)
+      a + b
+    end
+
+    def minus(a, b)
+      a - b
+    end
+  end
 end
 
 module Kanrisuru
   module Remote
     class Host
       os_include Kanrisuru::TestInclude
+      os_include Kanrisuru::TestNamespaceAdditions, namespace: :asdf
       os_include Kanrisuru::TestNamespace, namespace: :asdf
     end
 
     class Cluster
       os_collection Kanrisuru::TestInclude
+      os_collection Kanrisuru::TestNamespaceAdditions, namespace: :asdf
       os_collection Kanrisuru::TestNamespace, namespace: :asdf
     end
   end
@@ -64,8 +81,15 @@ RSpec.describe Kanrisuru::OsPackage do
 
     expect(host).to respond_to(:asdf)
     expect(host.asdf).to respond_to(:tester)
+    expect(host.asdf).to respond_to(:add)
+    expect(host.asdf).to respond_to(:minus)
+
     expect(host.asdf.tester).to eq 'hello namespace'
+    expect(host.asdf.add(1, 2)).to eq(3)
+    expect(host.asdf.minus(3, 2)).to eq(1)
+
     expect(host.tester).to eq('hello ubuntu')
+
     expect { host.asdf.test_not_correct }.to raise_error(NoMethodError)
     expect(cluster.asdf.tester).to be_instance_of(Array)
 

data/spec/unit/core/apt_spec.rb

@@ -11,7 +11,7 @@ RSpec.describe Kanrisuru::Core::Apt do
     expect(Kanrisuru::Core::Apt::PackageOverview.new).to respond_to(
       :package, :version, :suites, :architecture, :installed, :upgradeable, :automatic
     )
-    
+
     expect(Kanrisuru::Core::Apt::PackageDetail.new).to respond_to(
       :package,
       :version,

data/spec/unit/core/ip_spec.rb

@@ -10,9 +10,9 @@ RSpec.describe Kanrisuru::Core::IP do
 
     expect(Kanrisuru::Core::IP::IP_ROUTE_TYPES).to(
       eq(%w[
-        unicast unreachable blackhole prohibit local
-        broadcast throw nat via anycast multicast
-      ])
+           unicast unreachable blackhole prohibit local
+           broadcast throw nat via anycast multicast
+         ])
     )
 
     expect(Kanrisuru::Core::IP::IPLinkProperty.new).to respond_to(

data/spec/unit/core/socket_spec.rb

@@ -13,20 +13,20 @@ RSpec.describe Kanrisuru::Core::Socket do
       :rmem_alloc, :rcv_buf, :wmem_alloc, :snd_buf,
       :fwd_alloc, :wmem_queued, :ropt_mem, :back_log, :sock_drop
     )
-    expect(Kanrisuru::Core::Socket::TCP_STATES).to eq( 
+    expect(Kanrisuru::Core::Socket::TCP_STATES).to eq(
       %w[
         established syn-sent syn-recv
         fin-wait-1 fin-wait-2 time-wait
         closed close-wait last-ack listening closing
       ]
     )
-    expect(Kanrisuru::Core::Socket::OTHER_STATES).to eq( 
+    expect(Kanrisuru::Core::Socket::OTHER_STATES).to eq(
       %w[
         all connected synchronized bucket syn-recv
         big
       ]
     )
-    expect(Kanrisuru::Core::Socket::TCP_STATE_ABBR).to eq( 
+    expect(Kanrisuru::Core::Socket::TCP_STATE_ABBR).to eq(
       {
         'ESTAB' => 'established', 'LISTEN' => 'listening', 'UNCONN' => 'unconnected',
         'SYN-SENT' => 'syn-sent', 'SYN-RECV' => 'syn-recv', 'FIN-WAIT-1' => 'fin-wait-1',

data/spec/unit/core/system_spec.rb

@@ -82,7 +82,7 @@ RSpec.describe Kanrisuru::Core::System do
       :file_descriptor,
       :type,
       :device,
-      :size,
+      :fsize,
       :inode,
       :name
     )

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kanrisuru
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Ryan Mammina
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-08-02 00:00:00.000000000 Z
+date: 2021-08-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -114,6 +114,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/CONTRIBUTING.md"
+- ".github/ISSUE_TEMPLATE/bug_report.md"
+- ".github/ISSUE_TEMPLATE/feature_request.md"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"