jay_api 28.1.0 → 28.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0b2d35c2ed340724fe54f7f099ed3fb5f200249c72604b906a39ecdef13be6fb
-  data.tar.gz: 4da5c5a7dca36ea23ca6241ac5f44846558d620a60ce9382dff422ca3575f4fe
+  metadata.gz: 60468cdd7dbfd248e2ca373126f6d3f3a0e9c0d23d169a7e9d98aebe9de3d91d
+  data.tar.gz: 58ad9adc3a1f77139660338f213a9c835d935fc7a968f5971fe900904c1ba649
 SHA512:
-  metadata.gz: 74414baf82a02115568311cfce173e990c3777da5d3a18eed084366048968f88c1a42e581a2652544cc9952ff1e32b135528c622cd2d30554a429c952b544aa2
-  data.tar.gz: 5bbe6985eb4d5b3bd1263f1ebd6d23f83afb2a9b5eb48bce31a710628bdd35f6051c0b643bcdaab8c22ffc977b90e4bd79e3b94468a9d8b0b0984065408df92a
+  metadata.gz: 9a4c5a8ee131631eb7220b2c2cbf5eb4d9a081b3a0d817647c09d4027311629b78262b35707d8288418da5395d5bebdea11855d9a7f81b81f3d2566cc6156852
+  data.tar.gz: f596eeb92e9cecc97ffd2dccb9e93a2dfcf82524bd9bbed43b86ff2d3e60b011e6d9239923b2a4030ea1f0ab67c644028c3178c483de40455c2058c311e38e88

data/CHANGELOG.md

@@ -8,6 +8,12 @@ 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

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/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

@@ -2,6 +2,8 @@
 
 require_relative 'stats/index'
 require_relative 'stats/indices'
+require_relative 'stats/node'
+require_relative 'stats/nodes'
 
 module JayAPI
   module Elasticsearch
@@ -21,19 +23,37 @@ module JayAPI
       #   to the Statistics API endpoint fails.
       def indices
         # DO NOT MEMOIZE! Leave it to the caller.
-        ::JayAPI::Elasticsearch::Stats::Indices.new(response['indices'])
+        ::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 statistics returned by the
-      #   Elasticsearch cluster.
+      # @return [Hash] The Hash with the index-related statistics returned by
+      #   the Elasticsearch cluster.
       # @raise [Elasticsearch::Transport::Transport::ServerError] If the
       #   request fails.
-      def response
+      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/version.rb

@@ -2,5 +2,5 @@
 
 module JayAPI
   # JayAPI gem's semantic version
-  VERSION = '28.1.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.1.0
+  version: 28.2.0
 platform: ruby
 authors:
 - Accenture-Industry X
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-05-19 00:00:00.000000000 Z
+date: 2025-05-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -172,8 +172,12 @@ files:
 - 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