miab 0.2.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f55a97e81e82e74208daba1ab739870e2d20a69a24f1399ecc26d311fd7758b5
-  data.tar.gz: 9365c7761a511133a1489f48d8f925d969972735fcd5204b439c047f85fa852a
+  metadata.gz: a339ac7a434f6d8f59cfacb59a5f70e56c4cbe490712a9ec70bec7992cae9036
+  data.tar.gz: f44e1bf9f71fe2fc250841c9b69ae4eb62a69176bff014bc8293f23c17b6cf35
 SHA512:
-  metadata.gz: fc1f8615bb288650541853d281a6096217f2d5960fcb6de3d509012fec1fef88b70095dc8fb81c7aa2e53db2b4920f901318f2e95e28c6949e1513e9388029b3
-  data.tar.gz: a85242c85b472ca36301579a8439cf6557a0cda61bc8709256624d66d842e218a0a6f661cf6339090e26356aea4704c7cff4cd7420812216285be7d0f155fb76
+  metadata.gz: 42d047bc15e959ff24b194063547065875d495f23ccd09f5e7d0f607f326f6a5f9aeef0894c9f90d5459bcc64453d1abdfe5d8031bb8e5389e68181343ef525c
+  data.tar.gz: c390aebd8577fcbba6569549a69358c673bd85e44ac1b1f5f49fcd904885af78084a0aa76b478796adfcf7a7097af48514b8d5a48ba5f9283473b0994914d3ed

data/lib/miab.rb

@@ -4,188 +4,373 @@
 
 # Desc: Message in a bottle (MIAB) is designed to execute remote commands 
 #       through SSH for system maintenance purposes.
+#
+#       Note: Intended for a Debian based distro
 
 require 'net/ssh'
 require 'c32'
-require 'resolve/hostname'
-
+require 'resolv'
+
+
+# available commands:
+#
+# * backup - initiates rsync on the remote machine to be backed up
+# * date - returns the system date and time
+# * directory_exists? - returns true if the directory exists
+# * disk_space - returns the available disk space
+# * echo - returns whatever string is passed in
+# * file_exists? - returns true if the file exists
+# * file_write - writes contents to a file
+# * installable? - returns true if the package name exists in apt-cache search
+# * installed? - returns true if a package is already installed
+# * internet? - returns true if a ping request to an external IP address succeeds
+# * memory - returns the amount of free RAM available etc
+# * ping - returns the latency of a ping request to the node
+# * pwd - returns the working directory
+# * temperature - returns the temperature of the CPU
+
+# usage: puts Miab.new("temperature", domain: 'home', target: 'angelo', 
+#                       user: 'pi', password: 'secret').cast
+# nearest SSH equivalent `ssh pi@angelo.home exec \
+#                                 "cat /sys/class/thermal/thermal_zone0/temp"`
 
 class Miab
   using ColouredText
+  
+  class Session
+    
+    def initialize( host, ssh=nil, debug: false, dns: '1.1.1.1')
+      
+      @ssh, @host, @debug, @dns = ssh, host, debug, dns
+      
+      puts 'Session dns: ' + dns.inspect if @debug
+      @results = {}
+    end
+    
+    def exec(s)
+      eval s
+      @results
+    end
+    
+    protected
+    
+    # backup 
+    # e.g. from: /mnt/usbdisk/gem_src/.
+    #      to: pi@192.168.4.158:backup2020/gem_src/.
+    #
+    def backup(from: nil, to: nil)
+
+      if @debug then
+        puts 'ready to perform backup' 
+        puts "from: %s to: %s" % [from, to]
+      end
+      
+      instructions  = "rsync -akL -e ssh %s %s" % [from, to]
+
+      puts 'instructions: ' + instructions if @debug      
+      
+      # note: compression is not enabled since this is aimed at 
+      #       single board computers which have limited CPU capability
+
+      r = @ssh ? @ssh.exec!(instructions) : `#{instructions}`
+      puts 'r: ' + r.inspect if @debug
+      
+      # since it's running in the background, an empty string will be returned
+      
+    end
+    
+    # return the local date and time
+    #
+    def date()
 
-  def initialize(scroll, domain: nil, target: nil, pwlist: {}, password: nil, 
-    user: nil, debug: false)
+      instructions = 'date'
+      r = @ssh ? @ssh.exec!(instructions) : `#{instructions}`
+      puts 'r: ' + r.inspect if @debug
+      @results[:date] = r.chomp
 
-    @results = {}
+    end
+    
+    def directory_exists?(file)
+      
+      instructions = "test -d #{file}; echo $?"
+      r = @ssh ? @ssh.exec!(instructions) : `#{instructions}`
+      puts 'r: ' + r.inspect if @debug
+      
+      @results[:directory_exists?] = r.chomp == '0'
 
-    @scroll, @debug = scroll, debug
+    end
+    
+    alias dir_exists? directory_exists?
 
-    @nodes = if target then
+    # query the available disk space etc.
+    #
+    def disk_space()
 
-      target = [target] if target.is_a? String
+      instructions = 'df -h'
+      r = @ssh ? @ssh.exec!(instructions) : `#{instructions}`
 
-      target.inject({}) do |r,x|
-        host = domain ? x + '.' + domain : x
-        passwd = pwlist[x] || password
-        userhost = user ? user + '@' + host : host
-        r.merge({userhost => passwd})
-      end
+      @results[:disk_usage] = {}
 
-    else
-      {}
-    end
-  end
+      a = r.lines.grep(/\/dev\/root/)
 
-  # cast out the thing and hope for the best
-  #
-  def cast()
+      puts ('a: ' + a.inspect).debug if @debug
 
-    if @nodes.any? then
+      if a.any? then
+        size, used, avail = a[0].split(/ +/).values_at(1,2,3)
 
-      @nodes.each do |raw_host, password|
+        @results[:disk_usage][:root] = {size: size, used: used, 
+          avail: avail}
+      end
 
-        host, user = raw_host.split(/@/,2).reverse
-        @host = host
-        @results[host] = {}
-        
-        begin
-          @ssh = Net::SSH.start( host, user, password: password)
-          eval @scroll
-          @ssh.close
-        rescue
-          @results[host] = nil
-        end
-        
+      a2 = r.lines.grep(/\/dev\/sda1/)
+
+      puts ('a2: ' + a2.inspect).debug if @debug
+
+      if a2.any? then
+        size, used, avail = a2[0].split(/ +/).values_at(1,2,3)
+
+        @results[:disk_usage][:sda1] = {size: size, used: used, 
+          avail: avail}
       end
 
-    else
-      @results[`hostname`.chomp] = {}
-      eval @scroll if @scroll
     end
 
-    @scroll = nil
-    @results
-  end
+    alias df disk_space
+    
+    # return the string supplied
+    #
+    def echo(s)
 
-  # return the local date and time
-  #
-  def date()
+      instructions = 'echo ' + s
+      r = @ssh ? @ssh.exec!(instructions) : `#{instructions}`
+      puts 'r: ' + r.inspect if @debug
+      @results[:echo] = r.chomp
 
-    instructions = 'date'
-    r = @ssh ? @ssh.exec!(instructions) : system(instructions)
-    @results[@host][:date] = r.chomp
+    end
+    
+    def exec_success?(instruction, expected)
+      
+      r = @ssh ? @ssh.exec!(instruction) : `#{instruction}`
+      puts 'r: ' + r.inspect if @debug
+      
+      @results[:exec_success?] = (r =~ /#{expected}/ ? true : r)
+
+    end  
+    
+    def file_exists?(file)
+      
+      instructions = "test -f #{file}; echo $?"
+      r = @ssh ? @ssh.exec!(instructions) : `#{instructions}`
+      puts 'r: ' + r.inspect if @debug
+      
+      @results[:file_exists?] = r == 0 
+
+    end     
+    
+    # e.g. file_write 'desc.txt', 'Controls the door entry system.'
+    #
+    def file_write(file, content)
+      
+      instructions = "echo #{content.inspect} >> #{file}"
+      r = @ssh ? @ssh.exec!(instructions) : `#{instructions}`
+      puts 'r: ' + r.inspect if @debug
+      
+      @results[:file_write] = r
+
+    end        
+    
+    # return the string supplied
+    #
+    def install(package)
+
+      return @results[:install] = 'no route to internet' unless internet?
+      return @results[:install] = 'already installed' if installed? package
+      
+      instructions = "apt-get update && apt-get install  #{package} -y"
+      r = @ssh ? @ssh.exec!(instructions) : `#{instructions}`
+      puts 'r: ' + r.inspect if @debug
+      @results[:install] = r.chomp
+
+    end    
+    
+    def installable?(package)
+      
+      instructions = "apt-cache search --names-only ^#{package}$"
+      results = @ssh ? @ssh.exec!(instructions) : `#{instructions}`
+      puts 'results: ' + results.inspect if @debug
+      
+      @results[:installable?] = !results.empty? 
+
+    end    
+    
+    def installed?(package)
+      
+      instructions = 'dpkg --get-selections | grep -i ' + package
+      results = @ssh ? @ssh.exec!(instructions) : `#{instructions}`
+      puts 'results: ' + results.inspect if @debug
+      
+      return @results[:installed?] = nil if results.empty?
+      r = results.lines.grep /^#{package}/
+      
+      @results[:installed?] = r.any?
+    end
 
-  end
+    def internet?()
+      
+      instructions = "ping #{@dns} -W 1 -c 1"
+      r = @ssh ? @ssh.exec!(instructions) : `#{instructions}`
+      puts 'r: ' + r.inspect if @debug
+      
+      @results[:internet?] = r.lines[1][/icmp_seq/] ? true : false
 
-  # query the available disk space etc.
-  #
-  def disk_space()
+    end    
 
-    instructions = 'df -h'
-    s = @ssh ? @ssh.exec!(instructions) : system(instructions)
+    # find out available memory etc
+    #
+    def memory()
 
-    @results[@host][:disk_usage] = {}
+      instructions = 'free -h'
 
-    a = s.lines.grep(/\/dev\/root/)
+      puts ('instructions: ' + instructions.inspect).debug if @debug
+      r = @ssh ? @ssh.exec!(instructions) : `#{instructions}`
+      puts ('memory: ' + r.inspect).debug if @debug
+      a = r.lines
+      total, used, avail = a[1].split.values_at(1,2,-1)    
+      @results[:memory] = {total: total, used: used, available: avail}
 
-    puts ('a: ' + a.inspect).debug if @debug
+    end
+    
+    # query the ping time
+    #
+    def ping()
+
+      ip = Resolv.getaddress(@host)
+      puts ('ip: ' + ip.inspect).debug if @debug
+      valid = pingecho(ip)
+      puts ('valid: ' + valid.inspect).debug if @debug    
+      
+      @results[:ping] = if valid then
+        a = [valid]
+        4.times {sleep 0.01; a << pingecho(ip)}
+        (a.min * 1000).round(3)
+      else
+        nil
+      end
 
-    if a.any? then
-      size, used, avail = a[0].split(/ +/).values_at(1,2,3)
+    end
 
-      @results[@host][:disk_usage][:root] = {size: size, used: used, 
-        avail: avail}
+    # query the path of the current working directory
+    #
+    def pwd()
+      instructions = 'pwd'
+      r = @ssh ? @ssh.exec!(instructions) : `#{instructions}`
+      @results[:pwd] = r.chomp
     end
 
-    a2 = s.lines.grep(/\/dev\/sda1/)
+    # query the CPU temperature
+    #
+    def temperature()
+      instructions = 'cat /sys/class/thermal/thermal_zone0/temp'
+      r = @ssh ? @ssh.exec!(instructions) : `#{instructions}`
+      @results[:temperature] = r.chomp
+    end
+    
+    private
+    
+    
+    def pingecho(host, timeout=5, service="echo")
 
-    puts ('a2: ' + a2.inspect).debug if @debug
+      elapsed = nil
+      time = Time.new
 
-    if a2.any? then
-      size, used, avail = a2[0].split(/ +/).values_at(1,2,3)
+      begin
 
-      @results[@host][:disk_usage][:sda1] = {size: size, used: used, 
-        avail: avail}
-    end
+        Timeout.timeout(timeout) do
+          s = TCPSocket.new(host, service)
+          s.close
+        end
 
+      rescue Errno::ECONNREFUSED
+        return Time.now - time
+      rescue Timeout::Error, StandardError
+        return false
+      end
+      
+      # it should not reach this far
+      return true
+    end  
+      
+      
   end
 
-  alias df disk_space
+  def initialize(scroll, domain: nil, target: nil, pwlist: {}, password: nil, 
+    user: nil, debug: false, dns: '208.67.222.222')
+
+    @results = {}
 
-  # find out available memory etc
-  #
-  def memory()
+    @scroll, @debug, @dns = scroll, debug, dns
+    
+    puts '@dns: ' + @dns.inspect if @debug
+    
+    target = [target] if target.is_a? String
 
-    instructions = 'free -h'
+    @nodes = if target then
 
-    puts ('instructions: ' + instructions.inspect).debug if @debug
-    r = @ssh ? @ssh.exec!(instructions) : system(instructions)
-    puts ('memory: ' + r.inspect).debug if @debug
-    a = r.lines
-    total, used, avail = a[1].split.values_at(1,2,-1)    
-    @results[@host][:memory] = {total: total, used: used, available: avail}
+      target = [target] if target.is_a? String
+
+      target.inject({}) do |r,x|
+        host = domain ? x + '.' + domain : x
+        passwd = pwlist[x] || password
+        userhost = user ? user + '@' + host : host
+        r.merge({userhost => passwd})
+      end
 
-  end
-  
-  # query the ping time
-  #
-  def ping()
-
-    resolver = Resolve::Hostname.new
-    ip = resolver.getaddress(@host)
-    puts ('ip: ' + ip.inspect).debug if @debug
-    valid = pingecho(ip)
-    puts ('valid: ' + valid.inspect).debug if @debug    
-    
-    @results[@host][:ping] = if valid then
-      a = [valid]
-      4.times {sleep 0.01; a << pingecho(ip)}
-      (a.min * 1000).round(3)
     else
-      nil
+      {}
     end
-
   end
 
-  # query the path of the current working directory
+  # cast out the thing and hope for the best
   #
-  def pwd()
-    instructions = 'pwd'
-    r = @ssh ? @ssh.exec!(instructions) : system(instructions)
-    @results[@host][:pwd] = r.chomp
-  end
+  def cast()
 
-  # query the CPU temperature
-  #
-  def temperature()
-    instructions = 'cat /sys/class/thermal/thermal_zone0/temp'
-    r = @ssh ? @ssh.exec!(instructions) : system(instructions)
-    @results[@host][:temperature] = r.chomp
-  end
-  
-  private
-  
-  
-  def pingecho(host, timeout=5, service="echo")
+    if @nodes.any? then
+      
+      threads = []
+      dns = @dns
 
-    elapsed = nil
-    time = Time.new
+      @nodes.each do |raw_host, password|
+        
+        host, user = raw_host.split(/@/,2).reverse
+        @results[host] = {}
+        
+        threads << Thread.new do
+          begin
+            puts ('host: ' + host.inspect).debug if @debug
+            ssh = Net::SSH.start( host, user, password: password)
+            @results[host] = Session.new(host, ssh, dns: dns, debug: @debug).exec @scroll
+            ssh.close
+            puts (host + ' result: ' + @results[host].inspect).debug if @debug
+          rescue
+            @results[host] = nil
+          end
+        end
+        
+      end      
 
-    begin
+      threads.each(&:join)
 
-      Timeout.timeout(timeout) do
-        s = TCPSocket.new(host, service)
-        s.close
+    else
+      
+      if @scroll then
+        host = `hostname`.chomp
+        @results[host] = Session.new(host, dns: @dns, debug: @debug).exec(@scroll)
       end
-
-    rescue Errno::ECONNREFUSED
-      return Time.now - time
-    rescue Timeout::Error, StandardError
-      return false
+      
     end
-    
-    # it should not reach this far
-    return true
-  end  
+
+    @scroll = nil
+    @results
+  end
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: miab
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.4.0
 platform: ruby
 authors:
 - James Robertson
@@ -35,7 +35,7 @@ cert_chain:
   9irKsAp/hZt3dTbQOtnSlc9XREZZdegwOgu1FEqBqviNIn9R28OR237HExiWXwmw
   HDTFIjk8XBqTunABuFUgr4qx
   -----END CERTIFICATE-----
-date: 2019-09-14 00:00:00.000000000 Z
+date: 2020-08-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: net-ssh
@@ -43,20 +43,20 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.2.0
+        version: 6.1.0
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '6.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.2.0
+        version: 6.1.0
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '6.1'
 - !ruby/object:Gem::Dependency
   name: c32
   requirement: !ruby/object:Gem::Requirement
@@ -77,26 +77,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.2'
-- !ruby/object:Gem::Dependency
-  name: resolve-hostname
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.1.0
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.1'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.1.0
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.1'
 description: 
 email: james@jamesrobertson.eu
 executables: []