elastic-enterprise-search 7.14.1 → 7.15.0

data/spec/{app-search/api_top_clicks_analytics_spec.rb → integration/app-search/top_clicks_analytics_spec.rb}

@@ -17,28 +17,34 @@
 
 # frozen_string_literal: true
 
-require_relative './api_spec_helper'
+require_relative "#{__dir__}/app_search_helper.rb"
 
 describe Elastic::EnterpriseSearch::AppSearch::Client do
-  context 'api_top_clicks_analytics' do
+  context 'top clicks analytics' do
+    let(:engine_name) { 'top-clicks-analytics' }
+
+    before do
+      client.create_engine(name: engine_name)
+    end
+
+    after do
+      delete_engines
+    end
+
     it 'returns api_top_clicks_analytics with no query' do
-      VCR.use_cassette('app_search/api_top_clicks_analytics') do
-        response = @client.top_clicks_analytics('books')
-        expect(response.status).to eq 200
+      response = client.top_clicks_analytics(engine_name)
+      expect(response.status).to eq 200
 
-        expect(response.body['results'])
-        expect(response.body['meta'])
-      end
+      expect(response.body['results'])
+      expect(response.body['meta'])
     end
 
     it 'returns api_top_clicks_analytics with query' do
-      VCR.use_cassette('app_search/api_top_clicks_analytics_query') do
-        response = @client.top_clicks_analytics('books', query: 'test')
-        expect(response.status).to eq 200
+      response = client.top_clicks_analytics(engine_name, query: 'test')
+      expect(response.status).to eq 200
 
-        expect(response.body['results'])
-        expect(response.body['meta'])
-      end
+      expect(response.body['results'])
+      expect(response.body['meta'])
     end
   end
 end

data/spec/{app-search/api_top_queries_analytics_spec.rb → integration/app-search/top_queries_analytics_spec.rb}

@@ -17,18 +17,26 @@
 
 # frozen_string_literal: true
 
-require_relative './api_spec_helper'
+require_relative "#{__dir__}/app_search_helper.rb"
 
 describe Elastic::EnterpriseSearch::AppSearch::Client do
-  context 'api_top_queries_analytics' do
+  let(:engine_name) { 'top-queries-analytics' }
+
+  before do
+    client.create_engine(name: engine_name)
+  end
+
+  after do
+    delete_engines
+  end
+
+  context 'top queries analytics' do
     it 'returns api_top_queries_analytics with no query' do
-      VCR.use_cassette('app_search/api_top_queries_analytics') do
-        response = @client.top_queries_analytics('books')
-        expect(response.status).to eq 200
+      response = @client.top_queries_analytics(engine_name)
+      expect(response.status).to eq 200
 
-        expect(response.body['results'])
-        expect(response.body['meta'])
-      end
+      expect(response.body['results'])
+      expect(response.body['meta'])
     end
   end
 end

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

@@ -0,0 +1,106 @@
+# 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 'Content Sources' do
+    after do
+      delete_content_sources
+    end
+
+    it 'creates, retrieves and deletes authenticated with basic auth' do
+      # Create a content source and get its id
+      response = client.create_content_source(name: 'test')
+      expect(response.status).to eq 200
+      expect(response.body['id'])
+      id = response.body['id']
+
+      # Test we get the content source information with get_content_source
+      response = client.content_source(id)
+      expect(response.status).to eq 200
+
+      # List all content sources
+      response = client.list_content_sources
+      expect(response.status).to eq 200
+      expect(response.body['results'].count).to be >= 1
+
+      # Delete content source
+      response = client.delete_content_source(id)
+      expect(response.status).to eq 200
+    end
+
+    it 'creates and updates' do
+      response = client.create_content_source(name: 'ruby_client_app')
+      expect(response.status).to eq 200
+      id = response.body['id']
+
+      documents = [{ title: 'My first Document', body: 'Content', url: 'elastic.co' }]
+      response = client.index_documents(id, documents: documents)
+      expect(response.status).to eq 200
+
+      new_name = 'ruby_client'
+      body = {
+        name: new_name,
+        schema: { title: 'text', body: 'text', url: 'text' },
+        display: { title_field: 'title', url_field: 'url', color: '#f00f00' },
+        is_searchable: true
+      }
+      response = client.put_content_source(id, body: body)
+      expect(response.status).to eq 200
+
+      response = client.content_source(id)
+      expect(response.status).to eq 200
+      expect(response.body['name']) == new_name
+    end
+
+    it 'syncs jobs' do
+      response = client.create_content_source(name: 'sync_jobs_test')
+      expect(response.status).to eq 200
+      id = response.body['id']
+
+      response = client.command_sync_jobs(id, body: { command: 'interrupt' })
+      expect(response.status).to eq 200
+      expect(response.body['results'].keys).to eq ['interrupted']
+    end
+
+    context 'icons' do
+      let(:content_source_id) { client.create_content_source(name: 'with-icon').body['id'] }
+
+      it 'puts an icon' do
+        path = File.expand_path("#{File.dirname(__FILE__)}/icon.png")
+        icon = Base64.strict_encode64(File.read(path))
+        response = client.put_content_source_icons(content_source_id, main_icon: icon, alt_icon: icon)
+        expect(response.status).to eq 200
+        expect(response.body['results']).to eq({ 'main_icon' => 'success', 'alt_icon' => 'success' })
+      end
+    end
+
+    context 'auto query refinements details' do
+      let(:content_source_id) { client.create_content_source(name: 'refinements').body['id'] }
+
+      it 'retrieves details' do
+        response = client.auto_query_refinement_details(content_source_id)
+
+        expect(response.status).to eq 200
+        expect(response.body.keys.sort).to eq ['defaults', 'overrides', 'results']
+      end
+    end
+  end
+end

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

@@ -0,0 +1,95 @@
+# 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
+  after do
+    delete_content_sources
+  end
+
+  let(:documents) do
+    [
+      {
+        'id' => '4e696e74656e646f203634',
+        'url' => 'https://www.elastic.co/blog/introducing-quick-start-guides-getting-started-with-elastic-enterprise-search-for-free',
+        'title' => 'Getting started with Elastic Enterprise Search for free',
+        'body' => 'this is a test'
+      },
+      {
+        'id' => '47616d6520426f7920436f6c6f72',
+        'url' => 'https://www.elastic.co/workplace-search',
+        'title' => 'One-stop answer shop for the virtual workplace',
+        'body' => 'this is also a test'
+      }
+    ]
+  end
+
+  context 'Documents' do
+    let(:content_source_id) do
+      client.create_content_source(name: 'test').body['id']
+    end
+
+    it 'indexes' do
+      response = client.index_documents(content_source_id, documents: documents)
+      expect(response.status).to eq 200
+    end
+
+    it 'deletes' do
+      response = client.delete_documents(content_source_id, document_ids: documents.map { |doc| doc['id'] })
+      expect(response.status).to eq 200
+    end
+  end
+
+  context 'Documents in Content Sources' do
+    let(:content_source_id) { client.create_content_source(name: 'books').body['id'] }
+    let(:document_id) { client.index_documents(content_source_id, documents: documents).body['results'].first['id'] }
+
+    it 'Gets a document in a content source' do
+      response = client.document(content_source_id, document_id: document_id)
+      expect(response.status).to eq 200
+      expect(response.body['id']).to eq document_id
+    end
+
+    it 'Deletes all documents in a content source' do
+      response = client.delete_all_documents(content_source_id)
+      expect(response.status).to eq 200
+    end
+
+    it 'Deletes documents by query' do
+      content_source_id = client.create_content_source(name: 'asimov').body['id']
+      documents = [
+        { title: 'Foundation', year: 1951 },
+        { title: 'Foundation and Empire', year: 1952 },
+        { title: 'Second Foundation', year: 1953 }
+      ]
+      response = client.index_documents(content_source_id, documents: documents)
+
+      expect(response.status).to eq 200
+      expect(response.body['results'].count).to eq 3
+
+      # Give time to index the documents so we can delete them:
+      sleep 2
+
+      response = client.delete_documents_by_query(content_source_id, query: 'Foundation')
+      expect(response.status).to eq 200
+      expect(response.body).to eq({ 'total' => 3, 'deleted' => 3, 'failures' => [] })
+    end
+  end
+end

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

@@ -0,0 +1,97 @@
+# 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 'External Identities' do
+    after 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(:body) do
+      { user: user, source_user_id: source_user_id }
+    end
+
+    context 'Creates' do
+      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 })
+
+        client.delete_external_identity(content_source_id, user: user)
+      end
+
+      it 'creates and retrieves' do
+        client.create_external_identity(content_source_id, body: body)
+        response = client.external_identity(content_source_id, user: user)
+
+        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)
+      end
+    end
+
+    context 'Lists' do
+      let(:user) { 'lists_test' }
+
+      it 'lists external identities' do
+        client.create_external_identity(content_source_id, body: body)
+        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)
+      end
+    end
+
+    context 'Updates' do
+      before do
+        client.create_external_identity(content_source_id, body: body)
+      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)
+
+        expect(response.status).to eq 200
+        expect(response.body).to eq({ 'source_user_id' => 'example2@elastic.co', 'user' => user })
+      end
+    end
+
+    context 'Deletes' do
+      before do
+        client.create_external_identity(content_source_id, body: body)
+      end
+
+      it 'deletes an external identity' do
+        response = client.delete_external_identity(content_source_id, user: user)
+        expect(response.status).to eq 200
+        expect(response.body).to eq 'ok'
+      end
+    end
+  end
+end

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

@@ -0,0 +1,77 @@
+# 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

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

@@ -0,0 +1,92 @@
+# 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 'Synonym sets' do
+    after do
+      delete_content_sources
+    end
+
+    let(:body) do
+      {
+        synonym_sets: [
+          { 'synonyms' => ['house', 'home', 'abode'] },
+          { 'synonyms' => ['cat', 'feline', 'kitty'] },
+          { 'synonyms' => ['mouses', 'mice'] }
+        ]
+      }
+    end
+
+    it 'creates and deletes a batch synonym set' do
+      response = client.create_batch_synonym_sets(body: body)
+
+      expect(response.status).to eq 200
+      expect(response.body['has_errors']).to eq false
+      expect(response.body['synonym_sets'].count).to eq 3
+
+      response.body['synonym_sets'].map { |s| client.delete_synonym_set(synonym_set_id: s['id']) }
+    end
+
+    it 'lists synonym sets' do
+      client.create_batch_synonym_sets(body: body)
+      response = client.list_synonym_sets
+
+      expect(response.status).to eq 200
+      expect(response.body['results'].count).to eq 3
+
+      response.body['results'].map { |syn| client.delete_synonym_set(synonym_set_id: syn['id']) }
+    end
+
+    it 'gets a single synonym set' do
+      id = client.create_batch_synonym_sets(
+        body: {
+          synonym_sets: [
+            { 'synonyms' => ['house', 'home', 'abode'] }
+          ]
+        }
+      ).body['synonym_sets'].first['id']
+
+      response = client.synonym_set(synonym_set_id: id)
+      expect(response.status).to eq 200
+      expect(response.body['id']).to eq id
+      expect(response.body['synonyms']).to eq ['house', 'home', 'abode']
+      client.delete_synonym_set(synonym_set_id: id)
+    end
+
+    it 'updates a synonym set' do
+      response = client.create_batch_synonym_sets(
+        body: {
+          synonym_sets: [
+            { 'synonyms' => ['mouses', 'mice'] }
+          ]
+        }
+      )
+      id = response.body['synonym_sets'].first['id']
+      body = { synonyms: ['mouses', 'mice', 'luch'] }
+
+      response = client.put_synonym_set(synonym_set_id: id, body: body)
+
+      expect(response.status).to eq 200
+      expect(response.body).to eq({ 'id' => id, 'synonyms' => ['mouses', 'mice', 'luch'] })
+      client.delete_synonym_set(synonym_set_id: id)
+    end
+  end
+end

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

@@ -0,0 +1,43 @@
+# 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 'Triggers' do
+    it 'gets and updates triggers blocklist' do
+      response = client.triggers_blocklist
+      expect(response.status).to eq 200
+      expect(response.body['blocklist']).not_to be_empty
+      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'] })
+      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 })
+      expect(response.status).to eq 200
+      expect(response.body['blocklist']).to eq(original_list)
+    end
+  end
+end

data/spec/{app-search/api_query_suggestion_spec.rb → integration/workplace-search/users_spec.rb}

@@ -17,23 +17,20 @@
 
 # frozen_string_literal: true
 
-require_relative './api_spec_helper'
+require_relative "#{__dir__}/workplace_search_helper.rb"
 
-describe Elastic::EnterpriseSearch::AppSearch::Client do
-  context 'api_query_suggestion' do
-    let(:engine_name) { 'films' }
-
-    it 'provides query suggestions' do
-      VCR.use_cassette('app_search/api_query_suggestion') do
-        response = @client.query_suggestion(engine_name, query: 'moo')
-
-        expect(response.status).to eq 200
+describe Elastic::EnterpriseSearch::WorkplaceSearch::Client do
+  context 'Users' do
+    it 'gets the current user' do
+      response = client.current_user
+      expect(response.status).to eq 200
+      expect(response.body.keys).to eq ['email', 'username']
+    end
 
-        expect(response.body['results']['documents']).to include(
-          { 'suggestion' => 'moon' },
-          { 'suggestion' => 'moon men' }
-        )
-      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/integration/workplace-search/workplace_search_helper.rb

@@ -0,0 +1,39 @@
+# 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 'spec_helper'
+
+# Workplace Search Integration tests Client Configuration
+def client
+  @client ||= Elastic::EnterpriseSearch::WorkplaceSearch::Client.new(
+    host: ENV['ELASTIC_ENTERPRISE_HOST'] || 'http://localhost:3002',
+    http_auth: {
+      user: ENV['ELASTIC_ENTERPRISE_USER'] || 'enterprise_search',
+      password: ENV['ELASTIC_ENTERPRISE_PASSWORD'] || 'changeme'
+    }
+  )
+end
+
+def delete_content_sources
+  sources = client.list_content_sources.body['results']
+  sources.each do |source|
+    client.delete_content_source(source['id'])
+  end
+  sleep 1
+end