nagios_alerter 0.1.0

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) <year> <copyright holders>
+
+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/Manifest

@@ -0,0 +1,12 @@
+LICENSE
+README.rdoc
+Rakefile
+lib/nagios/alerter.rb
+lib/nagios/connection.rb
+lib/nagios_alerter.rb
+nagios_alerter.gemspec
+spec/lib/alerter_spec.rb
+spec/lib/connection_spec.rb
+spec/spec.opts
+tasks/rspec.rake
+Manifest

data/README.rdoc

@@ -0,0 +1,89 @@
+= Nagios Alerter
+
+Ruby library for sending heartbeat messages to a Nagios server.
+
+This is a wrapper for kbedell's Ruby implementation of the Nagios send_nsca C libary.
+
+== Install
+
+  gem install nagios-alerter --source http://gems.github.com
+
+== Usage
+
+You can create a Nagios::Alerter and call #send_alert whenever you want to send a Nagios message. There are a couple ways you can set up the Alerter:
+
+=== Option 0: Using the constructor
+
+You can set up all of the details of your alerts when you create the Alerter:
+
+  @alerter = Nagios::Alerter.new(:hostname => "some.domain.com",
+                                 :service_name => "my-alerter",
+                                 :return_code => SendNsca::STATUS_OK,
+                                 :status => "TEST")
+  # ...
+  @alerter.send_alert(:host => "nagios.domain.com", :port => 5667)
+
+=== Option 1: Using the instance variables
+
+You can also use Ruby's setter methods to set or tweak your Alerter details:
+
+  @alerter = Nagios::Alerter.new
+  @alerter.hostname     = "some.domain.com"
+  @alerter.service_name = "my-alerter"
+  @alerter.return_code  = SendNsca::STATUS_OK
+  @alerter.status       = "TEST"
+  # ...
+  @alerter.send_alert(:host => "nagios.domain.com", :port => 5667)
+
+=== Option 2: Using the class method
+
+You don't have to create an Alerter if you don't want to, you can use the class method instead:
+
+  Nagios::Alerter.send_alert(:host => "nagios.domain.com",
+                             :port => 5667,
+                             :hostname => "some.domain.com",
+                             :service_name => "my-alerter",
+                             :return_code => SendNsca::STATUS_OK,
+                             :status => "TEST")
+
+== Global settings
+
+Most users have only one Nagios server, so having to explicitly pass the host and port information to every #send_alert call can be very redundant. Instead, you can use Nagios::Connection to set up a globally accessible Nagios server. For example:
+
+  Nagios::Connection.instance.host = "nagios.somedomain.com"
+  Nagios::Connection.instance.port = 5667
+
+Nagios::Connection is a Singleton class, so you need to use #instance when you access it. You can set it up in your project's environment and have all further calls to #send_alert use those settings (except when using the class method).
+
+== Making Changes
+
+  # add/remove files
+  rake manifest
+  # make changes and reinstall to local system
+  rake install
+  # update version number in Rakefile and rebuild gemspec
+  rake build_gemspec
+
+== License
+
+The MIT License
+
+Copyright (c) 2010 Dana Merrick
+
+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/Rakefile

@@ -0,0 +1,16 @@
+require 'rubygems'
+require 'rake'
+require 'echoe'
+
+Echoe.new('nagios_alerter', '0.1.0') do |p|
+  p.description    = "Send a heartbeat to a Nagios server"
+  p.url            = "http://github.com/dmerrick/nagios_alerter"
+  p.author         = "Dana Merrick"
+  p.email          = "dana.merrick@gmail.com"
+  p.ignore_pattern = ["tmp/*", "script/*"]
+  p.runtime_dependencies = ["send_nsca >=0.4.11"]
+  p.development_dependencies = []
+end
+
+# load any other rake tasks
+Dir["#{File.dirname(__FILE__)}/tasks/*.rake"].sort.each { |ext| load ext }

data/lib/nagios/alerter.rb

@@ -0,0 +1,103 @@
+require 'rubygems'
+require 'send_nsca'
+
+module Nagios
+  class Alerter
+
+    attr_accessor :hostname
+    attr_accessor :service_name
+    attr_accessor :return_code
+    attr_accessor :status
+
+    def initialize(args = {})
+      @hostname     = args[:hostname]
+      @service_name = args[:service_name]
+      @return_code  = args[:return_code]
+      @status       = args[:status]
+    end
+
+    def send_alert(args = {})
+      # host and port can be passed as parameters or set using Nagios::Connection
+      host, port = connection_params(args[:host], args[:port])
+
+      # check the parameters if we're missing any variables
+      check_args(args) if [@hostname, @service_name, @return_code, @status].any? {|var| var.nil? }
+
+      hostname     = args[:hostname]     || @hostname
+      service_name = args[:service_name] || @service_name
+      return_code  = args[:return_code]  || @return_code
+      status       = args[:status]       || @status
+
+      config = {
+                :nscahost => host,
+                :port => port,
+                :hostname => hostname,
+                :service => service_name,
+                :return_code => return_code,
+                :status => status
+      }
+
+      nsca_connection = SendNsca::NscaConnection.new(config)
+      nsca_connection.send_nsca
+    end
+
+    # if you don't want to create a Nagios::Alerter object, you can call Nagios::Alerter.send_alert
+    def self.send_alert(args)
+      if [:host, :port, :hostname, :service_name, :return_code, :status].any? {|key| !args.has_key?(key) }
+        raise ArgumentError, "You must provide all alert details"
+      end
+
+      config = {
+                :nscahost => args[:host],
+                :port => args[:port],
+                :hostname => args[:hostname],
+                :service => args[:service_name],
+                :return_code => args[:return_code],
+                :status => args[:status]
+      }
+
+      nsca_connection = SendNsca::NscaConnection.new(config)
+      nsca_connection.send_nsca
+    end
+
+    private
+
+      # check that we have the Nagios server details
+      def connection_params(host, port)
+  
+        params = {}
+  
+        if !host.nil?
+          params[:host] = host
+        elsif !Nagios::Connection.instance.host.nil?
+          params[:host] = Nagios::Connection.instance.host
+        else
+          raise ArgumentError, "You must provide a Nagios host or use Nagios::Connection"
+        end
+
+        if !port.nil?
+          params[:port] = port
+        elsif !Nagios::Connection.instance.port.nil?
+          params[:port] = Nagios::Connection.instance.port
+        else
+          raise ArgumentError, "You must provide a Nagios port or use Nagios::Connection"
+        end
+
+        return params
+      end
+
+      # a method to verify that all necessary requirements are satisfied
+      def check_args(hash)
+        if !hash.include? :hostname
+          raise ArgumentError, "You must provide a hostname"
+        elsif !hash.include? :service_name
+          raise ArgumentError, "You must provide a service name"
+        elsif !hash.include? :return_code
+          raise ArgumentError, "You must provide a return code"
+        elsif !hash.include? :status
+          raise ArgumentError, "You must provide a status"
+        end
+      end
+
+  end
+end

data/lib/nagios/connection.rb

@@ -0,0 +1,11 @@
+require 'singleton'
+
+module Nagios
+  class Connection
+    include Singleton
+    
+    attr_accessor :host
+    attr_accessor :port
+    
+  end
+end

data/lib/nagios_alerter.rb

@@ -0,0 +1,4 @@
+module Nagios
+  autoload :Alerter, "nagios/alerter"
+  autoload :Connection, "nagios/connection"
+end

data/nagios_alerter.gemspec

@@ -0,0 +1,33 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{nagios_alerter}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Dana Merrick"]
+  s.date = %q{2010-09-09}
+  s.description = %q{Send a heartbeat to a Nagios server}
+  s.email = %q{dana.merrick@gmail.com}
+  s.extra_rdoc_files = ["LICENSE", "README.rdoc", "lib/nagios/alerter.rb", "lib/nagios/connection.rb", "lib/nagios_alerter.rb", "tasks/rspec.rake"]
+  s.files = ["LICENSE", "README.rdoc", "Rakefile", "lib/nagios/alerter.rb", "lib/nagios/connection.rb", "lib/nagios_alerter.rb", "nagios_alerter.gemspec", "spec/lib/alerter_spec.rb", "spec/lib/connection_spec.rb", "spec/spec.opts", "tasks/rspec.rake", "Manifest"]
+  s.homepage = %q{http://github.com/dmerrick/nagios_alerter}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Nagios_alerter", "--main", "README.rdoc"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{nagios_alerter}
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Send a heartbeat to a Nagios server}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<send_nsca>, [">= 0.4.11"])
+    else
+      s.add_dependency(%q<send_nsca>, [">= 0.4.11"])
+    end
+  else
+    s.add_dependency(%q<send_nsca>, [">= 0.4.11"])
+  end
+end

data/spec/lib/alerter_spec.rb

@@ -0,0 +1,133 @@
+require 'nagios/connection'
+require 'nagios/alerter'
+
+describe Nagios::Alerter do
+  describe "that's brand new" do
+    
+    before do
+      @alerter = Nagios::Alerter.new
+    end
+    
+    it "should have no defaults" do
+      @alerter.hostname.should be_nil
+      @alerter.service_name.should be_nil
+      @alerter.return_code.should be_nil
+      @alerter.status.should be_nil
+    end
+    
+    it "should raise an error if you try to send an alert" do
+      lambda { @alerter.send_alert }.should raise_error(ArgumentError)
+    end
+    
+    it "should set values using the constructor" do
+      @alerter = Nagios::Alerter.new(:hostname => "some.domain.com",
+                                     :service_name => "my-alerter",
+                                     :return_code => SendNsca::STATUS_OK,
+                                     :status => "TEST")
+      
+      @alerter.hostname.should == "some.domain.com"
+      @alerter.service_name.should == "my-alerter"
+      @alerter.return_code.should == SendNsca::STATUS_OK
+      @alerter.status.should == "TEST"
+    end
+    
+    it "should set the hostname" do
+      @alerter.hostname = "some.otherdomain.com"
+      @alerter.hostname.should == "some.otherdomain.com"
+    end
+    
+    it "should set the service name" do
+      @alerter.service_name = "new-alerter"
+      @alerter.service_name.should == "new-alerter"
+    end
+    
+    it "should set the return code" do
+      @alerter.return_code = SendNsca::STATUS_WARNING
+      @alerter.return_code.should == SendNsca::STATUS_WARNING
+    end
+    
+    it "should set the status" do
+      @alerter.status = "NEWTEST"
+      @alerter.status.should == "NEWTEST"
+    end
+  end
+  
+  describe "using Nagios::Connection" do
+    before(:all) do
+      Nagios::Connection.instance.host = "some.domain.com"
+      Nagios::Connection.instance.port = 5667
+    end
+    
+    before(:each) do
+      @alerter = Nagios::Alerter.new(:hostname => "some.domain.com",
+                                     :service_name => "new-alerter",
+                                     :return_code => SendNsca::STATUS_OK,
+                                     :status => "TEST")
+    end
+    
+    it "should not error if not given a host and port" do
+      @alerter.should_receive(:send_alert)
+      lambda { @alerter.send_alert }.should_not raise_error(ArgumentError)
+    end
+  end
+  
+  describe "using the static method" do
+    it "should error if run without any arguments" do
+      lambda { Nagios::Alerter.send_alert }.should raise_error(ArgumentError)
+    end
+    
+    it "should error if run without a host" do
+      lambda { Nagios::Alerter.send_alert(:port => 5667,
+                                          :hostname => "some.domain.com",
+                                          :service_name => "my-alerter",
+                                          :return_code => SendNsca::STATUS_OK,
+                                          :status => "TEST")
+      }.should raise_error(ArgumentError)
+    end
+    
+    it "should error if run without a port" do
+      lambda { Nagios::Alerter.send_alert(:host => "nagios.domain.com",
+                                          :hostname => "some.domain.com",
+                                          :service_name => "my-alerter",
+                                          :return_code => SendNsca::STATUS_OK,
+                                          :status => "TEST")
+      }.should raise_error(ArgumentError)
+    end
+    
+    it "should error if run without a hostname" do
+      lambda { Nagios::Alerter.send_alert(:host => "nagios.domain.com",
+                                          :port => 5667,
+                                          :service_name => "my-alerter",
+                                          :return_code => SendNsca::STATUS_OK,
+                                          :status => "TEST")
+      }.should raise_error(ArgumentError)
+    end
+
+    it "should error if run without a service name" do
+      lambda { Nagios::Alerter.send_alert(:host => "nagios.domain.com",
+                                          :port => 5667,
+                                          :hostname => "some.domain.com",
+                                          :return_code => SendNsca::STATUS_OK,
+                                          :status => "TEST")
+      }.should raise_error(ArgumentError)
+    end
+    
+    it "should error if run without a return code" do
+      lambda { Nagios::Alerter.send_alert(:host => "nagios.domain.com",
+                                          :port => 5667,
+                                          :hostname => "some.domain.com",
+                                          :service_name => "my-alerter",
+                                          :status => "TEST")
+      }.should raise_error(ArgumentError)
+    end
+    
+    it "should error if run without a status" do
+      lambda { Nagios::Alerter.send_alert(:host => "nagios.domain.com",
+                                          :port => 5667,
+                                          :hostname => "some.domain.com",
+                                          :service_name => "my-alerter",
+                                          :return_code => SendNsca::STATUS_OK)
+      }.should raise_error(ArgumentError)                               
+    end
+  end
+end

data/spec/lib/connection_spec.rb

@@ -0,0 +1,27 @@
+require 'nagios/connection'
+
+describe Nagios::Connection do
+  it "should mixin the Singleton module" do
+    included_modules = (class << Nagios::Connection.instance; self; end).send :included_modules
+    included_modules.should include(Singleton)
+  end
+
+  it "should only have one instance" do
+    a = Nagios::Connection.instance
+    b = Nagios::Connection.instance
+    a.should == b
+  end
+  
+  it "should have no defaults" do
+    Nagios::Connection.instance.host.should be_nil
+    Nagios::Connection.instance.port.should be_nil
+  end
+  
+  it "should set the host and port" do
+    Nagios::Connection.instance.host = "some.domain.com"
+    Nagios::Connection.instance.port = 5667
+    
+    Nagios::Connection.instance.host.should == "some.domain.com"
+    Nagios::Connection.instance.port.should == 5667
+  end
+end

data/spec/spec.opts

@@ -0,0 +1,4 @@
+--colour
+--format progress
+--loadby mtime
+--reverse

data/tasks/rspec.rake

@@ -0,0 +1,23 @@
+require 'rake'
+require 'spec/rake/spectask'
+
+task :default => :spec
+
+desc "Run all specs in spec directory"
+Spec::Rake::SpecTask.new do |t|
+  t.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+namespace :spec do
+  desc "Run all specs in spec directory with RCov (excluding plugin specs)"
+  Spec::Rake::SpecTask.new(:rcov) do |t|
+    t.spec_files = FileList['spec/**/*_spec.rb']
+    t.rcov = true
+  end
+
+  desc "Print Specdoc for all specs"
+  Spec::Rake::SpecTask.new(:doc) do |t|
+    t.spec_opts = ["--format", "specdoc", "--dry-run"]
+    t.spec_files = FileList['spec/**/*_spec.rb']
+  end
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification 
+name: nagios_alerter
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Dana Merrick
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-09-09 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: send_nsca
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 25
+        segments: 
+        - 0
+        - 4
+        - 11
+        version: 0.4.11
+  type: :runtime
+  version_requirements: *id001
+description: Send a heartbeat to a Nagios server
+email: dana.merrick@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+- lib/nagios/alerter.rb
+- lib/nagios/connection.rb
+- lib/nagios_alerter.rb
+- tasks/rspec.rake
+files: 
+- LICENSE
+- README.rdoc
+- Rakefile
+- lib/nagios/alerter.rb
+- lib/nagios/connection.rb
+- lib/nagios_alerter.rb
+- nagios_alerter.gemspec
+- spec/lib/alerter_spec.rb
+- spec/lib/connection_spec.rb
+- spec/spec.opts
+- tasks/rspec.rake
+- Manifest
+has_rdoc: true
+homepage: http://github.com/dmerrick/nagios_alerter
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Nagios_alerter
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 11
+      segments: 
+      - 1
+      - 2
+      version: "1.2"
+requirements: []
+
+rubyforge_project: nagios_alerter
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Send a heartbeat to a Nagios server
+test_files: []
+