zbx 1.0 → 1.1.1

data/bin/zbx

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require 'zbx'
+require 'zbx/cli'
+ZBX::CLI::CLI.start

data/lib/zbx.rb

@@ -7,4 +7,7 @@ require 'json'
 require 'net/http'
 
 module ZBX
+  def self.client user, password, api_url, &block
+    API.new user, password, api_url, &block
+  end
 end

data/lib/zbx/api.rb

@@ -4,24 +4,24 @@ module ZBX
     # if block is given, it will be evaluated in the object
     # that is to say, you can write something like this.
     #
-    # ZBX::API.new(user, pass, api_url) do
+    # ZBX::API.new(user, password, api_url) do
     #   host.get(hostids: 1)
     # end
     #
     # -- this is equal to the following --
     #
-    # ZBX::API.new(user, pass, api_url).host.get(hostids: 1)
+    # ZBX::API.new(user, password, api_url).host.get(hostids: 1)
 
-    def initialize user=nil, pass=nil, url=nil, &b
+    def initialize user=nil, password=nil, api_url=nil, &b
       @auth = nil
-      @user, @pass, @http = user, pass, HttpClient.new url
+      @user, @password, @http = user, password, HttpClient.new(api_url)
 
       instance_eval(&b) if block_given?
     end
 
     def set option={}
-      @user, @auth = option[:username], nil if option[:username]
-      @pass, @auth = option[:password], nil if option[:password]
+      @user, @auth = option[:user], nil if option[:user]
+      @password, @auth = option[:password], nil if option[:password]
       @http.api_url = option[:api_url] if option[:api_url]
     end
 
@@ -34,22 +34,17 @@ module ZBX
       # - jsonrpc         = '2.0'
       # - auth            = an authentication token
 
-      params[:output] ||= "extend"
-      @http.request(method: method,
-                    params: params,
-                    auth: auth!,
-                    id: _id,
-                    jsonrpc: '2.0')
+      params[:output] = "extend" unless params[:output] or params["output"]
+      opts = {method: method,
+              params: params,
+              id: _id,
+              jsonrpc: '2.0'}
+      opts[:auth] = auth! unless method == 'user.login'
+      @http.request opts
     end
 
     def auth!
-      @auth ||= @http.request(method: "user.login",
-                              params: {user: @user, password: @pass},
-                              id: _id,
-                              jsonrpc: '2.0')
-
-      # if login failed, we raise an auth error !
-      @auth or raise "Authentication failed"
+      @auth ||= user.login user: @user, password: @password
     end
 
     def method_missing m, &b

data/lib/zbx/cli.rb

@@ -0,0 +1,84 @@
+require 'yaml'
+require 'thor'
+
+module ZBX
+  module CLI
+    module Helper
+      extend self
+      def browse link
+        case RbConfig::CONFIG['host_os']
+        when /mswin|mingw|cygwin/
+          system "start #{link}"
+        when /darwin/
+          system "open #{link}"
+        when /linux|bsd/
+          system "xdg-open #{link}"
+        end
+      end
+    end
+
+    class CLI < Thor
+      map "-s" => :send
+      map "-d" => :doc
+
+      # ---------------------------- send ------------------------------
+
+      desc "send [method] [data]", "Send api request to zabbix server, -s is its short term"
+      long_desc <<-LLL
+      Example:
+      \x5> $ zbx send host.get '{"hostids": 321}'
+
+      > $ zbx -s host.get '{"hostids": 321}'
+
+      # specify user name and password
+      \x5> $ zbx -s host.get '{"hostids": 321}' -u me -p mypassword
+      LLL
+
+      method_option :user, type: :string, aliases: '-u', desc: "zabbix username, default defined in ~/.zbxconfig"
+      method_option :password, type: :string, aliases: '-p', desc: "zabbix password, default defined in ~/.zbxconfig"
+      method_option :api_url, type: :string, aliases: '-l',  desc: "zabbix api url, default defined in ~/.zbxconfig"
+
+      def send(method, data='{}')
+        config_file = File.expand_path('~/.zbxconfig')
+        default = File.exists?(config_file) ? YAML.load_file(config_file) : {}
+        client = ZBX::API.new(options[:user] || default["user"],
+                              options[:password] || default["password"],
+                              options[:api_url] || default["api_url"])
+        # x = method.split('.')
+        say client.request method, JSON.parse(data)
+        # say client.send(x.first).send(x.last, JSON.parse(data))
+      end
+
+
+      # ---------------------------- doc ------------------------------
+
+      desc "doc [method-name or entity-name]", "Open the api doc in browser, -d its short term"
+      long_desc <<-LLL
+      Example:
+      \x5> $ zbx doc host.get
+
+      > $ zbx -d host
+
+      > $ zbx doc hostgroup -v 1.8
+      LLL
+      method_option :version, default: 2.0, aliases: "-v", type: :numeric, desc: "api version"
+
+      def doc method=''
+        version = options[:version]
+        base = "https://www.zabbix.com/documentation/#{version}/"
+        suffix = case version
+                 when 1.8
+                   'api/'
+                 when 2.0
+                   'manual/appendix/api/'
+                 when 2.2
+                   'manual/api/reference/'
+                 end
+        url = base << suffix << method.gsub('.', '/')
+        say "browse #{url}"
+        Helper.browse url
+      end
+    end
+
+  end
+end

data/lib/zbx/http_client.rb

@@ -12,9 +12,18 @@ module ZBX
       req = Net::HTTP::Post.new uri.request_uri
       req.add_field('Content-Type', 'application/json-rpc')
       req.body = options.to_json
-      JSON.parse(http.request(req).body)['result']
-    rescue
-      nil
+      res = http.request(req)
+
+      begin
+        parsed = JSON.parse(res.body)
+      rescue
+        raise "Zabbix API Request Error: \n HTTP Response : #{res.inspect} \n #{res.body}"
+      end
+
+      if parsed["error"] or parsed["result"].nil?
+        raise "Zabbix API Request Message(Bad request) : #{parsed}"
+      end
+      parsed['result']
     end
 
     def http
@@ -33,10 +42,6 @@ module ZBX
 
     def api_url= url
       @api_url, @uri, @http = url, nil, nil
-      self
     end
   end
 end
-
-
-

data/lib/zbx/version.rb

@@ -1,3 +1,3 @@
 module ZBX
-  VERSION = "1.0"
+  VERSION = "1.1.1"
 end

data/spec/auth_spec.rb

@@ -1,15 +1,17 @@
 require 'spec_helper'
 
 describe ZBX::API do
-  api_url = 'http://localhost/api_jsonrpc.php'
+  info = YAML.load_file(File.expand_path('~/.zbxconfig'))
+  user, password, api_url = info["user"], info["password"], info["api_url"]
+
   before(:each) do
     @invalid_client = ZBX::API.new "fakeusername", "fakepassword", api_url
-    @valid_client = ZBX::API.new "wenjun.yan", "123456", api_url
+    @valid_client = ZBX::API.new user, password, api_url
   end
 
   describe "invalid client authentication" do
     it "should raise a runtime error!" do
-      expect { @invalid_client.auth! }.to raise_error(RuntimeError, /Authentication/)
+      expect { @invalid_client.auth! }.to raise_error(RuntimeError, /Login name or password/)
     end
   end
 

data/spec/functional_spec.rb

@@ -1,10 +1,11 @@
 require 'spec_helper'
 
 describe ZBX::API do
-  api_url = 'http://localhost/api_jsonrpc.php'
+  info = YAML.load_file(File.expand_path('~/.zbxconfig'))
+  user, password, api_url = info["user"], info["password"], info["api_url"]
 
   before(:each) do
-    @client = ZBX::API.new "wenjun.yan", "123456", api_url
+    @client = ZBX::API.new user, password, api_url
   end
 
   describe "Using host.get to check if api request works " do

data/spec/spec_helper.rb

@@ -1,5 +1,6 @@
 require 'bundler/setup'
 require 'zbx'
+require 'yaml'
 
 RSpec.configure do |config|
 end

data/zbx.gemspec

@@ -18,6 +18,8 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
+  spec.add_dependency 'thor'
+
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zbx
 version: !ruby/object:Gem::Version
-  version: '1.0'
+  version: 1.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,8 +9,24 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-23 00:00:00.000000000 Z
+date: 2013-08-26 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -62,7 +78,8 @@ dependencies:
 description: yet another zabbix api wrapper and a dsl
 email:
 - mylastnameisyan@gmail.com
-executables: []
+executables:
+- zbx
 extensions: []
 extra_rdoc_files: []
 files:
@@ -71,8 +88,10 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- bin/zbx
 - lib/zbx.rb
 - lib/zbx/api.rb
+- lib/zbx/cli.rb
 - lib/zbx/entity.rb
 - lib/zbx/http_client.rb
 - lib/zbx/version.rb