elastic-enterprise-search 7.10.0.beta.1 → 7.11.0

data/spec/app-search/api_schema_spec.rb

@@ -22,12 +22,26 @@ require_relative './api_spec_helper'
 
 describe Elastic::EnterpriseSearch::AppSearch::Client do
   context 'schema' do
+    let(:engine_name) { 'films' }
+
     it 'returns an engine schema' do
-      VCR.use_cassette('app_search/schema') do
-        response = @client.schema('books')
+      VCR.use_cassette('app_search/api_schema') do
+        response = @client.schema(engine_name)
 
         expect(response.status).to eq 200
-        expect(response.body).to eq({ 'author' => 'text', 'title' => 'text' })
+        expect(response.body).to eq({ 'title' => 'text', 'year' => 'number', 'director' => 'text' })
+      end
+    end
+
+    it 'updates a schema for an engine' do
+      VCR.use_cassette('app_search/api_put_schema') do
+        response = @client.put_schema(engine_name, schema: { year: 'text' })
+
+        expect(response.status).to eq 200
+        expect(response.body).to eq({ 'title' => 'text', 'year' => 'text', 'director' => 'text' })
+
+        response = @client.schema(engine_name)
+        expect(response.body).to eq({ 'title' => 'text', 'year' => 'text', 'director' => 'text' })
       end
     end
   end

data/spec/app-search/api_search_settings_spec.rb

@@ -0,0 +1,76 @@
+# 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 './api_spec_helper'
+
+describe Elastic::EnterpriseSearch::AppSearch::Client do
+  context 'search settings' do
+    let(:engine_name) { 'films' }
+
+    it 'returns engine search settings' do
+      VCR.use_cassette('app_search/api_search_settings') do
+        response = @client.search_settings(engine_name)
+
+        expect(response.status).to eq 200
+        expect(response.body['search_fields'])
+        expect(response.body['result_fields'])
+        expect(response.body['boosts'])
+      end
+    end
+
+    it 'updates search settings' do
+      VCR.use_cassette('app_search/api_put_search_settings') do
+        body = {
+          boosts: {
+            year: [
+              {
+                type: 'proximity',
+                function: 'linear',
+                center: 1950,
+                factor: 9
+              }
+            ]
+          }
+        }
+        response = @client.put_search_settings(engine_name, body: body)
+
+        expect(response.status).to eq 200
+        expect(response.body['boosts']).to eq(
+          {
+            'year' => [
+              { 'type' => 'proximity',
+                'function' => 'linear',
+                'center' => 1950,
+                'factor' => 9 }
+            ]
+          }
+        )
+      end
+    end
+
+    it 'resets search settings' do
+      VCR.use_cassette('app_search/api_reset_search_settings') do
+        response = @client.reset_search_settings(engine_name)
+
+        expect(response.body['boosts']).to eq({})
+        expect(response.status).to eq 200
+      end
+    end
+  end
+end

data/spec/app-search/api_synonyms_spec.rb

@@ -0,0 +1,79 @@
+# 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'
+require_relative './api_spec_helper'
+
+describe Elastic::EnterpriseSearch::AppSearch::Client do
+  context 'synonyms' do
+    let(:engine_name) { 'videogames' }
+    let(:id) { 'id' }
+
+    it 'creates a synonym set' do
+      VCR.use_cassette('app_search/create_synonym_set') do
+        response = @client.create_synonym_set(engine_name, body: { synonyms: ['joypad', 'gamepad'] })
+
+        expect(response.status).to eq 200
+        expect(response.body['synonyms'].sort).to eq ['gamepad', 'joypad']
+        expect(response.body['id'])
+      end
+    end
+
+    it 'lists synonym sets' do
+      VCR.use_cassette('app_search/list_synonym_sets') do
+        response = @client.list_synonym_sets(engine_name)
+
+        expect(response.status).to eq 200
+        expect(response.body['results'].count).to be > 0
+        expect(response.body['results'].first['synonyms'].sort).to eq ['gamepad', 'joypad']
+      end
+    end
+
+    it 'retrieves a synonym set by ID' do
+      VCR.use_cassette('app_search/synonym_set') do
+        response = @client.synonym_set(engine_name, synonym_set_id: id)
+
+        expect(response.status).to eq 200
+        expect(response.body).to eq({ 'id' => id, 'synonyms' => ['joypad', 'gamepad'] })
+      end
+    end
+
+    it 'updates a synonym set' do
+      VCR.use_cassette('app_search/put_synonym_set') do
+        response = @client.put_synonym_set(
+          engine_name,
+          synonym_set_id: id,
+          body: { synonyms: ['gamepad', 'controller'] }
+        )
+
+        expect(response.status).to eq 200
+        expect(response.body).to eq({ 'id' => id, 'synonyms' => ['gamepad', 'controller'] })
+      end
+    end
+
+    it 'deletes a synonym set' do
+      VCR.use_cassette('app_search/delete_synonym_set') do
+        response = @client.delete_synonym_set(engine_name, synonym_set_id: id)
+
+        expect(response.status).to eq 200
+        expect(response.body).to eq({ 'deleted' => true })
+      end
+    end
+  end
+end

data/spec/app-search/client_spec.rb

@@ -65,4 +65,24 @@ describe Elastic::EnterpriseSearch::AppSearch::Client do
       expect(app_client.http_auth).to eq api_key
     end
   end
+
+  describe '#create_signed_search_key' do
+    let(:key) { 'private-key-value' }
+    let(:api_key_name) { 'private-key' }
+    let(:enforced_options) { { query: 'cat' } }
+
+    subject do
+      Elastic::EnterpriseSearch::AppSearch::Client.create_signed_search_key(
+        key,
+        api_key_name,
+        enforced_options
+      )
+    end
+
+    it 'should build a valid jwt' do
+      decoded_token = JWT.decode(subject, key, true, algorithm: 'HS256')
+      expect(decoded_token[0]['api_key_name']).to(eq(api_key_name))
+      expect(decoded_token[0]['query']).to(eq('cat'))
+    end
+  end
 end

data/spec/enterprise-search/client_spec.rb

@@ -93,4 +93,15 @@ describe Elastic::EnterpriseSearch::Client do
       expect(client.workplace_search.host).to eq host
     end
   end
+
+  context 'meta-header' do
+    let(:transport) { Elastic::EnterpriseSearch::Client.new.instance_variable_get('@transport') }
+    let(:subject) { transport.transport.connections.first.connection.headers }
+    let(:regexp) { /^[a-z]{1,}=[a-z0-9.\-]{1,}(?:,[a-z]{1,}=[a-z0-9._-]+)*$/ }
+
+    it 'sends the correct meta header to transport' do
+      expect(subject['x-elastic-client-meta']).to match(regexp)
+      expect(subject['x-elastic-client-meta']).to match(/^ent=[0-9]+\.[0-9]+\.[0-9]+(p)?,/)
+    end
+  end
 end

data/spec/enterprise-search/request_spec.rb

@@ -90,6 +90,28 @@ describe Elastic::EnterpriseSearch::Client do
         expect(client.put('test', {}, { 'params' => 'test' }).status).to eq(200)
       end
     end
+
+    context 'with custom headers' do
+      let(:custom_header) { { 'x-custom-header' => 'Custom Header Value' } }
+
+      it 'builds the right request' do
+        stub_request(:get, "#{host}/test")
+          .with(body: { 'params' => 'test' })
+          .with(headers: headers.merge(custom_header))
+          .to_return(stub_response)
+
+        expect(client.request(:get, 'test', {}, { 'params' => 'test' }, custom_header).status).to eq(200)
+      end
+
+      it 'builds the right request for put' do
+        stub_request(:put, "#{host}/test")
+          .with(body: { 'params' => 'test' })
+          .with(headers: headers.merge(custom_header))
+          .to_return(stub_response)
+
+        expect(client.put('test', {}, { 'params' => 'test' }, custom_header).status).to eq(200)
+      end
+    end
   end
 
   context 'with ssl' do

data/spec/enterprise-search/utils_spec.rb

@@ -0,0 +1,46 @@
+# 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'
+require_relative './../webmock_requires'
+
+describe Elastic::EnterpriseSearch::Utils do
+  let(:subject) { Class.new { extend Elastic::EnterpriseSearch::Utils } }
+  let(:symbolized_hash) do
+    { title: 'This is the title',
+
+      year: 1985,
+      description: 'A generic description' }
+  end
+  let(:stringified_hash) do
+    {
+      'title' => 'This is the title',
+      'year' => 1985,
+      'description' => 'A generic description'
+    }
+  end
+
+  it 'stringifies keys in a hash' do
+    expect(subject.stringify_keys(symbolized_hash)).to eq stringified_hash
+  end
+
+  it 'symbolizes keys in a hash' do
+    expect(described_class.symbolize_keys(stringified_hash)).to eq symbolized_hash
+  end
+end

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

@@ -0,0 +1,109 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: http://localhost:3002/api/as/v1/engines/?name=comicbooks
+    body:
+      encoding: UTF-8
+      string: "{}"
+    headers:
+      User-Agent:
+      - 'elastic-enteprise-search-ruby/7.11.0.pre (RUBY_VERSION: 2.7.2; linux x86_64;
+        elasticsearch-transport: 7.10.1)'
+      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-Frame-Options:
+      - SAMEORIGIN
+      X-Xss-Protection:
+      - 1; mode=block
+      X-Content-Type-Options:
+      - nosniff
+      X-App-Search-Version:
+      - 7.12.0
+      Content-Type:
+      - application/json;charset=utf-8
+      Vary:
+      - Accept-Encoding, User-Agent
+      - Origin
+      Etag:
+      - W/"aac451759143f353e9b928edc402526a--gzip"
+      Cache-Control:
+      - max-age=0, private, must-revalidate
+      X-Request-Id:
+      - 57603887-9e92-4392-abfc-a72c86079c36
+      X-Runtime:
+      - '0.627512'
+      Transfer-Encoding:
+      - chunked
+      Server:
+      - Jetty(9.4.33.v20201020)
+    body:
+      encoding: ASCII-8BIT
+      string: '{"name":"comicbooks","type":"default","language":null,"document_count":0}'
+    http_version: 
+  recorded_at: Fri, 15 Jan 2021 16:30:41 GMT
+- request:
+    method: post
+    uri: http://localhost:3002/api/as/v1/engines/new-meta-engine/source_engines/
+    body:
+      encoding: UTF-8
+      string: '["comicbooks"]'
+    headers:
+      User-Agent:
+      - 'elastic-enteprise-search-ruby/7.11.0.pre (RUBY_VERSION: 2.7.2; linux x86_64;
+        elasticsearch-transport: 7.10.1)'
+      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-Frame-Options:
+      - SAMEORIGIN
+      X-Xss-Protection:
+      - 1; mode=block
+      X-Content-Type-Options:
+      - nosniff
+      X-App-Search-Version:
+      - 7.12.0
+      Content-Type:
+      - application/json;charset=utf-8
+      Vary:
+      - Accept-Encoding, User-Agent
+      - Origin
+      Etag:
+      - W/"50161cac2a450348c6cba677e3abbdfe--gzip"
+      Cache-Control:
+      - max-age=0, private, must-revalidate
+      X-Request-Id:
+      - e56d499d-a1e9-4b7b-a707-e7432c7fc48a
+      X-Runtime:
+      - '0.079150'
+      Transfer-Encoding:
+      - chunked
+      Server:
+      - Jetty(9.4.33.v20201020)
+    body:
+      encoding: ASCII-8BIT
+      string: '{"name":"new-meta-engine","type":"meta","source_engines":["videogames","books","comicbooks"],"document_count":15}'
+    http_version: 
+  recorded_at: Fri, 15 Jan 2021 16:30:41 GMT
+recorded_with: VCR 3.0.3

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

@@ -0,0 +1,56 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://localhost:3002/api/as/v1/engines/videogames/documents/
+    body:
+      encoding: UTF-8
+      string: "['doc-6005c044ad7f0c8b464b8cc4', 'doc-6005c044ad7f0c8b464b8cc3']"
+    headers:
+      User-Agent:
+      - 'elastic-enteprise-search-ruby/7.11.0.pre (RUBY_VERSION: 2.7.2; linux x86_64;
+        elasticsearch-transport: 7.10.1)'
+      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-Frame-Options:
+      - SAMEORIGIN
+      X-Xss-Protection:
+      - 1; mode=block
+      X-Content-Type-Options:
+      - nosniff
+      X-App-Search-Version:
+      - 7.12.0
+      Content-Type:
+      - application/json;charset=utf-8
+      Vary:
+      - Accept-Encoding, User-Agent
+      - Origin
+      Etag:
+      - W/"bec634096368170891453a3d92df309a--gzip"
+      Cache-Control:
+      - max-age=0, private, must-revalidate
+      X-Request-Id:
+      - bb90179c-bf2e-4b54-b9dc-0aacfc0715ac
+      X-Runtime:
+      - '0.080462'
+      Transfer-Encoding:
+      - chunked
+      Server:
+      - Jetty(9.4.33.v20201020)
+    body:
+      encoding: ASCII-8BIT
+      string: '[{"name":"Galaxxian","year":"1979","id":"doc-6005c044ad7f0c8b464b8cc4"},{"name":"Pack-Man","year":"1980","id":"doc-6005c044ad7f0c8b464b8cc3"}]'
+    http_version: 
+  recorded_at: Mon, 18 Jan 2021 17:10:03 GMT
+recorded_with: VCR 3.0.3