elasticsearch-api 7.13.3 → 8.14.0

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

@@ -24,7 +24,8 @@ describe 'client#explain' do
       url,
       params,
       body,
-      {}
+      {},
+      { defined_params: { id: 1, index: 'foo' }, endpoint: 'explain' }
     ]
   end
 
@@ -39,7 +40,7 @@ describe 'client#explain' do
   end
 
   let(:url) do
-    'foo/bar/1/_explain'
+    'foo/_explain/1'
   end
 
   let(:client) do
@@ -48,18 +49,18 @@ describe 'client#explain' do
 
   it 'requires the :index argument' do
     expect {
-      client.explain(type: 'bar', id: '1')
+      client.explain(id: '1')
     }.to raise_exception(ArgumentError)
   end
 
   it 'requires the :id argument' do
     expect {
-      client.explain(index: 'foo', type: 'bar')
+      client.explain(index: 'foo')
     }.to raise_exception(ArgumentError)
   end
-  
+
   it 'performs the request' do
-    expect(client_double.explain(index: 'foo', type: 'bar', id: 1, body: {})).to eq({})
+    expect(client_double.explain(index: 'foo', id: 1, body: {})).to be_a Elasticsearch::API::Response
   end
 
   context 'when a query is provided' do
@@ -68,12 +69,23 @@ describe 'client#explain' do
       { q: 'abc123' }
     end
 
+    let(:expected_args) do
+      [
+        method,
+        url,
+        params,
+        body,
+        {},
+        { defined_params: { id: '1', index: 'foo' }, endpoint: 'explain' }
+      ]
+    end
+
     let(:body) do
       nil
     end
 
     it 'passes the query' do
-      expect(client_double.explain(index: 'foo', type: 'bar', id: '1', q: 'abc123')).to eq({})
+      expect(client_double.explain(index: 'foo', id: '1', q: 'abc123')).to be_a Elasticsearch::API::Response
     end
   end
 
@@ -82,18 +94,40 @@ describe 'client#explain' do
       { query: { match: {} } }
     end
 
+    let(:expected_args) do
+      [
+        method,
+        url,
+        params,
+        body,
+        {},
+        { defined_params: { id: '1', index: 'foo' }, endpoint: 'explain' }
+      ]
+    end
+
     it 'passes the query definition' do
-      expect(client_double.explain(index: 'foo', type: 'bar', id: '1', body: { query: { match: {} } })).to eq({})
+      expect(client_double.explain(index: 'foo', id: '1', body: { query: { match: {} } })).to be_a Elasticsearch::API::Response
     end
   end
 
   context 'when the request needs to be URL-escaped' do
     let(:url) do
-      'foo%5Ebar/bar%2Fbam/1/_explain'
+      'foo%5Ebar/_explain/1'
+    end
+
+    let(:expected_args) do
+      [
+        method,
+        url,
+        params,
+        body,
+        {},
+        { defined_params: { id: '1', index: 'foo^bar' }, endpoint: 'explain' }
+      ]
     end
 
     it 'URL-escapes the parts' do
-      expect(client_double.explain(index: 'foo^bar', type: 'bar/bam', id: '1', body: { })).to eq({})
+      expect(client_double.explain(index: 'foo^bar', id: '1', body: { })).to be_a Elasticsearch::API::Response
     end
   end
 end

data/spec/elasticsearch/api/actions/features/get_features_spec.rb

@@ -17,18 +17,23 @@
 
 require 'spec_helper'
 
-describe 'client.featues#get_features' do
+describe 'client.features#get_features' do
   let(:expected_args) do
     [
-      'GET',
-      '_features',
-      {},
-      nil,
-      {}
+        'GET',
+        '_features',
+        {},
+        nil,
+        {},
+        { endpoint: 'features.get_features' }
     ]
   end
 
+  let(:client) do
+    Class.new { include Elasticsearch::API }.new
+  end
+
   it 'performs the request' do
-    expect(client_double.features.get_features).to eq({})
+    expect(client_double.features.get_features).to be_a Elasticsearch::API::Response
   end
 end

data/spec/elasticsearch/api/actions/features/reset_features_spec.rb

@@ -17,18 +17,23 @@
 
 require 'spec_helper'
 
-describe 'client.featues#reset_features' do
+describe 'client.features#reset_features' do
   let(:expected_args) do
     [
-      'POST',
-      '_features/_reset',
-      {},
-      nil,
-      {}
+        'POST',
+        '_features/_reset',
+        {},
+        nil,
+        {},
+        { endpoint: 'features.reset_features' }
     ]
   end
 
+  let(:client) do
+    Class.new { include Elasticsearch::API }.new
+  end
+
   it 'performs the request' do
-    expect(client_double.features.reset_features).to eq({})
+    expect(client_double.features.reset_features).to be_a Elasticsearch::API::Response
   end
 end

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

@@ -25,11 +25,12 @@ describe 'client#field_caps' do
         'foo/_field_caps',
         { fields: 'bar' },
         nil,
-        {}
+        {},
+        { defined_params: { index: 'foo' }, endpoint: 'field_caps' }
     ]
   end
 
   it 'performs the request' do
-    expect(client_double.field_caps(index: 'foo', fields: 'bar')).to eq({})
+    expect(client_double.field_caps(index: 'foo', fields: 'bar')).to be_a Elasticsearch::API::Response
   end
 end

data/spec/elasticsearch/api/actions/fleet/global_checkpoints_spec.rb

@@ -0,0 +1,45 @@
+# 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#fleet.global_checkpoints' do
+  let(:expected_args) do
+    [
+      'GET',
+      'foo/_fleet/global_checkpoints',
+      {},
+      nil,
+      {},
+      { defined_params: { index: 'foo' }, endpoint: 'fleet.global_checkpoints' }
+    ]
+  end
+
+  it 'performs the request' do
+    expect(client_double.fleet.global_checkpoints(index: 'foo')).to be_a Elasticsearch::API::Response
+  end
+
+  let(:client) do
+    Class.new { include Elasticsearch::API }.new
+  end
+
+  it 'requires the :index argument' do
+    expect {
+      client.fleet.global_checkpoints
+    }.to raise_exception(ArgumentError)
+  end
+end

data/spec/elasticsearch/api/actions/fleet/msearch_spec.rb

@@ -0,0 +1,45 @@
+# 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#fleet.msearch' do
+  let(:expected_args) do
+    [
+      'POST',
+      '_fleet/_fleet_msearch',
+      {},
+      {},
+      { 'Content-Type' => 'application/x-ndjson' },
+      { endpoint: 'fleet.msearch' }
+    ]
+  end
+
+  it 'performs the request' do
+    expect(client_double.fleet.msearch(body: {})).to be_a Elasticsearch::API::Response
+  end
+
+  let(:client) do
+    Class.new { include Elasticsearch::API }.new
+  end
+
+  it 'requires the :body argument' do
+    expect {
+      client.fleet.msearch
+    }.to raise_exception(ArgumentError)
+  end
+end

data/spec/elasticsearch/api/actions/fleet/search_spec.rb

@@ -0,0 +1,45 @@
+# 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#fleet.search' do
+  let(:expected_args) do
+    [
+      'GET',
+      'foo/_fleet/_fleet_search',
+      {},
+      nil,
+      {},
+      { defined_params: { index: 'foo' }, endpoint: 'fleet.search' }
+    ]
+  end
+
+  it 'performs the request' do
+    expect(client_double.fleet.search(index: 'foo')).to be_a Elasticsearch::API::Response
+  end
+
+  let(:client) do
+    Class.new { include Elasticsearch::API }.new
+  end
+
+  it 'requires the :index argument' do
+    expect {
+      client.fleet.search
+    }.to raise_exception(ArgumentError)
+  end
+end

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

@@ -25,7 +25,8 @@ describe 'client#get_source' do
         url,
         params,
         nil,
-        {}
+        {},
+        { defined_params: { id: '1', index: 'foo' }, endpoint: 'get_source'   }
     ]
   end
 
@@ -34,7 +35,7 @@ describe 'client#get_source' do
   end
 
   let(:url) do
-    'foo/bar/1/_source'
+    'foo/_source/1'
   end
 
   let(:client) do
@@ -43,46 +44,45 @@ describe 'client#get_source' do
 
   it 'requires the :index argument' do
     expect {
-      client.get_source(type: 'bar', id: '1')
+      client.get_source(id: '1')
     }.to raise_exception(ArgumentError)
   end
 
   it 'requires the :id argument' do
     expect {
-      client.get_source(index: 'foo', type: 'bar')
+      client.get_source(index: 'foo')
     }.to raise_exception(ArgumentError)
   end
 
-  context 'when the type parameter is not provided' do
-
-    let(:url) do
-      'foo/_source/1'
-    end
-
-    it 'performs the request' do
-      expect(client_double.get_source(index: 'foo', id: '1')).to eq({})
-    end
-  end
-
   context 'when URL parameters are provided' do
-
     let(:params) do
       { routing: 'abc123' }
     end
 
     it 'Passes the URL params' do
-      expect(client_double.get_source(index: 'foo', type: 'bar', id: '1', routing: 'abc123')).to eq({})
+      expect(client_double.get_source(index: 'foo', id: '1', routing: 'abc123')).to be_a Elasticsearch::API::Response
     end
   end
 
   context 'when the request needs to be URL-escaped' do
 
     let(:url) do
-      'foo%5Ebar/bar%2Fbam/1/_source'
+      'foo%5Ebar/_source/1'
+    end
+
+    let(:expected_args) do
+      [
+        'GET',
+        url,
+        params,
+        nil,
+        {},
+        { defined_params: { id: '1', index: 'foo^bar' }, endpoint: 'get_source'   }
+      ]
     end
 
     it 'URL-escapes the parts' do
-      expect(client_double.get_source(index: 'foo^bar', type: 'bar/bam', id: '1')).to eq({})
+      expect(client_double.get_source(index: 'foo^bar', id: '1')).to be_a Elasticsearch::API::Response
     end
   end
 

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

@@ -25,7 +25,8 @@ describe 'client#get' do
         url,
         params,
         nil,
-        {}
+        {},
+        { defined_params: { id: '1', index: 'foo' }, endpoint: 'get' }
     ]
   end
 
@@ -34,7 +35,7 @@ describe 'client#get' do
   end
 
   let(:url) do
-    'foo/bar/1'
+    'foo/_doc/1'
   end
 
   let(:client) do
@@ -43,60 +44,48 @@ describe 'client#get' do
 
   it 'requires the :index argument' do
     expect {
-      client.get(type: 'bar', id: '1')
+      client.get(id: '1')
     }.to raise_exception(ArgumentError)
   end
 
   it 'requires the :id argument' do
     expect {
-      client.get(index: 'foo', type: 'bar')
+      client.get(index: 'foo')
     }.to raise_exception(ArgumentError)
   end
 
-  context 'when the type parameter is not provided' do
-
-    let(:url) do
-      'foo/_doc/1'
-    end
-
-    it 'performs the request' do
-      expect(client_double.get(index: 'foo', id: '1')).to eq({})
-    end
-  end
-
   context 'when URL parameters are provided' do
-
     let(:params) do
       { routing: 'abc123' }
     end
 
     it 'Passes the URL params' do
-      expect(client_double.get(index: 'foo', type: 'bar', id: '1', routing: 'abc123')).to eq({})
-    end
-  end
-
-  context 'when invalid URL parameters are provided' do
-
-    it 'Passes the URL params' do
-      expect {
-        client.get(index: 'foo', type: 'bar', id: '1', qwert: 'abc123')
-      }.to raise_exception(ArgumentError)
+      expect(client_double.get(index: 'foo', id: '1', routing: 'abc123')).to be_a Elasticsearch::API::Response
     end
   end
 
   context 'when the request needs to be URL-escaped' do
-
     let(:url) do
-      'foo%5Ebar/bar%2Fbam/1'
+      'foo%5Ebar/_doc/1'
+    end
+
+    let(:expected_args) do
+      [
+        'GET',
+        url,
+        params,
+        nil,
+        {},
+        { defined_params: { id: '1', index: 'foo^bar' }, endpoint: 'get' }
+      ]
     end
 
     it 'URL-escapes the parts' do
-      expect(client_double.get(index: 'foo^bar', type: 'bar/bam', id: '1')).to eq({})
+      expect(client_double.get(index: 'foo^bar', id: '1')).to be_a Elasticsearch::API::Response
     end
   end
 
   context 'when the request raises a NotFound error' do
-
     before do
       expect(client).to receive(:perform_request).and_raise(NotFound)
     end
@@ -108,9 +97,7 @@ describe 'client#get' do
     end
 
     context 'when the ignore option is provided' do
-
       context 'when the response is 404' do
-
         let(:params) do
           { ignore: 404 }
         end

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

@@ -25,7 +25,8 @@ describe 'client#get_script' do
         url,
         params,
         nil,
-        {}
+        {},
+        { defined_params: { id: 'foo' }, endpoint: 'get_script' }
     ]
   end
 
@@ -44,7 +45,7 @@ describe 'client#get_script' do
     end
 
     it 'performs the request' do
-      expect(client_double.get_script(master_timeout: '1s', id: 'foo')).to eq({})
+      expect(client_double.get_script(master_timeout: '1s', id: 'foo')).to be_a Elasticsearch::API::Response
     end
   end
 end

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

@@ -0,0 +1,52 @@
+# 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#health_report' do
+  let(:expected_args) do
+    [
+      'GET',
+      '_health_report',
+      {},
+      nil,
+      {},
+      { endpoint: 'health_report' }
+    ]
+  end
+
+  it 'performs the request' do
+    expect(client_double.health_report).to be_a Elasticsearch::API::Response
+  end
+
+  context 'when a feature is specified' do
+    let(:expected_args) do
+      [
+        'GET',
+        '_health_report/foo',
+        {},
+        nil,
+        {},
+        { defined_params: { feature: 'foo' }, endpoint: 'health_report' }
+      ]
+    end
+
+    it 'performs the request' do
+      expect(client_double.health_report(feature: 'foo')).to be_a Elasticsearch::API::Response
+    end
+  end
+end