rubyipmi 0.10.0 → 0.11.0

data/lib/rubyipmi/freeipmi/commands/sensors.rb

@@ -1,85 +1,27 @@
-module Rubyipmi::Freeipmi
+require 'rubyipmi/commands/mixins/sensors_mixin'
 
+module Rubyipmi::Freeipmi
   class Sensors < Rubyipmi::Freeipmi::BaseCommand
+    include Rubyipmi::SensorsMixin
 
     def initialize(opts = ObservableHash.new)
       super("ipmi-sensors", opts)
     end
 
-    def refresh
-      @sensors = nil
-      list
-    end
-
-    def list
-      @sensors ||= parse(getsensors)
-    end
-
-    def count
-      list.count
-    end
-
-    def names
-      list.keys
-    end
-
-    # returns a hash of fan sensors where the key is fan name and value is the sensor
-    def fanlist(refreshdata=false)
-      refresh if refreshdata
-      flist = {}
-      list.each do | name,sensor |
-        if name =~ /.*fan.*/
-          flist[name] = sensor
-        end
-      end
-      return flist
-    end
-
-    # returns a hash of sensors where each key is the name of the sensor and the value is the sensor
-    def templist(refreshdata=false)
-      refresh if refreshdata
-      tlist = {}
-      list.each do | name , sensor |
-        if sensor[:unit] =~ /.*degree.*/ || name =~ /.*temp.*/
-          tlist[name] = sensor
-        end
-      end
-      return tlist
-    end
-
     def getsensors
       @options["no-header-output"] = false
       @options["output-sensor-state"] = false
       @options["entity-sensor-names"] = false
-      value = runcmd
+      runcmd
       @options.delete_notify('no-header-output')
       @options.delete_notify('output-sensor-state')
       @options.delete_notify('entity-sensor-names')
       @result
     end
 
-    private
-
-    def method_missing(method, *args, &block)
-      if not list.has_key?(method.to_s)
-        raise NoMethodError
-      else
-        list[method.to_s]
-      end
-    end
-
-    def parse(data)
-      sensorlist = {}
-      if ! data.nil?
-        data.lines.each do | line|
-          # skip the header
-          sensor = Sensor.new(line)
-          sensorlist[sensor[:name]] = sensor
-        end
-      end
-      return sensorlist
+    def sensor_class
+      Sensor
     end
-
   end
 
   class Sensor < Hash
@@ -89,6 +31,7 @@ module Rubyipmi::Freeipmi
     end
 
     private
+
     def normalize(text)
       text.gsub(/\ /, '_').gsub(/\./, '').downcase
     end
@@ -97,16 +40,16 @@ module Rubyipmi::Freeipmi
     # Note: not all fields will exist on every server
     def parse(line)
       fields = [:id_num, :name, :value, :unit, :status, :type, :state, :lower_nonrec,
-                :lower_crit,:lower_noncrit, :upper_crit, :upper_nonrec, :asserts_enabled, :deasserts_enabled  ]
+                :lower_crit, :lower_noncrit, :upper_crit, :upper_nonrec, :asserts_enabled, :deasserts_enabled]
       data = line.split(/\|/)
       # should we ever encounter a field not in the fields list, just use a counter based fieldname so we just
       # use field1, field2, field3, ...
       i = 0
-      data.each do | value |
+      data.each do |value|
         field ||= fields.shift || "field#{i}"
         self[field] = value.strip
         i = i.next
       end
     end
   end
-end
+end

data/lib/rubyipmi/freeipmi/connection.rb

@@ -6,11 +6,18 @@ require 'rubyipmi/freeipmi/commands/basecommand'
 Dir[File.dirname(__FILE__) + '/commands/*.rb'].each do |file|
   require file
 end
+
 module Rubyipmi
   module Freeipmi
     class Connection
       attr_accessor :options
 
+      DRIVERS_MAP = {
+        'lan15' => 'LAN',
+        'lan20' => 'LAN_2_0',
+        'open'  => 'OPENIPMI'
+      }
+
       def initialize(user, pass, host, opts)
         @options = Rubyipmi::ObservableHash.new
         raise("Must provide a host to connect to") unless host
@@ -19,29 +26,19 @@ module Rubyipmi
         # So they are not required
         @options["username"] = user if user
         @options["password"] = pass if pass
-        if opts.has_key?(:privilege)
-          @options["privilege-level"] = opts[:privilege]        # privilege type
+        if opts.key?(:privilege)
+          @options["privilege-level"] = opts[:privilege] # privilege type
         end
         # Note: rubyipmi should auto detect which driver to use so its unnecessary to specify the driver unless
         #       the user really wants to
-        @options['driver-type'] = drivers_map[opts[:driver]] unless drivers_map[opts[:driver]].nil?
+        @options['driver-type'] = DRIVERS_MAP[opts[:driver]] unless DRIVERS_MAP[opts[:driver]].nil?
       end
 
       # test the connection to ensure we can at least make a single call
       def connection_works?
-        begin
-          ! (bmc.info.nil? || bmc.info.empty? )
-        rescue
-          false
-        end
-      end
-
-      def drivers_map
-        {
-          'lan15' => 'LAN',
-          'lan20' => 'LAN_2_0',
-          'open'  => 'OPENIPMI'
-        }
+        ! (bmc.info.nil? || bmc.info.empty?)
+      rescue
+        false
       end
 
       def provider
@@ -75,4 +72,4 @@ module Rubyipmi
       end
     end
   end
-end
+end

data/lib/rubyipmi/freeipmi/errorcodes.rb

@@ -1,37 +1,31 @@
 module Rubyipmi::Freeipmi
-
   class ErrorCodes
-
-    @@codes = {
-        "authentication type unavailable for attempted privilege level" => {"driver-type" => "LAN_2_0"},
-        "authentication type unavailable for attempted privilege level\n" => {"driver-type" => "LAN_2_0"},
+    CODES = {
+      "authentication type unavailable for attempted privilege level" => {"driver-type" => "LAN_2_0"},
+      "authentication type unavailable for attempted privilege level\n" => {"driver-type" => "LAN_2_0"}
     }
 
     def self.length
-      @@codes.length
+      CODES.length
     end
 
     def self.code
-       @@codes
+      CODES
     end
 
     def self.search(code)
       # example error code:
       # "/usr/local/sbin/bmc-info: authentication type unavailable for attempted privilege level\n"
-      code.chomp!  # clean up newline
-      code = code.split(':').last.strip  # clean up left hand side and strip white space from sides
-      fix = @@codes.fetch(code,nil)
+      code.chomp! # clean up newline
+      code = code.split(':').last.strip # clean up left hand side and strip white space from sides
+      fix = CODES.fetch(code, nil)
       if fix.nil?
-        @@codes.each do | error, result |
-          if code =~ /.*#{error}.*/i
-            fix = result
-          end
+        CODES.each do |error, result|
+          fix = result if code =~ /.*#{error}.*/i
         end
       end
       raise "No Fix found" if fix.nil?
-      return fix
+      fix
     end
-
   end
-
 end

data/lib/rubyipmi/ipmitool/commands/basecommand.rb

@@ -1,13 +1,11 @@
 require 'rubyipmi/ipmitool/errorcodes'
 
 module Rubyipmi::Ipmitool
-
   class BaseCommand < Rubyipmi::BaseCommand
-
     def setpass
       super
       @options["f"] = @passfile.path
-      @passfile.write "#{@options["P"]}"
+      @passfile.write "#{@options['P']}"
       @passfile.rewind
       @passfile.close
     end
@@ -19,7 +17,7 @@ module Rubyipmi::Ipmitool
     def makecommand
       args = ''
       # need to format the options to ipmitool format
-      @options.each do  |k,v|
+      @options.each do |k, v|
         # must remove from command line as its handled via conf file
         next if k == "P"
         next if k == "cmdargs"
@@ -27,26 +25,24 @@ module Rubyipmi::Ipmitool
       end
 
       # since ipmitool requires commands to be in specific order
-
       args << ' ' + options.fetch('cmdargs', '')
 
-      return "#{cmd} #{args.lstrip}"
+      "#{cmd} #{args.lstrip}"
     end
 
     # The findfix method acts like a recursive method and applies fixes defined in the errorcodes
     # If a fix is found it is applied to the options hash, and then the last run command is retried
     # until all the fixes are exhausted or a error not defined in the errorcodes is found
     def find_fix(result)
-      if result
-        # The errorcode code hash contains the fix
-        begin
-          fix = ErrorCodes.search(result)
-          @options.merge_notify!(fix)
-
-        rescue
-          raise "Could not find fix for error code: \n#{result}"
-        end
+      return unless result
+      # The errorcode code hash contains the fix
+      begin
+        fix = ErrorCodes.search(result)
+        @options.merge_notify!(fix)
+
+      rescue
+        raise "Could not find fix for error code: \n#{result}"
       end
     end
   end
-end
+end

data/lib/rubyipmi/ipmitool/commands/bmc.rb

@@ -1,7 +1,5 @@
 module Rubyipmi::Ipmitool
-
   class Bmc < Rubyipmi::Ipmitool::BaseCommand
-
     attr_accessor :config
 
     def initialize(opts = ObservableHash.new)
@@ -23,38 +21,33 @@ module Rubyipmi::Ipmitool
 
     def version
       @options['V'] = nil
-      value = runcmd
+      runcmd
       @options.delete_notify('V')
       @result.slice(/\d\.\d.\d/)
     end
 
     # reset the bmc device, useful for troubleshooting
-    def reset(type='cold')
+    def reset(type = 'cold')
       if ['cold', 'warm'].include?(type)
-         @options["cmdargs"] = "bmc reset #{type}"
-         value = runcmd()
-         @options.delete_notify("cmdargs")
-         return value
+        @options["cmdargs"] = "bmc reset #{type}"
+        value = runcmd
+        @options.delete_notify("cmdargs")
+        return value
       else
         logger.error("reset type: #{type} is not a valid choice, use warm or cold") if logger
         raise "reset type: #{type} is not a valid choice, use warm or cold"
       end
-
     end
 
     def guid
       @options["cmdargs"] = "bmc guid"
-      value = runcmd()
+      value = runcmd
       @options.delete_notify("cmdargs")
-      if value
-        @result.lines.each { | line |
-          line.chomp
-          if line =~ /GUID/
-            line.split(":").last.strip
-          end
-        }
+      return unless value
+      @result.lines.each do |line|
+        line.chomp
+        line.split(":").last.strip if line =~ /GUID/
       end
-
     end
 
     # This function will get the bmcinfo and return a hash of each item in the info
@@ -63,7 +56,7 @@ module Rubyipmi::Ipmitool
       status = runcmd
       @options.delete_notify("cmdargs")
       subkey = nil
-      if not status
+      if !status
         raise @result
       else
         @result.lines.each do |line|
@@ -75,7 +68,7 @@ module Rubyipmi::Ipmitool
           if value.empty?
             subkey = key
             @bmcinfo[subkey] = []
-          elsif key == value and subkey
+          elsif key == value && subkey
             # subvalue found
             @bmcinfo[subkey] << value
           else
@@ -87,7 +80,5 @@ module Rubyipmi::Ipmitool
         return @bmcinfo
       end
     end
-
-
   end
 end

data/lib/rubyipmi/ipmitool/commands/chassis.rb

@@ -1,17 +1,14 @@
 module Rubyipmi::Ipmitool
-
   class Chassis < Rubyipmi::Ipmitool::BaseCommand
-
     def initialize(opts = ObservableHash.new)
       super("ipmitool", opts)
-
     end
 
     # Turn the led light on / off or with a delay
     # status means to enable or disable the blinking
-    def identify(status=false, delay=0)
+    def identify(status = false, delay = 0)
       if status
-        if not delay.between?(1,255)
+        if !delay.between?(1, 255)
           options["cmdargs"] = "chassis identify 255"
         else
           options["cmdargs"] = "chassis identify #{delay}"
@@ -22,7 +19,7 @@ module Rubyipmi::Ipmitool
       # Run the command
       value = runcmd
       options.delete_notify("cmdargs")
-      return value
+      value
     end
 
     # Access to the power command created on the fly
@@ -36,65 +33,54 @@ module Rubyipmi::Ipmitool
     end
 
     # set boot device from given boot device
-    def bootdevice(device, reboot=false,persistent=false)
+    def bootdevice(device, reboot = false, persistent = false)
       if config.bootdevices.include?(device)
         bootstatus = config.bootdevice(device, persistent)
-        if reboot and status
-          power.cycle
-        end
-
+        power.cycle if reboot && status
       else
-        logger.debug("Device with name: #{device} is not a valid boot device for host #{options["hostname"]}") if logger
-        raise "Device with name: #{device} is not a valid boot device for host #{options["hostname"]}"
+        logger.debug("Device with name: #{device} is not a valid boot device for host #{options['hostname']}") if logger
+        raise "Device with name: #{device} is not a valid boot device for host #{options['hostname']}"
       end
-      return bootstatus
+      bootstatus
     end
 
     # set boot device to pxe with option to reboot
-    def bootpxe(reboot=false,persistent=false)
+    def bootpxe(reboot = false, persistent = false)
       bootstatus = config.bootpxe(persistent)
       # Only reboot if setting the boot flag was successful
-      if reboot and bootstatus
-        power.cycle
-      end
-      return bootstatus
+      power.cycle if reboot && bootstatus
+      bootstatus
     end
 
     # set boot device to disk with option to reboot
-    def bootdisk(reboot=false,persistent=false)
+    def bootdisk(reboot = false, persistent = false)
       bootstatus = config.bootdisk(persistent)
       # Only reboot if setting the boot flag was successful
-      if reboot and bootstatus
-        power.cycle
-      end
-      return bootstatus
+      power.cycle if reboot && bootstatus
+      bootstatus
     end
 
     # set boot device to cdrom with option to reboot
-    def bootcdrom(reboot=false,persistent=false)
+    def bootcdrom(reboot = false, persistent = false)
       bootstatus = config.bootcdrom(persistent)
       # Only reboot if setting the boot flag was successful
-      if reboot and bootstatus
-        power.cycle
-      end
-      return bootstatus
+      power.cycle if reboot && bootstatus
+      bootstatus
     end
 
     # boot into bios setup with option to reboot
-    def bootbios(reboot=false,persistent=false)
+    def bootbios(reboot = false, persistent = false)
       bootstatus = config.bootbios(persistent)
       # Only reboot if setting the boot flag was successful
-      if reboot and bootstatus
-        power.cycle
-      end
-      return bootstatus
+      power.cycle if reboot && bootstatus
+      bootstatus
     end
 
     def status
-       options["cmdargs"] = "chassis status"
-       value = runcmd
-       options.delete_notify("cmdargs")
-       return { :result => @result, :value => value }
+      options["cmdargs"] = "chassis status"
+      value = runcmd
+      options.delete_notify("cmdargs")
+      {:result => @result, :value => value}
     end
 
     # A currently unsupported method to retrieve the led status
@@ -102,11 +88,7 @@ module Rubyipmi::Ipmitool
       options["cmdargs"] = "chassis identify status"
       value = runcmd
       options.delete_notify("cmdargs")
-      if value
-        @result.chomp.split(":").last.strip
-      end
+      @result.chomp.split(":").last.strip if value
     end
-
-
   end
-end
+end

data/lib/rubyipmi/ipmitool/commands/chassisconfig.rb

@@ -1,20 +1,11 @@
 module Rubyipmi::Ipmitool
-
   class ChassisConfig < Rubyipmi::Ipmitool::BaseCommand
-
     def initialize(opts = ObservableHash.new)
       super("ipmitool", opts)
-
-    end
-
-    # Get the current boot device
-    def bootdevice
-       # Not available with ipmitool
-       false
     end
 
     # Set the boot device
-    def bootdevice(device, persistent=false)
+    def bootdevice(device, persistent = false)
       if persistent
         @options["cmdargs"] = "chassis bootdev #{device}"
       else
@@ -22,7 +13,7 @@ module Rubyipmi::Ipmitool
       end
       value = runcmd
       @options.delete_notify("cmdargs")
-      return value
+      value
     end
 
     # Get list of available boot devices
@@ -33,24 +24,23 @@ module Rubyipmi::Ipmitool
     end
 
     # shortcut to set boot device to pxe
-    def bootpxe(persistent=true)
-      bootdevice("pxe",persistent)
+    def bootpxe(persistent = true)
+      bootdevice("pxe", persistent)
     end
 
     # shortcut to set boot device to disk
-    def bootdisk(persistent=true)
-      bootdevice("disk",persistent)
+    def bootdisk(persistent = true)
+      bootdevice("disk", persistent)
     end
 
     # shortcut to set boot device to cdrom
-    def bootcdrom(persistent=true)
-      bootdevice("cdrom",persistent)
+    def bootcdrom(persistent = true)
+      bootdevice("cdrom", persistent)
     end
 
     # shortcut to boot into bios setup
-    def bootbios(persistent=true)
-      bootdevice("bios",persistent)
+    def bootbios(persistent = true)
+      bootdevice("bios", persistent)
     end
-
   end
-end
+end