elasticsearch-api 8.8.0 → 8.9.0

data/spec/elasticsearch/api/actions/query_ruleset/delete_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.query_ruleset#delete' do
+
+  let(:expected_args) do
+    [
+      'DELETE',
+      '_query_rules/foo',
+      {},
+      nil,
+      {}
+    ]
+  end
+
+  it 'performs the request' do
+    expect(client_double.query_ruleset.delete(ruleset_id: 'foo')).to be_a Elasticsearch::API::Response
+  end
+end

data/spec/elasticsearch/api/actions/query_ruleset/get_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.query_ruleset#get' do
+
+  let(:expected_args) do
+    [
+      'GET',
+      '_query_rules/foo',
+      {},
+      nil,
+      {}
+    ]
+  end
+
+  it 'performs the request' do
+    expect(client_double.query_ruleset.get(ruleset_id: 'foo')).to be_a Elasticsearch::API::Response
+  end
+end

data/spec/elasticsearch/api/actions/query_ruleset/put_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.query_ruleset#put' do
+
+  let(:expected_args) do
+    [
+      'PUT',
+      '_query_rules/foo',
+      {},
+      {},
+      {}
+    ]
+  end
+
+  it 'performs the request' do
+    expect(client_double.query_ruleset.put(body: {}, ruleset_id: 'foo')).to be_a Elasticsearch::API::Response
+  end
+end

data/spec/elasticsearch/api/actions/search_application/render_query_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.search_application#render_query' do
+  let(:expected_args) do
+    [
+      'POST',
+      '_application/search_application/foo/_render_query',
+      {},
+      nil,
+      {}
+    ]
+  end
+
+  it 'performs the request' do
+    expect(client_double.search_application.render_query(name: 'foo')).to be_a Elasticsearch::API::Response
+  end
+end

data/spec/elasticsearch/api/actions/security/create_cross_cluster_api_key_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#security#create_api_key' do
+
+  let(:expected_args) do
+    [
+      'POST',
+      '_security/cross_cluster/api_key',
+      {},
+      {},
+      {}
+    ]
+  end
+
+  it 'performs the request' do
+    expect(client_double.security.create_cross_cluster_api_key(body: {})).to be_a Elasticsearch::API::Response
+  end
+end

data/spec/elasticsearch/api/actions/security/update_cross_cluster_api_key_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#security#create_api_key' do
+
+  let(:expected_args) do
+    [
+      'PUT',
+      '_security/cross_cluster/api_key/the_id',
+      {},
+      {},
+      {}
+    ]
+  end
+
+  it 'performs the request' do
+    expect(client_double.security.update_cross_cluster_api_key(id: 'the_id', body: {})).to be_a Elasticsearch::API::Response
+  end
+end

data/spec/elasticsearch/api/actions/synonym_rule/put_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.synonym_rule#put' do
+  let(:expected_args) do
+    [
+      'PUT',
+      '_synonyms/set/rule',
+      {},
+      {},
+      {}
+    ]
+  end
+
+  it 'performs the request' do
+    expect(client_double.synonym_rule.put(body: {}, synonyms_set: 'set', synonym_rule: 'rule')).to be_a Elasticsearch::API::Response
+  end
+end

data/spec/elasticsearch/api/actions/synonyms/update_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.synonyms#put' do
+  let(:expected_args) do
+    [
+      'PUT',
+      '_synonyms/foo',
+      {},
+      {},
+      {}
+    ]
+  end
+
+  it 'performs the request' do
+    expect(client_double.synonyms.put(body: {}, synonyms_set: 'foo')).to be_a Elasticsearch::API::Response
+  end
+end

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

data/spec/platinum/integration/api_key/api_key_cross_cluster_spec.rb

@@ -0,0 +1,129 @@
+# 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 'base64'
+require_relative '../platinum_helper'
+
+describe 'API keys API' do
+  let(:user) { 'admin_user' }
+  let(:password) { 'x-pack-test-password' }
+  before do
+    ADMIN_CLIENT.security.put_role(
+      name: 'admin_role',
+      body: { cluster: ['manage_security'] }
+    )
+    ADMIN_CLIENT.security.put_user(
+      username: user,
+      body: {
+        password: password,
+        roles: [ 'admin_role' ],
+        full_name: 'Admin user'
+      }
+    )
+  end
+
+  after do
+    ADMIN_CLIENT.security.delete_role(name: 'admin_role', ignore: 404)
+    ADMIN_CLIENT.security.delete_user(username: user, ignore: 404)
+  end
+
+  let(:client) do
+    Elasticsearch::Client.new(
+      host: "https://admin_user:x-pack-test-password@#{HOST_URI.host}:#{HOST_URI.port}",
+      transport_options: TRANSPORT_OPTIONS
+    )
+  end
+
+  describe 'Cross Cluster API Key' do
+    it 'updates api key' do
+      response = client.security.create_cross_cluster_api_key(
+        body: {
+          name: "my-cc-api-key",
+          expiration: "1d",
+          access: {
+            search: [
+              {
+                names: ["logs*"],
+                query: {
+                  term: { "category": "shared" }
+                },
+                field_security: {
+                  grant: ["*"],
+                  except: ["private"]
+                }
+              }
+            ],
+            replication: [
+              {
+                names: ["archive"],
+                allow_restricted_indices: false
+              }
+            ]
+          },
+          metadata: {
+            answer: 42,
+            tag: "dev"
+          }
+        }
+      )
+      expect(response.status).to eq 200
+      expect(response['name']).to eq 'my-cc-api-key'
+      id = response['id']
+      expect(id).not_to be nil
+      expect(response['api_key']).not_to be nil
+      expect(response['expiration']).not_to be nil
+      credentials = Base64.strict_encode64("#{response['id']}:#{response['api_key']}")
+      expect(credentials).to eq response['encoded']
+
+      new_client = Elasticsearch::Client.new(
+        host: "https://#{HOST_URI.host}:#{HOST_URI.port}",
+        transport_options: TRANSPORT_OPTIONS
+      )
+      expect do
+        new_client.security.authenticate(headers: { authorization: "ApiKey #{credentials}" })
+      end.to raise_error(Elastic::Transport::Transport::Errors::Unauthorized)
+
+      response = client.security.get_api_key(id: id, with_limited_by: true)
+      expect(response.status).to eq 200
+      api_key = response['api_keys'].first
+      expect(api_key['name']) == 'my-cc-api-key'
+      expect(api_key['type']) == 'cross_cluster'
+      expect(api_key['invalidated']).to be false
+      expect(api_key['metadata']).to eq({'answer' => 42, 'tag' => 'dev'})
+
+      # Tests update cc api_key
+      response = client.security.update_cross_cluster_api_key(
+        id: id,
+        body: {
+          access: {
+            replication: [{ names: ["archive"] }]
+          },
+          metadata: { "tag": "prod" }
+        }
+      )
+      expect(response['updated']).to be true
+
+      response = client.security.get_api_key(id: id, with_limited_by: true)
+      expect(response['api_keys'].length).to eq 1
+      api_key = response['api_keys'].first
+      expect(api_key['name']) == 'my-cc-api-key'
+      expect(api_key['type']) == 'cross_cluster'
+      expect(api_key['invalidated']).to be false
+      expect(api_key['metadata']).to eq({'tag' => 'prod'})
+    end
+  end
+end

data/spec/platinum/integration/api_key/api_key_invalidation_spec.rb

@@ -0,0 +1,107 @@
+# 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_relative '../platinum_helper'
+
+describe 'API keys API invalidation' do
+  before do
+    ADMIN_CLIENT.security.put_role(
+      name: 'admin_role',
+      body: {
+        cluster: ['manage_api_key']
+      }
+    )
+    ADMIN_CLIENT.security.put_role(
+      name: 'user_role',
+      body: {
+        cluster: ['manage_own_api_key']
+      }
+    )
+    ADMIN_CLIENT.security.put_user(
+      username: 'api_key_manager',
+      body: {
+        password: 'x-pack-test-password',
+        roles: [ 'admin_role' ],
+        full_name: 'API key manager'
+      }
+    )
+    ADMIN_CLIENT.security.put_user(
+      username: 'api_key_user1',
+      body: {
+        password: 'x-pack-test-password',
+        roles: [ 'user_role' ],
+        full_name: 'API key user'
+      }
+    )
+  end
+
+  after do
+    ADMIN_CLIENT.security.delete_role(name: "admin_role", ignore: 404)
+    ADMIN_CLIENT.security.delete_role(name: "user_role", ignore: 404)
+    ADMIN_CLIENT.security.delete_user(username: "api_key_user1", ignore: 404)
+    ADMIN_CLIENT.security.delete_user(username: "api_key_manager", ignore: 404)
+  end
+
+  let(:client) do
+    Elasticsearch::Client.new(
+      host: "https://api_key_manager:x-pack-test-password@#{HOST_URI.host}:#{HOST_URI.port}",
+      transport_options: TRANSPORT_OPTIONS
+    )
+  end
+
+  it 'invalidates by realm name' do
+    response = client.security.create_api_key(
+      body: {
+        name: "manager-api-key",
+        expiration: "1d",
+        role_descriptors: {}
+      }
+    )
+    expect(response['name']).to eq 'manager-api-key'
+    id = response['id']
+    expect(id).not_to be nil
+    expect(response['api_key']).not_to be nil
+    expect(response['expiration']).not_to be nil
+
+    user_client = Elasticsearch::Client.new(
+      host: "https://#{HOST_URI.host}:#{HOST_URI.port}",
+      user: 'api_key_user1',
+      password: 'x-pack-test-password',
+      transport_options: TRANSPORT_OPTIONS
+    )
+    response = user_client.security.create_api_key(
+      body: {
+        name: "user1-api-key",
+        expiration: "1d",
+        role_descriptors: {}
+      }
+    )
+    expect(response['name']).to eq 'user1-api-key'
+    id = response['id']
+    expect(id).not_to be nil
+    expect(response['api_key']).not_to be nil
+    expect(response['expiration']).not_to be nil
+
+    expect do
+      user_client.security.invalidate_api_key(body: { realm_name: 'default_native'})
+    end.to raise_error(Elastic::Transport::Transport::Errors::Forbidden)
+
+    response = client.security.invalidate_api_key(body: { realm_name: 'default_native'})
+    expect(response['invalidated_api_keys'].count).to be >= 2
+    expect(response['error_count']).to eq 0
+  end
+end