jay_api 29.3.1 → 29.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c4dc3e0a1c55fc4d24d117a2c24f415dfcd4d481c41bcc698ab22b9680b2c1ff
-  data.tar.gz: b8402e498357724ad86f0516d82e937049176cdb54476c49dab03bf7a941ce15
+  metadata.gz: 03ef39a19b2ff79bf0aea18958f4c0ea7d2b77f87f502c85fbaa793dc191af29
+  data.tar.gz: 5abb8d21871415133f2d95cab6090b2ee8d224d7056349dbf2b667873d3ea257
 SHA512:
-  metadata.gz: 77770aca2b7203de9a0e76c5293b21db21ff4f6fb13c4f02f19b3cd3740af58033aacf82f24131b2ed2aa20a1bfec22c9d29d837735fd5ad40081a5642e82e95
-  data.tar.gz: fbe4d05866d4b6f8b41a3b1ca1a458c22f59352d748619b459b20518a476fc4811ff11253b456c00b13787d8a47f38f4868b914a786ef8a3033f0bef6ca413a0
+  metadata.gz: aceb3ee3bc16cee43009c8c48e079f31eed730be5ae560c1974d660dd5ac4a385648cb329a9ef9d191f0ae2358915fd311fe0d81a1ddcd5ecac8ac806ae7a17d
+  data.tar.gz: cf762fbc558af858e560a83b4bcbc57574ac9ab0ffecb7fdbebb51254008550079a4f36beec32e19ea7b58e4187ae69f06e4e1c48e8ff1aae5835691e12b6072

data/CHANGELOG.md

@@ -8,6 +8,14 @@ Please mark backwards incompatible changes with an exclamation mark at the start
 
 ## [Unreleased]
 
+## [29.4.0] - 2026-01-28
+
+### Added
+- Support for the `bucket_selector` pipeline aggregation in
+  `Elasticsearch::QueryBuilder::Aggregations`. This allows filtering
+  buckets based on computed metrics (e.g., filtering terms buckets by
+  aggregated values).
+
 ## [29.3.1] - 2025-12-15
 
 ### Fixed
@@ -35,7 +43,7 @@ Please mark backwards incompatible changes with an exclamation mark at the start
   allows boolean clauses to be nested.
 - `QueryBuilder#sort` can now receive either the direction of the sorting (`asc`
   or `desc`) or a `Hash` with advanced sorting options. These are relayed
-  directly to Elasticsearch. 
+  directly to Elasticsearch.
 
 ## [29.0.0] - 2025-08-28
 

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

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+require_relative 'aggregation'
+
+module JayAPI
+  module Elasticsearch
+    class QueryBuilder
+      class Aggregations
+        # Represents a +bucket_selector+ pipeline aggregation in Elasticsearch.
+        # Docs:
+        # https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-bucket-selector-aggregation.html
+        class BucketSelector < ::JayAPI::Elasticsearch::QueryBuilder::Aggregations::Aggregation
+          attr_reader :buckets_path, :script, :gap_policy
+
+          # @param [String] name The name used by Elasticsearch to identify the
+          #   aggregation.
+          # @param [Hash] buckets_path Path(s) to the metric or metrics
+          #   over which the bucket_selector aggregation's script will operate.
+          #   The keys are the names of the script variables, the values the
+          #   paths to the metrics (relative to the parent aggregation).
+          #   The script will receive these variables in its +params+.
+          # @param [JayAPI::Elasticsearch::QueryBuilder::Script] script
+          #   Script used to decide whether to keep each bucket.
+          # @param [String, nil] gap_policy Optional gap policy (e.g. "skip",
+          #   "insert_zeros").
+          def initialize(name, buckets_path:, script:, gap_policy: nil)
+            super(name)
+
+            @buckets_path = buckets_path
+            @script       = script
+            @gap_policy   = gap_policy
+          end
+
+          # Bucket selector is a pipeline agg and cannot have nested aggregations.
+          # @raise [JayAPI::Elasticsearch::QueryBuilder::Aggregations::Errors::AggregationsError]
+          def aggs
+            no_nested_aggregations('Bucket Selector')
+          end
+
+          # @return [self] A copy of the receiver.
+          def clone
+            self.class.new(
+              name,
+              buckets_path: buckets_path.is_a?(Hash) ? buckets_path.dup : buckets_path,
+              script:, # Script is immutable-ish, ok to reuse
+              gap_policy:
+            )
+          end
+
+          # @return [Hash] The Hash representation of the +Aggregation+.
+          #   Properly formatted for Elasticsearch.
+          def to_h
+            super do
+              {
+                bucket_selector: {
+                  buckets_path: buckets_path,
+                  script: script.to_h,
+                  gap_policy: gap_policy
+                }.compact
+              }
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -9,6 +9,7 @@ require_relative 'aggregations/composite'
 require_relative 'aggregations/date_histogram'
 require_relative 'aggregations/filter'
 require_relative 'aggregations/scripted_metric'
+require_relative 'aggregations/bucket_selector'
 require_relative 'aggregations/sum'
 require_relative 'aggregations/max'
 require_relative 'aggregations/terms'
@@ -86,6 +87,16 @@ module JayAPI
           )
         end
 
+        # Adds an +bucket_selector+ type aggregation. For information about the parameters
+        # @see JayAPI::Elasticsearch::QueryBuilder::Aggregations::BucketSelector#initialize
+        def bucket_selector(name, buckets_path:, script:, gap_policy: nil)
+          add(
+            ::JayAPI::Elasticsearch::QueryBuilder::Aggregations::BucketSelector.new(
+              name, buckets_path:, script:, gap_policy:
+            )
+          )
+        end
+
         # Adds a +max+ type aggregation. For information about the parameters
         # @see JayAPI::Elasticsearch::QueryBuilder::Aggregations::Max#initialize
         def max(name, field:)

data/lib/jay_api/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jay_api
 version: !ruby/object:Gem::Version
-  version: 29.3.1
+  version: 29.4.0
 platform: ruby
 authors:
 - Accenture-Industry X
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-12-15 00:00:00.000000000 Z
+date: 2026-01-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -135,6 +135,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/bucket_selector.rb
 - lib/jay_api/elasticsearch/query_builder/aggregations/cardinality.rb
 - lib/jay_api/elasticsearch/query_builder/aggregations/composite.rb
 - lib/jay_api/elasticsearch/query_builder/aggregations/date_histogram.rb