elastic-enterprise-search 8.7.0 → 8.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '018288980fbd3b9a4f39cabf6fe3f7adfcb62e616d6d374a9e56099629468386'
-  data.tar.gz: eab15d1fa2e7d481b422a5fe3f843dfca8bb51e030ea6e70f690dd14ad757a09
+  metadata.gz: ba689b3ef05d303a636db6f9757b184c41de8232a625a9914dc521ae36ef10fe
+  data.tar.gz: 6b7bf74a47ce28ef549c77eb6f403cd9932f1001a6f82855230e407ddfc7e73b
 SHA512:
-  metadata.gz: 80d0d275fd647abee39ce5b14fe2ea133d3595a4992ed744bd7727953c223f624a1fed18550d950aed6c6dc034d63f756dfafc678c02dfaa4e15468ed0306bd0
-  data.tar.gz: aeb3fe71149d88fd9cc82005af8beef7295b9c15812eb53e67a0c702b1b012e82b2ff869d66e5f56c804c21793548acbc13162ffb4ad962060c6f64d632637a4
+  metadata.gz: ead1921648fc89eaa32ecbb5fff41509779df7377afddc8bfc8b96c9bdfd418eb4f3d8d854d6a6ca082933be830185404efe31548f074cf94de87b722451758e
+  data.tar.gz: b9865952c106e33d61add399ea50fe84818ba6baa84aa4084b7a61c2ff9f9cc047bea86a86783d11608493a7a8b33bdf0d20f0d81d699ce04d535385af6b88d8

data/.buildkite/log-results.sh

@@ -8,8 +8,8 @@ files="tmp/*.html"
 for f in $files; do
   SERVICE=`echo $f | grep -o "\(appsearch\|enterprisesearch\|workplacesearch\)"`
   RUBY_VERSION=`echo $f | grep -Po "(\d+\.)+\d+"`
-  EXAMPLES=`cat $f | grep -o "[0-9]\+ example" | tail -1`
-  FAILURES=`cat $f | grep -o "[0-9]\+ failure" | tail -1`
+  EXAMPLES=`cat $f | grep -o "[0-9]\+ examples\?" | tail -1`
+  FAILURES=`cat $f | grep -o "[0-9]\+ failures\?" | tail -1`
   PENDING=`cat $f | grep -o "[0-9]\+ pending" | tail -1`
   echo "--- :rspec: $EXAMPLES - :x: $FAILURES - :pinched_fingers: $PENDING :test_tube: $SERVICE :ruby: $RUBY_VERSION"
 done

data/.buildkite/pipeline.yml

@@ -4,14 +4,13 @@ steps:
       provider: "gcp"
     env:
       RUBY_VERSION: "{{ matrix.ruby }}"
-      STACK_VERSION: 8.7.0-SNAPSHOT
+      STACK_VERSION: 8.9-SNAPSHOT
     matrix:
       setup:
         ruby:
           - "3.2"
           - "3.1"
           - "3.0"
-          - "2.7"
     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/.github/workflows/testing.yml

@@ -7,7 +7,7 @@ jobs:
       ENDPOINT: http://localhost:8080
     strategy:
       matrix:
-        ruby: [ '2.7', '3.0', '3.1', '3.2' ]
+        ruby: [ '3.0', '3.1', '3.2' ]
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v2

data/CONTRIBUTING.md

@@ -45,28 +45,27 @@ RUNSCRIPTS=enterprise-search STACK_VERSION=7.10.0 ./.ci/run-tests
    your code without restriction. We ask this of all contributors in order to
    assure our users of the origin and continuing existence of the code. You only
    need to sign the CLA once.
- 
+
 2. Run rubocop and the test suite to ensure your changes do not break existing
    code:
-   
+
    ```
    $ bundle exec rubocop
    ```
-   
+
    Check [Running
    tests](https://github.com/elastic/enterprise-search-ruby/#run-tests) on the
    README for instructions on how to run all the tests.
 
 3. Rebase your changes. Update your local repository with the most recent code
    from the main `enterprise-search-ruby` repository and rebase your branch
-   on top of the latest `main` branch. All of your changes will be squashed
-   into a single commit so don't worry about pushing multiple times.
-   
+   on top of the latest `main` branch.
+
 4. Submit a pull request. Push your local changes to your forked repository
-   and [submit a pull request](https://github.com/elastic/enterprise-search-python/pulls)
+   and [submit a pull request](https://github.com/elastic/enterprise-search-ruby/pulls)
    and mention the issue number if any (`Closes #123`) Make sure that you
    add or modify tests related to your changes so that CI will pass.
-   
+
 5. Sit back and wait. There may be some discussion on your pull request and
    if changes are needed we would love to work with you to get your pull request
    merged into enterprise-search-ruby.

data/README.md

@@ -1,8 +1,9 @@
 # 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)
 
 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/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

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.7.0'
+    VERSION = '8.9.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,14 @@
 --- !ruby/object:Gem::Specification
 name: elastic-enterprise-search
 version: !ruby/object:Gem::Version
-  version: 8.7.0
+  version: 8.9.0
 platform: ruby
 authors:
 - Fernando Briano
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-04-25 00:00:00.000000000 Z
+date: 2023-07-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: elastic-transport
@@ -202,7 +202,7 @@ description: 'Official API client for Elastic Enterprise Search APIs.
 
   '
 email:
-- support@elastic.co
+- clients-team@elastic.co
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -266,6 +266,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
@@ -478,7 +480,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.4.13
 signing_key: 
 specification_version: 4
 summary: Official API client for Elastic Enterprise Search