nagiosplugin 2.1.1 → 2.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5bb7500269428bb2869fb2d1a2c072fb4211f98d
+  data.tar.gz: 68082b3cf61bb359310cd5503b0131a403632f80
+SHA512:
+  metadata.gz: b0d12d8f990dd210ea2927d76c3727a5ff1d24c490a30489e8b986f3fb3dc585f6994d137fa790f291adc110897fd96800ecbc97e22bc3ed162115f70a4a2655
+  data.tar.gz: 4e8046957f75bac17ae00b663fdfc635da11eb244339dac15874c8f820845955be581952af3953a1d06710e169f136d8517f8473c86ff176030ceb89fa696056

data/README.md

@@ -2,13 +2,9 @@
 
 The one Nagios Plugin framework, forged in the fires of Mount Doom.
 
+[![Gem Version](https://badge.fury.io/rb/nagiosplugin.svg)](http://badge.fury.io/rb/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.1 (see issues
-[#2](https://github.com/bjoernalbers/nagiosplugin/issues/2)
-and
-[#4](https://github.com/bjoernalbers/nagiosplugin/issues/4))!!!**
-
 ## Introduction
 
 NagiosPlugin is an
@@ -66,7 +62,7 @@ doesn't use that either), parse CLI options, etc.
 ### Step 2: Provide some context via status message (optionally).
 
 Ask yourself what might be important to know (and fits into a text
-message) when Nagios just send you an alert in the middle of the night.
+message) when Nagios send you an alert in the middle of the night.
 
 ```Ruby
 def message
@@ -78,12 +74,16 @@ end
 
 ### Step 3: Perform the actual check.
 
-In your binary then call the build-in class method `check` and you're done:
+In your binary then just call the build-in class method `check` and you're done:
 
 ```Ruby
-MyFancyPlugin.check
+MyFancyPlugin.check(options)
 ```
 
+(Optional arguments, i.e. from your favorite [CLI option
+parser](https://www.ruby-toolbox.com/categories/CLI_Option_Parsers), will be
+forwarded to you initializer method.)
+
 This will output the check result and exits in compliance with the
 official
 [Nagios plug-in development
@@ -93,17 +93,6 @@ If anything funky happens in your code: NagiosPlugin does a "blind
 rescue mission" and transforms any execptions to an unknown status.
 
 
-## One more thing...
-
-The API changed completely compared to v1.3 as well as the default command
-line options (they are gone).
-I suggest that you use 3rd party [CLI Option
-Parsers](https://www.ruby-toolbox.com/categories/CLI_Option_Parsers)
-because everyone has different preferences on this.
-
-Please let me know if you find this usefull or if you want to contribute!
-
-
 ## Note on Patches/Pull Requests
 
 * Fork the project and run `bundle install` to resolve all development

data/lib/nagiosplugin/plugin.rb

@@ -8,8 +8,8 @@ module NagiosPlugin
     }
 
     class << self
-      def check
-        plugin = new
+      def check(*args)
+        plugin = new(*args)
         puts plugin.nagios_plugin_output
         exit plugin.nagios_plugin_exit_code
       rescue => e

data/lib/nagiosplugin/version.rb

@@ -1,3 +1,3 @@
 module NagiosPlugin
-  VERSION = '2.1.1'
+  VERSION = '2.2.0'
 end

data/nagiosplugin.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |spec|
   spec.name        = 'nagiosplugin'
   spec.version     = NagiosPlugin::VERSION
   spec.authors     = ['Björn Albers']
-  spec.email       = ['bjoernalbers@googlemail.com']
+  spec.email       = ['bjoernalbers@gmail.com']
   spec.homepage    = 'https://github.com/bjoernalbers/nagiosplugin'
   spec.summary     = "#{spec.name}-#{spec.version}"
   spec.description = 'The one Nagios Plugin framework, forged in the fires of Mount Doom.'
@@ -22,6 +22,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'cucumber'
   spec.add_development_dependency 'aruba'
   spec.add_development_dependency 'guard-cucumber'
-  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rspec', '~> 3.1'
   spec.add_development_dependency 'guard-rspec'
 end

data/spec/nagiosplugin/plugin_spec.rb

@@ -6,31 +6,38 @@ module NagiosPlugin
 
     describe '.check' do
       before do
-        plugin.stub(:nagios_plugin_exit_code  => nil,
-                    :nagios_plugin_output     => nil)
-        Plugin.stub(:puts                     => nil,
-                    :exit                     => nil,
-                    :new                      => plugin)
+        allow(plugin).to receive_messages(
+          nagios_plugin_exit_code:  nil,
+          nagios_plugin_output:     nil)
+        allow(Plugin).to receive_messages(
+          puts: nil,
+          exit: nil,
+          new: plugin)
       end
 
       it 'displays the plugin output on stdout' do
-        plugin.should_receive(:nagios_plugin_output).
+        allow(plugin).to receive(:nagios_plugin_output).
           and_return('chunky bacon')
-        Plugin.should_receive(:puts).with('chunky bacon')
         Plugin.check
+        expect(Plugin).to have_received(:puts).with('chunky bacon')
       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)
+        allow(plugin).to receive(:nagios_plugin_exit_code).and_return(42)
         Plugin.check
+        expect(Plugin).to have_received(:exit).with(42)
+      end
+
+      it 'passed all arguments to the initializer' do
+        Plugin.check(42, fancy: true)
+        expect(Plugin).to have_received(:new).with(42, fancy: true)
       end
 
       context 'when an exception was raised' do
-        let(:exception) { StandardError.new }
+        let(:exception) { StandardError.new('Oops!') }
 
         before do
-          Plugin.stub(:new).and_return { raise 'Oops!' }
+          allow(Plugin).to receive(:new).and_raise(exception)
         end
 
         it 'rescues the exception' do
@@ -38,16 +45,16 @@ module NagiosPlugin
         end
 
         it 'exits with exit code unknown' do
-          Plugin.should_receive(:exit).with(3)
           Plugin.check
+          expect(Plugin).to have_received(:exit).with(3)
         end
 
         it 'displays the exception and backtrace on stdout' do
-          StandardError.any_instance.stub(:backtrace).
-            and_return(%w(Chunky Bacon))
-          Plugin.should_receive(:puts).
-            with("PLUGIN UNKNOWN: Oops!\n\nChunky\nBacon")
+          allow(StandardError).to receive(:new).and_return(exception)
+          allow(exception).to receive(:backtrace).and_return(%w(Chunky Bacon))
           Plugin.check
+          expect(Plugin).to have_received(:puts).
+            with("PLUGIN UNKNOWN: Oops!\n\nChunky\nBacon")
         end
       end
     end
@@ -68,28 +75,40 @@ module NagiosPlugin
 
     describe '#nagios_plugin_status' do
       it 'returns unknown when not critical, warning or ok' do
-        plugin.stub(:critical? => false, :warning? => false, :ok? => false)
+        allow(plugin).to receive_messages(
+          critical?: false,
+          warning?:  false,
+          ok?:       false)
         expect(plugin.send(:nagios_plugin_status)).to eq(:unknown)
       end
 
       it 'returns critical when critical' do
-        plugin.stub(:critical? => true, :warning? => true, :ok? => true)
+        allow(plugin).to receive_messages(
+          critical?: true,
+          warning?:  true,
+          ok?:       true)
         expect(plugin.send(:nagios_plugin_status)).to eq(:critical)
       end
 
       it 'returns warning when warning but not critical' do 
-        plugin.stub(:critical? => false, :warning? => true, :ok? => true)
+        allow(plugin).to receive_messages(
+          critical?: false,
+          warning?:  true,
+          ok?:       true)
         expect(plugin.send(:nagios_plugin_status)).to eq(:warning)
       end
 
       it 'returns ok when ok but not critical or warning' do
-        plugin.stub(:critical? => false, :warning? => false, :ok? => true)
+        allow(plugin).to receive_messages(
+          critical?: false,
+          warning?:  false,
+          ok?:       true)
         expect(plugin.send(:nagios_plugin_status)).to eq(:ok)
       end
 
-      it 'saves the status' do
+      it 'caches the status' do
         [:critical?, :warning?, :ok?].each do |check|
-          plugin.should_receive(check).once.and_return(false)
+          allow(plugin).to receive(check).once.and_return(false)
         end
         expect(plugin.send(:nagios_plugin_status)).to eq(:unknown)
         expect(plugin.send(:nagios_plugin_status)).to eq(:unknown)
@@ -98,44 +117,44 @@ module NagiosPlugin
 
     describe '#nagios_plugin_exit_code' do
       it 'returns 3 when unknown' do
-        plugin.should_receive(:nagios_plugin_status).and_return(:unknown)
+        allow(plugin).to receive(:nagios_plugin_status).and_return(:unknown)
         expect(plugin.send(:nagios_plugin_exit_code)).to eq(3)
       end
 
       it 'returns 2 when critical' do
-        plugin.should_receive(:nagios_plugin_status).and_return(:critical)
+        allow(plugin).to receive(:nagios_plugin_status).and_return(:critical)
         expect(plugin.send(:nagios_plugin_exit_code)).to eq(2)
       end
 
       it 'returns 1 when warning' do
-        plugin.should_receive(:nagios_plugin_status).and_return(:warning)
+        allow(plugin).to receive(:nagios_plugin_status).and_return(:warning)
         expect(plugin.send(:nagios_plugin_exit_code)).to eq(1)
       end
       
       it 'returns 0 when ok' do
-        plugin.should_receive(:nagios_plugin_status).and_return(:ok)
+        allow(plugin).to receive(:nagios_plugin_status).and_return(:ok)
         expect(plugin.send(:nagios_plugin_exit_code)).to eq(0)
       end
     end
 
     describe '#nagios_plugin_output' do
       before do
-        plugin.stub(:nagios_plugin_status)
+        allow(plugin).to receive(:nagios_plugin_status)
       end
 
       it 'joins the service name and the upcased status' do
-        plugin.should_receive(:nagios_plugin_service).and_return('FRIED')
-        plugin.should_receive(:nagios_plugin_status).and_return(:chicken)
+        allow(plugin).to receive(:nagios_plugin_service).and_return('FRIED')
+        allow(plugin).to receive(:nagios_plugin_status).and_return(:chicken)
         expect(plugin.send(:nagios_plugin_output)).to match(/^FRIED CHICKEN$/)
       end
 
       it 'includes a custom plugin message if present' do
-        plugin.stub(:message => 'ALL U CAN EAT!')
+        allow(plugin).to receive(:message).and_return('ALL U CAN EAT!')
         expect(plugin.send(:nagios_plugin_output)).to match(/: ALL U CAN EAT!$/)
       end
 
-      it 'should not append message if message is empty' do
-        plugin.stub(:message => '')
+      it 'does not append message if message is empty' do
+        allow(plugin).to receive(:message).and_return('')
         expect(plugin.send(:nagios_plugin_output)).not_to match(/:/)
       end
 

metadata

@@ -1,115 +1,102 @@
 --- !ruby/object:Gem::Specification
 name: nagiosplugin
 version: !ruby/object:Gem::Version
-  version: 2.1.1
-  prerelease: 
+  version: 2.2.0
 platform: ruby
 authors:
 - Björn Albers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-12 00:00:00.000000000 Z
+date: 2014-11-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: cucumber
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: aruba
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: guard-cucumber
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.1'
 - !ruby/object:Gem::Dependency
   name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: The one Nagios Plugin framework, forged in the fires of Mount Doom.
 email:
-- bjoernalbers@googlemail.com
+- bjoernalbers@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -130,34 +117,27 @@ files:
 homepage: https://github.com/bjoernalbers/nagiosplugin
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -4572774117514092169
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -4572774117514092169
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
-summary: nagiosplugin-2.1.1
+specification_version: 4
+summary: nagiosplugin-2.2.0
 test_files:
 - features/nagiosplugin_usage.feature
 - features/support/env.rb