rubyipmi 0.9.2 → 0.11.1

data/lib/rubyipmi.rb

@@ -16,16 +16,15 @@
 #     USA
 #
 
-
 require 'rubyipmi/ipmitool/connection'
 require 'rubyipmi/freeipmi/connection'
 require 'logger'
 
 class NullLogger < Logger
-  def initialize(*args)
+  def initialize(*_args)
   end
 
-  def add(*args, &block)
+  def add(*_args, &_block)
   end
 end
 
@@ -51,7 +50,7 @@ module Rubyipmi
   def self.logger
     # by default the log will be set to info
     unless @logger
-      if @log_level and @log_level >= 0
+      if @log_level && @log_level >= 0
         @logger = Logger.new('/tmp/rubyipmi.log')
         @logger.progname = 'Rubyipmi'
         @logger.level = @log_level
@@ -73,23 +72,31 @@ module Rubyipmi
   # If provider is left blank the function will use the first available provider
   # When the driver is set to auto, rubyipmi will try and figure out which driver to use by common error messages.  We will most likely be using
   # the lan20 driver, but in order to support a wide use case we default to auto.
-  def self.connect(user, pass, host, provider='any', opts={:driver => 'auto', :timeout => 'default'})
+  def self.connect(user, pass, host, provider = 'any', opts = {:driver => 'lan20', :timeout => 'default'})
     # use this variable to reduce cmd calls
     installed = false
 
+    # if the user supplied nil, we want to fix this automatically
+    opts = {:driver => 'lan20', :timeout => 'default'} if opts.nil?
+
+    # convert all keys to symbols for opts, we can't assume the user will use symbols
+    opts.keys.each do |key|
+      opts[(key.to_sym rescue key) || key] = opts.delete(key)
+    end
+
     # allow the user to specify an options hash instead of the provider
     # in the future I would stop using the provider and use the opts hash instead to get the provider
     # This allows us to be a little more flexible if the user is doesn't supply us what we need.
-    if provider.is_a?(Hash)
+    if provider.kind_of?(Hash)
       opts = provider
       provider = opts[:provider] ||= 'any'
     end
 
     # Verify options just in case user passed in a incomplete hash
-    opts[:driver]  ||= 'auto'
+    opts[:driver] ||= 'lan20'
     opts[:timeout] ||= 'default'
 
-    if opts[:privilege] and not supported_privilege_type?(opts[:privilege])
+    if opts[:privilege] && !supported_privilege_type?(opts[:privilege])
       logger.error("Invalid privilege type :#{opts[:privilege]}, must be one of: #{PRIV_TYPES.join("\n")}") if logger
       raise "Invalid privilege type :#{opts[:privilege]}, must be one of: #{PRIV_TYPES.join("\n")}"
     end
@@ -116,11 +123,11 @@ module Rubyipmi
     end
 
     # If the provider is available create a connection object
-    if installed or is_provider_installed?(provider)
+    if installed || is_provider_installed?(provider)
       if provider == "freeipmi"
         Rubyipmi::Freeipmi::Connection.new(user, pass, host, opts)
       elsif provider == "ipmitool"
-        Rubyipmi::Ipmitool::Connection.new(user,pass,host, opts)
+        Rubyipmi::Ipmitool::Connection.new(user, pass, host, opts)
       else
         logger.error("Incorrect provider given, must use one of #{valid_providers.join(', ')}") if logger
         raise "Incorrect provider given, must use one of #{valid_providers.join(', ')}"
@@ -134,31 +141,29 @@ module Rubyipmi
 
   # returns boolean true if privilege type is valid
   def self.supported_privilege_type?(type)
-     PRIV_TYPES.include?(type)
+    PRIV_TYPES.include?(type)
   end
 
   # method used to find the command which also makes it easier to mock with
   def self.locate_command(commandname)
     location = `which #{commandname}`.strip
-    if not $?.success?
-      location = nil
-    end
+    location = nil unless $?.success?
     location
   end
 
   # Return true or false if the provider is available
   def self.is_provider_installed?(provider)
     case provider
-      when "freeipmi"
-        cmdpath = locate_command('ipmipower')
-      when "ipmitool"
-        cmdpath = locate_command('ipmitool')
-      else
-        logger.error("Invalid BMC provider type #{provider}") if logger
-        false
+    when "freeipmi"
+      cmdpath = locate_command('ipmipower')
+    when "ipmitool"
+      cmdpath = locate_command('ipmitool')
+    else
+      logger.error("Invalid BMC provider type #{provider}") if logger
+      false
     end
     # return false if command was not found
-    return ! cmdpath.nil?
+    !cmdpath.nil?
   end
 
   def self.providers
@@ -173,15 +178,13 @@ module Rubyipmi
   def self.providers_installed
     available = []
     providers.each do |prov|
-      if is_provider_installed?(prov)
-        available << prov
-      end
+      available << prov if is_provider_installed?(prov)
     end
-    return available
+    available
   end
 
   # gets data from the bmc device and puts in a hash for diagnostics
-  def self.get_diag(user, pass, host, opts={:driver => 'auto', :timeout => 'default'})
+  def self.get_diag(user, pass, host, opts = {:driver => 'lan20', :timeout => 'default'})
     data = {}
     if Rubyipmi.is_provider_installed?('freeipmi')
       freeconn = Rubyipmi.connect(user, pass, host, 'freeipmi', opts)
@@ -197,7 +200,7 @@ module Rubyipmi
         data[:ipmitool] = ipmiconn.get_diag
       end
     end
-    File.open('/tmp/rubyipmi_diag_data.txt', 'w') {|f| f.write(data)}
+    File.open('/tmp/rubyipmi_diag_data.txt', 'w') { |f| f.write(data) }
     puts "Created file /tmp/rubyipmi_diag_data.txt"
   end
 end

data/rubyipmi.gemspec

@@ -1,145 +1,34 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
-# -*- encoding: utf-8 -*-
-# stub: rubyipmi 0.9.2 ruby lib
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rubyipmi/version'
 
 Gem::Specification.new do |s|
   s.name = "rubyipmi"
-  s.version = "0.9.2"
+  s.version = Rubyipmi::VERSION
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib"]
   s.authors = ["Corey Osman"]
-  s.date = "2015-03-19"
-  s.description = "Provides a library for controlling IPMI devices using pure ruby code"
+  s.date = "2021-09-29"
+  s.description = "Controls IPMI devices via command line wrapper for ipmitool and freeipmi"
   s.email = "corey@logicminds.biz"
   s.extra_rdoc_files = [
     "LICENSE.txt",
     "README.md"
   ]
-  s.files = [
-    "Gemfile",
-    "LICENSE.txt",
-    "README.md",
-    "RELEASE_NOTES.md",
-    "Rakefile",
-    "VERSION",
-    "lib/rubyipmi.rb",
-    "lib/rubyipmi/commands/basecommand.rb",
-    "lib/rubyipmi/freeipmi/commands/basecommand.rb",
-    "lib/rubyipmi/freeipmi/commands/bmc.rb",
-    "lib/rubyipmi/freeipmi/commands/bmcconfig.rb",
-    "lib/rubyipmi/freeipmi/commands/bmcdevice.rb",
-    "lib/rubyipmi/freeipmi/commands/bmcinfo.rb",
-    "lib/rubyipmi/freeipmi/commands/chassis.rb",
-    "lib/rubyipmi/freeipmi/commands/chassisconfig.rb",
-    "lib/rubyipmi/freeipmi/commands/fru.rb",
-    "lib/rubyipmi/freeipmi/commands/lan.rb",
-    "lib/rubyipmi/freeipmi/commands/power.rb",
-    "lib/rubyipmi/freeipmi/commands/sensors.rb",
-    "lib/rubyipmi/freeipmi/connection.rb",
-    "lib/rubyipmi/freeipmi/errorcodes.rb",
-    "lib/rubyipmi/ipmitool/commands/basecommand.rb",
-    "lib/rubyipmi/ipmitool/commands/bmc.rb",
-    "lib/rubyipmi/ipmitool/commands/chassis.rb",
-    "lib/rubyipmi/ipmitool/commands/chassisconfig.rb",
-    "lib/rubyipmi/ipmitool/commands/fru.rb",
-    "lib/rubyipmi/ipmitool/commands/lan.rb",
-    "lib/rubyipmi/ipmitool/commands/power.rb",
-    "lib/rubyipmi/ipmitool/commands/sensors.rb",
-    "lib/rubyipmi/ipmitool/connection.rb",
-    "lib/rubyipmi/ipmitool/errorcodes.rb",
-    "lib/rubyipmi/observablehash.rb",
-    "rubyipmi.gemspec",
-    "spec/Vagrantfile",
-    "spec/fixtures/freeipmi/bmc_config.txt",
-    "spec/fixtures/freeipmi/bmc_config_lan_conf.txt",
-    "spec/fixtures/freeipmi/bmc_info.txt",
-    "spec/fixtures/freeipmi/errors.txt",
-    "spec/fixtures/freeipmi/fru.txt",
-    "spec/fixtures/freeipmi/sensors.txt",
-    "spec/fixtures/ipmitool/bmc_info.txt",
-    "spec/fixtures/ipmitool/errors.txt",
-    "spec/fixtures/ipmitool/fru.txt",
-    "spec/fixtures/ipmitool/lan.txt",
-    "spec/fixtures/ipmitool/sensors.txt",
-    "spec/integration/bmc_spec.rb",
-    "spec/integration/chassis_config_spec.rb",
-    "spec/integration/chassis_spec.rb",
-    "spec/integration/connection_spec.rb",
-    "spec/integration/fru_spec.rb",
-    "spec/integration/lan_spec.rb",
-    "spec/integration/power_spec.rb",
-    "spec/integration/rubyipmi_spec.rb",
-    "spec/integration/sensor_spec.rb",
-    "spec/manifests/default.pp",
-    "spec/puppetmodules/archive/LICENSE-2.0.txt",
-    "spec/puppetmodules/archive/Modulefile",
-    "spec/puppetmodules/archive/README.md",
-    "spec/puppetmodules/archive/manifests/download.pp",
-    "spec/puppetmodules/archive/manifests/extract.pp",
-    "spec/puppetmodules/archive/manifests/init.pp",
-    "spec/puppetmodules/archive/manifests/tar-gz.pp",
-    "spec/puppetmodules/archive/manifests/zip.pp",
-    "spec/puppetmodules/archive/metadata.json",
-    "spec/spec_helper.rb",
-    "spec/unit/freeipmi/bmc-info_spec.rb",
-    "spec/unit/freeipmi/bmc_spec.rb",
-    "spec/unit/freeipmi/connection_spec.rb",
-    "spec/unit/freeipmi/errorcodes_spec.rb",
-    "spec/unit/freeipmi/fru_spec.rb",
-    "spec/unit/freeipmi/lan_spec.rb",
-    "spec/unit/freeipmi/sensors_spec.rb",
-    "spec/unit/ipmitool/bmc_spec.rb",
-    "spec/unit/ipmitool/connection_spec.rb",
-    "spec/unit/ipmitool/errorcodes_spec.rb",
-    "spec/unit/ipmitool/fru_spec.rb",
-    "spec/unit/ipmitool/lan_spec.rb",
-    "spec/unit/ipmitool/sensors_spec.rb",
-    "spec/unit/rubyipmi_spec.rb",
-    "spec/vagrant",
-    "spec/vagrant.pub"
-  ]
-  s.homepage = "http://github.com/logicminds/rubyipmi"
+  s.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(/^(\.|test|spec|features)/) || f.match(/^*.tar\.gz/)
+  end
+  s.homepage = "https://github.com/logicminds/rubyipmi"
   s.licenses = ["LGPLv2.1"]
   s.rubygems_version = "2.4.5"
   s.summary = "A ruby wrapper for ipmi command line tools that supports ipmitool and freeipmi"
-
-  if s.respond_to? :specification_version then
-    s.specification_version = 4
-
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_development_dependency(%q<rspec>, ["~> 3.1"])
-      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
-      s.add_development_dependency(%q<bundler>, [">= 1.1.5"])
-      s.add_development_dependency(%q<jeweler>, ["~> 2.0.1"])
-      s.add_development_dependency(%q<highline>, [">= 0"])
-      s.add_development_dependency(%q<rake>, [">= 0"])
-      s.add_development_dependency(%q<coveralls>, [">= 0"])
-      s.add_development_dependency(%q<pry>, [">= 0"])
-      s.add_development_dependency(%q<pry-rescue>, [">= 0"])
-    else
-      s.add_dependency(%q<rspec>, ["~> 3.1"])
-      s.add_dependency(%q<rdoc>, ["~> 3.12"])
-      s.add_dependency(%q<bundler>, [">= 1.1.5"])
-      s.add_dependency(%q<jeweler>, ["~> 2.0.1"])
-      s.add_dependency(%q<highline>, [">= 0"])
-      s.add_dependency(%q<rake>, [">= 0"])
-      s.add_dependency(%q<coveralls>, [">= 0"])
-      s.add_dependency(%q<pry>, [">= 0"])
-      s.add_dependency(%q<pry-rescue>, [">= 0"])
-    end
-  else
-    s.add_dependency(%q<rspec>, ["~> 3.1"])
-    s.add_dependency(%q<rdoc>, ["~> 3.12"])
-    s.add_dependency(%q<bundler>, [">= 1.1.5"])
-    s.add_dependency(%q<jeweler>, ["~> 2.0.1"])
-    s.add_dependency(%q<highline>, [">= 0"])
-    s.add_dependency(%q<rake>, [">= 0"])
-    s.add_dependency(%q<coveralls>, [">= 0"])
-    s.add_dependency(%q<pry>, [">= 0"])
-    s.add_dependency(%q<pry-rescue>, [">= 0"])
-  end
+  s.require_paths = ['lib']
+  s.add_development_dependency(%q<rspec>, ["~> 3.1"])
+  s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
+  s.add_development_dependency(%q<bundler>, [">= 1.1.5"])
+  s.add_development_dependency(%q<highline>, [">= 0"])
+  s.add_development_dependency(%q<rake>, [">= 0"])
+  s.add_dependency(%q<highline>, [">= 0"])
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubyipmi
 version: !ruby/object:Gem::Version
-  version: 0.9.2
+  version: 0.11.1
 platform: ruby
 authors:
 - Corey Osman
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-03-19 00:00:00.000000000 Z
+date: 2021-09-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -52,20 +52,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.1.5
-- !ruby/object:Gem::Dependency
-  name: jeweler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 2.0.1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 2.0.1
 - !ruby/object:Gem::Dependency
   name: highline
   requirement: !ruby/object:Gem::Requirement
@@ -95,48 +81,20 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: coveralls
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: pry
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: pry-rescue
+  name: highline
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Provides a library for controlling IPMI devices using pure ruby code
+description: Controls IPMI devices via command line wrapper for ipmitool and freeipmi
 email: corey@logicminds.biz
 executables: []
 extensions: []
@@ -152,6 +110,8 @@ files:
 - VERSION
 - lib/rubyipmi.rb
 - lib/rubyipmi/commands/basecommand.rb
+- lib/rubyipmi/commands/mixins/power_mixin.rb
+- lib/rubyipmi/commands/mixins/sensors_mixin.rb
 - lib/rubyipmi/freeipmi/commands/basecommand.rb
 - lib/rubyipmi/freeipmi/commands/bmc.rb
 - lib/rubyipmi/freeipmi/commands/bmcconfig.rb
@@ -176,60 +136,13 @@ files:
 - lib/rubyipmi/ipmitool/connection.rb
 - lib/rubyipmi/ipmitool/errorcodes.rb
 - lib/rubyipmi/observablehash.rb
+- lib/rubyipmi/version.rb
 - rubyipmi.gemspec
-- spec/Vagrantfile
-- spec/fixtures/freeipmi/bmc_config.txt
-- spec/fixtures/freeipmi/bmc_config_lan_conf.txt
-- spec/fixtures/freeipmi/bmc_info.txt
-- spec/fixtures/freeipmi/errors.txt
-- spec/fixtures/freeipmi/fru.txt
-- spec/fixtures/freeipmi/sensors.txt
-- spec/fixtures/ipmitool/bmc_info.txt
-- spec/fixtures/ipmitool/errors.txt
-- spec/fixtures/ipmitool/fru.txt
-- spec/fixtures/ipmitool/lan.txt
-- spec/fixtures/ipmitool/sensors.txt
-- spec/integration/bmc_spec.rb
-- spec/integration/chassis_config_spec.rb
-- spec/integration/chassis_spec.rb
-- spec/integration/connection_spec.rb
-- spec/integration/fru_spec.rb
-- spec/integration/lan_spec.rb
-- spec/integration/power_spec.rb
-- spec/integration/rubyipmi_spec.rb
-- spec/integration/sensor_spec.rb
-- spec/manifests/default.pp
-- spec/puppetmodules/archive/LICENSE-2.0.txt
-- spec/puppetmodules/archive/Modulefile
-- spec/puppetmodules/archive/README.md
-- spec/puppetmodules/archive/manifests/download.pp
-- spec/puppetmodules/archive/manifests/extract.pp
-- spec/puppetmodules/archive/manifests/init.pp
-- spec/puppetmodules/archive/manifests/tar-gz.pp
-- spec/puppetmodules/archive/manifests/zip.pp
-- spec/puppetmodules/archive/metadata.json
-- spec/spec_helper.rb
-- spec/unit/freeipmi/bmc-info_spec.rb
-- spec/unit/freeipmi/bmc_spec.rb
-- spec/unit/freeipmi/connection_spec.rb
-- spec/unit/freeipmi/errorcodes_spec.rb
-- spec/unit/freeipmi/fru_spec.rb
-- spec/unit/freeipmi/lan_spec.rb
-- spec/unit/freeipmi/sensors_spec.rb
-- spec/unit/ipmitool/bmc_spec.rb
-- spec/unit/ipmitool/connection_spec.rb
-- spec/unit/ipmitool/errorcodes_spec.rb
-- spec/unit/ipmitool/fru_spec.rb
-- spec/unit/ipmitool/lan_spec.rb
-- spec/unit/ipmitool/sensors_spec.rb
-- spec/unit/rubyipmi_spec.rb
-- spec/vagrant
-- spec/vagrant.pub
-homepage: http://github.com/logicminds/rubyipmi
+homepage: https://github.com/logicminds/rubyipmi
 licenses:
 - LGPLv2.1
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -244,9 +157,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.5
-signing_key: 
+rubygems_version: 3.0.3
+signing_key:
 specification_version: 4
 summary: A ruby wrapper for ipmi command line tools that supports ipmitool and freeipmi
 test_files: []

data/spec/Vagrantfile

@@ -1,45 +0,0 @@
-# -*- mode: ruby -*-
-# vi: set ft=ruby :
-
-# Vagrantfile API/syntax version. Don't touch unless you know what you're doing!
-VAGRANTFILE_API_VERSION = "2"
-
-Vagrant.configure(VAGRANTFILE_API_VERSION) do |config|
-
-  config.vm.box = "centos6.4"
-  config.vm.box_url = "http://developer.nrel.gov/downloads/vagrant-boxes/CentOS-6.4-x86_64-v20130427.box"
-  config.ssh.private_key_path = "vagrant"
-  config.vm.provider :virtualbox do |vb, override|
-    #vb.gui = true
-  end
-  config.vm.provider :vmware_fusion do |vf, override|
-    override.vm.box_url = "https://dl.dropbox.com/u/5721940/vagrant-boxes/vagrant-centos-6.4-x86_64-vmware_fusion.box"
-    #vf.gui = true
-  end
-
-  # Boot with a GUI so you can see the screen. (Default is headless)
-  #config.vm.boot_mode = :gui
-
-  # Enable provisioning with Puppet stand alone.  Puppet manifests
-  # are contained in a directory path relative to this Vagrantfile.
-  # You will need to create the manifests directory and a manifest in
-  # the file centos.pp in the manifests_path directory.
-  #
-  config.vm.synced_folder "../", "/rubyipmi"
-  (1..1).each do |i|
-    vmname = "testnode#{i}"
-    config.vm.define vmname.to_sym do |web_conf|
-      web_conf.vm.hostname = vmname
-      web_conf.vm.provision :shell,
-                            :inline => "hostname #{vmname}.company.corp"
-      web_conf.vm.provision :puppet do |puppet|
-        puppet.module_path = "puppetmodules"
-        puppet.manifests_path = "manifests"
-        puppet.manifest_file  = "default.pp"
-        puppet.facter = { }
-      end
-    end
-  end
-end
-
-