zabbix-client 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cf8aed8ec273e471d347a2c8c97d8720c7cb6933
-  data.tar.gz: 8fe616fdbadd37b4e5ecffad87625b385bb6d5de
+  metadata.gz: 9d5585021d980030d1b89a8c14c701cd1dd1f84c
+  data.tar.gz: a23f3b6127ee92b0aae5380e247d2b82651618b8
 SHA512:
-  metadata.gz: 7ae12cd805d4f265553b241b27277f7f61eb30b71a5e47980e1512a29d46a0b44c1704cefa782c24e4b8829ada0b6012d09a5f3cbd2f069e369dd4cc87fedc50
-  data.tar.gz: fe4681e21634288d551308dd8b3f3c41ca7f64a4c21fde26d9f3e7c7a98135c7c43d5f582cf46794243141c474d3fd88b1885598be200d5e071e6720987ea637
+  metadata.gz: be8bce17e565303c4aa7139c35f8c8ca013dc4747b14edf5aedd6a2834b651cd6bacb2f2079dc1147660660349fe810385d36211f2f037eb712e21b4c6c7220f
+  data.tar.gz: 036c4bec2b878d72e7823955637d4025a6c4eb83e46f3f4052b97d07d868c5189381314b82c98775770f6443d48b61d1fa4d7219b1ef3b0f1d5219349bb98079

data/README.md

@@ -24,13 +24,46 @@ Or install it yourself as:
 require 'zabbix/client'
 
 client = Zabbix::Client.new('http://localhost/zabbix/api_jsonrpc.php')
+
+# https://www.zabbix.com/documentation/2.0/manual/appendix/api/user/login
 client.user.login(user: 'Admin', password: 'zabbix')
+
+# https://www.zabbix.com/documentation/2.0/manual/appendix/api/apiinfo/version
 p client.apiinfo.version #=> "2.0.12"
-p client.template.getobjects(:host => ['Template OS Linux'])
+
+# https://www.zabbix.com/documentation/2.0/manual/appendix/api/template/getobjects
+p client.template.getobjects(host: ['Template OS Linux'])
 #=> [{"hostid"=>"10001",
-      "proxy_hostid"=>"0",
-      "host"=>"Template OS Linux",
-      ...
+#     "proxy_hostid"=>"0",
+#     "host"=>"Template OS Linux",
+#     ...
+```
+
+### Use proxy
+
+```ruby
+client = Zabbix::Client.new(
+  'http://localhost/zabbix/api_jsonrpc.php',
+  proxy_user: 'username', proxy_password: 'password'
+)
+```
+
+### Basic auth
+
+```ruby
+client = Zabbix::Client.new(
+  'http://localhost/zabbix/api_jsonrpc.php',
+  basic_auth_user: 'username', basic_auth_password: 'password'
+)
+```
+
+### Debug mode
+
+```ruby
+client = Zabbix::Client.new(
+  'http://localhost/zabbix/api_jsonrpc.php',
+  debug: true
+)
 ```
 
 ## Related links

data/lib/zabbix/client/client.rb

@@ -1,12 +1,14 @@
 class Zabbix::Client
-  DEFAULT_HEADERS = {
-    'Content-Type' => 'application/json-rpc'
-  }
-
   class Method
     JSON_RPC_VERSION = '2.0'
     JSON_RPC_REQUEST_ID = 1
+
     LOGIN_METHOD = 'user.login'
+    LOGOUT_METHOD = 'user.logout'
+
+    DEFAULT_HEADERS = {
+      'Content-Type' => 'application/json-rpc'
+    }
 
     def initialize(prefix, client)
       @prefix = prefix
@@ -22,14 +24,17 @@ class Zabbix::Client
       response = query(method, params, options)
 
       if (error = response['error'])
-        error = error.merge('method' => method, 'params' => params, 'options' => options)
+        error = error.merge('method' => method, 'params' => params)
         raise Zabbix::Client::Error.new(error)
       end
 
       result = response['result']
 
-      if method == LOGIN_METHOD
+      case method
+      when LOGIN_METHOD
         @client.auth = result
+      when LOGOUT_METHOD
+        @client.auth = nil
       end
 
       if block
@@ -51,24 +56,38 @@ class Zabbix::Client
 
       body[:auth] = @client.auth if @client.auth
       body = JSON.dump(body)
-      http = Net::HTTP.new(@client.url.host, @client.url.port)
+
+      proxy_user = @client.options[:proxy_user]
+      proxy_password = @client.options[:proxy_password]
+      http = Net::HTTP.Proxy(nil, nil).new(@client.url.host, @client.url.port)
 
       if @client.url.scheme == 'https'
-        https.use_ssl = true
-        https.verify_mode = OpenSSL::SSL::VERIFY_NONE
+        http.use_ssl = true
+        http.verify_mode = OpenSSL::SSL::VERIFY_NONE
       end
 
-      @client.http_hook.call(http) if @client.http_hook
+      http.set_debug_output($stderr) if @client.options[:debug]
 
       http.start do |h|
-        response = h.post(@client.url.path, body, @client.headers)
+        headers = DEFAULT_HEADERS.merge(@client.options[:headers] || {})
+        request = Net::HTTP::Post.new(@client.url.path, headers)
+        request.body = body
+
+        basic_auth_user = @client.options[:basic_auth_user]
+        basic_auth_password = @client.options[:basic_auth_password]
+
+        if basic_auth_user and basic_auth_password
+          request.basic_auth(basic_auth_user, basic_auth_password)
+        end
+
+        response = h.request(request)
         JSON.parse(response.body)
       end
     end
 
     def validate_args(args)
       unless (0..2).include?(args.length)
-        raise ArgumentError, "wrong number of arguments: #{args.inspect} (#{args.length} for 1..2)"
+        raise ArgumentError, "wrong number of arguments: #{args.inspect} (#{args.length} for 0..2)"
       end
 
       args.each do |arg|
@@ -80,14 +99,12 @@ class Zabbix::Client
   end # Method
 
   attr_reader   :url
-  attr_reader   :headers
-  attr_reader   :http_hook
+  attr_reader   :options
   attr_accessor :auth
 
-  def initialize(url, headers = {}, &http_hook)
+  def initialize(url, options = {})
     @url = URI.parse(url)
-    @headers = DEFAULT_HEADERS.merge(headers)
-    @http_hook = http_hook
+    @options = options
   end
 
   def method_missing(method_name)

data/lib/zabbix/client/version.rb

@@ -1,5 +1,5 @@
 module Zabbix
   class Client
-    VERSION = '0.0.1'
+    VERSION = '0.0.2'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zabbix-client
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Genki Sugawara