[XPACK] Updates API, adds grant_api_key

Author: picandocodigo

elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/security/get_role.rb

@@ -22,7 +22,7 @@ module Security
         module Actions
           # Retrieves roles in the native realm.
           #
-          # @option arguments [String] :name Role name
+          # @option arguments [List] :name A comma-separated list of role names
           # @option arguments [Hash] :headers Custom HTTP headers
           #
           # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/security-api-get-role.html

elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/security/get_role_mapping.rb

@@ -22,7 +22,7 @@ module Security
         module Actions
           # Retrieves role mappings.
           #
-          # @option arguments [String] :name Role-Mapping name
+          # @option arguments [List] :name A comma-separated list of role-mapping names
           # @option arguments [Hash] :headers Custom HTTP headers
           #
           # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/security-api-get-role-mapping.html

elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/security/grant_api_key.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.
+
+module Elasticsearch
+  module XPack
+    module API
+      module Security
+        module Actions
+          # Creates an API key on behalf of another user.
+          #
+          # @option arguments [String] :refresh If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes. (options: true, false, wait_for)
+          # @option arguments [Hash] :headers Custom HTTP headers
+          # @option arguments [Hash] :body The api key request to create an API key (*Required*)
+          #
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/security-api-grant-api-key.html
+          #
+          def grant_api_key(arguments = {})
+            raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
+
+            headers = arguments.delete(:headers) || {}
+
+            arguments = arguments.clone
+
+            method = Elasticsearch::API::HTTP_POST
+            path   = "_security/api_key/grant"
+            params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
+
+            body = arguments[:body]
+            perform_request(method, path, params, body, headers).body
+          end
+
+          # Register this action with its valid params when the module is loaded.
+          #
+          # @since 6.2.0
+          ParamsRegistry.register(:grant_api_key, [
+            :refresh
+          ].freeze)
+        end
+      end
+    end
+  end
+end

elasticsearch-xpack/test/unit/security/grant_api_key_test.rb

@@ -0,0 +1,41 @@
+# 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 'test_helper'
+
+module Elasticsearch
+  module Test
+    class XPackSecurityGrantApiKey < Minitest::Test
+      context "XPack Security: Grant API Key" do
+        subject { FakeClient.new }
+        should "perform correct request" do
+          subject.expects(:perform_request).with do |method, url, params, body|
+            assert_equal('POST', method)
+            assert_equal('_security/api_key/grant', url)
+            assert_equal(Hash.new, params)
+            assert_equal(body, {access_token: 'access_token', api_key: 'api_key', grant_type: 'access_token'})
+            true
+          end.returns(FakeResponse.new)
+
+          subject.xpack.security.grant_api_key(
+            body: {access_token: 'access_token', api_key: 'api_key', grant_type: 'access_token'}
+          )
+        end
+      end
+    end
+  end
+end