elastomer-client 3.2.2 → 6.2.0

data/lib/{elastomer → elastomer_client}/client/cluster.rb

@@ -1,4 +1,6 @@
-module Elastomer
+# frozen_string_literal: true
+
+module ElastomerClient
   class Client
 
     # Returns a Cluster instance.
@@ -11,9 +13,9 @@ module Elastomer
       # Create a new cluster client for making API requests that pertain to
       # the cluster health and management.
       #
-      # client - Elastomer::Client used for HTTP requests to the server
+      # client - ElastomerClient::Client used for HTTP requests to the server
       #
-      def initialize( client )
+      def initialize(client)
         @client = client
       end
 
@@ -33,7 +35,7 @@ module Elastomer
       # See https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-health.html
       #
       # Returns the response as a Hash
-      def health( params = {} )
+      def health(params = {})
         response = client.get "/_cluster/health{/index}", params.merge(action: "cluster.health", rest_api: "cluster.health")
         response.body
       end
@@ -51,7 +53,7 @@ module Elastomer
       # See https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-state.html
       #
       # Returns the response as a Hash
-      def state( params = {} )
+      def state(params = {})
         response = client.get "/_cluster/state{/metrics}{/indices}", params.merge(action: "cluster.state", rest_api: "cluster.state")
         response.body
       end
@@ -66,7 +68,7 @@ module Elastomer
       # See https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-stats.html
       #
       # Returns the response as a Hash
-      def stats( params = {} )
+      def stats(params = {})
         response = client.get "/_cluster/stats", params.merge(action: "cluster.stats", rest_api: "cluster.stats")
         response.body
       end
@@ -79,7 +81,7 @@ module Elastomer
       # See https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-pending.html
       #
       # Returns the response as a Hash
-      def pending_tasks( params = {} )
+      def pending_tasks(params = {})
         response = client.get "/_cluster/pending_tasks", params.merge(action: "cluster.pending_tasks", rest_api: "cluster.pending_tasks")
         response.body
       end
@@ -89,7 +91,7 @@ module Elastomer
       # does not contain the "tasks" field.
       def pending_tasks?
         hash = pending_tasks
-        return nil unless hash.key? "tasks"
+        return nil unless hash.key? "tasks" # rubocop:disable Style/ReturnNilInPredicateMethodDefinition
         hash["tasks"].length > 0
       end
 
@@ -100,7 +102,7 @@ module Elastomer
       # See https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-update-settings.html
       #
       # Returns the response as a Hash
-      def get_settings( params = {} )
+      def get_settings(params = {})
         response = client.get "/_cluster/settings", params.merge(action: "cluster.get_settings", rest_api: "cluster.get_settings")
         response.body
       end
@@ -116,8 +118,8 @@ module Elastomer
       # See https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-update-settings.html
       #
       # Returns the response as a Hash
-      def update_settings( body, params = {} )
-        response = client.put "/_cluster/settings", params.merge(body: body, action: "cluster.update_settings", rest_api: "cluster.put_settings")
+      def update_settings(body, params = {})
+        response = client.put "/_cluster/settings", params.merge(body:, action: "cluster.update_settings", rest_api: "cluster.put_settings")
         response.body
       end
 
@@ -146,7 +148,7 @@ module Elastomer
       # See https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-reroute.html
       #
       # Returns the response as a Hash
-      def reroute( commands, params = {} )
+      def reroute(commands, params = {})
         if commands.is_a?(Hash) && commands.key?(:commands)
           body = commands
         elsif commands.is_a?(Hash)
@@ -157,7 +159,7 @@ module Elastomer
           body = {commands: Array(commands)}
         end
 
-        response = client.post "/_cluster/reroute", params.merge(body: body, action: "cluster.reroute", rest_api: "cluster.reroute")
+        response = client.post "/_cluster/reroute", params.merge(body:, action: "cluster.reroute", rest_api: "cluster.reroute")
         response.body
       end
 
@@ -178,7 +180,7 @@ module Elastomer
       # See https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-aliases.html
       #
       # Returns the response body as a Hash
-      def get_aliases( params = {} )
+      def get_aliases(params = {})
         response = client.get "{/index}/_alias{/name}", params.merge(action: "cluster.get_aliases", rest_api: "indices.get_alias")
         response.body
       end
@@ -204,7 +206,7 @@ module Elastomer
       # See https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-aliases.html
       #
       # Returns the response body as a Hash
-      def update_aliases( actions, params = {} )
+      def update_aliases(actions, params = {})
         if actions.is_a?(Hash) && actions.key?(:actions)
           body = actions
         elsif actions.is_a?(Hash)
@@ -215,7 +217,7 @@ module Elastomer
           body = {actions: Array(actions)}
         end
 
-        response = client.post "/_aliases", params.merge(body: body, action: "cluster.update_aliases", rest_api: "indices.update_aliases")
+        response = client.post "/_aliases", params.merge(body:, action: "cluster.update_aliases", rest_api: "indices.update_aliases")
         response.body
       end
 

data/lib/{elastomer → elastomer_client}/client/delete_by_query.rb

@@ -1,13 +1,15 @@
-module Elastomer
+# frozen_string_literal: true
+
+module ElastomerClient
   class Client
     # Execute delete_by_query using the native _delete_by_query API if supported
     # or the application-level implementation.
     #
     # Warning: These implementations have different parameters and return types.
-    # If you want to use one or the other consistently, use Elastomer::Client#native_delete_by_query
-    # or Elastomer::Client#app_delete_by_query directly.
+    # If you want to use one or the other consistently, use ElastomerClient::Client#native_delete_by_query
+    # or ElastomerClient::Client#app_delete_by_query directly.
     def delete_by_query(query, params = {})
-      send(version_support.delete_by_query_method, query, params)
+      send(:native_delete_by_query, query, params)
     end
   end
 end

data/lib/{elastomer → elastomer_client}/client/docs.rb

@@ -1,5 +1,6 @@
+# frozen_string_literal: true
 
-module Elastomer
+module ElastomerClient
   class Client
 
     # Provides access to document-level API commands. Indexing documents and
@@ -11,7 +12,7 @@ module Elastomer
     # See https://www.elastic.co/guide/en/elasticsearch/reference/current/docs.html
     #
     # Returns a Docs instance.
-    def docs( name = nil, type = nil )
+    def docs(name = nil, type = nil)
       Docs.new self, name, type
     end
 
@@ -19,11 +20,11 @@ module Elastomer
       # Create a new document client for making API requests that pertain to
       # the indexing and searching of documents in a search index.
       #
-      # client - Elastomer::Client used for HTTP requests to the server
+      # client - ElastomerClient::Client used for HTTP requests to the server
       # name   - The name of the index as a String
       # type   - The document type as a String
       #
-      def initialize( client, name, type = nil )
+      def initialize(client, name, type = nil)
         @client = client
         @name   = @client.assert_param_presence(name, "index name") unless name.nil?
         @type   = @client.assert_param_presence(type, "document type") unless type.nil?
@@ -54,8 +55,6 @@ module Elastomer
       #
       # Elasticsearch 2.X only:
       #
-      #   :_timestamp (deprecated)
-      #   :_ttl (deprecated)
       #   :_consistency
       #
       # Elasticsearch 5.x only:
@@ -73,9 +72,9 @@ module Elastomer
       #
       # Returns the response body as a Hash
       #
-      # Raises Elastomer::Client::IllegalArgument if an unsupported indexing
+      # Raises ElastomerClient::Client::IllegalArgument if an unsupported indexing
       # directive is used.
-      def index( document, params = {} )
+      def index(document, params = {})
         overrides = from_document document
         params = update_params(params, overrides)
         params.merge!(action: "docs.index", rest_api: "index")
@@ -101,7 +100,7 @@ module Elastomer
       # See https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-delete.html
       #
       # Returns the response body as a Hash
-      def delete( params = {} )
+      def delete(params = {})
         response = client.delete "/{index}/{type}/{id}", update_params(params, action: "docs.delete", rest_api: "delete")
         response.body
       end
@@ -115,7 +114,7 @@ module Elastomer
       # See https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-get.html#docs-get
       #
       # Returns the response body as a Hash
-      def get( params = {} )
+      def get(params = {})
         response = client.get "/{index}/{type}/{id}", update_params(params, action: "docs.get", rest_api: "get")
         response.body
       end
@@ -129,7 +128,7 @@ module Elastomer
       # See https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-get.html#docs-get
       #
       # Returns true if the document exists
-      def exists?( params = {} )
+      def exists?(params = {})
         response = client.head "/{index}/{type}/{id}", update_params(params, action: "docs.exists", rest_api: "exists")
         response.success?
       end
@@ -144,7 +143,7 @@ module Elastomer
       # See https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-get.html#_source
       #
       # Returns the response body as a Hash
-      def source( params = {} )
+      def source(params = {})
         response = client.get "/{index}/{type}/{id}/_source", update_params(params, action: "docs.source", rest_api: "get_source")
         response.body
       end
@@ -157,11 +156,11 @@ module Elastomer
       # See https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-multi-get.html
       #
       # Returns the response body as a Hash
-      def multi_get( body, params = {} )
+      def multi_get(body, params = {})
         overrides = from_document body
         overrides.merge!(action: "docs.multi_get", rest_api: "mget")
 
-        response = client.get "{/index}{/type}/_mget", update_params(params, overrides)
+        response = client.get "{/index}{/type}/_mget", update_params(params, overrides, client.version_support.es_version_8_plus?)
         response.body
       end
       alias_method :mget, :multi_get
@@ -174,11 +173,15 @@ module Elastomer
       # See https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-update.html
       #
       # Returns the response body as a Hash
-      def update( script, params = {} )
+      def update(script, params = {})
         overrides = from_document script
         overrides.merge!(action: "docs.update", rest_api: "update")
 
-        response = client.post "/{index}/{type}/{id}/_update", update_params(params, overrides)
+        if client.version_support.es_version_8_plus?
+          response = client.post "/{index}/_update/{id}", update_params(params, overrides, true)
+        else
+          response = client.post "/{index}/{type}/{id}/_update", update_params(params, overrides)
+        end
         response.body
       end
 
@@ -204,10 +207,10 @@ module Elastomer
       # See https://www.elastic.co/guide/en/elasticsearch/reference/current/search-request-body.html
       #
       # Returns the response body as a hash
-      def search( query, params = nil )
+      def search(query, params = nil)
         query, params = extract_params(query) if params.nil?
 
-        response = client.get "/{index}{/type}/_search", update_params(params, body: query, action: "docs.search", rest_api: "search")
+        response = client.get "/{index}{/type}/_search", update_params(params, {body: query, action: "docs.search", rest_api: "search"}, client.version_support.es_version_8_plus?)
         response.body
       end
 
@@ -224,8 +227,10 @@ module Elastomer
       # See https://www.elastic.co/guide/en/elasticsearch/reference/current/search-shards.html
       #
       # Returns the response body as a hash
-      def search_shards( params = {} )
-        response = client.get "/{index}{/type}/_search_shards", update_params(params, action: "docs.search_shards", rest_api: "search_shards")
+      def search_shards(params = {})
+        updated_params = update_params(params, { action: "docs.search_shards", rest_api: "search_shards" }, true)
+
+        response = client.get "/{index}/_search_shards", updated_params
         response.body
       end
 
@@ -249,36 +254,20 @@ module Elastomer
       # See https://www.elastic.co/guide/en/elasticsearch/reference/current/search-count.html
       #
       # Returns the response body as a Hash
-      def count( query, params = nil )
+      def count(query, params = nil)
         query, params = extract_params(query) if params.nil?
 
-        response = client.get "/{index}{/type}/_count", update_params(params, body: query, action: "docs.count", rest_api: "count")
+        if client.version_support.es_version_8_plus?
+          response = client.get "/{index}/_count", update_params(params, {body: query, action: "docs.count", rest_api: "count"}, true)
+        else
+          response = client.get "/{index}{/type}/_count", update_params(params, body: query, action: "docs.count", rest_api: "count")
+        end
         response.body
       end
 
-      # Delete documents by query following either the native or
-      # application-level delete by query method.
-      #
-      # NOTE: The parameters and response format varies by version. To have more
-      # control over this, use app_delete_by_query or native_delete_by_query
-      # directly.
+      # Delete documents by query
       def delete_by_query(query, params = nil)
-        send(@client.version_support.delete_by_query_method, query, params)
-      end
-
-      # DEPRECATED: Delete documents from one or more indices and one or more types based
-      # on a query. This method supports both the "request body" query and the
-      # "URI request" query. When using the request body semantics, the query
-      # hash must contain the :query key. Otherwise we assume a URI request is
-      # being made.
-      #
-      # See Client#app_delete_by_query for more information.
-      #
-      # Returns a Hash of statistics about the delete operations
-      def app_delete_by_query(query, params = nil)
-        query, params = extract_params(query) if params.nil?
-
-        @client.app_delete_by_query(query, update_params(params))
+        send(:native_delete_by_query, query, params)
       end
 
       # Delete documents from one or more indices and one or more types based
@@ -289,7 +278,7 @@ module Elastomer
       # Returns a Hash of statistics about the delete operations as returned by
       # _delete_by_query.
       #
-      # Raises Elastomer::Client::IncompatibleVersionException if this version
+      # Raises ElastomerClient::Client::IncompatibleVersionException if this version
       # of Elasticsearch does not support _delete_by_query.
       def native_delete_by_query(query, params = {})
         query, params = extract_params(query) if params.nil?
@@ -297,6 +286,18 @@ module Elastomer
         @client.native_delete_by_query(query, update_params(params))
       end
 
+      # Update documents by query using Elasticsearch's _update_by_query API.
+      #
+      # See Client#update_by_query for more information.
+      #
+      # Returns a Hash of statistics about the update operations as returned by
+      # _update_by_query.
+      def update_by_query(query, params = nil)
+        query, params = extract_params(query) if params.nil?
+
+        @client.update_by_query(query, update_params(params))
+      end
+
       # Matches a provided or existing document to the stored percolator
       # queries. To match an existing document, pass `nil` as the body and
       # include `:id` in the params.
@@ -309,7 +310,7 @@ module Elastomer
       #
       # Returns the response body as a Hash
       def percolate(body, params = {})
-        response = client.get "/{index}/{type}{/id}/_percolate", update_params(params, body: body, action: "percolator.percolate", rest_api: "percolate")
+        response = client.get "/{index}/{type}{/id}/_percolate", update_params(params, body:, action: "percolator.percolate", rest_api: "percolate")
         response.body
       end
 
@@ -325,7 +326,7 @@ module Elastomer
       #
       # Returns the count
       def percolate_count(body, params = {})
-        response = client.get "/{index}/{type}{/id}/_percolate/count", update_params(params, body: body, action: "percolator.percolate_count", rest_api: "count_percolate")
+        response = client.get "/{index}/{type}{/id}/_percolate/count", update_params(params, body:, action: "percolator.percolate_count", rest_api: "count_percolate")
         response.body["total"]
       end
 
@@ -339,8 +340,12 @@ module Elastomer
       # See https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-termvectors.html
       #
       # Returns the response body as a hash
-      def termvector( params = {} )
-        response = client.get "/{index}/{type}/{id}/_termvectors", update_params(params, action: "docs.termvector", rest_api: "termvectors")
+      def termvector(params = {})
+        if client.version_support.es_version_8_plus?
+          response = client.get "/{index}/_termvectors/{id}", update_params(params, {action: "docs.termvector", rest_api: "termvectors"}, true)
+        else
+          response = client.get "/{index}/{type}/{id}/_termvectors", update_params(params, action: "docs.termvector", rest_api: "termvectors")
+        end
         response.body
       end
       alias_method :termvectors, :termvector
@@ -357,15 +362,13 @@ module Elastomer
       # See https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-multi-termvectors.html
       #
       # Returns the response body as a hash
-      def multi_termvectors( body, params = {} )
-        response = client.get "{/index}{/type}/_mtermvectors", update_params(params, body: body, action: "docs.multi_termvectors", rest_api: "mtermvectors")
+      def multi_termvectors(body, params = {})
+        response = client.get "{/index}{/type}/_mtermvectors", update_params(params, {body:, action: "docs.multi_termvectors", rest_api: "mtermvectors"}, client.version_support.es_version_8_plus?)
         response.body
       end
       alias_method :multi_term_vectors, :multi_termvectors
 
-=begin
-Percolate
-=end
+# Percolate
 
       # Compute a score explanation for a query and a specific document. This
       # can give useful feedback about why a document matched or didn't match
@@ -384,10 +387,14 @@ Percolate
       # See https://www.elastic.co/guide/en/elasticsearch/reference/current/search-explain.html
       #
       # Returns the response body as a hash
-      def explain( query, params = nil )
+      def explain(query, params = nil)
         query, params = extract_params(query) if params.nil?
 
-        response = client.get "/{index}/{type}/{id}/_explain", update_params(params, body: query, action: "docs.explain", rest_api: "explain")
+        if client.version_support.es_version_8_plus?
+          response = client.get "/{index}/_explain/{id}", update_params(params, {body: query, action: "docs.explain", rest_api: "explain"}, true)
+        else
+          response = client.get "/{index}/{type}/{id}/_explain", update_params(params, body: query, action: "docs.explain", rest_api: "explain")
+        end
         response.body
       end
 
@@ -409,10 +416,10 @@ Percolate
       # See https://www.elastic.co/guide/en/elasticsearch/reference/current/search-validate.html
       #
       # Returns the response body as a hash
-      def validate( query, params = nil )
+      def validate(query, params = nil)
         query, params = extract_params(query) if params.nil?
 
-        response = client.get "/{index}{/type}/_validate/query", update_params(params, body: query, action: "docs.validate", rest_api: "indices.validate_query")
+        response = client.get "/{index}{/type}/_validate/query", update_params(params, {body: query, action: "docs.validate", rest_api: "indices.validate_query"}, client.version_support.es_version_8_plus?)
         response.body
       end
 
@@ -437,7 +444,7 @@ Percolate
       #   end
       #
       # Returns the response body as a Hash
-      def bulk( params = {}, &block )
+      def bulk(params = {}, &block)
         raise "a block is required" if block.nil?
 
         params = {index: self.name, type: self.type}.merge params
@@ -465,8 +472,8 @@ Percolate
       # See https://www.elastic.co/guide/en/elasticsearch/reference/current/search-request-scroll.html
       #
       # Returns a new Scroller instance
-      def scroll( query, opts = {} )
-        opts = {index: name, type: type}.merge opts
+      def scroll(query, opts = {})
+        opts = {index: name, type:}.merge opts
         client.scroll query, opts
       end
 
@@ -492,8 +499,8 @@ Percolate
       #   end
       #
       # Returns a new Scroller instance
-      def scan( query, opts = {} )
-        opts = {index: name, type: type}.merge opts
+      def scan(query, opts = {})
+        opts = {index: name, type:}.merge opts
         client.scan query, opts
       end
 
@@ -521,10 +528,11 @@ Percolate
       # See https://www.elastic.co/guide/en/elasticsearch/reference/current/search-multi-search.html
       #
       # Returns the response body as a Hash
-      def multi_search( params = {}, &block )
+      def multi_search(params = {}, &block)
         raise "a block is required" if block.nil?
 
         params = {index: self.name, type: self.type}.merge params
+        params.delete(:type) if client.version_support.es_version_8_plus?
         client.multi_search params, &block
       end
 
@@ -554,9 +562,9 @@ Percolate
       end
 
       SPECIAL_KEYS= %i[
-        index type id version version_type op_type routing parent timestamp ttl
+        index type id version version_type op_type routing parent
         consistency replication refresh wait_for_active_shards
-      ].inject({}) { |h,k| h[k] = "_#{k}"; h }.freeze
+      ].inject({}) { |h, k| h[k] = "_#{k}"; h }.freeze
 
       # Internal: Given a `document` generate an options hash that will
       # override parameters based on the content of the document. The document
@@ -569,9 +577,9 @@ Percolate
       #
       # Returns an options Hash extracted from the document.
       #
-      # Raises Elastomer::Client::IllegalArgument if an unsupported indexing
+      # Raises ElastomerClient::Client::IllegalArgument if an unsupported indexing
       # directive is used.
-      def from_document( document )
+      def from_document(document)
         opts = {body: document}
 
         if document.is_a? Hash
@@ -591,16 +599,18 @@ Percolate
       # overrides - Optional parameter overrides as a Hash
       #
       # Returns a new params Hash.
-      def update_params( params, overrides = nil )
+      def update_params(params, overrides = nil, delete_type = false)
         h = defaults.update params
         h.update overrides unless overrides.nil?
-        h[:routing] = h[:routing].join(",") if Array === h[:routing]
+        h[:routing] = h[:routing].join(",") if h[:routing].is_a?(Array)
+        h[:type] = "_doc" if client.version_support.es_version_8_plus? && !delete_type
+        h.delete(:type) if delete_type
         h
       end
 
       # Internal: Returns a Hash containing default parameters.
       def defaults
-        { index: name, type: type }
+        { index: name, type: }
       end
 
       # Internal: Allow params to be passed as the first argument to
@@ -610,7 +620,7 @@ Percolate
       # params - params hash OR nil if no query
       #
       # Returns an array of the query (possibly nil) and params Hash.
-      def extract_params( query, params = nil )
+      def extract_params(query, params = nil)
         if params.nil?
           if query.key? :query
             params = {}

data/lib/{elastomer → elastomer_client}/client/errors.rb

@@ -1,13 +1,14 @@
+# frozen_string_literal: true
 
-module Elastomer
+module ElastomerClient
 
-  # Parent class for all Elastomer errors.
+  # Parent class for all ElastomerClient errors.
   Error = Class.new StandardError
 
   class Client
 
     # General error response from client requests.
-    class Error < ::Elastomer::Error
+    class Error < ::ElastomerClient::Error
 
       # Construct a new Error from the given response object or a message
       # String. If a response object is given, the error message will be
@@ -15,7 +16,7 @@ module Elastomer
       #
       # response - Faraday::Response object or a simple error message String
       #
-      def initialize( *args )
+      def initialize(*args)
         @status = nil
         @error = nil
 
@@ -33,10 +34,10 @@ module Elastomer
           @error = body["error"] if body.is_a?(Hash) && body.key?("error")
 
           message = @error || body.to_s
-          super message
+          super(message)
 
         else
-          super args.join(" ")
+          super(args.join(" "))
         end
       end
 
@@ -96,17 +97,6 @@ module Elastomer
     ConnectionFailed.fatal       = false
     RejectedExecutionError.fatal = false
 
-    # Define an Elastomer::Client exception class on the fly for
-    # Faraday exception classes that we don't specifically wrap.
-    Faraday::Error.constants.each do |error_name|
-      next if ::Elastomer::Client.const_get(error_name) rescue nil
-
-      error_class = Faraday::Error.const_get(error_name)
-      next unless error_class < Faraday::Error::ClientError
-
-      ::Elastomer::Client.const_set(error_name, Class.new(Error))
-    end
-
     # Exception for operations that are unsupported with the version of
     # Elasticsearch being used.
     IncompatibleVersionException = Class.new Error