miab 0.3.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3496f53c24051559de73b16b3ec351a6f6c7054b04e72e6cdde7851f43e41428
-  data.tar.gz: b3617027ca5ef79dfdfe06f790fb7fb048a97140096a246ddf38266babecd2bc
+  metadata.gz: ced57340f07efffc93c646a147121deb9a1fbb8d037aaa37ba2eb3203fc69573
+  data.tar.gz: 3ff78cd963d512efa0528cbee9456b8efed970a943698db326bf3ff95717a60d
 SHA512:
-  metadata.gz: 8cc9a8aef7ec3f22f45cae23015b8709a05390a5100b6498378190b15e34bdeca2dfa6d4a9fa45ac70343b20e91ab5c164678f376cfc20fab54e4a8558f2c071
-  data.tar.gz: 13f991b278fc3d8b077464120abf3cc7184439e4870f122d49d8df42fd8332eca7fbf0b73ed3534d403da17b40f391653476fc5f007267f7e52f744d9ce6c532
+  metadata.gz: 0ee3e715313c423032f22db63c8f9e8a21bd33877960abdcea64ba22b2ab44d5cd5de5519c485895af819d0590f79e0082d584d4cadf3ee88532ccbd605ab129
+  data.tar.gz: a8aae9b45ea47714cc4ca79562d5c904ee1592b8daa73989191ae22500a8185af3c7bd611e618610d04fa037a3622d738e6b27e8bed3c2138ecf8aee7543b838

data/lib/miab.rb

@@ -4,19 +4,45 @@
 
 # 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 'resolv'
 
 
+# available commands:
+#
+# * 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)
-      @ssh, @host, @debug = ssh, host, debug
+    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
     
@@ -37,6 +63,18 @@ class Miab
       @results[:date] = r.chomp
 
     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'
+
+    end
+    
+    alias dir_exists? directory_exists?
 
     # query the available disk space etc.
     #
@@ -72,6 +110,85 @@ class Miab
     end
 
     alias df disk_space
+    
+    # return the string supplied
+    #
+    def echo(s)
+
+      instructions = 'echo ' + s
+      r = @ssh ? @ssh.exec!(instructions) : `#{instructions}`
+      puts 'r: ' + r.inspect if @debug
+      @results[:echo] = r.chomp
+
+    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
+
+    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
+
+    end    
 
     # find out available memory etc
     #
@@ -152,11 +269,13 @@ class Miab
   end
 
   def initialize(scroll, domain: nil, target: nil, pwlist: {}, password: nil, 
-    user: nil, debug: false)
+    user: nil, debug: false, dns: '208.67.222.222')
 
     @results = {}
 
-    @scroll, @debug = scroll, debug
+    @scroll, @debug, @dns = scroll, debug, dns
+    
+    puts '@dns: ' + @dns.inspect if @debug
 
     @nodes = if target then
 
@@ -181,6 +300,7 @@ class Miab
     if @nodes.any? then
       
       threads = []
+      dns = @dns
 
       @nodes.each do |raw_host, password|
         
@@ -191,7 +311,7 @@ class Miab
           begin
             puts ('host: ' + host.inspect).debug if @debug
             ssh = Net::SSH.start( host, user, password: password)
-            @results[host] = Session.new(host, ssh, debug: @debug).exec @scroll
+            @results[host] = Session.new(host, ssh, dns: dns, debug: @debug).exec @scroll
             ssh.close
             puts (host + ' result: ' + @results[host].inspect).debug if @debug
           rescue
@@ -207,7 +327,7 @@ class Miab
       
       if @scroll then
         host = `hostname`.chomp
-        @results[host] = Session.new(host, debug: @debug).exec(@scroll)
+        @results[host] = Session.new(host, dns: @dns, debug: @debug).exec(@scroll)
       end
       
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: miab
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors:
 - James Robertson
@@ -35,7 +35,7 @@ cert_chain:
   9irKsAp/hZt3dTbQOtnSlc9XREZZdegwOgu1FEqBqviNIn9R28OR237HExiWXwmw
   HDTFIjk8XBqTunABuFUgr4qx
   -----END CERTIFICATE-----
-date: 2019-09-16 00:00:00.000000000 Z
+date: 2019-11-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: net-ssh