rubyipmi 0.10.0 → 0.11.0

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

@@ -1,14 +1,11 @@
 module Rubyipmi::Freeipmi
-
   class BmcConfig < Rubyipmi::Freeipmi::BaseCommand
-
     def initialize(opts = ObservableHash.new)
       super("bmc-config", opts)
       @sections = []
-
     end
 
-    def verbose(on=false)
+    def verbose(on = false)
       if on
         @options['verbose'] = false
       else
@@ -19,32 +16,29 @@ module Rubyipmi::Freeipmi
     def section(section)
       @options["checkout"] = false
       @options["section"] = section
-      value = runcmd
+      runcmd
       @options.delete_notify("checkout")
       @options.delete_notify("section")
-      return @result
+      @result
     end
 
     def setsection(section, key, value)
       keypair = "#{section}:#{key}=#{value}"
       @options["commit"] = false
-      if not keypair.empty?
+      unless keypair.empty?
         @options["key-pair"] = keypair
         value = runcmd
         @options.delete_notify("commit")
         @options.delete_notify("key-pair")
         return value
       end
-      return false
+      false
     end
 
-
     # returns the entire bmc-config configuration, can take a while to execute
     def configuration
-      require 'pry'
-      binding.pry
       @options["checkout"] = false
-      value = runcmd
+      runcmd
       @options.delete_notify("checkout")
       @result
     end
@@ -55,13 +49,9 @@ module Rubyipmi::Freeipmi
         @options["listsections"] = false
         value = runcmd
         @options.delete_notify("listsections")
-        if value
-          @sections = @result.split(/\n/)
-        end
+        @sections = @result.split(/\n/) if value
       end
       @sections
     end
-
-
   end
 end

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

@@ -1,7 +1,5 @@
 module Rubyipmi::Freeipmi
-
   class BmcDevice < Rubyipmi::Freeipmi::BaseCommand
-
     def initialize(opts = ObservableHash.new)
       super("bmc-device", opts)
     end
@@ -11,11 +9,11 @@ module Rubyipmi::Freeipmi
       @options[opt] = false
       value = runcmd
       @options.delete_notify(opt)
-      return value
+      value
     end
 
     # reset the bmc device, useful for debugging and troubleshooting
-    def reset(type='cold')
+    def reset(type = 'cold')
       if ['cold', 'warm'].include?(type)
         key = "#{type}-reset"
         command(key)
@@ -24,10 +22,5 @@ module Rubyipmi::Freeipmi
         raise "reset type: #{type} is not a valid choice, use warm or cold"
       end
     end
-
-
-
   end
-
-
 end

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

@@ -1,29 +1,25 @@
 module Rubyipmi::Freeipmi
-
   class BmcInfo < Rubyipmi::Freeipmi::BaseCommand
-
     def initialize(opts = ObservableHash.new)
       super("bmc-info", opts)
-
     end
 
     def guid
       options["get-device-guid"] = false
       status = runcmd
       options.delete_notify("get-device-guid")
-      if not status
+      if !status
         raise @result
       else
         @result.chomp.strip
       end
-
     end
 
     def retrieve
       bmcinfo = {}
       status = runcmd
       subkey = nil
-      if not status
+      if !status
         raise @result
       else
         @result.lines.each do |line|
@@ -32,10 +28,10 @@ module Rubyipmi::Freeipmi
           key = item.first.strip
           value = item.last.strip
           # if the following condition is met we have subvalues
-          if key == value and not subkey
+          if key == value && !subkey
             subkey = key
             bmcinfo[subkey] = []
-          elsif key == value and subkey
+          elsif key == value && subkey
             # subvalue found
             bmcinfo[subkey] << value.gsub(/\[|\]/, "")
           else
@@ -49,5 +45,3 @@ module Rubyipmi::Freeipmi
     end
   end
 end
-
-

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

@@ -1,14 +1,11 @@
 module Rubyipmi::Freeipmi
-
   class Chassis < Rubyipmi::Freeipmi::BaseCommand
-
     def initialize(opts = ObservableHash.new)
       super("ipmi-chassis", opts)
-
     end
 
     # Turn the led light on / off or with a delay
-    def identify(status=false, delay=0)
+    def identify(status = false, delay = 0)
       if status
         if delay <= 0
           options["chassis-identify"] = "FORCE"
@@ -21,7 +18,7 @@ module Rubyipmi::Freeipmi
       # Run the command
       value = runcmd
       options.delete_notify("chassis-identify")
-      return value
+      value
     end
 
     # Access to the power command created on the fly
@@ -35,80 +32,67 @@ module Rubyipmi::Freeipmi
     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 bootstatus
-          power.cycle
-        end
-
+        power.cycle if reboot && bootstatus
       else
-        logger.error("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.error("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
     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
+      power.cycle if reboot && 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
-
+      power.cycle if reboot && 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
+      power.cycle if reboot && 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
+      power.cycle if reboot && bootstatus
     end
 
     def status
-       options["get-status"] = false
-       value = runcmd
-       options.delete_notify("get-status")
-       if value
-         return parsestatus
-       else
-         return value
-       end
-
+      options["get-status"] = false
+      value = runcmd
+      options.delete_notify("get-status")
+      if value
+        return parsestatus
+      else
+        return value
+      end
     end
 
     # A currently unsupported method to retrieve the led status
     def identifystatus
-      # TODO implement this function
+      # TODO: implement this function
       # parse out the identify status
-     # status.result
+      # status.result
     end
 
     private
+
     def parsestatus
       statusresult = @result
       statusvalues = {}
-      subkey = nil
       statusresult.lines.each do |line|
         # clean up the data from spaces
         item = line.split(':')
@@ -116,9 +100,7 @@ module Rubyipmi::Freeipmi
         value = item.last.strip
         statusvalues[key] = value
       end
-      return statusvalues
+      statusvalues
     end
-
-
   end
-end
+end

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

@@ -1,10 +1,7 @@
 module Rubyipmi::Freeipmi
-
   class ChassisConfig < Rubyipmi::Freeipmi::BaseCommand
-
     def initialize(opts = ObservableHash.new)
       super("ipmi-chassis-config", opts)
-
     end
 
     # This is the raw command to send a new configuration to the ipmi device
@@ -12,45 +9,33 @@ module Rubyipmi::Freeipmi
       @options["commit"] = false
       value = runcmd
       @options.delete_notify("commit")
-      return value
+      value
     end
 
     # This is the raw command to get the entire ipmi chassis configuration
     # If you pass in a section you will get just the section
-    def checkout(section=nil)
+    def checkout(section = nil)
       @options["checkout"] = false
-      if section
-        @options["section"] = section
-      end
+      @options["section"] = section if section
       value = runcmd
       @options.delete_notify("checkout")
-      if section
-        @options.delete_notify("section")
-      end
-      return value
-    end
-
-    def bootdevice
-      value = checkout("Chassis_Boot_Flags")
-      if value
-        # TODO parse result to return current boot device
-        #@result
-      end
+      @options.delete_notify("section") if section
+      value
     end
 
     def bootdevice(device, persistent)
-      setBootFlag("Boot_Device", device,persistent)
+      set_boot_flag("Boot_Device", device, persistent)
     end
 
     def bootdevices
       # freeipmi returns a list of supported devices
       # However, for now we will just assume the following
       ["PXE", "HARD-DRIVE", "CD-DVD", "BIOS-SETUP"]
-      # TODO return array of possible boot devices
+      # TODO: return array of possible boot devices
     end
 
     def bootpersistent(value)
-      # TODO find out if we can specify multiple key-pair values
+      # TODO: find out if we can specify multiple key-pair values
       if value == true
         flag = "Chassis_Boot_Flags:Boot_Flags_Persistent=Yes"
       else
@@ -59,40 +44,40 @@ module Rubyipmi::Freeipmi
       @options["key-pair"] = "\"#{flag}\""
       value = commit
       @options.delete_notify("key-pair")
-      return value
+      value
     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("HARD-DRIVE",persistent)
+    def bootdisk(persistent = true)
+      bootdevice("HARD-DRIVE", persistent)
     end
 
     # shortcut to set boot device to cdrom
-    def bootcdrom(persistent=true)
-      bootdevice("CD-DVD",persistent)
+    def bootcdrom(persistent = true)
+      bootdevice("CD-DVD", persistent)
     end
 
     # shortcut to boot into bios setup
-    def bootbios(persistent=true)
-      bootdevice("BIOS-SETUP",persistent)
+    def bootbios(persistent = true)
+      bootdevice("BIOS-SETUP", persistent)
     end
 
     private
 
-    def setBootFlag(key,flag, persistent)
+    def set_boot_flag(key, flag, _persistent)
       @options["key-pair"] = "\"Chassis_Boot_Flags:#{key}=#{flag}\""
       value = commit
       @options.delete_notify("key-pair")
-      return value
+      value
     end
   end
 
-   ## Possible values: NO-OVERRIDE/PXE/HARD-DRIVE/HARD-DRIVE-SAFE-MODE/
-   ##                  DIAGNOSTIC_PARTITION/CD-DVD/BIOS-SETUP/REMOTE-FLOPPY
-   ##                  PRIMARY-REMOTE-MEDIA/REMOTE-CD-DVD/REMOTE-HARD-DRIVE/FLOPPY
-end
+  ## Possible values: NO-OVERRIDE/PXE/HARD-DRIVE/HARD-DRIVE-SAFE-MODE/
+  ##                  DIAGNOSTIC_PARTITION/CD-DVD/BIOS-SETUP/REMOTE-FLOPPY
+  ##                  PRIMARY-REMOTE-MEDIA/REMOTE-CD-DVD/REMOTE-HARD-DRIVE/FLOPPY
+end

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

@@ -1,24 +1,17 @@
 module Rubyipmi::Freeipmi
-
   class Fru < Rubyipmi::Freeipmi::BaseCommand
-
     attr_accessor :list
 
     DEFAULT_FRU = 'default_fru_device'
 
     def initialize(opts = ObservableHash.new)
-        super("ipmi-fru", opts)
-        @list = {}
+      super("ipmi-fru", opts)
+      @list = {}
     end
 
     def get_from_list(key)
-      if list.has_key?(DEFAULT_FRU)
-        if list[DEFAULT_FRU].has_key?(key)
-           list[DEFAULT_FRU][key]
-         else
-           nil
-         end
-      end
+      return unless list.key?(DEFAULT_FRU)
+      list[DEFAULT_FRU][key] if list[DEFAULT_FRU].key?(key)
     end
 
     def manufacturer
@@ -40,7 +33,7 @@ module Rubyipmi::Freeipmi
     # method to retrieve the raw fru data
     def getfrus
       command
-      return @result
+      @result
     end
 
     def names
@@ -49,15 +42,13 @@ module Rubyipmi::Freeipmi
 
     # 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
 
     private
 
-    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
@@ -76,7 +67,7 @@ module Rubyipmi::Freeipmi
 
     # parse the fru information
     def parse(data)
-      if ! data.nil? and ! data.empty?
+      if !data.nil? && !data.empty?
         parsed_data = []
         data.lines.each do |line|
           if line =~ /^FRU.*/
@@ -87,7 +78,6 @@ module Rubyipmi::Freeipmi
               parsed_data = []
               @list[new_fru[:name]] = new_fru
             end
-
           end
           parsed_data << line
         end
@@ -99,21 +89,17 @@ module Rubyipmi::Freeipmi
           @list[new_fru[:name]] = new_fru
         end
       end
-      return @list
+      @list
     end
 
     # run the command and return result
     def command
-       value = runcmd
-       if value
-         return @result
-       end
+      value = runcmd
+      return @result if value
     end
-
   end
 
   class FruData < Hash
-
     def name
       self[:name]
     end
@@ -124,29 +110,24 @@ module Rubyipmi::Freeipmi
 
     # 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.*/
-            if value =~ /([\w\s]*)\(.*\)/
-              self[:name] = $~[1].strip.gsub(/\ /, '_').downcase
-            end
-          else
-            key = key.strip.gsub(/\ /, '_').downcase.gsub(/fru_/, '')
-            if ! value.nil?
-              self[key] = value.strip
-
-            end
+      return unless data
+      data.each do |line|
+        key, value = line.split(':', 2)
+        if key =~ /^FRU.*/
+          if value =~ /([\w\s]*)\(.*\)/
+            self[:name] = $~[1].strip.gsub(/\ /, '_').downcase
           end
+        else
+          key = key.strip.gsub(/\ /, '_').downcase.gsub(/fru_/, '')
+          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/freeipmi/commands/lan.rb

@@ -1,7 +1,5 @@
 module Rubyipmi::Freeipmi
-
   class Lan
-
     attr_accessor :info
     attr_accessor :channel
     attr_accessor :config
@@ -22,11 +20,11 @@ module Rubyipmi::Freeipmi
     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 ip
@@ -87,7 +85,7 @@ module Rubyipmi::Freeipmi
     #  end
 
     def parse(landata)
-      if ! landata.nil? and ! landata.empty?
+      if !landata.nil? && !landata.empty?
         landata.lines.each do |line|
           # clean up the data from spaces
           next if line.match(/#+/)
@@ -102,4 +100,4 @@ module Rubyipmi::Freeipmi
       @info
     end
   end
-end
+end

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

@@ -1,5 +1,8 @@
+require 'rubyipmi/commands/mixins/power_mixin'
+
 module Rubyipmi::Freeipmi
   class Power < Rubyipmi::Freeipmi::BaseCommand
+    include Rubyipmi::PowerMixin
 
     def initialize(opts = ObservableHash.new)
       super("ipmipower", opts)
@@ -8,65 +11,19 @@ module Rubyipmi::Freeipmi
     # The command function is a wrapper that actually calls the run method
     def command(opt)
       @options[opt] = false
-      value = runcmd
+      runcmd
       @options.delete_notify(opt)
-      return @result
-    end
-
-    # Turn on the system
-    def on
-      command("on")
-    end
-
-    # Turn off the system
-    def off
-      command("off")
-    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")
+      @result
     end
 
-    # Perform a soft shutdown, like briefly pushing the power button
-    def softShutdown
-      command("soft")
-    end
-
-    def powerInterrupt
+    def power_interrupt
       command("pulse")
     end
 
     # Get the power status of the system, will show either on or off
     def status
       value = command("stat")
-      if value
-        @result.split(":").last.chomp.strip
-      end
+      @result.split(":").last.chomp.strip 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