nagiosplugin 1.0.3 → 1.1.0

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 1.8.7
+  - 1.9.3

data/README.md

@@ -1,6 +1,6 @@
 # NagiosPlugin
 
-A simple framework for writing [Nagios](http://www.nagios.org/) Plugins.
+The one [Nagios](http://www.nagios.org/) Plugin framework, forged in the fires of Mount Doom.
 
 ## Installation
 
@@ -8,35 +8,25 @@ A simple framework for writing [Nagios](http://www.nagios.org/) Plugins.
 
 ## Usage
 
-Create your executable file (which will be called by nagios), `require
-'nagiosplugin'` and subclass from `NagiosPlugin::Plugin`.
+### Step 1
 
-Then define a check method in your class which figures out the status
-for what you want to check and calls the corresponding status method
-(`ok`, `warning`, `critical` or `unknown`) to display a status message
-and exit immediately.
+Just subclass from `NagiosPlugin::Plugin` and define your `check` method
+which should figure out the status and then call the appropriate status
+method (`ok`, `warning`, `critical` or `unknown`) with meaningfull message.
+(The status methods will exit immediately by raising a corresponding StatusError.)
 
-Here's a simple example plugin named `check_u2d`:
+Take a look at a working [usage
+example](https://github.com/bjoernalbers/nagiosplugin/blob/master/features/nagiosplugin_usage.feature).
 
-```Ruby
-#!/usr/bin/env ruby
-require 'nagiosplugin'
+### Step 2
 
-class UnicornToDwarfRatio < NagiosPlugin::Plugin
-	def check
-    unicorn_to_dwarf_ratio = ... # We still need an alogrithm for this.
-    msg = "#{unicorn_to_dwarf_ratio} unicorns/dwarves"
+Call the `run` method on your new class, which outputs the check result
+and exits in compliance with the official [Nagios plug-in development
+guidelines](http://nagiosplug.sourceforge.net/developer-guidelines.html)
 
-    critical(msg) if unicorn_to_dwarf_ratio < 0.0
-    warning(msg) if unicorn_to_dwarf_ratio == 0.0
-    ok(msg)
-  end
-end
+### Step 3
 
-UnicornToDwarfRatio.run
-```
-
-Take a look below `features` to see what's going on...
+Profit... and maybe also fun.
 
 ## Note on Patches/Pull Requests
 

data/Rakefile

@@ -11,4 +11,4 @@ RSpec::Core::RakeTask.new do |t|
   t.pattern = './spec/**/*_spec.rb'
 end
 
-task :default => :features
+task :default => :spec

data/features/nagiosplugin_usage.feature

@@ -0,0 +1,38 @@
+Feature: NagiosPlugin Usage
+
+  In order to write awesome Nagios Plugins with minimal effort
+  As a busy (developer|sysadmin|devop|hacker|superhero|rockstar)
+  I want to use the one NagiosPlugin framework
+
+  Scenario Outline: Subclass from NagiosPlugin
+    Given a file named "check_foo.rb" with:
+      """
+      require 'nagiosplugin'
+
+      class Foo < NagiosPlugin::Plugin
+        def check
+          case ARGV.first
+            when 'UNKNOWN'  then unknown  'no clue, sorry'
+            when 'CRITICAL' then critical 'booooom!'
+            when 'WARNING'  then warning  'it could be worse'
+            when 'OK'       then ok       'all is fine'
+          end
+        end
+      end
+
+      Foo.run
+      """
+    When I run `ruby check_foo.rb <status>`
+    Then the exit status should be <code>
+    And the stdout should contain exactly:
+      """
+      <stdout>
+
+      """
+
+    Examples:
+     | status   | code | stdout                         |
+     | UNKNOWN  | 3    | FOO UNKNOWN: no clue, sorry    |
+     | CRITICAL | 2    | FOO CRITICAL: booooom!         |
+     | WARNING  | 1    | FOO WARNING: it could be worse |
+     | OK       | 0    | FOO OK: all is fine            |

data/lib/nagiosplugin/plugin.rb

@@ -1,36 +1,5 @@
 module NagiosPlugin
   class Plugin
-
-    # A custom status error which will be raised through the status methods.
-    class StatusError < StandardError
-
-      # All allowed statuses sorted by their corresponding exit status.
-      STATUS = [:ok, :warning, :critical, :unknown]
-
-      # @param [Symbol] status the status (must be {NagiosPlugin::Plugin::StatusError::STATUS a valid status})
-      # @param [String] message the message you want to display
-      def initialize(status, message)
-        @status, @message = status.to_sym, message
-      end
-
-      # @return [String] the status and message
-      def to_s
-        "#{status.to_s.upcase}: #{@message}"
-      end
-
-      # @return [Fixnum] the status converted into an exit code
-      def to_i
-        STATUS.find_index(status)
-      end
-
-    private
-
-      # @return [Symbol] the status (:unknown if invalid)
-      def status
-        (STATUS.include?(@status) && @status) || STATUS.last
-      end
-    end
-
     class << self
 
       # Create new instance and run it.
@@ -58,7 +27,7 @@ module NagiosPlugin
 
     # Overwrite this check method and call a status method within.
     def check
-      unknown 'please overwrite the method `check` in your class'
+      unknown 'please overwrite the `check` method in your class'
     end
 
    # Run check and return result in a nagios-compatible format.

data/lib/nagiosplugin/status_error.rb

@@ -0,0 +1,32 @@
+module NagiosPlugin
+
+    # A custom status error which will be raised through the status methods.
+    class StatusError < StandardError
+
+      # All allowed statuses sorted by their corresponding exit status.
+      STATUS = [:ok, :warning, :critical, :unknown]
+
+      # @param [Symbol] status the status (must be {NagiosPlugin::Plugin::StatusError::STATUS a valid status})
+      # @param [String] message the message you want to display
+      def initialize(status, message)
+        @status, @message = status.to_sym, message
+      end
+
+      # @return [String] the status and message
+      def to_s
+        "#{status.to_s.upcase}: #{@message}"
+      end
+
+      # @return [Fixnum] the status converted into an exit code
+      def to_i
+        STATUS.find_index(status)
+      end
+
+    private
+
+      # @return [Symbol] the status (:unknown if invalid)
+      def status
+        (STATUS.include?(@status) && @status) || STATUS.last
+      end
+    end
+end

data/lib/nagiosplugin/version.rb

@@ -1,3 +1,3 @@
 module NagiosPlugin
-  VERSION = '1.0.3'
+  VERSION = '1.1.0'
 end

data/lib/nagiosplugin.rb

@@ -1,2 +1,3 @@
 require 'nagiosplugin/version'
 require 'nagiosplugin/plugin'
+require 'nagiosplugin/status_error'

data/nagiosplugin.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |s|
   s.email       = ['bjoernalbers@googlemail.com']
   s.homepage    = 'https://github.com/bjoernalbers/nagiosplugin'
   s.summary     = "#{s.name}-#{s.version}"
-  s.description = 'A simple framework for writing Nagios Plugins'
+  s.description = 'The one Nagios Plugin framework, forged in the fires of Mount Doom.'
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")

data/spec/nagiosplugin/plugin_spec.rb

@@ -24,7 +24,7 @@ describe NagiosPlugin::Plugin do
     end
 
     it 'should output an appropriate message when check was not overwritten' do
-      @plugin.should_receive(:puts).with(/please overwrite the method `check` in your class/i)
+      @plugin.should_receive(:puts).with(/please overwrite the `check` method in your class/i)
       @plugin.run
     end
 
@@ -69,7 +69,7 @@ describe NagiosPlugin::Plugin do
     context 'when a status error was raised' do
       before do
         def @plugin.check
-          raise NagiosPlugin::Plugin::StatusError.new(:ok, 'hello, world.')
+          raise NagiosPlugin::StatusError.new(:ok, 'hello, world.')
         end
       end
 
@@ -90,36 +90,3 @@ describe NagiosPlugin::Plugin do
     end
   end
 end
-
-
-describe NagiosPlugin::Plugin::StatusError do
-  def create_status(status, msg = '')
-    NagiosPlugin::Plugin::StatusError.new(status, msg)
-  end
-
-  %w[ok warning critical unknown].each_with_index do |s,i|
-    context "when #{s}" do
-      before { @status = create_status(s.to_sym) }
-
-      it 'should include status in the exception message' do
-        @status.to_s.should include(s.upcase)
-      end
-
-      it "should convert to #{i}" do
-        @status.to_i.should eql(i)
-      end
-    end
-  end
-
-  context 'when initialized with invalid status' do
-    before { @status = create_status(:invalid) }
-
-    it 'should include unknown status in the exception message' do
-      @status.to_s.should include('UNKNOWN')
-    end
-
-    it 'should convert to 3' do
-      @status.to_i.should eql(3)
-    end
-  end
-end

data/spec/nagiosplugin/status_error_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+describe NagiosPlugin::StatusError do
+  def create_status(status, msg = '')
+    NagiosPlugin::StatusError.new(status, msg)
+  end
+
+  %w[ok warning critical unknown].each_with_index do |s,i|
+    context "when #{s}" do
+      before { @status = create_status(s.to_sym) }
+
+      it 'should include status in the exception message' do
+        @status.to_s.should include(s.upcase)
+      end
+
+      it "should convert to #{i}" do
+        @status.to_i.should eql(i)
+      end
+    end
+  end
+
+  context 'when initialized with invalid status' do
+    before { @status = create_status(:invalid) }
+
+    it 'should include unknown status in the exception message' do
+      @status.to_s.should include('UNKNOWN')
+    end
+
+    it 'should convert to 3' do
+      @status.to_i.should eql(3)
+    end
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: nagiosplugin
 version: !ruby/object:Gem::Version 
-  hash: 17
+  hash: 19
   prerelease: 
   segments: 
   - 1
+  - 1
   - 0
-  - 3
-  version: 1.0.3
+  version: 1.1.0
 platform: ruby
 authors: 
 - "Bj\xC3\xB6rn Albers"
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-03-30 00:00:00 Z
+date: 2012-04-02 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   type: :development
@@ -101,7 +101,7 @@ dependencies:
   prerelease: false
   name: guard-rspec
   version_requirements: *id006
-description: A simple framework for writing Nagios Plugins
+description: The one Nagios Plugin framework, forged in the fires of Mount Doom.
 email: 
 - bjoernalbers@googlemail.com
 executables: []
@@ -112,19 +112,22 @@ extra_rdoc_files: []
 
 files: 
 - .gitignore
+- .travis.yml
 - Gemfile
 - Guardfile
 - LICENSE
 - README.md
 - Rakefile
-- features/plugin_output.feature
+- features/nagiosplugin_usage.feature
 - features/steps/dev_steps.rb
 - features/support/env.rb
 - lib/nagiosplugin.rb
 - lib/nagiosplugin/plugin.rb
+- lib/nagiosplugin/status_error.rb
 - lib/nagiosplugin/version.rb
 - nagiosplugin.gemspec
 - spec/nagiosplugin/plugin_spec.rb
+- spec/nagiosplugin/status_error_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/bjoernalbers/nagiosplugin
 licenses: []
@@ -158,10 +161,11 @@ rubyforge_project:
 rubygems_version: 1.8.11
 signing_key: 
 specification_version: 3
-summary: nagiosplugin-1.0.3
+summary: nagiosplugin-1.1.0
 test_files: 
-- features/plugin_output.feature
+- features/nagiosplugin_usage.feature
 - features/steps/dev_steps.rb
 - features/support/env.rb
 - spec/nagiosplugin/plugin_spec.rb
+- spec/nagiosplugin/status_error_spec.rb
 - spec/spec_helper.rb

data/features/plugin_output.feature

@@ -1,50 +0,0 @@
-Feature: Plugin Output
-
-  In order to comply with official nagios plugin development guidelines
-  As a sysadmin building my own nagios plugins
-  I want to return a nagios compatible plugin output
-
-  Scenario Outline: UNKNOWN, CRITICAL, WARNING and OK
-    Given a file named "check_foo.rb" with:
-      """
-      require 'nagiosplugin'
-
-      class Foo < NagiosPlugin::Plugin
-        def check
-          case ARGV.first
-            when 'UNKNOWN'  then unknown  'no clue, sorry'
-            when 'CRITICAL' then critical 'booooom!'
-            when 'WARNING'  then warning  'it could be worse'
-            when 'OK'       then ok       'all is fine'
-          end
-        end
-      end
-
-      Foo.run
-      """
-    When I run `ruby check_foo.rb <status>`
-    Then the exit status should be <code>
-    And the stdout should contain "<status>"
-
-    Examples:
-     | status   | code |
-     | UNKNOWN  | 3    |
-     | CRITICAL | 2    |
-     | WARNING  | 1    |
-     | OK       | 0    |
-
-  Scenario: UNKNOWN when no status method was called
-    Given a file named "check_foo" with:
-      """
-      require 'nagiosplugin'
-
-      class Foo < NagiosPlugin::Plugin
-        def check
-        end
-      end
-
-      Foo.run
-      """
-    When I run `ruby check_foo`
-    Then the exit status should be 3
-    And the stdout should contain "UNKNOWN"