nagiosplugin 1.1.2 → 1.2.0

data/lib/nagiosplugin/plugin.rb

@@ -30,22 +30,33 @@ module NagiosPlugin
       unknown 'please overwrite the `check` method in your class'
     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 [self.class.name.upcase, e.to_s].join(' ')
-     exit e.to_i
-   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
+    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
+    end
   end
 end

data/lib/nagiosplugin/version.rb

@@ -1,3 +1,3 @@
 module NagiosPlugin
-  VERSION = '1.1.2'
+  VERSION = '1.2.0'
 end

data/spec/nagiosplugin/plugin_spec.rb

@@ -17,9 +17,9 @@ describe NagiosPlugin::Plugin do
       @plugin.run
     end
 
-    it 'should output the class name' do
-      def @plugin.check; end
-      @plugin.should_receive(:puts).with(/MYPLUGIN/)
+    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
 
@@ -89,4 +89,10 @@ describe NagiosPlugin::Plugin do
       end
     end
   end
+
+  describe '#service' do
+    it 'should return the upcased class name' do
+      @plugin.service.should eql('MYPLUGIN')
+    end
+  end
 end

metadata

@@ -1,116 +1,89 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: nagiosplugin
-version: !ruby/object:Gem::Version 
-  hash: 23
+version: !ruby/object:Gem::Version
+  version: 1.2.0
   prerelease: 
-  segments: 
-  - 1
-  - 1
-  - 2
-  version: 1.1.2
 platform: ruby
-authors: 
-- "Bj\xC3\xB6rn Albers"
+authors:
+- Björn Albers
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-04-02 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  version_requirements: &id001 !ruby/object:Gem::Requirement 
+date: 2012-04-02 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70139107324480 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  requirement: *id001
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  name: rake
   prerelease: false
-- !ruby/object:Gem::Dependency 
-  version_requirements: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *70139107324480
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  requirement: &70139107323900 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  requirement: *id002
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  name: cucumber
   prerelease: false
-- !ruby/object:Gem::Dependency 
-  version_requirements: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: *70139107323900
+- !ruby/object:Gem::Dependency
+  name: aruba
+  requirement: &70139107323300 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  requirement: *id003
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  name: aruba
   prerelease: false
-- !ruby/object:Gem::Dependency 
-  version_requirements: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: *70139107323300
+- !ruby/object:Gem::Dependency
+  name: guard-cucumber
+  requirement: &70139107322640 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  requirement: *id004
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  name: guard-cucumber
   prerelease: false
-- !ruby/object:Gem::Dependency 
-  version_requirements: &id005 !ruby/object:Gem::Requirement 
+  version_requirements: *70139107322640
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70139107322100 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  requirement: *id005
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  name: rspec
   prerelease: false
-- !ruby/object:Gem::Dependency 
-  version_requirements: &id006 !ruby/object:Gem::Requirement 
+  version_requirements: *70139107322100
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: &70139107321640 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  requirement: *id006
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  name: guard-rspec
   prerelease: false
+  version_requirements: *70139107321640
 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
 - .travis.yml
 - Gemfile
@@ -131,38 +104,35 @@ files:
 - spec/spec_helper.rb
 homepage: https://github.com/bjoernalbers/nagiosplugin
 licenses: []
-
 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: -1071120004356893242
+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: -1071120004356893242
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.8.11
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
-summary: nagiosplugin-1.1.2
-test_files: 
+summary: nagiosplugin-1.2.0
+test_files:
 - features/nagiosplugin_usage.feature
 - features/steps/dev_steps.rb
 - features/support/env.rb