elastic-app-search 7.4.0 → 7.8.0

data/spec/query_suggestion_spec.rb

@@ -0,0 +1,37 @@
+describe Elastic::AppSearch::Client::Search do
+  include_context 'App Search Credentials'
+  include_context 'Static Test Engine'
+
+  let(:client) { Elastic::AppSearch::Client.new(client_options) }
+
+  context 'QuerySuggest' do
+    describe '#query_suggestion' do
+      let(:query) { 'cat' }
+      let(:options) { { :size => 3, :types => { :documents => { :fields => ['title'] } } } }
+
+      context 'when options are provided' do
+        subject { client.query_suggestion(engine_name, query, options) }
+
+        it 'should request query suggestions' do
+          expected = {
+            'meta' => anything,
+            'results' => anything
+          }
+          expect(subject).to(match(expected))
+        end
+      end
+
+      context 'when options are omitted' do
+        subject { client.query_suggestion(engine_name, query) }
+
+        it 'should request query suggestions' do
+          expected = {
+            'meta' => anything,
+            'results' => anything
+          }
+          expect(subject).to(match(expected))
+        end
+      end
+    end
+  end
+end

data/spec/schema_spec.rb

@@ -0,0 +1,23 @@
+describe Elastic::AppSearch::Client::Schema do
+  include_context 'App Search Credentials'
+  include_context 'Test Engine'
+
+  let(:client) { Elastic::AppSearch::Client.new(client_options) }
+
+  context '#get_schema' do
+    before { client.update_schema(engine_name, 'title' => 'text') }
+    subject { client.get_schema(engine_name) }
+
+    it 'will retrieve a schema' do
+      expect(subject).to(eq('title' => 'text'))
+    end
+  end
+
+  context '#update_schema' do
+    subject { client.update_schema(engine_name, 'square_km' => 'number') }
+
+    it 'will update a schema' do
+      expect(subject).to(eq('square_km' => 'number'))
+    end
+  end
+end

data/spec/search_settings_spec.rb

@@ -0,0 +1,65 @@
+describe Elastic::AppSearch::Client::SearchSettings do
+  include_context 'App Search Credentials'
+  include_context 'Test Engine'
+
+  let(:client) { Elastic::AppSearch::Client.new(client_options) }
+
+  context 'SearchSettings' do
+    let(:default_settings) do
+      {
+        'search_fields' => {
+          'id' => {
+            'weight' => 1
+          }
+        },
+        'result_fields' => { 'id' => { 'raw' => {} } },
+        'boosts' => {}
+      }
+    end
+
+    let(:updated_settings) do
+      {
+        'search_fields' => {
+          'id' => {
+            'weight' => 3
+          }
+        },
+        'result_fields' => { 'id' => { 'raw' => {} } },
+        'boosts' => {}
+      }
+    end
+
+    describe '#show_settings' do
+      subject { client.show_settings(engine_name) }
+
+      it 'should return default settings' do
+        expect(subject).to(match(default_settings))
+      end
+    end
+
+    describe '#update_settings' do
+      subject { client.show_settings(engine_name) }
+
+      before do
+        client.update_settings(engine_name, updated_settings)
+      end
+
+      it 'should update search settings' do
+        expect(subject).to(match(updated_settings))
+      end
+    end
+
+    describe '#reset_settings' do
+      subject { client.show_settings(engine_name) }
+
+      before do
+        client.update_settings(engine_name, updated_settings)
+        client.reset_settings(engine_name)
+      end
+
+      it 'should reset search settings' do
+        expect(subject).to(match(default_settings))
+      end
+    end
+  end
+end

data/spec/search_spec.rb

@@ -0,0 +1,96 @@
+describe Elastic::AppSearch::Client::Search do
+  include_context 'App Search Credentials'
+  include_context 'Static Test Engine'
+
+  let(:client) { Elastic::AppSearch::Client.new(client_options) }
+
+  context 'Search' do
+    describe '#search' do
+      subject { client.search(engine_name, query, options) }
+      let(:query) { '' }
+      let(:options) { { 'page' => { 'size' => 2 } } }
+
+      it 'should execute a search query' do
+        expected = {
+          'meta' => anything,
+          'results' => [anything, anything]
+        }
+        expect(subject).to(match(expected))
+      end
+    end
+
+    describe '#multi_search' do
+      subject { client.multi_search(engine_name, queries) }
+
+      context 'when options are provided' do
+        let(:queries) do
+          [
+            { 'query' => 'gatsby', 'options' => { 'page' => { 'size' => 1 } } },
+            { 'query' => 'catcher', 'options' => { 'page' => { 'size' => 1 } } }
+          ]
+        end
+
+        it 'should execute a multi search query' do
+          response = subject
+          expected = [
+            {
+              'meta' => anything,
+              'results' => [{ 'id' => { 'raw' => '1' }, 'title' => anything, '_meta' => anything }]
+            },
+            {
+              'meta' => anything,
+              'results' => [{ 'id' => { 'raw' => '2' }, 'title' => anything, '_meta' => anything }]
+            }
+          ]
+          expect(response).to(match(expected))
+        end
+      end
+
+      context 'when options are omitted' do
+        let(:queries) do
+          [
+            { 'query' => 'gatsby' },
+            { 'query' => 'catcher' }
+          ]
+        end
+
+        it 'should execute a multi search query' do
+          response = subject
+          expected = [
+            {
+              'meta' => anything,
+              'results' => [{ 'id' => { 'raw' => '1' }, 'title' => anything, '_meta' => anything }]
+            },
+            {
+              'meta' => anything,
+              'results' => [{ 'id' => { 'raw' => '2' }, 'title' => anything, '_meta' => anything }]
+            }
+          ]
+
+          expect(response).to(match(expected))
+        end
+      end
+
+      context 'when a search is bad' do
+        let(:queries) do
+          [
+            {
+              'query' => 'cat',
+              'options' => { 'search_fields' => { 'taco' => {} } }
+            }, {
+              'query' => 'dog',
+              'options' => { 'search_fields' => { 'body' => {} } }
+            }
+          ]
+        end
+
+        it 'should throw an appropriate error' do
+          expect { subject }.to(raise_error) do |e|
+            expect(e).to(be_a(Elastic::AppSearch::BadRequest))
+            expect(e.errors).to(eq(['Search fields contains invalid field: taco', 'Search fields contains invalid field: body']))
+          end
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -4,9 +4,72 @@ require 'webmock/rspec'
 require 'awesome_print'
 require 'elastic/app-search'
 require 'config_helper'
+require 'securerandom'
 
 WebMock.allow_net_connect!
 
+#
+# Uses a static engine that will not change between tests. It comes preloaded
+# with documents that *are already indexed*. This means tests can run operations
+# that require documents to be indexed, like "search".
+#
+# This is optimal for tests that perform read-only operations, like "search".
+#
+RSpec.shared_context 'Static Test Engine' do
+  before(:all) do
+    @static_engine_name = "ruby-client-test-static-#{SecureRandom.hex}"
+    as_api_key = ConfigHelper.get_as_api_key
+    as_host_identifier = ConfigHelper.get_as_host_identifier
+    as_api_endpoint = ConfigHelper.get_as_api_endpoint
+    client_options = ConfigHelper.get_client_options(as_api_key, as_host_identifier, as_api_endpoint)
+    @static_client = Elastic::AppSearch::Client.new(client_options)
+    @static_client.create_engine(@static_engine_name)
+
+    @document1 = { 'id' => '1', 'title' => 'The Great Gatsby' }
+    @document2 = { 'id' => '2', 'title' => 'Catcher in the Rye' }
+    @documents = [@document1, @document2]
+    @static_client.index_documents(@static_engine_name, @documents)
+
+    # Wait until documents are indexed
+    start = Time.now
+    ready = false
+    until (ready)
+      sleep(3)
+      results = @static_client.search(@static_engine_name, '')
+      ready = true if results['results'].length == 2
+      ready = true if (Time.now - start).to_i >= 120 # Time out after 2 minutes
+    end
+  end
+
+  let(:engine_name) { @static_engine_name }
+  let(:document1) { @document1 }
+  let(:document2) { @document2 }
+
+  after(:all) do
+    @static_client.destroy_engine(@static_engine_name)
+  end
+end
+
+RSpec.shared_context 'Engine Name' do
+  let(:engine_name) { "ruby-client-test-#{SecureRandom.hex}" }
+end
+
+RSpec.shared_context 'Meta Engine Name' do
+  let(:meta_engine_name) { "ruby-client-test-#{SecureRandom.hex}" }
+end
+
+RSpec.shared_context 'Test Engine' do
+  let(:engine_name) { "ruby-client-test-#{SecureRandom.hex}" }
+
+  before(:each) do
+    client.create_engine(engine_name) rescue Elastic::AppSearch::BadRequest
+  end
+
+  after(:each) do
+    client.destroy_engine(engine_name) rescue Elastic::AppSearch::NonExistentRecord
+  end
+end
+
 RSpec.shared_context 'App Search Credentials' do
   let(:as_api_key) { ConfigHelper.get_as_api_key }
   # AS_ACCOUNT_HOST_KEY is deprecated
@@ -17,6 +80,16 @@ RSpec.shared_context 'App Search Credentials' do
   end
 end
 
+RSpec.shared_context 'App Search Admin Credentials' do
+  let(:as_api_key) { ConfigHelper.get_as_admin_key }
+  # AS_ACCOUNT_HOST_KEY is deprecated
+  let(:as_host_identifier) { ConfigHelper.get_as_host_identifier }
+  let(:as_api_endpoint) { ConfigHelper.get_as_api_endpoint }
+  let(:client_options) do
+    ConfigHelper.get_client_options(as_api_key, as_host_identifier, as_api_endpoint)
+  end
+end
+
 RSpec.configure do |config|
   # Run specs in random order to surface order dependencies. If you find an
   # order dependency and want to debug it, you can fix the order by providing

data/spec/synonyms_spec.rb

@@ -0,0 +1,65 @@
+describe Elastic::AppSearch::Client::Synonyms do
+  include_context 'App Search Credentials'
+  include_context 'Test Engine'
+
+  let(:client) { Elastic::AppSearch::Client.new(client_options) }
+
+  context '#create_synonym_set' do
+    let(:synonyms) { ['park', 'trail'] }
+    subject { client.create_synonym_set(engine_name, :synonyms => synonyms) }
+
+    it 'will create a synonym' do
+      expect(subject['id']).not_to(be_empty)
+      expect(subject['synonyms']).to(eq(synonyms))
+    end
+  end
+
+  context '#get_synonym_set' do
+    let(:synonyms) { ['park', 'trail'] }
+    let(:synonym_set_id) { client.create_synonym_set(engine_name, :synonyms => synonyms)['id'] }
+
+    subject { client.get_synonym_set(engine_name, synonym_set_id) }
+
+    it 'will retrieve a synonym set' do
+      expect(subject['id']).to(eq(synonym_set_id))
+      expect(subject['synonyms']).to(eq(synonyms))
+    end
+  end
+
+  context '#update_synonym_set' do
+    let(:synonyms) { ['park', 'trail'] }
+    let(:updated_synonyms) { %w[park trail system] }
+    let(:synonym_set_id) { client.create_synonym_set(engine_name, :synonyms => synonyms)['id'] }
+
+    subject { client.update_synonym_set(engine_name, synonym_set_id, :synonyms => updated_synonyms) }
+
+    it 'will update a synonym set' do
+      expect(subject['id']).to(eq(synonym_set_id))
+      expect(subject['synonyms']).to(eq(updated_synonyms))
+    end
+  end
+
+  context '#list_synonym_sets' do
+    subject { client.list_synonym_sets(engine_name, :current => 2, :size => 10) }
+
+    it 'will list synonyms' do
+      expect(subject['results']).to(eq([]))
+    end
+
+    it 'support paging params' do
+      expect(subject['meta']['page']['current']).to(eq(2))
+      expect(subject['meta']['page']['size']).to(eq(10))
+    end
+  end
+
+  context '#destroy_synonym_set' do
+    let(:synonyms) { ['park', 'trail'] }
+    let(:synonym_set_id) { client.create_synonym_set(engine_name, :synonyms => synonyms)['id'] }
+
+    subject { client.destroy_synonym_set(engine_name, synonym_set_id) }
+
+    it 'will delete a synonym set' do
+      expect(subject['deleted']).to(eq(true))
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: elastic-app-search
 version: !ruby/object:Gem::Version
-  version: 7.4.0
+  version: 7.8.0
 platform: ruby
 authors:
 - Quin Hoxie
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-01 00:00:00.000000000 Z
+date: 2020-06-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: awesome_print
@@ -107,21 +107,43 @@ files:
 - lib/elastic-app-search.rb
 - lib/elastic/app-search.rb
 - lib/elastic/app-search/client.rb
+- lib/elastic/app-search/client/analytics.rb
+- lib/elastic/app-search/client/click.rb
+- lib/elastic/app-search/client/credentials.rb
+- lib/elastic/app-search/client/curations.rb
 - lib/elastic/app-search/client/documents.rb
 - lib/elastic/app-search/client/engines.rb
+- lib/elastic/app-search/client/logs.rb
+- lib/elastic/app-search/client/meta_engines.rb
 - lib/elastic/app-search/client/query_suggestion.rb
+- lib/elastic/app-search/client/schema.rb
 - lib/elastic/app-search/client/search.rb
 - lib/elastic/app-search/client/search_settings.rb
+- lib/elastic/app-search/client/synonyms.rb
 - lib/elastic/app-search/exceptions.rb
 - lib/elastic/app-search/request.rb
 - lib/elastic/app-search/utils.rb
 - lib/elastic/app-search/version.rb
 - logo-app-search.png
 - script/console
+- spec/analytics_spec.rb
+- spec/click_spec.rb
 - spec/client_spec.rb
 - spec/config_helper.rb
+- spec/credentials_spec.rb
+- spec/curations_spec.rb
+- spec/documents_spec.rb
+- spec/engines_spec.rb
 - spec/exceptions_spec.rb
+- spec/list_documents_spec.rb
+- spec/logs_spec.rb
+- spec/meta_engines_spec.rb
+- spec/query_suggestion_spec.rb
+- spec/schema_spec.rb
+- spec/search_settings_spec.rb
+- spec/search_spec.rb
 - spec/spec_helper.rb
+- spec/synonyms_spec.rb
 homepage: https://github.com/elastic/app-search-ruby
 licenses:
 - Apache-2.0
@@ -141,13 +163,26 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Official gem for accessing the Elastic App Search API
 test_files:
+- spec/analytics_spec.rb
+- spec/click_spec.rb
 - spec/client_spec.rb
 - spec/config_helper.rb
+- spec/credentials_spec.rb
+- spec/curations_spec.rb
+- spec/documents_spec.rb
+- spec/engines_spec.rb
 - spec/exceptions_spec.rb
+- spec/list_documents_spec.rb
+- spec/logs_spec.rb
+- spec/meta_engines_spec.rb
+- spec/query_suggestion_spec.rb
+- spec/schema_spec.rb
+- spec/search_settings_spec.rb
+- spec/search_spec.rb
 - spec/spec_helper.rb
+- spec/synonyms_spec.rb