elastic-enterprise-search 7.17.0 → 8.0.1

data/spec/integration/workplace-search/external_identities_spec.rb

@@ -25,33 +25,42 @@ describe Elastic::EnterpriseSearch::WorkplaceSearch::Client do
       delete_content_sources
     end
 
-    let(:content_source_id) { client.create_content_source(name: 'my_content').body['id'] }
-    let(:user) { 'elastic_user' }
-    let(:source_user_id) { 'example@elastic.co' }
+    let(:content_source_id) { client.create_content_source(body: { name: 'my_content' }).body['id'] }
+    let(:external_user_id) { 'elastic_user' }
+    let(:user_properties) { ['attribute_name' => '_elasticsearch_username', 'attribute_value' => 'fernando'] }
     let(:body) do
-      { user: user, source_user_id: source_user_id }
+      { external_user_id: external_user_id, permissions: [], external_user_properties: user_properties }
+    end
+    let(:expected_response) do
+      {
+        'content_source_id' => content_source_id,
+        'external_user_id' => external_user_id,
+        'external_user_properties' => user_properties,
+        'permissions' => []
+      }
     end
 
     context 'Creates' do
-      let(:source_user_id) { 'test@elastic.co' }
+      # let(:source_user_id) { 'test@elastic.co' }
       let(:user) { 'test' }
 
       it 'creates an external identity' do
         response = client.create_external_identity(content_source_id, body: body)
 
         expect(response.status).to eq 200
-        expect(response.body).to eq({ 'source_user_id' => source_user_id, 'user' => user })
+        expect(response.body).to eq(expected_response)
 
-        client.delete_external_identity(content_source_id, user: user)
+        client.delete_external_identity(content_source_id, external_user_id: external_user_id)
       end
 
       it 'creates and retrieves' do
         client.create_external_identity(content_source_id, body: body)
-        response = client.external_identity(content_source_id, user: user)
+        response = client.external_identity(content_source_id, external_user_id: external_user_id)
 
         expect(response.status).to eq 200
-        expect(response.body).to eq({ 'source_user_id' => source_user_id, 'user' => user })
-        client.delete_external_identity(content_source_id, user: user)
+
+        expect(response.body).to eq(expected_response)
+        client.delete_external_identity(content_source_id, external_user_id: external_user_id)
       end
     end
 
@@ -63,8 +72,9 @@ describe Elastic::EnterpriseSearch::WorkplaceSearch::Client do
         response = client.list_external_identities(content_source_id)
 
         expect(response.status).to eq 200
-        expect(response.body['results']).to eq([{ 'source_user_id' => source_user_id, 'user' => user }])
-        client.delete_external_identity(content_source_id, user: user)
+
+        expect(response.body['results']).to eq([expected_response])
+        client.delete_external_identity(content_source_id, external_user_id: external_user_id)
       end
     end
 
@@ -74,11 +84,11 @@ describe Elastic::EnterpriseSearch::WorkplaceSearch::Client do
       end
 
       it 'updates an external identity' do
-        body = { source_user_id: 'example2@elastic.co' }
-        response = client.put_external_identity(content_source_id, user: user, body: body)
+        body = { external_user_id: external_user_id, permissions: ['permission1'] }
+        response = client.put_external_identity(content_source_id, external_user_id: external_user_id, body: body)
 
         expect(response.status).to eq 200
-        expect(response.body).to eq({ 'source_user_id' => 'example2@elastic.co', 'user' => user })
+        expect(response.body).to eq expected_response.merge({ 'permissions' => ['permission1'] })
       end
     end
 
@@ -88,7 +98,7 @@ describe Elastic::EnterpriseSearch::WorkplaceSearch::Client do
       end
 
       it 'deletes an external identity' do
-        response = client.delete_external_identity(content_source_id, user: user)
+        response = client.delete_external_identity(content_source_id, external_user_id: external_user_id)
         expect(response.status).to eq 200
         expect(response.body).to eq 'ok'
       end

data/spec/integration/workplace-search/triggers_spec.rb

@@ -28,14 +28,14 @@ describe Elastic::EnterpriseSearch::WorkplaceSearch::Client do
       original_list = response.body['blocklist']
 
       # Add a term to the block list and check it's been changed
-      response = client.put_triggers_blocklist(body: { blocklist: original_list + ['tests'] })
+      response = client.put_triggers_blocklist(blocklist: original_list + ['tests'])
       expect(response.status).to eq 200
       expect(response.body['blocklist']).to eq(original_list + ['tests'])
       response = client.triggers_blocklist
       expect(response.body['blocklist']).to eq(original_list + ['tests'])
 
       # Restored original list
-      response = client.put_triggers_blocklist(body: { blocklist: original_list })
+      response = client.put_triggers_blocklist(blocklist: original_list)
       expect(response.status).to eq 200
       expect(response.body['blocklist']).to eq(original_list)
     end

data/spec/integration/workplace-search/users_spec.rb

@@ -26,11 +26,5 @@ describe Elastic::EnterpriseSearch::WorkplaceSearch::Client do
       expect(response.status).to eq 200
       expect(response.body.keys).to eq ['email', 'username']
     end
-
-    it 'gets the current user with an access token' do
-      response = client.current_user(get_token: true)
-      expect(response.status).to eq 200
-      expect(response.body.keys).to eq ['email', 'username', 'access_token']
-    end
   end
 end

data/spec/workplace-search/client_spec.rb

@@ -91,9 +91,46 @@ describe Elastic::EnterpriseSearch::WorkplaceSearch::Client do
   context 'OAuth' do
     let(:client) { Elastic::EnterpriseSearch::WorkplaceSearch::Client.new(host: host) }
 
-    it 'generates an authorization url' do
-      authorization_url = 'http://localhost:3002/ws/oauth/authorize?response_type=code&client_id=client_id&redirect_uri=https%3A%2F%2Flocalhost%3A3002'
+    it 'generates an authorization url when kibana url has been set' do
+      client.kibana_url = 'http://localhost:5601'
+      authorization_url = "#{client.kibana_url}/app/enterprise_search/workplace_search/p/oauth/authorize?" \
+                          'response_type=code&client_id=client_id&redirect_uri=https%3A%2F%2Flocalhost%3A3002'
       expect(client.authorization_url('client_id', 'https://localhost:3002')).to eq authorization_url
     end
+
+    it 'raises an error when kibana url is not set' do
+      expect do
+        client.authorization_url('client_id', 'https://localhost:3002')
+      end.to raise_exception(ArgumentError)
+    end
+  end
+
+  context 'adapters' do
+    let(:client) { described_class.new }
+    let(:adapter) { client.transport.transport.connections.all.first.connection.builder.adapter }
+
+    context 'when no adapter is specified' do
+      it 'uses Faraday NetHttp' do
+        expect(adapter).to eq Faraday::Adapter::NetHttp
+      end
+    end
+
+    context 'when the adapter is patron' do
+      let(:client) { described_class.new(adapter: :patron) }
+
+      it 'uses Faraday with the adapter' do
+        expect(adapter).to eq Faraday::Adapter::Patron
+      end
+    end
+
+    unless defined?(JRUBY_VERSION)
+      context 'when the adapter is typhoeus' do
+        let(:client) { described_class.new(adapter: :patron) }
+
+        it 'uses Faraday with the adapter' do
+          expect(adapter).to eq Faraday::Adapter::Patron
+        end
+      end
+    end
   end
 end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: elastic-enterprise-search
 version: !ruby/object:Gem::Version
-  version: 7.17.0
+  version: 8.0.1
 platform: ruby
 authors:
 - Fernando Briano
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-03-07 00:00:00.000000000 Z
+date: 2022-05-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: elasticsearch-transport
+  name: elastic-transport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '7.11'
+        version: 8.0.0.pre.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '7.11'
+        version: 8.0.0.pre.1
 - !ruby/object:Gem::Dependency
   name: jwt
   requirement: !ruby/object:Gem::Requirement
@@ -106,14 +106,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: '1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: '1'
 - !ruby/object:Gem::Dependency
   name: vcr
   requirement: !ruby/object:Gem::Requirement
@@ -164,7 +164,10 @@ files:
 - ".ci/functions/imports.sh"
 - ".ci/functions/wait-for-container.sh"
 - ".ci/jobs/defaults.yml"
-- ".ci/jobs/elastic+enterprise-search-ruby+7.10.0.beta.1.yml"
+- ".ci/jobs/elastic+enterprise-search-ruby+7.13.yml"
+- ".ci/jobs/elastic+enterprise-search-ruby+7.14.yml"
+- ".ci/jobs/elastic+enterprise-search-ruby+7.15.yml"
+- ".ci/jobs/elastic+enterprise-search-ruby+7.16.yml"
 - ".ci/jobs/elastic+enterprise-search-ruby+main.yml"
 - ".ci/jobs/elastic+enterprise-search-ruby+pull-request.yml"
 - ".ci/make.sh"
@@ -175,17 +178,18 @@ files:
 - ".ci/run-tests"
 - ".ci/test-matrix.yml"
 - ".github/check_license_headers.rb"
-- ".github/compatibility/Gemfile"
 - ".github/license-header.txt"
-- ".github/workflows/compatibility.yml"
 - ".github/workflows/license.yml"
 - ".github/workflows/rubocop.yml"
 - ".github/workflows/testing.yml"
 - ".gitignore"
 - ".rubocop.yml"
+- CHANGELOG
+- CODE_OF_CONDUCT
 - CONTRIBUTING.md
 - Gemfile
 - LICENSE
+- NOTICE
 - README.md
 - Rakefile
 - docs/guide/app-search-api.asciidoc
@@ -203,12 +207,16 @@ files:
 - docs/guide/release_notes/715.asciidoc
 - docs/guide/release_notes/716.asciidoc
 - docs/guide/release_notes/717.asciidoc
+- docs/guide/release_notes/80.asciidoc
 - docs/guide/release_notes/index.asciidoc
 - docs/guide/workplace-search-api.asciidoc
 - elastic-enterprise-search.gemspec
 - lib/data/ca-bundle.crt
 - lib/elastic-enterprise-search.rb
 - lib/elastic/.rubocop.yml
+- lib/elastic/api/response.rb
+- lib/elastic/app-search/api/adaptive_relevance_settings.rb
+- lib/elastic/app-search/api/adaptive_relevance_suggestions.rb
 - lib/elastic/app-search/api/add_meta_engine_source.rb
 - lib/elastic/app-search/api/api_key.rb
 - lib/elastic/app-search/api/api_logs.rb
@@ -254,8 +262,10 @@ files:
 - lib/elastic/app-search/api/documents.rb
 - lib/elastic/app-search/api/engine.rb
 - lib/elastic/app-search/api/index_documents.rb
+- lib/elastic/app-search/api/list_adaptive_relevance_suggestions.rb
 - lib/elastic/app-search/api/list_api_keys.rb
 - lib/elastic/app-search/api/list_crawler_crawl_requests.rb
+- lib/elastic/app-search/api/list_crawler_domains.rb
 - lib/elastic/app-search/api/list_crawler_process_crawls.rb
 - lib/elastic/app-search/api/list_curations.rb
 - lib/elastic/app-search/api/list_documents.rb
@@ -263,6 +273,8 @@ files:
 - lib/elastic/app-search/api/list_synonym_sets.rb
 - lib/elastic/app-search/api/log_clickthrough.rb
 - lib/elastic/app-search/api/multi_search.rb
+- lib/elastic/app-search/api/put_adaptive_relevance_settings.rb
+- lib/elastic/app-search/api/put_adaptive_relevance_suggestions.rb
 - lib/elastic/app-search/api/put_api_key.rb
 - lib/elastic/app-search/api/put_crawler_crawl_rule.rb
 - lib/elastic/app-search/api/put_crawler_crawl_schedule.rb
@@ -275,6 +287,7 @@ files:
 - lib/elastic/app-search/api/put_search_settings.rb
 - lib/elastic/app-search/api/put_synonym_set.rb
 - lib/elastic/app-search/api/query_suggestion.rb
+- lib/elastic/app-search/api/refresh_adaptive_relevance_update_process.rb
 - lib/elastic/app-search/api/reset_search_settings.rb
 - lib/elastic/app-search/api/schema.rb
 - lib/elastic/app-search/api/search.rb
@@ -295,7 +308,6 @@ files:
 - lib/elastic/enterprise-search/utils.rb
 - lib/elastic/enterprise-search/version.rb
 - lib/elastic/enterprise_search.rb
-- lib/elastic/workplace-search/api/add_user_permissions.rb
 - lib/elastic/workplace-search/api/auto_query_refinement_details.rb
 - lib/elastic/workplace-search/api/command_sync_jobs.rb
 - lib/elastic/workplace-search/api/content_source.rb
@@ -316,19 +328,15 @@ files:
 - lib/elastic/workplace-search/api/list_content_sources.rb
 - lib/elastic/workplace-search/api/list_documents.rb
 - lib/elastic/workplace-search/api/list_external_identities.rb
-- lib/elastic/workplace-search/api/list_permissions.rb
 - lib/elastic/workplace-search/api/list_synonym_sets.rb
 - lib/elastic/workplace-search/api/put_content_source.rb
 - lib/elastic/workplace-search/api/put_content_source_icons.rb
 - lib/elastic/workplace-search/api/put_external_identity.rb
 - lib/elastic/workplace-search/api/put_synonym_set.rb
 - lib/elastic/workplace-search/api/put_triggers_blocklist.rb
-- lib/elastic/workplace-search/api/put_user_permissions.rb
-- lib/elastic/workplace-search/api/remove_user_permissions.rb
 - lib/elastic/workplace-search/api/search.rb
 - lib/elastic/workplace-search/api/synonym_set.rb
 - lib/elastic/workplace-search/api/triggers_blocklist.rb
-- lib/elastic/workplace-search/api/user_permissions.rb
 - lib/elastic/workplace-search/workplace_search.rb
 - rake_tasks/unified_release_tasks.rake
 - spec/app-search/client_spec.rb
@@ -339,6 +347,8 @@ files:
 - spec/fixtures/vcr/workplace_search/create_analytics_event.yml
 - spec/fixtures/vcr/workplace_search/oauth_request_token.yml
 - spec/fixtures/vcr/workplace_search/search_request.yml
+- spec/integration/app-search/adaptive_relevance_settings_spec.rb
+- spec/integration/app-search/adaptive_relevance_suggestions_spec.rb
 - spec/integration/app-search/api_key_spec.rb
 - spec/integration/app-search/api_logs_spec.rb
 - spec/integration/app-search/app_search_helper.rb
@@ -372,7 +382,6 @@ files:
 - spec/integration/workplace-search/documents_spec.rb
 - spec/integration/workplace-search/external_identities_spec.rb
 - spec/integration/workplace-search/icon.png
-- spec/integration/workplace-search/permissions_spec.rb
 - spec/integration/workplace-search/synonym_sets_spec.rb
 - spec/integration/workplace-search/triggers_spec.rb
 - spec/integration/workplace-search/users_spec.rb
@@ -399,14 +408,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.5'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.3
+rubygems_version: 3.3.7
 signing_key: 
 specification_version: 4
 summary: Official API client for Elastic Enterprise Search

data/.ci/jobs/elastic+enterprise-search-ruby+7.10.0.beta.1.yml

@@ -1,12 +0,0 @@
----
-- job:
-    name: elastic+enterprise-search-ruby+7.10.0.beta.1
-    display-name: 'elastic / enterprise-search-ruby # 7.10.0.beta.1'
-    description: Testing the enterprise-search-ruby 7.10.0.beta.1 branch.
-    junit_results: "*-junit.xml"
-    parameters:
-    - string:
-        name: branch_specifier
-        default: refs/heads/7.10.0.beta.1
-        description: the Git branch specifier to build (<branchName>, <tagName>,
-          <commitId>, etc.)

data/.github/compatibility/Gemfile

@@ -1,23 +0,0 @@
-# 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.
-
-# frozen_string_literal: true
-
-source 'https://rubygems.org'
-
-gem 'elasticsearch', ENV['es-version']
-gem 'elastic-enterprise-search', path: File.expand_path('../../', __dir__)

data/.github/workflows/compatibility.yml

@@ -1,20 +0,0 @@
-name: Compatibility with Elasticsearch
-on: [push, pull_request]
-
-jobs:
-  elasticsearch:
-    env:
-      ES_VERSION: ${{ matrix.es_version }}
-    strategy:
-      matrix:
-        es_version: [ 7.11, 7.12, 7.13, 7.14, 7.15, 7.16 ]
-    runs-on: ubuntu-latest
-    steps:
-    - uses: actions/checkout@v2
-    - uses: ruby/setup-ruby@v1
-      with:
-        ruby-version: 3.1
-    - name: Build Gemfile with Elasticsearch gem
-      run: |
-        ruby -v
-        cd ./.github/compatibility/ && bundle

data/spec/integration/workplace-search/permissions_spec.rb

@@ -1,77 +0,0 @@
-# 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.
-
-# frozen_string_literal: true
-
-require_relative "#{__dir__}/workplace_search_helper.rb"
-
-describe Elastic::EnterpriseSearch::WorkplaceSearch::Client do
-  context 'Permissions' do
-    let(:content_source_id) { client.create_content_source(name: 'my_content').body['id'] }
-    let(:user) { 'enterprise_search' }
-    let(:permissions) { ['permission1', 'permission2'] }
-
-    after do
-      client.put_user_permissions(content_source_id, { permissions: [], user: user })
-      delete_content_sources
-    end
-
-    it 'adds permissions to a user' do
-      response = client.add_user_permissions(
-        content_source_id,
-        { permissions: permissions, user: user }
-      )
-      expect(response.status).to eq 200
-      expect(response.body).to eq({ 'user' => 'enterprise_search', 'permissions' => ['permission1', 'permission2'] })
-    end
-
-    it 'removes permissions from a user' do
-      client.add_user_permissions(content_source_id, { permissions: permissions, user: user })
-
-      # Removes Permissions
-      response = client.remove_user_permissions(
-        content_source_id,
-        { permissions: permissions, user: user }
-      )
-      expect(response.status).to eq 200
-      expect(response.body).to eq({ 'user' => 'enterprise_search', 'permissions' => [] })
-    end
-
-    it 'lists permissions' do
-      response = client.list_permissions(content_source_id)
-      expect(response.status).to eq 200
-    end
-
-    it 'gets a user\'s permissions' do
-      client.add_user_permissions(content_source_id, { permissions: permissions, user: user })
-      response = client.user_permissions(content_source_id, { user: user })
-      expect(response.status).to eq 200
-      expect(response.body).to eq({ 'user' => 'enterprise_search', 'permissions' => permissions })
-    end
-
-    it 'updates a user\'s permissions' do
-      permissions = ['testing', 'more', 'permissions']
-      response = client.add_user_permissions(content_source_id, { permissions: permissions, user: user })
-      expect(response.status).to eq 200
-      expect(response.body).to eq({ 'user' => 'enterprise_search', 'permissions' => permissions })
-
-      response = client.put_user_permissions(content_source_id, { permissions: [], user: user })
-      expect(response.status).to eq 200
-      expect(response.body).to eq({ 'user' => 'enterprise_search', 'permissions' => [] })
-    end
-  end
-end