elasticsearch 7.1.0 → 8.10.0

data/spec/integration/helpers/scroll_helper_spec.rb

@@ -0,0 +1,91 @@
+# 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 'elasticsearch/helpers/scroll_helper'
+
+context 'Elasticsearch client helpers' do
+  let(:client) do
+    Elasticsearch::Client.new(
+      host: ELASTICSEARCH_URL,
+      user: 'elastic',
+      password: 'changeme'
+    )
+  end
+  let(:index) { 'books' }
+  let(:body) { { size: 12, query: { match_all: {} } } }
+  let(:scroll_helper) { Elasticsearch::Helpers::ScrollHelper.new(client, index, body) }
+
+  before do
+    documents = [
+      { index: { _index: index, data: {name: "Leviathan Wakes", "author": "James S.A. Corey", "release_date": "2011-06-02", "page_count": 561} } },
+      { index: { _index: index, data: {name: "Hyperion", "author": "Dan Simmons", "release_date": "1989-05-26", "page_count": 482} } },
+      { index: { _index: index, data: {name: "Dune", "author": "Frank Herbert", "release_date": "1965-06-01", "page_count": 604} } },
+      { index: { _index: index, data: {name: "Dune Messiah", "author": "Frank Herbert", "release_date": "1969-10-15", "page_count": 331} } },
+      { index: { _index: index, data: {name: "Children of Dune", "author": "Frank Herbert", "release_date": "1976-04-21", "page_count": 408} } },
+      { index: { _index: index, data: {name: "God Emperor of Dune", "author": "Frank Herbert", "release_date": "1981-05-28", "page_count": 454} } },
+      { index: { _index: index, data: {name: "Consider Phlebas", "author": "Iain M. Banks", "release_date": "1987-04-23", "page_count": 471} } },
+      { index: { _index: index, data: {name: "Pandora's Star", "author": "Peter F. Hamilton", "release_date": "2004-03-02", "page_count": 768} } },
+      { index: { _index: index, data: {name: "Revelation Space", "author": "Alastair Reynolds", "release_date": "2000-03-15", "page_count": 585} } },
+      { index: { _index: index, data: {name: "A Fire Upon the Deep", "author": "Vernor Vinge", "release_date": "1992-06-01", "page_count": 613} } },
+      { index: { _index: index, data: {name: "Ender's Game", "author": "Orson Scott Card", "release_date": "1985-06-01", "page_count": 324} } },
+      { index: { _index: index, data: {name: "1984", "author": "George Orwell", "release_date": "1985-06-01", "page_count": 328} } },
+      { index: { _index: index, data: {name: "Fahrenheit 451", "author": "Ray Bradbury", "release_date": "1953-10-15", "page_count": 227} } },
+      { index: { _index: index, data: {name: "Brave New World", "author": "Aldous Huxley", "release_date": "1932-06-01", "page_count": 268} } },
+      { index: { _index: index, data: {name: "Foundation", "author": "Isaac Asimov", "release_date": "1951-06-01", "page_count": 224} } },
+      { index: { _index: index, data: {name: "The Giver", "author": "Lois Lowry", "release_date": "1993-04-26", "page_count": 208} } },
+      { index: { _index: index, data: {name: "Slaughterhouse-Five", "author": "Kurt Vonnegut", "release_date": "1969-06-01", "page_count": 275} } },
+      { index: { _index: index, data: {name: "The Hitchhiker's Guide to the Galaxy", "author": "Douglas Adams", "release_date": "1979-10-12", "page_count": 180} } },
+      { index: { _index: index, data: {name: "Snow Crash", "author": "Neal Stephenson", "release_date": "1992-06-01", "page_count": 470} } },
+      { index: { _index: index, data: {name: "Neuromancer", "author": "William Gibson", "release_date": "1984-07-01", "page_count": 271} } },
+      { index: { _index: index, data: {name: "The Handmaid's Tale", "author": "Margaret Atwood", "release_date": "1985-06-01", "page_count": 311} } },
+      { index: { _index: index, data: {name: "Starship Troopers", "author": "Robert A. Heinlein", "release_date": "1959-12-01", "page_count": 335} } },
+      { index: { _index: index, data: {name: "The Left Hand of Darkness", "author": "Ursula K. Le Guin", "release_date": "1969-06-01", "page_count": 304} } },
+      { index: { _index: index, data: {name: "The Moon is a Harsh Mistress", "author": "Robert A. Heinlein", "release_date": "1966-04-01", "page_count": 288 } } }
+    ]
+    client.bulk(body: documents, refresh: 'wait_for')
+  end
+
+  after do
+    client.indices.delete(index: index)
+  end
+
+  it 'instantiates a scroll helper' do
+    expect(scroll_helper).to be_an_instance_of Elasticsearch::Helpers::ScrollHelper
+  end
+
+  it 'searches an index' do
+    my_documents = []
+    while !(documents = scroll_helper.results).empty?
+      my_documents << documents
+    end
+
+    expect(my_documents.flatten.size).to eq 24
+  end
+
+  it 'uses enumerable' do
+    count = 0
+    scroll_helper.each { |a| count += 1 }
+    expect(count).to eq 24
+    expect(scroll_helper).to respond_to(:count)
+    expect(scroll_helper).to respond_to(:reject)
+    expect(scroll_helper).to respond_to(:uniq)
+    expect(scroll_helper.map { |a| a['_id'] }.uniq.count).to eq 24
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,31 @@
+# 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 'elasticsearch'
+require 'rspec'
+
+RSpec.configure do |config|
+  config.formatter = :documentation
+end
+
+def meta_version
+  client.send(:client_meta_version, Elasticsearch::VERSION)
+end
+
+def jruby?
+  defined?(JRUBY_VERSION)
+end

data/spec/unit/api_key_spec.rb

@@ -0,0 +1,137 @@
+# 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
+  context 'when using API Key' do
+    let(:authorization_header) do
+      client.transport.connections.first.connection.headers['Authorization']
+    end
+
+    context 'when an encoded api_key is provided' do
+      let(:client) do
+        described_class.new(api_key: 'an_api_key')
+      end
+
+      it 'Adds the ApiKey header to the connection' do
+        expect(authorization_header).to eq('ApiKey an_api_key')
+      end
+    end
+
+    context 'when an un-encoded api_key is provided' do
+      let(:client) do
+        described_class.new(api_key: { id: 'my_id', api_key: 'my_api_key' })
+      end
+
+      it 'Adds the ApiKey header to the connection' do
+        expect(authorization_header).to eq("ApiKey #{Base64.strict_encode64('my_id:my_api_key')}")
+      end
+    end
+
+    context 'when basic auth and api_key are provided' do
+      let(:client) do
+        described_class.new(
+          api_key: { id: 'my_id', api_key: 'my_api_key' },
+          host: 'http://elastic:password@localhost:9200'
+        )
+      end
+
+      it 'removes basic auth credentials' do
+        expect(authorization_header).not_to match(/^Basic/)
+        expect(authorization_header).to match(/^ApiKey/)
+      end
+    end
+
+    context 'when other headers were specified' do
+      let(:client) do
+        described_class.new(
+          api_key: 'elasticsearch_api_key',
+          transport_options: { headers: { 'x-test-header' => 'test' } }
+        )
+      end
+
+      it 'Adds the ApiKey header to the connection and keeps the header' do
+        header = client.transport.connections.first.connection.headers
+        expect(header['Authorization']).to eq('ApiKey elasticsearch_api_key')
+        expect(header['X-Test-Header']).to eq('test')
+      end
+    end
+
+    context 'when sending transport_options but no headers were specified' do
+      let(:client) do
+        described_class.new(
+          api_key: 'elasticsearch_api_key',
+          transport_options: { ssl: { verify: false } }
+        )
+      end
+
+      it 'Adds the ApiKey header to the connection and keeps the options' do
+        header = client.transport.connections.first.connection.headers
+        expect(header['Authorization']).to eq('ApiKey elasticsearch_api_key')
+        expect(client.transport.options[:transport_options]).to include({ ssl: { verify: false } })
+        expect(client.transport.options[:transport_options][:headers]).to include('Authorization' => 'ApiKey elasticsearch_api_key')
+      end
+    end
+
+    context 'when other headers and options were specified' do
+      let(:client) do
+        described_class.new(
+          api_key: 'elasticsearch_api_key',
+          transport_options: {
+            headers: { 'x-test-header' => 'test' },
+            ssl: { verify: false }
+          }
+        )
+      end
+
+      it 'Adds the ApiKey header to the connection and keeps the header' do
+        header = client.transport.connections.first.connection.headers
+        expect(header['X-Test-Header']).to eq('test')
+        expect(header['Authorization']).to eq('ApiKey elasticsearch_api_key')
+        expect(client.transport.options[:transport_options]).to include({ ssl: { verify: false } })
+        expect(client.transport.options[:transport_options][:headers]).to include('Authorization' => 'ApiKey elasticsearch_api_key')
+      end
+    end
+
+    context 'Metaheader' do
+      let(:adapter_code) { "nh=#{defined?(Net::HTTP::VERSION) ? Net::HTTP::VERSION : Net::HTTP::HTTPVersion}" }
+      let(:meta_header) do
+        if jruby?
+          "es=#{meta_version},rb=#{RUBY_VERSION},t=#{Elastic::Transport::VERSION},jv=#{ENV_JAVA['java.version']},jr=#{JRUBY_VERSION},fd=#{Faraday::VERSION},#{adapter_code}"
+        else
+          "es=#{meta_version},rb=#{RUBY_VERSION},t=#{Elastic::Transport::VERSION},fd=#{Faraday::VERSION},#{adapter_code}"
+        end
+      end
+
+      context 'when using API Key' do
+        let(:client) do
+          described_class.new(api_key: 'an_api_key')
+        end
+
+        let(:headers) do
+          client.transport.connections.first.connection.headers
+        end
+
+        it 'adds the ApiKey header to the connection' do
+          expect(authorization_header).to eq('ApiKey an_api_key')
+          expect(headers).to include('x-elastic-client-meta' => meta_header)
+        end
+      end
+    end
+  end
+end

data/spec/unit/cloud_credentials_spec.rb

@@ -0,0 +1,167 @@
+# 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
+  context 'when cloud credentials are provided' do
+    let(:client) do
+      described_class.new(
+        cloud_id: 'name:bG9jYWxob3N0JGFiY2QkZWZnaA==',
+        user: 'elastic',
+        password: 'changeme'
+      )
+    end
+
+    let(:hosts) do
+      client.transport.hosts
+    end
+
+    it 'extracts the cloud credentials' do
+      expect(hosts[0][:host]).to eq('abcd.localhost')
+      expect(hosts[0][:protocol]).to eq('https')
+      expect(hosts[0][:user]).to eq('elastic')
+      expect(hosts[0][:password]).to eq('changeme')
+      expect(hosts[0][:port]).to eq(443)
+    end
+
+    it 'creates the correct full url' do
+      expect(
+        client.transport.__full_url(client.transport.hosts[0])
+      ).to eq('https://elastic:changeme@abcd.localhost:443')
+    end
+
+    context 'when a port is specified' do
+      let(:client) do
+        described_class.new(cloud_id: 'name:bG9jYWxob3N0JGFiY2QkZWZnaA==', user: 'elastic', password: 'changeme', port: 9250)
+      end
+
+      it 'sets the specified port along with the cloud credentials' do
+        expect(hosts[0][:host]).to eq('abcd.localhost')
+        expect(hosts[0][:protocol]).to eq('https')
+        expect(hosts[0][:user]).to eq('elastic')
+        expect(hosts[0][:password]).to eq('changeme')
+        expect(hosts[0][:port]).to eq(9250)
+      end
+
+      it 'creates the correct full url' do
+        expect(client.transport.__full_url(client.transport.hosts[0])).to eq('https://elastic:changeme@abcd.localhost:9250')
+      end
+    end
+
+    context 'when the cluster has alternate names' do
+      let(:client) do
+        described_class.new(
+          cloud_id: 'myCluster:bG9jYWxob3N0JGFiY2QkZWZnaA==',
+          user: 'elasticfantastic',
+          password: 'tobechanged'
+        )
+      end
+
+      let(:hosts) do
+        client.transport.hosts
+      end
+
+      it 'extracts the cloud credentials' do
+        expect(hosts[0][:host]).to eq('abcd.localhost')
+        expect(hosts[0][:protocol]).to eq('https')
+        expect(hosts[0][:user]).to eq('elasticfantastic')
+        expect(hosts[0][:password]).to eq('tobechanged')
+        expect(hosts[0][:port]).to eq(443)
+      end
+
+      it 'creates the correct full url' do
+        expect(
+          client.transport.__full_url(client.transport.hosts[0])
+        ).to eq('https://elasticfantastic:tobechanged@abcd.localhost:443')
+      end
+    end
+
+    context 'when decoded cloud id has a trailing dollar sign' do
+      let(:client) do
+        described_class.new(
+          cloud_id: 'a_cluster:bG9jYWxob3N0JGFiY2Qk',
+          user: 'elasticfantastic',
+          password: 'changeme'
+        )
+      end
+
+      let(:hosts) do
+        client.transport.hosts
+      end
+
+      it 'extracts the cloud credentials' do
+        expect(hosts[0][:host]).to eq('abcd.localhost')
+        expect(hosts[0][:protocol]).to eq('https')
+        expect(hosts[0][:user]).to eq('elasticfantastic')
+        expect(hosts[0][:password]).to eq('changeme')
+        expect(hosts[0][:port]).to eq(443)
+      end
+
+      it 'creates the correct full url' do
+        expect(
+          client.transport.__full_url(client.transport.hosts[0])
+        ).to eq('https://elasticfantastic:changeme@abcd.localhost:443')
+      end
+    end
+
+    context 'when the cloud host provides a port' do
+      let(:client) do
+        described_class.new(
+          cloud_id: 'name:ZWxhc3RpY19zZXJ2ZXI6OTI0MyRlbGFzdGljX2lk',
+          user: 'elastic',
+          password: 'changeme'
+        )
+      end
+
+      let(:hosts) do
+        client.transport.hosts
+      end
+
+      it 'creates the correct full url' do
+        expect(hosts[0][:host]).to eq('elastic_id.elastic_server')
+        expect(hosts[0][:protocol]).to eq('https')
+        expect(hosts[0][:user]).to eq('elastic')
+        expect(hosts[0][:password]).to eq('changeme')
+        expect(hosts[0][:port]).to eq(9243)
+      end
+    end
+
+    context 'when the cloud host provides a port and the port is also specified' do
+      let(:client) do
+        described_class.new(
+          cloud_id: 'name:ZWxhc3RpY19zZXJ2ZXI6OTI0MyRlbGFzdGljX2lk',
+          user: 'elastic',
+          password: 'changeme',
+          port: 9200
+        )
+      end
+
+      let(:hosts) do
+        client.transport.hosts
+      end
+
+      it 'creates the correct full url' do
+        expect(hosts[0][:host]).to eq('elastic_id.elastic_server')
+        expect(hosts[0][:protocol]).to eq('https')
+        expect(hosts[0][:user]).to eq('elastic')
+        expect(hosts[0][:password]).to eq('changeme')
+        expect(hosts[0][:port]).to eq(9243)
+      end
+    end
+  end
+end

data/spec/unit/custom_transport_implementation_spec.rb

@@ -0,0 +1,43 @@
+# 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
+  context 'when using custom transport implementation' do
+    class MyTransport
+      include Elastic::Transport::Transport::Base
+      def initialize(args); end
+    end
+    let(:client) { Elasticsearch::Client.new(transport_class: MyTransport) }
+    let(:arguments) { client.instance_variable_get('@transport').instance_variable_get('@arguments') }
+    let(:subject) do
+      arguments[:transport_options][:headers]
+    end
+
+    let(:meta_header) do
+      if jruby?
+        "es=#{meta_version},rb=#{RUBY_VERSION},t=#{Elastic::Transport::VERSION},jv=#{ENV_JAVA['java.version']},jr=#{JRUBY_VERSION}"
+      else
+        "es=#{meta_version},rb=#{RUBY_VERSION},t=#{Elastic::Transport::VERSION}"
+      end
+    end
+
+    it 'doesnae set any info about the implementation in the metaheader' do
+      expect(subject).to include('x-elastic-client-meta' => meta_header)
+    end
+  end
+end

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)
+    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