rbZabbix 0.1.4 → 0.1.5

data/lib/rbZabbix.rb

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+# Author:: Farzad FARID (<ffarid@pragmatic-source.com>)
+# Copyright:: Copyright (c) 2011-2012 Farzad FARID
+# License:: Simplified BSD License
+
+require 'rubygems'
+require 'json'
+require 'net/http'
+require 'net/https'
+require 'openssl'
+require 'uri'
+require 'pp'
+
+require 'rbZabbix/version'
+require 'rbZabbix/exceptions'
+require 'rbZabbix/config'
+require 'rbZabbix/zclass'
+require 'rbZabbix/connection'
+require 'rbZabbix/shell_helpers'
+require 'rbZabbix/runner'
+
+module Zabby
+  def self.init &block
+    z = Zabby::Runner.instance
+    z.run(&block) if block_given?
+    z
+  end
+end

data/lib/rbZabbix/config.rb

@@ -0,0 +1,44 @@
+# -*- encoding: utf-8 -*-
+# Author:: Farzad FARID (<ffarid@pragmatic-source.com>)
+# Copyright:: Copyright (c) 2011-2012 Farzad FARID
+# License:: Simplified BSD License
+
+# Configuration setting
+module Zabby
+  class Config
+    SETTING_LIST = %w{server user password proxy_host proxy_user proxy_password}
+
+    # Initialize Zabby configuration settings
+    # @todo Anything to configure here?
+    def initialize
+    end
+
+    # Display configuration variables
+    def list
+    puts "Zabby configuration"
+    puts "==================="
+      SETTING_LIST.each do |k|
+        puts "#{k} = #{instance_variable_get("@#{k}")}"
+      end
+      nil
+    end
+
+    # Dynamic setter and getter methods for the configuration variables.
+    # @param [String] name Setting name, ending with "=" in case we are setting a value
+    # @param [Array] args Setting value
+    # @param [Proc] block Unused
+    # @return [Object] Return the value set
+    def method_missing(name, *args, &block)
+      name = name.to_s.gsub(/=$/, '')
+      raise ConfigurationError.new("Unknown setting '#{name}'") if !SETTING_LIST.include?(name.to_s)
+
+      if args.empty?
+        instance_variable_get("@#{name}")
+      elsif args.size != 1
+        raise ConfigurationError.new("Too many values for '#{name}'")
+      else
+        instance_variable_set("@#{name}", args.first)
+      end
+    end
+  end
+end

data/lib/rbZabbix/connection.rb

@@ -0,0 +1,152 @@
+# -*- encoding: utf-8 -*-
+# Author:: Farzad FARID (<ffarid@pragmatic-source.com>)
+# Copyright:: Copyright (c) 2011-2012 Farzad FARID
+# License:: Simplified BSD License
+
+module Zabby
+  class Connection
+    # Name of the Zabbix RPC script
+    JSONRPC_SCRIPT = "/api_jsonrpc.php"
+
+    attr_reader :uri, :request_path, :user, :password, :proxy_host, :proxy_user, :proxy_password
+    attr_reader :auth
+    attr_reader :request_id
+
+    def initialize
+      reset
+    end
+
+    def reset
+      @uri = @user = @password = @proxy_host = @proxy_user = @proxy_password = nil
+      @request_id = 0
+      @auth = nil
+    end
+
+    def login(config)
+      return @auth if @auth
+      
+      @uri = URI.parse(config.server)
+      @user = config.user
+      @password = config.password
+      if config.proxy_host
+        @proxy_host = URI.parse(config.proxy_host)
+        @proxy_user = config.proxy_user
+        @proxy_password = config.proxy_password
+      end
+      @request_path = @uri.path[-4,4] == '.php' ? @uri.path : @uri.path + JSONRPC_SCRIPT
+      authenticate
+    end
+
+    def logout
+      reset
+    end
+
+    def logged_in?
+      !@auth.nil?
+    end
+    
+    def next_request_id
+      @request_id += 1
+    end
+
+    # @return [Authentication key]
+    def authenticate
+      auth_message = format_message('user', 'login',
+                                    'user' => @user,
+                                    'password' => @password)
+      @auth = query_zabbix_rpc(auth_message)
+    rescue Zabby::APIError
+      # Older Zabbix 1.8.x used a different authentication method. You have to guess...
+      auth_message = format_message('user', 'authenticate',
+                                    'user' => @user,
+                                    'password' => @password)
+      @auth = query_zabbix_rpc(auth_message)
+    rescue Exception => e
+      @auth = nil
+      raise e
+    end
+
+    def format_message(element, action, params = {})
+      {
+          'jsonrpc' => '2.0',
+          'id' => next_request_id,
+          'method' => "#{element}.#{action}",
+          'params' => params,
+          'auth' => @auth
+      }
+    end
+
+    # Perform an authenticated request
+    # @return [Object] The Zabbix response (Hash, Boolean, etc.) in JSON format.
+    def perform_request(element, action, params)
+      raise AuthenticationError.new("Not logged in") if !logged_in?
+
+      message = format_message(element, action, params)
+      query_zabbix_rpc(message)
+    end
+
+    # Prepare a JSON request HTTP Post format
+    # @param [Hash] message A hash with all parameters for the Zabbix web service.
+    # @return [Net::HTTP::Post] Message ready to be POSTed.
+    def request(message)
+      req = Net::HTTP::Post.new(@request_path)
+      req.add_field('Content-Type', 'application/json-rpc')
+      req.body = JSON.generate(message)
+      req
+    end
+
+    # Prepare http object
+    def http
+      if @proxy_host
+        http = Net::HTTP::Proxy(@proxy_host.host, @proxy_host.port, @proxy_user, @proxy_password).new(@uri.host, @uri.port)
+      else
+        http = Net::HTTP.new(@uri.host, @uri.port)
+      end
+      if @uri.scheme == "https"
+        http.use_ssl = true
+        http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      end
+      http
+    end
+
+    # Raise a Zabby exception
+    # @param [Hash] zabbix_response JSON formatted Zabbix response.
+    # @raise [Zabby::AuthenticationError] Authentication error.
+    # @raise [zabby::APIError] Generic Zabbix Web Services error.
+    def format_exception(zabbix_response)
+      error = zabbix_response['error']
+      error_message = error['message']
+      error_data = error['data']
+      error_code = error['code']
+
+      if error_data == "Login name or password is incorrect"
+        raise AuthenticationError.new(error_message, error_code, error_data)
+      else
+        raise APIError.new(error_message, error_code, error_data)
+      end
+    end
+
+    # Query the Zabbix Web Services and extract the JSON response.
+    # @param [Hash] message request in JSON format.
+    # @return [Object] The Zabbix response (Hash, Boolean, etc.) in JSON format.
+    # @raise [Zabby::ResponseCodeError] HTTP error.
+    def query_zabbix_rpc(message)
+      # Send the request!
+      http_response = http.request(request(message))
+
+      # Check for HTTP errors.
+      if http_response.code != "200"
+        raise ResponseCodeError.new("Error from #{@uri}", http_response.code, http_response.body)
+      end
+
+      zabbix_response = JSON.parse(http_response.body)
+
+      # Check for Zabbix errors.
+      if zabbix_response['error']
+        format_exception(zabbix_response)
+      end
+
+      zabbix_response['result']
+    end
+  end
+end

data/lib/rbZabbix/exceptions.rb

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+# Author:: Farzad FARID (<ffarid@pragmatic-source.com>)
+# Copyright:: Copyright (c) 2011-2012 Farzad FARID
+# License:: Simplified BSD License
+
+module Zabby
+  class APIError < StandardError
+    attr_reader :code, :msg, :data
+
+    def initialize(msg, code = nil, data = nil)
+      @msg = msg
+      @code = code
+      @data = data
+    end
+
+    def message
+      text = "#{msg}"
+      text += ": #{data}" if data
+      text += " (code: #{code})" if code
+      text
+    end
+  end
+  class ResponseCodeError < APIError; end
+  class AuthenticationError < APIError; end
+  class ConfigurationError < StandardError; end
+end

data/lib/rbZabbix/runner.rb

@@ -0,0 +1,102 @@
+# -*- encoding: utf-8 -*-
+# Author:: Farzad FARID (<ffarid@pragmatic-source.com>)
+# Copyright:: Copyright (c) 2011-2012 Farzad FARID
+# License:: Simplified BSD License
+
+require 'singleton'
+begin
+  require 'readline'
+rescue LoadError
+  # No readline
+end
+
+
+module Zabby
+  # This is the main interpreter.
+  # Additional shell commands are defined in the ShellHelpers module.
+  class Runner
+    include Singleton
+    include ShellHelpers
+
+    attr_reader :config, :connection
+
+    def initialize
+      @config = Zabby::Config.new
+      @connection = Zabby::Connection.new
+      @pure_binding = instance_eval "binding"
+
+      # Configure Readline for the shell, if available
+      if Object.const_defined?(:Readline)
+        @readline = true
+        Readline.basic_word_break_characters = ""
+			  Readline.completion_append_character = nil
+			  #Readline.completion_proc = completion_proc
+
+			  $last_res = nil
+      else
+        # Without Readline the Zabby shell is not available.
+        @readline = false
+      end
+    end
+
+    # Execute script file and/or instruction block
+    # @param [String] command_file Filename containing commands to execute.
+    # @param [Proc] block A block containing commands to execute.
+    def run(command_file = nil, &block)
+      unless command_file.nil?
+        commands = File.read(command_file)
+        instance_eval(commands, command_file, 1)
+      end
+      instance_eval(&block) if block_given?
+    end
+
+    # Execute an irb like shell in which we can type Zabby commands.
+    def shell
+      raise RuntimeError.new("Shell cannot run because 'readline' is missing.") if !@readline
+
+      puts <<HEADER
+Zabby Shell #{Zabby::VERSION}
+
+** This is a simple irb like Zabbix Shell. Multiline commands do not work for e.g. **
+Type "help" for online documentation.
+HEADER
+      loop do
+        cmd = Readline.readline('zabby> ')
+
+        exit(0) if cmd.nil? or cmd == 'exit'
+        next if cmd == ""
+        Readline::HISTORY.push(cmd)
+
+        execute(cmd)
+      end
+    end
+
+    private
+
+    # Run a single command.
+    # @param [String] cmd A command to execute in the object's context.
+    def execute(cmd)
+      res = eval(cmd, @pure_binding)
+      $last_res = res
+      eval("_ = $last_res", @pure_binding)
+      print_result res
+    rescue ::Exception => e
+      puts "Exception #{e.class} -> #{e.message}"
+      e.backtrace.each do |t|
+        puts "   #{::File.expand_path(t)}"
+      end
+    end
+
+    # Print a single command's output on the screen using "inspect" if necessary.
+    # @param [Object] res Result object to display
+    def print_result(res)
+      if res.kind_of? String
+        puts res
+      elsif res.nil?
+        # Do not print nil values
+      else
+        puts "=> #{res.inspect}"
+      end
+    end
+  end
+end

data/lib/rbZabbix/shell_helpers.rb

@@ -0,0 +1,102 @@
+# -*- encoding: utf-8 -*-
+# Author:: Farzad FARID (<ffarid@pragmatic-source.com>)
+# Copyright:: Copyright (c) 2011-2012 Farzad FARID
+# License:: Simplified BSD License
+
+module Zabby
+  # Useful helper methods for the Zabbix Shell. Methods added to this module
+  # are available in the scripting language and commande line.
+  # The following instance variable should be available to helper methods:
+  # - @config: Zabby::Config instance
+  # - @connection: Zabby::Connection instance
+  module ShellHelpers
+    # Documentation for helpers.
+    # Each helper method definition must be preceded by a call to "desc" and a short
+    # online help for the method.
+    @helpers_doc = {}
+    @last_doc = nil
+
+    # Save the documentation for a method about to be defined.
+    # @param text [String] Documentation of the method following the call to "desc"
+    def self.desc(text)
+      @last_doc = text
+    end
+
+    # Push helper documentation for the method just defined in a hash.
+    # @param [Symbol] method Helper method to document
+    # @todo Display functions in alphabetical or arbitrary order.
+    def self.method_added(method)
+      if @last_doc.nil?
+        @helpers_doc[method.id2name] = "** UNDOCUMENTED FUNCTION **"
+      else
+        @helpers_doc[method.id2name] = @last_doc
+        @last_doc = nil
+      end
+    end
+
+    # Show the Shell helpers documentation
+    def self.helpers_doc
+      help = <<EOT
+Available commands:
+==================
+
+EOT
+      @helpers_doc.each do |name, text|
+        help += name + ":\n"
+        help += '-' * name.size + "\n"
+        help += text + "\n\n"
+      end
+      help
+    end
+
+    desc %q{Set or query Zabby parameters.
+- "set" without argument displays all parameters.
+- "set <param>" shows the value of <param>
+- "set <param> => <value>" set <param> to <value>}
+    def set(key_value = nil)
+      if key_value.nil?
+        @config.list
+      elsif [ String, Symbol ].include?(key_value.class)
+        puts "#{key_value} = #{@config.send(key_value)}"
+      elsif key_value.instance_of? Hash
+        key = key_value.keys.first
+        value = key_value[key]
+        @config.send(key, value)
+      end
+    end
+
+    desc %q{Login to the Zabbix server.
+The parameters 'server', 'user' and 'password' must be defined.}
+    def login
+      @connection.login(@config)
+    end
+
+    desc 'Logout from the Zabbix server'
+    def logout
+      @connection.logout
+    end
+
+    desc 'Return true if we are connected to the Zabbix server, false otherwise.'
+    def logged_in?
+      @connection.logged_in?
+    end
+
+    desc 'Alias for "logged_in?".'
+    alias_method :loggedin?, :logged_in?
+
+    desc 'Show Zabby version.'
+    def version
+      Zabby::VERSION
+    end
+
+    desc 'Return the list of available Zabbix Classes (object types).'
+    def zabbix_classes
+      Zabby::ZClass.zabbix_classes
+    end
+
+    desc 'Show this help text.'
+    def help
+      puts Zabby::ShellHelpers.helpers_doc
+    end
+  end
+end