panda-motd 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 602cdbb28a1c8eb7b902dd7c1dee4f0caffb0663fcda3d4b505ca9f53b2aebf7
-  data.tar.gz: 638ca548913a3de96d7534bc22f84aa1fef57e4ee45ad18c4b295de7ce8add42
+  metadata.gz: 324ec514bbb141949c82866eed44d830d6f0f768824f42cda912f872f205bdc8
+  data.tar.gz: 867433a26a6277120037b51c7f16b0eb6cb32edac085f1f245048c7097148829
 SHA512:
-  metadata.gz: ca2a3254437207351125a08175382980cc43905a22b9f84127993e900d9a2e20213b89d79f973fc9505b8ee38423e24b8542e78135f6cb4423f729782d60400f
-  data.tar.gz: fb2e551bc3bcf911fc9d01aad4af7906aaad435ec19e89026232e34e53ef536d6eae592a6a68e9700b69ac3924d7714e4d22a299e6f75746acbdf951880eaa1e
+  metadata.gz: bec0220f18e5b3c5c2f32958ba93cd463efe92ce87dee363b9dd5ee2aec2ab7579b3ce1cc6794dae483f82b8b8ba38d15d974ef77a8bb91b2524fd5ff12a4180
+  data.tar.gz: 71e8cba32a1936bdf7304c296364ef2dc2aeb9cce2f4a9fb747db3bd97bee4f4ae8c5c4130ca0c6abc9a719f78ad01f98215b4ede31b72d48736e7c871a36fc2

data/lib/panda_motd/component_error.rb

@@ -0,0 +1,14 @@
+require 'colorize'
+
+class ComponentError
+  attr_reader :component, :message
+
+  def initialize(component, message)
+    @component = component
+    @message = message
+  end
+
+  def to_s
+    return "#{@component.name} error: ".red + @message.to_s
+  end
+end

data/lib/panda_motd/components/ascii_text_art.rb

@@ -1,18 +1,29 @@
 require 'artii'
 require 'colorize'
 
-class AsciiTextArt
+class ASCIITextArt
+  attr_reader :name, :errors, :results
+
   def initialize(motd)
+    @name = 'ascii_text_art'
     @motd = motd
-    @config = motd.config.component_config('ascii_text_art')
+    @config = motd.config.component_config(@name)
+    @errors = []
   end
 
   def process
     @text = `hostname`
-    @art = Artii::Base.new font: @config['font']
+
+    begin
+      @art = Artii::Base.new font: @config['font']
+      @results = @art.asciify(@text)
+      @results = @results.send(@config['color'].to_sym) if @config['color']
+    rescue Errno::EISDIR # Artii doesn't handle invalid font names very well
+      @errors << ComponentError.new(self, 'Invalid font name')
+    end
   end
 
   def to_s
-    return @art.asciify(@text).red
+    return @results
   end
 end

data/lib/panda_motd/components/filesystems.rb

@@ -0,0 +1,120 @@
+require 'ruby-units'
+require 'colorize'
+
+class Filesystems
+  attr_reader :name, :errors
+  attr_reader :results
+
+  def initialize(motd)
+    @name = 'filesystems'
+    @motd = motd
+    @config = motd.config.component_config(@name)
+    @errors = []
+  end
+
+  def process
+    @results = parse_filesystem_usage(@config['filesystems'])
+  end
+
+  def to_s
+    name_col_size = @results.select { |r| r.is_a? Hash }.map { |r| r[:pretty_name].length }.max
+    name_col_size = 0 if name_col_size.nil?
+
+    name_col_size_with_padding = (name_col_size + 6) > 13 ? (name_col_size + 6) : 13
+
+    result = 'Filesystems'.ljust(name_col_size_with_padding, ' ')
+    result += "Size  Used  Free  Use%\n"
+
+    @results.each do |filesystem|
+      # handle filesystem not found
+      if filesystem.is_a? String
+        result += "  #{filesystem}\n"
+        next
+      end
+
+      result += "  #{filesystem[:pretty_name]}".ljust(name_col_size_with_padding, ' ')
+
+      [:size, :used, :avail].each do |metric|
+        units = if filesystem[metric] > 10**12
+                  'terabytes'
+                elsif filesystem[metric] > 10**9
+                  'gigabytes'
+                elsif filesystem[metric] > 10**6
+                  'megabytes'
+                elsif filesystem[metric] > 10**3
+                  'kilobytes'
+                else
+                  'bytes'
+                end
+
+        value = Unit.new("#{filesystem[metric]} bytes").convert_to(units)
+
+        # we have 4 characters of space to include the number, a potential decimal point, and
+        # the unit character at the end. if the whole number component is 3+ digits long then
+        # we omit the decimal point and just display the whole number component. if the whole
+        # number component is 2 digits long, we can't afford to use a decimal point, so we still
+        # only display the whole number component. if the whole number component is 1 digit long,
+        # we use the single whole number component digit, a decimal point, a single fractional
+        # digit, and the unit character.
+        whole_number_length = value.scalar.floor.to_s.length
+        round_amount = whole_number_length > 1 ? 0 : 1
+        formatted_value = value.scalar.round(round_amount).to_s + units[0].upcase
+        result += formatted_value.rjust(4, ' ') + '  '
+      end
+
+      percentage_used = ((filesystem[:used].to_f / filesystem[:size].to_f) * 100).round
+      result += (percentage_used.to_s.rjust(3, ' ') + '%').send(percentage_color(percentage_used))
+
+      result += "\n"
+
+      total_ticks = name_col_size_with_padding + 18
+      used_ticks = (total_ticks * (percentage_used.to_f / 100)).round
+
+      result += "  [#{('=' * used_ticks).send(percentage_color(percentage_used))}#{('=' * (total_ticks - used_ticks)).light_black}]\n"
+    end
+
+    return result
+  end
+
+  private
+
+  def percentage_color(percentage)
+    return :green  if (0..75).cover?   percentage
+    return :yellow if (75..95).cover?  percentage
+    return :red    if (95..100).cover? percentage
+    return :white
+  end
+
+  def find_header_id_by_text(header_array, text)
+    return header_array.each_index.select { |i| header_array[i].downcase.include? text }.first
+  end
+
+  def parse_filesystem_usage(filesystems)
+    command_result = `BLOCKSIZE=1024 df`.split("\n")
+    header = command_result[0].split
+    entries = command_result[1..command_result.count]
+
+    name_index  = find_header_id_by_text(header, 'filesystem')
+    size_index  = find_header_id_by_text(header, 'blocks')
+    used_index  = find_header_id_by_text(header, 'used')
+    avail_index = find_header_id_by_text(header, 'avail')
+
+    results = filesystems.map do |filesystem, name|
+      matching_entry = entries.find { |e| e.split[name_index] == filesystem }
+
+      if matching_entry
+        {
+          pretty_name: name,
+          filesystem_name: matching_entry.split[name_index],
+          size: matching_entry.split[size_index].to_i * 1024,
+          used: matching_entry.split[used_index].to_i * 1024,
+          avail: matching_entry.split[avail_index].to_i * 1024
+        }
+      else
+        "#{filesystem} was not found"
+      end
+    end
+
+    return results
+  end
+end

data/lib/panda_motd/components/service_status.rb

@@ -1,31 +1,30 @@
 require 'colorize'
 
 class ServiceStatus
+  attr_reader :name, :errors
   attr_reader :results
 
   def initialize(motd)
+    @name = 'service_status'
     @motd = motd
-    @config = motd.config.component_config('service_status')
+    @config = motd.config.component_config(@name)
+    @errors = []
   end
 
   def process
     @services = @config['services']
-    @results = {}
-
-    parse_services
+    @results = parse_services(@services)
   end
 
   def to_s
     if @results.any?
       result = "Services:\n"
       longest_name_size = @results.keys.map { |k| k.to_s.length }.max + 1 # add 1 for the ':' at the end
-      @results.each do |name, status|
-        name_part = if name.to_s.length > longest_name_size
-                      name.to_s.slice(1..longest_name_size)
-                    else
-                      (name.to_s + ':').ljust(longest_name_size, ' ')
-                    end
-        result += "  #{name_part} #{status}\n"
+      @results.each_with_index do |(name, status), i|
+        name_part = (name.to_s + ':').ljust(longest_name_size, ' ')
+        status_part = status.to_s.send(service_colors[status])
+        result += "  #{name_part} #{status_part}"
+        result += "\n" unless i == @results.count - 1 # don't print newline for last entry
       end
 
       return result
@@ -36,62 +35,30 @@ class ServiceStatus
 
   private
 
-  def parse_services
-    case Gem::Platform.local.os
-    when 'darwin'
-      @results = parse_services_macos(@services)
-    when 'linux'
-      @results = parse_services_linux(@services)
-    end
-
-    return self
-  end
-
-  def parse_services_macos(services)
+  def parse_services(services)
     results = {}
 
-    # valid statuses are started, stopped, error, and unknown
-    `brew services list`.split("\n").each do |line|
-      parsed_name = line.split[0]
-      parsed_status = line.split[1]
+    cmd_result = `systemctl | grep '\.service'`
 
-      matching_service = services.find { |service, _name| service == parsed_name }
-
-      if matching_service
-        results[parsed_name.to_sym] = parsed_status.send(macos_service_colors[parsed_status.to_sym])
-      end
+    if cmd_result.empty?
+      @errors << ComponentError.new(self, 'Unable to parse systemctl output')
     end
 
-    return results
-  end
-
-  def parse_services_linux(services)
-    results = {}
-
-    `systemctl | grep '\.service'`.split("\n").each do |line|
+    cmd_result.split("\n").each do |line|
       parsed_name = line.split[0].gsub('.service', '')
       parsed_status = line.split[3]
 
       matching_service = services.find { |service, _name| service == parsed_name }
 
       if matching_service
-        results[parsed_name.to_sym] = parsed_status.send(linux_service_colors[parsed_status.to_sym])
+        results[parsed_name.to_sym] = parsed_status.to_sym
       end
     end
 
     return results
   end
 
-  def macos_service_colors
-    return {
-      started: :green,
-      stopped: :white,
-      error: :red,
-      unknown: :yellow
-    }
-  end
-
-  def linux_service_colors
+  def service_colors
     return {
       running: :green,
       exited: :white,

data/lib/panda_motd/components/ssl_certificates.rb

@@ -0,0 +1,85 @@
+require 'date'
+
+class SSLCertificates
+  attr_reader :name, :errors, :results
+
+  def initialize(motd)
+    @name = 'ssl_certificates'
+    @motd = motd
+    @config = motd.config.component_config(@name)
+    @errors = []
+  end
+
+  def process
+    @certs = @config['certs']
+    @results = cert_dates(@certs)
+  end
+
+  def to_s
+    result = "SSL Certificates:\n"
+    longest_name_size = @results.map { |r| r[0].length }.max
+
+    @results.each_with_index do |cert, i|
+      if cert.is_a? String # print the not found message
+        result += "  #{cert}"
+      else
+        name_portion = "  #{cert[0]}".ljust(longest_name_size + 6, ' ')
+
+        status = cert_status(cert[1])
+
+        date_portion = "#{cert_status_strings[status]} ".send(cert_status_colors[status]) + cert[1].strftime('%e %b %Y %H:%M:%S%p').to_s
+        result += name_portion + date_portion
+      end
+
+      result += "\n" unless i == @results.count - 1 # don't print newline for last entry
+    end
+
+    return result
+  end
+
+  private
+
+  def cert_dates(certs)
+    return certs.map do |name, path|
+      if File.exist?(path)
+        cmd_result = `openssl x509 -in #{path} -dates`
+        parsed = cmd_result.match(/notAfter=([\w\s:]+)\n/)
+        if parsed.nil?
+          @errors << ComponentError.new(self, 'Unable to find certificate expiration date')
+        else
+          begin
+            expiry_date = DateTime.parse(parsed[1])
+            [name, expiry_date]
+          rescue ArgumentError
+            @errors << ComponentError.new(self, 'Found expiration date, but unable to parse as date')
+          end
+        end
+      else
+        "Certificate #{name} not found at path: #{path}"
+      end
+    end
+  end
+
+  def cert_status(expiry_date)
+    status = :valid
+    status = :expiring if (DateTime.now...DateTime.now + 30).cover? expiry_date # ... range excludes end
+    status = :expired if DateTime.now >= expiry_date
+    return status
+  end
+
+  def cert_status_colors
+    return {
+      valid: :green,
+      expiring: :yellow,
+      expired: :red
+    }
+  end
+
+  def cert_status_strings
+    return {
+      valid: 'valid until',
+      expiring: 'expiring at',
+      expired: 'expired at'
+    }
+  end
+end

data/lib/panda_motd/components/uptime.rb

@@ -1,11 +1,14 @@
 require 'sysinfo'
 
 class Uptime
+  attr_reader :name, :errors
   attr_reader :days, :hours, :minutes
 
   def initialize(motd)
+    @name = 'uptime'
     @motd = motd
-    @config = motd.config.component_config('ascii_text_art')
+    @config = motd.config.component_config(@name)
+    @errors = []
   end
 
   def process
@@ -22,6 +25,6 @@ class Uptime
     result += "#{@days} day#{'s' if @days != 1}, " unless @days.zero?
     result += "#{@hours} hour#{'s' if @hours != 1}, " unless @hours.zero? && @days.zero?
     result += "#{@minutes} minute#{'s' if @minutes != 1}"
-    return "uptime: #{result}"
+    return "#{@config['prefix'] || 'up'} #{result}"
   end
 end

data/lib/panda_motd/config.rb

@@ -3,7 +3,7 @@ require 'fileutils'
 
 class Config
   def initialize(file_path = nil)
-    @file_path = File.join(Dir.home, '.config', 'panda-motd.yaml') if file_path.nil?
+    @file_path = file_path.nil? ? File.join(Dir.home, '.config', 'panda-motd.yaml') : file_path
     create_config(@file_path) unless File.exist?(@file_path)
     load_config(@file_path)
   end
@@ -11,8 +11,8 @@ class Config
   def components_enabled
     # first iterate through the config hash and grab all names of enabled components
     enabled_list = @config['components'].map { |component, setting| component if setting['enabled'] }.compact
-    # convert each snake_case name to an upper-camel-case name which represents a class, and get that class constant
-    return enabled_list.map { |e| Object.const_get(e.split('_').map(&:capitalize).join) }
+    # get the class constant
+    return enabled_list.map { |e| component_classes[e.to_sym] }
   end
 
   def component_config(component_name)
@@ -21,6 +21,16 @@ class Config
 
   private
 
+  def component_classes
+    return {
+      ascii_text_art: ASCIITextArt,
+      service_status: ServiceStatus,
+      uptime: Uptime,
+      ssl_certificates: SSLCertificates,
+      filesystems: Filesystems
+    }
+  end
+
   def create_config(file_path)
     default_config_path = File.join(File.dirname(__dir__), 'panda_motd', 'default_config.yaml')
     FileUtils.cp(default_config_path, file_path)

data/lib/panda_motd/default_config.yaml

@@ -1,23 +1,89 @@
+# The components section contains an ordered list of components you wish to
+# print in the MOTD. They will be printed in the order they are defined in
+# this file. Duplicate components will override previous definitions. Every
+# component has an "enabled" setting which will turn the component on or off.
+
 components:
-  ascii_text_art:
-    enabled: true
-    font: slant
-    color: red
-
-  service_status:
-    enabled: true
-    services:
-      chunkwm: chunkwm
-      skhd: skhd
-      elasticsearch@5.6: elasticsearch
-      mysql: MySQL
-
-  uptime:
-    enabled: true
-
-  # disk_info:
+  #####
+  # ASCII Text Art
+  #   Generates ASCII pictures of strings.
+  #
+  # Settings
+  #   font: The figlet font to render the text with. All supported fonts
+  #     can be found at http://www.figlet.org/fontdb.cgi
+  #   color: The color of the resulting text art. Supports the standard base-8
+  #     colors: black, red, green, yellow, blue, magenta, cyan, and white. You
+  #     can also use 'default' for your default terminal color. Additionally,
+  #     you can prefix any of the base colors with 'light_' to get the lighter
+  #     version.
+  #####
+
+  # ascii_text_art:
+  #   enabled: true
+  #   font: slant
+  #   color: red
+
+  #####
+  # Service Status
+  #   Displays the current state of services running on the system. Currently
+  #   only supports systemd.
+  #
+  # Settings
+  #   services: Pairs following the format "service_name: Pretty Name". The
+  #     service_name is the name of the systemd service to look for, NOT
+  #     including the '.service' suffix. The pretty name is the name that is
+  #     used in the MOTD to represent that service.
+  #####
+
+  # service_status:
+  #   enabled: true
+  #   services:
+  #     chunkwm: chunkwm
+  #     skhd: skhd
+  #     elasticsearch@5.6: elasticsearch
+  #     mysql: MySQL
+
+  #####
+  # Uptime
+  #   Displays the current uptime of the machine.
+  #
+  # Settings
+  #   prefix: The text to prepend to the uptime string.
+  #####
+
+  # uptime:
+  #   enabled: true
+  #   prefix: up
+
+  #####
+  # SSL Certificates
+  #   Displays the validity and expiration dates of SSL certificates.
+  #
+  # Settings
+  #   certs: Pairs following the format "PrettyName: absolute_cert_file_path".
+  #     The absolute_cert_file_path is the absolute file path of the SSL
+  #     certificate. The pretty name is the name that is used in the MOTD to
+  #     represent that certificate, typically a domain name.
+  #####
+
+  # ssl_certificates:
+  #   enabled: true
+  #   certs:
+  #     taylorjthurlow.com: /etc/letsencrypt/live/taylorjthurlow.com/cert.pem
+
+  #####
+  # Filesystems
+  #   Displays filesystem usage information.
+  #
+  # Settings
+  #   filesystems: Pairs following the format "filesystem_name: Pretty Name".
+  #     The filesystem_name is the name of the filesystem listed when using the
+  #     `df` command line tool. The pretty name is the name that is used in the
+  #     MOTD to represent that filesystem.
+  #####
+
+  # filesystems:
   #   enabled: true
-  #   disks:
-  #     /dev/disk3s1: Macintosh HD
-  #     /dev/disk0s4: Windows
-  #     /dev/disk2s2: Games
+  #   filesystems:
+  #     /dev/sda1: Ubuntu
+  #     /dev/sdc1: Data

data/lib/panda_motd/motd.rb

@@ -3,18 +3,19 @@ require 'sysinfo'
 class MOTD
   attr_reader :config, :components
 
-  def initialize
-    @config = Config.new
-
-    @components = []
-    @config.components_enabled.each do |component_class|
-      @components << component_class.new(self)
-    end
-
+  def initialize(config_path = nil)
+    @config = config_path ? Config.new(config_path) : Config.new
+    @components = @config.components_enabled.map { |ce| ce.new(self) }
     @components.each(&:process)
   end
 
   def to_s
-    return @components.map(&:to_s).join("\n\n")
+    return @components.map do |c|
+      if c.errors.any?
+        c.errors.map(&:to_s).join("\n")
+      else
+        c.to_s
+      end
+    end.join("\n\n")
   end
 end

data/lib/panda_motd/version.rb

@@ -1,4 +1,4 @@
 class PandaMOTD
   #:nodoc:
-  VERSION ||= '0.0.3'.freeze
+  VERSION ||= '0.0.4'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: panda-motd
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Taylor Thurlow
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-05 00:00:00.000000000 Z
+date: 2018-05-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: artii
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: ruby-units
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
 - !ruby/object:Gem::Dependency
   name: sysinfo
   requirement: !ruby/object:Gem::Requirement
@@ -173,9 +187,11 @@ extra_rdoc_files: []
 files:
 - bin/panda-motd
 - lib/panda_motd.rb
-- lib/panda_motd/component.rb
+- lib/panda_motd/component_error.rb
 - lib/panda_motd/components/ascii_text_art.rb
+- lib/panda_motd/components/filesystems.rb
 - lib/panda_motd/components/service_status.rb
+- lib/panda_motd/components/ssl_certificates.rb
 - lib/panda_motd/components/uptime.rb
 - lib/panda_motd/config.rb
 - lib/panda_motd/default_config.yaml