elastic-enterprise-search 8.2.0 → 8.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5beefad27301e777c767b0759b154f6e0bba47db65e0e02cacd206f4ff2c2696
-  data.tar.gz: 86610a1a51529bf54c454e93f2977a1968887e3737e1bfd2ef058b255a1b1975
+  metadata.gz: 29385166cdc5e9a328cf67da13cab2a4aa66a99319cea68f18589dffe02aa10f
+  data.tar.gz: '08f62bbcfd1b0b86f75642410aeb6b13a6af5e2342d6570a1ff503fc204d0db3'
 SHA512:
-  metadata.gz: f0e0e3f3bcf5994ea89f6dc399527c1a02b5b2699ed3af62fedf9d7bf62b32d2c475b104988190b7be5f1d1368ed73241f53392c6934663a76425648bfadf5f7
-  data.tar.gz: 691d3a79357db4880f777fd4a6975c9a434ade303037d7a94523d82e67266c553d7fded40e7f883b6e283d438b7a66d8d8dce7a72a48c4387c65b746c359aa4b
+  metadata.gz: 19cad7d9137c49c057702b95628eab683f0e5797e56245569e92b36edaf4824e26ebeeb40793f97b634e037b948e6e69df3d1217a9e8affe52dd1a1596282c2d
+  data.tar.gz: ab239465521ca6f25d5e4ca3e32e8f74bab95420123a32ae73e8bcecd29a3f23765b30fa6dbd7ab0c3c4d485e95d6923f3442c0d555a5f684fb8413ae962ec3a

data/.ci/Dockerfile

@@ -1,12 +1,25 @@
 ARG RUBY_VERSION=2.7
 FROM ruby:${RUBY_VERSION}
 
+# Default UID/GID to 1000
+# it can be overridden at build time
+ARG BUILDER_UID=1000
+ARG BUILDER_GID=1000
+ENV BUILDER_USER elastic
+ENV BUILDER_GROUP elastic
+
 ENV GEM_HOME="/usr/local/bundle"
 ENV PATH $GEM_HOME/bin:$GEM_HOME/gems/bin:$PATH
 ENV QUIET=true
 ENV CI=true
 
+# Create user
+RUN groupadd --system -g ${BUILDER_GID} ${BUILDER_GROUP} \
+    && useradd --system --shell /bin/bash -u ${BUILDER_UID} -g ${BUILDER_GROUP} -d /var/lib/elastic -m elastic 1>/dev/null 2>/dev/null \
+    && mkdir -p /code/enterprise-search-ruby && touch /Gemfile.lock \
+    && chown -R ${BUILDER_USER}:${BUILDER_GROUP} /code/enterprise-search-ruby /Gemfile.lock
+
 WORKDIR /code/enterprise-search-ruby
 
-COPY . .
+COPY --chown=$BUILDER_USER:$BUILDER_GROUP . .
 RUN bundle install

data/.ci/jobs/elastic+enterprise-search-ruby+8.1.yml

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

data/.ci/jobs/elastic+enterprise-search-ruby+8.2.yml

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

data/.ci/jobs/elastic+enterprise-search-ruby+8.3.yml

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

data/.ci/make.sh

@@ -113,6 +113,7 @@ esac
 echo -e "\033[34;1mINFO: building $product container\033[0m"
 
 docker build --file .ci/Dockerfile --tag ${product} \
+  --build-arg BUILDER_UID="$(id -u)" \
   --build-arg USER_ID="$(id -u)" \
   --build-arg GROUP_ID="$(id -g)" .
 
@@ -128,10 +129,11 @@ args_string="${TASK_ARGS[*]}"
 args_string="${args_string// /,}"
 
 docker run \
+       -u "$(id -u)" \
        --env "RUBY_TEST_VERSION=${RUBY_TEST_VERSION}" \
        --name test-runner \
        --volume $REPO_BINDING \
-       --volume $repo:/usr/src/app \
+       --volume $repo:/code/enterprise-search-ruby \
        --rm \
        $product \
        bundle exec rake unified_release:"$TASK"["$args_string"]

data/.ci/test-matrix.yml

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

data/README.md

@@ -34,7 +34,7 @@ If an adapter is not specified, the client will try to auto-detect available lib
 
 [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.
 
-See code examples of usage for the [Enteprise 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.
+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
 

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

@@ -338,12 +338,13 @@ client.refresh_adaptive_relevance_update_process(engine_name, adaptive_relevance
 
 === Elasticsearch Search
 
-Utilize the API to passthrough and execute raw Elasticsearch queries against the indices that power Enterprise Search engines.
+Submit an Elasticsearch search request to the document indices that power an App Search engine and retrieve the results. You can use this API with regular engines and meta engines. See https://www.elastic.co/guide/en/app-search/current/elasticsearch-search-api-reference.html[Elasticsearch search API for App Search] for more information and requirements for using this API.
+
 
 [source,rb]
 ----------------------------
-es_request = { body: { query: { bool: { must: { term: { title: 'test' } } } } } }
-client.search_es_search(engine_name, body: { request: es_request })
+es_request = { query: { bool: { must: { term: { title: 'test' } } } } }
+client.search_es_search(engine_name, body: es_request)
 ----------------------------
 
 === Search Explain

data/docs/guide/connecting.asciidoc

@@ -1,13 +1,13 @@
 [[connecting]]
 == Connecting
 
-
 This page contains the information you need to connect and use the Client with Elastic Enterprise Search.
 
 **On this page**
 
 * <<authentication>>
 * <<custom_headers>>
+* <<transport>>
 
 
 [discrete]
@@ -169,3 +169,16 @@ workplace_search_client.index_documents(
   { body: documents, headers: headers }
 )
 ----------------------------
+
+[discrete]
+[[transport]]
+=== Transport
+
+The Enterprise Search Ruby client is powered by the https://github.com/elastic/elastic-transport-ruby/[`elastic-transport`] gem. You can read more about it https://www.elastic.co/guide/en/elasticsearch/client/ruby-api/current/transport.html[here]. The client accepts a transport object as an initializer:
+
+[source,rb]
+----------------------------
+transport = Elastic::Transport::Transport::HTTP::Curb.new
+ent_client = Elastic::EnterpriseSearch::Client.new(transport: transport)
+----------------------------
+

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

@@ -3,6 +3,8 @@
 
 === Health API
 
+Get information on the health of a deployment and basic statistics around resource usage.
+
 [source,rb]
 ----------------------------
 > response = ent_client.health
@@ -17,6 +19,8 @@
 
 === Version API
 
+Get version information for the server.
+
 [source,rb]
 ----------------------------
 > response = ent_client.version
@@ -29,14 +33,16 @@
 [source,rb]
 ----------------------------
 # Set read-only flag state
-ent_client.put_read_only(body: { enabled: false })
+> ent_client.put_read_only(body: { enabled: false })
 
 # Get read-only flag state
-ent_client.read_only
+> ent_client.read_only
 ----------------------------
 
 === Stats API
 
+Get information about the resource usage of the application, the state of different internal queues, etc.
+
 [source,rb]
 ----------------------------
 > ent_client.stats.body
@@ -44,3 +50,12 @@ ent_client.read_only
      "queues"=>{"connectors"=>{...}, "document_destroyer"=>{...}, "engine_destroyer"=>{...}, "index_adder"=>{...}, ...},
      "connectors"=>{"alive"=>true, "pool"=>{...}, "job_store"=>{...}}}}
 ----------------------------
+
+=== Search Engines
+
+Retrieve information about search engines
+
+[source,rb]
+----------------------------
+> ent_client.search_engines
+----------------------------

data/docs/guide/index.asciidoc

@@ -1,4 +1,4 @@
-= enterprise-search-ruby
+= Enterprise Search Ruby client
 
 :doctype: book
 

data/docs/guide/installation.asciidoc

@@ -5,7 +5,7 @@ You can install Enterprise Search Client from Rubygems:
 
 [source,sh]
 ---------------------------------------------------
-$ gem install elastic-enterprise-search --pre
+$ gem install elastic-enterprise-search
 ---------------------------------------------------
 
 Or add it to your project's Gemfile:
@@ -15,4 +15,4 @@ Or add it to your project's Gemfile:
 gem 'elastic-enterprise-search'
 ---------------------------------------------------
 
-The version follows the Elastic Stack version so 7.10.0 is compatible with Enterprise Search released in Elastic Stack 7.10.0.
+The version follows the Elastic Stack version so 7.10.0 is compatible with Enterprise Search released in Elastic Stack 7.10.0, 8.1.0 is compatible with Enterprise Search released in Elastic Stack 8.1.0, and so on.

data/docs/guide/overview.asciidoc

@@ -10,11 +10,14 @@ Current development happens in the main branch.
 
 The library is compatible with all Elastic Enterprise Search versions since `7.x` but you **have to use a matching major version**:
 
-For **Elastic Enterprise Search 7.0** and later, use the major version 7 (`7.x.y`) of the library.
+* For **Elastic Enterprise Search 7.0** and later, use the major version 7 (`7.x.y`) of the library.
+* For **Elastic Enterprise Search 8.0** and later, use the major version 8 (`8.x.y`) of the library.
+
 
 [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:
+
+This library uses https://github.com/elastic/elastic-transport-ruby[elastic-transport], the low-level Ruby client for connecting to an Elastic cluster - 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]
 ---------------------------------------------------
@@ -26,7 +29,7 @@ client = Elastic::EnterpriseSearch::Client.new(adapter: :net_http_persistent)
 
 All requests, if successful, will return an `Elastic::Transport::Transport::Response` instance. You can access the response `body`, `headers` and `status`.
 
-`elastic-transport` defines a https://github.com/elastic/elastic-transport-ruby/blob/main/lib/elastic/transport/transport/errors.rb[number of exception classes] for various client and server errors, as well as unsuccessful HTTP responses, making it possible to rescue specific exceptions with desired granularity. More details https://github.com/elastic/elastic-transport-ruby#exception-handling[here]. You can find the full documentation for `elastic-transport` at https://rubydoc.info/gems/elastic-transport[RubyDoc].
+`elastic-transport` defines a https://github.com/elastic/elastic-transport-ruby/blob/main/lib/elastic/transport/transport/errors.rb[number of exception classes] for various client and server errors, as well as unsuccessful HTTP responses, making it possible to rescue specific exceptions with desired granularity. More details https://github.com/elastic/elastic-transport-ruby#exception-handling[here]. You can find the full documentation for `elastic-transport` at https://www.elastic.co/guide/en/elasticsearch/client/ruby-api/current/transport.html[our official documentation] and  https://rubydoc.info/gems/elastic-transport[RubyDoc].
 
 The clients pass different options to transport, you can check them out https://rubydoc.info/github/elastic/enterprise-search-ruby/Elastic/EnterpriseSearch/Client[on RubyDocs].
 
@@ -38,7 +41,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. You can also pass in a Logger object with the `:logger` parameter, any confoming logger implementation will work:
 
 [source,rb]
 ----------------------------
@@ -46,6 +49,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

@@ -1,4 +1,15 @@
 [[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]

data/docs/guide/release_notes/83.asciidoc

@@ -0,0 +1,14 @@
+[[release_notes_83]]
+=== 8.3 Release notes
+
+[discrete]
+[[release_notes_830]]
+=== 8.3.0 Release notes
+
+- Tested versions of Ruby for 8.3.0: Ruby (MRI) 2.7, 3.0 and 3.1, JRuby 9.3.
+- General small improvements in documentation.
+- Updated for compatibility with Elastic Enterprise Search 8.3's API.
+
+[discrete]
+==== Enterprise Search
+New API: `search_engines` - Retrieve information about search engines

data/docs/guide/release_notes/84.asciidoc

@@ -0,0 +1,36 @@
+[[release_notes_84]]
+=== 8.4 Release notes
+
+[discrete]
+[[release_notes_840]]
+=== 8.4.0 Release notes
+
+- Tested versions of Ruby for 8.4.0: Ruby (MRI) 2.7, 3.0 and 3.1, JRuby 9.3.
+- Updated for compatibility with Elastic Enterprise Search 8.4's API.
+- Fixed client name String in meta header
+
+==== Changes to Elasticsearch Search in App Search
+
+[CAUTION]
+====
+The Elasticsearch search API for App Search is a beta feature. Beta features are subject to change and are not covered by the support SLA of generally available (GA) features. Elastic plans to promote this feature to GA in a future release.
+====
+
+The Elasticsearch Search API `search_es_search` has been updated to be more consistent with the Elasticsearch `_search` API.
+
+In the previous version, a `request` object was required in the request:
+
+[source,rb]
+----------------------------
+# DEPRECATED - This worked for 8.3 but has been updated in 8.4:
+es_request = { body: { query: { bool: { must: { term: { title: 'test' } } } } } }
+client.search_es_search(engine_name, body: { request: es_request })
+----------------------------
+
+This has been simplified to:
+
+[source,rb]
+----------------------------
+es_request = { query: { bool: { must: { term: { title: 'test' } } } } }
+client.search_es_search(engine_name, body: es_request)
+----------------------------

data/docs/guide/release_notes/index.asciidoc

@@ -4,6 +4,8 @@
 [discrete]
 === 8.x
 
+* <<release_notes_84, 8.4.0 Release Notes>>
+* <<release_notes_83, 8.3.0 Release Notes>>
 * <<release_notes_82, 8.2.0 Release Notes>>
 * <<release_notes_81, 8.1.0 Release Notes>>
 * <<release_notes_80, 8.0.0 Release Notes>>
@@ -20,6 +22,8 @@
 * <<release_notes_711, 7.11.0 Release Notes>>
 * <<release_notes_710, 7.10.0.beta.1 Release Notes>>
 
+include::84.asciidoc[]
+include::83.asciidoc[]
 include::82.asciidoc[]
 include::81.asciidoc[]
 include::80.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.3'
+  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/multi_search.rb

@@ -21,22 +21,23 @@ module Elastic
   module EnterpriseSearch
     module AppSearch
       module Actions
-        # Search - Run several search in the same request
+        # MultiSearch - Submit a multi search
+        # Submit a multi search query and receive a set of results with meta data
         #
-        # @param engine_name [String]  (*Required*)
-        # @param arguments [Hash] endpoint arguments
-        # @option arguments [Object] :body One or more queries to execute in parallel (*Required*)
+        # @param [String] engine_name Name of the engine (*Required*)
+        # @param [Hash] arguments endpoint arguments
+        # @option arguments [Hash] :body (Required: queries)
+        # @option body :queries
         # @option arguments [Hash] :headers optional HTTP headers to send with the request
         #
         # @see https://www.elastic.co/guide/en/app-search/current/multi-search.html
         #
         def multi_search(engine_name, arguments = {})
           raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name
-          raise ArgumentError, "Required parameter 'body' missing" unless arguments[:body]
+          raise ArgumentError, "Required parameter 'body (queries)' missing" unless arguments[:body]
 
           body = arguments.delete(:body) || {}
           headers = arguments.delete(:headers) || {}
-
           request(
             :post,
             "api/as/v1/engines/#{engine_name}/multi_search/",

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

@@ -26,16 +26,15 @@ module Elastic
         #
         # @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] :body Query parameters to be passed to Elasticsearch _search API
         # @option arguments [Hash] :headers optional HTTP headers to send with the request
+        # @option headers [String] :X-Enterprise-Search-Analytics The search query associated with this request when recording search analytics
+        # @option headers [String] :X-Enterprise-Search-Analytics-Tags Analytics tags to be applied with this search 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) || {}

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

@@ -0,0 +1,43 @@
+# 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 Actions
+      # SearchEngines - Retrieve information about search engines
+      # Retrieve information about search engines
+      #
+      # @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/search-engines-apis.html
+      #
+      def search_engines(arguments = {})
+        headers = arguments.delete(:headers) || {}
+        request(
+          :get,
+          'api/search_engines/',
+          arguments,
+          nil,
+          headers
+        )
+      end
+    end
+  end
+end

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/request.rb

@@ -25,7 +25,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 = '8.2.0'
+    VERSION = '8.4.0'
   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/rake_tasks/unified_release_tasks.rake

@@ -17,6 +17,7 @@
 
 # frozen_string_literal: true
 
+# rubocop:disable Metrics/BlockLength
 namespace :unified_release do
   desc <<-DESC
   Update Rubygems versions in version.rb and *.gemspec files
@@ -43,4 +44,24 @@ namespace :unified_release do
   rescue StandardError => e
     abort "[!!!] #{e.class} : #{e.message}"
   end
+
+  desc 'Update Stack Versions in test matrices (.github/workflows and .ci/test-matrix.yml)'
+  task :update_matrices, :version do |_, args|
+    @version = args[:version]
+    error = 'Error: version must be passed in and needs to be a version format: 9.1.0, 8.7.15.'
+    raise ArgumentError, error unless @version&.match?(/[0-9.]/)
+
+    # Replace in test-matrix.yml
+    file = File.expand_path('./.ci/test-matrix.yml')
+    regex = /(STACK_VERSION:\s+- )([0-9.]+(-SNAPSHOT)?)/
+    replace_version(regex, file)
+  end
+
+  def replace_version(regex, file)
+    content = File.read(file)
+    match = content.match(regex)
+    content = content.gsub(regex, "#{match[1]}#{@version}")
+    File.open(file, 'w') { |f| f.puts content }
+  end
 end
+# rubocop:enable Metrics/BlockLength

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/elasticsearch_search_spec.rb

@@ -51,12 +51,26 @@ describe Elastic::EnterpriseSearch::AppSearch::Client do
     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 })
+      es_request = { query: { bool: { must: { term: { author: 'panciroli' } } } } }
+      response = client.search_es_search(engine_name, body: 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']
+        response.body['hits']['hits'].map do |a|
+          a['_source']['author']
+        end == ['Elsa Panciroli', 'Dr. Elsa Panciroli']
+      end
+    end
+
+    it 'performs an ES search with query parameters' do
+      es_request = { query: { bool: { must: { term: { author: 'panciroli' } } } } }
+      response = client.search_es_search(engine_name, body: es_request, sort: "{ 'author': 'desc' }")
+      expect(response.status).to eq 200
+      expect(response.body['hits']['hits'].count).to eq 2
+      expect do
+        response.body['hits']['hits'].map do |a|
+          a['_source']['author']
+        end == ['Dr. Elsa Panciroli', 'Elsa Panciroli']
       end
     end
   end

data/spec/integration/enterprise_search_api_spec.rb

@@ -97,4 +97,15 @@ describe Elastic::EnterpriseSearch::Client do
       end
     end
   end
+
+  context 'unversioned API' do
+    context 'search_engines' do
+      it 'makes GET request' do
+        response = client.search_engines
+
+        expect(response.status).to eq 200
+        expect(response.body['results'])
+      end
+    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.2.0
+  version: 8.4.0
 platform: ruby
 authors:
 - Fernando Briano
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-05-11 00:00:00.000000000 Z
+date: 2022-08-24 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.3
+        version: '8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 8.0.0.pre.3
+        version: '8'
 - !ruby/object:Gem::Dependency
   name: jwt
   requirement: !ruby/object:Gem::Requirement
@@ -166,6 +166,9 @@ files:
 - ".ci/jobs/defaults.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+8.1.yml"
+- ".ci/jobs/elastic+enterprise-search-ruby+8.2.yml"
+- ".ci/jobs/elastic+enterprise-search-ruby+8.3.yml"
 - ".ci/jobs/elastic+enterprise-search-ruby+main.yml"
 - ".ci/jobs/elastic+enterprise-search-ruby+pull-request.yml"
 - ".ci/make.sh"
@@ -208,6 +211,8 @@ files:
 - docs/guide/release_notes/80.asciidoc
 - docs/guide/release_notes/81.asciidoc
 - docs/guide/release_notes/82.asciidoc
+- docs/guide/release_notes/83.asciidoc
+- docs/guide/release_notes/84.asciidoc
 - docs/guide/release_notes/index.asciidoc
 - docs/guide/workplace-search-api.asciidoc
 - elastic-enterprise-search.gemspec
@@ -301,6 +306,7 @@ files:
 - lib/elastic/enterprise-search/api/health.rb
 - lib/elastic/enterprise-search/api/put_read_only.rb
 - lib/elastic/enterprise-search/api/read_only.rb
+- lib/elastic/enterprise-search/api/search_engines.rb
 - lib/elastic/enterprise-search/api/stats.rb
 - lib/elastic/enterprise-search/api/version.rb
 - lib/elastic/enterprise-search/client.rb
@@ -419,7 +425,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