elasticsearch 8.16.0 → 9.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 32cd6c6f02b68199e9e021fc628d7336525284f7111dda9dc82f1cd9600447f1
-  data.tar.gz: a7f3660149d1bdab70ce54402bacd81d715f470206adec898908d54e71879c9c
+  metadata.gz: 416eb19b60e9921f68c5ee015c548bcec83efe0bb5a8e8bbde764354441b6f40
+  data.tar.gz: 84ab9e3bb36db5edb709df7b92212d1a5cfb7180dd79fab01ee62c1380898ad4
 SHA512:
-  metadata.gz: 62e4e89c10b02281131710598fdc483c8e10ddb6d927b5ce311a1a44043b9dbf2bbd13e542281113a45d066a5a85522960acc2736672bb4d853151fd07ce06fa
-  data.tar.gz: cef1f6fb061b12efa6ca0bc60ed334d57bd17b8f2d64b86eae205743e5b51a631beb44b1391d99590336c79eff175b44b3d406baeb23dbbb4ece6b42aa94c240
+  metadata.gz: 779e20047d61128d03ca19651c00027f380d3e3bbbecfd96eeb917d104b4a7975b427904330934720259c3bc76e74c6f8e3f44989c039dff1866f16e4c469359
+  data.tar.gz: b9f0c986fb7d5e6562d6fc75b792c61d4d88da2155f27f87ac2beba7f445fba1014ecd088ff2597f48a9a2e2d02a6224ff15115a5f97c091e9cae53b0d980d70

data/elasticsearch.gemspec

@@ -15,7 +15,7 @@
 # specific language governing permissions and limitations
 # under the License.
 
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'elasticsearch/version'
 
@@ -33,24 +33,26 @@ Gem::Specification.new do |s|
     'source_code_uri' => 'https://github.com/elastic/elasticsearch-ruby/tree/main',
     'bug_tracker_uri' => 'https://github.com/elastic/elasticsearch-ruby/issues'
   }
-  s.files = `git ls-files`.split($/)
+  s.files = `git ls-files`.split($/).reject do |file|
+    file.match(/^spec\/|^Gemfile|^Rakefile/)
+  end
+
   s.executables = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
   s.executables << 'elastic_ruby_console'
-  s.test_files = s.files.grep(%r{^(test|spec|features)/})
   s.require_paths = ['lib']
   s.bindir = 'bin'
 
   s.extra_rdoc_files  = ['README.md', 'LICENSE.txt']
   s.rdoc_options      = ['--charset=UTF-8']
 
-  s.required_ruby_version = '>= 2.5'
-
+  s.required_ruby_version = '>= 2.6' # For compatibility with JRuby 9.3
+  s.add_dependency 'elasticsearch-api', '9.2.0'
   s.add_dependency 'elastic-transport', '~> 8.3'
-  s.add_dependency 'elasticsearch-api', '8.16.0'
 
   s.add_development_dependency 'base64'
   s.add_development_dependency 'bundler'
   s.add_development_dependency 'debug' unless defined?(JRUBY_VERSION)
+  s.add_development_dependency 'ostruct'
   s.add_development_dependency 'pry'
   s.add_development_dependency 'rake'
   s.add_development_dependency 'require-prof' unless defined?(JRUBY_VERSION) || defined?(Rubinius)

data/lib/elasticsearch/helpers/scroll_helper.rb

@@ -43,12 +43,8 @@ module Elasticsearch
       # @yieldparam document [Hash] yields a document found in the search hits.
       #
       def each(&block)
-        @docs = []
-        @scroll_id = nil
-        refresh_docs
-        for doc in @docs do
-          refresh_docs
-          yield doc
+        until (docs = results).empty?
+          docs.each(&block)
         end
         clear
       end
@@ -70,17 +66,11 @@ module Elasticsearch
       #
       def clear
         @client.clear_scroll(body: { scroll_id: @scroll_id }) if @scroll_id
-        @docs = []
+        @scroll_id = nil
       end
 
       private
 
-      def refresh_docs
-        @docs ||= []
-        @docs << results
-        @docs.flatten!
-      end
-
       def initial_search
         response = @client.search(index: @index, scroll: @scroll, body: @body)
         @scroll_id = response['_scroll_id']
@@ -88,7 +78,7 @@ module Elasticsearch
       end
 
       def scroll_request
-        @client.scroll(body: {scroll: @scroll, scroll_id: @scroll_id})['hits']['hits']
+        @client.scroll(body: { scroll: @scroll, scroll_id: @scroll_id })['hits']['hits']
       end
     end
   end

data/lib/elasticsearch/version.rb

@@ -16,5 +16,5 @@
 # under the License.
 
 module Elasticsearch
-  VERSION = '8.16.0'.freeze
+  VERSION = '9.2.0'.freeze
 end

data/lib/elasticsearch.rb

@@ -37,8 +37,9 @@ module Elasticsearch
     #
     # @param [Hash] arguments - initializer arguments
     # @option arguments [String] :cloud_id - The Cloud ID to connect to Elastic Cloud
-    # @option arguments [String, Hash] :api_key Use API Key Authentication, either the base64 encoding of `id` and `api_key`
-    #                                           joined by a colon as a String, or a hash with the `id` and `api_key` values.
+    # @option arguments [String, Hash] :api_key Use API Key Authentication, either the base64 encoding of `id` and
+    #                                           `api_key` joined by a colon as a String, or a hash with the `id` and
+    #                                           `api_key` values.
     # @option arguments [String] :opaque_id_prefix set a prefix for X-Opaque-Id when initializing the client.
     #                                              This will be prepended to the id you set before each request
     #                                              if you're using X-Opaque-Id
@@ -51,6 +52,7 @@ module Elasticsearch
       api_key(arguments) if arguments[:api_key]
       setup_cloud(arguments) if arguments[:cloud_id]
       set_user_agent!(arguments) unless sent_user_agent?(arguments)
+      set_content_type!(arguments)
       @transport = Elastic::Transport::Client.new(arguments, &block)
     end
 
@@ -65,10 +67,10 @@ module Elasticsearch
           opaque_id = @opaque_id_prefix ? "#{@opaque_id_prefix}#{opaque_id}" : opaque_id
           args[4] = headers.merge('X-Opaque-Id' => opaque_id)
         end
-        unless @verified
-          verify_elasticsearch(*args, &block)
-        else
+        if @verified
           @transport.perform_request(*args, &block)
+        else
+          verify_elasticsearch(*args, &block)
         end
       else
         @transport.send(name, *args, &block)
@@ -101,6 +103,7 @@ module Elasticsearch
         raise e
       end
       raise Elasticsearch::UnsupportedProductError unless response.headers['x-elastic-product'] == 'Elasticsearch'
+
       @verified = true
       response
     end
@@ -173,9 +176,25 @@ module Elasticsearch
       if RbConfig::CONFIG && RbConfig::CONFIG['host_os']
         user_agent << "#{RbConfig::CONFIG['host_os'].split('_').first[/[a-z]+/i].downcase} #{RbConfig::CONFIG['target_cpu']}"
       end
+      set_header({ user_agent: user_agent.join('; ') }, arguments)
+    end
+
+    def set_content_type!(arguments)
+      headers = {}
+      user_headers = arguments&.[](:transport_options)&.[](:headers)
+      unless user_headers&.keys&.detect { |h| h =~ /content-?_?type/ }
+        headers['content-type'] = 'application/vnd.elasticsearch+json; compatible-with=9'
+      end
+      unless user_headers&.keys&.detect { |h| h =~ /accept/ }
+        headers['accept'] = 'application/vnd.elasticsearch+json; compatible-with=9'
+      end
+      set_header(headers, arguments) unless headers.empty?
+    end
+
+    def set_header(header, arguments)
       arguments[:transport_options] ||= {}
       arguments[:transport_options][:headers] ||= {}
-      arguments[:transport_options][:headers].merge!({ user_agent: user_agent.join('; ')})
+      arguments[:transport_options][:headers].merge!(header)
     end
   end
 

metadata

@@ -1,15 +1,28 @@
 --- !ruby/object:Gem::Specification
 name: elasticsearch
 version: !ruby/object:Gem::Version
-  version: 8.16.0
+  version: 9.2.0
 platform: ruby
 authors:
 - Elastic Client Library Maintainers
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-11-12 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: elasticsearch-api
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 9.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 9.2.0
 - !ruby/object:Gem::Dependency
   name: elastic-transport
   requirement: !ruby/object:Gem::Requirement
@@ -25,21 +38,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '8.3'
 - !ruby/object:Gem::Dependency
-  name: elasticsearch-api
+  name: base64
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 8.16.0
-  type: :runtime
+        version: '0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 8.16.0
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: base64
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -53,7 +66,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: debug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -67,7 +80,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: debug
+  name: ostruct
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -201,14 +214,12 @@ executables:
 - elastic_ruby_console
 extensions: []
 extra_rdoc_files:
-- README.md
 - LICENSE.txt
+- README.md
 files:
 - ".gitignore"
-- Gemfile
 - LICENSE.txt
 - README.md
-- Rakefile
 - bin/elastic_ruby_console
 - elasticsearch.gemspec
 - lib/elasticsearch-ruby.rb
@@ -217,22 +228,6 @@ files:
 - lib/elasticsearch/helpers/esql_helper.rb
 - lib/elasticsearch/helpers/scroll_helper.rb
 - lib/elasticsearch/version.rb
-- spec/integration/characters_escaping_spec.rb
-- spec/integration/client_integration_spec.rb
-- spec/integration/helpers/bulk_helper_spec.rb
-- spec/integration/helpers/esql_helper_spec.rb
-- spec/integration/helpers/helpers_spec_helper.rb
-- spec/integration/helpers/scroll_helper_spec.rb
-- spec/integration/opentelemetry_spec.rb
-- spec/spec_helper.rb
-- spec/unit/api_key_spec.rb
-- spec/unit/cloud_credentials_spec.rb
-- spec/unit/custom_transport_implementation_spec.rb
-- spec/unit/elasticsearch_product_validation_spec.rb
-- spec/unit/headers_spec.rb
-- spec/unit/opaque_id_spec.rb
-- spec/unit/user_agent_spec.rb
-- spec/unit/wrapper_gem_spec.rb
 homepage: https://www.elastic.co/guide/en/elasticsearch/client/ruby-api/current/index.html
 licenses:
 - Apache-2.0
@@ -241,7 +236,6 @@ metadata:
   changelog_uri: https://github.com/elastic/elasticsearch-ruby/blob/main/CHANGELOG.md
   source_code_uri: https://github.com/elastic/elasticsearch-ruby/tree/main
   bug_tracker_uri: https://github.com/elastic/elasticsearch-ruby/issues
-post_install_message:
 rdoc_options:
 - "--charset=UTF-8"
 require_paths:
@@ -250,31 +244,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.5'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.20
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Ruby integrations for Elasticsearch
-test_files:
-- spec/integration/characters_escaping_spec.rb
-- spec/integration/client_integration_spec.rb
-- spec/integration/helpers/bulk_helper_spec.rb
-- spec/integration/helpers/esql_helper_spec.rb
-- spec/integration/helpers/helpers_spec_helper.rb
-- spec/integration/helpers/scroll_helper_spec.rb
-- spec/integration/opentelemetry_spec.rb
-- spec/spec_helper.rb
-- spec/unit/api_key_spec.rb
-- spec/unit/cloud_credentials_spec.rb
-- spec/unit/custom_transport_implementation_spec.rb
-- spec/unit/elasticsearch_product_validation_spec.rb
-- spec/unit/headers_spec.rb
-- spec/unit/opaque_id_spec.rb
-- spec/unit/user_agent_spec.rb
-- spec/unit/wrapper_gem_spec.rb
+test_files: []

data/Gemfile

@@ -1,35 +0,0 @@
-# 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.
-
-source 'https://rubygems.org'
-
-# Specify your gem's dependencies in elasticsearch.gemspec
-gemspec
-
-if File.exist? File.expand_path('../elasticsearch-api/elasticsearch-api.gemspec', __dir__)
-  gem 'elasticsearch-api', path: File.expand_path('../elasticsearch-api', __dir__), require: false
-end
-
-if ENV['TRANSPORT_VERSION'] == 'main'
-  gem 'elastic-transport', git: 'https://github.com/elastic/elastic-transport-ruby.git', branch: 'main'
-end
-
-if RUBY_VERSION >= '3.0'
-  gem 'opentelemetry-sdk', require: false
-end

data/Rakefile

@@ -1,54 +0,0 @@
-# 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.
-
-require 'bundler/gem_tasks'
-
-task(:default) { system 'rake --tasks' }
-
-desc 'Run unit tests'
-task test: 'test:spec'
-
-# ----- Test tasks ------------------------------------------------------------
-require 'rspec/core/rake_task'
-
-namespace :test do
-  desc 'Wait for Elasticsearch to be in a green state'
-  task :wait_for_green do
-    sh '../scripts/wait-cluster.sh'
-  end
-
-  RSpec::Core::RakeTask.new(:integration) do |t|
-    t.pattern = 'spec/integration/**{,/*/**}/*_spec.rb'
-  end
-
-  RSpec::Core::RakeTask.new(:unit) do |t|
-    t.pattern = 'spec/unit/**{,/*/**}/*_spec.rb'
-  end
-
-  desc 'Run unit and integration tests'
-  task :all do
-    Rake::Task['test:unit'].invoke
-    Rake::Task['test:integration'].invoke
-  end
-end
-
-# ----- Documentation tasks ---------------------------------------------------
-
-require 'yard'
-YARD::Rake::YardocTask.new(:doc) do |t|
-  t.options = %w| --embed-mixins --markup=markdown |
-end

data/spec/integration/characters_escaping_spec.rb

@@ -1,96 +0,0 @@
-# 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.
-
-require 'spec_helper'
-require 'uri'
-
-ELASTICSEARCH_URL = ENV['TEST_ES_SERVER'] || "http://localhost:#{(ENV['PORT'] || 9200)}"
-raise URI::InvalidURIError unless ELASTICSEARCH_URL =~ /\A#{URI::DEFAULT_PARSER.make_regexp}\z/
-
-context 'Elasticsearch client' do
-  let(:client) do
-    Elasticsearch::Client.new(host: ELASTICSEARCH_URL, user: 'elastic', password: 'changeme')
-  end
-  let(:index) { 'tvs' }
-
-  after do
-    client.indices.delete(index: index)
-  end
-
-  context 'escaping spaces in ids' do
-    it 'escapes spaces for id when using index' do
-      response = client.index(index: index, id: 'a test 1', body: { name: 'A test 1' }, refresh: true)
-      expect(response.body['_id']).to eq 'a test 1'
-
-      response = client.search(index: index)
-      expect(response.body['hits']['hits'].first['_id']).to eq 'a test 1'
-
-      # Raises exception, _id is unrecognized
-      expect do
-        client.index(index: index, _id: 'a test 2', body: { name: 'A test 2' })
-      end.to raise_exception Elastic::Transport::Transport::Errors::BadRequest
-
-      # Raises exception, id is a query parameter
-      expect do
-        client.index(index: index, body: { name: 'A test 3', _id: 'a test 3' })
-      end.to raise_exception Elastic::Transport::Transport::Errors::BadRequest
-    end
-
-    it 'escapes spaces for id when using create' do
-      # Works with create
-      response = client.create(index: index, id: 'a test 4', body: { name: 'A test 4' })
-      expect(response.body['_id']).to eq 'a test 4'
-    end
-
-    it 'escapes spaces for id when using bulk' do
-      body = [
-        { create: { _index: index, _id: 'a test 5', data: { name: 'A test 5' } } }
-      ]
-      expect(client.bulk(body: body, refresh: true).status).to eq 200
-
-      response = client.search(index: index)
-      expect(
-        response.body['hits']['hits'].select { |a| a['_id'] == 'a test 5' }.size
-      ).to eq 1
-    end
-  end
-
-  context 'it doesnae escape plus signs in id' do
-    it 'escapes spaces for id when using index' do
-      response = client.index(index: index, id: 'a+test+1', body: { name: 'A test 1' })
-      expect(response.body['_id']).to eq 'a+test+1'
-    end
-
-    it 'escapes spaces for id when using create' do
-      # Works with create
-      response = client.create(index: index, id: 'a+test+2', body: { name: 'A test 2' })
-      expect(response.body['_id']).to eq 'a+test+2'
-    end
-
-    it 'escapes spaces for id when using bulk' do
-      body = [
-        { create: { _index: index, _id: 'a+test+3', data: { name: 'A test 3' } } }
-      ]
-      expect(client.bulk(body: body, refresh: true).status).to eq 200
-
-      response = client.search(index: index)
-      expect(
-        response.body['hits']['hits'].select { |a| a['_id'] == 'a+test+3' }.size
-      ).to eq 1
-    end
-  end
-end

data/spec/integration/client_integration_spec.rb

@@ -1,64 +0,0 @@
-# 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.
-ELASTICSEARCH_URL = ENV['TEST_ES_SERVER'] || "http://localhost:#{(ENV['PORT'] || 9200)}"
-raise URI::InvalidURIError unless ELASTICSEARCH_URL =~ /\A#{URI::DEFAULT_PARSER.make_regexp}\z/
-
-require 'spec_helper'
-require 'logger'
-require 'uri'
-
-context 'Elasticsearch client' do
-  let(:logger) { Logger.new($stderr) }
-
-  let(:client) do
-    Elasticsearch::Client.new(
-      host: ELASTICSEARCH_URL,
-      logger: logger,
-      user: 'elastic',
-      password: 'changeme'
-    )
-  end
-
-  context 'Integrates with elasticsearch API' do
-    it 'should perform the API methods' do
-      expect do
-        # Index a document
-        client.index(index: 'test-index', id: '1', body: { title: 'Test' })
-
-        # Refresh the index
-        client.indices.refresh(index: 'test-index')
-
-        # Search
-        response = client.search(index: 'test-index', body: { query: { match: { title: 'test' } } })
-
-        expect(response['hits']['total']['value']).to eq 1
-        expect(response['hits']['hits'][0]['_source']['title']).to eq 'Test'
-
-        # Delete the index
-        client.indices.delete(index: 'test-index')
-      end.not_to raise_error
-    end
-  end
-
-  context 'Reports the right meta header' do
-    it 'Reports es service name and gem version' do
-      headers = client.transport.connections.first.connection.headers
-      version = Class.new.extend(Elastic::Transport::MetaHeader).send(:client_meta_version, Elasticsearch::VERSION)
-      expect(headers['x-elastic-client-meta']).to match /^es=#{version}/
-    end
-  end
-end