elasticsearch 7.13.3 → 8.14.0

data/spec/unit/elasticsearch_product_validation_spec.rb

@@ -0,0 +1,148 @@
+# 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 'webmock/rspec'
+
+describe 'Elasticsearch: Validation' do
+  let(:host) { 'http://localhost:9200' }
+  let(:count_request_stub) do
+    stub_request(:get, "#{host}/_count")
+      .to_return(status: status, body: nil, headers: headers)
+  end
+  let(:status) { 200 }
+  let(:body) { nil }
+  let(:headers) { {} }
+  let(:client) { Elasticsearch::Client.new }
+
+  context 'When Elasticsearch replies with status 401' do
+    let(:status) { 401 }
+
+    it 'Verifies the request but shows a warning' do
+      stderr      = $stderr
+      fake_stderr = StringIO.new
+      $stderr     = fake_stderr
+      expect(client.instance_variable_get('@verified')).to be false
+      count_request_stub
+      expect do
+        client.count
+      end.to raise_error Elastic::Transport::Transport::Errors::Unauthorized
+      expect(client.instance_variable_get('@verified')).to be true
+
+      fake_stderr.rewind
+      expect(fake_stderr.string).to eq("#{Elasticsearch::SECURITY_PRIVILEGES_VALIDATION_WARNING}\n")
+    ensure
+      $stderr = stderr
+    end
+  end
+
+  context 'When Elasticsearch replies with status 403' do
+    let(:status) { 403 }
+
+    it 'Verifies the request but shows a warning' do
+      stderr      = $stderr
+      fake_stderr = StringIO.new
+      $stderr     = fake_stderr
+
+      expect(client.instance_variable_get('@verified')).to be false
+      count_request_stub
+      expect do
+        client.count
+      end.to raise_error Elastic::Transport::Transport::Errors::Forbidden
+      expect(client.instance_variable_get('@verified')).to be true
+
+      fake_stderr.rewind
+      expect(fake_stderr.string).to eq("#{Elasticsearch::SECURITY_PRIVILEGES_VALIDATION_WARNING}\n")
+    ensure
+      $stderr = stderr
+    end
+  end
+
+  context 'When Elasticsearch replies with status 413' do
+    let(:status) { 413 }
+
+    it 'Verifies the request and shows a warning' do
+      stderr      = $stderr
+      fake_stderr = StringIO.new
+      $stderr     = fake_stderr
+
+      expect(client.instance_variable_get('@verified')).to be false
+      count_request_stub
+      expect do
+        client.count
+      end.to raise_error Elastic::Transport::Transport::Errors::RequestEntityTooLarge
+      expect(client.instance_variable_get('@verified')).to be true
+
+      fake_stderr.rewind
+      expect(fake_stderr.string.delete("\n"))
+        .to eq(Elasticsearch::SECURITY_PRIVILEGES_VALIDATION_WARNING)
+    ensure
+      $stderr = stderr
+    end
+  end
+
+  context 'When Elasticsearch replies with status 503' do
+    let(:status) { 503 }
+    let(:body) { {}.to_json }
+
+    it 'Does not verify the request and shows a warning' do
+      stderr      = $stderr
+      fake_stderr = StringIO.new
+      $stderr     = fake_stderr
+
+      expect(client.instance_variable_get('@verified')).to be false
+      count_request_stub
+      expect do
+        client.count
+      end.to raise_error Elastic::Transport::Transport::Errors::ServiceUnavailable
+      expect(client.instance_variable_get('@verified')).to be false
+
+      fake_stderr.rewind
+      expect(fake_stderr.string)
+        .to eq(
+              <<~MSG
+            The client is unable to verify that the server is \
+            Elasticsearch. Some functionality may not be compatible \
+            if the server is running an unsupported product.
+          MSG
+            )
+    ensure
+      $stderr = stderr
+    end
+  end
+
+  context 'When the header is present' do
+    let(:headers) { { 'X-Elastic-Product' => 'Elasticsearch' } }
+
+    it 'Makes requests and passes validation' do
+      expect(client.instance_variable_get('@verified')).to be false
+      count_request_stub
+      client.count
+      expect(client.instance_variable_get('@verified')).to be true
+    end
+  end
+
+  context 'When the header is not present' do
+    it 'Fails validation' do
+      expect(client.instance_variable_get('@verified')).to be false
+      stub_request(:get, "#{host}/_cluster/health")
+        .to_return(status: status, body: nil, headers: {})
+      expect { client.cluster.health }.to raise_error Elasticsearch::UnsupportedProductError, Elasticsearch::NOT_ELASTICSEARCH_WARNING
+      expect(client.instance_variable_get('@verified')).to be false
+    end
+  end
+end

data/spec/unit/headers_spec.rb

@@ -0,0 +1,55 @@
+# 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 'ostruct'
+
+describe Elasticsearch::Client do
+  context 'when a header is set on an endpoint request' do
+    let(:client) { described_class.new }
+    let(:headers) { { 'user-agent' => 'my ruby app' } }
+
+    it 'performs the request with the header' do
+      allow(client).to receive(:perform_request) { OpenStruct.new(body: '') }
+      expect { client.search(headers: headers) }.not_to raise_error
+      expect(client).to have_received(:perform_request)
+        .with('GET', '_search', {}, nil, headers, { endpoint: 'search' })
+    end
+  end
+
+  context 'when a header is set on an endpoint request and on initialization' do
+    let!(:client) do
+      described_class.new(
+        host: 'http://localhost:9200',
+        transport_options: { headers: instance_headers }
+      ).tap do |client|
+        client.instance_variable_set('@verified', true)
+      end
+    end
+    let(:instance_headers) { { set_in_instantiation: 'header value' } }
+    let(:param_headers) { { 'user-agent' => 'My Ruby Tests', 'set-on-method-call' => 'header value' } }
+
+    it 'performs the request with the header' do
+      expected_headers = client.transport.connections.connections.first.connection.headers.merge(param_headers)
+
+      expect_any_instance_of(Faraday::Connection)
+        .to receive(:run_request)
+          .with(:get, 'http://localhost:9200/_search', nil, expected_headers) { OpenStruct.new(body: '') }
+
+      client.search(headers: param_headers)
+    end
+  end
+end

data/spec/unit/opaque_id_spec.rb

@@ -0,0 +1,48 @@
+# 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 'ostruct'
+
+describe Elasticsearch::Client do
+  let(:transport) { client.instance_variable_get('@transport') }
+  let(:client) { described_class.new.tap { |cl| cl.instance_variable_set('@verified', true) } }
+
+  before do
+    allow(transport).to receive(:perform_request) { OpenStruct.new(body: '') }
+  end
+
+  context 'when x-opaque-id is set' do
+    it 'uses x-opaque-id on a request' do
+      client.search(opaque_id: '12345')
+      expect(transport).to have_received(:perform_request)
+        .with('GET', '_search', {}, nil, { 'X-Opaque-Id' => '12345' }, {:endpoint=>"search"})
+    end
+  end
+
+  context 'when an x-opaque-id prefix is set on initialization' do
+    let(:prefix) { 'elastic_cloud' }
+    let(:client) do
+      described_class.new(opaque_id_prefix: prefix).tap { |cl| cl.instance_variable_set('@verified', true) }
+    end
+
+    it 'uses x-opaque-id on a request' do
+      expect { client.search(opaque_id: '12345') }.not_to raise_error
+      expect(transport).to have_received(:perform_request)
+        .with('GET', '_search', {}, nil, { 'X-Opaque-Id' => 'elastic_cloud12345' }, {:endpoint=>"search"})
+    end
+  end
+end

data/spec/unit/user_agent_spec.rb

@@ -0,0 +1,69 @@
+# 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'
+
+describe Elasticsearch::Client do
+  let(:user_agent) {
+    "elasticsearch-ruby/#{Elasticsearch::VERSION}; elastic-transport-ruby/#{Elastic::Transport::VERSION}; RUBY_VERSION: #{RUBY_VERSION}; #{RbConfig::CONFIG['host_os'].split('_').first[/[a-z]+/i].downcase} #{RbConfig::CONFIG['target_cpu']}"
+  }
+
+  context 'when no user-agent is set on initialization' do
+    let(:client) { described_class.new }
+
+    it 'has the expected header' do
+      expect(client.transport.options[:transport_options][:headers][:user_agent]).to eq user_agent
+    end
+  end
+
+  context 'when a header is specified on initialization' do
+    let(:client) do
+      described_class.new(
+        transport_options: { headers: { 'X-Test-Header' => 'Test' } }
+      )
+    end
+
+    it 'has the expected header' do
+      expect(client.transport.options[:transport_options][:headers][:user_agent]).to eq user_agent
+      expect(client.transport.options[:transport_options][:headers]['X-Test-Header']).to eq 'Test'
+    end
+  end
+
+  context 'when other transport_options are specified on initialization' do
+    let(:client) do
+      described_class.new(
+        transport_options: { params:  { format: 'yaml' } }
+      )
+    end
+
+    it 'has the expected header' do
+      expect(client.transport.options[:transport_options][:headers][:user_agent]).to eq user_agent
+      expect(client.transport.options[:transport_options][:params][:format]).to eq 'yaml'
+    end
+  end
+
+  context 'when :user_agent is specified on initialization' do
+    let(:client) do
+      described_class.new(
+        transport_options: { headers: { user_agent: 'TestApp' } }
+      )
+    end
+
+    it 'has the expected header' do
+      expect(client.transport.options[:transport_options][:headers][:user_agent]).to eq 'TestApp'
+    end
+  end
+end

data/{test/unit/wrapper_gem_test.rb → spec/unit/wrapper_gem_spec.rb}

@@ -15,29 +15,19 @@
 # specific language governing permissions and limitations
 # under the License.
 
-require 'test_helper'
+require 'spec_helper'
 
-module Elasticsearch
-  module Test
-    class WrapperGemTest < Minitest::Test
-
-      context "Wrapper gem" do
-
-        should "require all neccessary subgems" do
-          assert defined? Elasticsearch::Client
-          assert defined? Elasticsearch::API
-        end
-
-        should "mix the API into the client" do
-          client = Elasticsearch::Client.new
-
-          assert_respond_to client, :search
-          assert_respond_to client, :cluster
-          assert_respond_to client, :indices
-        end
+describe 'Elasticsearch: wrapper gem' do
+  it 'requires all neccessary subgems' do
+    expect(defined? Elasticsearch::Client)
+    expect(defined? Elasticsearch::API)
+  end
 
-      end
+  it 'mixes the API into the client' do
+    client = Elasticsearch::Client.new
 
-    end
+    expect(client).to respond_to(:search)
+    expect(client).to respond_to(:cluster)
+    expect(client).to respond_to(:indices)
   end
 end

metadata

@@ -1,45 +1,45 @@
 --- !ruby/object:Gem::Specification
 name: elasticsearch
 version: !ruby/object:Gem::Version
-  version: 7.13.3
+  version: 8.14.0
 platform: ruby
 authors:
-- Karel Minarik
+- Elastic Client Library Maintainers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-07-12 00:00:00.000000000 Z
+date: 2024-06-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: elasticsearch-transport
+  name: elastic-transport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 7.13.3
+        version: '8.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 7.13.3
+        version: '8.3'
 - !ruby/object:Gem::Dependency
   name: elasticsearch-api
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 7.13.3
+        version: 8.14.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 7.13.3
+        version: 8.14.0
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: base64
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -53,49 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13'
-- !ruby/object:Gem::Dependency
-  name: elasticsearch-extensions
-  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: ansi
-  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: shoulda-context
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -109,7 +67,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: mocha
+  name: debug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -123,7 +81,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: yard
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -137,7 +95,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -151,7 +109,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: require-prof
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -165,7 +123,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: minitest-reporters
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -193,7 +151,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: require-prof
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -207,27 +165,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.17'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '0.18'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.17'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '0.18'
-- !ruby/object:Gem::Dependency
-  name: simplecov-rcov
+  name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -241,7 +179,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: cane
+  name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -254,52 +192,54 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: test-unit
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2'
 description: 'Ruby integrations for Elasticsearch (client, API, etc.)
 
   '
 email:
-- karel.minarik@elasticsearch.org
+- client-libs@elastic.co
 executables:
 - elastic_ruby_console
 extensions: []
 extra_rdoc_files:
 - README.md
-- LICENSE
+- LICENSE.txt
 files:
 - ".gitignore"
 - Gemfile
-- LICENSE
+- LICENSE.txt
 - README.md
 - Rakefile
 - bin/elastic_ruby_console
 - elasticsearch.gemspec
 - lib/elasticsearch-ruby.rb
 - lib/elasticsearch.rb
+- lib/elasticsearch/helpers/bulk_helper.rb
+- lib/elasticsearch/helpers/esql_helper.rb
+- lib/elasticsearch/helpers/scroll_helper.rb
 - lib/elasticsearch/version.rb
-- test/integration/client_integration_test.rb
-- test/test_helper.rb
-- test/unit/wrapper_gem_test.rb
-homepage: https://www.elastic.co/guide/en/elasticsearch/client/ruby-api/7.x/index.html
+- 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
 metadata:
-  homepage_uri: https://www.elastic.co/guide/en/elasticsearch/client/ruby-api/7.x/index.html
-  changelog_uri: https://github.com/elastic/elasticsearch-ruby/blob/7.x/CHANGELOG.md
-  source_code_uri: https://github.com/elastic/elasticsearch-ruby/tree/7.x
+  homepage_uri: https://www.elastic.co/guide/en/elasticsearch/client/ruby-api/current/index.html
+  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:
@@ -310,18 +250,31 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.4'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.15
+rubygems_version: 3.5.9
 signing_key: 
 specification_version: 4
 summary: Ruby integrations for Elasticsearch
 test_files:
-- test/integration/client_integration_test.rb
-- test/test_helper.rb
-- test/unit/wrapper_gem_test.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