zabby 0.0.2 → 0.0.4

data/doc/method_list.html

@@ -73,65 +73,65 @@
   
 
   <li class="r1 ">
-    <span class='object_link'><a href="Zabby/Connection.html#format_message-instance_method" title="Zabby::Connection#format_message (method)">#format_message</a></span>
+    <span class='object_link'><a href="Zabby/Runner.html#create_zobject-class_method" title="Zabby::Runner.create_zobject (method)">create_zobject</a></span>
     
-      <small>Zabby::Connection</small>
+      <small>Zabby::Runner</small>
     
   </li>
   
 
   <li class="r2 ">
-    <span class='object_link'><a href="Zabby/Runner.html#get-instance_method" title="Zabby::Runner#get (method)">#get</a></span>
+    <span class='object_link'><a href="Zabby/Connection.html#format_message-instance_method" title="Zabby::Connection#format_message (method)">#format_message</a></span>
     
-      <small>Zabby::Runner</small>
+      <small>Zabby::Connection</small>
     
   </li>
   
 
   <li class="r1 ">
-    <span class='object_link'><a href="Zabby/Runner.html#host-instance_method" title="Zabby::Runner#host (method)">#host</a></span>
+    <span class='object_link'><a href="Zabby/Connection.html#http-instance_method" title="Zabby::Connection#http (method)">#http</a></span>
     
-      <small>Zabby::Runner</small>
+      <small>Zabby::Connection</small>
     
   </li>
   
 
   <li class="r2 ">
-    <span class='object_link'><a href="Zabby/Connection.html#http-instance_method" title="Zabby::Connection#http (method)">#http</a></span>
+    <span class='object_link'><a href="Zabby.html#init-class_method" title="Zabby.init (method)">init</a></span>
     
-      <small>Zabby::Connection</small>
+      <small>Zabby</small>
     
   </li>
   
 
   <li class="r1 ">
-    <span class='object_link'><a href="Zabby.html#init-class_method" title="Zabby.init (method)">init</a></span>
+    <span class='object_link'><a href="Zabby/Config.html#initialize-instance_method" title="Zabby::Config#initialize (method)">#initialize</a></span>
     
-      <small>Zabby</small>
+      <small>Zabby::Config</small>
     
   </li>
   
 
   <li class="r2 ">
-    <span class='object_link'><a href="Zabby/Connection.html#initialize-instance_method" title="Zabby::Connection#initialize (method)">#initialize</a></span>
+    <span class='object_link'><a href="Zabby/Runner.html#initialize-instance_method" title="Zabby::Runner#initialize (method)">#initialize</a></span>
     
-      <small>Zabby::Connection</small>
+      <small>Zabby::Runner</small>
     
   </li>
   
 
   <li class="r1 ">
-    <span class='object_link'><a href="Zabby/Runner.html#initialize-instance_method" title="Zabby::Runner#initialize (method)">#initialize</a></span>
+    <span class='object_link'><a href="Zabby/Connection.html#initialize-instance_method" title="Zabby::Connection#initialize (method)">#initialize</a></span>
     
-      <small>Zabby::Runner</small>
+      <small>Zabby::Connection</small>
     
   </li>
   
 
   <li class="r2 ">
-    <span class='object_link'><a href="Zabby/Config.html#initialize-instance_method" title="Zabby::Config#initialize (method)">#initialize</a></span>
+    <span class='object_link'><a href="Zabby/ZObject.html#initialize-instance_method" title="Zabby::ZObject#initialize (method)">#initialize</a></span>
     
-      <small>Zabby::Config</small>
+      <small>Zabby::ZObject</small>
     
   </li>
   
@@ -145,49 +145,49 @@
   
 
   <li class="r2 ">
-    <span class='object_link'><a href="Zabby/Runner.html#logged_in%3F-instance_method" title="Zabby::Runner#logged_in? (method)">#logged_in?</a></span>
+    <span class='object_link'><a href="Zabby/Connection.html#logged_in%3F-instance_method" title="Zabby::Connection#logged_in? (method)">#logged_in?</a></span>
     
-      <small>Zabby::Runner</small>
+      <small>Zabby::Connection</small>
     
   </li>
   
 
   <li class="r1 ">
-    <span class='object_link'><a href="Zabby/Connection.html#logged_in%3F-instance_method" title="Zabby::Connection#logged_in? (method)">#logged_in?</a></span>
+    <span class='object_link'><a href="Zabby/Runner.html#logged_in%3F-instance_method" title="Zabby::Runner#logged_in? (method)">#logged_in?</a></span>
     
-      <small>Zabby::Connection</small>
+      <small>Zabby::Runner</small>
     
   </li>
   
 
   <li class="r2 ">
-    <span class='object_link'><a href="Zabby/Connection.html#login-instance_method" title="Zabby::Connection#login (method)">#login</a></span>
+    <span class='object_link'><a href="Zabby/Runner.html#login-instance_method" title="Zabby::Runner#login (method)">#login</a></span>
     
-      <small>Zabby::Connection</small>
+      <small>Zabby::Runner</small>
     
   </li>
   
 
   <li class="r1 ">
-    <span class='object_link'><a href="Zabby/Runner.html#login-instance_method" title="Zabby::Runner#login (method)">#login</a></span>
+    <span class='object_link'><a href="Zabby/Connection.html#login-instance_method" title="Zabby::Connection#login (method)">#login</a></span>
     
-      <small>Zabby::Runner</small>
+      <small>Zabby::Connection</small>
     
   </li>
   
 
   <li class="r2 ">
-    <span class='object_link'><a href="Zabby/Connection.html#logout-instance_method" title="Zabby::Connection#logout (method)">#logout</a></span>
+    <span class='object_link'><a href="Zabby/Runner.html#logout-instance_method" title="Zabby::Runner#logout (method)">#logout</a></span>
     
-      <small>Zabby::Connection</small>
+      <small>Zabby::Runner</small>
     
   </li>
   
 
   <li class="r1 ">
-    <span class='object_link'><a href="Zabby/Runner.html#logout-instance_method" title="Zabby::Runner#logout (method)">#logout</a></span>
+    <span class='object_link'><a href="Zabby/Connection.html#logout-instance_method" title="Zabby::Connection#logout (method)">#logout</a></span>
     
-      <small>Zabby::Runner</small>
+      <small>Zabby::Connection</small>
     
   </li>
   
@@ -201,6 +201,14 @@
   
 
   <li class="r1 ">
+    <span class='object_link'><a href="Zabby/ZObject.html#method_missing-instance_method" title="Zabby::ZObject#method_missing (method)">#method_missing</a></span>
+    
+      <small>Zabby::ZObject</small>
+    
+  </li>
+  
+
+  <li class="r2 ">
     <span class='object_link'><a href="Zabby/Connection.html#next_request_id-instance_method" title="Zabby::Connection#next_request_id (method)">#next_request_id</a></span>
     
       <small>Zabby::Connection</small>
@@ -208,7 +216,7 @@
   </li>
   
 
-  <li class="r2 ">
+  <li class="r1 ">
     <span class='object_link'><a href="Zabby/Connection.html#password-instance_method" title="Zabby::Connection#password (method)">#password</a></span>
     
       <small>Zabby::Connection</small>
@@ -216,7 +224,7 @@
   </li>
   
 
-  <li class="r1 ">
+  <li class="r2 ">
     <span class='object_link'><a href="Zabby/Connection.html#perform_request-instance_method" title="Zabby::Connection#perform_request (method)">#perform_request</a></span>
     
       <small>Zabby::Connection</small>
@@ -224,7 +232,7 @@
   </li>
   
 
-  <li class="r2 ">
+  <li class="r1 ">
     <span class='object_link'><a href="Zabby/Connection.html#proxy_host-instance_method" title="Zabby::Connection#proxy_host (method)">#proxy_host</a></span>
     
       <small>Zabby::Connection</small>
@@ -232,7 +240,7 @@
   </li>
   
 
-  <li class="r1 ">
+  <li class="r2 ">
     <span class='object_link'><a href="Zabby/Connection.html#proxy_password-instance_method" title="Zabby::Connection#proxy_password (method)">#proxy_password</a></span>
     
       <small>Zabby::Connection</small>
@@ -240,7 +248,7 @@
   </li>
   
 
-  <li class="r2 ">
+  <li class="r1 ">
     <span class='object_link'><a href="Zabby/Connection.html#proxy_user-instance_method" title="Zabby::Connection#proxy_user (method)">#proxy_user</a></span>
     
       <small>Zabby::Connection</small>
@@ -248,7 +256,7 @@
   </li>
   
 
-  <li class="r1 ">
+  <li class="r2 ">
     <span class='object_link'><a href="Zabby/Connection.html#query_zabbix_rpc-instance_method" title="Zabby::Connection#query_zabbix_rpc (method)">#query_zabbix_rpc</a></span>
     
       <small>Zabby::Connection</small>
@@ -256,7 +264,7 @@
   </li>
   
 
-  <li class="r2 ">
+  <li class="r1 ">
     <span class='object_link'><a href="Zabby/Connection.html#request-instance_method" title="Zabby::Connection#request (method)">#request</a></span>
     
       <small>Zabby::Connection</small>
@@ -264,7 +272,7 @@
   </li>
   
 
-  <li class="r1 ">
+  <li class="r2 ">
     <span class='object_link'><a href="Zabby/Connection.html#request_id-instance_method" title="Zabby::Connection#request_id (method)">#request_id</a></span>
     
       <small>Zabby::Connection</small>
@@ -272,7 +280,7 @@
   </li>
   
 
-  <li class="r2 ">
+  <li class="r1 ">
     <span class='object_link'><a href="Zabby/Connection.html#request_path-instance_method" title="Zabby::Connection#request_path (method)">#request_path</a></span>
     
       <small>Zabby::Connection</small>
@@ -280,7 +288,7 @@
   </li>
   
 
-  <li class="r1 ">
+  <li class="r2 ">
     <span class='object_link'><a href="Zabby/Connection.html#reset-instance_method" title="Zabby::Connection#reset (method)">#reset</a></span>
     
       <small>Zabby::Connection</small>
@@ -288,7 +296,7 @@
   </li>
   
 
-  <li class="r2 ">
+  <li class="r1 ">
     <span class='object_link'><a href="Zabby/Runner.html#run-instance_method" title="Zabby::Runner#run (method)">#run</a></span>
     
       <small>Zabby::Runner</small>
@@ -296,7 +304,7 @@
   </li>
   
 
-  <li class="r1 ">
+  <li class="r2 ">
     <span class='object_link'><a href="Zabby/Runner.html#set-instance_method" title="Zabby::Runner#set (method)">#set</a></span>
     
       <small>Zabby::Runner</small>
@@ -304,7 +312,7 @@
   </li>
   
 
-  <li class="r2 ">
+  <li class="r1 ">
     <span class='object_link'><a href="Zabby/Runner.html#setup-instance_method" title="Zabby::Runner#setup (method)">#setup</a></span>
     
       <small>Zabby::Runner</small>
@@ -312,7 +320,7 @@
   </li>
   
 
-  <li class="r1 ">
+  <li class="r2 ">
     <span class='object_link'><a href="Zabby/Config.html#setup-instance_method" title="Zabby::Config#setup (method)">#setup</a></span>
     
       <small>Zabby::Config</small>
@@ -320,7 +328,7 @@
   </li>
   
 
-  <li class="r2 ">
+  <li class="r1 ">
     <span class='object_link'><a href="Zabby/Runner.html#shell-instance_method" title="Zabby::Runner#shell (method)">#shell</a></span>
     
       <small>Zabby::Runner</small>
@@ -328,7 +336,7 @@
   </li>
   
 
-  <li class="r1 ">
+  <li class="r2 ">
     <span class='object_link'><a href="Zabby/Connection.html#uri-instance_method" title="Zabby::Connection#uri (method)">#uri</a></span>
     
       <small>Zabby::Connection</small>
@@ -336,7 +344,7 @@
   </li>
   
 
-  <li class="r2 ">
+  <li class="r1 ">
     <span class='object_link'><a href="Zabby/Connection.html#user-instance_method" title="Zabby::Connection#user (method)">#user</a></span>
     
       <small>Zabby::Connection</small>
@@ -344,7 +352,7 @@
   </li>
   
 
-  <li class="r1 ">
+  <li class="r2 ">
     <span class='object_link'><a href="Zabby/Runner.html#version-instance_method" title="Zabby::Runner#version (method)">#version</a></span>
     
       <small>Zabby::Runner</small>
@@ -352,6 +360,22 @@
   </li>
   
 
+  <li class="r1 ">
+    <span class='object_link'><a href="Zabby/ZObject.html#zmethods-instance_method" title="Zabby::ZObject#zmethods (method)">#zmethods</a></span>
+    
+      <small>Zabby::ZObject</small>
+    
+  </li>
+  
+
+  <li class="r2 ">
+    <span class='object_link'><a href="Zabby/ZObject.html#zname-instance_method" title="Zabby::ZObject#zname (method)">#zname</a></span>
+    
+      <small>Zabby::ZObject</small>
+    
+  </li>
+  
+
       </ul>
     </div>
   </body>

data/doc/top-level-namespace.html

@@ -94,7 +94,7 @@
 </div>
     
     <div id="footer">
-  Generated on Mon Dec 19 13:31:47 2011 by 
+  Generated on Wed Dec 21 12:25:13 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>

data/lib/zabby/runner.rb

@@ -26,7 +26,7 @@ module Zabby
     # 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..
+      # TODO.rdoc: 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?
@@ -37,15 +37,40 @@ module Zabby
       end
     }
 
+    # Create a method mapping a Zabbix object.
+    # @param [Symbol] name Zabbix Object name (:item, :host, etc.)
+    # @param [Array] zmethods The list of supported verbs
     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 all Zabbix object types and theirs verbs.
+    create_zobject(:action, [ :create, :delete, :exists, :get, :update ])
+    create_zobject(:alert, [ :create, :delete, :get ])
     create_zobject(:apiinfo, [ :version ])
+    create_zobject(:application, [ :create, :delete, :exists, :get, :massAdd, :update ])
+    create_zobject(:event, [ :acknowledge, :create, :delete, :get ])
+    create_zobject(:graph, [ :create, :delete, :exists, :get, :update ])
+    create_zobject(:graphitem, [ :get ])
+    create_zobject(:history, [ :delete, :get ])
+    create_zobject(:host, [ :create, :delete, :exists, :get, :update ])
+    create_zobject(:hostgroup, [ :create, :delete, :exists, :get, :massAdd, :massRemove, :massUpdate, :update ])
+    create_zobject(:image, [ :create, :delete, :exists, :get, :update ])
+    create_zobject(:item, [ :create, :delete, :exists, :get, :update ])
+    create_zobject(:maintenance, [ :create, :delete, :exists, :get, :update ])
+    create_zobject(:map, [ :create, :delete, :exists, :get, :update ])
+    create_zobject(:mediatype, [ :create, :delete, :get, :update ])
+    create_zobject(:proxy, [ :get ])
+    create_zobject(:screen, [ :create, :delete, :get, :update ])
+    create_zobject(:script, [ :create, :delete, :execute, :get, :update ])
+    create_zobject(:template, [ :create, :delete, :exists, :get, :massAdd, :massRemove, :massUpdate, :update ])
+    create_zobject(:trigger, [ :addDependencies, :create, :delete, :deleteDependencies, :exists, :get, :update ])
+    create_zobject(:user, [ :addMedia, :authenticate, :create, :delete, :deleteMedia, :get, :login, :logout, :update, :updateMedia, :updateProfile ])
+    create_zobject(:usergroup, [ :create, :delete, :exists, :get, :massAdd, :massRemove, :massUpdate, :update ])
+    create_zobject(:usermacro, [ :createGlobal, :deleteGlobal, :deleteHostMacro, :get, :massAdd, :massRemove, :massUpdate, :updateGlobal ])
+    create_zobject(:usermedia, [ :get ])
 
     def initialize &block
       @config = Zabby::Config.new &block

data/lib/zabby/version.rb

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

data/lib/zabby/zobject.rb

@@ -8,6 +8,10 @@ module Zabby
   class ZObject
     attr_reader :zname, :zmethods
 
+    # Define the Zabbix object name and associated methods
+    #
+    # @param [String] zname Zabbix Object name
+    # @param [Array] zmethods List of associated methods
     def initialize(zname, zmethods)
       @zname = zname
       @zmethods = zmethods.map { |f| f.to_sym }
@@ -15,7 +19,7 @@ module Zabby
 
     # Simulate methods on the object.
     # For example: "host.get", "item.create"..
-    # @zmethods is the list of valid methods.
+    # The instance variable @zmethods is the list of valid methods.
     def method_missing(zmethod, *args, &block)
       if @zmethods.include? zmethod
         Zabby::Runner.instance.connection.perform_request(@zname, zmethod, args.first)

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: zabby
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 23
   prerelease: 
   segments: 
   - 0
   - 0
-  - 2
-  version: 0.0.2
+  - 4
+  version: 0.0.4
 platform: ruby
 authors: 
 - Farzad FARID
@@ -95,10 +95,12 @@ extra_rdoc_files: []
 
 files: 
 - .gitignore
+- ChangeLog.rdoc
 - Gemfile
 - LICENSE
 - README.rdoc
 - Rakefile
+- TODO.rdoc
 - bin/zabbyrb
 - bin/zabbysh
 - doc/Zabby.html
@@ -108,13 +110,16 @@ files:
 - 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