elastic-app-search 7.5.0 → 7.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d8fe929d232cc83ec09ac232658d933a1f5f9082552c3a9435898df52dcd7035
-  data.tar.gz: 31d85c082b902fc26d5969c930b936465002b2415edd107f3e74809af87e1adf
+  metadata.gz: 26d0afae8c9cdefaf96ebf4ba72cbda4509f87327a68badb058fe90b22a772eb
+  data.tar.gz: 3edf7e70985084dc6771e1ec7de4a22848bc118ecf54fef8e8b7454228cebed8
 SHA512:
-  metadata.gz: 4e488fdcf558f8002c33957c140633384f0707f12123a25d931649b963f3affb2039e4bc0ebee79d2b12fa42cfd2e0ad38272dd45753b36d6e915494d3d03fe9
-  data.tar.gz: ab987fa529016c6ceba96bc47edb91128d0d6593d7979888d769f92fc8bda512652661729d019d052b899794db2ffa2ee20b12f7c3251f73828a5d1c77971989
+  metadata.gz: dbafac3cc2a8902a958a3a95a693230671c0ac2fcfbf255f296e5010b4f1659285fee4306e10a92d92b2b5f26743714043c52b0232deb519796f947a09a8a36a
+  data.tar.gz: 4d6b6a32d0b9b3cdd610898c596a83dc4ea6bcc4679b9424d4d9f1e62a66d13a11c9999ae6b9d7d523e34fc89a00bbc60c065d5dadcfaf2e0211191e373627ba

data/README.md

@@ -1,8 +1,18 @@
+> **⚠️ This client is deprecated ⚠️**
+>
+> As of Enterprise Search version 7.10.0, we are directing users to the new [Enterprise Search Ruby Client](https://github.com/elastic/enterprise-search-ruby) and
+> deprecating this client.
+>
+> This client will be compatible with all Enterprise Search 7.x releases, but will not be compatible with 8.x releases. Our development effort on this project will
+> be limited to bug fixes. All future enhancements will be focused on the Enterprise Search Ruby Client.
+>
+> Thank you! - Elastic
+
 <p align="center"><img src="https://github.com/elastic/app-search-ruby/blob/master/logo-app-search.png?raw=true" alt="Elastic App Search Logo"></p>
 
 <p align="center"><a href="https://circleci.com/gh/elastic/app-search-ruby"><img src="https://circleci.com/gh/elastic/app-search-ruby.svg?style=svg" alt="CircleCI build"></a></p>
 
-> A first-party Ruby client for building excellent, relevant search experiences with Elastic App Search.
+> A first-party Ruby client for building excellent, relevant search experiences with [Elastic App Search](https://www.elastic.co/products/app-search).
 
 ## Contents
 
@@ -25,7 +35,7 @@ To install the gem, execute:
 gem install elastic-app-search
 ```
 
-Or place `gem 'elastic-app-search', '~> 7.5.0'` in your `Gemfile` and run `bundle install`.
+Or place `gem 'elastic-app-search', '~> 7.10.0'` in your `Gemfile` and run `bundle install`.
 
 ## Versioning
 
@@ -35,34 +45,37 @@ To guarantee compatibility, use the most recent version of this library within t
 
 For example, for App Search `7.3`, use `7.3` of this library or above, but not `8.0`.
 
-If you are a [SaaS](https://app.swiftype.com/as) user, simply use the most recent version of this library.
+If you are using the [SaaS version available on swiftype.com](https://app.swiftype.com/as) of App Search, you should use the version 7.5.x of the client.
 
 ## Usage
 
-### Setup: Configuring the client and authentication
+#### Setup: Configuring the client and authentication
 
-Create a new instance of the Elastic App Search Client. This requires your `[HOST_IDENTIFIER]`, which
-identifies the unique hostname of the App Search API that is associated with your App Search account.
-It also requires a valid `[API_KEY]`, which authenticates requests to the API. You can use any key type with the client, however each has a different scope. For more information on keys, check out the [documentation](https://swiftype.com/documentation/app-search/credentials).
+Using this client assumes that you have already an instance of [Elastic App Search](https://www.elastic.co/products/app-search) up and running.
 
-You can find your `[API_KEY]` and your `[HOST_IDENTIFIER]` within the [Credentials](https://app.swiftype.com/as/credentials) menu:
+Once done, a client can be instantiated using the `[API_KEY]` and the `[API_ENDPOINT]` URL of your App Search setup:
 
 ```ruby
 require 'elastic-app-search'
 
-client = Elastic::AppSearch::Client.new(:host_identifier => 'host-c5s2mj', :api_key => 'private-mu75psc5egt9ppzuycnc2mc3')
+client = Elastic::AppSearch::Client.new(:api_key => 'private-xxxxxxxxxxxxxxxxxxx', :api_endpoint => 'http://localhost:3002/api/as/v1/')
 ```
 
-### Using with App Search Managed Deploys
+Note:
+
+The `[API_KEY]` authenticates requests to the API.
+You can use any key type with the client, however each has a different scope.
+For more information on keys, check out the [documentation](https://swiftype.com/documentation/app-search/api/credentials).
+
+##### Swiftype.com App Search users:
 
-The client can be configured to use a managed deploy by using the
-`api_endpoint` parameter. Since managed deploys do not rely on a `[HOST_IDENTIFIER]`
-, it can be omitted.
+When using the [SaaS version available on swiftype.com](https://app.swiftype.com/as) of App Search, you can configure the client using your `[HOST_IDENTIFIER]` instead of the `[API_ENDPOINT]`.
+The `[HOST_IDENTIFIER]` can be found within the [Credentials](https://app.swiftype.com/as#/credentials) menu.
 
 ```ruby
 require 'elastic-app-search'
 
-client = Elastic::AppSearch::Client.new(:api_key => 'private-mu75psc5egt9ppzuycnc2mc3', :api_endpoint => 'http://localhost:3002/api/as/v1/')
+client = Elastic::AppSearch::Client.new(:host_identifier => 'host-c5s2mj', :api_key => 'private-xxxxxxxxxxxxxxxxxxx')
 ```
 
 ### API Methods
@@ -176,6 +189,33 @@ engine_name = 'favorite-videos'
 client.destroy_engine(engine_name)
 ```
 
+#### Creating Meta Engines
+
+```ruby
+engine_name = 'videos-engine'
+sources_engines = ['favorite-videos', 'all-videos']
+
+client.create_meta_engine(engine_name, source_engines)
+```
+
+#### Adding Meta Engines Source
+
+```ruby
+engine_name = 'videos-engine'
+sources_engines = ['fun-videos', 'cat-videos']
+
+client.add_meta_engine_sources(engine_name, source_engines)
+```
+
+#### Adding Meta Engines Source
+
+```ruby
+engine_name = 'videos-engine'
+sources_engines = ['nsfw-videos']
+
+client.delete_meta_engine_sources(engine_name, source_engines)
+```
+
 #### Searching
 
 ```ruby
@@ -277,6 +317,7 @@ Creating a search key that will only return the title field.
 
 ```ruby
 public_search_key = 'search-xxxxxxxxxxxxxxxxxxxxxxxx'
+# This name must match the name of the key above from your App Search dashboard
 public_search_key_name = 'search-key'
 enforced_options = {
   result_fields: { title: { raw: {} } },
@@ -285,7 +326,8 @@ enforced_options = {
 
 signed_search_key = Elastic::AppSearch::Client.create_signed_search_key(public_search_key, public_search_key_name, enforced_options)
 
-client = Elastic::AppSearch::Client.new(host_identifier: 'host-c5s2mj', api_key: signed_search_key)
+client = Elastic::AppSearch::Client.new(:api_key => signed_search_key, :api_endpoint => 'http://localhost:3002/api/as/v1/')
+
 client.search('national-parks-demo', 'everglade')
 ```
 

data/lib/elastic/app-search/client.rb

@@ -13,6 +13,7 @@ module Elastic
       autoload :Curations, 'elastic/app-search/client/curations'
       autoload :Documents, 'elastic/app-search/client/documents'
       autoload :Engines, 'elastic/app-search/client/engines'
+      autoload :MetaEngines, 'elastic/app-search/client/meta_engines'
       autoload :Logs, 'elastic/app-search/client/logs'
       autoload :Schema, 'elastic/app-search/client/schema'
       autoload :Search, 'elastic/app-search/client/search'
@@ -69,6 +70,7 @@ module Elastic
       include Elastic::AppSearch::Client::Curations
       include Elastic::AppSearch::Client::Documents
       include Elastic::AppSearch::Client::Engines
+      include Elastic::AppSearch::Client::MetaEngines
       include Elastic::AppSearch::Client::Logs
       include Elastic::AppSearch::Client::Schema
       include Elastic::AppSearch::Client::Search

data/lib/elastic/app-search/client/meta_engines.rb

@@ -0,0 +1,23 @@
+module Elastic
+  module AppSearch
+    class Client
+      module MetaEngines
+
+        ENGINE_TYPE_META = 'meta'.freeze()
+
+        def create_meta_engine(engine_name, source_engines)
+          post('engines', :name => engine_name, :type => ENGINE_TYPE_META, :source_engines => source_engines)
+        end
+
+        def add_meta_engine_sources(engine_name, source_engines)
+          post("engines/#{engine_name}/source_engines", source_engines)
+        end
+
+        def delete_meta_engine_sources(engine_name, source_engines)
+          delete("engines/#{engine_name}/source_engines", source_engines)
+        end
+
+      end
+    end
+  end
+end

data/lib/elastic/app-search/version.rb

@@ -1,5 +1,5 @@
 module Elastic
   module AppSearch
-    VERSION = '7.5.0'
+    VERSION = '7.10.0'
   end
 end

data/spec/client_spec.rb

@@ -27,17 +27,33 @@ describe Elastic::AppSearch::Client do
 
   describe 'Requests' do
     it 'should include client name and version in headers' do
-      stub_request(:any, "#{client_options[:host_identifier]}.api.swiftype.com/api/as/v1/engines")
-      client.list_engines
-      expect(WebMock).to(
-        have_requested(:get, "https://#{client_options[:host_identifier]}.api.swiftype.com/api/as/v1/engines")
-        .with(
-          :headers => {
-            'X-Swiftype-Client' => 'elastic-app-search-ruby',
-            'X-Swiftype-Client-Version' => Elastic::AppSearch::VERSION
-          }
+      if (client_options[:api_endpoint])
+        stub_request(:any, "#{client_options[:api_endpoint]}engines")
+        client.list_engines
+        expect(WebMock).to(
+          have_requested(:get, "#{client_options[:api_endpoint]}engines")
+          .with(
+            :headers => {
+              'X-Swiftype-Client' => 'elastic-app-search-ruby',
+              'X-Swiftype-Client-Version' => Elastic::AppSearch::VERSION
+            }
+          )
         )
-      )
+      else
+        # CI runs against saas, so we keep this around for now. CI should be updated
+        # to use slef-managed and we should drop support "host_identifier" this.
+        stub_request(:any, "#{client_options[:host_identifier]}.api.swiftype.com/api/as/v1/engines")
+        client.list_engines
+        expect(WebMock).to(
+          have_requested(:get, "https://#{client_options[:host_identifier]}.api.swiftype.com/api/as/v1/engines")
+          .with(
+            :headers => {
+              'X-Swiftype-Client' => 'elastic-app-search-ruby',
+              'X-Swiftype-Client-Version' => Elastic::AppSearch::VERSION
+            }
+          )
+        )
+      end
     end
   end
 

data/spec/documents_spec.rb

@@ -71,7 +71,7 @@ describe Elastic::AppSearch::Client::Documents do
         it 'should return respective errors in an array of document processing hashes' do
           expected = [
             { 'id' => anything, 'errors' => [] },
-            { 'id' => anything, 'errors' => ['Invalid field type: id must be less than 800 characters'] },
+            { 'id' => anything, 'errors' => [anything] },
           ]
           expect(subject).to(match(expected))
         end
@@ -126,34 +126,5 @@ describe Elastic::AppSearch::Client::Documents do
         expect(response[1]['id']).to(eq(second_document_id))
       end
     end
-
-    describe '#list_documents' do
-      let(:documents) { [first_document, second_document] }
-      let(:first_document_id) { 'id' }
-      let(:first_document) { { 'id' => first_document_id, 'url' => 'https://www.youtube.com/watch?v=v1uyQZNg2vE' } }
-      let(:second_document_id) { 'another_id' }
-      let(:second_document) { { 'id' => second_document_id, 'url' => 'https://www.youtube.com/watch?v=9T1vfsHYiKY' } }
-
-      before do
-        client.index_documents(engine_name, documents)
-      end
-
-      context 'when no options are specified' do
-        it 'will return all documents' do
-          response = client.list_documents(engine_name)
-          expect(response['results'].size).to(eq(2))
-          expect(response['results'][0]['id']).to(eq(first_document_id))
-          expect(response['results'][1]['id']).to(eq(second_document_id))
-        end
-      end
-
-      context 'when options are specified' do
-        it 'will return all documents' do
-          response = client.list_documents(engine_name, :page => { :size => 1, :current => 2 })
-          expect(response['results'].size).to(eq(1))
-          expect(response['results'][0]['id']).to(eq(second_document_id))
-        end
-      end
-    end
   end
 end

data/spec/list_documents_spec.rb

@@ -0,0 +1,25 @@
+describe Elastic::AppSearch::Client::Documents do
+  include_context 'App Search Credentials'
+  include_context 'Static Test Engine'
+
+  let(:client) { Elastic::AppSearch::Client.new(client_options) }
+
+  context 'Documents' do
+    describe '#list_documents' do
+      context 'when no options are specified' do
+        it 'will return all documents' do
+          response = client.list_documents(engine_name)
+          expect(response['results'].size).to(eq(2))
+          expect(response['results'].map { |d| d['id'] }).to(include(document1['id'], document2['id']))
+        end
+      end
+
+      context 'when options are specified' do
+        it 'will return all documents' do
+          response = client.list_documents(engine_name, :page => { :size => 1, :current => 2 })
+          expect(response['results'].size).to(eq(1))
+        end
+      end
+    end
+  end
+end

data/spec/meta_engines_spec.rb

@@ -0,0 +1,73 @@
+describe Elastic::AppSearch::Client::MetaEngines do
+  include_context 'App Search Credentials'
+  include_context 'Engine Name'
+  include_context 'Meta Engine Name'
+  include_context 'Test Engine'
+
+  let(:client) { Elastic::AppSearch::Client.new(client_options) }
+  let(:source_engines) { [engine_name] }
+
+  # CI currently runs against SaaS. This feature is a Self-Managed only feature.
+  context 'Meta Engines', :skip => "Unable to test Self-Managed features in CI." do
+
+    after do
+      client.destroy_engine(meta_engine_name) rescue Elastic::AppSearch::NonExistentRecord
+    end
+
+    context '#create_meta_engine' do
+      it 'should create a meta engine when given a right set of parameters' do
+        expect { client.get_engine(meta_engine_name) }.to raise_error(Elastic::AppSearch::NonExistentRecord)
+        client.create_meta_engine(meta_engine_name, source_engines)
+        expect { client.get_engine(meta_engine_name) }.to_not raise_error
+      end
+
+      it 'should return a meta engine object' do
+        engine = client.create_meta_engine(meta_engine_name, source_engines)
+        expect(engine).to be_kind_of(Hash)
+        expect(engine['name']).to eq(meta_engine_name)
+        expect(engine['type']).to eq('meta')
+        expect(engine['source_engines']).to eq(source_engines)
+      end
+
+      it 'should return an error when the engine source engine is empty' do
+        expect { client.create_meta_engine(engine_name, []) }.to(raise_error) do |e|
+          expect(e).to be_a(Elastic::AppSearch::BadRequest)
+          expect(e.errors).to eq(['Source engines are required for meta engines'])
+        end
+      end
+    end
+
+    context '#add_meta_engine_sources' do
+      before do
+        client.create_meta_engine(meta_engine_name, source_engines)
+        client.delete_meta_engine_sources(meta_engine_name, source_engines)
+      end
+
+      it 'should add the source engine' do
+        expect { client.add_meta_engine_sources(meta_engine_name, source_engines) }.to_not raise_error do |engine|
+          expect(engine).to be_kind_of(Hash)
+          expect(engine['name']).to eq(meta_engine_name)
+          expect(engine['type']).to eq('meta')
+          expect(engine['source_engines']).to be_kind_of(Array)
+          expect(engine['source_engines']).to eq(source_engines)
+        end
+      end
+    end
+
+    context '#delete_meta_engine_sources' do
+      before do
+        client.create_meta_engine(meta_engine_name, source_engines)
+      end
+
+      it 'should remove the source engine' do
+        expect { client.delete_meta_engine_sources(meta_engine_name, source_engines) }.to_not raise_error do |engine|
+          expect(engine).to be_kind_of(Hash)
+          expect(engine['name']).to eq(meta_engine_name)
+          expect(engine['type']).to eq('meta')
+          expect(engine['source_engines']).to be_kind_of(Array)
+          expect(engine['source_engines']).to be_empty
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -54,6 +54,10 @@ 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}" }
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: elastic-app-search
 version: !ruby/object:Gem::Version
-  version: 7.5.0
+  version: 7.10.0
 platform: ruby
 authors:
 - Quin Hoxie
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-12-02 00:00:00.000000000 Z
+date: 2020-11-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: awesome_print
@@ -114,6 +114,7 @@ files:
 - 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
@@ -134,7 +135,9 @@ files:
 - 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
@@ -160,8 +163,7 @@ 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
@@ -175,7 +177,9 @@ test_files:
 - 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