rubyipmi 0.9.1 → 0.9.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 02b0b1ca03e27eaf226f2f876b943d0db218fe07
-  data.tar.gz: d76b73dbf83a64d85663c304169e9ee24e010ac4
+  metadata.gz: 1fb4c5a2ee5350e88825085a4d8bc8629c0540a7
+  data.tar.gz: 4e4ecc9f2c3cda0a9bc9d1dc2f95c85f01209abd
 SHA512:
-  metadata.gz: 2682146a7c24f31144c1eedbf980cad87b86097fb6338999b60121e1537f427a5eb7be6e87811a2ccfb8200db4af75f38370089f859df885e9538ae337535f3a
-  data.tar.gz: ca76f38f6f5ad045591030352b8679e3536fe2b38e0d73e2deeef796f85d3f38cb8ab9d9a4326be28f21ae2279ac2376710f6845ba09a441fadb4419550174a9
+  metadata.gz: 524f30bca98d535eab2ba5ff77a68816f8bcffe6d7c290e2f0024e25f1ccb2c994134fdaba359088d4c9eaec4338f9d8dc64193450c52428573e6fa198f8e5fb
+  data.tar.gz: d6304c667418b10143d7e9b753a2c2dfab367acbd888de03efc12a589a444cacf10d8e486ee136166626f85b37a5f4dbfd03ddba817576629d6baf20ad58dc67

data/README.md

@@ -1,3 +1,36 @@
+Table of Contents
+=================
+
+  * [Rubyipmi](#rubyipmi)
+    * [Projects that use Rubyipmi](#projects-that-use-rubyipmi)
+    * [Support](#support)
+    * [Using the library in your code](#using-the-library-in-your-code)
+      * [Requirements](#requirements)
+      * [Create a connection object](#create-a-connection-object)
+      * [Use power functions (not all listed)](#use-power-functions-not-all-listed)
+      * [Boot to specific device](#boot-to-specific-device)
+      * [Sensors](#sensors)
+      * [Fru](#fru)
+    * [Testing](#testing)
+    * [Security](#security)
+    * [How the library works](#how-the-library-works)
+      * [Creating a new command](#creating-a-new-command)
+      * [Writing a function for running a command](#writing-a-function-for-running-a-command)
+      * [Running the cmd](#running-the-cmd)
+      * [The Options hash](#the-options-hash)
+      * [How to get the results of the command](#how-to-get-the-results-of-the-command)
+      * [The command function](#the-command-function)
+    * [The following are tools bundled with freeipmi](#the-following-are-tools-bundled-with-freeipmi)
+    * [To contrast ipmitool has one command with many options](#to-contrast-ipmitool-has-one-command-with-many-options)
+    * [Auto Detect workarounds](#auto-detect-workarounds)
+    * [Troubleshooting](#troubleshooting)
+      * [Log files](#log-files)
+      * [Diagnostics Function](#diagnostics-function)
+      * [Test Function](#test-function)
+    * [Contributing to rubyipmi](#contributing-to-rubyipmi)
+    * [Copyright](#copyright)
+    * [Freeipmi Documented Workarounds](#freeipmi-documented-workarounds)
+
 # Rubyipmi
 This gem is a ruby wrapper for the freeipmi and ipmitool command line tools.
 It provides a ruby implementation of ipmi commands that will make it simple to connect to BMC devices from ruby.
@@ -6,12 +39,37 @@ It provides a ruby implementation of ipmi commands that will make it simple to c
 [![Gem Version](https://badge.fury.io/rb/rubyipmi.png)](http://badge.fury.io/rb/rubyipmi)
 [![Coverage Status](https://coveralls.io/repos/logicminds/rubyipmi/badge.png)](https://coveralls.io/r/logicminds/rubyipmi)
 
+Rubyipmi was built because I wanted an object oriented way to get data from BMC devices.  I also wanted it easy to use
+and if any IPMI hacks/workarounds were required I wanted to build those into the library to make life easier.
+
 ## Projects that use Rubyipmi
 * https://github.com/sensu/sensu-community-plugins/blob/master/plugins/ipmi/check-sensor.rb
-* https://github.com/theforeman/smart-proxy
-* https://github.com/logicminds/ipmispec
+* https://github.com/theforeman/smart-proxy  (Turns Rubyipmi into a Remote Web API Proxy server)
+* https://github.com/logicminds/ipmispec (just started)
 
 Don't see your project listed? Create a PR with your project listed here.
+
+## Support
+General support is offered via github issues and whenever I have time I will try to resolve any issues.  I do offer
+professional paid support through my [company](http://www.logicminds.biz) and can be contracted to work directly with your organization
+on Rubyipmi or other related automation/devops projects that you might have.
+
+At this time I only have one test server (HP DL380 G5) which I used to perform tests against.  While I try to keep the code
+generic in nature there may be newer devices that do not work correctly and its an issue I cannot troubleshoot directly.  If you would
+like to see newer/other devices be part of my test suite and you have extra servers lying around. I would encourage you to donate
+server equipment so that I can extend my test suite against this newer equipment.
+
+Servers I have never tested against.
+
+* Dell
+* IBM
+* HP server with ilo3+
+* Super Micro
+* Cisco
+
+IPMI is designed to support any equipment that implements the standard.  But there are always problems with people deviating
+from the standard.  In general this library should work will all servers.
+
 ## Using the library in your code
 
 ### Requirements
@@ -48,11 +106,11 @@ Don't see your project listed? Create a PR with your project listed here.
 
    Should you need to specify some additional options or the provider type
    ```ruby
-      conn = Rubyipmi.connect(nil,nil,nil, 'freeipmi', {:privilege  =>'USER'})
+      conn = Rubyipmi.connect("username", "password", "hostname", 'freeipmi', {:privilege  =>'USER'})
    ```
 
 
-#### Use power functions (not all listed)
+#### power functions
 
    ```ruby
    require 'rubyipmi'

data/VERSION

@@ -1 +1 @@
-0.9.1
+0.9.2

data/lib/rubyipmi.rb

@@ -154,8 +154,8 @@ module Rubyipmi
       when "ipmitool"
         cmdpath = locate_command('ipmitool')
       else
-        logger.error("Invalid BMC provider type") if logger
-        raise "Invalid BMC provider type"
+        logger.error("Invalid BMC provider type #{provider}") if logger
+        false
     end
     # return false if command was not found
     return ! cmdpath.nil?
@@ -167,10 +167,10 @@ module Rubyipmi
 
   # returns true if any of the providers are installed
   def self.provider_installed?
-    providers_installed?.length > 0
+    providers_installed.length > 0
   end
 
-  def self.providers_installed?
+  def self.providers_installed
     available = []
     providers.each do |prov|
       if is_provider_installed?(prov)

data/rubyipmi.gemspec

@@ -2,16 +2,16 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: rubyipmi 0.9.1 ruby lib
+# stub: rubyipmi 0.9.2 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "rubyipmi"
-  s.version = "0.9.1"
+  s.version = "0.9.2"
 
   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-11"
+  s.date = "2015-03-19"
   s.description = "Provides a library for controlling IPMI devices using pure ruby code"
   s.email = "corey@logicminds.biz"
   s.extra_rdoc_files = [

data/spec/integration/rubyipmi_spec.rb

@@ -48,12 +48,12 @@ describe "rubyipmi" do
     begin
       conn = Rubyipmi.connect(@user, @pass, @host, "bogus")
     rescue Exception => e
-        expect(e.message).to match(/Invalid/)
+        expect(e.message).to match(/The IPMI provider: bogus is not installed/)
     end
   end
 
   it "check to find any available installed providers" do
-    expect(Rubyipmi.providers_installed?.length).to be > 0
+    expect(Rubyipmi.providers_installed.length).to be > 0
   end
 
   it 'can get diag info' do

data/spec/unit/rubyipmi_spec.rb

@@ -22,8 +22,9 @@ describe :Rubyipmi do
     expect(Rubyipmi.is_provider_installed?('freeipmi')).to eq true
   end
 
-  it 'is provider installed should return error with ipmitool' do
-    expect{Rubyipmi.is_provider_installed?('bad_provider')}.to raise_error
+  it 'is provider installed should return false when bad provider' do
+    expect{Rubyipmi.is_provider_installed?('bad_provider')}.to_not raise_error
+    expect(Rubyipmi.is_provider_installed?('bad_provider')).to be_falsey
   end
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubyipmi
 version: !ruby/object:Gem::Version
-  version: 0.9.1
+  version: 0.9.2
 platform: ruby
 authors:
 - Corey Osman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-11 00:00:00.000000000 Z
+date: 2015-03-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec