nagios-api-client 0.4

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/.irbrc

@@ -0,0 +1,4 @@
+$:.push File.expand_path("../lib", __FILE__)
+require 'nagios/api'
+puts "Loaded Nagios::API"
+

data/Gemfile

@@ -0,0 +1,6 @@
+source = "http://rubygems.org"
+
+gemspec
+
+group :development do
+end

data/README.md

@@ -0,0 +1,82 @@
+Ruby Nagios API Client
+========
+
+A ruby gem used to interact with the nagios-api (REST interface to Nagios) server:
+
+https://github.com/xb95/nagios-api
+
+Install
+-------
+
+    gem install nagios-api-client
+
+If you are using bundler, add this to your Gemfile:
+
+    gem "nagios-api-client", require: 'nagios/api'
+
+If not using bundler:
+
+    require 'rubygems'
+    require 'nagios/api'
+
+Examples
+------
+
+    # Create a new client to interact with the nagios-api server.
+    client = Nagios::API::Client.new("http://nagios-server:8181")
+    
+    # Optionally set authentication credentials
+    client = Nagios::API::Client.new("http://nagios-server:8181", user: 'user', password: 'password')
+    
+    # Find a host
+    host = client.hosts.find("hostname")
+    
+    # Find a service on the host
+    service = host.services.find("servicename")
+    
+    # Check the status
+    puts service.status
+    
+    # Check the status details
+    puts service.status_details
+    
+    # Schedule downtime
+    service.schedule_downtime(
+      author: "User 1", 
+      comment: "This is flexible downtime", 
+      start_time: Time.now, 
+      fixed: false, 
+      duration: 3600, 
+      end_time: Time.now + 14400
+    )
+  
+Author
+------
+
+Philippe Green <phil@greenviewdata.com>
+Greenview Data, Inc.
+	
+License
+-------
+
+The MIT License (MIT)
+
+Copyright (c) 2014 Greenview Data, Inc.
+
+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 @@
+require "bundler/gem_tasks"

data/lib/nagios.rb

@@ -0,0 +1,6 @@
+require 'curb-fu'
+require 'json'
+require 'nagios/api'
+
+module Nagios
+end

data/lib/nagios/api.rb

@@ -0,0 +1,15 @@
+require 'nagios/api/version'
+
+module Nagios
+  module API
+    autoload :Interface, 'nagios/api/interface'
+    autoload :Client, 'nagios/api/client'
+    autoload :Service, 'nagios/api/service'
+    autoload :Services, 'nagios/api/service'
+    autoload :State, 'nagios/api/state'
+    autoload :Host, 'nagios/api/host'
+    autoload :Hosts, 'nagios/api/host'
+    autoload :Resource, 'nagios/api/resource'
+    autoload :Downtime, 'nagios/api/downtime'
+  end
+end

data/lib/nagios/api/client.rb

@@ -0,0 +1,30 @@
+module Nagios::API
+  # Create a new client to interact with the nagios-api server.
+  #
+  #  client = Nagios::API::Client.new("http://nagios-server:8181")
+  #
+  # Optionally set authentication credentials
+  #
+  #  client = Nagios::API::Client.new("http://nagios-server:8181", user: 'user', password: 'password')
+  #
+  class Client
+    attr_reader :base_url, :options, :state
+    
+    def initialize(base_url, extra_args = {})
+      @base_url = base_url
+      @options = extra_args
+    end
+    
+    def api
+      @api ||= Nagios::API::Interface.new(options.merge(base_url: base_url))
+    end
+    
+    def hosts
+      @hosts ||= Nagios::API::Hosts.new(api_client: self)
+    end
+    
+    def state
+      @state ||= Nagios::API::State.new(api_client: self)
+    end
+  end
+end

data/lib/nagios/api/downtime.rb

@@ -0,0 +1,28 @@
+module Nagios::API
+  class Downtime < Nagios::API::Resource
+    attr_reader :api_client, :service, :host
+    
+    def initialize(args = {})
+      @service = args.delete(:service)
+      @host = args.delete(:host)
+      
+      args['end_time'] = Time.at(args['end_time'].to_i)
+      args['start_time'] = Time.at(args['start_time'].to_i)
+      args['created_at'] = Time.at(args['entry_time'].to_i)
+      
+      super(args)
+    end
+    
+    def id
+      downtime_id
+    end
+    
+    def cancel
+      result = api_client.api.post("/cancel_downtime/#{id}", {})
+      
+      raise StandardError, "Unknown response canceling downtime: #{result}" unless result == "cancelled"
+      
+      true
+    end
+  end
+end

data/lib/nagios/api/host.rb

@@ -0,0 +1,47 @@
+module Nagios::API
+  class Hosts
+    attr_reader :api_client
+    
+    def initialize(args = {})
+      @api_client = args[:api_client]
+      @host_cache = {}
+    end
+    
+    def find(hostname)
+      return @host_cache[hostname] if @host_cache.has_key?(hostname)
+      
+      host = Host.new(api_client.api.query("/host/#{hostname}").merge(api_client: api_client))
+      @host_cache[hostname] = host
+      host
+    end
+    
+    def reload
+      @host_cache = {}
+    end
+  end
+  
+  class Host < Nagios::API::Resource
+    def services
+      @services ||= Nagios::API::Services.new(api_client: api_client, host: self)
+    end
+    
+    def name
+      host_name
+    end
+    
+    def state
+      api_client.state.for_host(name)
+    end
+    
+    def schedule_downtime
+      # host
+      # author
+      # comment
+      # start_time
+      # fixed
+      # duration
+      # end_time
+      # services_too
+    end
+  end
+end

data/lib/nagios/api/interface.rb

@@ -0,0 +1,78 @@
+require 'json'
+require 'curb-fu'
+
+module Nagios::API
+  class Interface
+    class HTTPError < StandardError; end
+    class BackendAPIError < StandardError; end
+    
+    attr_accessor :base_url, :username, :password, :use_cache
+    
+    def initialize(args = {})
+      @base_url = args[:base_url]
+      @username = args[:username]
+      @password = args[:password]
+      @use_cache = args[:use_cache]
+    end
+    
+    def query(path)
+      result = query_from_api(path)
+      
+      return result unless use_cache
+      save_to_cache(path, result) if result
+      result ||= query_from_cache(path)
+    end
+    
+    def memcached
+      @memcached ||= Memcached.new("localhost:11211")
+    end
+    
+    def save_to_cache(path, data)
+      memcached.set path, data, 0
+    end
+    
+    def query_from_cache(path)
+      memcached.get(path) rescue nil
+    end
+    
+    def authentication_options
+      !username.nil? ? { username: username, password: password } : {}
+    end
+    
+    def post(path, params)
+      args = { url: base_url + path, headers: { 'Accept' => 'application/json', 'Content-Type' => 'application/json' } }
+      args.merge!(authentication_options)
+      result = CurbFu.post(args, params.to_json)
+
+      if result.success?
+        data = JSON.parse(result.body)
+        
+        if data['success']
+          return data['content']
+        else
+          raise BackendAPIError, data['content']
+        end
+      else
+        raise HTTPError, "Error communicating with API server: #{result.status}"
+      end
+    end
+    
+    def query_from_api(path)
+      args = { url: base_url + path, headers: { Accept: 'application/json' } }
+      args.merge!(authentication_options)
+      result = CurbFu.get(args)
+
+      if result.success?
+        data = JSON.parse(result.body)
+        
+        if data['success']
+          return data['content']
+        else
+          raise BackendAPIError
+        end
+      else
+        raise HTTPError, "Error communicating with API server: #{result.status}"
+      end
+    end
+  end
+end

data/lib/nagios/api/resource.rb

@@ -0,0 +1,38 @@
+module Nagios::API
+  class Resource
+    attr_reader :api_client
+    attr_accessor :attributes
+    
+    def initialize(args = {})
+      @api_client = args.delete(:api_client)
+      @attributes = {}
+      self.attributes = args
+    end
+
+    def attributes=(args = {})
+      args ||= {}
+      args.each do |key, value|
+        self.send(:"#{key}=", value)
+      end
+    end
+    
+    def method_missing(meth, *args, &block)
+      if meth.to_s =~ /^(.+)=$/
+        @attributes[$1.to_sym] = args[0]
+      elsif @attributes.has_key?(meth)
+        @attributes[meth]
+      else
+        super # You *must* call super if you don't handle the
+              # method, otherwise you'll mess up Ruby's method
+              # lookup.
+      end
+    end
+    
+    def to_hash(options = {})
+      hash = attributes
+      hash.reject! { |key, value| options[:except].include?(key.to_sym) || options[:except].include?(key.to_s) } if options[:except]
+      hash.reject! { |key, value| !options[:only].include?(key.to_sym) && !options[:only].include?(key.to_s) } if options[:only]
+      hash
+    end
+  end
+end

data/lib/nagios/api/service.rb

@@ -0,0 +1,88 @@
+module Nagios::API
+  class Services
+    class NoHost < StandardError; end
+    
+    attr_reader :api_client
+    attr_accessor :host
+    
+    def initialize(args = {})
+      @api_client = args[:api_client]
+      @host = args[:host]
+    end
+    
+    def all
+      raise NoHost unless host
+      
+      @services ||= api_client.api.query("/service/#{host.name}").values.collect do |service_attributes|
+        Service.new(service_attributes.merge(api_client: api_client, host: host))
+      end
+    end
+    
+    def find(name)
+      raise NoHost unless host
+      
+      all.find { |service| service.name.downcase == name.downcase }
+    end
+    
+    def reload
+      @services = nil
+    end
+  end
+  
+  class Service < Nagios::API::Resource
+    def name
+      service
+    end
+    
+    def state
+      return nil unless host
+      
+      host.state['services'][name]
+    end
+    
+    def downtimes
+      return nil unless state
+      
+      dts = state['downtimes'] ? state['downtimes'].values : []
+      dts.collect { |dt| Nagios::API::Downtime.new(dt.merge(service: self, api_client: api_client)) }
+    end
+    
+    # schedule_downtime arguments:
+    #   author
+    #   comment
+    #   start_time
+    #   fixed
+    #   duration
+    #   end_time
+    def schedule_downtime(params = {})
+      params = params.dup
+      params[:host] = host.name
+      params[:service] = name
+      params[:start_time] = params[:start_time].to_i if params[:start_time]
+      params[:end_time] = params[:end_time].to_i if params[:end_time]
+      
+      result = api_client.api.post("/schedule_downtime", params)
+      
+      raise StandardError, "Unknown response scheduling downtime: #{result}" unless result == "scheduled"
+      
+      true
+    end
+    
+    def status
+      case current_state.to_i
+      when 0
+        :ok
+      when 1
+        :warning
+      when 2
+        :critical
+      else
+        :unknown
+      end
+    end
+    
+    def status_details
+      plugin_output
+    end
+  end
+end

data/lib/nagios/api/state.rb

@@ -0,0 +1,17 @@
+module Nagios::API
+  class State < Nagios::API::Resource
+    def initialize(args = {})
+      super
+      
+      reload
+    end
+    
+    def reload
+      self.attributes = { :data => api_client.api.query("/state") }
+    end
+    
+    def for_host(hostname)
+      data[hostname]
+    end
+  end
+end

data/lib/nagios/api/version.rb

@@ -0,0 +1,5 @@
+module Nagios
+  module API
+    VERSION = "0.4"
+  end
+end

data/nagios-api-client.gemspec

@@ -0,0 +1,25 @@
+# encoding: utf-8
+$:.push File.expand_path("../lib", __FILE__)
+require "nagios/api/version"
+
+Gem::Specification.new do |s|
+  s.name        = "nagios-api-client"
+  s.version     = Nagios::API::VERSION
+  s.author      = "Philippe Green, Greenview Data, Inc."
+  s.email       = ["development@greenviewdata.com"]
+  s.homepage    = "https://github.com/gdi/ruby-nagios-api-client"
+  s.license     = "MIT"
+  s.summary     = %q{Interface to interact with the nagios-api server}
+  s.description = %q{Interact with the nagios-api (REST interface to Nagios) server found at github.com/xb95/nagios-api}
+  
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- spec/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.required_ruby_version = '>= 1.9.2'
+
+  s.add_runtime_dependency "curb-fu"
+  
+  s.add_development_dependency "rspec"
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: nagios-api-client
+version: !ruby/object:Gem::Version
+  version: '0.4'
+  prerelease: 
+platform: ruby
+authors:
+- Philippe Green, Greenview Data, Inc.
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: curb-fu
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  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'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Interact with the nagios-api (REST interface to Nagios) server found
+  at github.com/xb95/nagios-api
+email:
+- development@greenviewdata.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .irbrc
+- Gemfile
+- README.md
+- Rakefile
+- lib/nagios.rb
+- lib/nagios/api.rb
+- lib/nagios/api/client.rb
+- lib/nagios/api/downtime.rb
+- lib/nagios/api/host.rb
+- lib/nagios/api/interface.rb
+- lib/nagios/api/resource.rb
+- lib/nagios/api/service.rb
+- lib/nagios/api/state.rb
+- lib/nagios/api/version.rb
+- nagios-api-client.gemspec
+homepage: https://github.com/gdi/ruby-nagios-api-client
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Interface to interact with the nagios-api server
+test_files: []
+has_rdoc: