elastic-enterprise-search 8.4.0 → 8.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 29385166cdc5e9a328cf67da13cab2a4aa66a99319cea68f18589dffe02aa10f
-  data.tar.gz: '08f62bbcfd1b0b86f75642410aeb6b13a6af5e2342d6570a1ff503fc204d0db3'
+  metadata.gz: 370baa568c7b78d3fa58a0c322732c106163b3f91845841287b968966ca70717
+  data.tar.gz: 76108e767bc9e72f6ca6c981629f69a8c9e99106b07dc460761aaf089be4c86a
 SHA512:
-  metadata.gz: 19cad7d9137c49c057702b95628eab683f0e5797e56245569e92b36edaf4824e26ebeeb40793f97b634e037b948e6e69df3d1217a9e8affe52dd1a1596282c2d
-  data.tar.gz: ab239465521ca6f25d5e4ca3e32e8f74bab95420123a32ae73e8bcecd29a3f23765b30fa6dbd7ab0c3c4d485e95d6923f3442c0d555a5f684fb8413ae962ec3a
+  metadata.gz: 17ebc4758f08ae8a5e198d02fa45016525f080d8cc357b9a3b5ad82b2b208c89e5534e05f61e784cccc4ab4b9d30c79e6737845f52cd25bc1741ceff95bc893e
+  data.tar.gz: 0252bf54a1828983f1a8daac3ae4fb123a814aaa4f9d195df7284cea265542cb370242c71dd5fb9c2832f81650e5b17f3b58da8ae585fc08e5e7aff03881b7a3

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

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

data/.ci/test-matrix.yml

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

data/.github/workflows/rubocop.yml

@@ -11,5 +11,5 @@ jobs:
         ruby-version: 2.7
     - name: Run Rubocop
       run: |
-        bundle install
-        bundle exec rubocop
+        gem install rubocop
+        rubocop

data/.github/workflows/testing.yml

@@ -16,6 +16,8 @@ jobs:
         ruby-version: ${{ matrix.ruby }}
     - name: Build and test with Rake
       run: |
+        sudo apt-get update
+        sudo apt-get install libcurl4-openssl-dev
         ruby -v
         bundle install
         bundle exec rake spec:client

data/docs/guide/release_notes/85.asciidoc

@@ -0,0 +1,40 @@
+[[release_notes_85]]
+=== 8.5 Release notes
+
+[discrete]
+[[release_notes_850]]
+=== 8.5.0 Release notes
+
+==== Client
+- Updates dependency on `elastic-transport`.  With the latest release of `elastic-transport` - `v8.1.0` - this gem now supports Faraday v2. When you upgrade your gems, `8.1.0` will be installed. This supports both Faraday v1 and Faraday v2. The main change on dependencies when using Faraday v2 is all adapters, except for the default `net_http` one, have been moved out of Faraday into separate gems. This means if you're not using the default adapter and you migrate to Faraday v2, you'll need to add the adapter gems to your Gemfile.
+
+These are the gems required for the different adapters with Faraday 2, instead of the libraries on which they were based:
+
+[source,rb]
+----------------------------
+# HTTPCLient
+gem 'faraday-httpclient'
+# NetHTTPPersistent
+gem 'faraday-net_http_persistent'
+# Patron
+gem 'faraday-patron'
+# Typhoeus
+gem 'faraday-typhoeus'
+----------------------------
+
+Things should work fine if you migrate to Faraday 2 as long as you include the adapter (unless you're using the default one `net-http`), but worst case scenario, you can always lock the version of Faraday in your project to 1.x:
+`gem 'faraday', '~> 1'`
+
+*Troubleshooting*
+
+If you see a message like:
+`:adapter is not registered on Faraday::Adapter (Faraday::Error)`
+Then you probably need to include the adapter library in your gemfile and require it.
+
+Please https://github.com/elastic/enterprise-search-ruby/issues[submit an issue] if you encounter any problems.
+
+[discrete]
+==== App Search
+
+- Adds `precision_enabled` (Boolean) to `put_search_settings`. See https://www.elastic.co/guide/en/app-search/current/search-settings.html#search-settings-update[here] for more information.
+- `search_es_search` and `search_explain` changed the path to `api/as/v1` instead of `v0` and are now GA with version `8.5` of the stack.

data/docs/guide/release_notes/index.asciidoc

@@ -4,6 +4,7 @@
 [discrete]
 === 8.x
 
+* <<release_notes_85, 8.5.0 Release Notes>>
 * <<release_notes_84, 8.4.0 Release Notes>>
 * <<release_notes_83, 8.3.0 Release Notes>>
 * <<release_notes_82, 8.2.0 Release Notes>>
@@ -22,6 +23,7 @@
 * <<release_notes_711, 7.11.0 Release Notes>>
 * <<release_notes_710, 7.10.0.beta.1 Release Notes>>
 
+include::85.asciidoc[]
 include::84.asciidoc[]
 include::83.asciidoc[]
 include::82.asciidoc[]

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'
+  s.add_dependency 'elastic-transport', '~> 8.1'
   s.add_runtime_dependency 'jwt', '>= 1.5', '< 3.0'
   s.add_development_dependency 'awesome_print'
   s.add_development_dependency 'byebug' unless defined?(JRUBY_VERSION)
@@ -56,5 +56,10 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'rubocop', '~> 1'
   s.add_development_dependency 'vcr', '~> 3.0.3'
   s.add_development_dependency 'webmock'
+  # Adapters
+  s.add_development_dependency 'faraday-httpclient'
+  s.add_development_dependency 'faraday-net_http_persistent'
+  s.add_development_dependency 'faraday-patron' unless defined? JRUBY_VERSION
+  s.add_development_dependency 'faraday-typhoeus'
 end
 # rubocop:enable Metrics/BlockLength

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

@@ -31,6 +31,7 @@ module Elastic
         # @option body :search_fields
         # @option body :result_fields
         # @option body [integer] :precision
+        # @option body [boolean] :precision_enabled
         # @option arguments [Hash] :headers optional HTTP headers to send with the request
         #
         # @see https://www.elastic.co/guide/en/app-search/current/search-settings.html#search-settings-update

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

@@ -27,6 +27,7 @@ module Elastic
         # @param [String] engine_name Name of the engine (*Required*)
         # @param [Hash] arguments endpoint arguments
         # @option arguments [Hash] :body Query parameters to be passed to Elasticsearch _search API
+        # @option arguments [Object] :es_search_query_params 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
@@ -40,7 +41,7 @@ module Elastic
           headers = arguments.delete(:headers) || {}
           request(
             :post,
-            "api/as/v0/engines/#{engine_name}/elasticsearch/_search/",
+            "api/as/v1/engines/#{engine_name}/elasticsearch/_search/",
             arguments,
             body,
             headers

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

@@ -49,7 +49,7 @@ module Elastic
           headers = arguments.delete(:headers) || {}
           request(
             :post,
-            "api/as/v0/engines/#{engine_name}/search_explain/",
+            "api/as/v1/engines/#{engine_name}/search_explain/",
             arguments,
             body,
             headers

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

@@ -19,6 +19,6 @@
 
 module Elastic
   module EnterpriseSearch
-    VERSION = '8.4.0'
+    VERSION = '8.5.0'
   end
 end

data/spec/app-search/client_spec.rb

@@ -86,32 +86,5 @@ describe Elastic::EnterpriseSearch::AppSearch::Client do
     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
+  include_examples 'adapters compatibility'
 end

data/spec/enterprise-search/client_spec.rb

@@ -104,32 +104,5 @@ describe Elastic::EnterpriseSearch::Client do
     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
+  include_examples 'adapters compatibility'
 end

data/spec/spec_helper.rb

@@ -39,3 +39,37 @@ RSpec.configure do |config|
     c.allow_http_connections_when_no_cassette = true
   end
 end
+
+def is_faraday2?
+  return false unless defined?(Faraday::VERSION)
+
+  Gem::Version.new(Faraday::VERSION) >= Gem::Version.new(2)
+end
+
+def hide_constants
+  hide_const('Faraday::Adapter::Patron')
+  hide_const('Patron')
+  hide_const('Faraday::Adapter::Typhoeus')
+  hide_const('Typhoeus')
+end
+
+shared_examples 'adapters compatibility' do
+  let(:transport_client) { instance_double(Elastic::Transport::Client) }
+  let(:adapter) { client.transport.transport.connections.all.first.connection.builder.adapter }
+  let(:client) { described_class.new }
+
+  context 'default ' do
+    it 'uses default NetHttp Faraday adapter' do
+      hide_constants
+      expect(adapter).to eq Faraday::Adapter::NetHttp
+    end
+  end
+
+  context 'selecting adapter' do
+    it 'uses Typhoeus when specified' do
+      allow(Elastic::Transport::Client).to receive(:new).and_return({})
+      described_class.new(adapter: :typhoeus)
+      expect(Elastic::Transport::Client).to have_received(:new).with(hash_including(adapter: :typhoeus))
+    end
+  end
+end

data/spec/workplace-search/client_spec.rb

@@ -105,32 +105,5 @@ describe Elastic::EnterpriseSearch::WorkplaceSearch::Client do
     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
+  include_examples 'adapters compatibility'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: elastic-enterprise-search
 version: !ruby/object:Gem::Version
-  version: 8.4.0
+  version: 8.5.0
 platform: ruby
 authors:
 - Fernando Briano
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-08-24 00:00:00.000000000 Z
+date: 2022-11-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: elastic-transport
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '8'
+        version: '8.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '8'
+        version: '8.1'
 - !ruby/object:Gem::Dependency
   name: jwt
   requirement: !ruby/object:Gem::Requirement
@@ -142,6 +142,62 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday-httpclient
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday-net_http_persistent
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday-patron
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday-typhoeus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 'Official API client for Elastic Enterprise Search APIs.
 
   '
@@ -165,10 +221,9 @@ files:
 - ".ci/functions/wait-for-container.sh"
 - ".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+8.4.yml"
 - ".ci/jobs/elastic+enterprise-search-ruby+main.yml"
 - ".ci/jobs/elastic+enterprise-search-ruby+pull-request.yml"
 - ".ci/make.sh"
@@ -213,6 +268,7 @@ files:
 - docs/guide/release_notes/82.asciidoc
 - docs/guide/release_notes/83.asciidoc
 - docs/guide/release_notes/84.asciidoc
+- docs/guide/release_notes/85.asciidoc
 - docs/guide/release_notes/index.asciidoc
 - docs/guide/workplace-search-api.asciidoc
 - elastic-enterprise-search.gemspec

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

@@ -1,12 +0,0 @@
----
-- 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.)