elasticsearch-api 7.13.3 → 8.14.0

data/spec/elasticsearch/api/actions/termvectors_spec.rb

@@ -24,12 +24,13 @@ describe 'client#termvectors' do
       url,
       params,
       body,
-      {}
+      {},
+      { defined_params: { id: '123', index: 'foo' }, endpoint: 'termvectors' }
     ]
   end
 
   let(:url) do
-    'foo/bar/123/_termvectors'
+    'foo/_termvectors/123'
   end
 
   let(:params) do
@@ -46,21 +47,32 @@ describe 'client#termvectors' do
 
   it 'requires the :index argument' do
     expect {
-      client.termvectors(type: 'bar', id: '1')
+      client.termvectors(id: '1')
     }.to raise_exception(ArgumentError)
   end
 
   it 'performs the request' do
-    expect(client_double.termvectors(index: 'foo', type: 'bar', id: '123', body: {})).to eq({})
+    expect(client_double.termvectors(index: 'foo', id: '123', body: {})).to be_a Elasticsearch::API::Response
   end
 
   context 'when the older api name \'termvector\' is used' do
     let(:url) do
-      'foo/bar/123/_termvector'
+      'foo/_termvectors/123'
+    end
+
+    let(:expected_args) do
+      [
+        'POST',
+        url,
+        params,
+        body,
+        {},
+        { defined_params: { id: '123', index: 'foo' }, endpoint: '_termvector' }
+      ]
     end
 
     it 'performs the request' do
-      expect(client_double.termvector(index: 'foo', type: 'bar', id: '123', body: {})).to eq({})
+      expect(client_double.termvector(index: 'foo', id: '123', body: {})).to be_a Elasticsearch::API::Response
     end
   end
 end

data/spec/elasticsearch/api/actions/text_structure/find_field_structure_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.text_structure#test_grok_pattern' do
+  let(:expected_args) do
+    [
+      'GET',
+      '_text_structure/find_field_structure',
+      {},
+      nil,
+      {},
+      { endpoint: 'text_structure.find_field_structure' }
+    ]
+  end
+
+  it 'performs the request' do
+    expect(client_double.text_structure.find_field_structure).to be_a Elasticsearch::API::Response
+  end
+end

data/spec/elasticsearch/api/actions/text_structure/find_message_structure_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.text_structure#test_grok_pattern' do
+  let(:expected_args) do
+    [
+      'POST',
+      '_text_structure/find_message_structure',
+      {},
+      {},
+      {},
+      { endpoint: 'text_structure.find_message_structure' }
+    ]
+  end
+
+  it 'performs the request' do
+    expect(client_double.text_structure.find_message_structure(body: {})).to be_a Elasticsearch::API::Response
+  end
+end

data/spec/elasticsearch/api/actions/text_structure/find_structure_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.text_structure#test_grok_pattern' do
+  let(:expected_args) do
+    [
+      'POST',
+      '_text_structure/find_structure',
+      {},
+      {},
+      { 'Content-Type' => 'application/x-ndjson' },
+      { endpoint: 'text_structure.find_structure' }
+    ]
+  end
+
+  it 'performs the request' do
+    expect(client_double.text_structure.find_structure(body: {})).to be_a Elasticsearch::API::Response
+  end
+end

data/spec/elasticsearch/api/actions/text_structure/test_grok_pattern_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.text_structure#test_grok_pattern' do
+  let(:expected_args) do
+    [
+      'POST',
+      '_text_structure/test_grok_pattern',
+      {},
+      {},
+      {},
+      { endpoint: 'text_structure.test_grok_pattern' }
+    ]
+  end
+
+  it 'performs the request' do
+    expect(client_double.text_structure.test_grok_pattern(body: {})).to be_a Elasticsearch::API::Response
+  end
+end

data/spec/elasticsearch/api/actions/transform/schedule_now_transform_spec.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.
+
+require 'spec_helper'
+
+describe 'client.transform#schedule_now_transform' do
+  let(:expected_args) do
+    [
+      'POST',
+      '_transform/id/_schedule_now',
+      {},
+      nil,
+      {},
+      { defined_params: { transform_id: 'id' },
+        endpoint: 'transform.schedule_now_transform' }
+    ]
+  end
+
+  it 'performs the request' do
+    expect(client_double.transform.schedule_now_transform(transform_id: 'id')).to be_a Elasticsearch::API::Response
+  end
+end

data/spec/elasticsearch/api/actions/update_by_query_spec.rb

@@ -18,18 +18,18 @@
 require 'spec_helper'
 
 describe 'client#update_by_query' do
-
   let(:expected_args) do
     [
-        'POST',
-        'foo/_update_by_query',
-        {},
-        nil,
-        {}
+      'POST',
+      'foo/_update_by_query',
+      {},
+      nil,
+      {},
+      { defined_params: { index: 'foo' }, endpoint: 'update_by_query' }
     ]
   end
 
   it 'performs the request' do
-    expect(client_double.update_by_query(index: 'foo')).to eq({})
+    expect(client_double.update_by_query(index: 'foo')).to be_a Elasticsearch::API::Response
   end
 end

data/spec/elasticsearch/api/actions/update_document_spec.rb

@@ -18,14 +18,14 @@
 require 'spec_helper'
 
 describe 'client#update' do
-
   let(:expected_args) do
     [
-        'POST',
-        url,
-        params,
-        body,
-        {}
+      'POST',
+      url,
+      params,
+      body,
+      {},
+      { defined_params: { id: '1', index: 'foo' }, endpoint: 'update' }
     ]
   end
 
@@ -34,7 +34,7 @@ describe 'client#update' do
   end
 
   let(:url) do
-    'foo/bar/1/_update'
+    'foo/_update/1'
   end
 
   let(:client) do
@@ -47,24 +47,23 @@ describe 'client#update' do
 
   it 'requires the :index argument' do
     expect {
-      client.update(type: 'bar', id: '1')
+      client.update(id: '1')
     }.to raise_exception(ArgumentError)
   end
 
   it 'requires the :id argument' do
     expect {
-      client.update(index: 'foo', type: 'bar')
+      client.update(index: 'foo')
     }.to raise_exception(ArgumentError)
   end
 
   it 'performs the request' do
-    expect(client_double.update(index: 'foo', type: 'bar', id: '1', body: { doc: {} })).to eq({})
+    expect(client_double.update(index: 'foo', id: '1', body: { doc: {} })).to be_a Elasticsearch::API::Response
   end
 
   context 'when URL parameters are provided' do
-
     let(:url) do
-      'foo/bar/1/_update'
+      'foo/_update/1'
     end
 
     let(:body) do
@@ -72,50 +71,49 @@ describe 'client#update' do
     end
 
     it 'performs the request' do
-      expect(client_double.update(index: 'foo', type: 'bar', id: '1', body: {}))
-    end
-  end
-
-  context 'when invalid parameters are specified' do
-
-    it 'raises an ArgumentError' do
-      expect {
-        client.update(index: 'foo', type: 'bar', id: '1', body: { doc: {} }, qwertypoiuy: 'asdflkjhg')
-      }.to raise_exception(ArgumentError)
+      expect(client_double.update(index: 'foo', id: '1', body: {}))
     end
   end
 
   context 'when the request needs to be URL-escaped' do
-
     let(:url) do
-      'foo%5Ebar/bar%2Fbam/1/_update'
+      'foo%5Ebar/_update/1'
     end
 
     let(:body) do
       {}
     end
 
+    let(:expected_args) do
+      [
+        'POST',
+        url,
+        params,
+        body,
+        {},
+        { defined_params: { id: '1', index: 'foo^bar' }, endpoint: 'update' }
+      ]
+    end
+
     it 'escapes the parts' do
-      expect(client_double.update(index: 'foo^bar', type: 'bar/bam', id: '1', body: {}))
+      expect(client_double.update(index: 'foo^bar', id: '1', body: {}))
     end
   end
 
   context 'when a NotFound exception is raised' do
-
     before do
       allow(client).to receive(:perform_request).and_raise(NotFound)
     end
 
     it 'raises it to the user' do
       expect {
-        client.update(index: 'foo', type: 'bar', id: 'XXX', body: {})
+        client.update(index: 'foo', id: 'XXX', body: {})
       }.to raise_exception(NotFound)
     end
 
     context 'when the :ignore parameter is specified' do
-
       it 'does not raise the error to the user' do
-        expect(client.update(index: 'foo', type: 'bar', id: 'XXX', body: {}, ignore: 404)).to eq(false)
+        expect(client.update(index: 'foo', id: 'XXX', body: {}, ignore: 404)).to eq(false)
       end
     end
   end

data/spec/elasticsearch/api/actions/watcher/get_settings_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#watcher.get_settings' do
+  let(:expected_args) do
+    [
+      'GET',
+      '_watcher/settings',
+      {},
+      nil,
+      {},
+      { endpoint: 'watcher.get_settings' }
+    ]
+  end
+
+  it 'performs the request' do
+    expect(client_double.watcher.get_settings).to be_a Elasticsearch::API::Response
+  end
+end

data/spec/elasticsearch/api/actions/watcher/update_settings_spec.rb

@@ -0,0 +1,47 @@
+# 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#watcher.update_settings' do
+  let(:expected_args) do
+    [
+      'PUT',
+      '_watcher/settings',
+      {},
+      {},
+      {},
+      { endpoint: 'watcher.update_settings' }
+    ]
+  end
+
+  context 'when using body' do
+    it 'performs the request' do
+      expect(client_double.watcher.update_settings(body: {})).to be_a Elasticsearch::API::Response
+    end
+  end
+
+  context 'without a body' do
+    let(:client) { Class.new { include Elasticsearch::API }.new }
+
+    it 'raises ArgumentError' do
+      expect do
+        client.watcher.update_settings
+      end.to raise_exception(ArgumentError)
+    end
+  end
+end

data/spec/elasticsearch/api/api_response_spec.rb

@@ -0,0 +1,65 @@
+# 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'
+require 'elastic/transport'
+
+describe Elasticsearch::API::Response do
+  let(:response_body) do
+    {
+      'name' => 'instance',
+      'cluster_name' => 'elasticsearch-8-0-0',
+      'version' => {
+        'number' => '8.0.0',
+        'build_flavor' => 'default'
+      },
+      'tagline' => 'You Know, for Search'
+    }
+  end
+  let(:headers) do
+    { 'Content-Type' => 'application/json'}
+  end
+  let(:es_response) do
+    Elastic::Transport::Transport::Response.new(
+      200,
+      response_body,
+      headers
+    )
+  end
+  let(:response) { described_class.new(es_response) }
+
+  it 'behaves like a Hash' do
+    expect(response['name']).to eq 'instance'
+    expect(response['version']).to eq({ 'number' => '8.0.0', 'build_flavor' => 'default' })
+    expect(response.keys).to eq ['name', 'cluster_name', 'version', 'tagline']
+    expect(response.respond_to?('map')).to be(true)
+    expect(response.respond_to?('each')).to be(true)
+    expect(response.respond_to?('size')).to be(true)
+  end
+
+  it 'returns a status' do
+    expect(response.status).to eq 200
+  end
+
+  it 'returns the headers' do
+    expect(response.headers).to eq headers
+  end
+
+  it 'returns the body which' do
+    expect(response.body).to eq response_body
+  end
+end

data/spec/elasticsearch/api/api_spec.rb

@@ -18,9 +18,7 @@
 require 'spec_helper'
 
 describe Elasticsearch::API do
-
   describe '#settings' do
-
     it 'allows access to settings' do
       expect(described_class.settings).not_to be_nil
     end
@@ -30,7 +28,6 @@ describe Elasticsearch::API do
     end
 
     context 'when settings are changed' do
-
       before do
         Elasticsearch::API.settings[:foo] = 'bar'
       end

data/spec/elasticsearch/api/client_spec.rb

@@ -18,27 +18,23 @@
 require 'spec_helper'
 
 describe 'API Client' do
-
   let(:client) do
     Class.new { include Elasticsearch::API }.new
   end
 
   describe '#cluster' do
-
     it 'responds to the method' do
       expect(client.respond_to?(:cluster)).to be(true)
     end
   end
 
   describe '#indices' do
-
     it 'responds to the method' do
       expect(client.respond_to?(:indices)).to be(true)
     end
   end
 
   describe '#bulk' do
-
     it 'responds to the method' do
       expect(client.respond_to?(:bulk)).to be(true)
     end

data/spec/elasticsearch/api/perform_request_spec.rb

@@ -0,0 +1,86 @@
+# 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'
+require 'elastic-transport'
+require_relative '../../../utils/thor/endpoint_spec'
+require_relative '../../../utils/thor/generator/files_helper'
+
+describe 'Perform request args' do
+  Elasticsearch::API::FilesHelper.files.each do |filepath|
+    spec = Elasticsearch::API::EndpointSpec.new(filepath)
+    next if spec.module_namespace.flatten.first == '_internal'
+
+    # These are the path parts defined by the user in the method argument
+    defined_path_parts = spec.path_params.inject({}) do |params, part|
+      params.merge(part => 'testing')
+    end
+
+    # These are the required params, we must pass them to the method even when testing
+    required_params = spec.required_parts.inject({}) do |params, part|
+      params.merge(part.to_sym => 'testing')
+    end
+
+    let(:client_double) do
+      Class.new { include Elasticsearch::API }.new.tap do |client|
+        expect(client).to receive(:perform_request) do |_, _, _, _, _, request_params|
+          # The create method ends up becoming an 'index' request
+          if expected_perform_request_params[:endpoint] == 'create'
+            expected_perform_request_params[:endpoint] = 'index'
+          end
+          # Check that the expected hash is passed to the perform_request method
+          expect(request_params).to eq(expected_perform_request_params)
+        end.and_return(response_double)
+      end
+    end
+
+    let(:response_double) do
+      double('response', status: 200, body: {}, headers: {})
+    end
+
+    context("'#{spec.endpoint_name}'") do
+      # The expected hash passed to perform_request contains the endpoint name and any defined path parts
+      let(:expected_perform_request_params) do
+        if defined_path_parts.empty?
+          { endpoint: spec.endpoint_name }
+        else
+          { endpoint: spec.endpoint_name, defined_params:  defined_path_parts}
+        end
+      end
+
+      if spec.path_parts.empty?
+        it "passes the endpoint id to the request" do
+          if spec.module_namespace.empty?
+            client_double.send(spec.method_name, required_params)
+          else
+            client_double.send(spec.module_namespace[0]).send(spec.method_name, required_params)
+          end
+        end
+      else
+        it "passes params to the request with the endpoint id: #{spec.path_parts.keys}" do
+          if spec.module_namespace.empty?
+            client_double.send(spec.method_name, required_params.merge(defined_path_parts))
+          else
+            client_double.send(
+              spec.module_namespace[0]).send(spec.method_name, required_params.merge(defined_path_parts)
+            )
+          end
+        end
+      end
+    end
+  end
+end