rus-admin 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b18c7ccfa78f51109d5412f24af5609e410e1f78056d8db6c015deb680779a77
+  data.tar.gz: 7b05b29fd765252bf3993aea482890fdffdbf46825ded3afbdc491d2b48ab0d9
+SHA512:
+  metadata.gz: 1593a7f05ff37a2c0ce8f9dcf0539332f25189ae1273ad07403f75a799acee85079fa0c865a1523fe764edbb13f50d5a28254ef7dce7f7fe839ff431bc1608ef
+  data.tar.gz: 8c0259c1da8c5734c81e99e87294a2d2406e671e85b6f6c9b8a9a85f78a37dcb2a98455a7c6f4980141d36ed063e9638df4e85008b2da08bb812aff69ebb8508

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 alx3dev
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,70 @@
+# rus-admin
+
+Set of helpers for system administration with IRB
+
+## How to install
+
+```
+gem install rus-admin
+```
+Open IRB shell with:
+```
+rus-admin
+```
+
+**Find helper**
+```ruby
+# When search #in_file - result is Struct object of param and line numbers
+# When search #in_dir - result is Struct object of param and found file-names
+
+# Last result is available in Find#info
+# Find#new or alias Find#reset clear params array
+# Find#reset! clear params and info
+```
+How to use:
+
+```ruby
+# check for name equal to .gemspec
+Find['.gemspec'].in_dir Dir.pwd
+=> #<struct Find::Result params=[".gemspec"], path="/home/alx/Alpha/rus-admin", result={}>
+
+# check if name include .gemspec
+Find.in_dir Dir.pwd, :include
+pp search.result if search.result.any?
+=> {".gemspec"=>["rus-admin.gemspec"]}
+
+# reset params to nil
+Find.new
+# add to params
+Find['password']
+# add more to params
+Find['another_password', 'password_another']
+# search in file for params
+Find.in_file 'path_to_file.txt'
+pp Find.info.result if Find.info.result.any?
+```
+
+**Randpass helper**
+```ruby
+# Create random password with SecureRandom#base64
+# Add random characters, and shuffle it
+# Last password is saved in attribute :pass
+```
+How to use:
+
+```ruby
+Randompass[20]
+=> "0!ZNiAUZCbjo!#hHeX+XX$eAC=!p"
+```
+
+**Override**  
+Override method `capitalize!`, make it work without downcase of other characters.
+Available in classes: `String, Symbol, Array`. If used in array, hashes and integers are skipped.
+
+```ruby
+# override method #capitalize!
+Rus::Admin.override!
+
+#check if classes are overriden
+Rus::Admin.override?
+```

data/bin/rus-admin

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require_relative '../lib/rus/admin'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/lib/rus/admin/find.rb

@@ -0,0 +1,126 @@
+# frozen_string_literal: true
+
+##
+# MIT LICENSE
+# Copyright (c) 2022 Alex3Dev
+#
+# Search for String(s) in file.
+# If success, save line numbers in response hash.
+#
+# @example Simple search for strings included in file
+#
+#  action = Find['string', another_string'].in_file 'path_to_some_file'
+#  pp action.result if action.result.any?
+#
+# @example Compare if any line in a file start with wanted string
+#
+#  action = Find['def some_method'].in_file 'path_to_file.rb', :start_with
+#  pp action.result if action.result.any?
+#
+# @example Search in logfile if any line is equal 'password'
+#
+#   action = Find['password'].in_file 'my_log_file.txt', :equal
+#
+#   if action.result.any?
+#     action.result.each do |param, line_number|
+#       puts "#{param} found on lines => #{line_number}"
+#     end
+#   else
+#     puts "No match for #{action.params}"
+#   end
+#
+class Find
+  Result = Struct.new(:params, :path, :result)
+
+  COMPARATION = %i[equal include start_with end_with].freeze
+
+  class << self
+    # remember last search
+    attr_reader :info
+
+    # Array of strings that has to be searched.
+    #
+    def params
+      @params ||= []
+    end
+
+    # Add strings to @params. Return self so we can chain methods
+    #
+    def [](*add_params)
+      @params = params | add_params
+      self
+    end
+    alias add_params []
+
+    # Start all over (Find.reset or Find.new)
+    #
+    def reset
+      @params = []
+    end
+    alias new reset
+
+    # Start all over, remove last result
+    #
+    def reset!
+      @params, @info = nil
+    end
+
+    # Search each line in file for param
+    # If found, line numbers are saved in result hash
+    #
+    def in_file(filename, type = :include)
+      @found = {}
+      params.each do |string|
+        line_no = 0
+        File.readlines(filename).map do |line|
+          line&.chomp!
+          process_line (line_no += 1).pred, line, string, type
+        end
+      end
+      @info = Result.new @params, filename, @found
+    end
+
+    # Search directory for file/directory name
+    # If found, names are saved in result hash
+    #
+    def in_dir(path, type = :equal)
+      @found = {}
+      Dir.entries(path).each do |file|
+        next if ['.', '..'].include?(file)
+
+        params.each do |string|
+          process_line file, file, string, type
+        end
+      end
+      @info = Result.new @params, path, @found
+    end
+
+    private
+
+    def process_line(line_no, line, string, type)
+      raise ArgumentError, 'Comparation not supported' unless COMPARATION.include?(type)
+
+      line = strip line
+      add_to = check_line line, string, type
+      add string, line_no if add_to
+    end
+
+    def check_line(line, string, type)
+      case type
+      when :include    then true if line.include? string
+      when :equal      then true if line == string
+      when :start_with then true if line.start_with? string
+      when :end_with   then true if line.end_with? string
+      end
+    end
+
+    def add(param, line_no)
+      @found[param] = Array(@found[param]) | Array(line_no)
+    end
+
+    def strip(line)
+      line[0] = '' until line[0] != ' '
+      line
+    end
+  end
+end

data/lib/rus/admin/randpass.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require 'securerandom'
+
+module Randpass
+  class << self
+    attr_reader :pass
+
+    # Get random password
+    # Add special characters to SecureRandom#base64 random string, and shuffle it
+    #
+    # @note Always shuffle base64 if it has less than 16 chars, because they end with '=='
+    #
+    def [](number_of_chars = 18)
+      random = SecureRandom.base64(number_of_chars)
+      rand(5..10).times { random = add_special_chars(random) }
+      @pass = random.split('').shuffle.join
+    end
+    alias get []
+
+    private
+
+    def add_special_chars(param)
+      count = SecureRandom.random_number 15_000
+      char = case count
+             when 1...1000    then '_'
+             when 1000...2000 then '!'
+             when 2000...3000 then '#'
+             when 3000...4000 then '$'
+             when 4000...5000 then '%'
+             when 6000...7000 then '?'
+             else return param
+             end
+      param[rand(param.size)] = char
+      param
+    end
+  end
+end

data/lib/rus/admin.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require_relative 'version' unless defined? Rus::Admin::VERSION
+require_relative 'admin/find' unless defined? Find
+require_relative 'admin/randpass' unless defined? Randpass
+
+module Rus
+  module Admin
+    class << self
+      def override?
+        @override == true
+      end
+
+      def override!
+        require_relative 'override/override'
+        @override = true
+      end
+    end
+  end
+end

data/lib/rus/override/override.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+class String
+  def capitalize!
+    self[0] = self[0].upcase
+    self
+  end
+end
+
+class Symbol
+  def capitalize!
+    String.new(name).capitalize!.to_sym
+  end
+end
+
+class Array
+  def capitalize!
+    each do |x|
+      x.capitalize! if x.instance_of?(String) || x.instance_of?(Symbol)
+    end
+  end
+end

data/lib/rus/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Rus
+  module Admin
+    VERSION = '0.1.0'
+  end
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification
+name: rus-admin
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- alx3dev
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-02-20 00:00:00.000000000 Z
+dependencies:
+- !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'
+description: |
+  Set of helper methods for system administration.
+  Speed up system tasks with one-liners and IRB.
+email:
+- alx3dev@gmail.com
+executables:
+- rus-admin
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- bin/rus-admin
+- lib/rus/admin.rb
+- lib/rus/admin/find.rb
+- lib/rus/admin/randpass.rb
+- lib/rus/override/override.rb
+- lib/rus/version.rb
+homepage: https://www.github.com/alx3dev/rus-admin
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://www.github.com/alx3dev/rus-admin
+  source_code_uri: https://www.github.com/alx3dev/rus-admin
+  changelog_uri: https://www.github.com/alx3dev/rus-admin/CHANGELOG.md
+  documentation_uri: https://www.rubydoc.info/gems/rus-admin/0.1.0
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.7'
+  - - "<"
+    - !ruby/object:Gem::Version
+      version: '3.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.6
+signing_key:
+specification_version: 4
+summary: Set of helper methods for system administration with Ruby.
+test_files: []