elasticsearch-api 8.0.1 → 8.2.0

data/spec/elasticsearch/api/actions/security/suggest_user_profiles_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#security#search_user_profiles' do
+  let(:expected_args) do
+    [
+      method,
+      '_security/profile/_suggest',
+      {},
+      body,
+      {}
+    ]
+  end
+  let(:method) { 'GET' }
+  let(:body) { nil }
+
+  it 'performs the request' do
+    expect(client_double.security.suggest_user_profiles).to be_a Elasticsearch::API::Response
+  end
+
+  context 'when there is a body parameter' do
+    let(:method) { 'POST' }
+    let(:body) { {} }
+
+    it 'performs the request' do
+      expect(client_double.security.suggest_user_profiles(body: {})).to be_a Elasticsearch::API::Response
+    end
+  end
+end

data/spec/elasticsearch/api/rest_api_yaml_spec.rb

@@ -30,10 +30,10 @@ describe 'Rest API YAML tests' do
   REST_API_YAML_FILES.each do |file|
     begin
       test_file = Elasticsearch::RestAPIYAMLTests::TestFile.new(file, ADMIN_CLIENT, REST_API_YAML_SKIP_FEATURES)
-    rescue SkipTestsException => _e
+    rescue SkipTestsException => e
       # If the test file has a `skip` at the top level that applies to this
       # version of Elasticsearch, continue with the next text.
-      LOGGER.info "Skipping #{file} due to 'skip all'."
+      LOGGER.info e.message
       next
     end
 
@@ -69,7 +69,12 @@ describe 'Rest API YAML tests' do
               if task_group.has_match_clauses?
                 task_group.match_clauses.each do |match|
                   it 'contains the expected error in the request response' do
-                    expect(task_group.exception.message).to match(Regexp.new(Regexp.escape(match['match'].values.first.to_s)))
+                    regexp = if (val = match['match'].values.first.to_s).include?('\\s')
+                               Regexp.new(val.gsub('\\\\', '\\').gsub('/', ''))
+                             else
+                               Regexp.new(Regexp.escape(val))
+                             end
+                    expect(task_group.exception.message).to match(regexp)
                   end
                 end
               end

data/spec/unit_tests_platinum/unit/security/activate_user_profile_test.rb

@@ -0,0 +1,40 @@
+# 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 SecurityAuthenticateTest < Minitest::Test
+      context 'Security: Activate User Profile' 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/profile/_activate', url)
+            assert_equal({}, params)
+            assert_equal(body, {})
+            true
+          end.returns(FakeResponse.new)
+
+          subject.security.activate_user_profile(body: {})
+        end
+      end
+    end
+  end
+end

data/spec/unit_tests_platinum/unit/security/get_user_profile_test.rb

@@ -0,0 +1,40 @@
+# 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 SecurityGetUserProfileTest < Minitest::Test
+      context 'Security: Get User Profile' do
+        subject { FakeClient.new }
+
+        should 'perform correct request' do
+          subject.expects(:perform_request).with do |method, url, params, body|
+            assert_equal('GET', method)
+            assert_equal('_security/profile/1', url)
+            assert_equal({}, params)
+            assert_nil(body)
+            true
+          end.returns(FakeResponse.new)
+
+          subject.security.get_user_profile(uid: 1)
+        end
+      end
+    end
+  end
+end

data/spec/unit_tests_platinum/unit/security/oidc_authenticate_test.rb

@@ -0,0 +1,40 @@
+# 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 SecurityOidcAuthenticateTest < Minitest::Test
+      context 'Security: OIDC Authenticate' 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/oidc/authenticate', url)
+            assert_equal({}, params)
+            assert_equal(body, {})
+            true
+          end.returns(FakeResponse.new)
+
+          subject.security.oidc_authenticate(body: {})
+        end
+      end
+    end
+  end
+end

data/spec/unit_tests_platinum/unit/security/oidc_logout_test.rb

@@ -0,0 +1,40 @@
+# 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 SecurityOidcLogoutTest < Minitest::Test
+      context 'Security: OIDC Logout' 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/oidc/logout', url)
+            assert_equal({}, params)
+            assert_equal(body, {})
+            true
+          end.returns(FakeResponse.new)
+
+          subject.security.oidc_logout(body: {})
+        end
+      end
+    end
+  end
+end

data/spec/unit_tests_platinum/unit/security/oidc_prepare_authentication_test.rb

@@ -0,0 +1,40 @@
+# 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 SecurityOidcPrepareAuthenticationTest < Minitest::Test
+      context 'Security: OIDC Prepare_Authentication' 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/oidc/prepare', url)
+            assert_equal({}, params)
+            assert_equal(body, {})
+            true
+          end.returns(FakeResponse.new)
+
+          subject.security.oidc_prepare_authentication(body: {})
+        end
+      end
+    end
+  end
+end

data/spec/unit_tests_platinum/unit/security/update_user_profile_data_test.rb

@@ -0,0 +1,40 @@
+# 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 SecurityUpdateUserProfileTest < Minitest::Test
+      context 'Security: Update User Profile Data' do
+        subject { FakeClient.new }
+
+        should 'perform correct request' do
+          subject.expects(:perform_request).with do |method, url, params, body|
+            assert_equal('PUT', method)
+            assert_equal('_security/profile/1/_data', url)
+            assert_equal({}, params)
+            assert_equal(body, {})
+            true
+          end.returns(FakeResponse.new)
+
+          subject.security.update_user_profile_data(uid: 1, body: {})
+        end
+      end
+    end
+  end
+end

data/spec/unit_tests_platinum/unit/transform/reset_transform_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.transform#reset_transform' do
+  let(:expected_args) do
+    [
+      'POST',
+      '_transform/foo/_reset',
+      {},
+      nil,
+      {}
+    ]
+  end
+
+  it 'performs the request' do
+    expect(client_double.transform.reset_transform(transform_id: 'foo')).to be_a Elasticsearch::API::Response
+  end
+end

data/utils/README.md

@@ -18,6 +18,11 @@ $ thor code:generate
 
 - The Ruby code will be generated in `elasticsearch-api/lib/elasticsearch/api/actions`.
 - The generator runs Rubocop to autolint and clean up the generated files.
+- You can use the environment variable `IGNORE_VERSION` to ignore the current version of the client when generating the source code documentation urls. This is currently used when generating code from `main`:
+
+```bash
+$ IGNORE_VERSION=true thor code:generate
+```
 
 ### Development
 

data/utils/thor/generate_source.rb

@@ -61,6 +61,7 @@ module Elasticsearch
 
       def generate_source
         @output = FilesHelper.output_dir
+        cleanup_directory!
 
         FilesHelper.files.each do |filepath|
           @path = Pathname(filepath)
@@ -74,6 +75,10 @@ module Elasticsearch
           @full_namespace   = __full_namespace
           @namespace_depth  = @full_namespace.size > 0 ? @full_namespace.size - 1 : 0
           @module_namespace = @full_namespace[0, @namespace_depth]
+
+          # Don't generate code for internal APIs:
+          next if @module_namespace.flatten.first == '_internal'
+
           @method_name      = @full_namespace.last
           @parts            = __endpoint_parts
           @params           = @spec['params'] || {}
@@ -87,6 +92,7 @@ module Elasticsearch
 
           @path_to_file = @output.join(@module_namespace.join('/')).join("#{@method_name}.rb")
           dir = @output.join(@module_namespace.join('/'))
+
           empty_directory(dir, verbose: false)
 
           # Write the file with the ERB template:
@@ -283,6 +289,13 @@ module Elasticsearch
         say_status('tree', lines.first + "\n" + lines[1, lines.size].map { |l| ' ' * 14 + l }.join("\n"))
       end
 
+      def cleanup_directory!
+        Dir["#{@output}/**/*.rb"].each do |file|
+          # file = File.join(@output, f)
+          File.delete(file) unless (['.', '..'].include? file) || Pathname(file).directory?
+        end
+      end
+
       def run_rubocop
         system("rubocop -c ./thor/.rubocop.yml --format autogenconf -x #{FilesHelper::output_dir}")
       end

data/utils/thor/generator/files_helper.rb

@@ -49,7 +49,7 @@ module Elasticsearch
         regex = /([0-9]{1,2}\.[0-9x]{1,2})/
         version = Elasticsearch::API::VERSION.match(regex)[0]
         # TODO - How do we fix this so it doesn't depend on which branch we're running from
-        if version == '8.0'
+        if ENV['IGNORE_VERSION']
           documentation_url
         else
           documentation_url.gsub(/\/(current|master|main)\//, "/#{version}/")