zabby 0.1.1 → 0.1.2

data/ChangeLog.rdoc

@@ -2,6 +2,14 @@
 
 List of visible changes:
 
+== v0.1.2 (2012/03/27)
+
+* Older Zabbix 1.8.x used "user.authenticate" instead of "user.login", we must try both methods.
+* Improve command line parsing. It is now easier to pass parameters to a "zabbysh" script withtout
+  having to prepend "--".
+* Make some methods private.
+* Internal: add an primary key to Zabby classes (not used yet).
+
 == v0.1.1 (2012/03/14)
 
 * Initialization code (the argument given to "Zabby.init") was not executed.

data/README.rdoc

@@ -159,6 +159,8 @@ Now to execute the script you just have to type:
 
     # ./my_zabbix_commands.zby
 
+Zabbysh script can have their own command line parameters (with libs like 'optparse').
+
 === API use
 
 The barebone API can be used in Ruby like this:
@@ -171,6 +173,7 @@ The barebone API can be used in Ruby like this:
       set :server => "https://monitoring.example.com"
       set :user => "api_user"
       set :password => "s3cr3t"
+      # The proxy settings are of coure optional
       set :proxy_host => "http://10.10.10.10"
       set :proxy_user => "john"
       set :proxy_password => "D0e"
@@ -222,6 +225,7 @@ Farzad FARID mailto:ffarid@pragmatic-source.com
 - Nicolas Blanco (slainer68): Advices on code design and Triple Facepalming after reading other Ruby/Zabbix code.
 - Renaud Chaput (renchap): For suggesting the "zabby" name.
 - Folks on the irc channel #rubyonrails.fr@Freenode
+- Beta testers: A-Kaser, gaetronik.
 
 === Sources of inspiration
 

data/bin/zabbysh

@@ -17,30 +17,33 @@ options.rcfile = File.expand_path('~/.zabbyrc')
 options.extra_file = nil
 
 opts = OptionParser.new do |opts|
-  opts.banner = <<EOT
-Usage: zabbysh [options] [script]
+  opts.banner = <<'EOT'
+Usage: zabbysh [zabbysh options] [script [script options]]
 
-  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.
+  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.
+
+  HOW TO PASS ARGUMENTS TO THE SCRIPT
+  -----------------------------------
+
+  The Zabbysh script can have its own command line arguments. Just prepend
+  '--' before the arguments to separate them from Zabbysh's own arguments.
 EOT
   opts.separator ""
-  opts.separator "Specific options:"
+  opts.separator "Zabbysh specific options:"
 
   opts.on("--[no-]rcfile [CONFIG FILE]",
-          "Configuration file to load on startup. Default is '~/.zabbyrc'." +
+          "Configuration file to load on startup.\n\tDefault 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|
+  opts.on("-f", "--extra-file CMD_FILE",
+                "Execute the instructions in CMD_FILE") do |file|
           options.extra_file = file
   end
 
-  opts.separator ""
-  opts.separator "Common options:"
-
-
   opts.on_tail("-h", "--help", "Show this message") do
     puts opts
     exit
@@ -57,15 +60,22 @@ EOT
   end
 end
 
-# Parse options, extract script to execute and initialize Zabby.
+# Parse options, extract optional script to execute and initialize Zabby.
+# Do not reorder commandline argument otherwise zabbysh's arguments will
+# get mixed up with the script's argument.
 begin
+  ENV['POSIXLY_CORRECT'] = '1'
   opts.parse!(ARGV)
 rescue OptionParser::ParseError => e
   STDERR.puts("ERROR: #{e.message}.")
   STDERR.puts opts
   exit 1
+ensure
+  ENV['POSIXLY_CORRECT'] = nil
 end
-script = ARGV.first
+
+# Now ARGV only contains the script's optional arguments.
+script = ARGV.shift
 z = Zabby.init
 
 # Read & execute startup file and/or command file. The true/false indicates if

data/lib/zabby/connection.rb

@@ -55,6 +55,12 @@ module Zabby
                                     '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

data/lib/zabby/shell_helpers.rb

@@ -35,7 +35,7 @@ module Zabby
     end
 
     # Show the Shell helpers documentation
-    def self.show_helpers_doc
+    def self.helpers_doc
       help = <<EOT
 Available commands:
 ==================
@@ -96,7 +96,7 @@ The parameters 'server', 'user' and 'password' must be defined.}
 
     desc 'Show this help text.'
     def help
-      puts Zabby::ShellHelpers.show_helpers_doc
+      puts Zabby::ShellHelpers.helpers_doc
     end
   end
 end

data/lib/zabby/version.rb

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

data/lib/zabby/zclass.rb

@@ -24,13 +24,31 @@ module Zabby
     module ClassMethods
       # List of valid Web Service methods for the current Zabbix Object
       attr_reader :zmethods
+      # The id field name for the model ("actionid", "hostid", etc.)
+      attr_reader :id
 
       # Name of the current class without the namespace
       # @return [String]
       # @example
-      #   Zabby::Host.object_name => "host"
-      def object_name
-        @object_name ||= self.name.gsub(/^.*::/, '').downcase
+      #   Zabby::Host.object_name => "Host"
+      def class_name
+        @class_name ||= self.name.split(/::/).last.downcase
+      end
+
+      # Human representation of the Zabbix Class
+      # @return [String] Class representation
+      # @example
+      #   Host.inspect => "<Zabby::Host methods=(create, delete, exists, get, update)>"
+      def inspect
+        "<#{name} methods=(#{@zmethods.join(', ')})>"
+      end
+
+      private
+
+      # Set the name of the primary key
+      # @param key [String] Primary key name
+      def primary_key(key)
+        @id = key.to_sym
       end
 
       # Add the list of Web Service methods to the current class.
@@ -52,19 +70,11 @@ module Zabby
       # @raise [NoMethodError] Raised on invalid method names.
       def method_missing(zmethod, *args, &block)
         if @zmethods.include? zmethod
-          Zabby::Runner.instance.connection.perform_request(object_name, zmethod, args.first)
+          Zabby::Runner.instance.connection.perform_request(class_name, zmethod, args.first)
         else
           super
         end
       end
-
-      # Human representation of the Zabbix Class
-      # @return [String] Class representation
-      # @example
-      #   Host.inspect => "<Zabbix Object 'host', methods: create, delete, exists, get, update>"
-      def inspect
-        "<Zabbix Object '#{object_name}', methods: #{@zmethods.join(', ')}>"
-      end
     end
   end
 
@@ -72,11 +82,13 @@ module Zabby
 
   class Action
     include ZClass
+    primary_key :actionid
     add_zmethods :create, :delete, :exists, :get, :update
   end
 
   class Alert
     include ZClass
+    primary_key :alertid
     add_zmethods :create, :delete, :get
   end
 
@@ -87,106 +99,127 @@ module Zabby
 
   class Application
     include ZClass
+    primary_key :applicationid
     add_zmethods :create, :delete, :exists, :get, :massAdd, :update
   end
 
   class Event
     include ZClass
+    primary_key :eventid
     add_zmethods :acknowledge, :create, :delete, :get
   end
 
   class Graph
     include ZClass
+    primary_key :graphid
     add_zmethods :create, :delete, :exists, :get, :update
   end
 
   class Graphitem
     include ZClass
+    primary_key :gitemid
     add_zmethods :get
   end
 
   class History
     include ZClass
+    primary_key :id # TODO Verify. The online documentation is not clear.
     add_zmethods :delete, :get
   end
 
   class Host
     include ZClass
+    primary_key :hostid
     add_zmethods :create, :delete, :exists, :get, :update
   end
 
   class Hostgroup
     include ZClass
+    primary_key :groupid
     add_zmethods :create, :delete, :exists, :get, :massAdd, :massRemove, :massUpdate, :update
   end
 
   class Image
     include ZClass
+    primary_key :imageid
     add_zmethods :create, :delete, :exists, :get, :update
   end
 
   class Item
     include ZClass
+    primary_key :itemid
     add_zmethods :create, :delete, :exists, :get, :update
   end
 
   class Maintenance
     include ZClass
+    primary_key :maintenanceid
     add_zmethods :create, :delete, :exists, :get, :update
   end
 
   class Map
     include ZClass
+    primary_key :sysmapid
     add_zmethods :create, :delete, :exists, :get, :update
   end
 
   class Mediatype
     include ZClass
+    primary_key :mediatypeid
     add_zmethods :create, :delete, :get, :update
   end
 
   class Proxy
     include ZClass
+    primary_key :proxyid
     add_zmethods :get
   end
 
   class Screen
     include ZClass
+    primary_key :screenid
     add_zmethods :create, :delete, :get, :update
   end
 
   class Script
     include ZClass
+    primary_key :scriptid
     add_zmethods :create, :delete, :execute, :get, :update
   end
 
   class Template
     include ZClass
+    primary_key :templateid
     add_zmethods :create, :delete, :exists, :get, :massAdd, :massRemove, :massUpdate, :update
   end
 
   class Trigger
     include ZClass
+    primary_key :triggerid
     add_zmethods :addDependencies, :create, :delete, :deleteDependencies, :exists, :get, :update
   end
 
   class User
     include ZClass
+    primary_key :userid
     add_zmethods :addMedia, :authenticate, :create, :delete, :deleteMedia, :get, :login, :logout, :update, :updateMedia, :updateProfile
   end
 
   class Usergroup
     include ZClass
+    primary_key :usrgrpid
     add_zmethods :create, :delete, :exists, :get, :massAdd, :massRemove, :massUpdate, :update
   end
 
   class Usermacro
     include ZClass
+    primary_key :hostmacroid
     add_zmethods :createGlobal, :deleteGlobal, :deleteHostMacro, :get, :massAdd, :massRemove, :massUpdate, :updateGlobal
   end
 
   class Usermedia
     include ZClass
+    primary_key :mediatypeid
     add_zmethods :get
   end
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: zabby
 version: !ruby/object:Gem::Version 
-  hash: 25
+  hash: 31
   prerelease: 
   segments: 
   - 0
   - 1
-  - 1
-  version: 0.1.1
+  - 2
+  version: 0.1.2
 platform: ruby
 authors: 
 - Farzad FARID
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-03-14 00:00:00 Z
+date: 2012-03-27 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: json