elastic-enterprise-search 8.1.0 → 8.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bdfa7f9a297b7be12956c4afb18c566ef6362be6f80b7ddcdf210a63de35792b
-  data.tar.gz: c0ea8e919e929a7a9a03dd183198d7a29f49b95a9fc1e044fb6d1c4becf87adf
+  metadata.gz: f6d66a77dd32e97bc9bb48101c97ee7b96d3ffef54db3779866a7371ab131523
+  data.tar.gz: 3b31e2deec924443691908abef0be3ed985e09282074e1c3fd37ac1b87b3d67f
 SHA512:
-  metadata.gz: 9bf7a70b4070b475c5929dee3dce93841db5150bd3502b1b22595ed037cc7f9fbb60e4ade158009af80059ee84f727c192663efd4e9913697bb5860110a327f5
-  data.tar.gz: 11ce05ae809478b90e8980b43b0c28fdfa33d79bb3d398fcf832d1bdb25c7495600cde089bb9d448d3a39599e17484c59bce1704f8f4f0fc5fc362eb2215ce37
+  metadata.gz: '060287850883e09c45626b58b282c06d6aa52a177a915636459a452aec11d96ecda0e17bd8ba8c47546543a483761bbadd40ec16da2def6e4bccfcbbc0696cb8'
+  data.tar.gz: 372c2381a0fe668b9fb160b0e0d9eb407607df1f36b49faff209c1a73fa71cc742b0619ccc0f997683e8193f4e15d7f4e60b8b37c3547103d46a46729240da4c

data/.ci/jobs/{elastic+enterprise-search-ruby+7.15.yml → elastic+enterprise-search-ruby+7.17.yml}

@@ -1,12 +1,12 @@
 ---
 - job:
-    name: elastic+enterprise-search-ruby+7.15
-    display-name: 'elastic / enterprise-search-ruby # 7.15'
-    description: Testing the enterprise-search-ruby 7.15 branch.
+    name: elastic+enterprise-search-ruby+7.17
+    display-name: 'elastic / enterprise-search-ruby # 7.17'
+    description: Testing the enterprise-search-ruby 7.17 branch.
     junit_results: "*-junit.xml"
     parameters:
     - string:
         name: branch_specifier
-        default: refs/heads/7.15
+        default: refs/heads/7.17
         description: the Git branch specifier to build (<branchName>, <tagName>,
           <commitId>, etc.)

data/.ci/jobs/{elastic+enterprise-search-ruby+7.16.yml → elastic+enterprise-search-ruby+8.0.yml}

@@ -1,12 +1,12 @@
 ---
 - job:
-    name: elastic+enterprise-search-ruby+7.16
-    display-name: 'elastic / enterprise-search-ruby # 7.16'
-    description: Testing the enterprise-search-ruby 7.16 branch.
+    name: elastic+enterprise-search-ruby+8.0
+    display-name: 'elastic / enterprise-search-ruby # 8.0'
+    description: Testing the enterprise-search-ruby 8.0 branch.
     junit_results: "*-junit.xml"
     parameters:
     - string:
         name: branch_specifier
-        default: refs/heads/7.16
+        default: refs/heads/8.0
         description: the Git branch specifier to build (<branchName>, <tagName>,
           <commitId>, etc.)

data/.ci/run-enterprise-search.sh

@@ -54,6 +54,7 @@ docker run \
   --env "elasticsearch.ssl.certificate=/usr/share/app-search/config/certs/testnode.crt" \
   --env "elasticsearch.ssl.certificate_authority=/usr/share/app-search/config/certs/ca.crt" \
   --env "elasticsearch.ssl.key=/usr/share/app-search/config/certs/testnode.key" \
+  --env "ELASTICSEARCH_SEARCH_API=true" \
   --volume $ssl_cert:/usr/share/app-search/config/certs/testnode.crt \
   --volume $ssl_key:/usr/share/app-search/config/certs/testnode.key \
   --volume $ssl_ca:/usr/share/app-search/config/certs/ca.crt \

data/.ci/test-matrix.yml

@@ -5,7 +5,7 @@ RUBY_VERSION:
   - 2.7
 
 STACK_VERSION:
-  - 8.1-SNAPSHOT
+  - 8.2.0-SNAPSHOT
 
 SERVICE:
   - appsearch

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

@@ -336,6 +336,27 @@ client.put_adaptive_relevance_settings(engine_name, body: body)
 client.refresh_adaptive_relevance_update_process(engine_name, adaptive_relevance_suggestion_type: 'curation')
 ----------------------------
 
+=== Elasticsearch Search
+
+Utilize the API to passthrough and execute raw Elasticsearch queries against the indices that power Enterprise Search engines.
+
+[source,rb]
+----------------------------
+es_request = { body: { query: { bool: { must: { term: { title: 'test' } } } } } }
+client.search_es_search(engine_name, body: { request: es_request })
+----------------------------
+
+=== Search Explain
+
+Submit a search and retrieve an Elasticsearch query.
+
+[source,rb]
+----------------------------
+response = client.search_explain(engine_name, body: { query: 'test' })
+response.body['query_string']
+# => "GET enterprise-search-engine-app-search-explain/_search"
+----------------------------
+
 === Other API Endpoints
 
 [source,rb]

data/docs/guide/connecting.asciidoc

@@ -1,7 +1,6 @@
 [[connecting]]
 == Connecting
 
-
 This page contains the information you need to connect and use the Client with Elastic Enterprise Search.
 
 **On this page**

data/docs/guide/overview.asciidoc

@@ -14,6 +14,7 @@ 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/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]
@@ -38,7 +39,7 @@ If you don't specify a host and port, the client will default to `http://localho
 [discrete]
 === Logging
 
-You can enable logging with the default logger by passing `log: true` as a parameter to the client's initializer, or pass in a Logger object with the `:logger` parameter:
+You can enable logging with the default logger by passing `log: true` as a parameter to the client's initializer, or pass in a Logger object with the `:logger` parameter, any confoming logger implementation:
 
 [source,rb]
 ----------------------------
@@ -46,6 +47,34 @@ logger = MyLogger.new
 client = Elastic::EnterpriseSearch::Client.new(logger: logger)
 ----------------------------
 
+To trace requests and responses in the _Curl_ format, set the `trace` argument:
+
+[source,rb]
+----------------------------
+> client = Elastic::EnterpriseSearch::Client.new(trace: true)
+> client.health                                                                                                                                                                                         
+curl -X GET -H 'x-elastic-client-meta: ent=8.3.0,rb=3.1.2,t=8.0.1,fd=1.10.0,nh=0.2.0, User-Agent: elastic-transport-ruby/8.0.1 (RUBY_VERSION: 3.1.2; linux x86_64; Faraday v1.10.0), Content-Type: application/json
+' 'http://localhost:9200/api/ent/v1/internal/health/?pretty'                                                                                                                                                       
+                                                                                                                                                                                                                   
+# 2022-05-23T08:39:09+01:00 [200] (0.049s)                                                                                                                                                                         
+#                                                                                                                                                                                                                  
+# {"name":"5b8067bf95fb", ...
+ =>                                                                                                                                                                                                                
+#<Elastic::API::Response:0x00007f9096e15f90                                                                                                                                                                        
+ @response=                                                                                                                                                                                                        
+  #<Elastic::Transport::Transport::Response:0x00007f9096e160a8                                                                                                                                                     
+   @body=                                                                                                                                                                                                          
+    {"name"=>"5b8067bf95fb",
+    ...
+----------------------------
+
+This will use the `elastic-transport` default logger. But you can pass in a custom logger with:
+
+[source,rb]
+----------------------------
+client = Elastic::EnterpriseSearch::Client.new(tracer: my_tracer)
+----------------------------
+
 [discrete]
 === License
 

data/docs/guide/release_notes/80.asciidoc

@@ -1,4 +1,15 @@
 [[release_notes_80]]
+=== 8.0 Release notes
+
+[discrete]
+[[release_notes_801]]
+=== 8.0.1 Release notes
+
+- Adds tracer parameters to enable tracing in elastic-transport. See https://www.elastic.co/guide/en/enterprise-search-clients/ruby/current/overview.html#_logging[logging] for more information.
+- Updates Workplace Search OAuth implementation. See https://www.elastic.co/guide/en/enterprise-search-clients/ruby/current/workplace-search-api.html#ws-oauth-authentication[OAuth Authentication] for changes in the OAuth process.
+
+[discrete]
+[[release_notes_800]]
 === 8.0.0 Release notes
 
 [discrete]

data/docs/guide/release_notes/81.asciidoc

@@ -1,4 +1,15 @@
 [[release_notes_81]]
+=== 8.1 Release notes
+
+[discrete]
+[[release_notes_811]]
+=== 8.1.1 Release notes
+
+- Adds tracer parameters to enable tracing in elastic-transport. See https://www.elastic.co/guide/en/enterprise-search-clients/ruby/current/overview.html#_logging[logging] for more information.
+- Updates Workplace Search OAuth implementation. See https://www.elastic.co/guide/en/enterprise-search-clients/ruby/current/workplace-search-api.html#ws-oauth-authentication[OAuth Authentication] for changes in the OAuth process.
+
+[discrete]
+[[release_notes_810]]
 === 8.1.0 Release notes
 
 [discrete]

data/docs/guide/release_notes/82.asciidoc

@@ -0,0 +1,42 @@
+[[release_notes_82]]
+=== 8.2 Release notes
+
+[discrete]
+[[release_notes_821]]
+=== 8.2.1 Release notes
+
+- Adds tracer parameters to enable tracing in elastic-transport. See https://www.elastic.co/guide/en/enterprise-search-clients/ruby/current/overview.html#_logging[logging] for more information.
+- Updates Workplace Search OAuth implementation. See https://www.elastic.co/guide/en/enterprise-search-clients/ruby/current/workplace-search-api.html#ws-oauth-authentication[OAuth Authentication] for changes in the OAuth process.
+
+[discrete]
+[[release_notes_820]]
+=== 8.2.0 Release notes
+
+[discrete]
+==== General
+
+- Tested with Elastic Enterprise Search API version 8.2.0.
+- Tested with Ruby 2.7, 3.0, 3.1, JRuby 9.3. Older versions of Ruby have reached end of life and been removed from the testing matrices. Minimum required Ruby version is Ruby 2.6 to keep compatibility with JRuby 9.3, but it may be upgraded to 2.7 once JRuby 9.4 comes out.
+
+[discrete]
+==== App Search
+[discrete]
+==== New APIs
+
+* Adds Elasticsearch Search API (In Technical Preview): Utilize the API to passthrough and execute raw Elasticsearch queries against the indices that power Enterprise Search engines.
+
++
+[source,rb]
+----------------------------
+es_request = { body: { query: { bool: { must: { term: { title: 'test' } } } } } }
+client.search_es_search(engine_name, body: { request: es_request })
+----------------------------
+
+* Adds Search Explain API: Submit a search and retrieve an Elasticsearch query.
++
+[source,rb]
+----------------------------
+response = client.search_explain(engine_name, body: { query: 'test' })
+response.body['query_string']
+# => "GET enterprise-search-engine-app-search-explain/_search"
+----------------------------

data/docs/guide/release_notes/index.asciidoc

@@ -3,6 +3,8 @@
 
 [discrete]
 === 8.x
+
+* <<release_notes_82, 8.2.0 Release Notes>>
 * <<release_notes_81, 8.1.0 Release Notes>>
 * <<release_notes_80, 8.0.0 Release Notes>>
 
@@ -18,6 +20,7 @@
 * <<release_notes_711, 7.11.0 Release Notes>>
 * <<release_notes_710, 7.10.0.beta.1 Release Notes>>
 
+include::82.asciidoc[]
 include::81.asciidoc[]
 include::80.asciidoc[]
 include::717.asciidoc[]

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

@@ -76,22 +76,42 @@ client.delete_documents_by_query(content_source_id, query: query)
 [[ws-oauth-authentication]]
 === OAuth Authentication
 
-You need to configure the OAuth Application for Search in order to use the Workplace Search client's `search` and `create_analytics` endpoints. You need to follow the steps in https://www.elastic.co/guide/en/workplace-search/current/building-custom-search-workplace-search.html#configuring-search-oauth[Configuring the OAuth Application for Search] to retrieve the credentials: Client ID and Client Secret to request access tokens from the authentication server.
+You need to configure the OAuth Application for Search in order to use the Workplace Search client's `search` and `create_analytics` endpoints. You need to follow the steps in https://www.elastic.co/guide/en/workplace-search/current/building-custom-search-workplace-search.html#configuring-search-oauth[Configuring the OAuth Application for Search] to retrieve the credentials: **Client ID** and **Client Secret** to request access tokens from the authentication server.
+
+The client implements https://www.elastic.co/guide/en/workplace-search/current/building-custom-search-workplace-search.html#authenticating-search-user-confidential[Authenticating Users with a Confidential OAuth Flow]. It provides a helper to obtain the autorization URL directly from the client once you've set the necessary values.
+
+The authorization endpoint is hosted by your Kibana deployment, so you need to provide the client with the https://www.elastic.co/guide/en/enterprise-search/current/endpoints-ref.html#kibana-base-url[base URL of your Kibana instance]. You can do this when you initialize the client:
+
+[source,rb]
+----------------------------
+client = Elastic::EnterpriseSearch::WorkplaceSearch::Client.new(http_auth: <access_token>, kibana_url: <kibana_url>)
+----------------------------
+
+Or you can set in an existing client:
 
 [source,rb]
 ----------------------------
 client = Elastic::EnterpriseSearch::WorkplaceSearch::Client.new(http_auth: <access_token>)
+client.kibana_url = <kibana_url>
+----------------------------
 
+Once you've instantiated a client and the base URL of your Kibana instance is set, you can get the URL for authorization like so:
+[source,rb]
+----------------------------
+# You get the values for client_id and client_secret when configuring the OAuth Application:
 client_id = <client_id>
 client_secret = <client_secret>
 redirect_uri = <redirect_uri>
 
 # Get the authorization URL:
 client.authorization_url(client_id, redirect_uri)
-> https://host:port/ws/oauth/authorize?response_type=code&client_id=client_id&redirect_uri=https%3A%2F%2Flocalhost%3A3002
+> https://kibana_url/app/enterprise_search/workplace_search/p/oauth/authorize?response_type=code&client_id=client_id&redirect_uri=https%3A%2F%2Flocalhost%3A3002
+
 ----------------------------
 
-Open the URL to authorize your application. Successful authorization redirects the user in accordance to the redirect URI provided (and configured for the application). The application server must now request for an access_token, which is generated by Workplace Search using the oauth/token endpoint, using the Client ID and Client Secret.
+Open the URL to authorize your application. Successful authorization redirects the user in accordance to the redirect URI provided (and configured for the application).
+
+The application server must now request for an `access_token`, which is generated by Workplace Search using the `oauth/token` endpoint, using the **Client ID** and **Client Secret**.
 
 [source,rb]
 ----------------------------
@@ -100,7 +120,7 @@ authorization_code = '<paste code from redirect>'
 access_token = client.request_access_token(client_id, client_secret, authorization_code, redirect_uri)
 
 # The access_token can now be used to issue a search request:
-client.search(body: {query: 'search query'}, access_token: access_token)
+client.search(body: { query: 'search query' }, access_token: access_token)
 ----------------------------
 
 See https://www.elastic.co/guide/en/workplace-search/current/workplace-search-search-api.html#search-api-overview[Search API Overview] for more search parameters.

data/elastic-enterprise-search.gemspec

@@ -47,7 +47,7 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
   s.require_paths = ['lib']
 
-  s.add_dependency 'elastic-transport', '8.0.0.pre.1'
+  s.add_dependency 'elastic-transport', '~> 8'
   s.add_runtime_dependency 'jwt', '>= 1.5', '< 3.0'
   s.add_development_dependency 'awesome_print'
   s.add_development_dependency 'byebug' unless defined?(JRUBY_VERSION)

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

@@ -29,7 +29,7 @@ module Elastic
         # @option arguments [String] :search_suggestion_query Query to obtain suggestions (*Required*)
         # @option arguments [Hash] :body
         # @option body :page
-        # @option body [string] :filters
+        # @option body [Hash] :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

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

@@ -31,7 +31,7 @@ module Elastic
         # @option body [Array<string>] :queries List of affected search queries
         # @option body [Array<string>] :promoted List of promoted document IDs
         # @option body [Array<string>] :hidden List of hidden document IDs
-        # @option body [Hash] :suggestion
+        # @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/list_adaptive_relevance_suggestions.rb

@@ -28,7 +28,7 @@ module Elastic
         # @param [Hash] arguments endpoint arguments
         # @option arguments [Hash] :body
         # @option body :page
-        # @option body [string] :filters
+        # @option body [Hash] :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

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

@@ -27,7 +27,7 @@ module Elastic
         # @param [String] engine_name Name of the engine (*Required*)
         # @param [Hash] arguments endpoint arguments
         # @option arguments [Hash] :body (Required: curation)
-        # @option body [Hash] :curation (Required: )
+        # @option body [Hash] :curation
         # @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

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

@@ -32,7 +32,7 @@ module Elastic
         # @option body [Array<string>] :queries List of affected search queries
         # @option body [Array<string>] :promoted List of promoted document IDs
         # @option body [Array<string>] :hidden List of hidden document IDs
-        # @option body [Hash] :suggestion
+        # @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/app-search/api/search_es_search.rb

@@ -0,0 +1,53 @@
+# 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
+        # ElasticsearchSearch - Run a search
+        # Execute the provided Elasticsearch search query against an App Search Engine
+        #
+        # @param [String] engine_name Name of the engine (*Required*)
+        # @param [Hash] arguments endpoint arguments
+        # @option arguments [Hash] :body (Required: request)
+        # @option body :request
+        # @option body :analytics
+        # @option arguments [Hash] :headers optional HTTP headers to send with the request
+        #
+        # @see https://www.elastic.co/guide/en/app-search/current/elasticsearch-search-api-reference.html
+        #
+        def search_es_search(engine_name, arguments = {})
+          raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name
+          raise ArgumentError, "Required parameter 'body (request)' missing" unless arguments[:body]
+
+          body = arguments.delete(:body) || {}
+          headers = arguments.delete(:headers) || {}
+          request(
+            :post,
+            "api/as/v0/engines/#{engine_name}/elasticsearch/_search/",
+            arguments,
+            body,
+            headers
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,61 @@
+# 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
+        # SearchExplain - Retrieve the search query
+        # Submit a search and retrieve an Elasticsearch query
+        #
+        # @param [String] engine_name Name of the engine (*Required*)
+        # @param [Hash] arguments endpoint arguments
+        # @option arguments [Hash] :body (Required: query)
+        # @option body [string] :query
+        # @option body :analytics
+        # @option body :boost
+        # @option body :facets
+        # @option body :filters
+        # @option body :group
+        # @option body :page
+        # @option body :result_fields
+        # @option body :search_fields
+        # @option body :sort
+        # @option arguments [Hash] :headers optional HTTP headers to send with the request
+        #
+        # @see https://www.elastic.co/guide/en/app-search/current/search-explain.html
+        #
+        def search_explain(engine_name, arguments = {})
+          raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name
+          raise ArgumentError, "Required parameter 'body (query)' missing" unless arguments[:body]
+
+          body = arguments.delete(:body) || {}
+          headers = arguments.delete(:headers) || {}
+          request(
+            :post,
+            "api/as/v0/engines/#{engine_name}/search_explain/",
+            arguments,
+            body,
+            headers
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -26,7 +26,7 @@ module Elastic
       # @param [Hash] arguments endpoint arguments
       # @option arguments [Hash] :headers optional HTTP headers to send with the request
       #
-      # @see https://www.elastic.co/guide/en/enterprise-search/current/management-apis.html
+      # @see https://www.elastic.co/guide/en/enterprise-search/current/monitoring-apis.html#monitoring-apis-version-api
       #
       def version(arguments = {})
         headers = arguments.delete(:headers) || {}

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

@@ -58,6 +58,8 @@ 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 [Boolean] :trace Use the default tracer (disabled by default)
+      # @option arguments [Object] :tracer 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)
@@ -77,7 +79,9 @@ module Elastic
             transport_options: {
               request: { open_timeout: open_timeout }
             },
-            enable_meta_header: @options[:enable_meta_header] || true
+            enable_meta_header: @options[:enable_meta_header] || true,
+            trace: trace,
+            tracer: tracer
           )
       end
 
@@ -109,6 +113,14 @@ module Elastic
         @options[:adapter]
       end
 
+      def tracer
+        @options[:tracer]
+      end
+
+      def trace
+        @options[:trace]
+      end
+
       def host
         return DEFAULT_HOST unless @options[:host]
 

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

@@ -19,6 +19,6 @@
 
 module Elastic
   module EnterpriseSearch
-    VERSION = '8.1.0'
+    VERSION = '8.2.1'
   end
 end

data/lib/elastic/workplace-search/workplace_search.rb

@@ -27,12 +27,17 @@ module Elastic
         include Elastic::EnterpriseSearch::WorkplaceSearch::Actions
         include Elastic::EnterpriseSearch::Utils
 
+        attr_accessor :kibana_url
+
         # Create a new Elastic::EnterpriseSearch::WorkplaceSearch::Client client
         #
         # @param options [Hash] a hash of configuration options
         # @option options [String] :access_token the access token for workplace search
         # @option options [String] :endpoint the endpoint Workplace Search
+        # @option options [String] :kibana_url The base URL of your Kibana instance
+        #
         def initialize(options = {})
+          @kibana_url = options[:kibana_url]
           super(options)
         end
 
@@ -45,9 +50,11 @@ module Elastic
         end
 
         def authorization_url(client_id, redirect_uri)
+          raise ArgumentError, 'kibana_url The base URL of your Kibana instance must be set in the client' unless kibana_url
+
           [
-            host,
-            '/ws/oauth/authorize?',
+            kibana_url,
+            '/app/enterprise_search/workplace_search/p/oauth/authorize?',
             'response_type=code&',
             "client_id=#{client_id}&",
             "redirect_uri=#{CGI.escape(redirect_uri)}"

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

@@ -0,0 +1,63 @@
+# 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 'Elasticsearch Search' do
+    let(:engine_name) { 'elasticsearch-books' }
+    let(:documents) do
+      [
+        { title: 'Beasts Before Us', author: 'Elsa Panciroli' },
+        { title: 'The Rise and Fall of the Dinosaurs', author: 'Steve Brusatte' },
+        { title: 'Raptor Red', author: 'Robert T. Bakker' },
+        { title: 'The Earth: A biography of life', author: 'Dr. Elsa Panciroli' }
+      ]
+    end
+    let(:api_key_name) { 'my-api-key' }
+
+    before do
+      # Use API Key in client, save a backup to restore original auth:
+      @old_client = @client.dup
+      api_key_body = { name: api_key_name, type: 'private', read: true, write: true, access_all_engines: true }
+      response = client.create_api_key(body: api_key_body)
+      @client.http_auth = response.body['key']
+      create_engine(engine_name)
+      client.index_documents(engine_name, documents: documents)
+      sleep 1
+    end
+
+    after do
+      # Restore original client:
+      @client = @old_client
+      delete_engines
+      client.delete_api_key(api_key_name: api_key_name)
+    end
+
+    it 'performs an ES search' do
+      es_request = { body: { query: { bool: { must: { term: { author: 'panciroli' } } } } } }
+      response = client.search_es_search(engine_name, body: { request: es_request })
+      expect(response.status).to eq 200
+      expect(response.body['hits']['hits'].count).to eq 2
+      expect do
+        response.body['hits']['hits'].map { |a| a['_source']['author'] } == ['Elsa Panciroli', 'Dr. Elsa Panciroli']
+      end
+    end
+  end
+end

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

@@ -0,0 +1,59 @@
+# 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 'Elasticsearch Search' do
+    let(:engine_name) { 'app-search-explain' }
+    let(:documents) do
+      [
+        { title: 'Beasts Before Us', author: 'Elsa Panciroli' },
+        { title: 'The Rise and Fall of the Dinosaurs', author: 'Steve Brusatte' },
+        { title: 'Raptor Red', author: 'Robert T. Bakker' },
+        { title: 'The Earth: A biography of life', author: 'Dr. Elsa Panciroli' }
+      ]
+    end
+    let(:api_key_name) { 'my-api-key' }
+
+    before do
+      # Use API Key in client, save a backup to restore original auth:
+      @old_client = @client.dup
+      api_key_body = { name: api_key_name, type: 'private', read: true, write: true, access_all_engines: true }
+      response = client.create_api_key(body: api_key_body)
+      @client.http_auth = response.body['key']
+      create_engine(engine_name)
+      client.index_documents(engine_name, documents: documents)
+      sleep 1
+    end
+
+    after do
+      # Restore original client:
+      @client = @old_client
+      delete_engines
+      client.delete_api_key(api_key_name: api_key_name)
+    end
+
+    it 'explains a Search query' do
+      response = client.search_explain(engine_name, body: { query: 'Raptor Red' })
+      expect(response.status).to eq 200
+      expect(response.body['query_string']).to eq 'GET enterprise-search-engine-app-search-explain/_search'
+    end
+  end
+end

data/spec/workplace-search/client_spec.rb

@@ -91,10 +91,18 @@ describe Elastic::EnterpriseSearch::WorkplaceSearch::Client do
   context 'OAuth' do
     let(:client) { Elastic::EnterpriseSearch::WorkplaceSearch::Client.new(host: host) }
 
-    it 'generates an authorization url' do
-      authorization_url = 'http://localhost:3002/ws/oauth/authorize?response_type=code&client_id=client_id&redirect_uri=https%3A%2F%2Flocalhost%3A3002'
+    it 'generates an authorization url when kibana url has been set' do
+      client.kibana_url = 'http://localhost:5601'
+      authorization_url = "#{client.kibana_url}/app/enterprise_search/workplace_search/p/oauth/authorize?" \
+                          'response_type=code&client_id=client_id&redirect_uri=https%3A%2F%2Flocalhost%3A3002'
       expect(client.authorization_url('client_id', 'https://localhost:3002')).to eq authorization_url
     end
+
+    it 'raises an error when kibana url is not set' do
+      expect do
+        client.authorization_url('client_id', 'https://localhost:3002')
+      end.to raise_exception(ArgumentError)
+    end
   end
 
   context 'adapters' do

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: elastic-enterprise-search
 version: !ruby/object:Gem::Version
-  version: 8.1.0
+  version: 8.2.1
 platform: ruby
 authors:
 - Fernando Briano
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-05-11 00:00:00.000000000 Z
+date: 2022-05-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: elastic-transport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 8.0.0.pre.1
+        version: '8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 8.0.0.pre.1
+        version: '8'
 - !ruby/object:Gem::Dependency
   name: jwt
   requirement: !ruby/object:Gem::Requirement
@@ -164,8 +164,8 @@ files:
 - ".ci/functions/imports.sh"
 - ".ci/functions/wait-for-container.sh"
 - ".ci/jobs/defaults.yml"
-- ".ci/jobs/elastic+enterprise-search-ruby+7.15.yml"
-- ".ci/jobs/elastic+enterprise-search-ruby+7.16.yml"
+- ".ci/jobs/elastic+enterprise-search-ruby+7.17.yml"
+- ".ci/jobs/elastic+enterprise-search-ruby+8.0.yml"
 - ".ci/jobs/elastic+enterprise-search-ruby+main.yml"
 - ".ci/jobs/elastic+enterprise-search-ruby+pull-request.yml"
 - ".ci/make.sh"
@@ -207,6 +207,7 @@ files:
 - docs/guide/release_notes/717.asciidoc
 - docs/guide/release_notes/80.asciidoc
 - docs/guide/release_notes/81.asciidoc
+- docs/guide/release_notes/82.asciidoc
 - docs/guide/release_notes/index.asciidoc
 - docs/guide/workplace-search-api.asciidoc
 - elastic-enterprise-search.gemspec
@@ -290,6 +291,8 @@ files:
 - lib/elastic/app-search/api/reset_search_settings.rb
 - lib/elastic/app-search/api/schema.rb
 - lib/elastic/app-search/api/search.rb
+- lib/elastic/app-search/api/search_es_search.rb
+- lib/elastic/app-search/api/search_explain.rb
 - lib/elastic/app-search/api/search_settings.rb
 - lib/elastic/app-search/api/synonym_set.rb
 - lib/elastic/app-search/api/top_clicks_analytics.rb
@@ -366,7 +369,9 @@ files:
 - spec/integration/app-search/crawler_user_agent_spec.rb
 - spec/integration/app-search/curations_spec.rb
 - spec/integration/app-search/documents_spec.rb
+- spec/integration/app-search/elasticsearch_search_spec.rb
 - spec/integration/app-search/engines_spec.rb
+- spec/integration/app-search/explain_search_spec.rb
 - spec/integration/app-search/log_clickthrough_spec.rb
 - spec/integration/app-search/meta_engines_spec.rb
 - spec/integration/app-search/query_suggestion_spec.rb
@@ -414,7 +419,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.3
+rubygems_version: 3.3.7
 signing_key: 
 specification_version: 4
 summary: Official API client for Elastic Enterprise Search