jay_api 28.0.0 → 28.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 641132f73f359c5e49bff17518040894399eb1396e5c17b629ae91f44007c702
-  data.tar.gz: 5c309039f6ce9ab628632624ebd6cfe542995ecd772dfad834a21fea799d5005
+  metadata.gz: 0b2d35c2ed340724fe54f7f099ed3fb5f200249c72604b906a39ecdef13be6fb
+  data.tar.gz: 4da5c5a7dca36ea23ca6241ac5f44846558d620a60ce9382dff422ca3575f4fe
 SHA512:
-  metadata.gz: 89eeffecce6f605111ea8fc641b287022b636ea06304d7932d9297777c68ecf3e1e65c76ede81876e9dc1d0f06bd4969e80e29d0f75b8da1a85acab95971f9eb
-  data.tar.gz: 9505af9f03871fea1f9ceae6ace4718100ac2921c5ec04b17a65769f91dbcd0c2b951a3f38473b3b5186ccf00d70b3add50cc334a47e703eb2a3641f07ea7bdf
+  metadata.gz: 74414baf82a02115568311cfce173e990c3777da5d3a18eed084366048968f88c1a42e581a2652544cc9952ff1e32b135528c622cd2d30554a429c952b544aa2
+  data.tar.gz: 5bbe6985eb4d5b3bd1263f1ebd6d23f83afb2a9b5eb48bce31a710628bdd35f6051c0b643bcdaab8c22ffc977b90e4bd79e3b94468a9d8b0b0984065408df92a

data/CHANGELOG.md

@@ -8,6 +8,13 @@ Please mark backwards incompatible changes with an exclamation mark at the start
 
 ## [Unreleased]
 
+## [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/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.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require_relative 'stats/index'
+require_relative 'stats/indices'
+
+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(response['indices'])
+      end
+
+      private
+
+      # @return [Hash] The Hash with the statistics returned by the
+      #   Elasticsearch cluster.
+      # @raise [Elasticsearch::Transport::Transport::ServerError] If the
+      #   request fails.
+      def response
+        # DO NOT MEMOIZE! Leave it to the caller.
+        transport_client.indices.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.1.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.1.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-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -171,6 +171,9 @@ 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/index.rb
+- lib/jay_api/elasticsearch/stats/indices.rb
 - lib/jay_api/elasticsearch/tasks.rb
 - lib/jay_api/elasticsearch/time.rb
 - lib/jay_api/errors/configuration_error.rb