nagiosplugin 1.3.0 → 2.0.0

data/.gitignore

@@ -1,6 +1,18 @@
 *.gem
+*.rbc
 .bundle
+.config
+.yardoc
 Gemfile.lock
-pkg/*
-tmp/*
-vendor/*
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+vendor

data/.rbenv-version

@@ -0,0 +1 @@
+1.9.3-p385

data/Gemfile

@@ -1,4 +1,4 @@
-source "http://rubygems.org"
+source 'https://rubygems.org'
 
-# Specify your gem's dependencies in nagiosplugin.gemspec
+# Specify your gem's dependencies in ..gemspec
 gemspec

data/{LICENSE → LICENSE.txt}

@@ -1,4 +1,6 @@
-Copyright (c) 2011 Björn Albers
+Copyright (c) 2013 Björn Albers
+
+MIT License
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -1,51 +1,121 @@
 # NagiosPlugin
 
-The one [Nagios](http://www.nagios.org/) Plugin framework, forged in the fires of Mount Doom.
+The one [Nagios](http://www.nagios.org/) 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)
+
+**NOTE: The API has changed since version 2.0 (see issue
+[#2](https://github.com/bjoernalbers/nagiosplugin/issues/2))!!!**
 
-[![Build Status](https://secure.travis-ci.org/bjoernalbers/nagiosplugin.png)](http://travis-ci.org/bjoernalbers/nagiosplugin)
 
 ## Installation
 
-	gem install nagiosplugin
+Via bundler: Add this to your Gemfile and run `bundle install`:
+
+```Ruby
+gem 'nagiosplugin'
+```
+
+Manually via Rubygems: Run `gem install nagiosplugin`.
+
 
 ## Usage
 
-### Step 1
+Writing your custom plugin is really simple:
+
+### Step 1: Describe when something is critical, warning and ok.
+
+Create your subclass from `NagiosPlugin::Plugin` and define these
+instance methods to determine the status:
+
+```Ruby
+require 'nagiosplugin'
+
+class MyFancyPlugin < NagiosPlugin::Plugin
+  def critical?
+    # Enter your code here (returns true when critical, else false).
+  end
+
+  def warning?
+    # Enter your code here (returns true when warning, else false).
+  end
+
+  def ok?
+    # Enter your code... you get the idea.
+  end
+end
+```
 
-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.)
+**Please keep in mind that the "worst" status always wins, i.e. if both
+`critical?` and `warning?` are true then the status would be critical
+(if none is true, then the status would be unknown of course)!**
 
-Take a look at a working [usage
-example](https://github.com/bjoernalbers/nagiosplugin/blob/master/features/nagiosplugin_usage.feature).
+You may use your `initialize` method to setup check data (NagiosPlugin
+doesn't use that either), parse CLI options, etc.
 
-### Step 2
+### Step 2: Provide some context via status message (optionally).
 
-Call the `run` method on your new class, which outputs the check result
-and exits in compliance with the official [Nagios plug-in development
+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.
+
+```Ruby
+def message
+  # Create an info string (this will be printed after the
+  # status on stdout).
+  # Service name, status and message should be longer than 78 chars!!!
+end
+```
+
+### Step 3: Perform the actual check.
+
+In your binary then call `check!` on your class and you're done:
+
+```Ruby
+MyFancyPlugin.new.check!
+```
+
+This will output the check result and exits in compliance with the
+official
+[Nagios plug-in development
 guidelines](http://nagiosplug.sourceforge.net/developer-guidelines.html)
 
-### Step 3
+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!
 
-Profit... and maybe also fun.
 
 ## Note on Patches/Pull Requests
 
-* Fork the project and run `bundle install` to resolve all development dependencies.
-* Add specs and/or features for it. This is important so I don't break it in a future version unintentionally.
+* Fork the project and run `bundle install` to resolve all development
+  dependencies.
+* Add specs and/or features for it. This is important so I don't break
+  it in a future version unintentionally.
 * Make your feature addition or bug fix.
 * Commit, do not mess with the Rakefile or gemspec.
-  (If you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull.)
+  (If you want to have your own version, that is fine but bump version
+in a commit by itself I can ignore when I pull.)
 * Send me a pull request. Bonus points for topic branches.
 
+
 ## Acknowledgments
 
 Thanks to the following contributors for improving NagiosPlugin:
 
-* [szuecs (Sandor Szücs)](https://github.com/szuecs): Adding default
-  options, perfdata stuff and helpful sample code.
+* [szuecs (Sandor Szücs)](https://github.com/szuecs)
+
 
 ## Copyright
 
-Copyright (c) 2011-2012 Björn Albers. See LICENSE for details.
+Copyright (c) 2011-2013 Björn Albers. See LICENSE for details.

data/Rakefile

@@ -2,13 +2,13 @@ require 'bundler/gem_tasks'
 
 require 'cucumber/rake/task'
 Cucumber::Rake::Task.new(:features) do |t|
-  t.cucumber_opts = '--format pretty'
+    t.cucumber_opts = '--format pretty'
 end
 
 require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new do |t|
-  t.rspec_opts = %w[--color]
-  t.pattern = './spec/**/*_spec.rb'
+    t.rspec_opts = %w[--color]
+      t.pattern = './spec/**/*_spec.rb'
 end
 
 task :default => :spec

data/features/nagiosplugin_usage.feature

@@ -5,24 +5,31 @@ Feature: NagiosPlugin Usage
   I want to use the one NagiosPlugin framework
 
   Scenario Outline: Subclass from NagiosPlugin
-    Given a file named "check_foo.rb" with:
+    Given a file named "check_fancy.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
+      class FancyPlugin < NagiosPlugin::Plugin
+        def critical?
+          <critical>
+        end
+
+        def warning?
+          <warning>
+        end
+
+        def ok?
+          <ok>
+        end
+
+        def message
+          'answer is 42'
         end
       end
 
-      Foo.run
+      FancyPlugin.new.check!
       """
-    When I run `ruby check_foo.rb <status>`
+    When I run `ruby check_fancy.rb`
     Then the exit status should be <code>
     And the stdout should contain exactly:
       """
@@ -31,8 +38,8 @@ Feature: NagiosPlugin Usage
       """
 
     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            |
+     | critical | warning | ok    | status   | code | stdout                       |
+     | true     | true    | true  | CRITICAL | 2    | FANCY CRITICAL: answer is 42 |
+     | false    | true    | true  | WARNING  | 1    | FANCY WARNING: answer is 42  |
+     | false    | false   | true  | OK       | 0    | FANCY OK: answer is 42       |
+     | false    | false   | false | UNKNOWN  | 3    | FANCY UNKNOWN: answer is 42  |

data/lib/nagiosplugin.rb

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

data/lib/nagiosplugin/plugin.rb

@@ -1,106 +1,45 @@
-require "optparse"
-
 module NagiosPlugin
   class Plugin
-    class << self
-      def parse_options(options, &blk2)
-        OptionParser.new do |opts|
-          opts.banner  = "% #{$0} [options]"
-          opts.separator ""
-          opts.separator "Specific options:"
-          opts.separator ""
-
-          opts.on('-h', '--help', 'Display this help.') do
-            abort "#{opts}"
-          end
-
-          opts.on('-r', '--reverse', 'Reverse thresholds.') do |b|
-            options[:reverse] = b
-          end
-
-          opts.on('-w', '--warn <n>', 'Warning threshold.') do |s|
-            options[:warn] = s.to_i
-          end
-
-          opts.on('-c', '--crit <n>', 'Critical threshold.') do |s|
-            options[:crit] = s.to_i
-          end
-
-          blk2.call(opts)
-
-          begin
-            opts.parse!
-          rescue => e
-            abort "#{e}\n\n#{opts}"
-          end
-        end
-
-        options
-      end
-
-      # Create new instance and run it.
-      def run(*args)
-        self.new(*args).run
-      end
-
-    private
-
-      # @macro [status] message
-      #   @method $1(message)
-      #   Raise $1 StatusError with message
-      #   @param [String] message the exeption message
-      def make(status)
-        define_method(status) do |message|
-          raise StatusError.new(status, message)
-        end
-      end
+    NAGIOS_PLUGIN_EXIT_CODES = {
+      :unknown  => 3,
+      :critical => 2,
+      :warning  => 1,
+      :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]
     end
 
-    make :ok
-    make :warning
-    make :critical
-    make :unknown
+  private
 
-    def initialize(options={})
-      @warn = options[:warn] if options[:warn]
-      @crit = options[:crit] if options[:crit]
-      @reverse = options[:reverse] if options[:reverse]
+    def nagios_plugin_status
+      @nagios_plugin_status ||=
+        case
+        when critical? then :critical
+        when warning?  then :warning
+        when ok?       then :ok
+        else                :unknown
+        end
     end
 
-
-    # Overwrite this check method and call a status method within.
-    def check
-      unknown 'please overwrite the `check` method in your class'
+    def nagios_plugin_exit_code
+      NAGIOS_PLUGIN_EXIT_CODES[nagios_plugin_status]
     end
 
-    # Return the service name, which will be displayed on stdout.
-    #
-    # By default this will be the upcased class name. If you want
-    # to name your service different than the class then overwrite
-    # this method.
-    #
-    # @return [String] the service name
-    def service
-      self.class.name.upcase
+    def nagios_plugin_service
+      self.class.name.split('::').last.gsub(/plugin$/i, '').upcase
     end
 
-    # Run check and return result in a nagios-compatible format.
-    #
-    # It will...
-    # - execute your check method
-    # - output the result in a nagios-compatible format (SERVICE STATUS: Message)
-    # - exit according to the status
-    def run
-      check
-    rescue StatusError => e
-    rescue => e
-      e = StatusError.new(:unknown, ([e.to_s, nil] + e.backtrace).join("\n"))
-    else
-      e = StatusError.new(:unknown, 'no status method was called')
-    ensure
-      puts [service, e.to_s].join(' ')
-      exit e.to_i
+    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 = '1.3.0'
+  VERSION = '2.0.0'
 end

data/nagiosplugin.gemspec

@@ -1,25 +1,27 @@
-# -*- encoding: utf-8 -*-
-$:.push File.expand_path('../lib', __FILE__)
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'nagiosplugin/version'
 
-Gem::Specification.new do |s|
-  s.name        = 'nagiosplugin'
-  s.version     = NagiosPlugin::VERSION
-  s.authors     = ['Björn Albers']
-  s.email       = ['bjoernalbers@googlemail.com']
-  s.homepage    = 'https://github.com/bjoernalbers/nagiosplugin'
-  s.summary     = "#{s.name}-#{s.version}"
-  s.description = 'The one Nagios Plugin framework, forged in the fires of Mount Doom.'
+Gem::Specification.new do |spec|
+  spec.name        = 'nagiosplugin'
+  spec.version     = NagiosPlugin::VERSION
+  spec.authors     = ['Björn Albers']
+  spec.email       = ['bjoernalbers@googlemail.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.'
+  spec.license     = 'MIT'
 
-  s.files         = `git ls-files`.split("\n")
-  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
-  s.require_paths = ['lib']
+  spec.files         = `git ls-files`.split("\n")
+  spec.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  spec.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  spec.require_paths = ['lib']
 
-  s.add_development_dependency 'rake'
-  s.add_development_dependency 'cucumber'
-  s.add_development_dependency 'aruba'
-  s.add_development_dependency 'guard-cucumber'
-  s.add_development_dependency 'rspec'
-  s.add_development_dependency 'guard-rspec'
+  spec.add_development_dependency 'rake'
+  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 'guard-rspec'
 end

data/spec/nagiosplugin/plugin_spec.rb

@@ -1,119 +1,137 @@
 require 'spec_helper'
 
-describe NagiosPlugin::Plugin do
-  before do
-    class MyPlugin < NagiosPlugin::Plugin; end
-    @plugin = MyPlugin.new
+module NagiosPlugin
+  describe Plugin do
+    let(:plugin) { Plugin.new }
 
-    class MergedOptionsPlugin < NagiosPlugin::Plugin
-      def initialize(options, &blk)
-        super(options, &blk)
-        @foo = options[:foo]
+    describe '#check!' do
+      before do
+        plugin.stub(:puts                     => nil,
+                    :exit                     => nil,
+                    :nagios_plugin_exit_code  => nil,
+                    :nagios_plugin_output     => nil)
       end
-      attr_reader :warn, :crit, :reverse, :foo
-    end
-    @plugin_with_options = MergedOptionsPlugin.new({:warn => 5, :crit => 1, :reverse => true, :foo => "bar"})  do |opts|
-      opts.on('--foo <s>', 'A test option.') do |s|
-        options[:foo] = s
+
+      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!
       end
-    end
-  end
 
-  describe '#initialize' do
-    it "should have attributes" do
-      @plugin_with_options.should satisfy { |o|
-        o.warn == 5 and o.crit == 1 and o.reverse and o.foo == "bar"
-      }
-    end
-  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!
+      end
 
-  describe '#run' do
-    before do
-      @plugin.stub(:puts)
-      @plugin.stub(:exit)
-    end
+      context 'when an exception was raised' do
+        let(:exception) { StandardError.new }
 
-    it 'should run the check method' do
-      @plugin.should_receive(:check).with(no_args)
-      @plugin.run
-    end
+        before do
+          plugin.stub(:nagios_plugin_output).and_return { raise }
+        end
 
-    it 'should output the servie name' do
-      @plugin.stub(:service).and_return('MY_FUNKY_PLUGIN')
-      @plugin.should_receive(:puts).with(/MY_FUNKY_PLUGIN/)
-      @plugin.run
-    end
+        it 'rescues the exception' do
+          expect { plugin.check! }.to_not raise_error
+        end
 
-    it 'should output an appropriate message when check was not overwritten' do
-      @plugin.should_receive(:puts).with(/please overwrite the `check` method in your class/i)
-      @plugin.run
-    end
+        it 'exits with exit code unknown' do
+          plugin.should_receive(:exit).with(3)
+          plugin.check!
+        end
 
-    context 'when an unknown exception was raised' do
-      before do
-        StandardError.any_instance.stub(:backtrace).and_return(%w[foo bar baz])
-        def @plugin.check
-          raise StandardError, 'Oops!'
+        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!
         end
       end
+    end
 
-      it 'should output the execptions message' do
-        @plugin.should_receive(:puts).with(/Oops!/)
-        @plugin.run
+    describe '#nagios_plugin_service' do
+      it 'returns the upcased class name' do
+        class Foo < Plugin; end
+        plugin = Foo.new
+        expect(plugin.send(:nagios_plugin_service)).to eq('FOO')
       end
 
-      it 'should output the exceptions backtrace' do
-        @plugin.should_receive(:puts).with(/foo\nbar\nbaz/)
-        @plugin.run
+      it 'strips "Plugin" from the class name' do
+        class BarPlugin < Plugin; end
+        plugin = BarPlugin.new
+        expect(plugin.send(:nagios_plugin_service)).to eq('BAR')
       end
+    end
 
-      it 'should exit unknown' do
-        @plugin.should_receive(:exit).with(3)
-        @plugin.run
+    describe '#nagios_plugin_status' do
+      it 'returns unknown when not critical, warning or ok' do
+        plugin.stub(:critical? => false, :warning? => false, :ok? => false)
+        expect(plugin.send(:nagios_plugin_status)).to eq(:unknown)
       end
-    end
 
-    context 'when no exception was raised' do
-      before { def @plugin.check; end }
+      it 'returns critical when critical' do
+        plugin.stub(:critical? => true, :warning? => true, :ok? => true)
+        expect(plugin.send(:nagios_plugin_status)).to eq(:critical)
+      end
 
-      it 'should display a hint for the developer' do
-        @plugin.should_receive(:puts).with(/no status method was called/i)
-        @plugin.run
+      it 'returns warning when warning but not critical' do 
+        plugin.stub(:critical? => false, :warning? => true, :ok? => true)
+        expect(plugin.send(:nagios_plugin_status)).to eq(:warning)
       end
 
-      it 'should exit unknown' do
-        @plugin.should_receive(:exit).with(3)
-        @plugin.run
+      it 'returns ok when ok but not critical or warning' do
+        plugin.stub(:critical? => false, :warning? => false, :ok? => true)
+        expect(plugin.send(:nagios_plugin_status)).to eq(:ok)
       end
-    end
 
-    context 'when a status error was raised' do
-      before do
-        def @plugin.check
-          raise NagiosPlugin::StatusError.new(:ok, 'hello, world.')
+      it 'saves the status' do
+        [:critical?, :warning?, :ok?].each do |check|
+          plugin.should_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)
       end
+    end
 
-      it 'should output the status type' do
-        @plugin.should_receive(:puts).with(/OK/)
-        @plugin.run
+    describe '#nagios_plugin_exit_code' do
+      it 'returns 3 when unknown' do
+        plugin.should_receive(:nagios_plugin_status).and_return(:unknown)
+        expect(plugin.send(:nagios_plugin_exit_code)).to eq(3)
       end
 
-      it 'should output the status message' do
-        @plugin.should_receive(:puts).with(/hello, world\./)
-        @plugin.run
+      it 'returns 2 when critical' do
+        plugin.should_receive(:nagios_plugin_status).and_return(:critical)
+        expect(plugin.send(:nagios_plugin_exit_code)).to eq(2)
       end
 
-      it 'should exit with the exit status from status error' do
-        @plugin.should_receive(:exit).with(0)
-        @plugin.run
+      it 'returns 1 when warning' do
+        plugin.should_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)
+        expect(plugin.send(:nagios_plugin_exit_code)).to eq(0)
       end
     end
-  end
 
-  describe '#service' do
-    it 'should return the upcased class name' do
-      @plugin.service.should eql('MYPLUGIN')
+    describe '#nagios_plugin_output' do
+      before do
+        plugin.stub(: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)
+        expect(plugin.send(:nagios_plugin_output)).to match(/^FRIED CHICKEN$/)
+      end
+
+      it 'includes a custom plugin message if present' do
+        plugin.should_receive(:message).and_return('ALL U CAN EAT!')
+        expect(plugin.send(:nagios_plugin_output)).to match(/: ALL U CAN EAT!$/)
+      end
     end
   end
 end

metadata

@@ -1,175 +1,168 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: nagiosplugin
-version: !ruby/object:Gem::Version 
-  hash: 27
+version: !ruby/object:Gem::Version
+  version: 2.0.0
   prerelease: 
-  segments: 
-  - 1
-  - 3
-  - 0
-  version: 1.3.0
 platform: ruby
-authors: 
-- "Bj\xC3\xB6rn Albers"
+authors:
+- Björn Albers
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-08-30 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  prerelease: false
-  type: :development
+date: 2013-09-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: rake
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  prerelease: 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
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  prerelease: 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
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  prerelease: 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
-  version_requirements: *id004
-- !ruby/object:Gem::Dependency 
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  prerelease: 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
-  version_requirements: *id005
-- !ruby/object:Gem::Dependency 
-  requirement: &id006 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  prerelease: 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-rspec
-  version_requirements: *id006
+  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: 
+email:
 - bjoernalbers@googlemail.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
+- .rbenv-version
 - .travis.yml
 - Gemfile
 - Guardfile
-- LICENSE
+- LICENSE.txt
 - README.md
 - Rakefile
-- examples/check_file_exists.rb
-- examples/check_perfdata.rb
 - features/nagiosplugin_usage.feature
-- features/steps/dev_steps.rb
 - features/support/env.rb
 - lib/nagiosplugin.rb
-- lib/nagiosplugin/default_options.rb
-- lib/nagiosplugin/perfdata.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: []
-
+licenses:
+- MIT
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+      hash: 1579051430854649941
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
+      hash: 1579051430854649941
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
-summary: nagiosplugin-1.3.0
-test_files: 
+summary: nagiosplugin-2.0.0
+test_files:
 - 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/examples/check_file_exists.rb

@@ -1,62 +0,0 @@
-#!/usr/bin/env ruby
-
-$:.unshift(File.dirname(__FILE__) + "/lib")
-
-require "nagiosplugin"
-require "nagiosplugin/default_options"
-
-class MyPlugin < NagiosPlugin::Plugin
-  include NagiosPlugin::DefaultOptions
-
-  VERSION = 1.0
-
-  class << self
-    def run(*args)
-      self.new(*args).run
-    end
-  end
-
-  def parse_options(*args)
-    @options = {}
-    OptionParser.new do |opts|
-      opts.banner  = "% #{File.basename($0)} --filename <file>"
-      opts.separator ""
-      opts.separator "Specific options:"
-      opts.separator ""
-
-      opts.on('-f', '--filename <name>', 'Filename that should exist.') do |s|
-        @options[:filename] = s
-      end
-
-      yield(opts) if block_given?
-
-      begin
-        opts.parse!(args)
-        @options
-      rescue => e
-        puts "#{e}\n\n#{opts}"
-        exit(3)
-      end
-    end
-  end
-
-  def initialize(*args)
-    parse_options(*args, &default_options)
-    @warn = @options[:warn] if @options[:warn]
-    @crit = @options[:crit] if @options[:crit]
-    @reverse = @options[:reverse] if @options[:reverse]
-    @filename = @options[:filename]
-  end
-
-  def check
-    if File.executable?(@filename)
-      ok("#{@filename} is excutable")
-    elsif File.exists?(@filename)
-      warning("#{@filename} is not excutable")
-    else
-      critical("#{@filename} does not exist")
-    end
-  end
-end
-
-MyPlugin.run(*ARGV)

data/examples/check_perfdata.rb

@@ -1,30 +0,0 @@
-require "nagiosplugin"
-require "nagiosplugin/plugin"
-require "nagiosplugin/perfdata"
-
-class CheckPerfdata < NagiosPlugin::Plugin
-  include NagiosPlugin::Perfdata
-
-  def check
-    sleep 0.4
-    pd = PerfData.new
-    pd.val = 40
-    pd.warn = 25
-    pd.crit = 50
-    pd.min = 1
-    pd.max = 90
-    pd.uom = "%"
-
-    @perfdata = {
-      :pd => pd,
-      :baz => PerfData.new(1),
-      :foo => PerfData.new(1,2,3),
-      :bar => PerfData.new(4,5,6,7,8),
-    }
-    ok('super perfdata')
-    sleep 0.2
-  end
-
-end
-
-CheckPerfdata.run

data/features/steps/dev_steps.rb

@@ -1,17 +0,0 @@
-When /^I run a plugin with the following methods:$/ do |methods|
-  steps %Q{
-    Given a file named "check_foo" with:
-			"""
-			require 'nagiosplugin'
-			class Foo < NagiosPlugin::Plugin
-        #{methods}
-  		end
-			Foo.new.run
-			"""
-		When I run `ruby check_foo`
-  }
-end
-
-Then /^the plugin should print "([^"]*)"$/ do |stdout|
-  steps %Q{Then the stdout should contain "FOO #{stdout}"}
-end

data/lib/nagiosplugin/default_options.rb

@@ -1,78 +0,0 @@
-require "optparse"
-
-module NagiosPlugin
-  module DefaultOptions
-    def parse_num(s)
-      if s.include? "."
-        s.to_f
-      else
-        s.to_i
-      end
-    end
-
-    def parse_start_num(s)
-      if s.include? '~'
-        s.delete!('~')
-        Float::MIN
-      else
-        parse_num(s)
-      end
-    end
-    def parse_reverse(s)
-      if s.include? '@'
-        s.delete!('@')
-        @options[:invert] = true
-      end
-    end
-
-    def parse_nagios_style(s)
-      parse_reverse(s)
-
-      if not s.include? ':'
-        s = ":" + s
-      end
-
-      start, stop = s.split(':')
-      if start.empty?
-        # :m
-        start = 0
-        stop = parse_num(stop)
-      elsif stop.empty?
-        # n:
-        start = parse_start_num(start)
-        stop = Float::MAX
-      else
-        # n:m
-        start = parse_start_num(start)
-        stop = parse_num(stop)
-      end
-      start..stop
-    end
-
-    def default_options
-      lambda do |opts|
-        opts.separator ""
-        opts.separator "Default options:"
-        opts.separator ""
-
-        opts.on('-h', '--help', 'Display this help.') do
-          puts "#{opts}"
-          exit(3)
-        end
-
-        opts.on('-V', '--version', 'Print version.') do |s|
-          puts "#{File.basename($0)} #{VERSION}"
-          exit(3)
-        end
-
-        opts.on('-w', '--warn <n:m>', 'Warning threshold.') do |s|
-          @options[:warn] = parse_nagios_style(s)
-        end
-
-        opts.on('-c', '--crit <n:m>', 'Critical threshold.') do |s|
-          @options[:crit] = parse_nagios_style(s)
-        end
-      end
-    end
-  end
-end

data/lib/nagiosplugin/perfdata.rb

@@ -1,40 +0,0 @@
-module NagiosPlugin
-  module Perfdata
-    _perfdata = Struct.new :val, :warn, :crit, :min, :max, :uom
-    PerfData = _perfdata
-
-    def get_perfdata
-      if @perfdata.class == PerfData
-        @perfdata.select {|e| e}.join(';')
-      else
-        @perfdata.map do |k,v|
-          "#{k}=" + v.select {|e| e}.join(';')
-        end.join(' ')
-      end
-    end
-
-    # Run check and return result in a nagios-compatible format.
-    #
-    # It will...
-    # - execute your check method
-    # - output the result in a nagios-compatible format (SERVICE STATUS: Message)
-    # - exit according to the status
-    def run
-      t1 = Time.now
-      check
-    rescue StatusError => e
-    rescue => e
-      e = StatusError.new(:unknown, ([e.to_s, nil] + e.backtrace).join("\n"))
-    else
-      e = StatusError.new(:unknown, 'no status method was called')
-    ensure
-      t2 = Time.now
-      msg = [service, e.to_s].join(' ')
-      perfdata = get_perfdata
-      t = t2 - t1
-      puts "#{msg}|time=#{t} #{perfdata}"
-      exit e.to_i
-    end
-
-  end
-end

data/lib/nagiosplugin/status_error.rb

@@ -1,32 +0,0 @@
-module NagiosPlugin
-
-    # A custom status error which will be raised through the status methods.
-    class StatusError < StandardError
-
-      # All allowed statuses sorted by their exit code
-      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/spec/nagiosplugin/status_error_spec.rb

@@ -1,33 +0,0 @@
-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