jay_api 27.1.0

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

@@ -0,0 +1,179 @@
+# frozen_string_literal: true
+
+require_relative '../errors/query_builder_error'
+require_relative 'query_clause'
+require_relative 'match_clauses'
+
+module JayAPI
+  module Elasticsearch
+    class QueryBuilder
+      class QueryClauses
+        # Represents an Elasticsearch boolean query clause. For more information
+        # about this type of clause check: https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-bool-query.html
+        class Bool < JayAPI::Elasticsearch::QueryBuilder::QueryClauses::QueryClause
+          include ::JayAPI::Elasticsearch::QueryBuilder::QueryClauses::MatchClauses
+
+          def initialize
+            @query_clauses = {}
+          end
+
+          # Adds a +must+ clause to the +bool+ clause.
+          # @yield [JayAPI::Elasticsearch::QueryBuilder::QueryClauses::Bool]
+          #   Yields itself if a block is given.
+          # @return [JayAPI::Elasticsearch::QueryBuilder::QueryClauses::Bool]
+          #   Returns itself so that other methods can be chained.
+          # @raise [JayAPI::Elasticsearch::QueryBuilder::Errors::QueryBuilderError]
+          #   If no boolean clause currently exists.
+          def must(&block)
+            add_boolean_clause(:must, &block)
+          end
+
+          # Adds a +filter+ clause to an already existing +bool+ clause.
+          # @yield [JayAPI::Elasticsearch::QueryBuilder::QueryClauses::Bool]
+          #   Yields itself if a block is given.
+          # @return [JayAPI::Elasticsearch::QueryBuilder::QueryClauses::Bool]
+          #   Returns itself so that other methods can be chained.
+          # @raise [JayAPI::Elasticsearch::QueryBuilder::Errors::QueryBuilderError]
+          #   If no boolean clause currently exists.
+          def filter(&block)
+            add_boolean_clause(:filter, &block)
+          end
+
+          # Adds a +should+ clause to an already existing +bool+ clause.
+          # @yield [JayAPI::Elasticsearch::QueryBuilder::QueryClauses::Bool]
+          #   Yields itself if a block is given.
+          # @return [JayAPI::Elasticsearch::QueryBuilder::QueryClauses::Bool]
+          #   Returns itself so that other methods can be chained.
+          # @raise [JayAPI::Elasticsearch::QueryBuilder::Errors::QueryBuilderError]
+          #   If no boolean clause currently exists.
+          def should(&block)
+            add_boolean_clause(:should, &block)
+          end
+
+          # Adds a +must_not+ clause to an already existing +bool+ clause.
+          # @yield [JayAPI::Elasticsearch::QueryBuilder::QueryClauses::Bool]
+          #   Yields itself if a block is given.
+          # @return [JayAPI::Elasticsearch::QueryBuilder::QueryClauses::Bool]
+          #   Returns itself so that other methods can be chained.
+          # @raise [JayAPI::Elasticsearch::QueryBuilder::Errors::QueryBuilderError]
+          #   If no boolean clause currently exists.
+          def must_not(&block)
+            add_boolean_clause(:must_not, &block)
+          end
+
+          # Adds a clause to the current sub-clause of the boolean clause.
+          # @param [JayAPI::Elasticsearch::QueryBuilder::QueryClauses::QueryClause]
+          #   query_clause The query clause to add.
+          # @return [JayAPI::Elasticsearch::QueryBuilder::QueryClauses::Bool]
+          #   Returns itself so that other methods can be chained.
+          # @raise [JayAPI::Elasticsearch::QueryBuilder::Errors::QueryBuilderError]
+          #   If no boolean sub-clause has been defined.
+          def <<(query_clause)
+            unless current_bool
+              raise ::JayAPI::Elasticsearch::QueryBuilder::Errors::QueryBuilderError,
+                    'Please call #must, #filter, #should or #must_not in order ' \
+                    'to add query clauses inside a boolean clause'
+            end
+
+            current_bool << query_clause
+            self
+          end
+
+          # @return [Hash] The Hash representation of the Query Clause
+          def to_h
+            unless query_clauses.any?
+              raise ::JayAPI::Elasticsearch::QueryBuilder::Errors::QueryBuilderError,
+                    'A boolean clause has been defined but no boolean sub-clauses were added'
+            end
+
+            unless query_clauses.values.all?(&:any?)
+              raise ::JayAPI::Elasticsearch::QueryBuilder::Errors::QueryBuilderError,
+                    'A boolean clause and a sub-clause were defined but no match clauses were added'
+            end
+
+            {
+              bool: query_clauses.transform_values { |value| value.map(&:to_h) }
+            }
+          end
+
+          # @return [self] A copy of the receiver and all match clauses attached
+          #   to it.
+          def clone
+            self.class.new.tap do |copy|
+              copy.query_clauses = query_clauses.transform_values do |array|
+                array.map(&:clone)
+              end
+            end
+          end
+
+          # @param [Other] other Another +QueryClause+ object.
+          # @return [self] The receiver, after having merged the given
+          #   +QueryClause+ into itself.
+          def merge!(other)
+            if other.is_a?(self.class)
+              merge_clauses(other)
+            elsif other.is_a?(self.class.superclass)
+              must << other.clone
+            else
+              raise_cannot_merge_error(other)
+            end
+
+            self
+          end
+
+          # @param [Other] other Another +QueryClause+ object.
+          # @return [self] A new instance of the class with the merging of the
+          #   receiver abd the given +QueryClause+ object.
+          def merge(other)
+            # This +if+ prevents the creation of a clone (which can be costly)
+            # only for an +ArgumentError+ to be raised when +#merge!+ is called.
+            if [self.class, self.class.superclass].any? { |klass| other.is_a?(klass) }
+              clone.merge!(other)
+            else
+              raise_cannot_merge_error(other)
+            end
+          end
+
+          protected
+
+          attr_accessor :query_clauses # Used by #clone
+
+          private
+
+          attr_reader :current_bool
+
+          # Adds the given +bool+ sub-clause
+          # @param [Symbol] clause_type The type of clause to add (one of +must+,
+          #   +filter+, +should+ or +must_not+)
+          # @yield [JayAPI::Elasticsearch::QueryBuilder::QueryClauses::Bool]
+          #   Yields itself if a block is given.
+          # @return [JayAPI::Elasticsearch::QueryBuilder::QueryClauses::Bool]
+          #   Returns itself so that other methods can be chained.
+          def add_boolean_clause(clause_type, &block)
+            @current_bool = query_clauses[clause_type] ||= []
+            yield self if block
+            self
+          end
+
+          # Merges the boolean clauses of the given +Bool+ into the query
+          # clauses of the receiver. Producing a union of both.
+          # @param [self] other Another instance of the class.
+          def merge_clauses(other)
+            all_clauses = query_clauses.keys.union(other.query_clauses.keys)
+            all_clauses.each do |clause|
+              others_clauses = other.query_clauses.fetch(clause, [])
+
+              query_clauses[clause] ||= []
+              query_clauses[clause] += others_clauses.map(&:clone)
+            end
+          end
+
+          # @raise [ArgumentError] Is always raised with the appropriate error message.
+          def raise_cannot_merge_error(other)
+            raise ArgumentError, "Cannot merge #{self.class} with #{other.class}"
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require_relative 'query_clause'
+
+module JayAPI
+  module Elasticsearch
+    class QueryBuilder
+      class QueryClauses
+        # Represents an +Exists+ query
+        # Documentation for this type of query can be found here:
+        # https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-exists-query.html
+        class Exists < ::JayAPI::Elasticsearch::QueryBuilder::QueryClauses::QueryClause
+          attr_reader :field
+
+          # @param [String, Symbol] field The name of the field.
+          def initialize(field:)
+            @field = field
+          end
+
+          # @return [Hash] The Hash representation of the Query Clause (in
+          #   Elasticsearch's format)
+          def to_h
+            {
+              exists: {
+                field: field
+              }
+            }
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require_relative 'query_clause'
+
+module JayAPI
+  module Elasticsearch
+    class QueryBuilder
+      class QueryClauses
+        # Represents a +match_all+ query
+        # Documentation for this type of query can be found here:
+        # https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-match-all-query.html
+        class MatchAll < QueryClause
+          # @return [Hash] The Hash representation of the Query Clause (in
+          #   Elasticsearch's format)
+          def to_h
+            { match_all: {} }
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,140 @@
+# frozen_string_literal: true
+
+require_relative 'exists'
+require_relative 'match_all'
+require_relative 'match_none'
+require_relative 'match_phrase'
+require_relative 'query_string'
+require_relative 'range'
+require_relative 'regexp'
+require_relative 'term'
+require_relative 'terms'
+require_relative 'wildcard'
+
+module JayAPI
+  module Elasticsearch
+    class QueryBuilder
+      class QueryClauses
+        # Provides an easy interface to add query clauses to objects that behave
+        # like query clauses sets.
+        # @see JayAPI::Elasticsearch::QueryBuilder::QueryClauses
+        # @see JayAPI::Elasticsearch::QueryBuilder::QueryClauses::Bool
+        module MatchClauses
+          # Adds a +JayAPI::Elasticsearch::QueryBuilder::QueryClauses::MatchPhrase+
+          # clause to the Query Clauses set.
+          # @param [Hash] params The parameters for the +MatchPhrase+ 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 match_phrase(**params)
+            self << ::JayAPI::Elasticsearch::QueryBuilder::QueryClauses::MatchPhrase.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
+          #   constructor.
+          # @see JayAPI::Elasticsearch::QueryBuilder::QueryClauses::QueryString#initialize
+          # @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 query_string(**params)
+            self << ::JayAPI::Elasticsearch::QueryBuilder::QueryClauses::QueryString.new(**params)
+          end
+
+          # Adds a +JayAPI::Elasticsearch::QueryBuilder::QueryClauses::Wildcard+
+          # clause to the Query Clauses set.
+          # @param [Hash] params The parameters for the +Wildcard+ class
+          #   constructor.
+          # @see JayAPI::Elasticsearch::QueryBuilder::QueryClauses::Wildcard#initialize
+          # @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 wildcard(**params)
+            self << ::JayAPI::Elasticsearch::QueryBuilder::QueryClauses::Wildcard.new(**params)
+          end
+
+          # Adds a +JayAPI::Elasticsearch::QueryBuilder::QueryClauses::Exists+
+          # clause to the Query Clauses set.
+          # @param [Hash] params The parameters for the +Exists+ class'
+          #   constructor.
+          # @see JayAPI::Elasticsearch::QueryBuilder::QueryClauses::Exists#initialize
+          # @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 exists(**params)
+            self << ::JayAPI::Elasticsearch::QueryBuilder::QueryClauses::Exists.new(**params)
+          end
+
+          # Adds a +JayAPI::Elasticsearch::QueryBuilder::QueryClauses::Term+
+          # clause to the Query Clauses set.
+          # @param [Hash] params The parameters for the +Term+ class'
+          #   constructor.
+          # @see JayAPI::Elasticsearch::QueryBuilder::QueryClauses::Term#initialize
+          # @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 term(**params)
+            self << ::JayAPI::Elasticsearch::QueryBuilder::QueryClauses::Term.new(**params)
+          end
+
+          # Adds a +JayAPI::Elasticsearch::QueryBuilder::QueryClauses::Range+
+          # clause to the Query Clauses set.
+          # @param [Hash] params The parameters for the +Range+ class'
+          #   constructor.
+          # @see JayAPI::Elasticsearch::QueryBuilder::QueryClauses::Rang#initialize
+          # @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.
+          # @raise [ArgumentError] If there are any issues with the parameters
+          #   passed down to the +Range+ class's constructor.
+          def range(**params)
+            self << ::JayAPI::Elasticsearch::QueryBuilder::QueryClauses::Range.new(**params)
+          end
+
+          # Adds a +JayAPI::Elasticsearch::QueryBuilder::QueryClauses::Terms+
+          # clause to the Query Clauses set.
+          # @param [Hash] params The parameters for the +Terms+ class'
+          #   constructor.
+          # @see JayAPI::Elasticsearch::QueryBuilder::QueryClauses::Terms#initialize
+          # @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 terms(**params)
+            self << ::JayAPI::Elasticsearch::QueryBuilder::QueryClauses::Terms.new(**params)
+          end
+
+          # Adds a +JayAPI::Elasticsearch::QueryBuilder::QueryClauses::Regexp+
+          # clause to the Query Clauses set.
+          # @param [Hash] params The parameters for the +Regexp+ class'
+          #   constructor.
+          # @see JayAPI::Elasticsearch::QueryBuilder::QueryClauses::Regexp#initialize
+          # @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 regexp(**params)
+            self << ::JayAPI::Elasticsearch::QueryBuilder::QueryClauses::Regexp.new(**params)
+          end
+
+          # Adds a +JayAPI::Elasticsearch::QueryBuilder::QueryClauses::MatchAll+
+          # clause to the Query Clauses set.
+          # @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 match_all
+            self << ::JayAPI::Elasticsearch::QueryBuilder::QueryClauses::MatchAll.new
+          end
+
+          # Adds a +JayAPI::Elasticsearch::QueryBuilder::QueryClauses::MatchNone+
+          # clause to the Query Clauses set.
+          # @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 match_none
+            self << ::JayAPI::Elasticsearch::QueryBuilder::QueryClauses::MatchNone.new
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require_relative 'query_clause'
+
+module JayAPI
+  module Elasticsearch
+    class QueryBuilder
+      class QueryClauses
+        # Represents a +match_none+ query
+        # Documentation for this type of query can be found here:
+        # https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-match-all-query.html#query-dsl-match-none-query
+        class MatchNone < QueryClause
+          # @return [Hash] The Hash representation of the Query Clause (in
+          #   Elasticsearch's format)
+          def to_h
+            { match_none: {} }
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require_relative 'query_clause'
+
+module JayAPI
+  module Elasticsearch
+    class QueryBuilder
+      class QueryClauses
+        # Represents a Match Phrase query in Elasticsearch
+        # Documentation for this type of query can be found here:
+        # https://www.elastic.co/guide/en/elasticsearch/reference/7.9/query-dsl-match-query-phrase.html#query-dsl-match-query-phrase
+        class MatchPhrase < ::JayAPI::Elasticsearch::QueryBuilder::QueryClauses::QueryClause
+          attr_reader :field, :phrase
+
+          # @param [String] field The name of the field to match against
+          # @param [String] phrase The phrase to match
+          def initialize(field:, phrase:)
+            @field = field
+            @phrase = phrase
+          end
+
+          # @return [Hash] The Hash representation of the Query Clause (in
+          #   Elasticsearch's format)
+          def to_h
+            {
+              match_phrase: {
+                field => phrase
+              }
+            }
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require_relative 'bool'
+require_relative 'match_all'
+require_relative 'match_none'
+
+module JayAPI
+  module Elasticsearch
+    class QueryBuilder
+      class QueryClauses
+        # A class capable of negating any QueryClause object
+        class Negator
+          # A mapping between QueryClause classes and their corresponding inverse
+          # clauses. Only some of the clauses can be directly inverted.
+          INVERSE_CLAUSES = {
+            ::JayAPI::Elasticsearch::QueryBuilder::QueryClauses::MatchAll =>
+              ::JayAPI::Elasticsearch::QueryBuilder::QueryClauses::MatchNone,
+            ::JayAPI::Elasticsearch::QueryBuilder::QueryClauses::MatchNone =>
+              ::JayAPI::Elasticsearch::QueryBuilder::QueryClauses::MatchAll
+          }.freeze
+
+          attr_reader :query_clause
+
+          # @param [JayAPI::Elasticsearch::QueryBuilder::QueryClauses::QueryClause] query_clause
+          #   The +QueryClause+ to negate.
+          def initialize(query_clause)
+            @query_clause = query_clause
+          end
+
+          # @return [JayAPI::Elasticsearch::QueryBuilder::QueryClauses::QueryClause]
+          #   The negated version of the given +QueryClause+
+          def negate
+            @negate ||= INVERSE_CLAUSES[query_clause.class]&.new ||
+                        ::JayAPI::Elasticsearch::QueryBuilder::QueryClauses::Bool.new.must_not do |bool_query|
+                          bool_query << query_clause
+                        end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module JayAPI
+  module Elasticsearch
+    class QueryBuilder
+      class QueryClauses
+        # This is the base class for all the query types that Elasticsearch can
+        # handle. See the subclasses for info on each of the query types.
+        class QueryClause
+          def to_h
+            raise NotImplementedError, "Please implement the #to_h method in the #{self.class} class"
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require 'active_support'
+require 'active_support/core_ext/array'
+
+require_relative 'query_clause'
+
+module JayAPI
+  module Elasticsearch
+    class QueryBuilder
+      class QueryClauses
+        # Represents a Query String query in Elasticsearch
+        # Documentation for this type of query can be found here:
+        # https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-query-string-query.html
+        class QueryString < ::JayAPI::Elasticsearch::QueryBuilder::QueryClauses::QueryClause
+          attr_reader :fields, :query
+
+          # @param [String, Array<String>] fields The field or fields to search
+          #   into.
+          # @param [String] query The query string
+          def initialize(query:, fields: nil)
+            @fields = fields ? Array.wrap(fields) : nil
+            @query = query
+          end
+
+          # @return [Hash] The Hash that represents this query (in
+          #   Elasticsearch's format)
+          def to_h
+            {
+              query_string: {
+                query: query
+              }.merge(fields_attribute)
+            }
+          end
+
+          private
+
+          # @return [Hash] A Hash with the +fields+ attribute for the
+          #   +query_string+ clause or an empty array if no +fields+ were
+          #   specified during initialization.
+          def fields_attribute
+            return {} unless fields
+
+            { fields: fields }
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require_relative 'query_clause'
+
+module JayAPI
+  module Elasticsearch
+    class QueryBuilder
+      class QueryClauses
+        # Represents a +Range+ 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-range-query.html
+        class Range < ::JayAPI::Elasticsearch::QueryBuilder::QueryClauses::QueryClause
+          VALID_PARAMS = %i[gt gte lt lte].freeze
+
+          attr_reader :field, :params
+
+          # @param [Hash] params A hash with parameters for the class.
+          # @option params [String, Symbol] :field The field where the range
+          #   query should be applied.
+          # @option params [String, Numeric] :gt Greater than
+          # @option params [String, Numeric] :gte Greater than or equal
+          # @option params [String, Numeric] :lt Less than
+          # @option params [String, Numeric] :lte Less than or equal
+          def initialize(params)
+            @field = params.delete(:field) || raise(ArgumentError, "Missing required key 'field'")
+
+            invalid_keys = params.keys - VALID_PARAMS
+            raise ArgumentError, "Invalid keys: #{invalid_keys.join(', ')}" if invalid_keys.any?
+
+            params = params.compact
+            raise ArgumentError, "At least one of #{VALID_PARAMS.join(', ')} should be given" unless params.any?
+
+            @params = params
+          end
+
+          # @return [Hash] The Hash that represents this query (in
+          #   Elasticsearch's format)
+          def to_h
+            {
+              range: {
+                field => params
+              }
+            }
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require_relative 'query_clause'
+
+module JayAPI
+  module Elasticsearch
+    class QueryBuilder
+      class QueryClauses
+        # Represents a +Regexp+ 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-regexp-query.html
+        class Regexp < ::JayAPI::Elasticsearch::QueryBuilder::QueryClauses::QueryClause
+          attr_reader :field, :value
+
+          # @param [String, Symbol] field The field where the regexp query
+          #   should be applied.
+          # @param [String, Regexp] value Terms 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
+            {
+              regexp: {
+                field => {
+                  value: value
+                }
+              }
+            }
+          end
+        end
+      end
+    end
+  end
+end

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

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