zabbix_api_gem 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a6c8f297f2139a9f7c49a789f9e1ffd4600e5912d9e0b1a63330f761752fcd1e
+  data.tar.gz: 50b8942c322c9875c94c28a75080feb1b72f93910511e2bfa10c3353740577d7
+SHA512:
+  metadata.gz: ba97284983467df1d8b2ead9f52b04883f5978bf78c38d0d0c3fc229cbc5a07ce81cb3ec8d79c5332ec591e6c0f7943f60d7cea4c29a57d0650c8e6a764bfc08
+  data.tar.gz: 28858aaa64c5fb2e9666949d83108e1751192d64042023afb6e7800ff037fe6e810f972692e8e5179c0fd89d0d5e506e03b56c762821a2162ab1f5a026f6a757

data/.env.template

@@ -0,0 +1,2 @@
+ZABBIX_API_HOST=<your veeam api host>
+ZABBIX_API_KEY=<api-key>

data/.gitignore

@@ -0,0 +1,44 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+/data/
+*.log
+*.txt
+*.json
+*.yml
+
+# Used by dotenv library to load environment variables.
+.env
+
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# Used by RuboCop. Remote config files pulled in from inherit_from directive.
+# .rubocop-https?--*
+Gemfile.lock

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-02-09
+- Initial release

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in cloudally.gemspec
+gemspec
+
+gem 'rake', '~> 13.0'
+gem 'rubocop', '~> 1.7'
+gem 'wrapi'

data/README.md

@@ -0,0 +1,99 @@
+# Zabbix API
+
+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.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'zabbix_api_gem'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ 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.
+
+```
+require 'zabbix_api_gem'
+
+# use do block
+Zabbix.configure do |config|
+  config.endpoint = ENV["ZABBIX_API_HOST"]
+  config.access_token = ENV["ZABBIX_API_KEY"]
+end
+
+# or configure with options hash
+client = Zabbix.client({ logger: Logger.new(CLIENT_LOGGER) })
+
+client = Zabbix.client
+client.login
+
+hostgroups = client.hostgroups
+companies.each do |c|
+  puts "#{c.name}"
+end
+```
+
+## Resources
+### Authentication
+```
+# 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
+```
+puts client.settings.default_theme
+```
+
+|Resource|API endpoint|
+|:--|:--|
+|.settings|settings.get|
+
+
+
+### Data resourcews
+Endpoint for data related requests 
+```
+groups = client.hostgroups
+group_hosts = client.hosts({groupids:[groups.first.groupid]})
+
+group_hosts.each do |host|
+  client.problems({hostids:[host.hostid]}).each do |problem|
+    puts problem.name
+  end
+end
+```
+
+|Resource|API endpoint|
+|:--|:--|
+|.hostgroups|hostgroup.get|
+|.hosts|hosts.get|
+|.problems|problems.get|
+
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/jancotanis/veeam.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new
+task default: %i[test rubocop]

data/lib/zabbix/api.rb

@@ -0,0 +1,39 @@
+require "wrapi"
+require File.expand_path('request', __dir__)
+require File.expand_path('authentication', __dir__)
+
+module Zabbix
+  # @private
+  class API
+
+    # @private
+    attr_accessor *WrAPI::Configuration::VALID_OPTIONS_KEYS
+
+    # Creates a new API and copies settings from singleton
+    def initialize(options = {})
+      options = Zabbix.options.merge(options)
+      WrAPI::Configuration::VALID_OPTIONS_KEYS.each do |key|
+        send("#{key}=", options[key])
+      end
+    end
+
+    def config
+      conf = {}
+      WrAPI::Configuration::VALID_OPTIONS_KEYS.each do |key|
+        conf[key] = send key
+      end
+      conf
+    end
+
+    # Convert zabbix clock to datetime
+    def zabbix_clock secs
+      Time.at( secs.to_i ).to_datetime
+    end
+
+    include WrAPI::Connection
+    include WrAPI::Request
+    include Request::JSONRPC2
+    include WrAPI::Authentication
+    include Authentication
+  end
+end

data/lib/zabbix/authentication.rb

@@ -0,0 +1,18 @@
+
+module Zabbix
+  # Deals with authentication flow and stores it within global configuration
+  module Authentication
+
+    # https://helpcenter.veeam.com/docs/vac/rest/reference/vspc-rest.html?ver=80#tag/Authentication
+    # Authorize to the Veeam portal and return access_token
+    def login(options = {})
+      raise ArgumentError, "Accesstoken/api-key not set" unless access_token
+      # only bearer token needed 
+      # will do sanitty check if token if valid
+      rpc_call('settings.get')
+    rescue RPCError => e
+      raise AuthenticationError, e
+    end
+
+  end
+end

data/lib/zabbix/client.rb

@@ -0,0 +1,23 @@
+require File.expand_path('api', __dir__)
+
+module Zabbix
+  # Wrapper for the Zabbix REST API
+  #
+  # @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
+
+    def self.def_rpc_call(method, rpc_method)
+      self.send(:define_method, method) do |params = nil|
+        rpc_call(rpc_method, params)
+      end
+    end
+
+    def_rpc_call(:api_info, 'api.info')
+    def_rpc_call(:settings, 'settings.get')
+    def_rpc_call(:hostgroups, 'hostgroup.get')
+    def_rpc_call(:hosts, 'host.get')
+    def_rpc_call(:problems, 'problem.get')
+
+  end
+end

data/lib/zabbix/error.rb

@@ -0,0 +1,11 @@
+module Zabbix
+	
+  # Generic error to be able to rescue all Zabbix errors
+  class ZabbixError < StandardError; end
+
+  # Raised when Zabbix RPC protocol returns error object
+  class RPCError < ZabbixError; end
+
+  # Error when authentication fails
+  class AuthenticationError < ZabbixError; end
+end

data/lib/zabbix/request.rb

@@ -0,0 +1,36 @@
+
+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
+    # http, or in many various message passing environments. It uses JSON (RFC 4627) as data format.
+    #
+    # https://www.jsonrpc.org/specification
+    module JSONRPC2
+
+      @@id = 1
+      ZABBIX_ENDPOINT = '/zabbix/api_jsonrpc.php'
+
+      def rpc_call(method, params = nil)
+        options = {
+          "jsonrpc": "2.0",
+          "method": method,
+          "params": {
+            "output": "extend"
+          },
+          "id": @@id += 1
+        }
+
+        options[:params] = params if params
+        result = post( ZABBIX_ENDPOINT, options )
+        raise RPCError, result.body['error'] if result.body['error']
+
+        WrAPI::Request::Entity.new(result.body['result'])
+      end
+
+    end
+  end
+end

data/lib/zabbix/version.rb

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

data/lib/zabbix.rb

@@ -0,0 +1,25 @@
+require "wrapi"
+require File.expand_path('zabbix/version', __dir__)
+require File.expand_path('zabbix/error', __dir__)
+require File.expand_path('zabbix/client', __dir__)
+
+module Zabbix
+  extend WrAPI::Configuration
+  extend WrAPI::RespondTo
+
+  DEFAULT_UA       = "Ruby Zabbix API wrapper #{Zabbix::VERSION}".freeze
+
+  #
+  # @return [Zabbix::Client]
+  def self.client(options = {})
+    Zabbix::Client.new({
+      user_agent: DEFAULT_UA
+    }.merge(options))
+  end
+
+  def self.reset
+    super
+    self.endpoint     = nil
+    self.user_agent   = DEFAULT_UA
+  end
+end

data/lib/zabbix_api_gem.rb

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

data/zabbix.gemspec

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require_relative 'lib/zabbix/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'zabbix_api_gem'
+  s.version     = Zabbix::VERSION
+  s.authors     = ['Janco Tanis']
+  s.email       = 'gems@jancology.com'
+  s.license     = 'MIT'
+
+  s.summary     = 'A Ruby wrapper for the Zabbix APIs (readonly)'
+  s.homepage    = 'https://rubygems.org/gems/zabbix'
+
+  s.required_ruby_version = Gem::Requirement.new('>= 2.4.0')
+
+  s.metadata['homepage_uri'] = s.homepage
+  s.metadata['source_code_uri'] = 'https://github.com/jancotanis/zabbix'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  s.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  s.bindir        = 'exe'
+  s.executables   = s.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  s.require_paths = ['lib']
+
+  s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.platform = Gem::Platform::RUBY
+  s.add_runtime_dependency 'faraday'
+  s.add_runtime_dependency 'wrapi', ">= 0.2.0"
+  s.add_development_dependency 'dotenv'
+  s.add_development_dependency 'minitest'
+  s.add_development_dependency 'rubocop'
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: zabbix_api_gem
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Janco Tanis
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-02-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: wrapi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description:
+email: gems@jancology.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".env.template"
+- ".gitignore"
+- CHANGELOG.md
+- Gemfile
+- README.md
+- Rakefile
+- lib/zabbix.rb
+- lib/zabbix/api.rb
+- lib/zabbix/authentication.rb
+- lib/zabbix/client.rb
+- lib/zabbix/error.rb
+- lib/zabbix/request.rb
+- lib/zabbix/version.rb
+- lib/zabbix_api_gem.rb
+- zabbix.gemspec
+homepage: https://rubygems.org/gems/zabbix
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://rubygems.org/gems/zabbix
+  source_code_uri: https://github.com/jancotanis/zabbix
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.12
+signing_key:
+specification_version: 4
+summary: A Ruby wrapper for the Zabbix APIs (readonly)
+test_files: []