rubyipmi 0.10.0 → 0.11.0

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

@@ -1,7 +1,5 @@
 module Rubyipmi::Ipmitool
-
   class Fru < Rubyipmi::Ipmitool::BaseCommand
-
     attr_accessor :list
 
     DEFAULT_FRU = 'builtin_fru_device'
@@ -29,22 +27,20 @@ module Rubyipmi::Ipmitool
 
     # return the list of fru information in a hash
     def list
-      if @list.count < 1
-        parse(getfrus)
-      end
+      parse(getfrus) if @list.count < 1
       @list
     end
 
-  # method to retrieve the raw fru data
+    # method to retrieve the raw fru data
     def getfrus
       command
     end
 
-   private
+    private
 
     # I use method missing to allow the user to say Fru.<name> which returns a frudata object unless the user
     # passes a keyname from the default fru device
-    def method_missing(method, *args, &block)
+    def method_missing(method, *_args, &_block)
       name = method.to_s
       fru = list.fetch(name, nil)
       # if the user wanted some data from the default fru, lets show the data for the fru.  Otherwise
@@ -63,29 +59,27 @@ module Rubyipmi::Ipmitool
 
     # parse the fru information
     def parse(data)
-      if ! data.nil?
-        parsed_data = []
-        data.lines.each do |line|
-          if line =~ /^FRU.*/
-            # this is the either the first line of of the fru or another fru
-            if parsed_data.count != 0
-              # we have reached a new fru device so lets record the previous fru
-              new_fru = FruData.new(parsed_data)
-              parsed_data = []
-              @list[new_fru[:name]] = new_fru
-            end
-
+      return unless data
+      parsed_data = []
+      data.lines.each do |line|
+        if line =~ /^FRU.*/
+          # this is the either the first line of of the fru or another fru
+          if parsed_data.count != 0
+            # we have reached a new fru device so lets record the previous fru
+            new_fru = FruData.new(parsed_data)
+            parsed_data = []
+            @list[new_fru[:name]] = new_fru
           end
-          parsed_data << line
-        end
-        # process the last fru
-        if parsed_data.count != 0
-          # we have reached a new fru device so lets record the previous fru
-          new_fru = FruData.new(parsed_data)
-          parsed_data = []
-          @list[new_fru[:name]] = new_fru
+
         end
+        parsed_data << line
       end
+      # process the last fru
+      return if parsed_data.count == 0
+      # we have reached a new fru device so lets record the previous fru
+      new_fru = FruData.new(parsed_data)
+      parsed_data = []
+      @list[new_fru[:name]] = new_fru
     end
 
     # run the command and return result
@@ -93,15 +87,11 @@ module Rubyipmi::Ipmitool
       @options["cmdargs"] = "fru"
       value = runcmd
       @options.delete_notify("cmdargs")
-      if value
-        return @result
-      end
+      return @result if value
     end
-
   end
 
   class FruData < Hash
-
     def name
       self[:name]
     end
@@ -112,27 +102,24 @@ module Rubyipmi::Ipmitool
 
     # parse the fru information that should be an array of lines
     def parse(data)
-      if ! data.nil?
-        data.each do |line|
-          key, value = line.split(':', 2)
-          if key =~ /^FRU\s+Device.*/
-            if value =~ /([\w\s]*)\(.*\)/
-              self[:name] = $~[1].strip.gsub(/\ /, '_').downcase
-            end
-          else
-            key = key.strip.gsub(/\ /, '_').downcase
-            if ! value.nil?
-              self[key] = value.strip
-            end
+      return unless data
+      data.each do |line|
+        key, value = line.split(':', 2)
+        if key =~ /^FRU\s+Device.*/
+          if value =~ /([\w\s]*)\(.*\)/
+            self[:name] = $~[1].strip.gsub(/\ /, '_').downcase
           end
+        else
+          key = key.strip.gsub(/\ /, '_').downcase
+          self[key] = value.strip unless value.nil?
         end
       end
     end
 
     private
 
-    def method_missing(method, *args, &block)
-      self.fetch(method.to_s, nil)
+    def method_missing(method, *_args, &_block)
+      fetch(method.to_s, nil)
     end
   end
-end
+end

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

@@ -1,7 +1,5 @@
 module Rubyipmi::Ipmitool
-
   class Lan < Rubyipmi::Ipmitool::BaseCommand
-
     attr_accessor :info
     attr_accessor :channel
     MAX_RETRY = 1
@@ -10,7 +8,6 @@ module Rubyipmi::Ipmitool
       super("ipmitool", opts)
       @info = {}
       @channel = 2
-
     end
 
     # sets the info var to be empty causing the variable to repopulate upon the next call to info
@@ -33,7 +30,11 @@ module Rubyipmi::Ipmitool
           # wait for error to occur then retry using channel 1
           if retrycount < MAX_RETRY
             @channel = 1
+            retrycount = retrycount.next
             retry
+          else
+            # failed to fetch info, return cached info
+            @info
           end
         end
       else
@@ -43,81 +44,79 @@ module Rubyipmi::Ipmitool
     end
 
     def snmp
-      info.fetch("snmp_community_string",nil)
+      info.fetch("snmp_community_string", nil)
     end
 
     def ip
-      info.fetch("ip_address",nil)
+      info.fetch("ip_address", nil)
     end
 
     def mac
-      info.fetch("mac_address",nil)
+      info.fetch("mac_address", nil)
     end
 
     def netmask
-      info.fetch("subnet_mask",nil)
+      info.fetch("subnet_mask", nil)
     end
 
     def gateway
-      info.fetch("default_gateway_ip",nil)
+      info.fetch("default_gateway_ip", nil)
     end
 
     def vlanid
-      info.fetch("802.1q_vlan_id",nil)
+      info.fetch("802.1q_vlan_id", nil)
     end
 
-  #  def snmp=(community)
-  #    @options["cmdargs"] = "lan set #{channel} snmp #{community}"
-  #    value = runcmd
-  #    @options.delete_notify("cmdargs")
-  #    return value
-  #  end
+    #  def snmp=(community)
+    #    @options["cmdargs"] = "lan set #{channel} snmp #{community}"
+    #    value = runcmd
+    #    @options.delete_notify("cmdargs")
+    #    return value
+    #  end
 
     def ip=(address)
       @options["cmdargs"] = "lan set #{channel} ipaddr #{address}"
       value = runcmd
       @options.delete_notify("cmdargs")
-      return value
+      value
     end
 
     def netmask=(mask)
       @options["cmdargs"] = "lan set #{channel} netmask #{mask}"
       value = runcmd
       @options.delete_notify("cmdargs")
-      return value
+      value
     end
 
     def gateway=(address)
       @options["cmdargs"] = "lan set #{channel} defgw ipaddr #{address}"
       value = runcmd
       @options.delete_notify("cmdargs")
-      return value
+      value
     end
 
     def dhcp?
-      info.fetch("ip_address_source",nil).match(/dhcp/i) != nil
+      info.fetch("ip_address_source", nil).match(/dhcp/i) != nil
     end
 
     def static?
-      info.fetch("ip_address_source",nil).match(/static/i) != nil
+      info.fetch("ip_address_source", nil).match(/static/i) != nil
     end
 
     def vlanid=(vlan)
       @options["cmdargs"] = "lan set #{channel} vlan id #{vlan}"
       value = runcmd
       @options.delete_notify("cmdargs")
-      return value
+      value
     end
 
-   private
+    private
 
     def print
       @options["cmdargs"] = "lan print"
       value = runcmd
       @options.delete_notify("cmdargs")
-      if value
-        @result
-      end
+      @result if value
     end
 
     def parse(landata)
@@ -127,14 +126,12 @@ module Rubyipmi::Ipmitool
         key = normalize(item.first.strip)
         value = item.last.strip
         @info[key] = value
-
       end
-      return @info
+      @info
     end
 
     def normalize(text)
       text.gsub(/\ /, '_').gsub(/\./, '').downcase
     end
-
   end
 end

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

@@ -1,6 +1,8 @@
-module Rubyipmi::Ipmitool
+require 'rubyipmi/commands/mixins/power_mixin'
 
+module Rubyipmi::Ipmitool
   class Power < Rubyipmi::Ipmitool::BaseCommand
+    include Rubyipmi::PowerMixin
 
     def initialize(opts = ObservableHash.new)
       super("ipmitool", opts)
@@ -11,70 +13,17 @@ module Rubyipmi::Ipmitool
       @options["cmdargs"] = "power #{opt}"
       value = runcmd
       @options.delete_notify("cmdargs")
-      return value
-    end
-
-    # Turn on the system
-    def on
-      if on?
-        return true
-      else
-        command("on")
-      end
-    end
-
-    # Turn off the system
-    def off
-      if off?
-        return true
-      else
-        command("off")
-      end
+      value
     end
 
-    # Power cycle the system
-    def cycle
-      # if the system is off turn it on
-      if off?
-        on
-      else
-        command("cycle")
-      end
-
-    end
-
-    # Perform a power reset on the system
-    def reset
-      command("reset")
-    end
-
-    # Perform a soft shutdown, like briefly pushing the power button
-    def softShutdown
-      command("soft")
-    end
-
-    def powerInterrupt
+    def power_interrupt
       command("diag")
     end
 
     # Get the power status of the system, will show either on or off
     def status
       value = command("status")
-      if value
-        @result.match(/(off|on)/).to_s
-      end
+      @result.match(/(off|on)/).to_s if value
     end
-
-    # Test to see if the power is on
-    def on?
-      status == "on"
-
-    end
-
-    # Test to see if the power is off
-    def off?
-      status == "off"
-    end
-
   end
-end
+end

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

@@ -1,83 +1,25 @@
-module Rubyipmi::Ipmitool
+require 'rubyipmi/commands/mixins/sensors_mixin'
 
+module Rubyipmi::Ipmitool
   class Sensors < Rubyipmi::Ipmitool::BaseCommand
+    include Rubyipmi::SensorsMixin
 
     def initialize(opts = ObservableHash.new)
       super("ipmitool", 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["cmdargs"] = "sensor"
-      value = runcmd
+      runcmd
       options.delete_notify("cmdargs")
       @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
     def initialize(line)
       parse(line)
@@ -85,6 +27,7 @@ module Rubyipmi::Ipmitool
     end
 
     private
+
     def normalize(text)
       text.gsub(/\ /, '_').gsub(/\./, '').downcase
     end
@@ -93,17 +36,16 @@ module Rubyipmi::Ipmitool
     # Note: not all fields will exist on every server
     def parse(line)
       fields = [: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]
       # skip the header
       data = line.split(/\|/)
       # should we ever encounter a field not in the fields list, just use a counter based fieldname
       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/ipmitool/connection.rb

@@ -9,11 +9,14 @@ end
 
 module Rubyipmi
   module Ipmitool
-
     class Connection
-
       attr_accessor :options
 
+      DRIVERS_MAP = {
+        'lan15' => 'lan',
+        'lan20' => 'lanplus',
+        'open'  => 'open'
+      }
 
       def initialize(user, pass, host, opts)
         @options = Rubyipmi::ObservableHash.new
@@ -23,29 +26,17 @@ module Rubyipmi
         # So they are not required
         @options["U"] = user if user
         @options["P"] = pass if pass
-        if opts.has_key?(:privilege)
-          @options["L"] = opts[:privilege]
-        end
+        @options["L"] = opts[:privilege] if opts.key?(:privilege)
         # Note: rubyipmi should auto detect which driver to use so its unnecessary to specify the driver unless
         #  the user really wants to.
-        @options['I'] = drivers_map[opts[:driver]] unless drivers_map[opts[:driver]].nil?
+        @options['I'] = 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' => 'lanplus',
-          'open'  => 'open'
-        }
+        ! (bmc.info.nil? || bmc.info.empty?)
+      rescue
+        false
       end
 
       def fru

data/lib/rubyipmi/ipmitool/errorcodes.rb

@@ -1,67 +1,33 @@
 module Rubyipmi
   module Ipmitool
     class ErrorCodes
-
-      @@codes = {
-          "Authentication type NONE not supported\nAuthentication type NONE not supported\n" +
-              "Error: Unable to establish LAN session\nGet Device ID command failed\n" => {"I" => "lanplus"},
-         "Authentication type NONE not supported" => {"I" => "lanplus"},
-          "Error: Unable to establish LAN session\nGet Device ID command failed\n" => {"I" => "lanplus"}
-
-
+      CODES = {
+        "Authentication type NONE not supported\nAuthentication type NONE not supported\n" \
+        "Error: Unable to establish LAN session\nGet Device ID command failed\n" => {"I" => "lanplus"},
+        "Authentication type NONE not supported" => {"I" => "lanplus"},
+        "Error: Unable to establish LAN session\nGet Device ID command failed\n" => {"I" => "lanplus"}
       }
+
       def self.length
-        @@codes.length
+        CODES.length
       end
 
       def self.code
-        @@codes
+        CODES
       end
 
       def self.search(code)
-        fix = @@codes.fetch(code,nil)
+        fix = CODES.fetch(code, nil)
         if fix.nil?
-          @@codes.each do | error, result |
+          CODES.each do |error, result|
             # the error should be a subset of the actual erorr
-            if code =~ /.*#{error}.*/i
-              return result
-            end
+            return result if code =~ /.*#{error}.*/i
           end
         else
           return fix
         end
         raise "No Fix found" if fix.nil?
       end
-
-
-      def throwError
-        # Find out what kind of error is happening, parse results
-        # Check for authentication or connection issue
-
-        if @result =~ /timeout|timed\ out/
-          code = "ipmi call: #{@lastcall} timed out"
-          raise code
-        else
-          code = @result.split(":").last.chomp.strip if not @result.empty?
-        end
-        case code
-          when "invalid hostname"
-            raise code
-          when "password invalid"
-            raise code
-          when "username invalid"
-            raise code
-          else
-            raise :ipmierror, code
-        end
-      end
-
-
     end
-
-
-
-
   end
 end
-

data/lib/rubyipmi/observablehash.rb

@@ -15,6 +15,5 @@ module Rubyipmi
       delete(del)
       notify_observers(self)
     end
-
   end
-end
+end

data/lib/rubyipmi/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Rubyipmi
+  VERSION = '0.11.0'.freeze
+end