elasticsearch-api 7.11.2 → 8.6.0

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

@@ -0,0 +1,69 @@
+# 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_path) { '_security/service/foo/bar/credential/token' }
+  let(:expected_request_method) { 'POST' }
+  let(:expected_args) do
+    [
+      expected_request_method,
+      expected_path,
+      {},
+      nil,
+      {}
+    ]
+  end
+
+  context 'with token name' do
+    let(:expected_request_method) { 'PUT' }
+    let(:token_name) { 'test-token' }
+    let(:expected_path) { "#{super()}/#{token_name}" }
+    it 'performs the request' do
+      expect(
+        client_double.security.create_service_token(
+          namespace: 'foo', service: 'bar', name: token_name
+        )
+      ).to be_a Elasticsearch::API::Response
+    end
+  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

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

@@ -0,0 +1,60 @@
+# 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#delete_service_token' do
+  let(:expected_args) do
+    [
+      'DELETE',
+      '_security/service/foo/bar/credential/token/service_token',
+      {},
+      nil,
+      {}
+    ]
+  end
+
+  it 'performs the request' do
+    expect(
+      client_double.security.delete_service_token(
+        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.delete_service_token(service: 'bar', name: 'service_token')
+    }.to raise_exception(ArgumentError)
+  end
+
+  it 'requires the :service argument' do
+    expect {
+      client.security.delete_service_token(namespace: 'foo', name: 'service_token')
+    }.to raise_exception(ArgumentError)
+  end
+
+  it 'requires the :name argument' do
+    expect {
+      client.security.delete_service_token(namespace: 'foo', service: 'bar')
+    }.to raise_exception(ArgumentError)
+  end
+end

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

@@ -0,0 +1,34 @@
+# 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#disable_user_profile' do
+  let(:expected_args) do
+    [
+      'PUT',
+      '_security/profile/foo/_disable',
+      {},
+      nil,
+      {}
+    ]
+  end
+
+  it 'performs the request' do
+    expect(client_double.security.disable_user_profile(uid: 'foo')).to be_a Elasticsearch::API::Response
+  end
+end

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

@@ -0,0 +1,34 @@
+# 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#enable_user_profile' do
+  let(:expected_args) do
+    [
+      'PUT',
+      '_security/profile/foo/_enable',
+      {},
+      nil,
+      {}
+    ]
+  end
+
+  it 'performs the request' do
+    expect(client_double.security.enable_user_profile(uid: 'foo')).to be_a Elasticsearch::API::Response
+  end
+end

data/spec/elasticsearch/api/actions/{indices/upgrade_spec.rb → security/enroll_kibana_spec.rb}

@@ -17,19 +17,18 @@
 
 require 'spec_helper'
 
-describe 'client.cluster#upgrade' do
-
+describe 'client#security#enroll_kibana' do
   let(:expected_args) do
     [
-        'POST',
-        '_upgrade',
-        {},
-        nil,
-        {}
+      'GET',
+      '_security/enroll/kibana',
+      {},
+      nil,
+      {}
     ]
   end
 
   it 'performs the request' do
-    expect(client_double.indices.upgrade).to eq({})
+    expect(client_double.security.enroll_kibana).to be_a Elasticsearch::API::Response
   end
 end

data/spec/elasticsearch/api/actions/security/get_api_key_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#security#get_api_key' do
+
+  let(:expected_args) do
+    [
+        'GET',
+        '_security/api_key',
+        params,
+        nil,
+        {}
+    ]
+  end
+
+  let(:params) do
+    {}
+  end
+
+  it 'performs the request' do
+    expect(client_double.security.get_api_key).to be_a Elasticsearch::API::Response
+  end
+
+  context 'when params are specified' do
+
+    let(:params) do
+      { id: '1',
+        username: 'user',
+        name: 'my-api-key',
+        realm_name: '_es_api_key' }
+    end
+
+    it 'performs the request' do
+      expect(client_double.security.get_api_key(id: '1',
+                                                   username: 'user',
+                                                   name: 'my-api-key',
+                                                   realm_name: '_es_api_key')).to be_a Elasticsearch::API::Response
+    end
+  end
+end

data/spec/elasticsearch/api/actions/{remote/info_spec.rb → security/get_builtin_privileges_spec.rb}

@@ -17,19 +17,19 @@
 
 require 'spec_helper'
 
-describe 'client.remote#info' do
+describe 'client#security#get_builtin_privileges' do
 
   let(:expected_args) do
     [
         'GET',
-        '_remote/info',
+        '_security/privilege/_builtin',
         {},
         nil,
-        nil
+        {}
     ]
   end
 
   it 'performs the request' do
-    expect(client_double.remote.info).to eq({})
+    expect(client_double.security.get_builtin_privileges).to be_a Elasticsearch::API::Response
   end
 end

data/spec/elasticsearch/api/actions/security/get_service_accounts_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#get_service_accounts' do
+  let(:expected_args) do
+    [
+      'GET',
+      url,
+      {},
+      nil,
+      {}
+    ]
+  end
+
+  let(:url) { '_security/service' }
+
+  it 'performs the request' do
+    expect(
+      client_double.security.get_service_accounts
+    ).to be_a Elasticsearch::API::Response
+  end
+
+  context 'when using namespace' do
+    let(:url) { '_security/service/foo' }
+
+    it 'performs the request' do
+      expect(
+        client_double.security.get_service_accounts(namespace: 'foo')
+      ).to be_a Elasticsearch::API::Response
+    end
+  end
+
+  context 'when using namespace and service' do
+    let(:url) { '_security/service/foo/bar' }
+
+    it 'performs the request' do
+      expect(
+        client_double.security.get_service_accounts(namespace: 'foo', service: 'bar')
+      ).to be_a Elasticsearch::API::Response
+    end
+  end
+end

data/spec/elasticsearch/api/actions/security/get_service_credentials_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#security#get_service_credentials' do
+  let(:expected_args) do
+    [
+      'GET',
+      '_security/service/foo/bar/credential',
+      {},
+      nil,
+      {}
+    ]
+  end
+
+  it 'performs the request' do
+    expect(
+      client_double.security.get_service_credentials(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.get_service_credentials(service: 'bar')
+    }.to raise_exception(ArgumentError)
+  end
+
+  it 'requires the :service argument' do
+    expect {
+      client.security.get_service_credentials(namespace: 'foo')
+    }.to raise_exception(ArgumentError)
+  end
+
+end

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

@@ -0,0 +1,34 @@
+# 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#has_privileges_user_profile' do
+  let(:expected_args) do
+    [
+      'POST',
+      '_security/profile/_has_privileges',
+      {},
+      {},
+      {}
+    ]
+  end
+
+  it 'performs the request' do
+    expect(client_double.security.has_privileges_user_profile(body: {})).to be_a Elasticsearch::API::Response
+  end
+end

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

@@ -0,0 +1,38 @@
+# 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#invalidate_api_key_sp' do
+  let(:expected_args) do
+    [
+      'DELETE',
+      '_security/api_key',
+      {},
+      body,
+      {}
+    ]
+  end
+
+  let(:body) do
+    { id: 1 }
+  end
+
+  it 'performs the request' do
+    expect(client_double.security.invalidate_api_key(body: body)).to be_a Elasticsearch::API::Response
+  end
+end

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

@@ -0,0 +1,48 @@
+# 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#query_api_keys' do
+  let(:expected_args) do
+    [
+      method,
+      '_security/_query/api_key',
+      {},
+      body,
+      {}
+    ]
+  end
+
+  let(:body) { nil }
+  let(:method) { 'GET' }
+
+  it 'performs the request' do
+    expect(client_double.security.query_api_keys).to be_a Elasticsearch::API::Response
+  end
+
+  context 'when body is specified' do
+    let(:body) do
+      { size: 1, query: 'test' }
+    end
+    let(:method) { 'POST' }
+
+    it 'performs the request' do
+      expect(client_double.security.query_api_keys(body: body)).to be_a Elasticsearch::API::Response
+    end
+  end
+end

data/spec/elasticsearch/api/actions/security/saml_authenticate_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.security#saml_authenticate' do
+  let(:expected_args) do
+    [
+      'POST',
+      '_security/saml/authenticate',
+      {},
+      {},
+      {}
+    ]
+  end
+
+  it 'performs the request' do
+    expect(client_double.security.saml_authenticate(body: {})).to be_a Elasticsearch::API::Response
+  end
+
+  let(:client) do
+    Class.new { include Elasticsearch::API }.new
+  end
+
+  it 'raises an error if no body is provided' do
+    expect do
+      client.security.saml_authenticate
+    end.to raise_exception(ArgumentError)
+  end
+end

data/spec/elasticsearch/api/actions/security/saml_complete_logout_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#security.saml_complete_logout' do
+  let(:expected_args) do
+    [
+      'POST',
+      '_security/saml/complete_logout',
+      {},
+      {},
+      {}
+    ]
+  end
+
+  it 'performs the request' do
+    expect(client_double.security.saml_complete_logout(body: {})).to be_a Elasticsearch::API::Response
+  end
+
+  let(:client) do
+    Class.new { include Elasticsearch::API }.new
+  end
+
+  it 'requires the :namespace argument' do
+    expect do
+      client.security.saml_complete_logout
+    end.to raise_exception(ArgumentError)
+  end
+end

data/spec/elasticsearch/api/actions/security/saml_invalidate_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.security#saml_invalidate' do
+  let(:expected_args) do
+    [
+      'POST',
+      '_security/saml/invalidate',
+      {},
+      {},
+      {}
+    ]
+  end
+
+  it 'performs the request' do
+    expect(client_double.security.saml_invalidate(body: {})).to be_a Elasticsearch::API::Response
+  end
+
+  let(:client) do
+    Class.new { include Elasticsearch::API }.new
+  end
+
+  it 'raises an error if no body is provided' do
+    expect do
+      client.security.saml_invalidate
+    end.to raise_exception(ArgumentError)
+  end
+end