jay_api 27.4.0 → 27.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5a6edc53b541759520ecc03ea41bd03119d4c89aca3967d6a108d7b4329d31ac
-  data.tar.gz: 576525ff4b4a470f1b81839990344837f6907bd3d0e54acd9dab7ccff7090dce
+  metadata.gz: 0023753053e15b7b8982ebe074f705a6fd2ff103c4088b5913a961fe113e010d
+  data.tar.gz: 978121f009ece07730bcb0821d21f3ad5798caaf9589a446a31f02e5e25897e3
 SHA512:
-  metadata.gz: 54bf37bfd8b82a8337645a8064b2cc82707d8c985816646ae23774b917676b7a79642710420dba680cb163491fb8035eaed603ac22c86410c63e43907805a14d
-  data.tar.gz: 4525bc1fb75c38f6e741e245757e3261c9bf4a0981d1e65da3756c65f24610ac66d25480a6d842f54c5c9097fad6612e05736310226466ddd783df13b142266f
+  metadata.gz: f7ca59c3d9de98e6e3887afd0cae27959703ebf4c213335142dccd6532ed2342f895f15de1deed4c9b73ca910e161293c56bf41e90c45673213ba72b63be3dab
+  data.tar.gz: a53fc7870322d03b7fd986c3598a3c7e629253a8ebf142006b7ea713f161eed71d752ee02c77e1714ca89ab552de91196baaa7745a483980536338cdd6ebd059

data/CHANGELOG.md

@@ -8,6 +8,13 @@ Please mark backwards incompatible changes with an exclamation mark at the start
 
 ## [Unreleased]
 
+## [27.5.0] - 2025-04-22
+
+### Added
+- The `Aggregations::DateHistogram` class and the `Aggregations#date_histogram`
+  method. They make it possible to use Elasticsearch's `date_histogram`
+  aggregations.
+
 ## [27.4.0] - 2025-04-10
 
 ### Added

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

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module JayAPI
+  module Elasticsearch
+    class QueryBuilder
+      class Aggregations
+        # Represents a +date_histogram+ aggregation in Elasticsearch.
+        # Information about this type of aggregation can be found in:
+        # https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-datehistogram-aggregation
+        class DateHistogram < ::JayAPI::Elasticsearch::QueryBuilder::Aggregations::Aggregation
+          attr_reader :field, :calendar_interval, :format
+
+          # @param [String] name The name used by Elasticsearch to identify each
+          #   of the aggregations.
+          # @param [String] field The field over which the date histogram should
+          #   be performed. This field **MUST** be a date or date range field.
+          # @param [String] calendar_interval The interval that should be used
+          #   for the histogram. For a list of accepted intervals check the
+          #   aggregation's documentation. This **must** be a single calendar
+          #   unit. I.e. +1d+ is accepted but +2d+ is not.
+          # @param [String] format The format in which the date interval keys
+          #   should be represented. For information on what this format can be
+          #   check the aggregation's documentation.
+          def initialize(name, field:, calendar_interval:, format: nil)
+            @field = field
+            @calendar_interval = calendar_interval
+            @format = format
+            super(name)
+          end
+
+          # @return [self] A copy of the receiver.
+          def clone
+            self.class.new(name, field: field, calendar_interval: calendar_interval, format: format).tap do |copy|
+              copy.aggregations = aggregations.clone
+            end
+          end
+
+          # @return [Hash] The Hash representation of the +Aggregation+.
+          #   Properly formatted for Elasticsearch.
+          def to_h(&block)
+            super do
+              {
+                date_histogram: {
+                  field: field,
+                  calendar_interval: calendar_interval,
+                  format: format
+                }.compact
+              }
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -13,7 +13,7 @@ module JayAPI
       class Aggregations
         # Represents a +filter+ aggregation in Elasticsearch.
         # Information on this type of aggregation can be found here:
-        # https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-filter-aggregation.html
+        # https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-top-hits-aggregation
         class TopHits < ::JayAPI::Elasticsearch::QueryBuilder::Aggregations::Aggregation
           attr_reader :size
 

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

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

data/lib/jay_api/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jay_api
 version: !ruby/object:Gem::Version
-  version: 27.4.0
+  version: 27.5.0
 platform: ruby
 authors:
 - Accenture-Industry X
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-04-10 00:00:00.000000000 Z
+date: 2025-04-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -140,6 +140,7 @@ files:
 - 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/date_histogram.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