elastic-enterprise-search 7.16.0 → 7.17.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e3331736a101d1b938e0911742b67fe42a42849e179e8f5b575f9f2b07dafda2
-  data.tar.gz: 3ef839006353cd13259ec36ddf0244c2c6812f19add3a04b48dd169e2d66238c
+  metadata.gz: 20d5dc58d956de95e2aa7d0723236fddf174fdbf17bb59685609a3cbeb3115cf
+  data.tar.gz: f343bdbeb2448f5a77750a1bf1f28e54152e56662ce490633e5bd49232695230
 SHA512:
-  metadata.gz: 5f1d529bdbd13f0c550bee3f475ee799ec537e39ffc172b18119a194fe61c27a8452c56e1cd1ee8cb68a6d60fb56da92bc4cadad82d35650119df7ef21647e09
-  data.tar.gz: 36465dbde68f27f1d39a7afb829e890e6ccda5c6b4fce70186ecc229ada201de89a13fbbd198d2c6a5b483ac4e4e5c28abd516633d5a45c7b241bc2ecc92d6ff
+  metadata.gz: b7dc1bce350ac51b2061bd1d85037b51d884a31b558aa8d4164a98d4eb18d7d403558029719037f824358788466ad14a050d2c799532fc7505f2d64dc681fb4c
+  data.tar.gz: d5c0604ace9a80dd05c3ec1f0b04d6ef0f48aebda33727632ce01d1a3ce7b217cec72d044b9dd3344ba7f160d4350991f4c61b29b875c0c6c3feff0394bc5048

data/.ci/test-matrix.yml

@@ -1,12 +1,12 @@
 ---
 RUBY_VERSION:
+  - 3.1
   - 3.0
   - 2.7
   - 2.6
-  - 2.5
 
 STACK_VERSION:
-  - 7.16-SNAPSHOT
+  - 7.17-SNAPSHOT
 
 SERVICE:
   - appsearch

data/.github/workflows/compatibility.yml

@@ -7,13 +7,13 @@ jobs:
       ES_VERSION: ${{ matrix.es_version }}
     strategy:
       matrix:
-        es_version: [ 7.11, 7.12, 7.13, 7.14, 7.15 ]
+        es_version: [ 7.11, 7.12, 7.13, 7.14, 7.15, 7.16 ]
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v2
     - uses: ruby/setup-ruby@v1
       with:
-        ruby-version: 3.0
+        ruby-version: 3.1
     - name: Build Gemfile with Elasticsearch gem
       run: |
         ruby -v

data/.github/workflows/testing.yml

@@ -7,7 +7,7 @@ jobs:
       ENDPOINT: http://localhost:8080
     strategy:
       matrix:
-        ruby: [ 2.5, 2.6, 2.7, 3.0 ]
+        ruby: [ '2.6', '2.7', '3.0', '3.1' ]
 
     runs-on: ubuntu-latest
     steps:

data/CHANGELOG

@@ -0,0 +1 @@
+See https://www.elastic.co/guide/en/enterprise-search-clients/ruby/current/release_notes.html

data/CODE_OF_CONDUCT

@@ -0,0 +1 @@
+See: https://www.elastic.co/community/codeofconduct

data/CONTRIBUTING.md

@@ -1,5 +1,42 @@
 # Contributing to enterprise-search-ruby
 
+## Run Stack locally
+
+A rake task is included to run the Elastic Enterprise Search stack locally via Docker:
+
+```
+$ rake stack[7.10.0]
+```
+
+This will run Elastic Enterprise Search in http://localhost:3002
+- Username: `enterprise_search`
+- Password: `changeme`
+
+The version of the Elastic Enterprise Search Stack to use should be the same as tags of `https://www.docker.elastic.co/r/enterprise-search`. You can also use SNAPSHOT builds such as `8.0.0-SNAPSHOT`, `7.11-SNAPSHOT`, etc.
+
+## Running Tests
+
+Unit tests for the clients:
+
+```
+$ rake spec:client
+```
+
+Integration tests: you need to have an instance of Enterprise Search running either locally or remotely, and specify the host and credentials in environment variables (see below for a complete dockerized setup). If you're using the included rake task `rake stack[:version]`, you can run the integration tests with the following command:
+
+```
+$ ELASTIC_ENTERPRISE_HOST='http://localhost:3002' \
+  ELASTIC_ENTERPRISE_USER='elastic' \
+  ELASTIC_ENTERPRISE_PASSWORD='changeme' \
+  rake spec:integration
+```
+
+Run integration tests completely within containers, the way we run them on our CI:
+```
+RUNSCRIPTS=enterprise-search STACK_VERSION=7.10.0 ./.ci/run-tests
+```
+
+
 ## Contributing Code Changes
 
 1. Please make sure you have signed the [Contributor License

data/NOTICE

@@ -0,0 +1,2 @@
+Elastic Enterprise Search Ruby Client
+Copyright 2021 Elasticsearch B.V.

data/README.md

@@ -6,48 +6,44 @@
 
 Official Ruby API client for [Elastic Enterprise Search](https://www.elastic.co/enterprise-search). Use this gem to integrate App Search and Workplace Search into your Ruby code.
 
-## Documentation
-
-[See the documentation](https://www.elastic.co/guide/en/enterprise-search-clients/ruby/current/index.html) for compatibility info, configuring, and an API reference.
-
-## Development
-
-### Run Stack locally
+## Installation
 
-A rake task is included to run the Elastic Enterprise Search stack locally via Docker:
+Install the `elastic-enterprise-search` gem from [Rubygems](https://rubygems.org/gems/elastic-enterprise-search):
 
 ```
-$ rake stack[7.10.0]
+$ gem install elastic-enterprise-search
 ```
 
-This will run Elastic Enterprise Search in http://localhost:3002
-- Username: `enterprise_search`
-- Password: `changeme`
+Or add it to your project's Gemfile:
 
-The version of the Elastic Enterprise Search Stack to use should be the same as tags of `https://www.docker.elastic.co/r/enterprise-search`. You can also use SNAPSHOT builds such as `8.0.0-SNAPSHOT`, `7.11-SNAPSHOT`, etc.
+```ruby
+gem 'elastic-enterprise-search', 'VERSION'
+```
 
-### Running Tests
+The Enterprise Search client is implemented with [`elastic-transport`](https://github.com/elastic/elastic-transport-ruby/) as the HTTP layer, which uses [Faraday](https://rubygems.org/gems/faraday). Faraday supports several [adapters](https://lostisland.github.io/faraday/adapters/) and will use `Net::HTTP` by default. For optimal performance with the Enterprise Search API, we suggest using an HTTP library which supports persistent ("keep-alive") connections. For the standard Ruby implementation, this could be https://github.com/drbrain/net-http-persistent[Net::HTTP::Persistent], [patron](https://github.com/toland/patron) or [Typhoeus](https://github.com/typhoeus/typhoeus). For JRuby, [Manticore](https://github.com/cheald/manticore) is a great option as well. Require the library for the adapter in your code and then pass in the `:adapter` parameter to the client when you initialize it:
 
-Unit tests for the clients:
+```ruby
+require 'elastic-enterprise-search'
+require 'faraday/net_http_persistent'
 
+client = Elastic::EnterpriseSearch::Client.new(adapter: :net_http_persistent)
 ```
-$ rake spec:client
-```
+If an adapter is not specified, the client will try to auto-detect available libraries and use the best available HTTP client.
 
-Integration tests: you need to have an instance of Enterprise Search running either locally or remotely, and specify the host and credentials in environment variables (see below for a complete dockerized setup). If you're using the included rake task `rake stack[:version]`, you can run the integration tests with the following command:
+## Documentation
 
-```
-$ ELASTIC_ENTERPRISE_HOST='http://localhost:3002' \
-  ELASTIC_ENTERPRISE_USER='elastic' \
-  ELASTIC_ENTERPRISE_PASSWORD='changeme' \
-  rake spec:integration
-```
+[See the documentation](https://www.elastic.co/guide/en/enterprise-search-clients/ruby/current/index.html) for usage, code examples, configuring the client, and an API reference.
 
-Run integration tests completely within containers, the way we run them on our CI:
-```
-RUNSCRIPTS=enterprise-search STACK_VERSION=7.10.0 ./.ci/run-tests
-```
+See code examples of usage for the [Enterprise Search](https://www.elastic.co/guide/en/enterprise-search-clients/ruby/current/enterprise-search-api.html), [App Search](https://www.elastic.co/guide/en/enterprise-search-clients/ruby/current/app-search-api.html) and [Workplace Search](https://www.elastic.co/guide/en/enterprise-search-clients/ruby/current/workplace-search-api.html) APIs.
+
+## Compatibility
+
+We follow Ruby’s own maintenance policy and officially support all currently maintained versions per [Ruby Maintenance Branches](https://www.ruby-lang.org/en/downloads/branches/).
+
+## Development
+
+See [CONTRIBUTING](https://github.com/elastic/enterprise-search-ruby/blob/main/CONTRIBUTING.md).
 
 ## License
 
-Apache-2.0
+This software is licensed under the [Apache 2 license](./LICENSE). See [NOTICE](./NOTICE).

data/docs/guide/app-search-api.asciidoc

@@ -196,9 +196,6 @@ client.create_crawler_domain(engine_name, body: body)
 # Get crawler domain information
 client.crawler_domain(engine_name, domain_id: domain_id)
 
-# List crawler domains
-client.list_crawler_domains(engine_name)
-
 # Update a crawler domain
 body = { name: 'https://www.wikipedia.org' }
 client.put_crawler_domain(engine_name, domain_id: domain_id, domain: body)
@@ -304,29 +301,6 @@ client.crawler_process_crawl_denied_urls(engine_name, process_crawl_id: id)
 # Cancel an active crawl request, stopping a running crawl if needed.
 client.delete_crawler_active_crawl_request(engine_name)
 ----------------------------
-=== Adaptive Relevance
-
-
-The adaptive relevance API is a **beta** feature. Beta features are subject to change and are not covered by the support SLA of general release (GA) features. Elastic plans to promote this feature to GA in a future release. The adaptive relevance API is not available at all Elastic subscription levels. Refer to the Elastic subscriptions pages for https://www.elastic.co/subscriptions/cloud[Elastic Cloud] and https://www.elastic.co/subscriptions[self-managed] deployments.
-
-[source,rb]
-----------------------------
-# Retrieve adaptive relevance settings
-client.adaptive_relevance_settings(engine_name)
-
-# Update adaptive relevance settings for an engine
-body = { curation: { enabled: true } }
-client.put_adaptive_relevance_settings(engine_name, body: body)
-
-# List suggestions
-client.list_adaptive_relevance_suggestions(engine_name)
-
-# Update adaptive relevance
-client.put_adaptive_relevance_suggestions(engine_name, body: body)
-
-# Retrive adaptive relevance
-client.adaptive_relevance_suggestions(engine_name, search_suggestion_query: 'suggestion')
-----------------------------
 
 === Other API Endpoints
 

data/docs/guide/overview.asciidoc

@@ -14,7 +14,15 @@ For **Elastic Enterprise Search 7.0** and later, use the major version 7 (`7.x.y
 
 [discrete]
 === HTTP Library
-This library uses https://github.com/elastic/elasticsearch-ruby/tree/main/elasticsearch-transport[elasticsearch-transport], the low-level Ruby client for connecting to an Elasticsearch cluster - also used in the official https://github.com/elastic/elasticsearch-ruby[Elasticsearch Ruby Client].
+This library uses https://github.com/elastic/elastic-transport-ruby[elastic-transport], the low-level Ruby client for connecting to an Elastic clusters - also used in the official https://github.com/elastic/elasticsearch-ruby[Elasticsearch Ruby Client]. It uses https://rubygems.org/gems/faraday[Faraday], which supports several https://lostisland.github.io/faraday/adapters/[adapters] and will use `Net::HTTP` by default. For optimal performance with the Enterprise Search API, we suggest using an HTTP library which supports persistent ("keep-alive") connections. For the standard Ruby implementation, this could be https://github.com/drbrain/net-http-persistent[Net::HTTP::Persistent], https://github.com/toland/patron[patron] or https://github.com/typhoeus/typhoeus[Typhoeus]. For JRuby, https://github.com/cheald/manticore[Manticore] is a great option as well. Require the library for the adapter in your code and then pass in the `:adapter` parameter to the client when you initialize it:
+
+[source,ruby]
+---------------------------------------------------
+require 'elastic-enterprise-search'
+require 'faraday/net_http_persistent'
+
+client = Elastic::EnterpriseSearch::Client.new(adapter: :net_http_persistent)
+---------------------------------------------------
 
 All requests, if successful, will return an `Elasticsearch::Transport::Transport::Response` instance. You can access the response `body`, `headers` and `status`.
 

data/docs/guide/release_notes/717.asciidoc

@@ -0,0 +1,21 @@
+[[release_notes_717]]
+=== 7.17 Release notes
+
+[discrete]
+[[release_notes_7171]]
+=== 7.17.1 Release notes
+
+- Updates in Documentation: CHANGELOG, CODE_OF_CONDUCT, CONTRIBUTING, NOTICE, README
+- Adds the option to specify an adapter for Faraday when initializing a client. See https://github.com/elastic/enterprise-search-ruby/blob/main/README.md#elastic-enterprise-search-client[README]
+- Fixes typo in meta data for CLIENT_NAME.
+
+[discrete]
+[[release_notes_7170]]
+=== 7.17.0 Release notes
+
+[discrete]
+==== General
+
+- Tested with Elastic Enterprise Search API version 7.17.0.
+- Last release in the `7.x` branch.
+- Tested with Ruby 2.6, 2.7, 3.0, 3.1

data/docs/guide/release_notes/index.asciidoc

@@ -5,6 +5,7 @@
 [discrete]
 === 7.x
 
+* <<release_notes_717, 7.17.0 Release Notes>>
 * <<release_notes_716, 7.16.0 Release Notes>>
 * <<release_notes_715, 7.15.0 Release Notes>>
 * <<release_notes_714, 7.14.0 Release Notes>>
@@ -13,6 +14,7 @@
 * <<release_notes_711, 7.11.0 Release Notes>>
 * <<release_notes_710, 7.10.0.beta.1 Release Notes>>
 
+include::717.asciidoc[]
 include::716.asciidoc[]
 include::715.asciidoc[]
 include::714.asciidoc[]

data/lib/elastic/app-search/api/crawler_domain_validation_result.rb

@@ -28,7 +28,7 @@ module Elastic
         # @option arguments [String] :body
         # @option arguments [Hash] :headers optional HTTP headers to send with the request
         #
-        # @see https://www.elastic.co/guide/en/app-search/current/web-crawler-api-reference.html#web-crawler-apis-post-crawler-validate-domain
+        # @see https://www.elastic.co/guide/en/app-search/current/web-crawler-api-reference.html
         #
         def crawler_domain_validation_result(arguments = {})
           body = arguments.delete(:body) || {}

data/lib/elastic/app-search/api/crawler_url_tracing_result.rb

@@ -27,9 +27,10 @@ module Elastic
         # @param engine_name [String] Name of the engine (*Required*)
         # @param arguments [Hash] endpoint arguments
         # @option arguments [String] :body
+        # @option arguments [String] :url (*Required*)
         # @option arguments [Hash] :headers optional HTTP headers to send with the request
         #
-        # @see https://www.elastic.co/guide/en/app-search/current/web-crawler-api-reference.html#web-crawler-apis-post-crawler-trace-url
+        # @see https://www.elastic.co/guide/en/app-search/current/web-crawler-api-reference.html
         #
         def crawler_url_tracing_result(engine_name, arguments = {})
           raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name

data/lib/elastic/app-search/api/crawler_url_validation_result.rb

@@ -27,9 +27,10 @@ module Elastic
         # @param engine_name [String] Name of the engine (*Required*)
         # @param arguments [Hash] endpoint arguments
         # @option arguments [String] :body
+        # @option arguments [String] :url (*Required*)
         # @option arguments [Hash] :headers optional HTTP headers to send with the request
         #
-        # @see https://www.elastic.co/guide/en/app-search/current/web-crawler-api-reference.html#web-crawler-apis-post-crawler-validate-url
+        # @see https://www.elastic.co/guide/en/app-search/current/web-crawler-api-reference.html
         #
         def crawler_url_validation_result(engine_name, arguments = {})
           raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name

data/lib/elastic/app-search/api/create_crawler_crawl_rule.rb

@@ -33,7 +33,6 @@ module Elastic
         # @option body [String] :policy  (*Required)
         # @option body [String] :rule  (*Required)
         # @option body [String] :pattern  (*Required)
-        # @option body [String] :created_at
         # @option arguments [Hash] :headers optional HTTP headers to send with the request
         #
         # @see https://www.elastic.co/guide/en/app-search/current/web-crawler-api-reference.html#web-crawler-apis-post-crawl-rules

data/lib/elastic/app-search/api/create_crawler_entry_point.rb

@@ -30,7 +30,6 @@ module Elastic
         # @option arguments [Hash] :body  (Required: value)
         # @option body [String] :id
         # @option body [String] :value  (*Required)
-        # @option body [String] :created_at
         # @option arguments [Hash] :headers optional HTTP headers to send with the request
         #
         # @see https://www.elastic.co/guide/en/app-search/current/web-crawler-api-reference.html#web-crawler-apis-post-entry-points

data/lib/elastic/app-search/api/create_crawler_sitemap.rb

@@ -30,7 +30,6 @@ module Elastic
         # @option arguments [Hash] :body  (Required: url)
         # @option body [String] :id
         # @option body [String] :url  (*Required)
-        # @option body [String] :created_at
         # @option arguments [Hash] :headers optional HTTP headers to send with the request
         #
         # @see https://www.elastic.co/guide/en/app-search/current/web-crawler-api-reference.html#web-crawler-apis-post-sitemaps

data/lib/elastic/app-search/api/create_curation.rb

@@ -31,7 +31,6 @@ module Elastic
         # @option body [Array] :queries List of affected search queries (*Required)
         # @option body [Array] :promoted List of promoted document IDs
         # @option body [Array] :hidden List of hidden document IDs
-        # @option body :suggestion
         # @option arguments [Hash] :headers optional HTTP headers to send with the request
         #
         # @see https://www.elastic.co/guide/en/app-search/current/curations.html#curations-create

data/lib/elastic/app-search/api/log_clickthrough.rb

@@ -26,11 +26,11 @@ module Elastic
         #
         # @param engine_name [String] Name of the engine (*Required*)
         # @param arguments [Hash] endpoint arguments
-        # @option arguments [Hash] :body  (Required: query, document_id)
-        # @option body [String] :query  (*Required)
-        # @option body [String] :request_id
-        # @option body :document_id  (*Required)
-        # @option body [Array] :tags
+        # @option arguments :body Search request parameters
+        # @option body [String] :query Search query text (*Required*)
+        # @option body [String] :document_id The id of the document that was clicked on (*Required*)
+        # @option body [String] :request_id The request id returned in the meta tag of a search API response
+        # @option body [Array] :tags Array of strings representing additional information you wish to track with the clickthrough. You may submit up to 16 tags, and each may be up to 64 characters in length.
         # @option arguments [Hash] :headers optional HTTP headers to send with the request
         #
         # @see https://www.elastic.co/guide/en/app-search/current/clickthrough.html

data/lib/elastic/app-search/api/put_crawler_crawl_rule.rb

@@ -34,7 +34,6 @@ module Elastic
         # @option body [String] :policy  (*Required)
         # @option body [String] :rule  (*Required)
         # @option body [String] :pattern  (*Required)
-        # @option body [String] :created_at
         # @option arguments [Hash] :headers optional HTTP headers to send with the request
         #
         # @see https://www.elastic.co/guide/en/app-search/current/web-crawler-api-reference.html#web-crawler-apis-put-crawl-rule

data/lib/elastic/app-search/api/put_crawler_entry_point.rb

@@ -31,7 +31,6 @@ module Elastic
         # @option arguments [Hash] :body  (Required: value)
         # @option body [String] :id
         # @option body [String] :value  (*Required)
-        # @option body [String] :created_at
         # @option arguments [Hash] :headers optional HTTP headers to send with the request
         #
         # @see https://www.elastic.co/guide/en/app-search/current/web-crawler-api-reference.html#web-crawler-apis-put-entry-point

data/lib/elastic/app-search/api/put_crawler_sitemap.rb

@@ -31,7 +31,6 @@ module Elastic
         # @option arguments [Hash] :body  (Required: url)
         # @option body [String] :id
         # @option body [String] :url  (*Required)
-        # @option body [String] :created_at
         # @option arguments [Hash] :headers optional HTTP headers to send with the request
         #
         # @see https://www.elastic.co/guide/en/app-search/current/web-crawler-api-reference.html#web-crawler-apis-put-sitemap

data/lib/elastic/app-search/api/put_curation.rb

@@ -32,7 +32,6 @@ module Elastic
         # @option body [Array] :queries List of affected search queries (*Required)
         # @option body [Array] :promoted List of promoted document IDs
         # @option body [Array] :hidden List of hidden document IDs
-        # @option body :suggestion
         # @option arguments [Hash] :headers optional HTTP headers to send with the request
         #
         # @see https://www.elastic.co/guide/en/app-search/current/curations.html#curations-update

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

@@ -58,6 +58,7 @@ module Elastic
       # @option options [String] :proxy url of proxy to use, ex: "http://localhost:8888"
       # @option options [Boolean] :log Use the default logger (disabled by default)
       # @option arguments [Object] :logger An instance of a Logger-compatible object
+      # @option arguments [Symbol] :adapter A specific adapter for Faraday (e.g. `:patron`)
       # @option enable_meta_header [Boolean] :enable_meta_header Enable sending the meta data header to Cloud.
       #                                                          (Default: true)
       def initialize(options = {})
@@ -72,6 +73,7 @@ module Elastic
             log: log,
             logger: logger,
             request_timeout: overall_timeout,
+            adapter: adapter,
             transport_options: {
               request: { open_timeout: open_timeout }
             },
@@ -103,6 +105,10 @@ module Elastic
         @options[:logger]
       end
 
+      def adapter
+        @options[:adapter]
+      end
+
       def host
         return DEFAULT_HOST unless @options[:host]
 

data/lib/elastic/enterprise-search/request.rb

@@ -24,7 +24,7 @@ require 'base64'
 
 module Elastic
   module EnterpriseSearch
-    CLIENT_NAME = 'elastic-enteprise-search-ruby'
+    CLIENT_NAME = 'elastic-enterprise-search-ruby'
     CLIENT_VERSION = Elastic::EnterpriseSearch::VERSION
 
     # Module included in Elastic::Enterprise::Client for http requests.

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

@@ -19,6 +19,6 @@
 
 module Elastic
   module EnterpriseSearch
-    VERSION = '7.16.0'
+    VERSION = '7.17.1'
   end
 end

data/spec/app-search/client_spec.rb

@@ -85,4 +85,33 @@ describe Elastic::EnterpriseSearch::AppSearch::Client do
       expect(decoded_token[0]['query']).to(eq('cat'))
     end
   end
+
+  context 'adapters' do
+    let(:client) { described_class.new }
+    let(:adapter) { client.transport.transport.connections.all.first.connection.builder.adapter }
+
+    context 'when no adapter is specified' do
+      it 'uses Faraday NetHttp' do
+        expect(adapter).to eq Faraday::Adapter::NetHttp
+      end
+    end
+
+    context 'when the adapter is patron' do
+      let(:client) { described_class.new(adapter: :patron) }
+
+      it 'uses Faraday with the adapter' do
+        expect(adapter).to eq Faraday::Adapter::Patron
+      end
+    end
+
+    unless defined?(JRUBY_VERSION)
+      context 'when the adapter is typhoeus' do
+        let(:client) { described_class.new(adapter: :patron) }
+
+        it 'uses Faraday with the adapter' do
+          expect(adapter).to eq Faraday::Adapter::Patron
+        end
+      end
+    end
+  end
 end

data/spec/enterprise-search/client_spec.rb

@@ -103,4 +103,33 @@ describe Elastic::EnterpriseSearch::Client do
       expect(subject['x-elastic-client-meta']).to match(/^ent=[0-9]+\.[0-9]+\.[0-9]+(p)?,/)
     end
   end
+
+  context 'adapters' do
+    let(:client) { described_class.new }
+    let(:adapter) { client.transport.transport.connections.all.first.connection.builder.adapter }
+
+    context 'when no adapter is specified' do
+      it 'uses Faraday NetHttp' do
+        expect(adapter).to eq Faraday::Adapter::NetHttp
+      end
+    end
+
+    context 'when the adapter is patron' do
+      let(:client) { described_class.new(adapter: :patron) }
+
+      it 'uses Faraday with the adapter' do
+        expect(adapter).to eq Faraday::Adapter::Patron
+      end
+    end
+
+    unless defined?(JRUBY_VERSION)
+      context 'when the adapter is typhoeus' do
+        let(:client) { described_class.new(adapter: :patron) }
+
+        it 'uses Faraday with the adapter' do
+          expect(adapter).to eq Faraday::Adapter::Patron
+        end
+      end
+    end
+  end
 end

data/spec/fixtures/vcr/workplace_search/create_analytics_event.yml

@@ -10,7 +10,7 @@ http_interactions:
       X-Elastic-Client-Meta:
       - es=7.11.0.pre.1,rb=2.7.2,t=7.11.0.pre.1,fd=1.3.0,nh=1.1
       User-Agent:
-      - 'elastic-enteprise-search-ruby/7.11.0.pre (RUBY_VERSION: 2.7.2; linux x86_64;
+      - 'elastic-enterprise-search-ruby/7.11.0.pre (RUBY_VERSION: 2.7.2; linux x86_64;
         elasticsearch-transport: 7.11.0.pre.1)'
       Content-Type:
       - application/json

data/spec/fixtures/vcr/workplace_search/oauth_request_token.yml

@@ -10,7 +10,7 @@ http_interactions:
       X-Elastic-Client-Meta:
       - es=7.11.0.pre.1,rb=2.7.2,t=7.11.0.pre.1,fd=1.3.0,nh=1.1
       User-Agent:
-      - 'elastic-enteprise-search-ruby/7.11.0.pre (RUBY_VERSION: 2.7.2; linux x86_64;
+      - 'elastic-enterprise-search-ruby/7.11.0.pre (RUBY_VERSION: 2.7.2; linux x86_64;
         elasticsearch-transport: 7.11.0.pre.1)'
       Content-Type:
       - application/json

data/spec/fixtures/vcr/workplace_search/search_request.yml

@@ -10,7 +10,7 @@ http_interactions:
       X-Elastic-Client-Meta:
       - es=7.11.0.pre.1,rb=2.7.2,t=7.11.0.pre.1,fd=1.3.0,nh=1.1
       User-Agent:
-      - 'elastic-enteprise-search-ruby/7.11.0.pre (RUBY_VERSION: 2.7.2; linux x86_64;
+      - 'elastic-enterprise-search-ruby/7.11.0.pre (RUBY_VERSION: 2.7.2; linux x86_64;
         elasticsearch-transport: 7.11.0.pre.1)'
       Content-Type:
       - application/json

data/spec/integration/app-search/crawler_domain_spec.rb

@@ -34,7 +34,7 @@ describe Elastic::EnterpriseSearch::AppSearch::Client do
       sleep 1
     end
 
-    it 'creates, gets and lists a crawler domain' do
+    it 'creates and gets a crawler domain' do
       body = { name: name }
       response = client.create_crawler_domain(engine_name, body: body)
       @domain = response.body
@@ -48,11 +48,6 @@ describe Elastic::EnterpriseSearch::AppSearch::Client do
       expect(response.status).to eq 200
       expect(response.body['id']).to eq @domain['id']
       expect(response.body).to include('name' => name)
-
-      # client.list_crawler_domains
-      response = client.list_crawler_domains(engine_name)
-      expect(response.status).to eq 200
-      expect(response.body['results'].first['id']).to eq(@domain['id'])
     end
 
     it 'creates and updates a crawler domain' do

data/spec/workplace-search/client_spec.rb

@@ -96,4 +96,33 @@ describe Elastic::EnterpriseSearch::WorkplaceSearch::Client do
       expect(client.authorization_url('client_id', 'https://localhost:3002')).to eq authorization_url
     end
   end
+
+  context 'adapters' do
+    let(:client) { described_class.new }
+    let(:adapter) { client.transport.transport.connections.all.first.connection.builder.adapter }
+
+    context 'when no adapter is specified' do
+      it 'uses Faraday NetHttp' do
+        expect(adapter).to eq Faraday::Adapter::NetHttp
+      end
+    end
+
+    context 'when the adapter is patron' do
+      let(:client) { described_class.new(adapter: :patron) }
+
+      it 'uses Faraday with the adapter' do
+        expect(adapter).to eq Faraday::Adapter::Patron
+      end
+    end
+
+    unless defined?(JRUBY_VERSION)
+      context 'when the adapter is typhoeus' do
+        let(:client) { described_class.new(adapter: :patron) }
+
+        it 'uses Faraday with the adapter' do
+          expect(adapter).to eq Faraday::Adapter::Patron
+        end
+      end
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: elastic-enterprise-search
 version: !ruby/object:Gem::Version
-  version: 7.16.0
+  version: 7.17.1
 platform: ruby
 authors:
 - Fernando Briano
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-12-23 00:00:00.000000000 Z
+date: 2022-11-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: elasticsearch-transport
@@ -183,9 +183,12 @@ files:
 - ".github/workflows/testing.yml"
 - ".gitignore"
 - ".rubocop.yml"
+- CHANGELOG
+- CODE_OF_CONDUCT
 - CONTRIBUTING.md
 - Gemfile
 - LICENSE
+- NOTICE
 - README.md
 - Rakefile
 - docs/guide/app-search-api.asciidoc
@@ -202,14 +205,13 @@ files:
 - docs/guide/release_notes/714.asciidoc
 - docs/guide/release_notes/715.asciidoc
 - docs/guide/release_notes/716.asciidoc
+- docs/guide/release_notes/717.asciidoc
 - docs/guide/release_notes/index.asciidoc
 - docs/guide/workplace-search-api.asciidoc
 - elastic-enterprise-search.gemspec
 - lib/data/ca-bundle.crt
 - lib/elastic-enterprise-search.rb
 - lib/elastic/.rubocop.yml
-- lib/elastic/app-search/api/adaptive_relevance_settings.rb
-- lib/elastic/app-search/api/adaptive_relevance_suggestions.rb
 - lib/elastic/app-search/api/add_meta_engine_source.rb
 - lib/elastic/app-search/api/api_key.rb
 - lib/elastic/app-search/api/api_logs.rb
@@ -255,10 +257,8 @@ files:
 - lib/elastic/app-search/api/documents.rb
 - lib/elastic/app-search/api/engine.rb
 - lib/elastic/app-search/api/index_documents.rb
-- lib/elastic/app-search/api/list_adaptive_relevance_suggestions.rb
 - lib/elastic/app-search/api/list_api_keys.rb
 - lib/elastic/app-search/api/list_crawler_crawl_requests.rb
-- lib/elastic/app-search/api/list_crawler_domains.rb
 - lib/elastic/app-search/api/list_crawler_process_crawls.rb
 - lib/elastic/app-search/api/list_curations.rb
 - lib/elastic/app-search/api/list_documents.rb
@@ -266,8 +266,6 @@ files:
 - lib/elastic/app-search/api/list_synonym_sets.rb
 - lib/elastic/app-search/api/log_clickthrough.rb
 - lib/elastic/app-search/api/multi_search.rb
-- lib/elastic/app-search/api/put_adaptive_relevance_settings.rb
-- lib/elastic/app-search/api/put_adaptive_relevance_suggestions.rb
 - lib/elastic/app-search/api/put_api_key.rb
 - lib/elastic/app-search/api/put_crawler_crawl_rule.rb
 - lib/elastic/app-search/api/put_crawler_crawl_schedule.rb
@@ -344,7 +342,6 @@ files:
 - spec/fixtures/vcr/workplace_search/create_analytics_event.yml
 - spec/fixtures/vcr/workplace_search/oauth_request_token.yml
 - spec/fixtures/vcr/workplace_search/search_request.yml
-- spec/integration/app-search/adaptive_relevance_spec.rb
 - spec/integration/app-search/api_key_spec.rb
 - spec/integration/app-search/api_logs_spec.rb
 - spec/integration/app-search/app_search_helper.rb
@@ -412,7 +409,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.3.7
 signing_key: 
 specification_version: 4
 summary: Official API client for Elastic Enterprise Search

data/lib/elastic/app-search/api/adaptive_relevance_settings.rb

@@ -1,51 +0,0 @@
-# frozen_string_literal: true
-
-# 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.
-
-module Elastic
-  module EnterpriseSearch
-    module AppSearch
-      module Actions
-        # AdaptiveRelevanceSettings - Retrieve adaptive relevance settings
-        # Retrieve adaptive relevance settings
-        #
-        # @param engine_name [String] Name of the engine (*Required*)
-        # @param arguments [Hash] endpoint arguments
-        # @option arguments [Hash] :body The request body
-        # @option arguments [Hash] :headers optional HTTP headers to send with the request
-        #
-        # @see https://www.elastic.co/guide/en/app-search/current/adaptive-relevance-api-reference.html#adaptive-relevance-api-get-engine-adaptive-relevance-settings
-        #
-        def adaptive_relevance_settings(engine_name, arguments = {})
-          raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name
-
-          body = arguments.delete(:body) || {}
-          headers = arguments.delete(:headers) || {}
-
-          request(
-            :get,
-            "api/as/v0/engines/#{engine_name}/adaptive_relevance/settings/",
-            arguments,
-            body,
-            headers
-          )
-        end
-      end
-    end
-  end
-end

data/lib/elastic/app-search/api/adaptive_relevance_suggestions.rb

@@ -1,56 +0,0 @@
-# frozen_string_literal: true
-
-# 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.
-
-module Elastic
-  module EnterpriseSearch
-    module AppSearch
-      module Actions
-        # AdaptiveRelevanceSuggestions - Retrieve adaptive relevance
-        # Retrieve adaptive relevance for a single query
-        #
-        # @param engine_name [String] Name of the engine (*Required*)
-        # @param arguments [Hash] endpoint arguments
-        # @option arguments [String] :search_suggestion_query Query to obtain suggestions (*Required*)
-        # @option arguments [Hash] :body
-        # @option body :page
-        # @option body :filters
-        # @option arguments [Hash] :headers optional HTTP headers to send with the request
-        #
-        # @see https://www.elastic.co/guide/en/app-search/current/adaptive-relevance-api-reference.html#adaptive-relevance-api-get-engine-adaptive-relevance-suggestions-query
-        #
-        def adaptive_relevance_suggestions(engine_name, arguments = {})
-          raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name
-          raise ArgumentError, "Required parameter 'search_suggestion_query' missing" unless arguments[:search_suggestion_query]
-
-          search_suggestion_query = arguments[:search_suggestion_query]
-          body = arguments.delete(:body) || {}
-          headers = arguments.delete(:headers) || {}
-
-          request(
-            :post,
-            "api/as/v0/engines/#{engine_name}/adaptive_relevance/suggestions/#{search_suggestion_query}/",
-            arguments,
-            body,
-            headers
-          )
-        end
-      end
-    end
-  end
-end

data/lib/elastic/app-search/api/list_adaptive_relevance_suggestions.rb

@@ -1,53 +0,0 @@
-# frozen_string_literal: true
-
-# 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.
-
-module Elastic
-  module EnterpriseSearch
-    module AppSearch
-      module Actions
-        # AdaptiveRelevanceSuggestions - Retrieve adaptive relevance
-        # Retrieve adaptive relevance
-        #
-        # @param engine_name [String] Name of the engine (*Required*)
-        # @param arguments [Hash] endpoint arguments
-        # @option arguments [Hash] :body
-        # @option body :page
-        # @option body :filters
-        # @option arguments [Hash] :headers optional HTTP headers to send with the request
-        #
-        # @see https://www.elastic.co/guide/en/app-search/current/adaptive-relevance-api-reference.html#adaptive-relevance-api-get-engine-adaptive-relevance-suggestions
-        #
-        def list_adaptive_relevance_suggestions(engine_name, arguments = {})
-          raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name
-
-          body = arguments.delete(:body) || {}
-          headers = arguments.delete(:headers) || {}
-
-          request(
-            :post,
-            "api/as/v0/engines/#{engine_name}/adaptive_relevance/suggestions/",
-            arguments,
-            body,
-            headers
-          )
-        end
-      end
-    end
-  end
-end

data/lib/elastic/app-search/api/list_crawler_domains.rb

@@ -1,51 +0,0 @@
-# frozen_string_literal: true
-
-# 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.
-
-module Elastic
-  module EnterpriseSearch
-    module AppSearch
-      module Actions
-        # Crawler - List crawler domains
-        # Returns a list of crawler domains
-        #
-        # @param engine_name [String] Name of the engine (*Required*)
-        # @param arguments [Hash] endpoint arguments
-        # @option arguments [Hash] :body The request body
-        # @option arguments [Hash] :headers optional HTTP headers to send with the request
-        #
-        # @see https://www.elastic.co/guide/en/app-search/current/web-crawler-api-reference.html#web-crawler-apis-get-crawler-domain
-        #
-        def list_crawler_domains(engine_name, arguments = {})
-          raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name
-
-          body = arguments.delete(:body) || {}
-          headers = arguments.delete(:headers) || {}
-
-          request(
-            :get,
-            "api/as/v0/engines/#{engine_name}/crawler/domains/",
-            arguments,
-            body,
-            headers
-          )
-        end
-      end
-    end
-  end
-end

data/lib/elastic/app-search/api/put_adaptive_relevance_settings.rb

@@ -1,52 +0,0 @@
-# frozen_string_literal: true
-
-# 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.
-
-module Elastic
-  module EnterpriseSearch
-    module AppSearch
-      module Actions
-        # AdaptiveRelevanceSettings - Update adaptive relevance settings
-        # Update adaptive relevance settings
-        #
-        # @param engine_name [String] Name of the engine (*Required*)
-        # @param arguments [Hash] endpoint arguments
-        # @option arguments [Hash] :body  (Required: curation)
-        # @option body [Object] :curation  (*Required)
-        # @option arguments [Hash] :headers optional HTTP headers to send with the request
-        #
-        # @see https://www.elastic.co/guide/en/app-search/current/adaptive-relevance-api-reference.html#adaptive-relevance-api-put-engine-adaptive-relevance-settings
-        #
-        def put_adaptive_relevance_settings(engine_name, arguments = {})
-          raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name
-
-          body = arguments.delete(:body) || {}
-          headers = arguments.delete(:headers) || {}
-
-          request(
-            :put,
-            "api/as/v0/engines/#{engine_name}/adaptive_relevance/settings/",
-            arguments,
-            body,
-            headers
-          )
-        end
-      end
-    end
-  end
-end

data/lib/elastic/app-search/api/put_adaptive_relevance_suggestions.rb

@@ -1,51 +0,0 @@
-# frozen_string_literal: true
-
-# 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.
-
-module Elastic
-  module EnterpriseSearch
-    module AppSearch
-      module Actions
-        # AdaptiveRelevanceSuggestions - Update adaptive relevance
-        # Update adaptive relevance
-        #
-        # @param engine_name [String] Name of the engine (*Required*)
-        # @param arguments [Hash] endpoint arguments
-        # @option arguments [Array] :body
-        # @option arguments [Hash] :headers optional HTTP headers to send with the request
-        #
-        # @see https://www.elastic.co/guide/en/app-search/current/adaptive-relevance-api-reference.html#adaptive-relevance-api-put-engine-adaptive-relevance-suggestions
-        #
-        def put_adaptive_relevance_suggestions(engine_name, arguments = {})
-          raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name
-
-          body = arguments.delete(:body) || {}
-          headers = arguments.delete(:headers) || {}
-
-          request(
-            :put,
-            "api/as/v0/engines/#{engine_name}/adaptive_relevance/suggestions/",
-            arguments,
-            body,
-            headers
-          )
-        end
-      end
-    end
-  end
-end

data/spec/integration/app-search/adaptive_relevance_spec.rb

@@ -1,80 +0,0 @@
-# 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 "#{__dir__}/app_search_helper.rb"
-
-describe Elastic::EnterpriseSearch::AppSearch::Client do
-  context 'Adaptive Relevance' do
-    let(:engine_name) { 'adaptive-relevance' }
-
-    before do
-      create_engine(engine_name)
-    end
-
-    after do
-      delete_engines
-    end
-
-    it 'retrieves adaptive relevance settings' do
-      response = client.adaptive_relevance_settings(engine_name)
-      expect(response.body['curation'])
-      expect(response.status).to eq 200
-    end
-
-    it 'updates settings and lists adaptive relevance for an engine' do
-      body = { curation: { enabled: true } }
-      # Enables curations
-      response = client.put_adaptive_relevance_settings(engine_name, body: body)
-      expect(response.status).to eq 200
-      expect(response.body.dig('curation', 'enabled'))
-
-      # Lists suggestions
-      response = client.list_adaptive_relevance_suggestions(engine_name)
-      expect(response.status).to eq 200
-      expect(response.body['meta'])
-      expect(response.body['results'])
-    end
-
-    xit 'updates adaptive relevance' do
-      body = { curation: { enabled: true } }
-      client.put_adaptive_relevance_settings(engine_name, body: body)
-
-      # Index document and create curation:
-      id = client.index_documents(engine_name, documents: [{ title: 'experiment' }]).body.first['id']
-      body = { queries: ['test'], promoted: [id] }
-      client.create_curation(engine_name, body: body)
-      body = [{ query: 'test', type: 'curation', status: 'applied' }]
-      response = client.put_adaptive_relevance_suggestions(engine_name, body: body)
-
-      expect(response.status).to eq 200
-    end
-
-    xit 'retrieves an adaptive relevance' do
-      # Enables curations
-      client.put_adaptive_relevance_settings(engine_name, body: { curation: { enabled: true } })
-      id = client.index_documents(engine_name, documents: [{ title: 'experiment' }]).body.first['id']
-      body = { queries: ['test'], promoted: [id] }
-      client.create_curation(engine_name, body: body)
-
-      response = client.adaptive_relevance_suggestions(engine_name, search_suggestion_query: 'test')
-      expect(response.status).to eq 200
-      expect(response.body)
-    end
-  end
-end