zabby 0.0.2

data/.gitignore

@@ -0,0 +1,6 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+.idea
+.yardoc

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in zabby.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,49 @@
+Copyright 2011 Farzad FARID / Pragmatic Source. All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are
+permitted provided that the following conditions are met:
+
+   1. Redistributions of source code must retain the above copyright notice, this list of
+      conditions and the following disclaimer.
+
+   2. Redistributions in binary form must reproduce the above copyright notice, this list
+      of conditions and the following disclaimer in the documentation and/or other materials
+      provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY PRAGMATIC SOURCE ''AS IS'' AND ANY EXPRESS OR IMPLIED
+WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
+FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL PRAGMATIC SOURCE OR
+CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
+ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+The views and conclusions contained in the software and documentation are those of the
+authors and should not be interpreted as representing official policies, either expressed
+or implied, of Pragmatic Source.
+
+OTHER LICENSES COVERING PORTIONS OF CODE
+========================================
+
+Portions of code in "Zabbix::Running" were inspired by Rush (https://github.com/adamwiggins/rush):
+
+Copyright (c) 2010 Adam Wiggins
+
+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.rdoc

@@ -0,0 +1,137 @@
+= Zabby
+
+Zabby[http://zabby.org] is a Ruby library and client for Zabbix[http://www.zabbix.com/]. It provides a simple and
+clean interface to the {Zabbix Web Services}[http://www.zabbix.com/documentation/1.8/api].
+
+== Goals
+
+There already are Ruby Zabbix libraries but some of them are unfinished (and apparently
+abandonned) and some other's code is too complicated or poorly designed. This is why I decided
+to write another tool for which my primary goal is to keep the code design, the user interaction
+and application interface clean and simple.
+
+Zabby has the following caracteristics:
+- Works both as a Ruby API and a command line tool.
+- Uses an internal Ruby DSL (Domain Specific Langage) that give access to the full power of
+  Ruby scripting in your configurarion files. No need for a specific configuration language.
+- Simple design: avoids spaghetti code, WTF and facepalm, unlike some other
+  Ruby Zabbix libraries.
+
+== Features
+
+- Low level Ruby API that maps every Zabbix API (JSON RPC) to Ruby hashes.
+- Higher level Ruby DSL, both available in pure Ruby and for writing configuration files.
+- Supports authenticated HTTP proxies.
+- Full featured IRB like shell included with Readline support. You can mix Zabbix instructions
+  with Ruby calls transparently.
+
+== Examples
+
+=== API use
+
+The barebone API can be used in Ruby like this:
+
+    require "rubygems"
+    require "zabby"
+    require "pp"
+
+    z = Zabby.init do
+      host "https://monitoring.example.com"
+      user "api_user"
+      password "s3cr3t"
+      proxy_host "http://10.10.10.10"
+      proxy_user "john"
+      proxy_password "D0e"
+    end
+    z.login
+
+    pp z.connection.perform_request("host", "get", { "filter" => { "host" => "master.example.com" } })
+    pp z.connection.perform_request("item", "get", { "host" => "master.example.com", "output" => "shorten" })
+
+- The _host_, _user_ and _passord_ are necessary.
+- If you don't provide the path to the JSON-RPC script "/api_jsonrpc.php" is appended
+  to the URI automatically.
+- The <em>proxy_*</em> settings are optionnal.
+
+=== Shell
+
+*zabbysh* is an simple Zabbix Shell. It runs either interactively or
+can be used to execute a command file with the "-f CMD_FILE" option.
+
+If the command file does not end with "exit" then the program drops into
+the shell after executing the file.
+
+*zabbysh* provides Readline support but does no support advanced IRB features likes
+multi-lines instructions.
+
+*zabbyrb* is another Zabbix Shell based on *IRB*. It provides the whole power of IRB
+but may be less stable than zabbysh because the IRB API is poorly documented and hard
+to use.
+
+==== Interactive shell
+
+    # zabbysh
+    zabby> set host "https://monitoring.example.com"
+    zabby> set user "api_user"
+    zabby> set password "s3cr3t"
+    zabby> set proxy_host "http://10.10.10.10"
+    zabby> set proxy_user "john"
+    zabby> set proxy_password "D0e"
+    zabby> login
+    zabby> logged_in?
+    zabby> host.get "filter" => { "host" => "monitor.example.com" }, "output" => "extend"
+    zabby> item.get "host" => "monitor.example.com", "output" => "refer"
+    zabby> [...]
+    zabby> logout
+    zabby> exit
+
+==== Execute a command script
+
+Create a file and put the same instructions as above in it, then execute *zabbysh*:
+
+    # zabbysh --file my_zabbix_commands.txt
+
+== Requirements
+
+- Ruby 1.8.5. It basically runs anywhere!
+- JSON library: 'json' or 'json_pure'
+- OptionParser
+- Readline (optionnal, used by the interactive shell)
+
+== References
+
+- Main web site: http://zabby.org
+- GitHub projet: https://github.com/Pragmatic-Source/zabby
+
+== Contributing
+
+All contributions are welcome. You can either open a ticket on Github, send a pull request
+with a patch or send an email to the author.
+
+== Author
+
+Farzad FARID mailto:ffarid@pragmatic-source.com
+
+=== Thanks to
+
+- Jean-Hadrien Chabran (jhchabran): Advices on code design.
+- Nicolas Blanco (slainer68): Advices on code design and Triple Facepalming after reading other Ruby/Zabbix code.
+- Renaud Chaput (renchap): For suggesting the "zabby" name.
+
+=== Sources of inspiration
+
+- Adam Wiggins's Rush[https://github.com/adamwiggins/rush] for the interactive shell.
+- Other Zabbix Ruby libraries (only the good parts ;) ):
+
+zabcon[http://trac.red-tux.net/]::
+  Zabcon is a command line interface for Zabbix written in Ruby
+
+rzabbix[http://github.com/neerfri/rzabbix]::
+  Zabbix API client for Ruby
+
+rubix[https://github.com/dhruvbansal/rubix]::
+  Rubix is a Ruby client for Zabbix
+
+== License
+
+This software is release under the <b>Simplified BSD license</b>. See the LICENSE file.

data/Rakefile

@@ -0,0 +1,8 @@
+require 'bundler'
+require 'yard'
+Bundler::GemHelper.install_tasks
+
+YARD::Rake::YardocTask.new do |t|
+  t.files   = ['lib/**/*.rb', '-', 'LICENSE']
+  #t.options = ['--any', '--extra', '--opts'] # optional
+end

data/bin/zabbyrb

@@ -0,0 +1,86 @@
+#!/usr/bin/env ruby
+# -*- encoding: utf-8 -*-
+# Author:: Farzad FARID (<ffarid@pragmatic-source.com>)
+# Copyright:: Copyright (c) 2011 Farzad FARID
+# License:: Simplified BSD License
+
+# This is an experimental Zabby Shell based on IRB. It is still buggy and the code
+# is very nasty because IRB is poorly documented and hard to use as a library. Use
+# with care.
+#
+# Ugly IRB initialisation inspired by Shef (Chef's CLI) and a article on
+# StackOverflow : http://stackoverflow.com/questions/4189818/how-to-run-irb-start-in-context-of-current-class
+
+ZABBY_ROOT = File.expand_path('../../lib', __FILE__)
+$: << ZABBY_ROOT unless $:.include?(ZABBY_ROOT)
+
+require 'zabby'
+require 'optparse'
+require 'ostruct'
+require 'irb'
+require 'irb/completion'
+
+
+module ZabbyRB
+  def self.irb_conf
+    @irb_conf || IRB.conf
+  end
+
+  def self.configure_irb
+    irb_conf[:MAIN_CONTEXT] = IRB::Irb.new.context
+    irb_conf[:HISTORY_FILE] = "~/.zabby_history"
+    irb_conf[:SAVE_HISTORY] = 1000
+
+    irb_conf[:IRB_RC] = lambda do |conf|
+      m = conf.main
+      leader = "(#{m.class.to_s})"
+
+      def m.help
+        puts "Help??"
+      end
+
+      # Hack without which "exit" brings us back to the main IRB context instead
+      # of exiting.
+      def m.exit
+        Kernel.exit
+      end
+
+      conf.prompt_c       = "Zabby#{leader} > "
+      conf.return_format  = " => %s \n"
+      conf.prompt_i       = "Zabby#{leader} > "
+      conf.prompt_n       = "Zabby#{leader} ?> "
+      conf.prompt_s       = "Zabby#{leader}%l> "
+    end
+  end
+
+  def self.init
+    configure_irb
+
+    puts <<EOT
+Zabby Shell #{Zabby::VERSION}, irb based shell.
+
+run `help' for help, `exit' or ^D to quit.
+
+** THIS IS AN EXPERIMENTAL SHELL, IT MAY BE UNSTABLE. USE WITH CARE. **
+Please use 'zabbysh' instead and report a bug if 'zabbyrb' does not
+work correctly.
+EOT
+  end
+end
+
+module IRB
+  class << self
+    alias :run_original_config :run_config
+
+    def run_config
+      run_original_config
+      ZabbyRB.init
+    end
+  end
+end
+
+IRB.setup nil
+#IRB.conf[:MAIN_CONTEXT] = IRB::Irb.new.context
+require 'irb/ext/multi-irb'
+IRB.irb nil, Zabby.init
+IRB.start

data/bin/zabbysh

@@ -0,0 +1,68 @@
+#!/usr/bin/env ruby
+# -*- encoding: utf-8 -*-
+# Author:: Farzad FARID (<ffarid@pragmatic-source.com>)
+# Copyright:: Copyright (c) 2011 Farzad FARID
+# License:: Simplified BSD License
+
+
+ZABBY_ROOT = File.expand_path('../../lib', __FILE__)
+$: << ZABBY_ROOT unless $:.include?(ZABBY_ROOT)
+
+require 'zabby'
+require "optparse"
+require 'ostruct'
+
+options = OpenStruct.new
+options.file = nil
+
+opts = OptionParser.new do |opts|
+  opts.banner = "Usage: zabbysh [options]"
+
+  opts.separator ""
+  opts.separator "Specific options:"
+
+  opts.on("-f", "--file COMMAND_FILE",
+                "Execute the instructions in COMMAND_FILE") do |file|
+          options.file = file
+  end
+
+  opts.separator ""
+  opts.separator "Common options:"
+
+
+  opts.on_tail("-h", "--help", "Show this message") do
+    puts opts
+    exit
+  end
+
+  opts.on_tail("--version", "Show version") do
+    puts <<EOT
+Zabby #{Zabby::VERSION}
+Copyright (c) 2011 Farzad FARID / Pragmatic Source
+License: Simplified BSD
+EOT
+    exit
+  end
+end
+
+opts.parse!(ARGV)
+
+z = Zabby.init
+
+if options.file
+  begin
+    z.run(options.file)
+  rescue SystemExit
+    exit 0
+  rescue Exception => e
+    puts "Exception #{e.class} -> #{e.message}"
+    e.backtrace.each do |t|
+      puts "   #{::File.expand_path(t)}"
+    end
+    exit 1
+  end
+end
+
+# We end up here even if a command file is provided if it doesn't end with "exit"
+z.shell
+exit 0

data/doc/Zabby.html

@@ -0,0 +1,208 @@
+<!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>
+  Module: Zabby
+  
+    &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 (Z)</a> &raquo; 
+    
+    
+    <span class="title">Zabby</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>Module: Zabby
+  
+  
+  
+</h1>
+
+<dl class="box">
+  
+  
+    
+  
+    
+  
+  
+  
+    <dt class="r1 last">Defined in:</dt>
+    <dd class="r1 last">lib/zabby/config.rb<span class="defines">,<br />
+  lib/zabby.rb,<br /> lib/zabby/runner.rb,<br /> lib/zabby/version.rb,<br /> lib/zabby/connection.rb,<br /> lib/zabby/exceptions.rb</span>
+</dd>
+  
+</dl>
+<div class="clear"></div>
+
+<h2>Overview</h2><div class="docstring">
+  <div class="discussion">
+    <table>
+<tr><td valign="top">Author:</td><td>Farzad FARID (&lt;ffarid@pragmatic-source.com&gt;)
+
+</td></tr>
+<tr><td valign="top">Copyright:</td><td>Copyright &#169; 2011 Farzad FARID
+
+</td></tr>
+<tr><td valign="top">License:</td><td>Simplified BSD License
+
+</td></tr>
+</table>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+
+</div><h2>Defined Under Namespace</h2>
+<p class="children">
+   
+    
+   
+    
+      <strong class="classes">Classes:</strong> <span class='object_link'><a href="Zabby/AuthenticationError.html" title="Zabby::AuthenticationError (class)">AuthenticationError</a></span>, <span class='object_link'><a href="Zabby/Config.html" title="Zabby::Config (class)">Config</a></span>, <span class='object_link'><a href="Zabby/ConfigurationError.html" title="Zabby::ConfigurationError (class)">ConfigurationError</a></span>, <span class='object_link'><a href="Zabby/Connection.html" title="Zabby::Connection (class)">Connection</a></span>, <span class='object_link'><a href="Zabby/ResponseCodeError.html" title="Zabby::ResponseCodeError (class)">ResponseCodeError</a></span>, <span class='object_link'><a href="Zabby/Runner.html" title="Zabby::Runner (class)">Runner</a></span>
+    
+  
+</p>
+
+  <h2>Constant Summary</h2>
+  
+    <dl class="constants">
+      
+        <dt id="VERSION-constant" class="">VERSION =
+          
+        </dt>
+        <dd><pre class="code"><span class='string val'>&quot;0.0.1&quot;</span>
+</pre></dd>
+      
+    </dl>
+  
+
+
+
+
+
+  
+    <h2>
+      Class Method Summary
+      <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
+    </h2>
+
+    <ul class="summary">
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#init-class_method" title="init (class method)">+ (Object) <strong>init</strong>(&amp;block) </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'></div></span>
+  
+</li>
+
+      
+    </ul>
+  
+
+
+
+  <div id="class_method_details" class="method_details_list">
+    <h2>Class Method Details</h2>
+    
+    
+      <div class="method_details first">
+  <p class="signature first" id="init-class_method">
+  
+    + (<tt>Object</tt>) <strong>init</strong>(&amp;block) 
+  
+
+  
+</p><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+20
+21
+22</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/zabby.rb', line 20</span>
+
+<span class='rubyid_def def kw'>def</span> <span class='rubyid_self self kw'>self</span><span class='dot token'>.</span><span class='rubyid_init identifier id'>init</span> <span class='bitand op'>&amp;</span><span class='rubyid_block identifier id'>block</span>
+  <span class='rubyid_Zabby constant id'>Zabby</span><span class='colon2 op'>::</span><span class='rubyid_Runner constant id'>Runner</span><span class='dot token'>.</span><span class='rubyid_new identifier id'>new</span> <span class='bitand op'>&amp;</span><span class='rubyid_block identifier id'>block</span>
+<span class='rubyid_end end kw'>end</span>
+</pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+  </div>
+
+</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>