zabby 0.0.4 → 0.0.5

data/.gitignore

@@ -3,4 +3,5 @@
 Gemfile.lock
 pkg/*
 .idea
-.yardoc
+.yardoc
+/doc

data/.yardopts

@@ -0,0 +1 @@
+lib/**/*.rb - LICENSE TODO.rdoc ChangeLog.rdoc

data/ChangeLog.rdoc

@@ -1,5 +1,16 @@
 = ChangeLog for Zabby
 
+List of visible changes:
+
+== v0.0.5 (2012/01/05)
+
+* Better command file parsing and add rcfile support.
+* Better handling of the default JSON RPC script name in the URL.
+* Add a 'loggedin?' alias for 'logged_in?'.
+* Ignore 'doc' directory.
+* List of docs to generate with Yard is now specified in .yardopts.
+* Improve Gemspec file.
+
 == v0.0.4 (2011/12/21)
 
 * Same as v0.0.3 that I could not publish on rubygems.org

data/README.rdoc

@@ -25,6 +25,41 @@ Zabby has the following caracteristics:
 - Full featured IRB like shell included with Readline support. You can mix Zabbix instructions
   with Ruby calls transparently.
 
+== Configuration
+
+The file <tt>~/.zabbyrc</tt> is read on startup unless the option "<tt>--no-rcfile</tt>" is
+used.
+
+=== Command line
+
+  --[no-]rcfile [CONFIG FILE]:  Configuration file to load on startup. Default is '~/.zabbyrc'. With the 'no' prefix no configuration file will be loaded.
+  -f, --extra-file COMMAND_FILE:    Execute the instructions in COMMAND_FILE
+
+=== Zabby configuration
+
+The following settings can be configured with the '+set+' command:
+[server]  Zabbix webservice URL. If the URL does not end with <tt>.php</tt> then
+          <tt>/api_jsonrpc.php</tt> is appended automatically.
+[user]    User login with +API+ rights on the Zabbix Server. If the account does not have
+          +API+ access the connection will be refused by Zabbix.
+[password] User password.
+[proxy_host] HTTP proxy.SSL is supported and the certificate validity is not checked. *Optional*
+[proxy_user] User authentication on the proxy. *Optional*
+[proxy_password] User password on the proxy. *Optional*
+
+=== Sample ".zabbyrc"
+
+This is a configuration <tt>.zabbyrc</tt> file example, it will be loaded at startup:
+
+    # Zabby configuration
+    set :server => "https://monitoring.example.com"
+    set :user => "api_user"
+    set :password => "s3cr3t"
+    set :proxy_host => "http://10.10.10.10"
+    set :proxy_user => "john"
+    set :proxy_password => "D0e"
+    login
+
 == Examples
 
 === API use

data/Rakefile

@@ -3,7 +3,8 @@ require 'yard'
 Bundler::GemHelper.install_tasks
 
 YARD::Rake::YardocTask.new do |t|
-  t.files   = ['lib/**/*.rb', '-', 'LICENSE', 'TODO.rdoc', 'ChangeLog.rdoc']
+  # File list is defined in '.yardopts'
+  #t.files   = ['lib/**/*.rb', '-', 'LICENSE', 'TODO.rdoc', 'ChangeLog.rdoc']
   #t.options = ['--any', '--extra', '--opts'] # optional
 end
 

data/bin/zabbysh

@@ -9,21 +9,32 @@ ZABBY_ROOT = File.expand_path('../../lib', __FILE__)
 $: << ZABBY_ROOT unless $:.include?(ZABBY_ROOT)
 
 require 'zabby'
-require "optparse"
+require 'optparse'
 require 'ostruct'
 
 options = OpenStruct.new
-options.file = nil
+options.rcfile = File.expand_path('~/.zabbyrc')
+options.extra_file = nil
 
 opts = OptionParser.new do |opts|
-  opts.banner = "Usage: zabbysh [options]"
+  opts.banner = <<EOT
+Usage: zabbysh [options] [script]
 
+  If no 'script' file is provided an interactive shell is started. Otherwise the script file
+  is executed. To load and execute a supplementary script file before the shell use the
+  '--extra-file' option.
+EOT
   opts.separator ""
   opts.separator "Specific options:"
 
-  opts.on("-f", "--file COMMAND_FILE",
+  opts.on("--[no-]rcfile [CONFIG FILE]",
+          "Configuration file to load on startup. Default is '~/.zabbyrc'." +
+              " With the 'no' prefix no configuration file will be loaded.") do |file|
+    options.rcfile = file || nil
+  end
+  opts.on("-f", "--extra-file COMMAND_FILE",
                 "Execute the instructions in COMMAND_FILE") do |file|
-          options.file = file
+          options.extra_file = file
   end
 
   opts.separator ""
@@ -45,24 +56,43 @@ EOT
   end
 end
 
-opts.parse!(ARGV)
-
+# Parse options, extract script to execute and initialize Zabby.
+begin
+  opts.parse!(ARGV)
+rescue OptionParser::ParseError => e
+  STDERR.puts("ERROR: #{e.message}.")
+  STDERR.puts opts
+  exit 1
+end
+script = ARGV.first
 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)}"
+# Read & execute startup file and/or command file. The true/false indicates if
+# we should fail in case the file does not exist.
+[ [ options.rcfile, false ], [ options.extra_file, true ], [ script, true ] ].each do |file, fail_on_missing|
+  if file.nil?
+    # Do nothing
+  elsif File.exist?(file)
+    begin
+      z.run(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
-    exit 1
+  elsif fail_on_missing # File is missing but do not fail for '.zabbyrc'
+    raise RuntimeError, "Missing Zabby script '#{file}'."
   end
 end
 
-# We end up here even if a command file is provided if it doesn't end with "exit"
-z.shell
+
+# We start the shell if a command file is not provided
+if script.nil?
+  z.shell
+end
+
 exit 0

data/lib/zabby/connection.rb

@@ -5,6 +5,9 @@
 
 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
@@ -30,7 +33,7 @@ module Zabby
         @proxy_user = config.proxy_user
         @proxy_password = config.proxy_password
       end
-      @request_path = @uri.path.empty? ? "/api_jsonrpc.php" : @uri.path
+      @request_path = @uri.path[-4,4] == '.php' ? @uri.path : @uri.path + JSONRPC_SCRIPT
       authenticate
     end
 
@@ -67,6 +70,7 @@ module Zabby
       }
     end
 
+    # Perform an authenticated request
     def perform_request(element, action, params)
       raise AuthenticationError.new("Not logged in") if !logged_in?
 

data/lib/zabby/runner.rb

@@ -117,6 +117,7 @@ module Zabby
     def logged_in?
       @connection.logged_in?
     end
+    alias_method :loggedin?, :logged_in?
 
     def version
       Zabby::VERSION
@@ -127,7 +128,7 @@ module Zabby
     def run(command_file = nil, &block)
       unless command_file.nil?
         commands = File.read(command_file)
-        instance_eval(commands)
+        instance_eval(commands, command_file, 1)
       end
       instance_eval(&block) if block_given?
     end
@@ -174,4 +175,4 @@ module Zabby
       end
     end
   end
-end
+end

data/lib/zabby/version.rb

@@ -4,5 +4,5 @@
 # License:: Simplified BSD License
 
 module Zabby
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

data/zabby.gemspec

@@ -13,10 +13,11 @@ Gem::Specification.new do |s|
   s.authors     = ["Farzad FARID"]
   s.email       = ["ffarid@pragmatic-source.com"]
   s.homepage    = "http://zabby.org/"
-  s.summary     = %q{Ruby Zabbix API and command line interface}
+  s.summary     = %q{Ruby Zabbix API, scripting language and command line interface}
   s.description = %q{Zabby is a Zabby API and CLI. It provides a provisioning tool for
 creating, updating and querying Zabbix objects (hosts, items, triggers, etc.) through the web
 service.}
+  s.license     = "Simplified BSD"
 
   s.rubyforge_project = "zabby"
 
@@ -24,6 +25,7 @@ service.}
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
+  s.extra_rdoc_files = [ "TODO.rdoc", "ChangeLog.rdoc" ]
   s.add_runtime_dependency "json"
   s.add_development_dependency "bundler", ">= 1.0.0"
   s.add_development_dependency "rspec", ">= 2.0.0"

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: zabby
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 21
   prerelease: 
   segments: 
   - 0
   - 0
-  - 4
-  version: 0.0.4
+  - 5
+  version: 0.0.5
 platform: ruby
 authors: 
 - Farzad FARID
@@ -15,8 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-12-21 00:00:00 +01:00
-default_executable: 
+date: 2012-01-05 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: json
@@ -91,10 +90,12 @@ executables:
 - zabbysh
 extensions: []
 
-extra_rdoc_files: []
-
+extra_rdoc_files: 
+- TODO.rdoc
+- ChangeLog.rdoc
 files: 
 - .gitignore
+- .yardopts
 - ChangeLog.rdoc
 - Gemfile
 - LICENSE
@@ -103,31 +104,6 @@ files:
 - TODO.rdoc
 - bin/zabbyrb
 - bin/zabbysh
-- doc/Zabby.html
-- doc/Zabby/AuthenticationError.html
-- doc/Zabby/Config.html
-- doc/Zabby/ConfigurationError.html
-- doc/Zabby/Connection.html
-- doc/Zabby/ResponseCodeError.html
-- doc/Zabby/Runner.html
-- doc/Zabby/ZObject.html
-- doc/_index.html
-- doc/class_list.html
-- doc/css/common.css
-- doc/css/full_list.css
-- doc/css/style.css
-- doc/file.ChangeLog.html
-- doc/file.LICENSE.html
-- doc/file.README.html
-- doc/file.TODO.html
-- doc/file_list.html
-- doc/frames.html
-- doc/index.html
-- doc/js/app.js
-- doc/js/full_list.js
-- doc/js/jquery.js
-- doc/method_list.html
-- doc/top-level-namespace.html
 - lib/zabby.rb
 - lib/zabby/config.rb
 - lib/zabby/connection.rb
@@ -137,10 +113,9 @@ files:
 - lib/zabby/zobject.rb
 - spec/spec_helper.rb
 - zabby.gemspec
-has_rdoc: true
 homepage: http://zabby.org/
-licenses: []
-
+licenses: 
+- Simplified BSD
 post_install_message: 
 rdoc_options: []
 
@@ -167,9 +142,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: zabby
-rubygems_version: 1.4.2
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
-summary: Ruby Zabbix API and command line interface
+summary: Ruby Zabbix API, scripting language and command line interface
 test_files: 
 - spec/spec_helper.rb
+has_rdoc: 

data/doc/Zabby.html

@@ -1,208 +0,0 @@
-<!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/zobject.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>, <span class='object_link'><a href="Zabby/ZObject.html" title="Zabby::ZObject (class)">ZObject</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.4&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">
-
-
-22
-23
-24</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/zabby.rb', line 22</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_instance identifier id'>instance</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 Wed Dec 21 12:25:12 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>