wazuh-ruby-client 0.3.4 → 0.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e5378e67cd9073d90868662fe577ddafdbbd774f5813ae4883646fb1573804ef
-  data.tar.gz: 475ab3b706db3da28ba4bf80f1234e2d3ebe37f5e94d73c5cef98e87f51fd2f5
+  metadata.gz: 657652b05f675dd6fbe1ddb5e81adb03ef185d0eae786ffdfd30421ee975fcec
+  data.tar.gz: '0948eea68b62f1d1f66eb74e058edcd4ef3200cfb2eeca8b45c51cd782983ec3'
 SHA512:
-  metadata.gz: b5cdd839f283f03626900446db96eb040ba368664c1110a3f04bb4e31468f7e9f01cba0382006c79f074a9c14dcfed2344e2d302010d780b2dcfe8e237ac4273
-  data.tar.gz: d6443f7b6f466542b8e705b18318fef5444ec8309afa3631db0188391013955496b8c5ad04a88efdf1dc49391c648dea5523e8ffe9441f00064f85ff8e0b8bad
+  metadata.gz: 1f0718c22e673a282d6849dc5d9829f440357d34d5fd891bf6e42f43cb99ba8cbec019736d192b162901d6bf6fac1e7c3ecc30a1a42db11cbcc14ff3b9155132
+  data.tar.gz: 45151ead99511c81f03fd944415a0d8098613a0cadf601bfa04ccaf58cee504d7e88ce6e97bd531fa7a4917cf5603f3e7a0367a7d21e624fd9618b7d0fcaae12

data/.rubocop.yml

@@ -0,0 +1,59 @@
+require:
+  - rubocop-performance
+  - rubocop-rspec
+
+AllCops:
+  TargetRubyVersion: 2.6
+  DisplayCopNames: true
+  DisabledByDefault: true
+  Exclude:
+    - 'vendor/**/*'
+    - 'bin/bundle'
+
+Style/HashSyntax:
+  Enabled: true
+
+Layout/EmptyLines:
+  Enabled: true
+
+Layout/TrailingEmptyLines:
+  Enabled: true
+
+Layout/TrailingWhitespace:
+  Enabled: true
+
+Style/MethodDefParentheses:
+  Enabled: true
+
+# Generated by gry
+
+Layout/AccessModifierIndentation:
+  EnforcedStyle: indent
+  Enabled: true
+
+Layout/CaseIndentation:
+  EnforcedStyle: end
+  Enabled: true
+
+Style/Encoding:
+  Enabled: true
+
+Style/For:
+  EnforcedStyle: each
+  Enabled: true
+
+Style/FrozenStringLiteralComment:
+  EnforcedStyle: never
+  Enabled: false
+
+Layout/MultilineHashBraceLayout:
+  EnforcedStyle: symmetrical
+  Enabled: true
+
+Style/NumericLiteralPrefix:
+  EnforcedOctalStyle: zero_only
+  Enabled: true
+
+Style/StabbyLambdaParentheses:
+  EnforcedStyle: require_parentheses
+  Enabled: true

data/CHANGELOG.md

@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased]
 
+Supports v4 Cluster API.
+
+- [Supports v4 Cluster API by mrtc0 · Pull Request #36 · mrtc0/wazuh-ruby-client](https://github.com/mrtc0/wazuh-ruby-client/pull/36)
+
 ## [0.3.4]
 
 Support Vulnerability API.

data/Rakefile

@@ -3,7 +3,7 @@ require "rspec/core/rake_task"
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec
 
 task :doc do
   sh %{yardoc 'lib/**/*.rb' --output docs}

data/lib/wazuh/api/endpoints/agents.rb

@@ -4,7 +4,7 @@ module Wazuh
       module Agents
         #
         # Returns a list with the available agents.
-        # 
+        #
         # @option options [String] :offset
         #   First element to return in the collection.
         # @option options [String] :limit

data/lib/wazuh/api/endpoints/rootcheck.rb

@@ -21,7 +21,7 @@ module Wazuh
         end
 
         # Get last rootcheck scan
-        # Returns the timestamp of the last rootcheck scan. 
+        # Returns the timestamp of the last rootcheck scan.
         #
         # @param [String] agent_id
         # @see https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-last-rootcheck-scan

data/lib/wazuh/api/endpoints/security_configuration_assessment.rb

@@ -15,7 +15,7 @@ module Wazuh
         #   Filters by policy description
         # @option options [rationale] :rationale
         #   Filters by rationale
-        # @option options [remediation] :remediation 
+        # @option options [remediation] :remediation
         #   Filters by remediation
         # @option options [file] :file
         #   Filters by file

data/lib/wazuh/api/endpoints/syscollector.rb

@@ -216,7 +216,7 @@ module Wazuh
         #   Filters by process sgroup.
         # @option options [suser] :suser
         #   Filters by process suser.
-        # 
+        #
         # @see https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-processes-info
         def processes(agent_id, options = {})
           offset_request('get', "/syscollector/#{agent_id}/processes", options)

data/lib/wazuh/api/endpoints/v4/cluster.rb

@@ -4,6 +4,133 @@ module Wazuh
       module V4
         module Cluster
           include ::Wazuh::Api::Endpoints::Cluster
+
+          # https://documentation.wazuh.com/current/user-manual/api/reference.html#operation/api.controllers.cluster_controller.get_cluster_node
+          def local_node_info(options = {})
+            offset_request('get', '/cluster/local/info', options)
+          end
+
+          alias_method :get_cluster_node, :local_node_info
+
+          # https://documentation.wazuh.com/current/user-manual/api/reference.html#operation/api.controllers.cluster_controller.get_cluster_nodes
+          def nodes_info(options = {})
+            offset_request('get', '/cluster/nodes', options)
+          end
+
+          alias_method :get_cluster_nodes, :nodes_info
+
+          # https://documentation.wazuh.com/current/user-manual/api/reference.html#operation/api.controllers.cluster_controller.get_healthcheck
+          def nodes_healthcheck(options = {})
+            offset_request('get', '/cluster/healthcheck', options)
+          end
+
+          # https://documentation.wazuh.com/current/user-manual/api/reference.html#operation/api.controllers.cluster_controller.get_status
+          def cluster_status(options = {})
+            get '/cluster/status', options
+          end
+
+          # https://documentation.wazuh.com/current/user-manual/api/reference.html#operation/api.controllers.cluster_controller.get_config
+          def local_node_config(options = {})
+            offset_request('get', '/cluster/local/config', options)
+          end
+
+          # https://documentation.wazuh.com/current/user-manual/api/reference.html#operation/api.controllers.cluster_controller.get_api_config
+          def nodes_api_config(options = {})
+            offset_request('get', '/cluster/api/config', options)
+          end
+
+          alias_method :get_api_config, :nodes_api_config
+
+          # https://documentation.wazuh.com/current/user-manual/api/reference.html#operation/api.controllers.cluster_controller.get_status_node
+          def node_status(node_id, options = {})
+            offset_request('get', "/cluster/#{node_id}/status", options)
+          end
+
+          alias_method :get_status_node, :node_status
+
+          # https://documentation.wazuh.com/current/user-manual/api/reference.html#operation/api.controllers.cluster_controller.get_info_node
+          def node_info(node_id, options = {})
+            offset_request('get', "/cluster/#{node_id}/info", options)
+          end
+
+          alias_method :get_info_node, :node_info
+
+          # https://documentation.wazuh.com/current/user-manual/api/reference.html#operation/api.controllers.cluster_controller.get_configuration_node
+          def node_config(node_id, options = {})
+            offset_request('get', "/cluster/#{node_id}/configuration", options)
+          end
+
+          alias_method :get_configuration_node, :node_config
+
+          # https://documentation.wazuh.com/current/user-manual/api/reference.html#operation/api.controllers.cluster_controller.get_stats_node
+          def node_stats(node_id, options = {})
+            offset_request('get', "/cluster/#{node_id}/stats", options)
+          end
+
+          alias_method :get_stats_node, :node_stats
+
+          # https://documentation.wazuh.com/current/user-manual/api/reference.html#operation/api.controllers.cluster_controller.get_stats_hourly_node
+          def node_stats_hour(node_id, options = {})
+            offset_request('get', "/cluster/#{node_id}/stats/hourly", options)
+          end
+
+          alias_method :get_stats_hourly_node, :node_stats_hour
+
+          # https://documentation.wazuh.com/current/user-manual/api/reference.html#operation/api.controllers.cluster_controller.get_stats_weekly_node
+          def node_stats_week(node_id, options = {})
+            offset_request('get', "/cluster/#{node_id}/stats/weekly", options)
+          end
+
+          alias_method :get_stats_weekly_node, :node_stats_week
+
+          # https://documentation.wazuh.com/current/user-manual/api/reference.html#operation/api.controllers.cluster_controller.get_stats_analysisd_node
+          def node_stats_analysisd(node_id, options = {})
+            offset_request('get', "/cluster/#{node_id}/stats/analysisd", options)
+          end
+
+          alias_method :get_stats_analysisd_node, :node_stats_analysisd
+
+          # https://documentation.wazuh.com/current/user-manual/api/reference.html#operation/api.controllers.cluster_controller.get_stats_remoted_node
+          def node_stats_remoted(node_id, options = {})
+            offset_request('get', "/cluster/#{node_id}/stats/remoted", options)
+          end
+
+          alias_method :get_stats_remoted_node, :node_stats_remoted
+
+          # https://documentation.wazuh.com/current/user-manual/api/reference.html#operation/api.controllers.cluster_controller.get_log_node
+          def node_logs(node_id, options = {})
+            offset_request('get', "/cluster/#{node_id}/logs", options)
+          end
+
+          alias_method :get_log_node, :node_logs
+
+          # https://documentation.wazuh.com/current/user-manual/api/reference.html#operation/api.controllers.cluster_controller.get_log_summary_node
+          def node_logs_summary(node_id, options = {})
+            offset_request('get', "/cluster/#{node_id}/logs/summary", options)
+          end
+
+          alias_method :get_log_summary_node, :node_logs_summary
+
+          # https://documentation.wazuh.com/current/user-manual/api/reference.html#operation/api.controllers.cluster_controller.put_restart
+          def restart_nodes(options = {})
+            offset_request('put', "/cluster/restart", options)
+          end
+
+          alias_method :put_restart, :restart_nodes
+
+          # https://documentation.wazuh.com/current/user-manual/api/reference.html#operation/api.controllers.cluster_controller.get_conf_validation
+          def check_nodes_config(options = {})
+            offset_request('get', "/cluster/configuration/validationj", options)
+          end
+
+          alias_method :get_conf_validation, :check_nodes_config
+
+          # https://documentation.wazuh.com/current/user-manual/api/reference.html#operation/api.controllers.cluster_controller.get_node_config
+          def node_active_configuration(node_id, component, configuration, options = {})
+            offset_request('get', "/cluster/#{node_id}/configuration/#{component}/#{configuration}", options)
+          end
+
+          alias_method :get_node_config, :node_active_configuration
         end
       end
     end

data/lib/wazuh/client.rb

@@ -31,4 +31,3 @@ module Wazuh
     end
   end
 end
-

data/lib/wazuh/sawyer/connection.rb

@@ -18,7 +18,7 @@ module Wazuh
         options[:ssl].merge!({ verify: false }) unless verify_ssl
 
         opts = {
-          :links_parser => ::Sawyer::LinkParsers::Simple.new
+          links_parser: ::Sawyer::LinkParsers::Simple.new
         }
 
         case api_version

data/lib/wazuh/sawyer/request.rb

@@ -2,49 +2,55 @@
 module Wazuh
   module Sawyer
     module Request
+      MAX_ITEM_NUM = 500
+
       def get(path, options = {})
-        request(:get, path, options)
+        request(:get, path, options).data
       end
 
       def post(path, options = {})
-        request(:post, path, options)
+        request(:post, path, options).data
       end
 
       def put(path, options = {})
-        request(:put, path, options)
+        request(:put, path, options).data
       end
 
       def delete(path, options = {})
-        request(:delete, path, options)
+        request(:delete, path, options).data
       end
 
+      # The response format is different for v3 and v4.
+      # In v3, it is a camel case like `totalItems` and `items`,
+      # but in v4, it is snake case like total_affected_items.
+      # offset_request will fill this gap.
+      # This function is used if there are `affected_items` or `items` in the response.
       def offset_request(method, path, options = {})
         items = []
         data = send(method, path, options)
         total_items = api_version == 3 ? data.totalItems : data.total_affected_items
-        0.step(total_items, 500) { |offset|
+        0.step(total_items, MAX_ITEM_NUM) do |offset|
           options[:offset] = offset
           d = send(method, path, options)
           _items = api_version == 3 ? data.items : d.affected_items
           items.concat(_items)
-        }
+        end
 
         items
       end
 
-
       private
 
       def request(method, path, options, query_options={})
         response = case method
-        when :get, :delete
-          connection.call(method, URI::Parser.new.escape(path), nil, {query: options})
-        when :post, :put
-          data = options unless options.empty?
-          connection.call(method, URI::Parser.new.escape(path), data, {query: query_options})
-        end
-
-        return response.data.data if response.status == 200
+                   when :get, :delete
+                     connection.call(method, URI::Parser.new.escape(path), nil, {query: options})
+                   when :post, :put
+                     data = options unless options.empty?
+                     connection.call(method, URI::Parser.new.escape(path), data, {query: query_options})
+                   end
+
+        return response.data if response.status == 200
 
         raise Wazuh::Api::Errors::WazuhError.new(response.body, response)
       end

data/lib/wazuh/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module Wazuh
-  VERSION = '0.3.4'
+  VERSION = '0.3.5'
 end

data/lib/wazuh-ruby-client/version.rb

@@ -1,3 +1,3 @@
 module WazuhRubyClient
-  VERSION = "0.3.4"
+  VERSION = "0.3.5"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wazuh-ruby-client
 version: !ruby/object:Gem::Version
-  version: 0.3.4
+  version: 0.3.5
 platform: ruby
 authors:
 - mrtc0
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-02-03 00:00:00.000000000 Z
+date: 2022-03-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -189,7 +189,7 @@ files:
 - ".github/workflows/rspec-ci.yml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
+- ".rubocop.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE
@@ -306,7 +306,7 @@ metadata:
   homepage_uri: https://github.com/mrtc0/wazuh-ruby-client
   source_code_uri: https://github.com/mrtc0/wazuh-ruby-client
   changelog_uri: https://github.com/mrtc0/wazuh-ruby-client/blob/master/CHANGELOG.md
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -322,7 +322,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.1.4
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Wazuh API client for Ruby
 test_files: []

data/.travis.yml

@@ -1,7 +0,0 @@
----
-sudo: false
-language: ruby
-cache: bundler
-rvm:
-  - 2.5.1
-before_install: gem install bundler -v 1.17.3