elasticsearch-api 7.2.0 → 8.0.0

data/spec/elasticsearch/api/actions/scroll_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#scroll' do
+  context 'with scroll_id as a param' do
+    let(:expected_args) do
+      [
+        'GET',
+        '_search/scroll/cXVlcn...',
+        {},
+        nil,
+        {}
+      ]
+    end
+
+    it 'performs the request' do
+      expect(client_double.scroll(scroll_id: 'cXVlcn...')).to be_a Elasticsearch::API::Response
+    end
+  end
+
+  context 'with scroll_id in the body' do
+    let(:expected_args) do
+      [
+        'POST',
+        '_search/scroll',
+        {},
+        { scroll_id: 'cXVlcn...' },
+        {}
+      ]
+    end
+
+    it 'performs the request' do
+      expect(client_double.scroll(body: { scroll_id: 'cXVlcn...' })).to be_a Elasticsearch::API::Response
+    end
+  end
+end

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

@@ -0,0 +1,53 @@
+# 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#search_mvt' do
+  let(:expected_args) do
+    [
+      method,
+      url,
+      params,
+      body,
+      {}
+    ]
+  end
+
+  context 'with right parameters' do
+    let(:method) { 'POST' }
+    let(:url) { 'foo/_mvt/field/10/57.2127/6.2348' }
+    let(:params) { {} }
+    let(:body) { nil }
+
+    it 'performs the request' do
+      expect(client_double.search_mvt(index: 'foo', field: 'field', zoom: 10, x: 57.2127, y: 6.2348)).to be_a Elasticsearch::API::Response
+    end
+  end
+
+  context 'when a param is missing' do
+    let(:client) do
+      Class.new { include Elasticsearch::API }.new
+    end
+
+    it 'raises an ArgumentError' do
+      expect{
+        client.search_mvt
+      }.to raise_exception(ArgumentError)
+    end
+  end
+end

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

@@ -6,7 +6,7 @@
 # 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
+#   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
@@ -23,12 +23,13 @@ describe 'client#search_shards' do
     [
         'GET',
         '_search_shards',
-        { },
-        nil
+        {},
+        nil,
+        {}
     ]
   end
 
   it 'performs the request' do
-    expect(client_double.search_shards).to eq({})
+    expect(client_double.search_shards).to be_a Elasticsearch::API::Response
   end
 end

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

@@ -6,7 +6,7 @@
 # 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
+#   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
@@ -18,15 +18,16 @@
 require 'spec_helper'
 
 describe 'client#search' do
-
   let(:expected_args) do
     [
-        'GET',
-        url,
-        params,
-        body
+      method,
+      url,
+      params,
+      body,
+      {}
     ]
   end
+  let(:method) { 'GET' }
 
   let(:body) do
     nil
@@ -37,18 +38,18 @@ describe 'client#search' do
   end
 
   let(:url) do
-    '_all/foo/_search'
+    '_search'
   end
 
   it 'has a default value for index' do
-    expect(client_double.search(type: 'foo'))
+    expect(client_double.search())
   end
 
   context 'when a request definition is specified' do
-
     let(:body) do
       { query: { match: {} } }
     end
+    let(:method) { 'POST' }
 
     let(:url) do
       '_search'
@@ -60,7 +61,6 @@ describe 'client#search' do
   end
 
   context 'when an index is specified' do
-
     let(:url) do
       'foo/_search'
     end
@@ -70,19 +70,7 @@ describe 'client#search' do
     end
   end
 
-  context 'when an index and type are specified' do
-
-    let(:url) do
-      'foo/bar/_search'
-    end
-
-    it 'performs the request' do
-      expect(client_double.search(index: 'foo', type: 'bar'))
-    end
-  end
-
   context 'when multiple indices are specified' do
-
     let(:url) do
       'foo,bar/_search'
     end
@@ -92,19 +80,7 @@ describe 'client#search' do
     end
   end
 
-  context 'when multiple indices and types are specified' do
-
-    let(:url) do
-      'foo,bar/lam,bam/_search'
-    end
-
-    it 'performs the request' do
-      expect(client_double.search(index: ['foo', 'bar'], type: ['lam', 'bam']))
-    end
-  end
-
   context 'when there are URL params' do
-
     let(:url) do
       '_search'
     end
@@ -117,32 +93,4 @@ describe 'client#search' do
       expect(client_double.search(search_type: 'count'))
     end
   end
-
-  context 'when there are invalid URL params' do
-
-    let(:client) do
-      Class.new { include Elasticsearch::API }.new
-    end
-
-    it 'raises an ArgumentError' do
-      expect{
-        client.search(search_type: 'count', qwertypoiuy: 'asdflkjhg')
-      }.to raise_exception(ArgumentError)
-    end
-  end
-
-  context 'when the request field params are not URL-encoded' do
-
-    let(:params) do
-      { fields: 'foo^bar'}
-    end
-
-    let(:url) do
-      'foo/bar/_search'
-    end
-
-    it 'does not encode the field params' do
-      expect(client_double.search(index: 'foo', type: 'bar', fields: 'foo^bar'))
-    end
-  end
 end

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

@@ -6,7 +6,7 @@
 # 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
+#   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
@@ -18,17 +18,17 @@
 require 'spec_helper'
 
 describe 'client#search_template' do
-
   let(:expected_args) do
     [
-        'GET',
-        'foo/_search/template',
-        { },
-        { foo: 'bar' }
+      'POST',
+      'foo/_search/template',
+      { },
+      { foo: 'bar' },
+      {}
     ]
   end
 
   it 'performs the request' do
-    expect(client_double.search_template(index: 'foo', body: { foo: 'bar' })).to eq({})
+    expect(client_double.search_template(index: 'foo', body: { foo: 'bar' })).to be_a Elasticsearch::API::Response
   end
 end

data/spec/elasticsearch/api/actions/searchable_snapshots/cache_stats_spec.rb

@@ -0,0 +1,44 @@
+# 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#searchable_snapshots.cache_stats' do
+  let(:expected_args) do
+    [
+      'GET',
+      url,
+      {},
+      nil,
+      {}
+    ]
+  end
+
+  let(:url){ '_searchable_snapshots/cache/stats' }
+
+  it 'performs the request' do
+    expect(client_double.searchable_snapshots.cache_stats).to be_a Elasticsearch::API::Response
+  end
+
+  context 'when using index' do
+    let(:url){ '_searchable_snapshots/foo/cache/stats' }
+
+    it 'performs the request' do
+      expect(client_double.searchable_snapshots.cache_stats(node_id: 'foo')).to be_a Elasticsearch::API::Response
+    end
+  end
+end

data/spec/elasticsearch/api/actions/searchable_snapshots/clear_cache_spec.rb

@@ -0,0 +1,44 @@
+# 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#searchable_snapshots.clear_cache' do
+  let(:expected_args) do
+    [
+      'POST',
+      url,
+      {},
+      nil,
+      {}
+    ]
+  end
+
+  let(:url){ '_searchable_snapshots/cache/clear' }
+
+  it 'performs the request' do
+    expect(client_double.searchable_snapshots.clear_cache).to be_a Elasticsearch::API::Response
+  end
+
+  context 'when using index' do
+    let(:url){ 'foo/_searchable_snapshots/cache/clear' }
+
+    it 'performs the request' do
+      expect(client_double.searchable_snapshots.clear_cache(index: 'foo')).to be_a Elasticsearch::API::Response
+    end
+  end
+end

data/spec/elasticsearch/api/actions/searchable_snapshots/mount_spec.rb

@@ -0,0 +1,56 @@
+# 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#searchable_snapshots.mount' do
+  let(:expected_args) do
+    [
+      'POST',
+      '_snapshot/foo/bar/_mount',
+      {},
+      {},
+      {}
+    ]
+  end
+
+  it 'performs the request' do
+    expect(client_double.searchable_snapshots.mount(body: {}, repository: 'foo', snapshot: 'bar')).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.searchable_snapshots.mount(repository: 'foo', snapshot: 'bar')
+    }.to raise_exception(ArgumentError)
+  end
+
+  it 'requires the :repository argument' do
+    expect {
+      client.searchable_snapshots.mount(body: {}, snapshot: 'bar')
+    }.to raise_exception(ArgumentError)
+  end
+
+  it 'requires the :snapshot argument' do
+    expect {
+      client.searchable_snapshots.mount(body: {}, repository: 'bar')
+    }.to raise_exception(ArgumentError)
+  end
+end

data/spec/elasticsearch/api/actions/searchable_snapshots/stats_spec.rb

@@ -0,0 +1,43 @@
+# 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#searchable_snapshots.stats' do
+  let(:expected_args) do
+    [
+      'GET',
+      url,
+      {},
+      nil,
+      {}
+    ]
+  end
+  let(:url) { '_searchable_snapshots/stats' }
+
+  it 'performs the request' do
+    expect(client_double.searchable_snapshots.stats).to be_a Elasticsearch::API::Response
+  end
+
+  context 'using index' do
+    let(:url) { 'foo/_searchable_snapshots/stats' }
+
+    it 'performs the request' do
+      expect(client_double.searchable_snapshots.stats(index: 'foo')).to be_a Elasticsearch::API::Response
+    end
+  end
+end

data/spec/elasticsearch/api/actions/security/clear_cached_service_tokens_spec.rb

@@ -0,0 +1,58 @@
+# 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#security#clear_cached_service_tokens' do
+  let(:expected_args) do
+    [
+      'POST',
+      '_security/service/foo/bar/credential/token/service_token/_clear_cache',
+      {},
+      nil,
+      {}
+    ]
+  end
+
+  it 'performs the request' do
+    expect(client_double.security.clear_cached_service_tokens(
+             namespace: 'foo', service: 'bar', name: 'service_token')
+          ).to be_a Elasticsearch::API::Response
+  end
+
+  let(:client) do
+    Class.new { include Elasticsearch::API }.new
+  end
+
+  it 'requires the :namespace argument' do
+    expect {
+      client.security.clear_cached_service_tokens(service: 'bar', name: 'service_token')
+    }.to raise_exception(ArgumentError)
+  end
+
+  it 'requires the :service argument' do
+    expect {
+      client.security.clear_cached_service_tokens(namespace: 'foo', name: 'service_token')
+    }.to raise_exception(ArgumentError)
+  end
+
+  it 'requires the :name argument' do
+    expect {
+      client.security.clear_cached_service_tokens(service: 'bar', namespace: 'foo')
+    }.to raise_exception(ArgumentError)
+  end
+end

data/spec/elasticsearch/api/actions/security/create_api_key_spec.rb

@@ -0,0 +1,79 @@
+# 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#security#create_api_key' do
+
+  let(:expected_args) do
+    [
+        'PUT',
+        '_security/api_key',
+        {},
+        body,
+        {}
+    ]
+  end
+
+  let(:body) do
+    {
+        "name": "my-api-key",
+        "expiration": "1d",
+        "role_descriptors": {
+            "role-a": {
+                "cluster": ["all"],
+                "index": [
+                    {
+                        "names": ["index-a"],
+                        "privileges": ["read"]
+                    }
+                ]
+            },
+            "role-b": {
+                "cluster": ["manage"],
+                "index": [
+                    {
+                        "names": ["index-b"],
+                        "privileges": ["all"]
+                    }
+                ]
+            }
+        }
+    }
+  end
+
+  it 'performs the request' do
+    expect(client_double.security.create_api_key(body: body)).to be_a Elasticsearch::API::Response
+  end
+
+  context 'when params are specified' do
+
+    let(:expected_args) do
+      [
+          'PUT',
+          '_security/api_key',
+          { refresh: 'wait_for' },
+          body,
+          {}
+      ]
+    end
+
+    it 'performs the request' do
+      expect(client_double.security.create_api_key(body: body, refresh: 'wait_for')).to be_a Elasticsearch::API::Response
+    end
+  end
+end

data/spec/elasticsearch/api/actions/security/create_service_token_spec.rb

@@ -0,0 +1,54 @@
+# 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#security#create_service_token' do
+  let(:expected_args) do
+    [
+      'PUT',
+      '_security/service/foo/bar/credential/token',
+      {},
+      nil,
+      {}
+    ]
+  end
+
+  it 'performs the request' do
+    expect(
+      client_double.security.create_service_token(
+        namespace: 'foo', service: 'bar'
+      )
+    ).to be_a Elasticsearch::API::Response
+  end
+
+  let(:client) do
+    Class.new { include Elasticsearch::API }.new
+  end
+
+  it 'requires the :namespace argument' do
+    expect {
+      client.security.create_service_token(service: 'bar')
+    }.to raise_exception(ArgumentError)
+  end
+
+  it 'requires the :service argument' do
+    expect {
+      client.security.create_service_token(namespace: 'foo')
+    }.to raise_exception(ArgumentError)
+  end
+end