nagios_plugin_base 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3850ff75a984f3c9398fefd80537e2a6509279ac
+  data.tar.gz: 2bb4115bd072ddd99ab9f6cce0c521a6ab4932e0
+SHA512:
+  metadata.gz: a2e2b4105e3dade5395d88d741a11d974b0437fb3fade3d6cd76628ed62f3c233ff97cd2173f3097a265adc165b1aa1d552ff8307dc2ac24186d380afd4a3a9f
+  data.tar.gz: 405b86c0556754758ac67f5c95bd880cc272784a2afba1ecc600c93854b022982b3e074bcb3f3a92b6b3f359d6eeca88d3013567afc5f2f1bec78a49a74361d3

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 nazoking@gmail.com
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,54 @@
+# NagiosPluginBase
+
+Base class of nagios plugin.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'nagios_plugin_base'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install nagios_plugin_base
+
+## Usage
+
+```ruby
+require 'nagios_plugin_base'
+require 'open-uri'
+
+# check is instant check method.
+# argumsnts is options( nagios-plugin default options )
+# block is check block.
+Nagios::PluginBase.check!(:timeout,:verbose,:url) do
+  # if you set verbose, you can use attr_reader :verbose
+  puts "start" if verbose
+  unless open(url).read =~ /Google/
+    puts "document has not Google" if verbose
+    # Methods critical! and warning! and ok! and unknown!,
+    # print status and exit.
+    critical!
+  end
+  puts "end" if verbose
+  ok!
+end
+```
+
+```bash
+ruby check --url=https://www.google.com
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/nazoking/nagios_plugin_base/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/nagios_plugin_base.rb

@@ -0,0 +1,120 @@
+require "nagios_plugin_base/version"
+require 'optparse'
+require 'timeout'
+
+module Nagios
+  class PluginBase
+    # exit codes
+    CODES=[
+      "OK",
+      "WARNING",
+      "CRITICAL",
+      "UNKNOWN"
+    ]
+    # well known options
+    OPTOINS = {
+      :hostname       => ['-H','--hostname=VAL'],
+      :warning        => ['-w','--warning', 'warning threshold',Float],
+      :critical       => ['-c','--critical', 'critical threshold',Float],
+      :authentication => ['-a','--authentication=VAL'],
+      :verbose        => ['-v','--[no-]verbose'],
+      :timeout        => ['-t','--timeout=VAL',Float],
+      :port           => ['-p','--port=VAL',Integer],
+      :logname        => ['-l','--logname=VAL'],
+      :url            => ['-u','--url=VAL'],
+      :community      => ['-C','--community'],
+    }
+
+    # @method ok!
+    #  Print "OK" and exit 0
+    # @method warning!
+    #  Print "WARNING" and exit 1
+    # @method critical!
+    #  Print "CRITICAL" and exit 2
+    # @method warning!
+    #  Print "WARNING" and exit 3
+    CODES.each_with_index do |name,code|
+      eval <<-CODE
+        def #{name.downcase}!
+          exit_ #{code}
+        end
+      CODE
+    end
+
+    # Print message and option helps, and exit as UNKNOWN.
+    # this is default style of argument error.
+    def invalid_args!(message=nil)
+      puts message if message
+      puts @opt.help
+      unknown!
+    end
+    # Print status (ex: OK) and exit
+    # @param [Integer] :code
+    def exit_(code)
+      if CODES[code]
+        puts "#{CODES[code]}"
+        exit code
+      else
+        raise "unknown exit code #{code}"
+      end
+    end
+    # Add option to option parser and create attribute-reader to self
+    # @param [Symbol] arg     Option name
+    # @param [Array]  options Option arguments for optparse
+    def set_default_option(arg, options)
+      @opt.on(*options){|v|
+        instance_variable_set("@#{arg}".to_sym, v)
+      }
+      eval <<-CODE
+        class << self
+          define_method(:#{arg}){ @#{arg} }
+        end
+      CODE
+    end
+    # set option to option parser
+    # @param [Symbol] :arg option from OPTIONS
+    def option(arg)
+      if OPTOINS[arg]
+        set_default_option(arg, OPTOINS[arg])
+      else
+        raise "unknwon nagios plugin option #{arg}"
+      end
+    end
+    # @param [Array<Symbol>] args option parser arguments
+    def initialize(args=[])
+      @opt = OptionParser.new
+      args.each{|a| option(a)}
+    end
+    # parse option
+    # @param [Array] argv cmmand line argumetns
+    def parse!(argv)
+      begin
+        @opt.parse!(argv)
+      rescue OptionParser::InvalidOption => e
+        invalid_args!(e.to_s)
+      end
+    end
+    # Run block with timeout.
+    # @yield Main check callback block.
+    # @yieldreturn [Integer] exit code.
+    def run
+      Timeout.timeout(@timeout) do
+        ret = yield
+        raise "block need exit code" unless ret
+        exit_(ret)
+      end
+    rescue Timeout::Error => e
+      puts "timeout"
+      critical!
+    end
+    # instant check
+    def self.check!(*args,&block)
+      opt = self.new(args)
+      opt.parse!(ARGV)
+      opt.run do |opta|
+        opt.instance_eval(&block)
+      end
+    end
+  end
+end
+

data/lib/nagios_plugin_base/version.rb

@@ -0,0 +1,5 @@
+module Nagios
+  class PluginBase
+    VERSION = "0.0.1"
+  end
+end

data/nagios_plugin_base.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'nagios_plugin_base/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "nagios_plugin_base"
+  spec.version       = Nagios::PluginBase::VERSION
+  spec.authors       = ["nazoking"]
+  spec.email         = ["nazoking@gmail.com"]
+  spec.summary       = %q{nagios plugin base class.}
+  spec.description   = %q{nagios plugin base class.}
+  spec.homepage      = "https://github.com/nazoking/nagios_plugin_base"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: nagios_plugin_base
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- nazoking
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: nagios plugin base class.
+email:
+- nazoking@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/nagios_plugin_base.rb
+- lib/nagios_plugin_base/version.rb
+- nagios_plugin_base.gemspec
+homepage: https://github.com/nazoking/nagios_plugin_base
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: nagios plugin base class.
+test_files: []