elastic-enterprise-search 7.12.1 → 7.15.0

data/spec/{workplace-search → integration/workplace-search}/external_identities_spec.rb

@@ -17,53 +17,63 @@
 
 # frozen_string_literal: true
 
-require 'spec_helper'
+require_relative "#{__dir__}/workplace_search_helper.rb"
 
 describe Elastic::EnterpriseSearch::WorkplaceSearch::Client do
-  let(:host) { ENV['ELASTIC_ENTERPRISE_HOST'] || 'http://localhost:3002' }
-  let(:access_token) { ENV['ELASTIC_WORKPLACE_TOKEN'] || 'access_token' }
-  let(:content_source_id) { ENV['ELASTIC_WORKPLACE_SOURCE_ID'] || 'content_source_id' }
-  let(:client) do
-    Elastic::EnterpriseSearch::WorkplaceSearch::Client.new(
-      host: host,
-      http_auth: access_token
-    )
-  end
+  context 'External Identities' do
+    after do
+      delete_content_sources
+    end
 
-  context 'external identities' do
+    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
 
-    it 'creates an external identity' do
-      VCR.use_cassette('workplace_search/create_external_identity') do
-        body = { user: user, source_user_id: source_user_id }
+    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
-    end
 
-    it 'retrieves an external identity' do
-      VCR.use_cassette('workplace_search/retrieve_external_identity') do
+      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
 
-    it 'lists external identities' do
-      VCR.use_cassette('workplace_search/list_external_identities') do
+    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
 
-    it 'updates an external identity' do
-      VCR.use_cassette('workplace_search/put_external_identity') do
+    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)
 
@@ -72,10 +82,13 @@ describe Elastic::EnterpriseSearch::WorkplaceSearch::Client do
       end
     end
 
-    it 'deletes an external identity' do
-      VCR.use_cassette('workplace_search/delete_external_identity') do
-        response = client.delete_external_identity(content_source_id, user: user)
+    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

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

data/spec/webmock_requires.rb

@@ -1,3 +1,19 @@
+# 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 'webmock'

data/spec/workplace-search/client_spec.rb

@@ -20,7 +20,7 @@
 require 'spec_helper'
 
 describe Elastic::EnterpriseSearch::WorkplaceSearch::Client do
-  let(:host) { 'https://localhost:8080' }
+  let(:host) { 'http://localhost:3002' }
   let(:access_token) { 'access_token' }
 
   context 'dependant on EnterpriseSearch' do
@@ -66,11 +66,33 @@ describe Elastic::EnterpriseSearch::WorkplaceSearch::Client do
     end
   end
 
+  context 'Authentication' do
+    let(:client) { Elastic::EnterpriseSearch::WorkplaceSearch::Client.new(http_auth: http_auth) }
+
+    context 'when using an API token' do
+      let(:http_auth) { 'api_token' }
+
+      it 'initializes a workplace search client' do
+        expect(client.http_auth).to eq http_auth
+        expect(client.setup_authentication_header).to eq "Bearer #{http_auth}"
+      end
+    end
+
+    context 'when using basic auth' do
+      let(:http_auth) { { user: 'elastic', password: 'password' } }
+
+      it 'initializes a workplace search client' do
+        expect(client.http_auth).to eq http_auth
+        expect(client.setup_authentication_header).to eq 'Basic ZWxhc3RpYzpwYXNzd29yZA=='
+      end
+    end
+  end
+
   context 'OAuth' do
     let(:client) { Elastic::EnterpriseSearch::WorkplaceSearch::Client.new(host: host) }
 
     it 'generates an authorization url' do
-      authorization_url = 'https://localhost:8080/ws/oauth/authorize?response_type=code&client_id=client_id&redirect_uri=https%3A%2F%2Flocalhost%3A3002'
+      authorization_url = 'http://localhost:3002/ws/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
   end