jay_api 27.2.1 → 27.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a35b06322adf0ab11fcdd970835c9a1aac3ff8b5de340c4daa8fe9d2214613a5
-  data.tar.gz: 0be3fa8509779e0d18e4cacc5df1a182babe20554568f6a1af43ca9c8af2cc8e
+  metadata.gz: 5a6edc53b541759520ecc03ea41bd03119d4c89aca3967d6a108d7b4329d31ac
+  data.tar.gz: 576525ff4b4a470f1b81839990344837f6907bd3d0e54acd9dab7ccff7090dce
 SHA512:
-  metadata.gz: 85f9eac9b429ef76ab803704be715bb038860a789376cd42dd213bd3d1fbcfaac2fc89881d3419a721ce3e3a25614a1f042067282c8a448c4c1664ca99ff381a
-  data.tar.gz: c01b9deda5d00aec9a188e7e60fd4b9b6d3f82801750cb5e00d9339c4380822b8e08788e9080107cb67cb26d1c80c4e8c42f99b68b1ef04a7e758c94c0561b31
+  metadata.gz: 54bf37bfd8b82a8337645a8064b2cc82707d8c985816646ae23774b917676b7a79642710420dba680cb163491fb8035eaed603ac22c86410c63e43907805a14d
+  data.tar.gz: 4525bc1fb75c38f6e741e245757e3261c9bf4a0981d1e65da3756c65f24610ac66d25480a6d842f54c5c9097fad6612e05736310226466ddd783df13b142266f

data/CHANGELOG.md

@@ -8,6 +8,22 @@ Please mark backwards incompatible changes with an exclamation mark at the start
 
 ## [Unreleased]
 
+## [27.4.0] - 2025-04-10
+
+### Added
+- The `#ping` method to `Elasticsearch::Client`
+
+## [27.3.0] - 2025-04-04
+
+### Added
+- The `Aggregations::Cardinality` class and the `Aggregations#cardinality`
+  method. They make it possible to use Elasticsearch's `cardinality`
+  aggregations.
+
+### Changed
+- `GitilesHelper#gitiles_url` can now be called without a `path`. When no path
+  is given the method generates a link to the given `refspec` instead.
+
 ## [27.2.1] - 2025-03-14
 
 ### Fixed

data/lib/jay_api/elasticsearch/client.rb

@@ -3,6 +3,7 @@
 require 'elasticsearch/api/namespace/tasks'
 require 'elasticsearch/transport/transport/errors'
 require 'faraday/error'
+require 'forwardable'
 
 require_relative '../abstract/connection'
 
@@ -13,6 +14,8 @@ module JayAPI
     # rescue the error up to a few times and re-try the connection. This way the
     # connection to Elasticsearch will be more robust.
     class Client
+      extend Forwardable
+
       # The errors that, if raised, must cause a retry of the connection.
       ERRORS = [
         ::Elasticsearch::Transport::Transport::ServerError,
@@ -33,6 +36,11 @@ module JayAPI
 
       attr_reader :transport_client, :logger, :max_attempts, :wait_strategy
 
+      # @return [Boolean] True if there is connectivity to the cluster, false otherwise.
+      # @raise [Transport::Errors::Forbidden] If the user has no permissions to
+      #   ping the cluster.
+      def_delegator :transport_client, :ping
+
       # @param [Elasticsearch::Transport::Client] transport_client The Client
       #   object that will be wrapped.
       # @param [Logging::Logger] logger

data/lib/jay_api/elasticsearch/query_builder/aggregations/cardinality.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require_relative 'aggregation'
+
+module JayAPI
+  module Elasticsearch
+    class QueryBuilder
+      class Aggregations
+        # Represents a +cardinality+ aggregation in Elasticsearch.
+        # Information on this type of aggregation can be found here:
+        # https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-cardinality-aggregation.html
+        class Cardinality < ::JayAPI::Elasticsearch::QueryBuilder::Aggregations::Aggregation
+          attr_reader :field
+
+          # @param [String] name The name used by Elasticsearch to identify each
+          #   of the aggregations.
+          # @param [String] field The field whose cardinality (number of unique
+          #   values) should be calculated.
+          def initialize(name, field:)
+            super(name)
+
+            @field = field
+          end
+
+          # @raise [JayAPI::Elasticsearch::QueryBuilder::Aggregations::Errors::AggregationsError]
+          #   Is always raised. The Cardinality aggregation cannot have nested
+          #   aggregations.
+          def aggs
+            no_nested_aggregations('Cardinality')
+          end
+
+          # @return [self] A copy of the receiver.
+          def clone
+            self.class.new(name, field: field)
+          end
+
+          # @return [Hash] The Hash representation of the +Aggregation+.
+          #   Properly formatted for Elasticsearch.
+          def to_h
+            super do
+              {
+                cardinality: {
+                  field: field
+                }
+              }
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/jay_api/elasticsearch/query_builder/aggregations.rb

@@ -4,6 +4,7 @@ require 'forwardable'
 
 require_relative 'aggregations/aggregation'
 require_relative 'aggregations/avg'
+require_relative 'aggregations/cardinality'
 require_relative 'aggregations/filter'
 require_relative 'aggregations/scripted_metric'
 require_relative 'aggregations/sum'
@@ -99,6 +100,16 @@ module JayAPI
           add(::JayAPI::Elasticsearch::QueryBuilder::Aggregations::Filter.new(name, &block))
         end
 
+        # Adds a +cardinality+ type aggregation. For more information about the parameters
+        # @see JayAPI::Elasticsearch::QueryBuilder::Aggregations::Cardinality#initialize
+        def cardinality(name, field:)
+          add(
+            ::JayAPI::Elasticsearch::QueryBuilder::Aggregations::Cardinality.new(
+              name, field: field
+            )
+          )
+        end
+
         # Returns a Hash with the correct format for the current list of
         # aggregations. For example:
         #

data/lib/jay_api/git/gerrit/gitiles_helper.rb

@@ -8,16 +8,18 @@ module JayAPI
       # Offers a set of utility methods to work with Gerrit's Gitiles URLs.
       module GitilesHelper
         GITILES_PATH = '/plugins/gitiles/'
-        GITILES_REFSPEC = '/+/%<refspec>s/'
+        GITILES_REFSPEC = '/+/%<refspec>s'
 
         # Returns a Gitiles URL for the given parameters
         # @param [String] repository The URL of the git repository.
-        # @param [String] refspec The name of a branch or the SHA1 of a particular
-        #   commit.
-        # @param [String] path The path to the source file.
-        # @param [Integer, String] line_number The line number
+        # @param [String] refspec The name of a branch or the SHA1 of a
+        #   particular commit.
+        # @param [String, nil] path The path to the source file. If +nil+ is
+        #   given a link to the +refspec+ itself is will be created.
+        # @param [Integer, String, nil] line_number The line number. Ignored
+        #   when +path+ is +nil+.
         # @return [String] The corresponding Gitiles URL.
-        def gitiles_url(repository:, refspec:, path:, line_number: nil)
+        def gitiles_url(repository:, refspec:, path: nil, line_number: nil)
           # NOTE: Here File.join is being used because it takes care of cases in
           # which both strings have slash (/) at their tips and removes the double
           # slash, for example:
@@ -30,14 +32,15 @@ module JayAPI
           #
           #   URI.join('https://www.example.com/hello/world', '/again') => https://www.example.com/again
 
-          @gitiles_urls ||= {}
-          base_url = @gitiles_urls[repository] ||= translate_gerrit_url(repository)
+          fragments = [
+            gerrit_urls_cache[repository] ||= translate_gerrit_url(repository),
+            format(GITILES_REFSPEC, refspec: refspec)
+          ]
 
-          File.join(
-            base_url,
-            format(GITILES_REFSPEC, refspec: refspec),
-            [path, line_number].compact.join('#') # If there is no line number the # will not appear in the URL
-          )
+          # If there is no line number the # will not appear in the URL
+          fragments << [path, line_number].compact.join('#') if path
+
+          File.join(*fragments)
         end
 
         # Translates a Gerrit repository URL into a Gerrit Gitiles URL for that
@@ -52,6 +55,15 @@ module JayAPI
           path = uri.path.sub(%r{^/a/}, '/') # Removes the /a/ at the beginning of HTTP/S repository URLs
           URI::HTTPS.build(host: uri.host, path: File.join(GITILES_PATH, path)).to_s
         end
+
+        private
+
+        # @return [Hash{String => String}] A Hash that act as a cache for URLs
+        #   generated by #translate_gerrit_url. It is used to avoid having to
+        #   translate the same repository's URL multiple times.
+        def gerrit_urls_cache
+          @gerrit_urls_cache ||= {}
+        end
       end
     end
   end

data/lib/jay_api/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jay_api
 version: !ruby/object:Gem::Version
-  version: 27.2.1
+  version: 27.4.0
 platform: ruby
 authors:
 - Accenture-Industry X
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-03-14 00:00:00.000000000 Z
+date: 2025-04-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -139,6 +139,7 @@ files:
 - lib/jay_api/elasticsearch/query_builder/aggregations.rb
 - lib/jay_api/elasticsearch/query_builder/aggregations/aggregation.rb
 - lib/jay_api/elasticsearch/query_builder/aggregations/avg.rb
+- lib/jay_api/elasticsearch/query_builder/aggregations/cardinality.rb
 - lib/jay_api/elasticsearch/query_builder/aggregations/errors.rb
 - lib/jay_api/elasticsearch/query_builder/aggregations/errors/aggregations_error.rb
 - lib/jay_api/elasticsearch/query_builder/aggregations/filter.rb