[API] Adds simulate.ingest endpoint

Author: picandocodigo

elasticsearch-api/lib/elasticsearch/api.rb

@@ -85,7 +85,8 @@ def self.included(base)
                 Elasticsearch::API::QueryRuleset,
                 Elasticsearch::API::Esql,
                 Elasticsearch::API::Inference,
-                Elasticsearch::API::Profiling
+                Elasticsearch::API::Profiling,
+                Elasticsearch::API::Simulate
     end
 
     # The serializer class

elasticsearch-api/lib/elasticsearch/api/actions/simulate/ingest.rb

@@ -0,0 +1,71 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+#
+# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
+# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
+#
+module Elasticsearch
+  module API
+    module Simulate
+      module Actions
+        # Simulates running ingest with example documents.
+        # This functionality is Experimental and may be changed or removed
+        # completely in a future release. Elastic will take a best effort approach
+        # to fix any issues, but experimental features are not subject to the
+        # support SLA of official GA features.
+        #
+        # @option arguments [String] :index Default index for docs which don't provide one
+        # @option arguments [String] :pipeline The pipeline id to preprocess incoming documents with if no pipeline is given for a particular document
+        # @option arguments [Hash] :headers Custom HTTP headers
+        # @option arguments [Hash] :body The simulate definition (*Required*)
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/simulate-ingest-api.html
+        #
+        def ingest(arguments = {})
+          request_opts = { endpoint: arguments[:endpoint] || "simulate.ingest" }
+
+          defined_params = [:index].inject({}) do |set_variables, variable|
+            set_variables[variable] = arguments[variable] if arguments.key?(variable)
+            set_variables
+          end
+          request_opts[:defined_params] = defined_params unless defined_params.empty?
+
+          raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
+
+          arguments = arguments.clone
+          headers = arguments.delete(:headers) || {}
+
+          body   = arguments.delete(:body)
+
+          _index = arguments.delete(:index)
+
+          method = Elasticsearch::API::HTTP_POST
+          path   = if _index
+                     "_ingest/#{Utils.__listify(_index)}/_simulate"
+                   else
+                     "_ingest/_simulate"
+                   end
+          params = Utils.process_params(arguments)
+
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers, request_opts)
+          )
+        end
+      end
+    end
+  end
+end

elasticsearch-api/lib/elasticsearch/api/namespace/simulate.rb

@@ -0,0 +1,36 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+module Elasticsearch
+  module API
+    module Simulate
+      module Actions; end
+
+      # Client for the "simulate" namespace (includes the {Simulate::Actions} methods)
+      #
+      class SimulateClient
+        include Common::Client, Common::Client::Base, Simulate::Actions
+      end
+
+      # Proxy method for {SimulateClient}, available in the receiving object
+      #
+      def simulate
+        @simulate ||= SimulateClient.new(self)
+      end
+    end
+  end
+end

elasticsearch-api/spec/elasticsearch/api/actions/simulate/ingest_spec.rb

@@ -0,0 +1,35 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+require 'spec_helper'
+
+describe 'client.simulate#ingest' do
+  let(:expected_args) do
+    [
+      'POST',
+      '_ingest/foo/_simulate',
+      {},
+      {},
+      {},
+      { defined_params: {index: 'foo'}, endpoint: 'simulate.ingest' }
+    ]
+  end
+
+  it 'performs the request' do
+    expect(client_double.simulate.ingest(body: {}, index: 'foo')).to be_a Elasticsearch::API::Response
+  end
+end