jay_api 29.9.0 → 29.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e0a1faee742a3503bae215225c1a111f9cb21b21e94ffb83b10fcd16d14f71e1
-  data.tar.gz: b39ed836b7bef2233a3833d9b9e56f5234f4b542fd10f1a4fb7fc35b85e85e37
+  metadata.gz: 29f1af4da5bd52cd5012da50bc4933a30cd8d3d7682d4301bab18dfb429d090c
+  data.tar.gz: 86924bc855b991f2678cce3d3f023e8958f3beb725fb154429ad5667c705b78c
 SHA512:
-  metadata.gz: 4963d63c87ed8d756e94984ec635d53cb4db539e6fba42632be2ecd8f5cf79443485ededadaddf9f15988414db7e37b07b515f2d37529fcc074de8d57bf6f2f4
-  data.tar.gz: 9db8b8d9600477ded9c07058d26af30de56153717adc5cdd9dc179bd0b2893225936fbdecb2281a0d5e06859ad6797eee3554d89e3531d88d449042040f266d2
+  metadata.gz: d4401b8bea8090b4f21182689b336d65256efe4136327c23f1418aa93a88b8bd3d15c364423838b8e29709f2edc4ebae5d99953a8125bd97ae268b4a2fc2de46
+  data.tar.gz: ce39feece636e38b932e3b100f814f7ecba3fb3c7c870a6c8a7d12cbba4c24e5c9c32646b6ede2d59f86f73f434b617364b65eaf88a5722582ce9b28c54cc9ad

data/CHANGELOG.md

@@ -8,6 +8,15 @@ Please mark backwards incompatible changes with an exclamation mark at the start
 
 ## [Unreleased]
 
+## [29.10.0] - 2026-08-21
+
+### Added
+- The `JayAPI::Elasticsearch::QueryBuilder::QueryClauses::Prefix` class and the
+  corresponding `#prefix` method to the `MatchClauses` module. This allows the
+  use of Elasticsearch's
+  [prefix](https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-prefix-query.html)
+  query with the Query Builder.
+
 ## [29.9.0] - 2026-08-04
 
 ### Added

data/lib/jay_api/elasticsearch/query_builder/query_clauses/match_clauses.rb

@@ -5,6 +5,7 @@ require_relative 'ids'
 require_relative 'match_all'
 require_relative 'match_none'
 require_relative 'match_phrase'
+require_relative 'prefix'
 require_relative 'query_string'
 require_relative 'range'
 require_relative 'regexp'
@@ -31,6 +32,16 @@ module JayAPI
             self << ::JayAPI::Elasticsearch::QueryBuilder::QueryClauses::MatchPhrase.new(**params)
           end
 
+          # Adds a +JayAPI::Elasticsearch::QueryBuilder::QueryClauses::Prefix+
+          # clause to the Query Clauses set.
+          # @param [Hash] params The parameters for the +Prefix+ class.
+          # @return [self] Returns itself so that other methods can be chained.
+          # @raise [JayAPI::Elasticsearch::QueryBuilder::Errors::QueryBuilderError]
+          #   If an error occurs when trying to add the query clause to the set.
+          def prefix(**params)
+            self << ::JayAPI::Elasticsearch::QueryBuilder::QueryClauses::Prefix.new(**params)
+          end
+
           # Adds a +JayAPI::Elasticsearch::QueryBuilder::QueryClauses::QueryString+
           # clause to the Query Clauses set.
           # @param [Hash] params The parameters for the +QueryString+ class

data/lib/jay_api/elasticsearch/query_builder/query_clauses/prefix.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require_relative 'query_clause'
+
+module JayAPI
+  module Elasticsearch
+    class QueryBuilder
+      class QueryClauses
+        # Represents a +Prefix+ query in Elasticsearch
+        # More information about this type of query can be found here:
+        # https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-prefix-query.html
+        class Prefix < ::JayAPI::Elasticsearch::QueryBuilder::QueryClauses::QueryClause
+          attr_reader :field, :value
+
+          # @param [String, Symbol] field The field where the prefix query
+          #   should be applied.
+          # @param [String] value The prefix to be found in +field+
+          def initialize(field:, value:)
+            super()
+            @field = field
+            @value = value
+          end
+
+          # @return [Hash] The Hash that represents this query (in
+          #   Elasticsearch's format)
+          def to_h
+            {
+              prefix: {
+                field => {
+                  value: value
+                }
+              }
+            }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/jay_api/elasticsearch/query_results.rb

@@ -24,7 +24,8 @@ module JayAPI
       # @param [JayAPI::Elasticsearch::Indexable] index The Elasticsearch
       #   index or indexes over which the query should be performed.
       # @param [Hash] query The query that produced the results.
-      # @param [JayAPI::Elasticsearch::Results] response An object containing Docs retrieved from Elasticsearch.
+      # @param [JayAPI::Elasticsearch::Response] response An object containing
+      #   Docs retrieved from Elasticsearch.
       # @param [JayAPI::Elasticsearch::BatchCounter] batch_counter An object keeping track of the current batch.
       def initialize(index:, query:, response:, batch_counter: nil)
         @index = index

data/lib/jay_api/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jay_api
 version: !ruby/object:Gem::Version
-  version: 29.9.0
+  version: 29.10.0
 platform: ruby
 authors:
 - Accenture-Industry X
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-08-04 00:00:00.000000000 Z
+date: 2026-08-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -169,6 +169,7 @@ files:
 - lib/jay_api/elasticsearch/query_builder/query_clauses/match_none.rb
 - lib/jay_api/elasticsearch/query_builder/query_clauses/match_phrase.rb
 - lib/jay_api/elasticsearch/query_builder/query_clauses/negator.rb
+- lib/jay_api/elasticsearch/query_builder/query_clauses/prefix.rb
 - lib/jay_api/elasticsearch/query_builder/query_clauses/query_clause.rb
 - lib/jay_api/elasticsearch/query_builder/query_clauses/query_string.rb
 - lib/jay_api/elasticsearch/query_builder/query_clauses/range.rb