nagiosplugin 2.0.0 → 2.1.0

data/README.md

@@ -1,14 +1,22 @@
 # NagiosPlugin
 
-The one [Nagios](http://www.nagios.org/) Plugin framework, forged in the
-fires of Mount Doom.
+The one Nagios Plugin framework, forged in the fires of Mount Doom.
 
-[![Build
-Status](https://secure.travis-ci.org/bjoernalbers/nagiosplugin.png)](http://travis-ci.org/bjoernalbers/nagiosplugin)
+[![Build Status](https://secure.travis-ci.org/bjoernalbers/nagiosplugin.png)](http://travis-ci.org/bjoernalbers/nagiosplugin)
 
-**NOTE: The API has changed since version 2.0 (see issue
-[#2](https://github.com/bjoernalbers/nagiosplugin/issues/2))!!!**
+**NOTE: The API has changed since version 2.1 (see issues
+[#2](https://github.com/bjoernalbers/nagiosplugin/issues/2)
+and
+[#4](https://github.com/bjoernalbers/nagiosplugin/issues/4))!!!**
 
+## Introduction
+
+NagiosPlugin is an
+[embarrassingly simple](https://github.com/bjoernalbers/nagiosplugin/blob/master/lib/nagiosplugin/plugin.rb)
+framework to write custom monitoring plugins for
+[Nagios](http://www.nagios.org/).
+It was born out of duplication, because all nagios plugins share some
+common behaviour...
 
 ## Installation
 
@@ -70,10 +78,10 @@ end
 
 ### Step 3: Perform the actual check.
 
-In your binary then call `check!` on your class and you're done:
+In your binary then call the build-in class method `check` and you're done:
 
 ```Ruby
-MyFancyPlugin.new.check!
+MyFancyPlugin.check
 ```
 
 This will output the check result and exits in compliance with the

data/features/nagiosplugin_usage.feature

@@ -27,7 +27,7 @@ Feature: NagiosPlugin Usage
         end
       end
 
-      FancyPlugin.new.check!
+      FancyPlugin.check
       """
     When I run `ruby check_fancy.rb`
     Then the exit status should be <code>

data/lib/nagiosplugin/plugin.rb

@@ -7,12 +7,27 @@ module NagiosPlugin
       :ok       => 0
     }
 
-    def check!
-      puts nagios_plugin_output
-      exit nagios_plugin_exit_code
-    rescue => e
-      puts "PLUGIN UNKNOWN: #{e.to_s}\n\n#{e.backtrace}"
-      exit NAGIOS_PLUGIN_EXIT_CODES[:unknown]
+    class << self
+      def check
+        plugin = new
+        puts plugin.nagios_plugin_output
+        exit plugin.nagios_plugin_exit_code
+      rescue => e
+        pretty_error = ([e.to_s, nil] + e.backtrace).join("\n")
+        puts "PLUGIN UNKNOWN: #{pretty_error}"
+        exit NAGIOS_PLUGIN_EXIT_CODES[:unknown]
+      end
+    end
+
+    def nagios_plugin_exit_code
+      NAGIOS_PLUGIN_EXIT_CODES[nagios_plugin_status]
+    end
+
+    def nagios_plugin_output
+      output = [nagios_plugin_service] << ' '
+      output << nagios_plugin_status.to_s.upcase
+      output << ': ' + message if respond_to?(:message)
+      output.join
     end
 
   private
@@ -27,19 +42,8 @@ module NagiosPlugin
         end
     end
 
-    def nagios_plugin_exit_code
-      NAGIOS_PLUGIN_EXIT_CODES[nagios_plugin_status]
-    end
-
     def nagios_plugin_service
       self.class.name.split('::').last.gsub(/plugin$/i, '').upcase
     end
-
-    def nagios_plugin_output
-      output = [nagios_plugin_service] << ' '
-      output << nagios_plugin_status.to_s.upcase
-      output << ': ' + message if respond_to?(:message)
-      output.join
-    end
   end
 end

data/lib/nagiosplugin/version.rb

@@ -1,3 +1,3 @@
 module NagiosPlugin
-  VERSION = '2.0.0'
+  VERSION = '2.1.0'
 end

data/spec/nagiosplugin/plugin_spec.rb

@@ -4,49 +4,50 @@ module NagiosPlugin
   describe Plugin do
     let(:plugin) { Plugin.new }
 
-    describe '#check!' do
+    describe '.check' do
       before do
-        plugin.stub(:puts                     => nil,
-                    :exit                     => nil,
-                    :nagios_plugin_exit_code  => nil,
+        plugin.stub(:nagios_plugin_exit_code  => nil,
                     :nagios_plugin_output     => nil)
+        Plugin.stub(:puts                     => nil,
+                    :exit                     => nil,
+                    :new                      => plugin)
       end
 
       it 'displays the plugin output on stdout' do
-        plugin.should_receive(:nagios_plugin_output).and_return('chunky bacon')
-        plugin.should_receive(:puts).with('chunky bacon')
-        plugin.check!
+        plugin.should_receive(:nagios_plugin_output).
+          and_return('chunky bacon')
+        Plugin.should_receive(:puts).with('chunky bacon')
+        Plugin.check
       end
 
       it 'exits with the status exit code' do
         plugin.should_receive(:nagios_plugin_exit_code).and_return(42)
-        plugin.should_receive(:exit).with(42)
-        plugin.check!
+        Plugin.should_receive(:exit).with(42)
+        Plugin.check
       end
 
       context 'when an exception was raised' do
         let(:exception) { StandardError.new }
 
         before do
-          plugin.stub(:nagios_plugin_output).and_return { raise }
+          Plugin.stub(:new).and_return { raise 'Oops!' }
         end
 
         it 'rescues the exception' do
-          expect { plugin.check! }.to_not raise_error
+          expect { Plugin.check }.to_not raise_error
         end
 
         it 'exits with exit code unknown' do
-          plugin.should_receive(:exit).with(3)
-          plugin.check!
+          Plugin.should_receive(:exit).with(3)
+          Plugin.check
         end
 
         it 'displays the exception and backtrace on stdout' do
-          plugin.stub(:nagios_plugin_output).and_return { raise 'Oops!' }
           StandardError.any_instance.stub(:backtrace).
-            and_return('Chunky Bacon')
-          plugin.should_receive(:puts).
-            with("PLUGIN UNKNOWN: Oops!\n\nChunky Bacon")
-          plugin.check!
+            and_return(%w(Chunky Bacon))
+          Plugin.should_receive(:puts).
+            with("PLUGIN UNKNOWN: Oops!\n\nChunky\nBacon")
+          Plugin.check
         end
       end
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nagiosplugin
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-19 00:00:00.000000000 Z
+date: 2013-10-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -145,7 +145,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1579051430854649941
+      hash: 1074742340015625013
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -154,13 +154,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1579051430854649941
+      hash: 1074742340015625013
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
-summary: nagiosplugin-2.0.0
+summary: nagiosplugin-2.1.0
 test_files:
 - features/nagiosplugin_usage.feature
 - features/support/env.rb