elastic-enterprise-search 8.8.0 → 8.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 031cec00d19f25b476ac32ea1074c5f8d1a79ee09e631ee9dc9097e3b53dbf59
-  data.tar.gz: 459bb77b77b89ef66a781adeb1aed5289d21b0399bd0e5bfa5c7405e1a3c6e5f
+  metadata.gz: e1edee1a341d229766cc56217bdc48daba826c38285fac78da19f98c4499f007
+  data.tar.gz: e59f9320edc8874b05b7a42888bc6c8817c4192a9f266bdf5584674c686cb518
 SHA512:
-  metadata.gz: 61e665be5a259b3a1bcafe382c4b54938c3d1f04d458df6037a593b32ff07a18e9d6a2d197cd55467e4d2c28c5cd7685754bba46e8b0be3a84b2827574b568bb
-  data.tar.gz: 6029c93e184f0f0a5e96d02b251b1d9bf40322bad0e677cfaccb8b9475ea246db9e96bf4ccf2c7a6e652bc39aebbc8595cae63c9b243af342d66ec4955a8cdbf
+  metadata.gz: d1a70bed65232c5281f1439cfa460cdbd8c10414c73e522e0570d5a900916b4c3685b578256cbb0929b1f2aae574a14e23815b994918f37eba72ede0030c1639
+  data.tar.gz: e82c1ce74df9f238b3a978291bdf8736d73fc71fa20c028bba039d33b75b01e4c36db676e8d2a5c9177e3e2c0e2f8fe3e73c6b4a72533e0d9c21d49ff4e2f101

data/.buildkite/pipeline.yml

@@ -4,13 +4,14 @@ steps:
       provider: "gcp"
     env:
       RUBY_VERSION: "{{ matrix.ruby }}"
-      STACK_VERSION: 8.8-SNAPSHOT
+      STACK_VERSION: 8.18.0-SNAPSHOT
     matrix:
       setup:
         ruby:
+          - "3.4"
+          - "3.3"
           - "3.2"
           - "3.1"
-          - "3.0"
     command: ./.buildkite/run-tests.sh
     artifact_paths: "tmp/*"
   - wait: ~

data/.buildkite/run-elasticsearch.sh

@@ -29,8 +29,12 @@ set -euo pipefail
 echo -e "\033[34;1mINFO:\033[0m Take down node if called twice with the same arguments (DETACH=true) or on seperate terminals \033[0m"
 cleanup_node $es_node_name
 
-# Set vm.max_map_count kernel setting to 262144
-sudo sysctl -w vm.max_map_count=262144
+BUILDKITE=${BUILDKITE-false}
+
+# Set vm.max_map_count kernel setting to 262144 if we're in CI
+if [[ "$BUILDKITE" == "true" ]]; then
+  sudo sysctl -w vm.max_map_count=262144
+fi
 
 master_node_name=${es_node_name}
 cluster_name=${moniker}${suffix}

data/.buildkite/run-tests.sh

@@ -11,9 +11,6 @@ script_path=$(dirname $(realpath -s $0))
 source $script_path/functions/imports.sh
 set -euo pipefail
 
-echo "--- Create the elastic network"
-docker network create elastic
-
 echo "--- :docker: :elasticsearch: Starting Elasticsearch"
 DETACH=true bash $script_path/run-elasticsearch.sh
 

data/.ci/make.sh

@@ -55,15 +55,6 @@ case $CMD in
         echo -e "\033[32;1mdone.\033[0m"
         exit 0
         ;;
-    assemble)
-        if [ -v $VERSION ]; then
-            echo -e "\033[31;1mTARGET: assemble -> missing version parameter\033[0m"
-            exit 1
-        fi
-        echo -e "\033[36;1mTARGET: assemble artefact $VERSION\033[0m"
-        TASK=assemble
-        TASK_ARGS=("$VERSION" "$output_folder")
-        ;;
     codegen)
         if [ -v $VERSION ]; then
             echo -e "\033[31;1mTARGET: codegen -> missing version parameter\033[0m"
@@ -112,11 +103,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)" .
-
+docker build --file .buildkite/Dockerfile --tag ${product}
 
 # ------------------------------------------------------- #
 # Run the Container
@@ -142,15 +129,6 @@ docker run \
 # Post Command tasks & checks
 # ------------------------------------------------------- #
 
-if [[ "$CMD" == "assemble" ]]; then
-	if compgen -G ".ci/output/*" > /dev/null; then
-		echo -e "\033[32;1mTARGET: successfully assembled client v$VERSION\033[0m"
-	else
-		echo -e "\033[31;1mTARGET: assemble failed, empty workspace!\033[0m"
-		exit 1
-	fi
-fi
-
 if [[ "$CMD" == "codegen" ]]; then
     echo "TODO"
 fi

data/.github/workflows/license.yml

@@ -4,10 +4,10 @@ jobs:
   build:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v4
     - uses: ruby/setup-ruby@v1
       with:
-        ruby-version: 3
+        ruby-version: '3.4'
     - name: Check license headers
       run: |
         ruby ./.github/check_license_headers.rb

data/.github/workflows/rubocop.yml

@@ -5,10 +5,10 @@ jobs:
   rubocop:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v4
     - uses: ruby/setup-ruby@v1
       with:
-        ruby-version: 2.7
+        ruby-version: 3
     - name: Run Rubocop
       run: |
         gem install rubocop

data/.github/workflows/testing.yml

@@ -1,3 +1,4 @@
+---
 name: main
 on: [push, pull_request]
 
@@ -7,10 +8,10 @@ jobs:
       ENDPOINT: http://localhost:8080
     strategy:
       matrix:
-        ruby: [ '3.0', '3.1', '3.2' ]
+        ruby: ['3.1', '3.2', '3.3', '3.4']
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v4
     - uses: ruby/setup-ruby@v1
       with:
         ruby-version: ${{ matrix.ruby }}
@@ -27,10 +28,10 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: [ jruby-9.3, jruby-9.4 ]
+        ruby: ['jruby-9.3', 'jruby-9.4']
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v4
     - uses: ruby/setup-ruby@v1
       with:
         ruby-version: ${{ matrix.ruby }}

data/README.md

@@ -1,8 +1,19 @@
 # Elastic Enterprise Search Client
 
-![build](https://github.com/elastic/enterprise-search-ruby/workflows/main/badge.svg)
 ![rubocop](https://github.com/elastic/enterprise-search-ruby/workflows/rubocop/badge.svg)
 [![Ruby Style Guide](https://img.shields.io/badge/code_style-rubocop-brightgreen.svg)](https://github.com/rubocop-hq/rubocop)
+![build](https://github.com/elastic/enterprise-search-ruby/workflows/main/badge.svg)
+[![Build status](https://badge.buildkite.com/a6c44f2af741c866381fb3c845e8d4b0e9b5c5883ef84ac30e.svg)](https://buildkite.com/elastic/enterprise-search-ruby)
+
+> [!WARNING] **Enterprise Search will be discontinued in 9.0.**
+
+> Starting with Elastic version 9.0, the standalone Enterprise Search products, will no longer be included in our offering. They remain supported in their current form in version 8.x and will only receive security upgrades and fixes. Enterprise Search clients will continue to be supported in their current form throughout 8.x versions, according to our EOL policy: https://www.elastic.co/support/eol
+> We recommend transitioning to our actively developed Elastic Stack (https://www.elastic.co/elastic-stack) tools for your search use cases. However, if you're still using any Enterprise Search products, we recommend using the latest stable release of the clients.
+
+> Here are some useful links with more information:
+> * Enterprise Search FAQ: https://www.elastic.co/resources/enterprise-search/enterprise-search-faq
+> * Migrating to 9.x from Enterprise Search 8.x versions: https://www.elastic.co/guide/en/enterprise-search/current/upgrading-to-9-x.html
+
 
 Official Ruby API client for [Elastic Enterprise Search](https://www.elastic.co/enterprise-search). Use this gem to integrate App Search and Workplace Search into your Ruby code.
 

data/catalog-info.yaml

@@ -0,0 +1,19 @@
+apiVersion: backstage.io/v1alpha1
+kind: Resource
+metadata:
+  name: buildkite-pipeline-enterprise-search-ruby
+spec:
+  implementation:
+    apiVersion: buildkite.elastic.dev/v1
+    kind: Pipeline
+    metadata:
+      description: Enterprise Search Ruby Client
+      name: enterprise-search-ruby
+    spec:
+      repository: elastic/enterprise-search-ruby
+      teams:
+        devtools-team: {}
+        everyone:
+          access_level: READ_ONLY
+  owner: group:devtools-team
+  type: buildkite-pipeline

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

@@ -35,7 +35,7 @@ client.create_engine(body: body)
 # Add a source engine to a meta engine:
 client.add_meta_engine_source(meta_engine_name, source_engines: ['engine1', 'engine2'])
 
-# Remove a source enginge from a meta engine:
+# Remove a source engine from a meta engine:
 client.delete_meta_engine_source(meta_engine_name, source_engines: ['engine1', 'engine2'])
 ----------------------------
 
@@ -72,7 +72,9 @@ client.put_documents(engine_name, documents: [{id: document_id, key: value}])
 ----------------------------
 # Single Search
 query = {
-  query: 'luigi'
+  body: {
+    query: 'luigi'
+  }
 }
 
 client.search(engine_name, query)

data/docs/guide/release_notes/88.asciidoc

@@ -0,0 +1,9 @@
+[[release_notes_88]]
+=== 8.8 Release notes
+
+[discrete]
+[[release_notes_880]]
+=== 8.8.0 Release notes
+
+- Tested versions of Ruby for 8.8.0: Ruby (MRI) 3.0, 3.1 and 3.2, JRuby 9.3 and JRuby 9.4.
+- Updated for compatibility with Elastic Enterprise Search 8.8's API.

data/docs/guide/release_notes/89.asciidoc

@@ -0,0 +1,10 @@
+[[release_notes_89]]
+=== 8.9 Release notes
+
+[discrete]
+[[release_notes_890]]
+=== 8.9.0 Release notes
+
+- Refactored User-Agent code, it is now set up on initializing the client instead of every request.
+- Tested versions of Ruby for 8.9.0: Ruby (MRI) 3.0, 3.1 and 3.2, JRuby 9.3 and JRuby 9.4.
+- Updated for compatibility with Elastic Enterprise Search 8.9's API.

data/docs/guide/release_notes/index.asciidoc

@@ -4,6 +4,8 @@
 [discrete]
 === 8.x
 
+* <<release_notes_89, 8.9.0 Release Notes>>
+* <<release_notes_88, 8.8.0 Release Notes>>
 * <<release_notes_87, 8.7.0 Release Notes>>
 * <<release_notes_86, 8.6.0 Release Notes>>
 * <<release_notes_85, 8.5.0 Release Notes>>
@@ -25,6 +27,8 @@
 * <<release_notes_711, 7.11.0 Release Notes>>
 * <<release_notes_710, 7.10.0.beta.1 Release Notes>>
 
+include::89.asciidoc[]
+include::88.asciidoc[]
 include::87.asciidoc[]
 include::86.asciidoc[]
 include::85.asciidoc[]

data/elastic-enterprise-search.gemspec

@@ -26,7 +26,7 @@ Gem::Specification.new do |s|
   s.name        = 'elastic-enterprise-search'
   s.version     = Elastic::EnterpriseSearch::VERSION
   s.authors     = ['Fernando Briano']
-  s.email       = ['support@elastic.co']
+  s.email       = ['clients-team@elastic.co']
   s.homepage    = 'https://github.com/elastic/enterprise-search-ruby'
   s.summary     = 'Official API client for Elastic Enterprise Search'
   s.description = <<~DESCRIPTION
@@ -53,13 +53,26 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'byebug' unless defined?(JRUBY_VERSION)
   s.add_development_dependency 'rspec', '~> 3.9.0'
   s.add_development_dependency 'rspec_junit_formatter'
-  s.add_development_dependency 'rubocop', '~> 1'
+  s.add_development_dependency 'rubocop', '>= 1.51' unless defined?(JRUBY_VERSION) &&
+                                                           Gem::Version.new(JRUBY_VERSION) < Gem::Version.new('9.4')
   s.add_development_dependency 'vcr'
-  s.add_development_dependency 'webmock'
+  s.add_development_dependency 'webmock', '>= 3.23.1'
   # 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'
+
+  s.post_install_message = <<~MESSAGE
+
+    Warning: Starting with Elastic version 9.0, the standalone Enterprise Search products, will no longer be included in our offering. They remain supported in their current form in version 8.x and will only receive security upgrades and fixes.
+    Enterprise Search clients will continue to be supported in their current form throughout 8.x versions, according to our EOL policy: https://www.elastic.co/support/eol
+    We recommend transitioning to our actively developed Elastic Stack (https://www.elastic.co/elastic-stack) tools for your search use cases. However, if you're still using any Enterprise Search products, we recommend using the latest stable release of the clients.
+
+    Here are some useful links with more information:
+    * Enterprise Search FAQ: https://www.elastic.co/resources/enterprise-search/enterprise-search-faq
+    * Migrating to 9.x from Enterprise Search 8.x versions: https://www.elastic.co/guide/en/enterprise-search/current/upgrading-to-9-x.html
+
+  MESSAGE
 end
 # rubocop:enable Metrics/BlockLength

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

@@ -77,7 +77,8 @@ module Elastic
             request_timeout: overall_timeout,
             adapter: adapter,
             transport_options: {
-              request: { open_timeout: open_timeout }
+              request: { open_timeout: open_timeout },
+              headers: { user_agent: user_agent }
             },
             enable_meta_header: @options[:enable_meta_header] || true,
             trace: trace,
@@ -128,6 +129,19 @@ module Elastic
 
         @options[:host]
       end
+
+      private
+
+      def user_agent
+        ua = "#{CLIENT_NAME}/#{CLIENT_VERSION}"
+        meta = ["RUBY_VERSION: #{RUBY_VERSION}"]
+        if RbConfig::CONFIG && RbConfig::CONFIG['host_os']
+          meta << "#{RbConfig::CONFIG['host_os'].split('_').first[/[a-z]+/i].downcase} " \
+                  "#{RbConfig::CONFIG['target_cpu']}"
+        end
+        meta << "elastic-transport: #{Elastic::Transport::VERSION}"
+        "#{ua} (#{meta.join('; ')})"
+      end
     end
   end
 end

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

@@ -48,7 +48,7 @@ module Elastic
 
       # Construct and send a request to the API.
       def request(method, path, params = {}, body = {}, headers = {})
-        meta_headers = { authorization: decide_authorization(params), user_agent: request_user_agent }
+        meta_headers = { authorization: decide_authorization(params) }
         headers = if !headers.is_a?(Hash)
                     meta_headers
                   else
@@ -79,17 +79,6 @@ module Elastic
 
       private
 
-      def request_user_agent
-        ua = "#{CLIENT_NAME}/#{CLIENT_VERSION}"
-        meta = ["RUBY_VERSION: #{RUBY_VERSION}"]
-        if RbConfig::CONFIG && RbConfig::CONFIG['host_os']
-          meta << "#{RbConfig::CONFIG['host_os'].split('_').first[/[a-z]+/i].downcase} " \
-                  "#{RbConfig::CONFIG['target_cpu']}"
-        end
-        meta << "elastic-transport: #{Elastic::Transport::VERSION}"
-        "#{ua} (#{meta.join('; ')})"
-      end
-
       def decide_authorization(params)
         if params[:grant_type] == 'authorization_code'
           "Bearer #{params[:code]}"

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

@@ -19,6 +19,6 @@
 
 module Elastic
   module EnterpriseSearch
-    VERSION = '8.8.0'
+    VERSION = '8.18.0'
   end
 end

data/spec/enterprise-search/client_spec.rb

@@ -104,5 +104,16 @@ describe Elastic::EnterpriseSearch::Client do
     end
   end
 
+  context 'user-agent' do
+    context 'default' do
+      let(:transport) { Elastic::EnterpriseSearch::Client.new.instance_variable_get('@transport') }
+      let(:subject) { transport.transport.connections.first.connection.headers }
+
+      it 'includes the user-agent in transport' do
+        expect(subject['user-agent']).to match("elastic-enterprise-search-ruby/#{Elastic::EnterpriseSearch::VERSION}")
+      end
+    end
+  end
+
   include_examples 'adapters compatibility'
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: elastic-enterprise-search
 version: !ruby/object:Gem::Version
-  version: 8.8.0
+  version: 8.18.0
 platform: ruby
 authors:
 - Fernando Briano
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-05-25 00:00:00.000000000 Z
+date: 2025-04-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: elastic-transport
@@ -104,16 +103,16 @@ dependencies:
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1'
+        version: '1.51'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1'
+        version: '1.51'
 - !ruby/object:Gem::Dependency
   name: vcr
   requirement: !ruby/object:Gem::Requirement
@@ -134,14 +133,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.23.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.23.1
 - !ruby/object:Gem::Dependency
   name: faraday-httpclient
   requirement: !ruby/object:Gem::Requirement
@@ -202,7 +201,7 @@ description: 'Official API client for Elastic Enterprise Search APIs.
 
   '
 email:
-- support@elastic.co
+- clients-team@elastic.co
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -226,7 +225,6 @@ files:
 - ".buildkite/run-local.sh"
 - ".buildkite/run-tests.sh"
 - ".ci/.gitignore"
-- ".ci/Dockerfile"
 - ".ci/make.sh"
 - ".github/check_license_headers.rb"
 - ".github/license-header.txt"
@@ -243,6 +241,7 @@ files:
 - NOTICE
 - README.md
 - Rakefile
+- catalog-info.yaml
 - docs/guide/app-search-api.asciidoc
 - docs/guide/connecting.asciidoc
 - docs/guide/development.asciidoc
@@ -266,6 +265,8 @@ files:
 - docs/guide/release_notes/85.asciidoc
 - docs/guide/release_notes/86.asciidoc
 - docs/guide/release_notes/87.asciidoc
+- docs/guide/release_notes/88.asciidoc
+- docs/guide/release_notes/89.asciidoc
 - docs/guide/release_notes/index.asciidoc
 - docs/guide/workplace-search-api.asciidoc
 - elastic-enterprise-search.gemspec
@@ -463,7 +464,16 @@ metadata:
   homepage_uri: https://www.elastic.co/enterprise-search
   source_code_uri: https://github.com/elastic/enterprise-search-ruby
   changelog_uri: https://www.elastic.co/guide/en/enterprise-search-clients/ruby/current/release_notes.html
-post_install_message: 
+post_install_message: |2+
+
+  Warning: Starting with Elastic version 9.0, the standalone Enterprise Search products, will no longer be included in our offering. They remain supported in their current form in version 8.x and will only receive security upgrades and fixes.
+  Enterprise Search clients will continue to be supported in their current form throughout 8.x versions, according to our EOL policy: https://www.elastic.co/support/eol
+  We recommend transitioning to our actively developed Elastic Stack (https://www.elastic.co/elastic-stack) tools for your search use cases. However, if you're still using any Enterprise Search products, we recommend using the latest stable release of the clients.
+
+  Here are some useful links with more information:
+  * Enterprise Search FAQ: https://www.elastic.co/resources/enterprise-search/enterprise-search-faq
+  * Migrating to 9.x from Enterprise Search 8.x versions: https://www.elastic.co/guide/en/enterprise-search/current/upgrading-to-9-x.html
+
 rdoc_options: []
 require_paths:
 - lib
@@ -478,8 +488,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.13
-signing_key: 
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Official API client for Elastic Enterprise Search
 test_files: []
+...

data/.ci/Dockerfile

@@ -1,25 +0,0 @@
-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 --chown=$BUILDER_USER:$BUILDER_GROUP . .
-RUN bundle install