elastomer-client 3.2.2 → 6.2.0

data/lib/{elastomer → elastomer_client}/client/rest_api_spec/rest_api.rb

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 require "forwardable"
 
-module Elastomer::Client::RestApiSpec
+module ElastomerClient::Client::RestApiSpec
   class RestApi
     extend Forwardable
 
@@ -15,7 +17,7 @@ module Elastomer::Client::RestApiSpec
     def initialize(documentation:, methods:, url:, body: nil)
       @documentation = documentation
       @methods = Array(methods)
-      @url = Url.new(url)
+      @url = Url.new(**url)
       @body = body
     end
 
@@ -40,7 +42,7 @@ module Elastomer::Client::RestApiSpec
       end
 
       def select_parts(from:)
-        from.select {|k,v| valid_part?(k)}
+        from.select { |k, v| valid_part?(k) }
       end
 
       def valid_part?(part)
@@ -48,7 +50,7 @@ module Elastomer::Client::RestApiSpec
       end
 
       def select_params(from:)
-        from.select {|k,v| valid_param?(k)}
+        from.select { |k, v| valid_param?(k) }
       end
 
       def valid_param?(param)

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

@@ -1,5 +1,6 @@
+# frozen_string_literal: true
 
-module Elastomer
+module ElastomerClient
   class Client
 
     # Provides access to the versioned REST API specs for Elasticsearch.
@@ -34,7 +35,7 @@ module Elastomer
       # Internal: Convert a dotted version String into an underscore format
       # suitable for use in Ruby class names.
       def self.to_class_version(version)
-        version.to_s.split(".").slice(0,2).join("_")
+        version.to_s.split(".").slice(0, 2).join("_")
       end
     end
   end

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

@@ -1,4 +1,6 @@
-module Elastomer
+# frozen_string_literal: true
+
+module ElastomerClient
   class Client
 
     # Create a new Scroller instance for scrolling all results from a `query`.
@@ -19,7 +21,7 @@ module Elastomer
     #   end
     #
     # Returns a new Scroller instance
-    def scroll( query, opts = {} )
+    def scroll(query, opts = {})
       Scroller.new(self, query, opts)
     end
 
@@ -42,7 +44,7 @@ module Elastomer
     #   end
     #
     # Returns a new Scroller instance
-    def scan( query, opts = {} )
+    def scan(query, opts = {})
       Scroller.new(self, add_sort_by_doc(query), opts)
     end
 
@@ -55,7 +57,6 @@ module Elastomer
     #   :type        - the document type to search
     #   :scroll      - the keep alive time of the scrolling request (5 minutes by default)
     #   :size        - the number of documents per shard to fetch per scroll
-    #   :search_type - set to 'scan' for scan semantics  # DEPRECATED in ES 2.1.0 - use a Scroll query sorted by _doc: https://www.elastic.co/guide/en/elasticsearch/reference/2.3/search-request-search-type.html#scan
     #
     # Examples
     #
@@ -70,8 +71,9 @@ module Elastomer
     #   # repeat until there are no more hits
     #
     # Returns the response body as a Hash.
-    def start_scroll( opts = {} )
+    def start_scroll(opts = {})
       opts = opts.merge action: "search.start_scroll", rest_api: "search"
+      opts.delete(:type) if version_support.es_version_8_plus?
       response = get "{/index}{/type}/_search", opts
       response.body
     end
@@ -95,8 +97,8 @@ module Elastomer
     #   # repeat until the results are empty
     #
     # Returns the response body as a Hash.
-    def continue_scroll( scroll_id, scroll = "5m" )
-      response = get "/_search/scroll", body: {scroll_id: scroll_id}, scroll: scroll, action: "search.scroll", rest_api: "scroll"
+    def continue_scroll(scroll_id, scroll = "5m")
+      response = get "/_search/scroll", body: {scroll_id:}, scroll:, action: "search.scroll", rest_api: "scroll"
       response.body
     rescue RequestError => err
       if err.error && err.error["caused_by"]["type"] == "search_context_missing_exception"
@@ -112,7 +114,7 @@ module Elastomer
     # scroll_id - One or more scroll IDs
     #
     # Returns the response body as a Hash.
-    def clear_scroll( scroll_ids )
+    def clear_scroll(scroll_ids)
       response = delete "/_search/scroll", body: {scroll_id: Array(scroll_ids)}, action: "search.clear_scroll", rest_api: "clear_scroll"
       response.body
     end
@@ -129,7 +131,7 @@ module Elastomer
       end
 
       if query.has_key? :sort
-         raise ArgumentError, "Query cannot contain a sort (found sort '#{query[:sort]}' in query: #{query})"
+        raise ArgumentError, "Query cannot contain a sort (found sort '#{query[:sort]}' in query: #{query})"
       end
 
       query.merge(sort: [:_doc])
@@ -150,14 +152,13 @@ module Elastomer
       # See https://www.elastic.co/guide/en/elasticsearch/reference/current/search-request-scroll.html
       # and https://www.elastic.co/guide/en/elasticsearch/reference/current/search-request-search-type.html#scan
       #
-      # client - Elastomer::Client used for HTTP requests to the server
+      # client - ElastomerClient::Client used for HTTP requests to the server
       # query  - The query to scroll as a Hash or a JSON encoded String
       # opts   - Options Hash
       #   :index       - the name of the index to search
       #   :type        - the document type to search
       #   :scroll      - the keep alive time of the scrolling request (5 minutes by default)
       #   :size        - the number of documents per shard to fetch per scroll
-      #   :search_type - set to 'scan' for scan semantics  # DEPRECATED in ES 2.1.0 - use a Scroll query sorted by _doc: https://www.elastic.co/guide/en/elasticsearch/reference/2.3/search-request-search-type.html#scan
       #
       # Examples
       #
@@ -167,7 +168,7 @@ module Elastomer
       #     doc['_source']
       #   }
       #
-      def initialize( client, query, opts = {} )
+      def initialize(client, query, opts = {})
         @client = client
 
         @opts = DEFAULT_OPTS.merge({ body: query }).merge(opts)
@@ -230,7 +231,7 @@ module Elastomer
       #   end
       #
       # Returns this Scroller instance.
-      def each_document( &block )
+      def each_document(&block)
         each { |hits| hits["hits"].each(&block) }
       end
 
@@ -238,12 +239,12 @@ module Elastomer
       # cluster and no further documents can be returned by this Scroller
       # instance.
       #
-      # Returns nil if the `scroll_id` is not valid; returns the reponse body if
+      # Returns nil if the `scroll_id` is not valid; returns the response body if
       # the `scroll_id` was cleared.
       def clear!
         return if scroll_id.nil?
         client.clear_scroll(scroll_id)
-      rescue ::Elastomer::Client::IllegalArgument
+      rescue ::ElastomerClient::Client::IllegalArgument
         nil
       end
 
@@ -269,4 +270,4 @@ module Elastomer
 
     end  # Scroller
   end  # Client
-end  # Elastomer
+end  # ElastomerClient

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

@@ -1,4 +1,6 @@
-module Elastomer
+# frozen_string_literal: true
+
+module ElastomerClient
   class Client
 
     # Provides access to snapshot API commands.
@@ -15,7 +17,7 @@ module Elastomer
       # Create a new snapshot object for making API requests that pertain to
       # creating, restoring, deleting, and retrieving snapshots.
       #
-      # client     - Elastomer::Client used for HTTP requests to the server
+      # client     - ElastomerClient::Client used for HTTP requests to the server
       # repository - The name of the repository as a String. Cannot be nil if
       #              snapshot name is not nil.
       # name       - The name of the snapshot as a String
@@ -37,7 +39,7 @@ module Elastomer
       def exists?(params = {})
         response = client.get "/_snapshot/{repository}/{snapshot}", update_params(params, action: "snapshot.exists", rest_api: "snapshot.get")
         response.success?
-      rescue Elastomer::Client::Error => err
+      rescue ElastomerClient::Client::Error => err
         if err.error && err.error.dig("root_cause", 0, "type") == "snapshot_missing_exception"
           false
         else
@@ -54,7 +56,7 @@ module Elastomer
       #
       # Returns the response body as a Hash
       def create(body = {}, params = {})
-        response = client.put "/_snapshot/{repository}/{snapshot}", update_params(params, body: body, action: "snapshot.create", rest_api: "snapshot.create")
+        response = client.put "/_snapshot/{repository}/{snapshot}", update_params(params, body:, action: "snapshot.create", rest_api: "snapshot.create")
         response.body
       end
 
@@ -67,7 +69,7 @@ module Elastomer
       def get(params = {})
         # Set snapshot name or we'll get the repository instead
         snapshot = name || "_all"
-        response = client.get "/_snapshot/{repository}/{snapshot}", update_params(params, snapshot: snapshot, action: "snapshot.get", rest_api: "snapshot.get")
+        response = client.get "/_snapshot/{repository}/{snapshot}", update_params(params, snapshot:, action: "snapshot.get", rest_api: "snapshot.get")
         response.body
       end
 
@@ -90,7 +92,7 @@ module Elastomer
       #
       # Returns the response body as a Hash
       def restore(body = {}, params = {})
-        response = client.post "/_snapshot/{repository}/{snapshot}/_restore", update_params(params, body: body, action: "snapshot.restore", rest_api: "snapshot.restore")
+        response = client.post "/_snapshot/{repository}/{snapshot}/_restore", update_params(params, body:, action: "snapshot.restore", rest_api: "snapshot.restore")
         response.body
       end
 
@@ -112,7 +114,7 @@ module Elastomer
       # overrides - Optional parameter overrides as a Hash
       #
       # Returns a new params Hash.
-      def update_params( params, overrides = nil )
+      def update_params(params, overrides = nil)
         h = defaults.update params
         h.update overrides unless overrides.nil?
         h
@@ -120,7 +122,7 @@ module Elastomer
 
       # Internal: Returns a Hash containing default parameters.
       def defaults
-        { repository: repository, snapshot: name }
+        { repository:, snapshot: name }
       end
     end
   end

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

@@ -1,4 +1,6 @@
-module Elastomer
+# frozen_string_literal: true
+
+module ElastomerClient
   class Client
 
     # Returns a Tasks instance for querying the cluster bound to this client for
@@ -15,7 +17,7 @@ module Elastomer
       # Create a new Tasks for introspecting on internal cluster activity.
       # More context: https://www.elastic.co/guide/en/elasticsearch/reference/5.6/tasks.html
       #
-      # client     - Elastomer::Client used for HTTP requests to the server
+      # client     - ElastomerClient::Client used for HTTP requests to the server
       #
       # Raises IncompatibleVersionException if caller attempts to access Tasks API on ES version < 5.0.0
       def initialize(client)
@@ -63,10 +65,8 @@ module Elastomer
         raise ArgumentError, "invalid node ID provided: #{node_id.inspect}" if node_id.to_s.empty?
         raise ArgumentError, "invalid task ID provided: #{task_id.inspect}" unless task_id.is_a?(Integer)
 
-        rest_api = client.version_support.supports_tasks_get? ? "tasks.get" : "tasks.list"
-
         # in this API, the task ID is included in the path, not as a request parameter.
-        response = client.get "/_tasks/{task_id}", params.merge(task_id: "#{node_id}:#{task_id}", action: "tasks.get", rest_api: rest_api)
+        response = client.get "/_tasks/{task_id}", params.merge(task_id: "#{node_id}:#{task_id}", action: "tasks.get", rest_api: "tasks.get")
         response.body
       end
 
@@ -92,11 +92,7 @@ module Elastomer
         parent_task_id = "#{parent_node_id}:#{parent_task_id}"
         params = params.merge(action: "tasks.parent", rest_api: "tasks.list")
 
-        if client.version_support.supports_parent_task_id?
-          params[:parent_task_id] = parent_task_id
-        else
-          params[:parent_task] = parent_task_id
-        end
+        params[:parent_task_id] = parent_task_id
 
         response = client.get "/_tasks", params
         response.body
@@ -115,8 +111,8 @@ module Elastomer
       #
       # Returns the response body as a Hash when timeout expires or target tasks complete
       # COMPATIBILITY WARNING: the response body differs between ES versions for this API
-      def wait_for(timeout = "10s", params = {}) 
-        self.get params.merge(wait_for_completion: true, timeout: timeout)
+      def wait_for(timeout = "10s", params = {})
+        self.get params.merge(wait_for_completion: true, timeout:)
       end
 
       # Wait for the specified amount of time (10 seconds by default) for some task(s) to complete.
@@ -137,7 +133,7 @@ module Elastomer
         raise ArgumentError, "invalid node ID provided: #{node_id.inspect}" if node_id.to_s.empty?
         raise ArgumentError, "invalid task ID provided: #{task_id.inspect}" unless task_id.is_a?(Integer)
 
-        self.get_by_id(node_id, task_id, params.merge(wait_for_completion: true, timeout: timeout))
+        self.get_by_id(node_id, task_id, params.merge(wait_for_completion: true, timeout:))
       end
 
       # Cancels a task running on a particular node.

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

@@ -1,9 +1,10 @@
+# frozen_string_literal: true
 
-module Elastomer
+module ElastomerClient
   class Client
 
     # Returns a Template instance.
-    def template( name )
+    def template(name)
       Template.new self, name
     end
 
@@ -13,10 +14,10 @@ module Elastomer
       # Create a new template client for making API requests that pertain to
       # template management.
       #
-      # 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 template as a String
       #
-      def initialize( client, name )
+      def initialize(client, name)
         @client = client
         @name   = name
       end
@@ -24,7 +25,7 @@ module Elastomer
       attr_reader :client, :name
 
       # Returns true if the template already exists on the cluster.
-      def exists?( params = {} )
+      def exists?(params = {})
         response = client.head "/_template/{template}", update_params(params, action: "template.exists", rest_api: "indices.exists_template")
         response.success?
       end
@@ -36,7 +37,7 @@ module Elastomer
       # params - Parameters Hash
       #
       # Returns the response body as a Hash
-      def get( params = {} )
+      def get(params = {})
         response = client.get "/_template/{template}", update_params(params, action: "template.get", rest_api: "indices.get_template")
         response.body
       end
@@ -48,7 +49,7 @@ module Elastomer
       # params   - Parameters Hash
       #
       # Returns the response body as a Hash
-      def create( template, params = {} )
+      def create(template, params = {})
         response = client.put "/_template/{template}", update_params(params, body: template, action: "template.create", rest_api: "indices.put_template")
         response.body
       end
@@ -59,7 +60,7 @@ module Elastomer
       # params - Parameters Hash
       #
       # Returns the response body as a Hash
-      def delete( params = {} )
+      def delete(params = {})
         response = client.delete "/_template/{template}", update_params(params, action: "template.delete", rest_api: "indices.delete_template")
         response.body
       end
@@ -71,7 +72,7 @@ module Elastomer
       # overrides - Optional parameter overrides as a Hash
       #
       # Returns a new params Hash.
-      def update_params( params, overrides = nil )
+      def update_params(params, overrides = nil)
         h = defaults.update params
         h.update overrides unless overrides.nil?
         h

data/lib/elastomer_client/client/update_by_query.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module ElastomerClient
+  class Client
+    # Update documents based on a query using the Elasticsearch _update_by_query API.
+    #
+    # query  - The query body as a Hash
+    # params - Parameters Hash
+    #
+    # Examples
+    #
+    #   # request body query
+    #   update_by_query({
+    #     "script": {
+    #       "source": "ctx._source.count++",
+    #       "lang": "painless"
+    #     },
+    #     "query": {
+    #       "term": {
+    #         "user.id": "kimchy"
+    #       }
+    #     }
+    #   })
+    #
+    # See https://www.elastic.co/guide/en/elasticsearch/reference/8.7/docs-update-by-query.html
+    #
+    # Returns a Hash containing the _update_by_query response body.
+    def update_by_query(query, parameters = {})
+      UpdateByQuery.new(self, query, parameters).execute
+    end
+
+    class UpdateByQuery
+      attr_reader :client, :query, :parameters
+
+      def initialize(client, query, parameters)
+        @client = client
+        @query = query
+        @parameters = parameters
+      end
+
+      def execute
+        # TODO: Require index parameter. type is optional.
+        updated_params = parameters.merge(body: query, action: "update_by_query", rest_api: "update_by_query")
+        updated_params.delete(:type) if client.version_support.es_version_8_plus?
+        response = client.post("/{index}{/type}/_update_by_query", updated_params)
+        response.body
+      end
+    end
+  end
+end