jay_api 27.1.0 → 27.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 773086b4ced206a7ccecba655665b5d525fc68f0552c5be72abdfa3eb07d5585
-  data.tar.gz: aecb7f4b0af0a692bbc0b2ab95ea7184e5d743a1f10d268c769d8d8d9f781453
+  metadata.gz: 3314debaa7f484d22d094d74cc7a8af9b14b3a1e08e52f95cece7b8e1b73cc14
+  data.tar.gz: 6535032e2b1ddb1b3e3b8f7cffff77e28e5c107c93832f9b6d93f720e663c858
 SHA512:
-  metadata.gz: 7897a7adddd0b69691fdf513dac2dcb2a92a1cc4f47fee243da4e9325587ff00aa78d167bd93df728e13eab3955af58224c45103903c5aa256eed7267705819a
-  data.tar.gz: e7e7e6aa94c21d4e69ed7e586da6910dd5048531a68c3613b68d738fb1dcd69bc0c52ef1958e7ac28e95abcfd1fd6d742e2e4aef42b97f55f683db58354a85e8
+  metadata.gz: 4c7a1d9da9204610f5b1be328b225132690c370128bf8c35d91f765e7bd08f0a8d3b136c77adfda22cf181441fec1ba274dad0ad1570482ac78d452862146fbd
+  data.tar.gz: 4e5edc12ed9541991f3effd901c4c188893664ba89aebcb439b49bfc2291a97cc72ebc8781e4c984826c5d62ca2c3e53e8d4b199658f527e6b3c95f1eb34699c

data/CHANGELOG.md

@@ -8,6 +8,12 @@ Please mark backwards incompatible changes with an exclamation mark at the start
 
 ## [Unreleased]
 
+## [27.2.0] - 2025-02-28
+
+### Added
+- `QueryBuilder#source` can now take `false`, `Array` and `Hash` in addition to
+  simple strings.
+
 ## [27.1.0] - 2025-02-19
 
 ### Added

data/lib/jay_api/elasticsearch/errors.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require_relative 'errors/elasticsearch_error'
+require_relative 'errors/end_of_query_results_error'
+require_relative 'errors/query_execution_error'
+require_relative 'errors/query_execution_failure'
+require_relative 'errors/query_execution_timeout'
+require_relative 'errors/search_after_error'
+
+module JayAPI
+  module Elasticsearch
+    # Namespace for all error classes related to Elasticsearch
+    module Errors; end
+  end
+end

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

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require_relative 'errors/query_builder_error'
+
+module JayAPI
+  module Elasticsearch
+    class QueryBuilder
+      # Namespace for the error classes related to the QueryBuilder
+      module Errors; end
+    end
+  end
+end

data/lib/jay_api/elasticsearch/query_builder.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative 'query_builder/aggregations'
+require_relative 'query_builder/errors'
 require_relative 'query_builder/query_clauses'
 require_relative 'query_builder/script'
 
@@ -83,10 +84,13 @@ module JayAPI
       end
 
       # Adds a +_source+ clause to the query.
-      # @param [String] filter_expr Expression used for filtering source.
+      # @param [FalseClass, String, Array<String>, Hash] filter_expr Expression
+      #   used for source filtering.
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/search-fields.html#source-filtering
+      #   For more information on what kind of expressions are allowed.
       # @return [QueryBuilder] itself so that other methods can be chained.
       def source(filter_expr)
-        check_argument(filter_expr, 'source', String)
+        check_argument(filter_expr, 'source', FalseClass, String, Array, Hash)
         @source = filter_expr
         self
       end
@@ -149,12 +153,15 @@ module JayAPI
       # @param [Object] value The value of the argument.
       # @param [String] argument_name The name of the argument (for the error
       #   message).
-      # @param [Class] expected_type The expected type of +value+
-      # @raise [ArgumentError] If the value is not an instance of the class.
-      def check_argument(value, argument_name, expected_type)
-        return if value.is_a?(expected_type)
-
-        raise ArgumentError, "Expected `#{argument_name}` to be #{expected_type}, #{value.class} given"
+      # @param [Class, Array<Class>] allowed_types The list of classes that
+      #   +value+ might have.
+      # @raise [ArgumentError] If the value is not an instance of the any of the
+      #   classes in +allowed_types+.
+      def check_argument(value, argument_name, *allowed_types)
+        return if allowed_types.any? { |allowed_type| value.is_a?(allowed_type) }
+
+        raise ArgumentError, "Expected `#{argument_name}` to be one of: " \
+                             "#{allowed_types.map(&:to_s).join(', ')} but #{value.class} was given"
       end
 
       # Checks that the given argument is positive (>= 0)
@@ -174,7 +181,7 @@ module JayAPI
         query_hash = {}
         query_hash[:from] = @from if @from
         query_hash[:size] = @size if @size
-        query_hash[:_source] = @source if @source
+        query_hash[:_source] = @source unless @source.nil?
         query_hash[:query] = query.to_h
 
         if @sort.any?

data/lib/jay_api/elasticsearch.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require_relative 'elasticsearch/async'
+require_relative 'elasticsearch/batch_counter'
+require_relative 'elasticsearch/client'
+require_relative 'elasticsearch/client_factory'
+require_relative 'elasticsearch/errors'
+require_relative 'elasticsearch/index'
+require_relative 'elasticsearch/query_builder'
+require_relative 'elasticsearch/query_results'
+require_relative 'elasticsearch/response'
+require_relative 'elasticsearch/search_after_results'
+require_relative 'elasticsearch/tasks'
+require_relative 'elasticsearch/time'
+
+module JayAPI
+  # Namespace for all Elasticsearch related classes.
+  module Elasticsearch; end
+end

data/lib/jay_api/version.rb

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

data/lib/jay_api.rb

@@ -3,6 +3,7 @@
 require 'jay_api/version'
 
 require_relative 'jay_api/rspec'
+require_relative 'jay_api/elasticsearch'
 
 # Top-level namespace for the Gem
 module JayAPI

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jay_api
 version: !ruby/object:Gem::Version
-  version: 27.1.0
+  version: 27.2.0
 platform: ruby
 authors:
 - Accenture-Industry X
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-02-19 00:00:00.000000000 Z
+date: 2025-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -122,10 +122,12 @@ files:
 - lib/jay_api/abstract/geometric_wait.rb
 - lib/jay_api/abstract/wait_strategy.rb
 - lib/jay_api/configuration.rb
+- lib/jay_api/elasticsearch.rb
 - lib/jay_api/elasticsearch/async.rb
 - lib/jay_api/elasticsearch/batch_counter.rb
 - lib/jay_api/elasticsearch/client.rb
 - lib/jay_api/elasticsearch/client_factory.rb
+- lib/jay_api/elasticsearch/errors.rb
 - lib/jay_api/elasticsearch/errors/elasticsearch_error.rb
 - lib/jay_api/elasticsearch/errors/end_of_query_results_error.rb
 - lib/jay_api/elasticsearch/errors/query_execution_error.rb
@@ -146,6 +148,7 @@ files:
 - lib/jay_api/elasticsearch/query_builder/aggregations/terms.rb
 - lib/jay_api/elasticsearch/query_builder/aggregations/top_hits.rb
 - lib/jay_api/elasticsearch/query_builder/aggregations/value_count.rb
+- lib/jay_api/elasticsearch/query_builder/errors.rb
 - lib/jay_api/elasticsearch/query_builder/errors/query_builder_error.rb
 - lib/jay_api/elasticsearch/query_builder/query_clauses.rb
 - lib/jay_api/elasticsearch/query_builder/query_clauses/bool.rb