RubyGems - zabby - Versions diffs - 0.0.2 - Mend

zabby 0.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (39) hide show

data/.gitignore +6 -0
data/Gemfile +4 -0
data/LICENSE +49 -0
data/README.rdoc +137 -0
data/Rakefile +8 -0
data/bin/zabbyrb +86 -0
data/bin/zabbysh +68 -0
data/doc/Zabby.html +208 -0
data/doc/Zabby/AuthenticationError.html +116 -0
data/doc/Zabby/Config.html +414 -0
data/doc/Zabby/ConfigurationError.html +116 -0
data/doc/Zabby/Connection.html +1617 -0
data/doc/Zabby/ResponseCodeError.html +116 -0
data/doc/Zabby/Runner.html +1116 -0
data/doc/_index.html +175 -0
data/doc/class_list.html +47 -0
data/doc/css/common.css +1 -0
data/doc/css/full_list.css +55 -0
data/doc/css/style.css +322 -0
data/doc/file.LICENSE.html +132 -0
data/doc/file.README.html +234 -0
data/doc/file_list.html +52 -0
data/doc/frames.html +13 -0
data/doc/index.html +234 -0
data/doc/js/app.js +205 -0
data/doc/js/full_list.js +167 -0
data/doc/js/jquery.js +16 -0
data/doc/method_list.html +358 -0
data/doc/top-level-namespace.html +103 -0
data/lib/zabby.rb +25 -0
data/lib/zabby/config.rb +38 -0
data/lib/zabby/connection.rb +131 -0
data/lib/zabby/exceptions.rb +10 -0
data/lib/zabby/runner.rb +152 -0
data/lib/zabby/version.rb +8 -0
data/lib/zabby/zobject.rb +27 -0
data/spec/spec_helper.rb +5 -0
data/zabby.gemspec +31 -0
metadata +170 -0

data/doc/top-level-namespace.html ADDED Viewed

@@ -0,0 +1,103 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=fr_fr" />
+<title>
+  Top Level Namespace
+    &mdash; Documentation by YARD 0.7.4
+</title>
+  <link rel="stylesheet" href="css/style.css" type="text/css" media="screen" charset="utf-8" />
+  <link rel="stylesheet" href="css/common.css" type="text/css" media="screen" charset="utf-8" />
+<script type="text/javascript" charset="utf-8">
+  relpath = '';
+  if (relpath != '') relpath += '/';
+</script>
+  <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
+  <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
+  </head>
+  <body>
+    <script type="text/javascript" charset="utf-8">
+      if (window.top.frames.main) document.body.className = 'frames';
+    </script>
+    <div id="header">
+      <div id="menu">
+    <a href="_index.html">Index</a> &raquo;
+    <span class="title">Top Level Namespace</span>
+  <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
+</div>
+      <div id="search">
+    <a id="class_list_link" href="#">Class List</a>
+    <a id="method_list_link" href="#">Method List</a>
+    <a id="file_list_link" href="#">File List</a>
+</div>
+      <div class="clear"></div>
+    </div>
+    <iframe id="search_frame"></iframe>
+    <div id="content"><h1>Top Level Namespace
+</h1>
+<dl class="box">
+</dl>
+<div class="clear"></div>
+<h2>Defined Under Namespace</h2>
+<p class="children">
+      <strong class="modules">Modules:</strong> <span class='object_link'><a href="Zabby.html" title="Zabby (module)">Zabby</a></span>
+</p>
+</div>
+    <div id="footer">
+  Generated on Mon Dec 19 13:31:47 2011 by
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.7.4 (ruby-1.8.7).
+</div>
+  </body>
+</html>

data/lib/zabby.rb ADDED Viewed

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

data/lib/zabby/config.rb ADDED Viewed

@@ -0,0 +1,38 @@
+# -*- encoding: utf-8 -*-
+# Author:: Farzad FARID (<ffarid@pragmatic-source.com>)
+# Copyright:: Copyright (c) 2011 Farzad FARID
+# License:: Simplified BSD License
+# Configuration setting
+module Zabby
+  class Config
+    SETTING_LIST = %w{server user password proxy_host proxy_user proxy_password}
+    def initialize &block
+      setup(&block)
+    end
+    def setup &block
+      instance_eval(&block) if block_given?
+    end
+    def list
+      SETTING_LIST.each do |k|
+        puts "#{k} = #{instance_variable_get("@#{k}")}"
+      end
+    end
+    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/zabby/connection.rb ADDED Viewed

@@ -0,0 +1,131 @@
+# -*- encoding: utf-8 -*-
+# Author:: Farzad FARID (<ffarid@pragmatic-source.com>)
+# Copyright:: Copyright (c) 2011 Farzad FARID
+# License:: Simplified BSD License
+module Zabby
+  class Connection
+    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.empty? ? "/api_jsonrpc.php" : @uri.path
+      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 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
+    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
+    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
+    def query_zabbix_rpc(message)
+      # Send the request!
+      response = http.request(request(message))
+      if response.code != "200" then
+        raise ResponseCodeError.new("Response code from [#{@uri}] is #{response.code}): #{response.body}")
+      end
+      zabbix_response = JSON.parse(response.body)
+      #if not ( responce_body_hash['id'] == id ) then
+      # raise Zabbix::InvalidAnswerId.new("Wrong ID in zabbix answer")
+      #end
+      # Check errors in zabbix answer. If error exist - raise exception Zabbix::Error
+      if (error = zabbix_response['error']) then
+        error_message = error['message']
+        error_data = error['data']
+        error_code = error['code']
+        e_message = "Code: [" + error_code.to_s + "]. Message: [" + error_message +
+                "]. Data: [" + error_data + "]."
+        if error_data == "Login name or password is incorrect"
+          raise AuthenticationError.new(e_message)
+        else
+          raise StandardError.new(e_message)
+        end
+      end
+      zabbix_response['result']
+    end
+  end
+end

data/lib/zabby/exceptions.rb ADDED Viewed

@@ -0,0 +1,10 @@
+# -*- encoding: utf-8 -*-
+# Author:: Farzad FARID (<ffarid@pragmatic-source.com>)
+# Copyright:: Copyright (c) 2011 Farzad FARID
+# License:: Simplified BSD License
+module Zabby
+  class ResponseCodeError < StandardError; end
+  class AuthenticationError < StandardError; end
+  class ConfigurationError < StandardError; end
+end

data/lib/zabby/runner.rb ADDED Viewed

@@ -0,0 +1,152 @@
+# -*- encoding: utf-8 -*-
+# Author:: Farzad FARID (<ffarid@pragmatic-source.com>)
+# Copyright:: Copyright (c) 2011 Farzad FARID
+# License:: Simplified BSD License
+require 'singleton'
+begin
+  require 'readline'
+rescue LoadError
+  # No readline
+end
+module Zabby
+  class Runner
+    include Singleton
+    attr_reader :config, :connection
+    # Meta-create methods with the same name as the configuration settings.
+    # This way we can write:
+    #   set host "http://my.zabbix.server"
+    # instead of:
+    #   set :host => "http://my.zabbix.server"
+    # or "set host" instead of "set :host"
+    # All the created method does is return the second form which will be
+    # used by "set".
+    Zabby::Config::SETTING_LIST.each { |setting|
+      # TODO: Ruby 1.8 does not support default values for block arguments..
+      # Writing "... do |value = nil|" would be more elegant.
+      define_method(setting) do |*args|
+        if args.empty?
+          setting.intern
+        else
+          { setting.intern => args.first }
+        end
+      end
+    }
+    def self.create_zobject(name, zmethods)
+      define_method(name) do
+        @zobject[name] ||= Zabby::ZObject.new(name, zmethods)
+      end
+    end
+    create_zobject(:host, [ :get, :exists, :create, :update, :delete ])
+    create_zobject(:item, [ :get, :exists, :create, :update, :delete ])
+    create_zobject(:apiinfo, [ :version ])
+    def initialize &block
+      @config = Zabby::Config.new &block
+      @connection = Zabby::Connection.new
+      @pure_binding = instance_eval "binding"
+      @zobject = {} # List of Zabbix Object
+      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
+        @readline = false
+      end
+    end
+    def setup &block
+      @config.setup &block
+    end
+    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
+    def login
+      @connection.login(@config)
+    end
+    def logout
+      @connection.logout
+    end
+    def logged_in?
+      @connection.logged_in?
+    end
+    def version
+      Zabby::VERSION
+    end
+    # @param command_file [String] Filename containing commands to execute.
+    # @param block [Proc] A block containing commands to execute.
+    def run(command_file = nil, &block)
+      unless command_file.nil?
+        commands = File.read(command_file)
+        instance_eval(commands)
+      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 "Zabby Shell #{Zabby::VERSION}"
+      puts
+      puts "** This is a simple irb like Zabbix Shell. Multiline commands do not work for e.g. **"
+      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 cmd [String] 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
+    def print_result(res)
+      if res.kind_of? String
+        puts res
+      else
+        puts "=> #{res.inspect}"
+      end
+    end
+  end
+end