elastic-enterprise-search 0.3.1 → 7.12.1

data/spec/app-search/api_query_suggestion_spec.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_relative './api_spec_helper'
+
+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
+
+        expect(response.body['results']['documents']).to include(
+          { 'suggestion' => 'moon' },
+          { 'suggestion' => 'moon men' }
+        )
+      end
+    end
+  end
+end

data/spec/app-search/api_schema_spec.rb

@@ -0,0 +1,48 @@
+# 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 'schema' do
+    let(:engine_name) { 'films' }
+
+    it 'returns an engine schema' do
+      VCR.use_cassette('app_search/api_schema') do
+        response = @client.schema(engine_name)
+
+        expect(response.status).to eq 200
+        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
+end

data/spec/app-search/api_search_and_multi_search_spec.rb

@@ -0,0 +1,48 @@
+# 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
+  let(:engine_name) { 'books' }
+
+  context 'single search' do
+    it 'performs a single query search' do
+      VCR.use_cassette('app_search/single_query_search') do
+        response = @client.search(engine_name, query: 'Herman')
+        expect(response.status).to eq 200
+        expect(response.body).not_to be nil
+        expect(response.body['results'].count).to be > 1
+      end
+    end
+  end
+
+  context 'multi query search' do
+    it 'performs a multi query search' do
+      VCR.use_cassette('app_search/multi_query_search') do
+        response = @client.multi_search('books', body: [{ query: 'Herman' }, { query: 'Edgar' }])
+        expect(response.status).to eq 200
+        expect(response.body.class).to be Array
+        expect(response.body.count).to be 2
+        expect(response.body[0]['results']).to_not be nil
+        expect(response.body[1]['results']).to_not be nil
+      end
+    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_spec_helper.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.configure do |config|
+  config.before(:example) do
+    @host = ENV['ELASTIC_ENTERPRISE_HOST'] || 'http://localhost:3002'
+    @api_key = ENV['ELASTIC_APPSEARCH_API_KEY'] || 'api_key'
+    @client = Elastic::EnterpriseSearch::AppSearch::Client.new(
+      host: @host,
+      http_auth: @api_key
+    )
+  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/api_top_clicks_analytics_spec.rb

@@ -0,0 +1,44 @@
+# 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 'api_top_clicks_analytics' do
+    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
+
+        expect(response.body['results'])
+        expect(response.body['meta'])
+      end
+    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
+
+        expect(response.body['results'])
+        expect(response.body['meta'])
+      end
+    end
+  end
+end

data/spec/app-search/api_top_queries_analytics_spec.rb

@@ -0,0 +1,34 @@
+# 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 'api_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
+
+        expect(response.body['results'])
+        expect(response.body['meta'])
+      end
+    end
+  end
+end

data/spec/app-search/client_spec.rb

@@ -0,0 +1,88 @@
+# 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'
+
+describe Elastic::EnterpriseSearch::AppSearch::Client do
+  let(:host) { 'https://localhost:8080' }
+  let(:api_key) { 'api_key' }
+
+  context 'dependant on EnterpriseSearch' do
+    let(:ent_client) { Elastic::EnterpriseSearch::Client.new(host: host) }
+    let(:app_client) { ent_client.app_search }
+
+    it 'initializes an app search client' do
+      expect(app_client).not_to be nil
+      expect(app_client).to be_a(Elastic::EnterpriseSearch::AppSearch::Client)
+      expect(app_client.host).to eq(host)
+    end
+
+    it 'sets up authentication during initialization' do
+      ent_client = Elastic::EnterpriseSearch::Client.new(host: host)
+      app_client = ent_client.app_search(http_auth: api_key)
+      expect(app_client.http_auth).to eq api_key
+    end
+
+    it 'sets up authentication as a parameter' do
+      app_client.http_auth = api_key
+      expect(app_client.http_auth).to eq api_key
+    end
+  end
+
+  context 'independent from EnterpriseSearch client' do
+    let(:app_client) { Elastic::EnterpriseSearch::AppSearch::Client.new(host: host) }
+
+    it 'initializes a workplace search client' do
+      expect(app_client).not_to be nil
+      expect(app_client).to be_a(Elastic::EnterpriseSearch::AppSearch::Client)
+      expect(app_client.host).to eq(host)
+    end
+
+    it 'sets up authentication during initialization' do
+      ent_client = Elastic::EnterpriseSearch::Client.new(host: host)
+      app_client = ent_client.app_search(http_auth: api_key)
+      expect(app_client.http_auth).to eq api_key
+    end
+
+    it 'sets up authentication as a parameter' do
+      app_client.http_auth = api_key
+      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