jay_api 28.0.0 → 28.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 641132f73f359c5e49bff17518040894399eb1396e5c17b629ae91f44007c702
-  data.tar.gz: 5c309039f6ce9ab628632624ebd6cfe542995ecd772dfad834a21fea799d5005
+  metadata.gz: 60468cdd7dbfd248e2ca373126f6d3f3a0e9c0d23d169a7e9d98aebe9de3d91d
+  data.tar.gz: 58ad9adc3a1f77139660338f213a9c835d935fc7a968f5971fe900904c1ba649
 SHA512:
-  metadata.gz: 89eeffecce6f605111ea8fc641b287022b636ea06304d7932d9297777c68ecf3e1e65c76ede81876e9dc1d0f06bd4969e80e29d0f75b8da1a85acab95971f9eb
-  data.tar.gz: 9505af9f03871fea1f9ceae6ace4718100ac2921c5ec04b17a65769f91dbcd0c2b951a3f38473b3b5186ccf00d70b3add50cc334a47e703eb2a3641f07ea7bdf
+  metadata.gz: 9a4c5a8ee131631eb7220b2c2cbf5eb4d9a081b3a0d817647c09d4027311629b78262b35707d8288418da5395d5bebdea11855d9a7f81b81f3d2566cc6156852
+  data.tar.gz: f596eeb92e9cecc97ffd2dccb9e93a2dfcf82524bd9bbed43b86ff2d3e60b011e6d9239923b2a4030ea1f0ab67c644028c3178c483de40455c2058c311e38e88

data/CHANGELOG.md

@@ -8,6 +8,19 @@ Please mark backwards incompatible changes with an exclamation mark at the start
 
 ## [Unreleased]
 
+## [28.2.0] - 2025-05-30
+
+### Added
+- The `#nodes` method to the `Elasticsearch::Stats` class. This method gives the
+  user access to the node-related statistics of the Elasticsearch cluster.
+
+## [28.1.0] - 2025-05-19
+
+### Added
+- The `#stats` method to the `Elasticsearch::Client` class. The method returns
+  an object that can be used to retrieve statistics about the Cluster. For the
+  moment only `#indices` is available, which returns index-related statistics.
+
 ## [28.0.0] - 2025-05-09
 
 ### Added

data/lib/jay_api/elasticsearch/client.rb

@@ -6,6 +6,7 @@ require 'faraday/error'
 require 'forwardable'
 
 require_relative '../abstract/connection'
+require_relative 'stats'
 
 module JayAPI
   module Elasticsearch
@@ -91,6 +92,12 @@ module JayAPI
         retry_request { transport_client.tasks.get(**args) }
       end
 
+      # @return [JayAPI::Elasticsearch::Stats] An instance of the +Stats+ class,
+      #   which gives the caller access to Elasticsearch's Statistics API.
+      def stats
+        @stats ||= ::JayAPI::Elasticsearch::Stats.new(transport_client)
+      end
+
       private
 
       # @param [Proc] block The block to execute.

data/lib/jay_api/elasticsearch/stats/errors/stats_data_not_available.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require_relative '../../../errors/error'
+
+module JayAPI
+  module Elasticsearch
+    class Stats
+      module Errors
+        # An error to be raised when a particular Stats element is requested for
+        # which there is no data in the response received from the cluster.
+        class StatsDataNotAvailable < ::JayAPI::Errors::Error; end
+      end
+    end
+  end
+end

data/lib/jay_api/elasticsearch/stats/index.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module JayAPI
+  module Elasticsearch
+    class Stats
+      # Holds information about an Elasticsearch Index.
+      class Index
+        attr_reader :name
+
+        # @param [String] name The name of the index.
+        # @param [Hash] data Information about the index.
+        def initialize(name, data)
+          @name = name
+          @data = data
+        end
+      end
+    end
+  end
+end

data/lib/jay_api/elasticsearch/stats/indices.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+require_relative 'index'
+
+module JayAPI
+  module Elasticsearch
+    class Stats
+      # Provides access to the list of indices returned by Elasticsearch's
+      # Stats API
+      class Indices
+        # A lambda used to select / reject system indices (indices whose name
+        # starts with dot).
+        SYSTEM_SELECTOR = ->(name, _data) { name.starts_with?('.') }
+
+        # @param [Hash{String=>Hash}] indices A +Hash+ with the information
+        #   about the indices. Its keys are the names of the indices, its values
+        #   hashes with information about each of the indices.
+        def initialize(indices)
+          @indices = indices
+        end
+
+        # @return [Enumerator::Lazy<JayAPI::Elasticsearch::Stats::Index>] A lazy
+        #   enumerator of +Index+ objects, one for each of the indexes. All
+        #   indices (system and user-defined are included).
+        def all
+          @all ||= with_lazy_instantiation { indices }
+        end
+
+        # @return [Enumerator::Lazy<JayAPI::Elasticsearch::Stats::Index>] A lazy
+        #   enumerator of +Index+ objects. Includes only the system indices.
+        def system
+          @system ||= with_lazy_instantiation { indices.select(&SYSTEM_SELECTOR) }
+        end
+
+        # @return [Enumerator::Lazy<JayAPI::Elasticsearch::Stats::Index>] A lazy
+        #   enumerator of +Index+ objects. Includes only the user-defined
+        #   indices.
+        def user
+          @user ||= with_lazy_instantiation { indices.reject(&SYSTEM_SELECTOR) }
+        end
+
+        private
+
+        attr_reader :indices
+
+        # @param [Array(String, Hash)] args An array with two elements, the name
+        #   of the index and its information.
+        # @return [JayAPI::Elasticsearch::Stats::Index] An +Index+ object
+        #   representing the given index.
+        def build_index(args)
+          JayAPI::Elasticsearch::Stats::Index.new(*args)
+        end
+
+        # Calls the given block and turns its return value into a lazy
+        # enumerator that instantiates an +Index+ object for each of the
+        # elements of the collection returned by block.
+        # @return [Enumerator::Lazy<JayAPI::Elasticsearch::Stats::Index>]
+        def with_lazy_instantiation(&block)
+          block.call.lazy.map(&method(:build_index))
+        end
+      end
+    end
+  end
+end

data/lib/jay_api/elasticsearch/stats/node/storage.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module JayAPI
+  module Elasticsearch
+    class Stats
+      class Node
+        # Holds storage information related to one of the nodes in the
+        # Elasticsearch cluster.
+        class Storage
+          TOTAL_KEY = 'total_in_bytes'
+          FREE_KEY = 'free_in_bytes'
+          AVAILABLE_KEY = 'available_in_bytes'
+
+          # @param [Hash] data Data about the Node's storage.
+          def initialize(data)
+            @data = data
+          end
+
+          # @return [Integer] The total size of the storage (in bytes)
+          def total
+            @total ||= data[TOTAL_KEY]
+          end
+
+          # @return [Integer] The total number of bytes that are free on the
+          #   node.
+          def free
+            @free ||= data[FREE_KEY]
+          end
+
+          # @return [Integer] The total number of bytes that are available on
+          #   the node. In general this is equal to #free, but not always.
+          def available
+            @available ||= data[AVAILABLE_KEY]
+          end
+
+          # @return [self] A new instance of the class with the added storage of
+          #   the receiver and +other+.
+          def +(other)
+            raise ArgumentError, "Cannot add #{self.class} and #{other.class} together" unless other.is_a?(self.class)
+
+            self.class.new(
+              TOTAL_KEY => total + other.total,
+              FREE_KEY => free + other.free,
+              AVAILABLE_KEY => available + other.available
+            )
+          end
+
+          private
+
+          attr_reader :data
+        end
+      end
+    end
+  end
+end

data/lib/jay_api/elasticsearch/stats/node.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require_relative 'errors/stats_data_not_available'
+require_relative 'node/storage'
+
+module JayAPI
+  module Elasticsearch
+    class Stats
+      # Holds information about one of the nodes in the Elasticsearch cluster.
+      class Node
+        attr_reader :name
+
+        # @param [String] name The name of the node.
+        # @param [Hash] data Information about the node.
+        def initialize(name, data)
+          @name = name
+          @data = data
+        end
+
+        # @return [JayAPI::Elasticsearch::Stats::Node::Storage] Storage
+        #   information about the node.
+        # @raise [JayAPI::Elasticsearch::Stats::Errors::StatsDataNotAvailable]
+        #   If there is no storage information for the node.
+        def storage
+          @storage ||= ::JayAPI::Elasticsearch::Stats::Node::Storage.new(fs_totals)
+        end
+
+        private
+
+        attr_reader :data
+
+        # @return [Hash] Aggregated information about the +Node+'s
+        #   filesystem.
+        # @raise [JayAPI::Elasticsearch::Stats::Errors::StatsDataNotAvailable]
+        #   If there is no filesystem information for the node.
+        def fs_totals
+          @fs_totals ||= data.dig('fs', 'total') || raise(
+            ::JayAPI::Elasticsearch::Stats::Errors::StatsDataNotAvailable,
+            "Filesystem data not available for node #{name}"
+          )
+        end
+      end
+    end
+  end
+end

data/lib/jay_api/elasticsearch/stats/nodes.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require 'forwardable'
+
+require_relative 'node'
+
+module JayAPI
+  module Elasticsearch
+    class Stats
+      # Provides access to the list of nodes returned by Elasticsearch's Stats API
+      class Nodes
+        extend Forwardable
+
+        def_delegator :nodes, :size
+
+        # @param [Hash] nodes Information about the nodes in the Elasticsearch
+        #   cluster.
+        def initialize(nodes)
+          @nodes = nodes
+        end
+
+        # @return [Enumerator::Lazy<JayAPI::Elasticsearch::Stats::Node>] A lazy
+        #   enumerator of +Node+ objects, one for each of the nodes.
+        def all
+          @all ||= with_lazy_instantiation { nodes }
+        end
+
+        private
+
+        attr_reader :nodes
+
+        def build_node(args)
+          ::JayAPI::Elasticsearch::Stats::Node.new(*args)
+        end
+
+        # Calls the given block and turns its return value into a lazy
+        # enumerator that instantiates a +Node+ object for each of the
+        # elements of the collection returned by the block.
+        # @return [Enumerator::Lazy<JayAPI::Elasticsearch::Stats::Node>]
+        def with_lazy_instantiation(&block)
+          block.call.lazy.map(&method(:build_node))
+        end
+      end
+    end
+  end
+end

data/lib/jay_api/elasticsearch/stats.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require_relative 'stats/index'
+require_relative 'stats/indices'
+require_relative 'stats/node'
+require_relative 'stats/nodes'
+
+module JayAPI
+  module Elasticsearch
+    # This class provides access to Elasticsearch's Cluster Statistic API.
+    class Stats
+      attr_reader :transport_client, :logger
+
+      # @param [Elasticsearch::Transport::Client] transport_client The transport
+      #   client to use to make requests to the cluster.
+      def initialize(transport_client)
+        @transport_client = transport_client
+      end
+
+      # @return [JayAPI::Elasticsearch::Stats::Indices] Information about the
+      #   indices that exist in the Elasticsearch cluster.
+      # @raise [Elasticsearch::Transport::Transport::ServerError] If the request
+      #   to the Statistics API endpoint fails.
+      def indices
+        # DO NOT MEMOIZE! Leave it to the caller.
+        ::JayAPI::Elasticsearch::Stats::Indices.new(indices_stats['indices'])
+      end
+
+      # @return [JayAPI::Elasticsearch::Stats::Nodes] Information about the
+      #   nodes that make up the Elasticsearch cluster.
+      # @raise [Elasticsearch::Transport::Transport::ServerError] If the request
+      #   to the Statistics API endpoint fails.
+      def nodes
+        # DO NOT MEMOIZE! Leave it to the caller.
+        ::JayAPI::Elasticsearch::Stats::Nodes.new(nodes_stats['nodes'])
+      end
+
+      private
+
+      # @return [Hash] The Hash with the index-related statistics returned by
+      #   the Elasticsearch cluster.
+      # @raise [Elasticsearch::Transport::Transport::ServerError] If the
+      #   request fails.
+      def indices_stats
+        # DO NOT MEMOIZE! Leave it to the caller.
+        transport_client.indices.stats
+      end
+
+      # @return [Hash] The Hash with the node-related statistics returned by the
+      #   Elasticsearch cluster.
+      # @raise [Elasticsearch::Transport::Transport::ServerError] If the
+      #   request fails.
+      def nodes_stats
+        # DO NOT MEMOIZE! Leave it to the caller.
+        transport_client.nodes.stats
+      end
+    end
+  end
+end

data/lib/jay_api/elasticsearch.rb

@@ -10,6 +10,7 @@ require_relative 'elasticsearch/query_builder'
 require_relative 'elasticsearch/query_results'
 require_relative 'elasticsearch/response'
 require_relative 'elasticsearch/search_after_results'
+require_relative 'elasticsearch/stats'
 require_relative 'elasticsearch/tasks'
 require_relative 'elasticsearch/time'
 

data/lib/jay_api/version.rb

@@ -2,5 +2,5 @@
 
 module JayAPI
   # JayAPI gem's semantic version
-  VERSION = '28.0.0'
+  VERSION = '28.2.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jay_api
 version: !ruby/object:Gem::Version
-  version: 28.0.0
+  version: 28.2.0
 platform: ruby
 authors:
 - Accenture-Industry X
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-05-09 00:00:00.000000000 Z
+date: 2025-05-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -171,6 +171,13 @@ files:
 - lib/jay_api/elasticsearch/query_results.rb
 - lib/jay_api/elasticsearch/response.rb
 - lib/jay_api/elasticsearch/search_after_results.rb
+- lib/jay_api/elasticsearch/stats.rb
+- lib/jay_api/elasticsearch/stats/errors/stats_data_not_available.rb
+- lib/jay_api/elasticsearch/stats/index.rb
+- lib/jay_api/elasticsearch/stats/indices.rb
+- lib/jay_api/elasticsearch/stats/node.rb
+- lib/jay_api/elasticsearch/stats/node/storage.rb
+- lib/jay_api/elasticsearch/stats/nodes.rb
 - lib/jay_api/elasticsearch/tasks.rb
 - lib/jay_api/elasticsearch/time.rb
 - lib/jay_api/errors/configuration_error.rb