icinga_api 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ac468fc80d13004bb9ec82f9617e6fde11b599c7
+  data.tar.gz: f6c892509cb27b488db7284523ce0607d4f3f445
+SHA512:
+  metadata.gz: 969c5e36129e4b572b397fa8d1487c315a8b75e5bbb5544332de08451c2494512ae4ee083f60cf5c85caba8781d4188b2196853050dc54fc24e039776dd71961
+  data.tar.gz: c9d31d5e4f01d3e7764f1dd58a5061e7c6278a4e99ac3d59723ac38eb0a32d20412c0adf55cd69141e96a8af5c99d7116244f9c7850270d4a2b7ee52117c8bf0

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Sarah Diendorfer
+
+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,82 @@
+# IcingaApi
+
+This is an still experimental gem to access the Icinga Web REST API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'icinga_api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install icinga_api
+
+## Usage
+
+### create connection
+```ruby
+require 'icinga_api'
+
+icinga = IcingaApi.new(
+  url: "http://icinga-server/icinga-web",
+  authkey: "myauthkey"
+)
+```
+
+### some sample host API calls
+```ruby
+host = icinga.host("my-monitored-host")
+
+# is the host up?
+host.up?
+
+# what is the state of the host?
+host.current_state
+
+# when was the last check of the host
+host.last_check
+
+# has the host problem been acknowledged?
+host.problem_has_been_acknowledged
+
+# get a list of services of the host
+host.services
+
+# get a specific service by name on a host
+service = host.service("Time")
+
+etc.
+```
+
+### some sample service API calls
+```ruby
+# is the service ok?
+service.ok?
+
+# since when is the service in the current state?
+service.last_state_change
+
+# what is the display name of the service?
+service.display_name
+
+# when will the service be checked the next time?
+service.next_check
+
+etc.
+```
+
+
+## Contributing
+
+1. Fork it ( https://github.com/terracor/icinga_api/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/icinga_api.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'icinga_api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "icinga_api"
+  spec.version       = IcingaApi::VERSION
+  spec.authors       = ["Lothar Handl"]
+  spec.email         = ["ranger@wizards.at"]
+  spec.summary       = %q{A gem to access the Icinga Web API}
+  spec.description   = %q{A gem to access the Icinga Web API}
+  spec.homepage      = ""
+  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_dependency "ipaddress"
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/icinga_api.rb

@@ -0,0 +1,26 @@
+require 'pry'
+require 'json'
+require 'uri'
+require 'net/http'
+require 'time'
+require 'ipaddress'
+
+require "icinga_api/version"
+require "icinga_api/request"
+require "icinga_api/host"
+require "icinga_api/service"
+
+class IcingaApi
+  attr_reader :data
+
+  def initialize(options = {})
+    @data = options
+    @data[:url] += '/web/api/json'
+  end
+
+
+  def host(name)
+    Host.new(self, name)
+  end
+
+end

data/lib/icinga_api/host.rb

@@ -0,0 +1,140 @@
+class IcingaApi
+  class Host < Request
+    TARGET="host"
+    attr_reader :name, :host_filter
+
+    CHECKS = {
+      integer: %i(
+        HOST_ID
+        HOST_OBJECT_ID
+        HOST_INSTANCE_ID
+        HOST_PARENT_OBJECT_ID
+        HOST_CHILD_ID
+        HOST_CURRENT_CHECK_ATTEMPT
+        HOST_MAX_CHECK_ATTEMPTS
+        HOST_STATE_COUNT
+      ),
+      float: %i(
+        HOST_LATENCY
+        HOST_EXECUTION_TIME
+      ),
+      boolean: %i(
+        HOST_FLAP_DETECTION_ENABLED
+        HOST_ACTIVE_CHECKS_ENABLED
+        HOST_FLAP_DETECTION_ENABLED
+        HOST_FRESHNESS_CHECK_ENABLED
+        HOST_PASSIVE_CHECKS_ENABLED
+        HOST_EVENT_HANDLER_ENABLED
+        HOST_ACTIVE_CHECKS_ENABLED
+        HOST_NOTIFICATIONS_ENABLED
+        HOST_OBSESS_OVER_HOST
+        HOST_FAILURE_PREDICTION_ENABLED
+        HOST_IS_ACTIVE
+        HOST_HAS_BEEN_CHECKED
+        HOST_IS_FLAPPING
+        HOST_PROBLEM_HAS_BEEN_AKNOWLEDGED
+        HOST_IS_PENDING
+        HOST_SHOULD_BE_SCHEDULED
+        HOST_PROCESS_PERFORMANCE_DATA
+      ),
+      string: %i(
+        HOST_NAME
+        HOST_ALIAS
+        HOST_DISPLAY_NAME
+        HOST_NOTES
+        HOST_OUTPUT
+        HOST_LONG_OUTPUT
+        HOST_PARENT_NAME
+        HOST_CHILD_NAME
+        HOST_ICON_IMAGE
+        HOST_ICON_IMAGE_ALT
+        HOST_NOTES_URL
+        HOST_ACTION_URL
+      ),
+      time: %i(
+        HOST_LAST_CHECK
+        HOST_LAST_STATE_CHANGE
+        HOST_NEXT_CHECK
+        HOST_LAST_NOTIFICATION
+        HOST_STATUS_UPDATE_TIME
+        HOST_LAST_HARD_STATE_CHANGE
+      )
+    }
+
+    CHECKS.each do |check_type, arr|
+      request_name = "#{check_type.to_s}_request"
+      arr.each do |method_symbol|
+        method_name = method_symbol.to_s.gsub(/^\w+?_/, "").downcase
+        define_method(method_name) do
+          send(request_name, TARGET, @host_filter, method_symbol)
+        end
+      end
+    end
+
+
+    def initialize(connection, name)
+       @connection = connection
+       @name = name
+       @host_filter = filter("HOST_NAME", "=", name)
+    end
+
+
+    def fetch(method)
+      string_request(TARGET, @host_filter, method)
+    end
+
+
+    def current_state
+      rc = request(TARGET, @host_filter, ["HOST_CURRENT_STATE"])
+      return :unknown unless rc[:success] == "true"
+      case rc[:result][0][:HOST_CURRENT_STATE].to_i
+        when 0 
+          :up
+        when 1
+          :down
+      end
+    end
+
+
+    def up?
+      current_state == :up
+    end
+
+
+    def down?
+      current_state == :down
+    end
+
+
+    def unknown?
+      current_state == :unknown
+    end
+
+
+    def address
+      rc = request(TARGET, @host_filter, [:HOST_ADDRESS])
+      address = rc[:result][0][:HOST_ADDRESS]
+      begin 
+        address = IPAddress(address)
+      rescue
+        address
+      end
+    end
+
+
+    def services
+      rc = request(Service::TARGET, @host_filter, [:SERVICE_NAME])
+      # TODO: langsam, und keine Ahnung, warum
+      rc[:result].map do |service_hash|
+        Service.new(@connection, self, service_hash[:SERVICE_NAME])
+      end
+    end
+
+
+    def service(name)
+      Service.new(@connection, self, name)
+    end
+
+    # TODO: implement further
+  end # of class Host
+end

data/lib/icinga_api/request.rb

@@ -0,0 +1,66 @@
+class IcingaApi
+  class Request
+    attr_accessor :connection
+
+    protected
+    
+    def and_filters(a, b)
+      { type: "AND", field: [a, b] }
+    end
+
+
+    def or_filters(a, b)
+      { type: "OR", field: [a, b] }
+    end
+
+
+    def filter(field, operator, value)
+      { type: "atom", field: [ field ], method: [ operator ], value:  [ value ] }
+    end
+
+
+    def request(target, filters, columns)
+      # prepare post data
+      data = Hash.new
+      data[:authkey] = @connection.data[:authkey]
+      data[:target] = target
+      filters = and_filters(filters, filters) # the hell knows why, but the api always wants an AND- or OR-construct on the top level
+      data[:filters_json] = filters.to_json if filters
+      columns.each_with_index do |col, i|
+        data["columns[#{i}]".to_sym] = col
+      end
+
+      # post data
+      uri = URI(@connection.data[:url])
+      res = Net::HTTP.post_form(uri, data)
+      raise "error on API query" unless res.code.to_i == 200
+      JSON.parse(res.body, { symbolize_names: true })
+    end
+
+
+    def string_request(target, filter, field)
+      rc = request(target, filter, [ field ])
+      rc[:result][0][field]
+    end
+
+
+    def integer_request(target, filter, field)
+      rc = string_request(target, filter, field).to_i
+    end
+
+
+    def float_request(target, filter, field)
+      rc = string_request(target, filter, field).to_f
+    end
+
+
+    def boolean_request(target, filter, field)
+      integer_request(target, filter, field) == 1
+    end
+
+
+    def time_request(target, filter, field)
+      Time.parse(string_request(target, filter, field))
+    end
+  end # of class Request
+end

data/lib/icinga_api/service.rb

@@ -0,0 +1,126 @@
+class IcingaApi
+  class Service < Request
+    TARGET = "service"
+    attr_reader :name, :service_filter
+
+    CHECKS = {
+      integer: %i(
+        SERVICE_ID
+        SERVICE_INSTANCE_ID
+        SERVICE_OBJECT_ID
+        SERVICE_CURRENT_CHECK_ATTEMPTS
+        SERVICE_MAX_CHECK_ATTEMPTS
+        SERVICE_STATE_COUNT
+        SERVICE_OBJECT_COUNT
+      ),
+      float: %i(
+        SERVICE_LATENCY
+        SERVICE_EXECUTION_TIME
+      ),
+      boolean: %i(
+        SERVICE_IS_ACTIVE
+        SERVICE_NOTIFICATIONS_ENABLED
+        SERVICE_FLAP_DETECTION_ENABLED
+        SERVICE_PASSIVE_CHECKS_ENABLED
+        SERVICE_EVENT_HANDLER_ENABLED
+        SERVICE_ACTIVE_CHECKS_ENABLED
+        SERVICE_RETAIN_STATUS_INFORMATION
+        SERVICE_RETAIN_NONSTATUS_INFORMATION
+        SERVICE_OBSESS_OVER_SERVICE
+        SERVICE_FAILURE_PREDICTION_ENABLED
+        SERVICE_PROCESS_PERFORMANCE_DATA
+        SERVICE_HAS_BEEN_CHECKED
+        SERVICE_IS_FLAPPING
+        SERVICE_PROBLEM_HAS_BEEN_ACKNOWLEDGED
+        SERVICE_SHOULD_BE_SCHEDULED
+        SERVICE_IS_PENDING
+        SERVICE_LAST_HARD_STATE
+      ),
+      string: %i(
+        SERVICE_NAME
+        SERVICE_DISPLAY_NAME
+        SERVICE_NOTES
+        SERVICE_OUTPUT
+        SERVICE_LONG_OUTPUT
+        SERVICE_ICON_IMAGE
+        SERVICE_ICON_IMAGE_ALT
+        SERVICE_NOTES_URL
+        SERVICE_ACTION_URL
+      ),
+      time: %i(
+        SERVICE_LAST_CHECK
+        SERVICE_LAST_STATE_CHANGE
+        SERVICE_NEXT_CHECK
+        SERVICE_LAST_HARD_STATE_CHANGE
+        SERVICE_LAST_NOTIFICATION
+        SERVICE_STATUS_UPDATE_TIME
+      )
+    }
+    
+    CHECKS.each do |check_type, arr|
+      request_name = "#{check_type.to_s}_request"
+      arr.each do |method_symbol|
+        method_name = method_symbol.to_s.gsub(/^\w+?_/, "").downcase
+        define_method(method_name) do
+          send(request_name, TARGET, @service_filter, method_symbol)
+        end
+      end
+    end
+
+
+    def initialize(connection, host, name)
+      @connection = connection
+      @host = host
+      @name = name
+      @service_filter = and_filters(@host.host_filter, filter("SERVICE_NAME", "=", name))
+    end
+
+
+    def fetch(method)
+      string_request(TARGET, @service_filter, method)
+    end
+
+
+    def perfdata
+      rc = request(TARGET, @service_filter, [:SERVICE_PERFDATA])
+      # TODO: parsen
+    end
+
+
+    def current_state
+      rc = request(TARGET, @service_filter, ["SERVICE_CURRENT_STATE"])
+      case rc[:result][0][:SERVICE_CURRENT_STATE].to_i
+        when 0 
+          :ok
+        when 1
+          :warning
+        when 2
+          :critical
+        when 4
+          :unknown
+      end
+    end
+
+
+    def ok?
+      current_state == :ok
+    end
+
+
+    def warning?
+      current_state == :warning
+    end
+
+
+    def critical?
+      current_state == :critical
+    end
+
+
+    def unknown?
+      current_state == :unknown
+    end
+
+    # TODO: implement further
+  end # of class Service
+end

data/lib/icinga_api/version.rb

@@ -0,0 +1,3 @@
+class IcingaApi
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: icinga_api
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Lothar Handl
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ipaddress
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !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: A gem to access the Icinga Web API
+email:
+- ranger@wizards.at
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- icinga_api.gemspec
+- lib/icinga_api.rb
+- lib/icinga_api/host.rb
+- lib/icinga_api/request.rb
+- lib/icinga_api/service.rb
+- lib/icinga_api/version.rb
+homepage: ''
+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.4.1
+signing_key: 
+specification_version: 4
+summary: A gem to access the Icinga Web API
+test_files: []