zabbix_api_gem 0.3.3 → 0.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7f320a0b0f09957b5daca1b574e6b47665823214b2bc3df38e1c09dc6baf84be
-  data.tar.gz: 528c6c270141c9662417247fb72c013818c841ac92cbc5474d68bd49d31d815b
+  metadata.gz: 1d9caf35864059444cdcda6d50357ea93aec46aca168097f25664c870d1b1b29
+  data.tar.gz: 1defae29de7348948fa323a99476748902456512e479b6c704cc0e926d377b15
 SHA512:
-  metadata.gz: 918cf731282b13be7f4624e36d6ec635bc43386e5cf33785cd3c09c8c1b09b15849c108390f481874ad5731734b2c1b9ad675c3c566bd78c3195b24cb82b9e9a
-  data.tar.gz: 89fc1ff2554b76f98f2605e26cce055d4e4fbc46658b134e01ff2d26663b4b71a57357cdc9d2fb35b1c86fbd200eff35c748b364e463652daadc1f5a15036cdc
+  metadata.gz: cac93c6741f01358190714aa44f78f9929851bc7ddb758789c5e4cd47ca0506e850cc4dfa4471202d70c6a3ac26b16075263c7b629c6afcaedf38ad9bde26e1e
+  data.tar.gz: 35c41b3d7b640a9f71bfea83dd4b5afc439cdbff5d1c0bac9f56139986c9bc2864d0d4cd4bbd619efeee8a3db683af342f68ddef2ca228d26bec8fc375ae59d2

data/CHANGELOG.md

@@ -1,20 +1,29 @@
-## [Unreleased]
+# Changelog
 
 ## [0.1.0] - 2024-02-09
+
 - Initial release
 
 ## [0.2.0] - 2024-02-12
+
 - Include events and method to get object by id
 
 ## [0.3.0] - 2024-02-20
+
 - ConfigurationError raised if not configured properly
 
 ## [0.3.1] - 2024-02-22
+
 - Fix problem with entity creation
 
 ## [0.3.2] - 2024-03-21
+
 - Refactory extract method
 
 ## [0.3.3] - 2024-03-21
+
 - Fix issues with extract method
 
+## [0.3.4] - 2024-03-21
+
+- Fix issues with problems api and use eventids parameter

data/Gemfile

@@ -8,4 +8,4 @@ gemspec
 gem 'rake', '~> 13.0'
 gem 'rubocop', '~> 1.7'
 gem 'simplecov', require: false, group: :test
-gem 'wrapi'
+gem 'wrapi'

data/README.md

@@ -1,9 +1,11 @@
 # Zabbix API
+
 [![Version](https://img.shields.io/gem/v/zabbix_api_gem.svg)](https://rubygems.org/gems/zabbix_api_gem)
 [![Maintainability](https://api.codeclimate.com/v1/badges/de2999161abdc8179fde/maintainability)](https://codeclimate.com/github/jancotanis/zabbix/maintainability)
 [![Test Coverage](https://api.codeclimate.com/v1/badges/de2999161abdc8179fde/test_coverage)](https://codeclimate.com/github/jancotanis/zabbix/test_coverage)
 
-This is a wrapper for the Zabix rest API. You can see the API endpoints here https://www.zabbix.com/documentation/current/en/manual/api/reference/
+This is a wrapper for the Zabix rest API. You can see the
+API endpoints [here](https://www.zabbix.com/documentation/current/en/manual/api/reference/)
 
 Currently only the GET requests to get a list of hosts, host groups and problems are implemented.
 
@@ -17,15 +19,20 @@ gem 'zabbix_api_gem'
 
 And then execute:
 
-    $ bundle install
+```console
+> bundle install
+```
 
 Or install it yourself as:
 
-    $ gem install zabbix_api_gem
+```console
+> gem install zabbix_api_gem
+```
 
 ## Usage
 
-Before you start making the requests to API provide the client id and client secret and email/password using the configuration wrapping.
+Before you start making the requests to API provide the client id and client secret and
+email/password using the configuration wrapping.
 
 ```ruby
 require 'zabbix_api_gem'
@@ -49,19 +56,23 @@ end
 ```
 
 ## Resources
+
 ### Authentication
+
 ```ruby
 # setup configuration
 #
 client.login
 ```
+
 |Resource|API endpoint|Description|
 |:--|:--|:--|
 |.login| none |uses settings.get to check if credentials are correct. Raises Zabbix:AuthenticationError incase this fails|
 
-
 ### Server settings
+
 Return zabbix server settings
+
 ```ruby
 puts client.settings.default_theme
 ```
@@ -70,10 +81,10 @@ puts client.settings.default_theme
 |:--|:--|
 |.settings|settings.get|
 
-
-
 ### Data resourcews
+
 Endpoint for data related requests 
+
 ```
 groups = client.hostgroups
 group_hosts = client.hosts({groupids:[groups.first.groupid]})
@@ -92,11 +103,9 @@ end
 |.problems, problem(event_id)|problems.get|
 |.events, event(event_id)|problems.get|
 
-
-
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/jancotanis/zabbix.
+Bug reports and pull requests are welcome on [GitHub](https://github.com/jancotanis/zabbix).
 
 ## License
 

data/lib/zabbix/api.rb

@@ -1,35 +1,71 @@
-require "wrapi"
+# frozen_string_literal: true
+
+require 'wrapi'
 require File.expand_path('request', __dir__)
 require File.expand_path('authentication', __dir__)
 
 module Zabbix
-  # @private
+  # This class is the core API client that interfaces with Zabbix.
+  # It manages configuration options, API connections, and helper utilities.
+  #
+  # @example Create a new Zabbix API client:
+  #    api = Zabbix::API.new(endpoint: 'https://zabbix.example.com/api_jsonrpc.php', api_key: 'your_key')
+  #
+  # @note This class includes connection, request handling, JSON-RPC 2.0 support, and authentication from WrAPI.
   class API
+    # Allow read/write access to configuration keys like endpoint, user_agent, and others.
+    # These keys are inherited from `WrAPI::Configuration::VALID_OPTIONS_KEYS`.
+    #
+    # @!attribute [rw] endpoint
+    #   @return [String] The base URL of the Zabbix API.
+    # @!attribute [rw] user_agent
+    #   @return [String] The user agent used in API requests.
+    attr_accessor(*WrAPI::Configuration::VALID_OPTIONS_KEYS)
 
-    # @private
-    attr_accessor *WrAPI::Configuration::VALID_OPTIONS_KEYS
-
-    # Creates a new API and copies settings from singleton
+    # Initialize a new Zabbix::API instance and copy settings from the singleton configuration.
+    #
+    # @param options [Hash] Configuration options for the Zabbix API client.
+    #   Options override any default values set in the singleton Zabbix configuration.
+    #
+    # @option options [String] :endpoint The base URL of the Zabbix API.
+    # @option options [String] :user_agent The User-Agent header sent with requests.
+    # @option options [Integer] :timeout Request timeout in seconds.
     def initialize(options = {})
-      options = Zabbix.options.merge(options)
+      options = Zabbix.options.merge(options)  # Merge provided options with default options
       WrAPI::Configuration::VALID_OPTIONS_KEYS.each do |key|
-        send("#{key}=", options[key])
+        send("#{key}=", options[key])  # Assign each configuration option dynamically
       end
     end
 
+    # Retrieve the current configuration for the API client.
+    #
+    # @return [Hash] A hash containing the current configuration options.
+    # @example Get the client configuration:
+    #   api = Zabbix::API.new
+    #   puts api.config  # => { endpoint: "https://...", user_agent: "...", timeout: 60 }
     def config
       conf = {}
       WrAPI::Configuration::VALID_OPTIONS_KEYS.each do |key|
-        conf[key] = send key
+        conf[key] = send(key)  # Build a hash of current configuration values
       end
       conf
     end
 
-    # Convert zabbix clock to datetime
-    def zabbix_clock secs
-      Time.at( secs.to_i ).to_datetime
+    # Convert a Zabbix clock timestamp to a Ruby DateTime object.
+    #
+    # @param secs [String, Integer] The Zabbix clock time in seconds since the Unix epoch.
+    # @return [DateTime] A DateTime object representing the input time.
+    #
+    # @example Convert Zabbix clock to DateTime:
+    #   api.zabbix_clock(1684500000)  # => #<DateTime: 2023-05-19T09:20:00+00:00>
+    def zabbix_clock(secs)
+      Time.at(secs.to_i).to_datetime  # Convert seconds since Unix epoch to DateTime
     end
 
+    # Includes core modules from WrAPI and Zabbix:
+    # - Connection: For managing HTTP connections.
+    # - Request: For handling JSON-RPC 2.0 requests.
+    # - Authentication: For managing API authentication.
     include WrAPI::Connection
     include WrAPI::Request
     include Request::JSONRPC2

data/lib/zabbix/authentication.rb

@@ -1,18 +1,18 @@
+# frozen_string_literal: true
 
 module Zabbix
   # Deals with authentication flow and stores it within global configuration
   module Authentication
-
     # Authorize to the Zabbix portal using the access_token
     # @see https://www.zabbix.com/documentation/current/en/manual/api
-    def login(options = {})
-      raise ConfigurationError, "Accesstoken/api-key not set" unless access_token
-      # only bearer token needed 
+    def login(_options = {})
+      raise ConfigurationError, 'Accesstoken/api-key not set' unless access_token
+
+      # only bearer token needed
       # will do sanity check if token if valid
       rpc_call('settings.get')
     rescue RPCError => e
       raise AuthenticationError, e
     end
-
   end
 end

data/lib/zabbix/client.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require File.expand_path('api', __dir__)
 
 module Zabbix
@@ -6,34 +8,30 @@ module Zabbix
   # @note All methods have been separated into modules and follow the same grouping used in api docs
   # @see https://www.zabbix.com/documentation/current/en/manual/api
   class Client < API
-  private
     def self.def_rpc_call(method, rpc_method, id_field = nil)
       self.send(:define_method, method) do |params = nil|
         rpc_call(rpc_method, params)
       end
-    
       # singular by stripping last trailing 's'
       self.singular_method(method.to_s.chop.to_sym, rpc_method, id_field) if id_field
     end
-    
-    def self.singular_method method, rpc_method, id_field
-      self.send(:define_method, method) do |ids,params = nil|
+
+    def self.singular_method(method, rpc_method, id_field)
+      self.send(:define_method, method) do |ids, params = nil|
         if ids.is_a?(Array)
-          rpc_call(rpc_method, {"#{id_field}":ids}.merge(params || {}))
+          rpc_call(rpc_method, { "#{id_field}": ids}.merge(params || { }))
         else
-          rpc_call(rpc_method, {"#{id_field}":[ids]}.merge(params || {})).first
+          rpc_call(rpc_method, { "#{id_field}": [ids]}.merge(params || { })).first
         end
       end
     end
 
-  public
     def_rpc_call :api_info, 'api.info'
     def_rpc_call :settings, 'settings.get'
     def_rpc_call :hostgroups, 'hostgroup.get', 'groupids'
     def_rpc_call :hosts, 'host.get', 'hostids'
-    def_rpc_call :problems, 'problem.get', 'problemids'
+    def_rpc_call :problems, 'problem.get', 'eventids'
     def_rpc_call :events, 'event.get', 'eventids'
     def_rpc_call :acknowledge_events, 'event.acknowledge'
-
   end
 end

data/lib/zabbix/error.rb

@@ -1,5 +1,6 @@
+# frozen_string_literal: true
+
 module Zabbix
-	
   # Generic error to be able to rescue all Zabbix errors
   class ZabbixError < StandardError; end
 
@@ -11,4 +12,4 @@ module Zabbix
 
   # Error when authentication fails
   class AuthenticationError < ZabbixError; end
-end
+end

data/lib/zabbix/request.rb

@@ -1,8 +1,8 @@
+# frozen_string_literal: true
 
 module Zabbix
   # Deals with requests
   module Request
-
     # JSON-RPC is a stateless, light-weight remote procedure call (RPC) protocol. Primarily this
     # specification defines several data structures and the rules around their processing. It is
     # transport agnostic in that the concepts can be used within the same process, over sockets, over
@@ -16,21 +16,20 @@ module Zabbix
 
       def rpc_call(method, params = nil)
         options = {
-          "jsonrpc": "2.0",
-          "method": method,
-          "params": {
-            "output": "extend"
+          'jsonrpc': '2.0',
+          'method': method,
+          'params': {
+            'output': 'extend'
           },
-          "id": @@id += 1
+          'id': @@id += 1
         }
 
         options[:params] = params if params
-        result = post( ZABBIX_ENDPOINT, options )
+        result = post(ZABBIX_ENDPOINT, options)
         raise RPCError, result.body['error'] if result.body['error']
 
         WrAPI::Request::Entity.create(result.body['result'])
       end
-
     end
   end
 end

data/lib/zabbix/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Zabbix
-  VERSION = '0.3.3'
+  VERSION = '0.3.4'
 end

data/lib/zabbix.rb

@@ -1,25 +1,51 @@
-require "wrapi"
+# frozen_string_literal: true
+
+require 'wrapi'
 require File.expand_path('zabbix/version', __dir__)
 require File.expand_path('zabbix/error', __dir__)
 require File.expand_path('zabbix/client', __dir__)
 
+# This module provides a Ruby API wrapper for Zabbix.
+# It includes configuration options and creates client instances for interacting with the Zabbix API.
+# 
+# @example Initialize a Zabbix client:
+#   client = Zabbix.client(endpoint: 'https://your-zabbix-server/api_jsonrpc.php')
+#
 module Zabbix
   extend WrAPI::Configuration
   extend WrAPI::RespondTo
 
-  DEFAULT_UA       = "Ruby Zabbix API wrapper #{Zabbix::VERSION}".freeze
+  # Default User-Agent string for API requests.
+  DEFAULT_UA = "Ruby Zabbix API wrapper #{Zabbix::VERSION}"
 
+  # Creates and returns a new Zabbix client instance.
+  # Merges default client settings with any user-provided options.
+  #
+  # @param options [Hash] Optional settings to configure the client.
+  #   - `:user_agent` (String) – Custom User-Agent string for API requests.
+  #   - `:endpoint` (String) – The API endpoint URL (e.g., 'https://zabbix.example.com/api_jsonrpc.php').
+  #
+  # @return [Zabbix::Client] A configured client instance.
+  #
+  # @example Create a client with a custom User-Agent and endpoint:
+  #   client = Zabbix.client(user_agent: "MyApp Zabbix Client", endpoint: "https://zabbix.example.com/api_jsonrpc.php")
   #
-  # @return [Zabbix::Client]
   def self.client(options = {})
+    # Ensure that the options argument is a Hash to prevent merge errors
+    options = options.is_a?(Hash) ? options : {}
     Zabbix::Client.new({
       user_agent: DEFAULT_UA
     }.merge(options))
   end
 
+  # Resets the Zabbix module configuration to its default state.
+  #
+  # This method sets the default endpoint and User-Agent string.
+  #
+  # @return [void]
   def self.reset
     super
-    self.endpoint     = nil
-    self.user_agent   = DEFAULT_UA
+    self.endpoint   = nil
+    self.user_agent = DEFAULT_UA
   end
 end

data/lib/zabbix_api_gem.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 
 # place holder to use unique gem name
 require File.expand_path('zabbix', __dir__)

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: zabbix_api_gem
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.3.4
 platform: ruby
 authors:
 - Janco Tanis
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-07-18 00:00:00.000000000 Z
+date: 2025-03-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -94,7 +93,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description:
 email: gems@jancology.com
 executables: []
 extensions: []
@@ -122,7 +120,6 @@ licenses:
 metadata:
   homepage_uri: https://rubygems.org/gems/zabbix
   source_code_uri: https://github.com/jancotanis/zabbix
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -137,8 +134,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: A Ruby wrapper for the Zabbix APIs (readonly)
 test_files: []