zobbix 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9911466813d661136d61be74125c070d5f277e5c
-  data.tar.gz: fd1ff95638a274075f3a985516bb9abcdb69646e
+  metadata.gz: 29150be35da6782e1024701d4d292405f81c5bf7
+  data.tar.gz: 8837a76838b79f9d5015f5fe656be5d32993bf88
 SHA512:
-  metadata.gz: 7099349a5a24eea485962b89cd895ce003c98b814433fb4850751ea870bf16eeca01f2fb0c0b16c1dbe915fd0f5a98b14d537b31c7a9f48cf6ca976b7e02985f
-  data.tar.gz: cf8dfc3ca569c4ea824a2b7759862e9594783f91121b12656ec7636bcb0d2b6eb3a3025dc02d67067ea45696a5715b7b79751028b8e9e893f3c3bb78c2c340bd
+  metadata.gz: 6cc7318b64d3256ad64e4fa9100c44fb23279b550e550b184db77245c83679b36d1886b9e8f390174bc8bcdbcd666138ba56dee6bb568e6507cc324f3d36fb97
+  data.tar.gz: 1c40af5a0a5232f757369870f5d0fadda8fd4e4bce304ba179c2ac9f56fbd951c79801d5cc26c3d4c10c2fa4bedd9511787046e0f9ed2bb271ecf072a81c07ba

data/README.md

@@ -22,9 +22,35 @@ params = {
   expression: 'Linux Template:system.cpu.util[all,idle,avg1].avg(120)}<5'
 }
 
-zbx.request(methods, params)
+response = zbx.request(methods, params)
+
+response.class #=> Zobbix::ApiResponse
+
+version = zbx.request('apiinfo.version')
+
+version.result #=> "2.4.6"
+version.success? #=> true
+
+error = zbx.request('unknown.method')
+error.error? #=> true
+error.result #=> nil
+error.error_code #=> -32602
+error.error_message #=> "Invalid params."
+error.error_data #=> 'Incorrect API "unknown".'
+error.raise_exception #=> Zobbix::Error: API returned error. Code: -32602 Message: Invalid params. Data: Incorrect API "unknown".
 ``` 
 
+## API Exceptions
+```ruby
+# Enable API exceptions
+
+zbx = Zobbix.connect(uri:      'http://localhost/zabbix',
+                     user:     'Admin',
+                     password: 'zabbix',
+                     raise_exceptions: true)
+zbx.request('unknown.method') #=> Zobbix::Error: API returned error. Code: -32602 Message: Invalid params. Data: Incorrect API "unknown".
+```
+
 ## Zabbix Server API
 
 [API reference (2.2)](https://www.zabbix.com/documentation/2.2/manual/api/reference)

data/lib/zobbix/api_request.rb

@@ -20,6 +20,9 @@ class Zobbix
       new(*args).perform
     end
 
+    # @param [String] uri Zabbix Server uri
+    # @param [String] method API method
+    # @param [Hash] params API method params
     def initialize(uri, method, params)
       @uri    = uri.sub(/\/$/, '')
       @method = method
@@ -27,6 +30,9 @@ class Zobbix
       @params = params
     end
 
+    # Execute http request
+    #
+    # @return [Zobbix::ApiResponse]
     def perform
       ApiResponse.new { self.class.post("#{@uri}#{self.class.path}", body: payload) }
     end

data/lib/zobbix/api_response.rb

@@ -11,30 +11,37 @@ class Zobbix
       @exception = ex
     end
 
+    # @return [Boolean] True, if no HTTP or API errors happened
     def success?
       @exception.nil? && @response['error'].nil?
     end
 
+    # @return [Boolean] Opposite of #success?
     def error?
       !success?
     end
 
+    # @return [String, Hash] API result. Depends on API method
     def result
       @response['result']
     end
 
+    # @return [Fixnum, nil] Zabbix API error code
     def error_code
       @response['error'] && @response['error']['code']
     end
 
+    # @return [String, nil] Zabbix API error message
     def error_message
       @response['error'] && @response['error']['message']
     end
 
+    # @return [String, nil] Zabbix API error description
     def error_data
       @response['error'] && @response['error']['data']
     end
 
+    # @return [Fixnum] Request id
     def id
       @response['id']
     end

data/lib/zobbix/version.rb

@@ -1,3 +1,3 @@
 class Zobbix
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 end

data/lib/zobbix.rb

@@ -34,6 +34,11 @@ class Zobbix
     end
   end
 
+  #
+  # @param [Hash] credentials Connection credentials
+  # @option opts [String] :uri Zabbix Server URI
+  # @option opts [String] :user
+  # @option opts [String] :password
   def self.connect(credentials)
     new(credentials)
       .tap(&:check_version!)
@@ -45,9 +50,6 @@ class Zobbix
   end
 
   attr_reader :credentials, :auth
-
-  #
-  # @param Zobbix::Credentials
   def initialize(credentials)
     @raise_exceptions = credentials.delete(:raise_exceptions) || false
     @credentials = Credentials.new(credentials)
@@ -60,7 +62,7 @@ class Zobbix
   # @raise Zobbix::ConnectionError Can't establish connection
   # @raise Zobbix::UnsupportedVersionError Bad API version
   def check_version!
-    version = Apiinfo::VersionRequest.perform(credentials.uri).result
+    version = request('apiinfo.version').result
 
     if version.nil?
       raise ConnectionError.new(credentials)
@@ -80,9 +82,8 @@ class Zobbix
   #
   # @raise Zobbix::AuthenticationError
   def authenticate!
-    response = User::LoginRequest.perform(credentials.uri,
-                                          credentials.user,
-                                          credentials.password)
+    response = request('user.login', user: credentials.user,
+                                     password: credentials.password)
 
     unless response.success?
       raise AuthenticationError.new(credentials)
@@ -93,42 +94,21 @@ class Zobbix
 
   # Makes API request
   #
-  # @param [String] request method
-  # @param [Hash] request params
-  # @return [Zobbix::ApiResponse] response object
+  # @param [String] method Request method
+  # @param [Hash] params Request params
+  # @return [Zobbix::ApiResponse] Response object
   #
   # @see https://www.zabbix.com/documentation/2.4/manual/api/reference
   def request(method, params = {})
-    request = resolve_class(method)
-
-    response =
-      if request
-        if requires_auth?(method)
-          request.perform(credentials.uri, @auth, params)
-        else
-          request.perform(credentials.uri, params)
-        end
-      else
-        raw_request(method, params)
-      end
+    params = params.merge(auth: @auth) if requires_auth?(method)
 
+    response = ApiRequest.perform(credentials.uri, method, params)
     response.raise_exception if @raise_exceptions && response.error?
-
     response
   end
 
   private
 
-  def resolve_class(method)
-    namespace, mtd = method.split('.').map(&:capitalize)
-    self.class.const_get(namespace).const_get("#{mtd}Request")
-  rescue NameError
-  end
-
-  def raw_request(method, params)
-    ApiRequest.perform(credentials.uri, method, params.merge(auth: @auth))
-  end
-
   def requires_auth?(method)
     method = method.to_s
     method != 'apiinfo.version' && method != 'user.login'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zobbix
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Michael Lutsiuk
@@ -109,10 +109,8 @@ files:
 - lib/zobbix.rb
 - lib/zobbix/api_request.rb
 - lib/zobbix/api_response.rb
-- lib/zobbix/apiinfo/version_request.rb
 - lib/zobbix/core_ext/hash.rb
 - lib/zobbix/credentials.rb
-- lib/zobbix/user/login_request.rb
 - lib/zobbix/version.rb
 - test/api_request_test.rb
 - test/api_response_test.rb

data/lib/zobbix/apiinfo/version_request.rb

@@ -1,11 +0,0 @@
-require 'zobbix/api_request'
-
-class Zobbix
-  module Apiinfo
-    class VersionRequest < ApiRequest
-      def initialize(uri)
-        super(uri, 'apiinfo.version', {})
-      end
-    end
-  end
-end

data/lib/zobbix/user/login_request.rb

@@ -1,14 +0,0 @@
-require 'zobbix/api_request'
-
-class Zobbix
-  module User
-    class LoginRequest < ApiRequest
-      def initialize(uri, user, password)
-        super(uri,
-              'user.login',
-              user: user,
-              password: password)
-      end
-    end
-  end
-end