livestatus 0.1.0 → 0.2.0

data/.rvmrc

@@ -1 +1 @@
-rvm use --create ruby-1.9.2-p290@livestatus
+rvm use --create ruby-1.8.7-p352@livestatus

data/Gemfile

@@ -1,2 +1,6 @@
 source "http://rubygems.org"
+
 gemspec
+
+gem 'sinatra', '~> 1.2.7'
+gem 'thin', '~> 1.2.5'

data/README.rst

@@ -3,11 +3,10 @@ livestatus
 ==========
 
 :Author: `Benedikt Böhm <bb@xnull.de>`_
-:Web: http://github.com/zenops/livestatus
+:Web: https://github.com/zenops/livestatus
 :Git: ``git clone https://github.com/zenops/livestatus``
 
-Livestatus is a simple Ruby library to get Nagios data via MK Livestatus or
-LivestatusSlave.
+Livestatus is a simple Ruby library to control Nagios via MK Livestatus.
 
 Contributing to livestatus
 ==========================

data/config.ru

@@ -0,0 +1,2 @@
+require 'livestatus/api'
+run Livestatus::API

data/{contrib/example.rb → examples/http.rb}

@@ -2,7 +2,7 @@
 
 require 'livestatus'
 
-c = Livestatus::Connection.new("https://nagios.example.com/nagios/live.php")
+c = Livestatus::Connection.new("https://nagios.example.com/live")
 
 c.handler.session.insecure = true
 c.handler.session.auth_type = :basic

data/examples/simple.rb

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'livestatus'
+
+puts Livestatus::Host.find.first.inspect

data/examples/unix.rb

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+require 'livestatus'
+
+c = Livestatus::Connection.new("unix:///var/nagios/rw/live")
+
+c.command("DISABLE_NOTIFICATIONS")
+puts c.get("status").inspect

data/lib/livestatus.rb

@@ -2,11 +2,13 @@ require "active_support/core_ext"
 
 require "livestatus/version"
 require "livestatus/connection"
-require "livestatus/model"
+require "livestatus/models"
 
 module Livestatus
   mattr_accessor :config
-  self.config = {}
+  self.config = {
+    :uri => "unix:///var/nagios/rw/live",
+  }
 
   def self.connection
     @@connection ||= connection!

data/lib/livestatus/api.rb

@@ -0,0 +1,29 @@
+require 'livestatus/connection'
+require 'livestatus/models'
+require 'sinatra/base'
+require 'yajl'
+
+module Livestatus
+  class API < Sinatra::Base
+    def parse_headers(env)
+      Hash[env.select do |k, v|
+        k =~ /^HTTP_X_LIVESTATUS_/
+      end.map do |k, v|
+        [k[18..-1].downcase.to_sym, v]
+      end]
+    end
+
+    get '/' do
+      headers = parse_headers(request.env)
+
+      halt 400, 'no query specified' unless headers.include?(:query)
+      method, model = headers.delete(:query).split
+
+      halt 400, 'invalid method' unless ['GET', 'COMMAND'].include?(method)
+      method = method.downcase.to_sym
+
+      c = Livestatus::Connection.new(:uri => 'unix:///var/nagios/rw/live')
+      Yajl::Encoder.encode(c.handler.send(method, model, headers))
+    end
+  end
+end

data/lib/livestatus/connection.rb

@@ -19,6 +19,8 @@ module Livestatus
       case @config[:uri]
       when /^https?:\/\//
         PatronHandler.new(@config)
+      when /^unix:\/\//
+        UnixHandler.new(@config)
       else
         raise AttributeError, "unknown uri type: #{@config[:uri]}"
       end

data/lib/livestatus/handler.rb

@@ -1,4 +1,19 @@
-require "livestatus/handler/base"
+module Livestatus
+
+  class HandlerException < StandardError; end
+
+  class BaseHandler
+    def get(table_name, options = {})
+      query(:get, table_name.to_s, options)
+    end
+
+    def command(cmd, time = nil)
+      time = Time.now.to_i unless time
+      query(:command, "[#{time}] #{cmd}")
+    end
+  end
+
+end
 
 Dir["#{File.dirname(__FILE__)}/handler/*.rb"].each do |path|
   require "livestatus/handler/#{File.basename(path, '.rb')}"

data/lib/livestatus/handler/patron.rb

@@ -1,6 +1,6 @@
+require 'livestatus/handler'
 require 'patron'
 require 'yajl'
-require 'cgi'
 
 module Livestatus
 
@@ -12,31 +12,26 @@ module Livestatus
       @session.timeout = 10
       @session.headers["User-Agent"] = "livestatus/#{VERSION} ruby/#{RUBY_VERSION}"
       @session.insecure = config[:insecure]
-      @session.auth_type = config[:auth_type].to_sym
+      @session.auth_type = config.fetch(:auth_type, :basic).to_sym
       @session.username = config[:username]
       @session.password = config[:password]
       @uri = config[:uri]
     end
 
     def query(method, query, headers = {})
-      headers = headers.map { |k,v| "#{k.to_s.capitalize}: #{v}" }.join("\n")
-      headers += "\n" unless headers.empty?
+      headers = Hash[headers.merge({
+        :query => "#{method.to_s.upcase} #{query}"
+      }).map do |k, v|
+        ["X-Livestatus-#{k.to_s.dasherize}", v]
+      end]
 
-      query = CGI::escape("#{method.to_s.upcase} #{query}\n#{headers}")
-      result = session.get("#{@uri}?q=#{query}")
+      result = session.get(@uri, headers)
 
       unless result.status == 200
         raise HandlerException, "livestatus query failed with status #{result.status}"
       end
 
-      parser = Yajl::Parser.new
-      data = parser.parse(result.body)
-
-      if data[0][0] > 0
-        raise HandlerException, "livestatus returned error: #{data[0][1]}"
-      end
-
-      return data[1]
+      Yajl::Parser.parse(result.body)
     end
   end
 

data/lib/livestatus/handler/unix.rb

@@ -0,0 +1,55 @@
+require 'livestatus/handler'
+require 'socket'
+require 'yajl'
+
+module Livestatus
+
+  class UnixHandler < BaseHandler
+    def initialize(config)
+      @socket = UNIXSocket.open(config[:uri].sub(/^unix:\/\//, ''))
+    end
+
+    def get(table_name, options = {})
+      data = super
+
+      if options.include?(:columns)
+        columns = options[:columns].split(" ")
+      else
+        columns = data.delete_at(0)
+      end
+
+      column_zip(columns, data)
+    end
+
+    def query(method, query, headers = {})
+      headers.merge!({
+        :response_header => "fixed16",
+        :output_format => "json",
+        :keep_alive => "on",
+      })
+
+      headers = headers.map { |k,v| "#{k.to_s.camelize}: #{v}" }.join("\n")
+      headers += "\n" unless headers.empty?
+
+      @socket.write("#{method.to_s.upcase} #{query}\n#{headers}\n")
+
+      res = @socket.read(16)
+      status, length = res[0..2].to_i, res[4..14].chomp.to_i
+
+      unless status == 200
+        raise HandlerException, "livestatus query failed with status #{status}"
+      end
+
+      Yajl::Parser.new.parse(@socket.read(length))
+    end
+
+    private
+
+    def column_zip(columns, data)
+      data.map do |d|
+        Hash[columns.zip(d)]
+      end
+    end
+  end
+
+end

data/lib/livestatus/{model/base.rb → models.rb}

@@ -1,4 +1,9 @@
+require "active_support/core_ext"
+
 module Livestatus
+  mattr_accessor :models
+  self.models = []
+
   class Base
     attr_reader :data
 
@@ -82,3 +87,11 @@ module Livestatus
     end
   end
 end
+
+# load all models and register in Livestatus.models
+Dir["#{File.dirname(__FILE__)}/models/*.rb"].map do |path|
+  File.basename(path, '.rb')
+end.each do |name|
+  require "livestatus/models/#{name}"
+  Livestatus.models << "Livestatus::#{name.pluralize.classify}".constantize
+end

data/lib/livestatus/version.rb

@@ -1,3 +1,3 @@
 module Livestatus
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/livestatus.gemspec

@@ -7,9 +7,9 @@ Gem::Specification.new do |s|
   s.version     = Livestatus::VERSION
   s.authors     = ["Benedikt Böhm"]
   s.email       = ["bb@xnull.de"]
-  s.homepage    = ""
-  s.summary     = %q{Simple API wrapper for MK Livestatus and LivestatusSlave}
-  s.description = %q{Simple API wrapper for MK Livestatus and LivestatusSlave}
+  s.homepage    = "https://github.com/zenops/livestatus"
+  s.summary     = %q{Livestatus is a simple Ruby library to control Nagios via MK Livestatus.}
+  s.description = %q{Livestatus is a simple Ruby library to control Nagios via MK Livestatus.}
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")

metadata

@@ -1,116 +1,128 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: livestatus
-version: !ruby/object:Gem::Version
-  version: 0.1.0
+version: !ruby/object:Gem::Version 
   prerelease: 
+  version: 0.2.0
 platform: ruby
-authors:
-- Benedikt Böhm
+authors: 
+- "Benedikt B\xC3\xB6hm"
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-11-19 00:00:00.000000000Z
-dependencies:
-- !ruby/object:Gem::Dependency
+
+date: 2011-11-23 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
   name: activesupport
-  requirement: &24410080 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
   type: :runtime
-  prerelease: false
-  version_requirements: *24410080
-- !ruby/object:Gem::Dependency
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
   name: i18n
-  requirement: &24409660 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
   type: :runtime
-  prerelease: false
-  version_requirements: *24409660
-- !ruby/object:Gem::Dependency
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
   name: patron
-  requirement: &24409240 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
   type: :runtime
-  prerelease: false
-  version_requirements: *24409240
-- !ruby/object:Gem::Dependency
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
   name: yajl-ruby
-  requirement: &24408820 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
   type: :runtime
-  prerelease: false
-  version_requirements: *24408820
-description: Simple API wrapper for MK Livestatus and LivestatusSlave
-email:
+  version_requirements: *id004
+description: Livestatus is a simple Ruby library to control Nagios via MK Livestatus.
+email: 
 - bb@xnull.de
 executables: []
+
 extensions: []
+
 extra_rdoc_files: []
-files:
+
+files: 
 - .gitignore
 - .rvmrc
 - Gemfile
 - LICENSE
 - README.rst
 - Rakefile
-- contrib/example.rb
-- contrib/live.php
+- config.ru
+- examples/http.rb
+- examples/simple.rb
+- examples/unix.rb
 - lib/livestatus.rb
+- lib/livestatus/api.rb
 - lib/livestatus/connection.rb
 - lib/livestatus/handler.rb
-- lib/livestatus/handler/base.rb
 - lib/livestatus/handler/patron.rb
-- lib/livestatus/model.rb
-- lib/livestatus/model/base.rb
-- lib/livestatus/model/command.rb
-- lib/livestatus/model/comment.rb
-- lib/livestatus/model/contact.rb
-- lib/livestatus/model/contactgroup.rb
-- lib/livestatus/model/downtime.rb
-- lib/livestatus/model/host.rb
-- lib/livestatus/model/hostgroup.rb
-- lib/livestatus/model/service.rb
-- lib/livestatus/model/servicegroup.rb
-- lib/livestatus/model/timeperiod.rb
+- lib/livestatus/handler/unix.rb
+- lib/livestatus/models.rb
+- lib/livestatus/models/command.rb
+- lib/livestatus/models/comment.rb
+- lib/livestatus/models/contact.rb
+- lib/livestatus/models/contactgroup.rb
+- lib/livestatus/models/downtime.rb
+- lib/livestatus/models/host.rb
+- lib/livestatus/models/hostgroup.rb
+- lib/livestatus/models/service.rb
+- lib/livestatus/models/servicegroup.rb
+- lib/livestatus/models/timeperiod.rb
 - lib/livestatus/version.rb
 - livestatus.gemspec
-homepage: ''
+has_rdoc: true
+homepage: https://github.com/zenops/livestatus
 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
-      version: '0'
-required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
 requirements: []
+
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
-summary: Simple API wrapper for MK Livestatus and LivestatusSlave
+summary: Livestatus is a simple Ruby library to control Nagios via MK Livestatus.
 test_files: []
+

data/contrib/live.php

@@ -1,252 +0,0 @@
-<?php
-/*****************************************************************************
- *
- * live.php - Standalone PHP script to serve the unix socket of the
- *            MKLivestatus NEB module as webservice.
- *
- * Copyright (c) 2010,2011 Lars Michelsen <lm@larsmichelsen.com>
- * Copyright (c) 2011 Benedikt Böhm <bb@xnull.de>
- *
- * License:
- *
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License version 2 as
- * published by the Free Software Foundation.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
- *
- * @AUTHOR   Lars Michelsen <lm@larsmichelsen.com>
- * @HOME     http://nagios.larsmichelsen.com/livestatusslave/
- * @VERSION  1.1
- *****************************************************************************/
-
-/**
- * Script configuration.
- */
-
-$conf = Array(
-    // The socket type can be 'unix' for connecting with the unix socket or 'tcp'
-    // to connect to a tcp socket.
-    'socketType'       => 'unix',
-    // When using a unix socket the path to the socket needs to be set
-    'socketPath'       => '/var/nagios/rw/live',
-    // When using a tcp socket the address and port needs to be set
-    'socketAddress'    => '',
-    'socketPort'       => '',
-    // Modify the default allowed query type match regex
-    'queryTypes'       => '(GET|COMMAND)',
-);
-
-
-###############################################################################
-# Don't modify the code below when you're not aware of what you are doing...
-###############################################################################
-
-class LiveException extends Exception {}
-
-$LIVE = null;
-
-// Start the main function
-livestatusSlave();
-
-function livestatusSlave() {
-    global $conf;
-
-    try {
-        verifyConfig();
-        connectSocket();
-
-        $query = getQuery();
-        response(Array(0, 'OK'), queryLivestatus($query));
-
-        closeSocket();
-        exit(0);
-    } catch(LiveException $e) {
-        response(Array(1, $e->getMessage()), Array());
-        closeSocket();
-        exit(1);
-    }
-}
-
-function readQuery() {
-    global $argv;
-
-    if (isset($_REQUEST['q']) && $_REQUEST['q'] !== '') {
-        return str_replace('\\\\n', "\n", $_REQUEST['q']);
-    } elseif (isset($argv[1]) && $argv[1] !== '') {
-        return str_replace('\\n', "\n", $argv[1]);
-    } else {
-        throw new LiveException('No query given in "q" Attribute nor argv[0].');
-    }
-}
-
-function getQuery() {
-    global $conf;
-    $query = readQuery();
-
-    if (!preg_match("/^".$conf['queryTypes']."\s/", $query))
-        throw new LiveException('Invalid livestatus query: ' . $query);
-
-    return $query;
-}
-
-function response($head, $body) {
-    header('Content-type: application/json');
-    $json_result = json_encode(Array($head, $body));
-
-    // Support jsonp when requested by client (see http://en.wikipedia.org/wiki/JSONP).
-    if (isset($_REQUEST['callback']) && $_REQUEST['callback'] != '')
-        $json_result = $_REQUEST['callback']."(".$json_result.")";
-
-    echo $json_result;
-}
-
-function verifyConfig() {
-    global $conf;
-
-    if (!function_exists('socket_create')) {
-        throw new LiveException('The PHP function socket_create is not available. Maybe the sockets module is missing in your PHP installation.');
-    }
-
-    if ($conf['socketType'] != 'tcp' && $conf['socketType'] != 'unix') {
-        throw new LiveException('Socket Type is invalid. Need to be "unix" or "tcp".');
-    }
-
-    if ($conf['socketType'] == 'unix') {
-        if ($conf['socketPath'] == '') {
-            throw new LiveException('The option socketPath is empty.');
-        }
-
-        if (!file_exists($conf['socketPath'])) {
-            throw new LiveException('The configured livestatus socket does not exists');
-        }
-    }
-
-    elseif ($conf['socketType'] == 'tcp') {
-        if ($conf['socketAddress'] == '') {
-            throw new LiveException('The option socketAddress is empty.');
-        }
-
-        if ($conf['socketPort'] == '') {
-            throw new LiveException('The option socketPort is empty.');
-        }
-    }
-}
-
-function readSocket($len) {
-    global $LIVE;
-    $offset = 0;
-    $socketData = '';
-
-    while($offset < $len) {
-        if (($data = @socket_read($LIVE, $len - $offset)) === false)
-            return false;
-
-        $dataLen = strlen ($data);
-        $offset += $dataLen;
-        $socketData .= $data;
-
-        if ($dataLen == 0)
-            break;
-    }
-
-    return $socketData;
-}
-
-function queryLivestatus($query) {
-    global $LIVE;
-
-    // Query to get a json formated array back
-    // Use fixed16 header
-    socket_write($LIVE, $query . "OutputFormat: json\nResponseHeader: fixed16\n\n");
-    socket_shutdown($LIVE, 1);
-
-    if (substr($query, 0, 7) == "COMMAND") {
-        return Array();
-    }
-
-    // Read 16 bytes to get the status code and body size
-    $read = readSocket(16);
-
-    if ($read === false)
-        throw new LiveException('Problem while reading from socket: '.socket_strerror(socket_last_error($LIVE)));
-
-    // Extract status code
-    $status = substr($read, 0, 3);
-
-    // Extract content length
-    $len = intval(trim(substr($read, 4, 11)));
-
-    // Read socket until end of data
-    $read = readSocket($len);
-
-    if ($read === false)
-        throw new LiveException('Problem while reading from socket: '.socket_strerror(socket_last_error($LIVE)));
-
-    // Catch errors (Like HTTP 200 is OK)
-    if ($status != "200")
-        throw new LiveException('Problem while reading from socket: '.$read);
-
-    // Catch problems occured while reading? 104: Connection reset by peer
-    if (socket_last_error($LIVE) == 104)
-        throw new LiveException('Problem while reading from socket: '.socket_strerror(socket_last_error($LIVE)));
-
-    // Decode the json response
-    $obj = json_decode(utf8_encode($read));
-
-    // json_decode returns null on syntax problems
-    if ($obj === null)
-        throw new LiveException('The response has an invalid format');
-    else
-        return $obj;
-}
-
-function connectSocket() {
-    global $conf, $LIVE;
-
-    // Create socket connection
-    if ($conf['socketType'] === 'unix') {
-        $LIVE = socket_create(AF_UNIX, SOCK_STREAM, 0);
-    } elseif ($conf['socketType'] === 'tcp') {
-        $LIVE = socket_create(AF_INET, SOCK_STREAM, SOL_TCP);
-    }
-
-    if ($LIVE == false) {
-        throw new LiveException('Could not create livestatus socket connection.');
-    }
-
-    // Connect to the socket
-    if ($conf['socketType'] === 'unix') {
-        $result = socket_connect($LIVE, $conf['socketPath']);
-    } elseif ($conf['socketType'] === 'tcp') {
-        $result = socket_connect($LIVE, $conf['socketAddress'], $conf['socketPort']);
-    }
-
-    if ($result == false) {
-        throw new LiveException('Unable to connect to livestatus socket.');
-    }
-
-    // Maybe set some socket options
-    if ($conf['socketType'] === 'tcp') {
-        // Disable Nagle's Algorithm - Nagle's Algorithm is bad for brief protocols
-        if (defined('TCP_NODELAY')) {
-            socket_set_option($LIVE, SOL_TCP, TCP_NODELAY, 1);
-        } else {
-            // See http://bugs.php.net/bug.php?id=46360
-            socket_set_option($LIVE, SOL_TCP, 1, 1);
-        }
-    }
-}
-
-function closeSocket() {
-    global $LIVE;
-    @socket_close($LIVE);
-    $LIVE = null;
-}

data/lib/livestatus/handler/base.rb

@@ -1,32 +0,0 @@
-module Livestatus
-
-  class HandlerException < StandardError; end
-
-  class BaseHandler
-    def get(table_name, options = {})
-      data = query(:get, table_name.to_s, options)
-
-      if options.include?(:columns)
-        columns = options[:columns].split(" ")
-      else
-        columns = data.delete_at(0)
-      end
-
-      column_zip(columns, data)
-    end
-
-    def command(cmd, time = nil)
-      time = Time.now.to_i unless time
-      query(:command, "[#{time}] #{cmd}")
-    end
-
-    private
-
-    def column_zip(columns, data)
-      data.map do |d|
-        Hash[columns.zip(d)]
-      end
-    end
-  end
-
-end

data/lib/livestatus/model.rb

@@ -1,5 +0,0 @@
-require "livestatus/model/base"
-
-Dir["#{File.dirname(__FILE__)}/model/*.rb"].each do |path|
-  require "livestatus/model/#{File.basename(path, '.rb')}"
-end