elastic-enterprise-search 7.13.0 → 7.14.0

data/spec/app-search/api_spec_helper.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 'spec_helper'

data/spec/fixtures/vcr/app_search/create_api_key.yml

@@ -0,0 +1,52 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: http://localhost:3002/api/as/v1/credentials/
+    body:
+      encoding: UTF-8
+      string: '{"name":"my-api-key","type":"private","read":true,"write":true,"access_all_engines":true}'
+    headers:
+      X-Elastic-Client-Meta:
+      - ent=8.0.0,rb=3.0.1,t=7.13.3,fd=1.5.1,nh=0.1.1
+      User-Agent:
+      - 'elastic-enteprise-search-ruby/8.0.0 (RUBY_VERSION: 3.0.1; linux x86_64; elasticsearch-transport:
+        7.13.3)'
+      Content-Type:
+      - application/json
+      Authorization:
+      - Bearer api_key
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      X-App-Search-Version:
+      - 7.14.0
+      Content-Type:
+      - application/json;charset=utf-8
+      Vary:
+      - Accept-Encoding, User-Agent
+      - Origin
+      Etag:
+      - W/"cb88f57feab926c9f2fc911133296c96--gzip"
+      Cache-Control:
+      - max-age=0, private, must-revalidate
+      X-Request-Id:
+      - aa3678b1-f5cb-4b6a-b699-076420dd908d
+      X-Runtime:
+      - '0.124357'
+      Transfer-Encoding:
+      - chunked
+      Server:
+      - Jetty(9.4.33.v20201020)
+    body:
+      encoding: ASCII-8BIT
+      string: '{"id":"loco_moco_account_id:60ed920e613281f096273599|name:my-api-key","key":"private-q1fom1cnf2cdsr2wa91vpqs4","name":"my-api-key","type":"private","read":true,"write":true,"access_all_engines":true}'
+    http_version: 
+  recorded_at: Tue, 13 Jul 2021 13:30:34 GMT
+recorded_with: VCR 3.0.3

data/spec/fixtures/vcr/app_search/delete_api_key.yml

@@ -0,0 +1,52 @@
+---
+http_interactions:
+- request:
+    method: delete
+    uri: http://localhost:3002/api/as/v1/credentials/my-api-key/?api_key_name=my-api-key
+    body:
+      encoding: UTF-8
+      string: "{}"
+    headers:
+      X-Elastic-Client-Meta:
+      - ent=8.0.0,rb=3.0.1,t=7.13.3,fd=1.5.1,nh=0.1.1
+      User-Agent:
+      - 'elastic-enteprise-search-ruby/8.0.0 (RUBY_VERSION: 3.0.1; linux x86_64; elasticsearch-transport:
+        7.13.3)'
+      Content-Type:
+      - application/json
+      Authorization:
+      - Bearer api_key
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      X-App-Search-Version:
+      - 7.14.0
+      Content-Type:
+      - application/json;charset=utf-8
+      Vary:
+      - Accept-Encoding, User-Agent
+      - Origin
+      Etag:
+      - W/"1b70b1c98c544d975c39049311ab1d24--gzip"
+      Cache-Control:
+      - max-age=0, private, must-revalidate
+      X-Request-Id:
+      - 977b3790-757e-4f78-be0d-a09c7fc7ae4b
+      X-Runtime:
+      - '0.093760'
+      Transfer-Encoding:
+      - chunked
+      Server:
+      - Jetty(9.4.33.v20201020)
+    body:
+      encoding: ASCII-8BIT
+      string: '{"deleted":true}'
+    http_version: 
+  recorded_at: Tue, 13 Jul 2021 15:01:55 GMT
+recorded_with: VCR 3.0.3

data/spec/fixtures/vcr/app_search/get_api_key.yml

@@ -0,0 +1,52 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://localhost:3002/api/as/v1/credentials/my-api-key/?api_key_name=my-api-key
+    body:
+      encoding: UTF-8
+      string: "{}"
+    headers:
+      X-Elastic-Client-Meta:
+      - ent=8.0.0,rb=3.0.1,t=7.13.3,fd=1.5.1,nh=0.1.1
+      User-Agent:
+      - 'elastic-enteprise-search-ruby/8.0.0 (RUBY_VERSION: 3.0.1; linux x86_64; elasticsearch-transport:
+        7.13.3)'
+      Content-Type:
+      - application/json
+      Authorization:
+      - Bearer api_key
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      X-App-Search-Version:
+      - 7.14.0
+      Content-Type:
+      - application/json;charset=utf-8
+      Vary:
+      - Accept-Encoding, User-Agent
+      - Origin
+      Etag:
+      - W/"cb88f57feab926c9f2fc911133296c96--gzip"
+      Cache-Control:
+      - max-age=0, private, must-revalidate
+      X-Request-Id:
+      - 54dd3deb-d236-4fdd-adaa-7790230fb55e
+      X-Runtime:
+      - '0.064862'
+      Transfer-Encoding:
+      - chunked
+      Server:
+      - Jetty(9.4.33.v20201020)
+    body:
+      encoding: ASCII-8BIT
+      string: '{"id":"loco_moco_account_id:60ed920e613281f096273599|name:my-api-key","key":"private-q1fom1cnf2cdsr2wa91vpqs4","name":"my-api-key","type":"private","read":true,"write":true,"access_all_engines":true}'
+    http_version: 
+  recorded_at: Tue, 13 Jul 2021 13:36:10 GMT
+recorded_with: VCR 3.0.3

data/spec/fixtures/vcr/app_search/list_api_keys.yml

@@ -0,0 +1,52 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://localhost:3002/api/as/v1/credentials/
+    body:
+      encoding: UTF-8
+      string: "{}"
+    headers:
+      X-Elastic-Client-Meta:
+      - ent=8.0.0,rb=3.0.1,t=7.13.3,fd=1.5.1,nh=0.1.1
+      User-Agent:
+      - 'elastic-enteprise-search-ruby/8.0.0 (RUBY_VERSION: 3.0.1; linux x86_64; elasticsearch-transport:
+        7.13.3)'
+      Content-Type:
+      - application/json
+      Authorization:
+      - Bearer api_key
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      X-App-Search-Version:
+      - 7.14.0
+      Content-Type:
+      - application/json;charset=utf-8
+      Vary:
+      - Accept-Encoding, User-Agent
+      - Origin
+      Etag:
+      - W/"939fc16d42c5831cfe117f2a95d945cd--gzip"
+      Cache-Control:
+      - max-age=0, private, must-revalidate
+      X-Request-Id:
+      - 0e178874-067a-43d9-855e-b5a310e8a818
+      X-Runtime:
+      - '0.029724'
+      Transfer-Encoding:
+      - chunked
+      Server:
+      - Jetty(9.4.33.v20201020)
+    body:
+      encoding: ASCII-8BIT
+      string: '{"meta":{"page":{"current":1,"total_pages":1,"total_results":4,"size":25}},"results":[{"id":"loco_moco_account_id:60ed920e613281f096273599|name:my-api-key","key":"private-q1fom1cnf2cdsr2wa91vpqs4","name":"my-api-key","type":"private","read":true,"write":true,"access_all_engines":true},{"id":"loco_moco_account_id:60ed920e613281f096273599|name:private-key","key":"private-593eojp3t6bhqrgtkv31iifg","name":"private-key","type":"private","read":true,"write":true,"access_all_engines":true},{"id":"loco_moco_account_id:60ed920e613281f096273599|name:search-key","key":"search-frunn74mzsf6fz222gupq24i","name":"search-key","type":"search","access_all_engines":true},{"id":"loco_moco_account_id:60ed920e613281f096273599|name:test","key":"api_key","name":"test","type":"admin"}]}'
+    http_version: 
+  recorded_at: Tue, 13 Jul 2021 13:38:17 GMT
+recorded_with: VCR 3.0.3

data/spec/fixtures/vcr/app_search/put_api_key.yml

@@ -0,0 +1,52 @@
+---
+http_interactions:
+- request:
+    method: put
+    uri: http://localhost:3002/api/as/v1/credentials/my-api-key/?api_key_name=my-api-key
+    body:
+      encoding: UTF-8
+      string: '{"name":"my-api-key","type":"private","read":true,"write":true,"engines":["test"]}'
+    headers:
+      X-Elastic-Client-Meta:
+      - ent=8.0.0,rb=3.0.1,t=7.13.3,fd=1.5.1,nh=0.1.1
+      User-Agent:
+      - 'elastic-enteprise-search-ruby/8.0.0 (RUBY_VERSION: 3.0.1; linux x86_64; elasticsearch-transport:
+        7.13.3)'
+      Content-Type:
+      - application/json
+      Authorization:
+      - Bearer api_key
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      X-App-Search-Version:
+      - 7.14.0
+      Content-Type:
+      - application/json;charset=utf-8
+      Vary:
+      - Accept-Encoding, User-Agent
+      - Origin
+      Etag:
+      - W/"4b2fa3ed1c59fd1267877524d95fdcae--gzip"
+      Cache-Control:
+      - max-age=0, private, must-revalidate
+      X-Request-Id:
+      - 1ef1e1d7-4d4a-4eed-b4c5-4116ba6a29bf
+      X-Runtime:
+      - '0.093023'
+      Transfer-Encoding:
+      - chunked
+      Server:
+      - Jetty(9.4.33.v20201020)
+    body:
+      encoding: ASCII-8BIT
+      string: '{"id":"loco_moco_account_id:60ed920e613281f096273599|name:my-api-key","key":"private-q1fom1cnf2cdsr2wa91vpqs4","name":"my-api-key","type":"private","read":true,"write":true,"engines":["test"]}'
+    http_version: 
+  recorded_at: Tue, 13 Jul 2021 14:58:36 GMT
+recorded_with: VCR 3.0.3

data/spec/integration/workplace_search_spec.rb

@@ -18,6 +18,7 @@
 # frozen_string_literal: true
 
 require 'spec_helper'
+require 'base64'
 
 describe Elastic::EnterpriseSearch::WorkplaceSearch::Client do
   let(:host) { ENV['ELASTIC_ENTERPRISE_HOST'] || 'http://localhost:3002' }
@@ -92,6 +93,28 @@ describe Elastic::EnterpriseSearch::WorkplaceSearch::Client do
       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
   end
 
   context 'Documents' do
@@ -124,6 +147,26 @@ describe Elastic::EnterpriseSearch::WorkplaceSearch::Client 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
 
   context 'External Identities' do
@@ -250,4 +293,83 @@ describe Elastic::EnterpriseSearch::WorkplaceSearch::Client do
       expect(response.body).to eq({ 'user' => 'enterprise_search', 'permissions' => [] })
     end
   end
+
+  context 'Synonym sets' do
+    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
+      id = client.create_batch_synonym_sets(
+        body: {
+          synonym_sets: [
+            { 'synonyms' => ['mouses', 'mice'] }
+          ]
+        }
+      ).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
+
+  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
+
+    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/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'