informo 1.0

data/README.md

@@ -0,0 +1,31 @@
+# Informo 
+
+A ruby gem for retrieving info from linux systems.
+
+## Installation
+
+clone this repo
+
+```
+$ gem build informo.gemspec
+$ gem install informo-1.0.gem
+```
+
+## Usage
+
+```
+require 'informo'
+```
+
+The following top level classes exist:
+
+- Informo::Bios
+- Informo::Dpkg
+- Informo::Memory
+- Informo::Network
+- Informo::Processor
+- Informo::Rpm
+- Informo::Storage
+- Informo::System
+
+

data/Rakefile

@@ -0,0 +1,8 @@
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+end
+
+desc "Run tests"
+task :default => :test

data/informo.gemspec

@@ -0,0 +1,12 @@
+$LOAD_PATH.unshift File.expand_path('../lib', __FILE__)
+require 'informo/version'
+
+Gem::Specification.new 'informo', Informo::VERSION do |s|
+  s.date	= '2013-05-03'
+  s.summary	= 'Linux info wrapped in a gem'
+  s.description	= 'Informo is used to gather information from your linux system'
+  s.files	= `git ls-files`.split("\n") - %w[]
+  s.author	= 'Rick Briganti'
+  s.email	= 'jeviolle@newaliases.org'
+  s.homepage	= 'http://github.com/jeviolle/informo'
+end

data/lib/informo.rb

@@ -0,0 +1,31 @@
+require 'informo/bios.rb'
+require 'informo/dpkg.rb'
+require 'informo/memory.rb'
+require 'informo/network.rb'
+require 'informo/processor.rb'
+require 'informo/rpm.rb'
+require 'informo/storage.rb'
+require 'informo/system.rb'
+require 'informo/version.rb'
+
+##
+# Informo make's it easy to get system information 
+# for Linux systems from inside ruby scripts. Currently it is 
+# a glorified wrapper around existing native commands and
+# tries to avoid reinventing wheels that already exist inside
+# GNU/Linux.
+#
+# The following classes are available:
+#
+# - Informo::Bios
+# - Informo::Dpkg
+# - Informo::Memory
+# - Informo::Network
+# - Informo::Processor
+# - Informo::Rpm
+# - Informo::Storage
+# - Informo::System
+#
+module Informo
+
+end

data/lib/informo/bios.rb

@@ -0,0 +1,30 @@
+module Informo
+  ##
+  # Allows for the retrieval of bios related information.
+  class Bios
+    ##
+    # returns the serial number as a string
+    def serial
+      serial = `dmidecode -s system-serial-number`.chomp
+      return serial
+    end
+    ##
+    # returns the bios vendor as a string
+    def vendor
+      vendor = `dmidecode -s system-product-name`.chomp
+      return vendor
+    end
+    ##
+    # returns the bios version as a string
+    def version
+      version = `dmidecode -s bios-version`.chomp
+      return version
+    end
+    ##
+    # returns the release date of the installed bios version as a string
+    def date
+      date = `dmidecode -s bios-release-date`.chomp
+      return date
+    end
+  end
+end

data/lib/informo/dpkg.rb

@@ -0,0 +1,81 @@
+require 'time'
+
+module Informo  
+  ##
+  # This class is used to return information about installed packages
+  # for systems utilizing debian/ubuntu package formats
+  class Dpkg
+    def initialize()
+      @@dpkgquery = "dpkg-query"
+      @@pkginfo = "/var/lib/dpkg/info"
+    end
+    ## 
+    # returns an array of package names that are/were installed
+    # as show via +dpkg-query+ command
+    def get_packages
+      packages = Array.new
+      packages = `#{@@dpkgquery} -W -f='${Package}\n'`.split("\n")
+      return packages
+    end
+    ##
+    # returns the version of the package specified as a string
+    def get_version(name)
+      package_version = `#{@@dpkgquery} -W -f='${Version}' #{name}`
+      return package_version
+    end
+    ##
+    # returns the architecture of the package specified as a string
+    def get_architecture(name)
+      package_architecture = `#{@@dpkgquery} -W -f='${Architecture}' #{name}`
+      return package_architecture
+    end
+    ##
+    # returns the package maintainer for the given package as a string
+    def get_maintainer(name)
+      package_maintainer = `#{@@dpkgquery} -W -f='${Maintainer}' #{name}`
+      return package_maintainer
+    end
+    ##
+    # returns a brief description of a given package as a string
+    def get_short_description(name)
+      package_description = `#{@@dpkgquery} -W -f='${Description}' #{name}`.split("\n")
+      return package_description[0]
+    end
+    ##
+    # returns the full, possibly lengthy, description for the specified package as a string
+    def get_description(name)
+      package_description = `#{@@dpkgquery} -W -f='${Description}' #{name}`
+      return package_description
+    end
+    ##
+    # returns the status for the package specified as a string
+    def get_status(name)
+      package_status = `#{@@dpkgquery} -W -f='${Status}' #{name}`
+      return package_status
+    end
+    ##
+    # returns the installation date of the given package 
+    def get_installdate(name)
+      create_time = Time.at(File.stat(@@pkginfo + "/#{name}.list")).ctime.utc
+      return create_time
+    end
+    ##
+    # returns the following information for a given package name as a hash
+    #
+    # - version
+    # - architecture
+    # - maintainer
+    # - description
+    # - status
+    def get_all(name)
+      results = `#{@@dpkgquery} -W -f='${Version}|||${Architecture}|||${Maintainer}|||${Description}|||${Status}' #{name}`.split('|||')
+  
+      # return results as an array and map
+      hresults = {'name' => name, 'version' => results[0],
+                  'architecture' => results[1], 'maintainer' => results[2],
+                  'description' => results[3], 'status' => results[4]}
+  
+      return hresults
+    end
+  end
+end

data/lib/informo/memory.rb

@@ -0,0 +1,77 @@
+module Informo  
+  ##
+  # This class is used to return various physical memory related information. For
+  # example: how many modules are installed, module size, etc
+  #
+  # For virtualized systems some of these might not be applicable
+  class Memory
+    ##
+    # returns the maximum size for memory modules
+    def max_module_size
+      `dmidecode -t 5`.each_line do |line|
+        if line =~ /Maximum Memory Module Size.+?(\d+)\s+/
+          max_module_size = $1
+          return max_module_size
+        end
+      end
+    end
+    ##
+    # returns the maximum amount of memory slots. 
+    def max_modules
+      `dmidecode -t 5`.each_line do |line|
+        if line =~ /Associated Memory Slots.+?(\d+)\s+/
+          max_modules = $1
+          return max_modules
+        end
+      end
+    end
+    ##
+    # returns the maximum amount of memory supported by the bios/system
+    def max_capacity
+      `dmidecode -t 5`.each_line do |line|
+        if line =~ /Maximum Total Memory Size.+?(\d+)\s+/
+          max_capacity = $1
+          return max_capacity
+        end
+      end
+    end
+    ##
+    # returns the amount of physical memory installed
+    def installed
+      `free -m`.each_line do |line|
+        if line =~ /^Mem.+?(\d+)\s+/
+          installed_memory = $1
+          return installed_memory
+        end
+      end
+    end
+  
+    ##
+    # returns details for memory installed in each memory slot
+    #
+    # - size
+    # - location on board
+    # - speed
+    # - form factor
+    def slots
+      count = -1
+      modules = Array.new
+  
+      `dmidecode -t 17`.each_line do |line|
+        if line =~ /\cI(Array Handle|Size|Locator|Speed|Form Factor):\s*(.*)$/
+          key, value = $1, $2
+          if key =~ /Array Handle/
+            count += 1
+            modules[count] = Hash.new
+          else
+            key = "type" if key =~ /Form Factor/
+            modules[count][key.downcase] = value
+          end
+        end
+      end
+  
+      return modules
+    end
+  
+  end
+end

data/lib/informo/network.rb

@@ -0,0 +1,73 @@
+module Informo
+  ##
+  # This class is used to provide information about the network configuration of the system
+  # and physical networking hardware available to the system.
+  class Network
+    ##
+    # returns an array of available network interfaces
+    def interfaces
+      interfaces = Array.new
+      if File.exists?("/sbin/ip")
+        `ip a`.each_line do |line|
+          interfaces.push($1) if line =~ /scope.+?\s(\w+\d+(:.+?)?)$/  
+        end
+      else
+        `ifconfig -a`.each_line do |line|
+          interfaces.push($1) if line =~ /^(\w+\d+(:.+?)?)\s+Link/
+        end
+      end
+  
+      return interfaces
+    end
+    ##
+    # returns hash of the following info for a given network interface
+    #
+    # - ip address
+    # - subnet mask
+    # - broadcast address
+    # - mtu
+    def interface_details(dev)
+      details = Hash.new
+      details["ip6"] = Array.new
+      count = -1 
+  
+      if File.exists?("/sbin/ip") 
+        `ip addr show #{dev}`.each_line do |line|
+          details["mtu"] = $1 if line =~ /mtu (\d+)/
+  
+          if line =~ /inet\s(\d+\.\d+\.\d+\.\d+)\/(\d+)\s+brd\s(\d+\.\d+\.\d+\.\d+)\sscope.+#{dev}$/
+            details["ipaddr"],details["prefix"],details["broadcast"] = $1, $2, $3 
+          end
+          
+          if dev != /:/
+            if line =~ /inet6\s(.+?)\/(\d+)\sscope/
+              count += 1
+              details["ip6"][count] = Hash.new
+              details["ip6"][count]["ipaddr"],details["ip6"][count]["prefix"] = $1, $2 
+            end
+          end
+        end
+      else
+        `ifconfig #{dev}`.each_line do |line|
+        end
+      end
+  
+      return details
+    end
+    ##
+    # returns an array of installed HBAs
+    def host_bus_adapters
+      list = Array.new
+  
+      `lspci`.each_line do |line|
+        if line =~ /fib|hba/i        
+          
+          list.push($1) if line =~ /.+?:\s+(.+)/ 
+        end
+      end
+  
+      return list
+    end
+  
+  end
+end

data/lib/informo/processor.rb

@@ -0,0 +1,45 @@
+module Informo  
+  ##
+  # This class is used to retrieve information about the processors available
+  # to the system.
+  class Processor
+    ##
+    # returns the total number of processors on the system
+    def count
+      total = 0
+      File.open("/proc/cpuinfo").each_line do |line|
+        total += 1 if line =~ /^processor/ 
+      end
+  
+      return total
+    end
+    ##
+    # returns the details of the processor(s) as an array with the following
+    # information
+    #
+    # - vendor (amd, intel, etc)
+    # - model (xeon, k9, etc)
+    # - speed (2000 Mhz, etc)
+    # - cache size (512k, etc)
+    def details
+      count = -1
+      processors = Array.new
+  
+      File.open("/proc/cpuinfo").each_line do |line|
+        
+        if line =~ /(processor|vendor_id|model name|cpu MHz|cache size)\s+:\s+(.+)/
+          key, value = $1, $2
+          if key =~ /processor/
+            count += 1
+            processors[count] = Hash.new
+          else
+            key = key.gsub(/\s+/,"_")
+            processors[count][key] = value
+          end
+        end
+      end 
+  
+      return processors
+    end
+  end
+end

data/lib/informo/rpm.rb

@@ -0,0 +1,85 @@
+require 'time'
+  
+module Informo
+  ##
+  # This class is used to get information about installed RPMs
+  class Rpm
+    def initialize()
+      @@rpmquery = "rpm"
+    end
+    ## 
+    # returns an array of installed package names
+    def get_packages
+      packages = Array.new
+      packages = `#{@@rpmquery} -qa --qf='%{NAME}\n'`.split("\n")
+      return packages
+    end
+    ##
+    # returns the version of the given package
+    def get_version(name)
+      package_version = `#{@@rpmquery} -q --qf='%{VERSION}' #{name}`
+      return package_version
+    end
+    ##
+    # returns the release of the given package
+    def get_release(name)
+      package_release = `#{@@rpmquery} -q --qf='%{RELEASE}' #{name}`
+      return package_release
+    end
+    ##
+    # returns the architecture of the given package
+    def get_architecture(name)
+      package_architecture = `#{@@rpmquery} -q --qf='%{ARCH}' #{name}`
+      return package_architecture
+    end
+    ##
+    # returns the maintainer of the given package
+    def get_maintainer(name)
+      package_maintainer = `#{@@rpmquery} -q --qf='%{VENDOR}' #{name}`
+      return package_maintainer
+    end
+    ##
+    # returns the +short+ description (ie: rpm summary field) of the given package
+    def get_short_description(name)
+      package_description = `#{@@rpmquery} -q --qf='%{SUMMARY}' #{name}`.split("\n")
+      return package_description[0]
+    end
+    ##
+    # returns the +full+ description of the given package
+    def get_description(name)
+      package_description = `#{@@rpmquery} -q --qf='%{DESCRIPTION}' #{name}`
+      return package_description
+    end
+    ##
+    # returns the installed date of the given package
+    def get_installdate(name)
+      package_status = Time.at(Time.parse(`#{@@rpmquery} -q --qf='%{INSTALLTIME:date}' #{name}`)).utc
+      return package_status
+    end
+    ##
+    # returns the status of the installed package (ie. nothing for RPM), kind of a placeholder I guess...
+    def get_status(name)
+      return 
+    end
+    ##
+    # returns a hash of details for the given package
+    #
+    # - version
+    # - release
+    # - architecture
+    # - maintainer
+    # - summary
+    # - description
+    # - install date
+    def get_all(name)
+      results = `#{@@rpmquery} -q --queryformat "%{VERSION}|||%{RELEASE}|||%{ARCH}|||%{VENDOR}|||%{SUMMARY}|||%{DESCRIPTION}|||%{INSTALLTIME:date}" #{name}`.split('|||')
+  
+      # return results as an array and map
+      hresults = {'name' => name, 'version' => results[0], 'release' => results[1],
+                  'architecture' => results[2], 'maintainer' => results[3], 'summary' => results[4],
+                  'description' => results[5], 'installdate' => results[6]}
+  
+      return hresults
+    end
+  end
+end