nub 0.0.21

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 102f1cf06e8b45889dd60b7372e5111f492a97fdf8ed8caafd30b3dac5690dd3
+  data.tar.gz: e921565b8a4ab7ef8644a1e0993d7187105840f38d73d21c6145cb420d7d8952
+SHA512:
+  metadata.gz: 27f89bc3db8382e91415a3009d2cc76136734cf4f25685a5f40797b0cfdebabfc3fd5ff808eb4f84366c949bea3a5eebf38e8d333fcda2d58242f6716eb868f2
+  data.tar.gz: 5110db336085570bb0ec25497f4f61edc0f5d063de501e6edbbd01401846eb9c52a667d14b124f8363a7f853d94e0f8f71843b7be4e8653e832f5520ac127357

data/lib/nub.rb

@@ -0,0 +1,33 @@
+#!/usr/bin/env ruby
+#MIT License
+#Copyright (c) 2018 phR0ze
+#
+#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.
+
+module Nub
+  require 'nub/cmds'
+  require 'nub/config'
+  require 'nub/log'
+  require 'nub/net'
+  require 'nub/string'
+  require 'nub/thread_comm'
+  require 'nub/user'
+end
+
+# vim: ft=ruby:ts=2:sw=2:sts=2

data/lib/nub/cmds.rb

@@ -0,0 +1,153 @@
+#MIT License
+#Copyright (c) 2018 phR0ze
+#
+#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.
+
+require 'optparse'              # cmd line options: OptionParser
+
+begin
+  require 'colorize'
+rescue Exception => e
+  mod = e.message.split(' ').last.sub('/', '-')
+  mod = e.message[/.*Could not find '(.*?)'.*/, 1] if e.message.include?("Could not find")
+  !puts("Error: install missing package with 'sudo pacman -S ruby-#{mod}'") and exit
+end
+
+# Command option class provides a way to encapsulate a command with
+# any additional properties.
+class CmdOpt
+  attr_reader(:key)
+  attr_reader(:conf)
+  attr_reader(:type)
+  attr_reader(:desc)
+  attr_reader(:required)
+  def initialize(conf, desc, type:nil, required:false)
+    @conf = conf.gsub(' ', '=')
+    @key = conf.gsub('-', '').split('=').first.to_sym
+    @type = type
+    @desc = desc
+    @required = required
+  end
+end
+
+# Simple command wrapper around options parsing
+# When multiple commands are given they share the options passed along with them
+class Cmds
+
+  # Option and command names have all hyphens removed
+  attr_accessor(:cmds)
+  attr_accessor(:opts)
+
+  # Initialize the commands for your application
+  # Params:
+  # +app+:: application name e.g. reduce
+  # +version+:: version of the application e.g. 1.0.0
+  # +examples+:: optional examples to list after the title before usage
+  def initialize(app, version, examples)
+    @opts = {}
+    @cmds = {}
+    @cmds_config = {}
+
+    @app = app
+    @version = version
+    @examples = examples || ''
+  end
+
+  # Hash like accessor for checking if a command is set
+  def [](key)
+    return @cmds[key] if @cmds[key]
+    return @opts[key] if @opts[key]
+  end
+
+  # Hash like accessor for editing options
+  def []=(key, value)
+    @opts[key] = value
+  end
+
+  # Add a command to the command list
+  # Params:
+  # +cmd+:: name of the command
+  # +desc+:: description of the command
+  # +opts+:: list of command options
+  def add(cmd, desc, opts)
+    @cmds_config[cmd] = {desc: desc, inopts: opts, outopts: OptionParser.new{|parser|
+      required = opts.map{|x| x.conf if x.required}.compact * ' '
+      required += ' ' if not required.empty?
+      parser.banner = "#{banner}\nUsage: ./#{@app} #{cmd} #{required}[options]"
+      opts.each{|opt| parser.on(opt.conf, opt.type, opt.desc){|x| @opts[opt.key] = x }}
+    }}
+  end
+
+  # Returns banner string
+  def banner
+    banner = "#{@app}_v#{@version}\n#{'-' * 80}".colorize(:light_yellow)
+    return banner
+  end
+
+  # Construct the command line parser and parse
+  def parse!
+
+    # Construct help for the application
+    help = "COMMANDS:\n"
+    @cmds_config.each{|k,v| help += "    #{k.ljust(33, ' ')}#{v[:desc]}\n" }
+    help += "\nsee './#{@app} COMMAND --help' for specific command info"
+
+    # Construct top level option parser
+    @optparser = OptionParser.new do |parser|
+      parser.banner = "#{banner}\n#{@examples}Usage: ./#{@app} commands [options]"
+      parser.on('-h', '--help', 'Print command/options help') {|x| !puts(parser) and exit }
+      parser.separator(help)
+    end
+
+    # Invoke the option parser with help if any un-recognized commands are given
+    cmds = ARGV.select{|x| not x.start_with?('-')}
+    ARGV.clear and ARGV << '-h' if ARGV.empty? or cmds.any?{|x| not @cmds_config[x]}
+    cmds.each{|x| puts("Error: Invalid command '#{x}'".colorize(:red)) if not @cmds_config[x]}
+    @optparser.order!
+
+    # Now remove them from ARGV leaving only options
+    ARGV.reject!{|x| not x.start_with?('-')}
+
+    # Parse each command which will consume options from ARGV
+    cmds.each do |cmd|
+      begin
+        @cmds[cmd.gsub('-', '_').to_sym] = true
+        @cmds_config[cmd][:outopts].order!
+
+        # Ensure that all required options were given
+        @cmds_config[cmd][:inopts].each{|x|
+          if x.required and not @opts[x.key]
+            puts("Error: Missing required option '#{x.key}'".colorize(:red))
+            ARGV.clear and ARGV << "-h"
+            @cmds_config[cmd][:outopts].order!
+          end
+        }
+      rescue OptionParser::InvalidOption => e
+        # Options parser will raise an invalid exception if it doesn't recognize something
+        # However we want to ignore that as it may be another command's option
+        ARGV << e.to_s[/(-.*)/, 1]
+      end
+    end
+
+    # Ensure all options were consumed
+    !puts("Error: invalid options #{ARGV}".colorize(:red)) and exit if ARGV.any?
+  end
+end
+
+# vim: ft=ruby:ts=2:sw=2:sts=2

data/lib/nub/config.rb

@@ -0,0 +1,83 @@
+#MIT License
+#Copyright (c) 2018 phR0ze
+#
+#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.
+
+require 'yaml'
+
+begin
+  require 'colorize'
+rescue Exception => e
+  mod = e.message.split(' ').last.sub('/', '-')
+  mod = e.message[/.*Could not find '(.*?)'.*/, 1] if e.message.include?("Could not find")
+  !puts("Error: install missing package with 'sudo pacman -S ruby-#{mod}'") and exit
+end
+
+require_relative 'user'
+require_relative 'log'
+
+# Simple YAML configuration for an application
+# uses singleton pattern for single source of truth
+module Config
+
+  # Private properties
+  @@_yml = nil
+
+  # Public properties
+  class << self
+    attr_accessor :path
+  end
+
+  # Singleton new alternate
+  # @param config_name [String] name of the config file
+  def self.init(config_name)
+    @path = "/home/#{User.name}/.config/#{config_name}"
+
+    # Open the config file or create in memory yml
+    begin
+      @@_yml = File.exists?(@path) ? YAML.load_file(@path) : {}
+    rescue Exception => e
+      Log.puts("Error: #{e}".colorize(:red)) and exit
+    end
+
+    return nil
+  end
+
+  # Simple bool whether the config exists or not on disk
+  def exists?
+      return File.exists?(@path)
+  end
+
+  # Hash like getter
+  def self.[](key)
+    return @@_yml[key]
+  end
+
+  # Hash like setter
+  def self.[]=(key, val)
+    return @@_yml[key] = val
+  end
+
+  # Save the config file
+  def self.save
+    File.open(@path, 'w'){|f| f << @@_yml.to_yaml } if @@_yml
+  end
+end
+
+# vim: ft=ruby:ts=2:sw=2:sts=2

data/lib/nub/log.rb

@@ -0,0 +1,254 @@
+#MIT License
+#Copyright (c) 2018 phR0ze
+#
+#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.
+
+require 'time'
+require 'monitor'
+require 'ostruct'
+
+begin
+  require 'colorize'
+rescue Exception => e
+  mod = e.message.split(' ').last.sub('/', '-')
+  mod = e.message[/.*Could not find '(.*?)'.*/, 1] if e.message.include?("Could not find")
+  !puts("Error: install missing package with 'sudo pacman -S ruby-#{mod}'") and exit
+end
+
+ColorPair = Struct.new(:str, :color)
+ColorMap = {
+  "30" => "black",
+  "31" => "red",
+  "32" => "green",
+  "33" => "yellow",
+  "34" => "blue",
+  "35" => "magenta",
+  "36" => "cyan",
+  "37" => "white",
+  "39" => "gray88"   # default
+}
+
+LogLevel = OpenStruct.new({
+  error: 0,
+  warn: 1,
+  info: 2,
+  debug: 3
+})
+
+# Singleton logger for use with both console and gtk+ apps
+# logs to both a file and the console/queue for shell/UI apps
+# uses Mutex.synchronize where required to provide thread safty
+module Log
+  extend self
+
+  # Private properties
+  @@_level = 3
+  @@_queue = nil
+  @@_stdout = true
+  @@_monitor = Monitor.new
+
+  # Public properties
+  class << self
+    attr_reader(:id, :path)
+  end
+
+  # Singleton new alternate initialize
+  # Can be called multiple times to reset
+  # @param path [String] path to log file
+  # @param queue [Bool] use a queue as well
+  # @param stdout [Bool] turn on or off stdout
+  # @param level [LogLevel] level at which to log
+  def init(path:nil, level:LogLevel.debug, queue:false, stdout:true)
+    @id ||= 'singleton'.object_id
+
+    @path = path ? File.expand_path(path) : nil
+    @@_level = level
+    @@_queue = queue ? Queue.new : nil
+    @@_stdout = stdout
+
+    # Open log file creating as needed
+    if @path
+      FileUtils.mkdir_p(File.dirname(@path)) if !File.exist?(File.dirname(@path))
+      @file = File.open(@path, 'a')
+      @file.sync = true
+    end
+
+    return nil
+  end
+
+  # Format the given string for use in log
+  def format(str)
+    @@_monitor.synchronize{
+
+      # Locate caller
+      stack = caller_locations(3,10)
+      i = -1
+      while i += 1 do
+        mod = File.basename(stack[i].path, '.rb')
+        break if !['log', 'monitor'].include?(mod)
+      end
+
+      # Save lineno from non log call but use method name rather than rescue or block
+      lineno = stack[i].lineno
+      nested = ['rescue in', 'block in', 'each']
+      while nested.any?{|x| stack[i].label.include?(x)} do
+        i += 1
+      end
+      loc = ":#{File.basename(stack[i].path, '.rb')}:#{stack[i].label}:#{lineno}"
+
+      return "#{Time.now.utc.iso8601(3)}#{loc}:: #{str}"
+    }
+  end
+
+  def print(*args)
+    @@_monitor.synchronize{
+      str = !args.first.is_a?(Hash) ? args.first.to_s : ''
+
+      # Determine if stamp should be used
+      stamp = true
+      opts = args.find{|x| x.is_a?(Hash)}
+      if opts and opts.key?(:stamp)
+        stamp = opts[:stamp]
+      end
+
+      # Format message
+      str = format(str) if stamp
+
+      if !str.empty?
+        @file << strip_colorize(str) if @path
+        @@_queue << str if @@_queue
+        $stdout.print(str) if @@_stdout
+      end
+
+      return true
+    }
+  end
+
+  def puts(*args)
+    @@_monitor.synchronize{
+      str = !args.first.is_a?(Hash) ? args.first.to_s : ''
+
+      # Determine if stamp should be used
+      stamp = true
+      opts = args.find{|x| x.is_a?(Hash)}
+      if opts and opts.key?(:stamp)
+        stamp = opts[:stamp]
+      end
+
+      # Format message
+      str = format(str) if stamp
+
+      # Handle output
+      @file.puts(strip_colorize(str)) if @path
+      @@_queue << "#{str}\n" if @@_queue
+      $stdout.puts(str) if @@_stdout
+
+      return true
+    }
+  end
+
+  def error(*args)
+    return puts(*args) if LogLevel.error <= @@_level
+    return true
+  end
+
+  def warn(*args)
+    return puts(*args) if LogLevel.warn <= @@_level
+    return true
+  end
+
+  def info(*args)
+    return puts(*args) if LogLevel.info <= @@_level
+    return true
+  end
+
+  def debug(*args)
+    return puts(*args) if LogLevel.debug <= @@_level
+    return true
+  end
+
+  # Log the given message in red and exit
+  # @param msg [String] message to log
+  def die(msg)
+    puts(msg.colorize(:red)) and exit
+  end
+
+  # Remove an item from the queue, block until one exists
+  def pop()
+    return @@_queue ? @@_queue.pop : nil
+  end
+
+  # Check if the log queue is empty
+  def empty?
+    return @@_queue ? @@_queue.empty? : true
+  end
+
+  # Strip the ansi color codes from the given string
+  # @param str [String] string with ansi color codes
+  # @returns [String] string without any ansi codes
+  def strip_colorize(str)
+    @@_monitor.synchronize{
+      return str.gsub(/\e\[0;[39]\d;49m/, '').gsub(/\e\[0m/, '')
+    }
+  end
+
+  # Tokenize the given colorized string
+  # @param str [String] string with ansi color codes
+  # @returns [Array] array of Token
+  def tokenize_colorize(str)
+    @@_monitor.synchronize{
+      tokens = []
+      matches = str.to_enum(:scan, /\e\[0;[39]\d;49m(.*?[\s]*)\e\[0m/).map{Regexp.last_match}
+
+      i, istart, iend = 0, 0, 0
+      match = matches[i]
+      while istart < str.size
+        color = "39"
+        iend = str.size
+        token = str[istart..iend]
+
+        # Current token is not a match
+        if match && match.begin(0) != istart
+          iend = match.begin(0)-1
+          token = str[istart..iend]
+          istart = iend + 1
+
+        # Current token is a match
+        elsif match && match.begin(0) == istart
+          iend = match.end(0)
+          token = match.captures.first
+          color = match.to_s[/\e\[0;(\d+);49m.*/, 1]
+          i += 1; match = matches[i]
+          istart = iend
+
+        # Ending
+        else
+          istart = iend
+        end
+
+        # Create token and advance
+        tokens << ColorPair.new(token, color)
+      end
+
+      return tokens
+    }
+  end
+end
+
+# vim: ft=ruby:ts=2:sw=2:sts=2

data/lib/nub/net.rb

@@ -0,0 +1,76 @@
+#!/usr/bin/env ruby
+#MIT License
+#Copyright (c) 2018 phR0ze
+#
+#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.
+require 'ostruct'
+
+module Net 
+  @@_proxy = nil
+  @@_agents = OpenStruct.new({
+    windows_ie_6: 'Windows IE 6',
+    windows_ie_7: 'Windows IE 7',
+    windows_mozilla: 'Windows Mozilla',
+    mac_safari: 'Mac Safari',
+    mac_firefox: 'Mac FireFox',
+    mac_mozilla: 'Mac Mozilla',
+    linux_mozilla: 'Linux Mozilla',
+    linux_firefox: 'Linux Firefox',
+    linux_konqueror: 'Linux Konqueror',
+    iphone: 'iPhone'
+  })
+
+  # Accessors
+  def self.agents; @@_agents; end
+  def self.proxy_uri; http_proxy ? http_proxy.split(':')[1][2..-1] : nil; end
+  def self.proxy_port; http_proxy ? http_proxy.split(':').last : nil; end
+  def self.ftp_proxy; get_proxy if @@_proxy.nil?; @@_proxy['ftp_proxy']; end
+  def self.http_proxy; get_proxy if @@_proxy.nil?; @@_proxy['http_proxy']; end
+  def self.https_proxy; get_proxy if @@_proxy.nil?; @@_proxy['https_proxy']; end
+  def self.no_proxy; get_proxy if @@_proxy.nil?; @@_proxy['no_proxy']; end
+
+  # Get the system proxy variables
+  def self.get_proxy
+    @@_proxy = {
+      'ftp_proxy' => ENV['ftp_proxy'],
+      'http_proxy' => ENV['http_proxy'],
+      'https_proxy' => ENV['https_proxy'],
+      'no_proxy' => ENV['no_proxy']
+    }
+  end
+
+  # Get a shell export string for proxies
+  def self.proxy_export
+    get_proxy if @@_proxy.nil?
+    return proxy_exist? ? (@@_proxy.map{|k,v| "export #{k}=#{v}"} * ';') + ";" : nil
+  end
+
+  # Check if a proxy is set
+  def self.proxy_exist?
+    get_proxy if @@_proxy.nil?
+    return !@@_proxy['http_proxy'].nil?
+  end
+
+  # Check if the system is configured for the kernel to forward ip traffic
+  def self.ip_forward?
+    return `cat /proc/sys/net/ipv4/ip_forward`.include?('1')
+  end
+end
+
+# vim: ft=ruby:ts=2:sw=2:sts=2

data/lib/nub/string.rb

@@ -0,0 +1,35 @@
+#MIT License
+#Copyright (c) 2018 phR0ze
+#
+#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.
+
+# Monkey patch string with some useful methods
+class String
+  def to_ascii
+    options = {
+      :invalid => :replace,
+      :undef => :replace,
+      :replace => '',
+      :universal_newline => true
+    }
+    return self.encode(Encoding.find('ASCII'), options)
+  end
+end
+
+# vim: ft=ruby:ts=2:sw=2:sts=2

data/lib/nub/thread_comm.rb

@@ -0,0 +1,65 @@
+#MIT License
+#Copyright (c) 2018 phR0ze
+#
+#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.
+
+require 'ostruct'
+
+# Provides a simple messaging mechanism between threads
+ThreadMsg = Struct.new(:cmd, :value)
+
+# Thread with communication queues for simple messaging
+class ThreadComm < Thread
+  def initialize
+    @comm_in = Queue.new
+    @comm_out = Queue.new
+
+    # Proc.new will return the block given to this method
+    # pass it along to thread .new with arguments
+    super(@comm_in, @comm_out, &Proc.new)
+  end
+
+  # Check if the message queue is empty
+  def empty?
+    return @comm_out.empty?
+  end
+
+  # Pop a message off the thread's outbound queue or block
+  def pop
+    msg = @comm_out.pop
+    return msg if msg.is_a?(ThreadMsg)
+    return ThreadMsg.new(msg)
+  end
+
+  # Push the given message onto the threads inbound queue
+  # @param msg [ThreadMsg] message to the thread
+  # @param cmd [String] message command to the thread
+  # @param value [String] message value to the thread
+  def push(*args)
+    if args.first.is_a?(ThreadMsg)
+      @comm_in << args.first
+    elsif args.size == 1
+      @comm_in << ThreadMsg.new(args.first)
+    else
+      @comm_in << ThreadMsg.new(args.first, args.last)
+    end
+  end
+end
+
+# vim: ft=ruby:ts=2:sw=2:sts=2

data/lib/nub/user.rb

@@ -0,0 +1,36 @@
+#!/usr/bin/env ruby
+#MIT License
+#Copyright (c) 2018 phR0ze
+#
+#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.
+
+module User
+
+  # Check if the current user has root privileges
+  def self.root?
+    return Process.uid.zero?
+  end
+
+  # Get the current user taking into account sudo priviledges
+  def self.name
+    return Process.uid.zero? ? Etc.getpwuid(ENV['SUDO_UID'].to_i).name : ENV['USER']
+  end
+end
+
+# vim: ft=ruby:ts=2:sw=2:sts=2

metadata

@@ -0,0 +1,51 @@
+--- !ruby/object:Gem::Specification
+name: nub
+version: !ruby/object:Gem::Version
+  version: 0.0.21
+platform: ruby
+authors:
+- Patrick Crummett
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-03-22 00:00:00.000000000 Z
+dependencies: []
+description: Collection of useful utilities
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/nub.rb
+- lib/nub/cmds.rb
+- lib/nub/config.rb
+- lib/nub/log.rb
+- lib/nub/net.rb
+- lib/nub/string.rb
+- lib/nub/thread_comm.rb
+- lib/nub/user.rb
+homepage: https://github.com/phR0ze/ruby-nub
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.3
+signing_key: 
+specification_version: 4
+summary: Collection of useful utilities
+test_files: []