elasticsearch 7.14.0 → 8.0.0.pre1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 716743889b9b5e25022814cceb17d97ac242891c91ca86f8de4dd77003ee8e13
-  data.tar.gz: e11579ee6907a87f131b689979e6c35df9079177bbf7df0419370c2294f8d86b
+  metadata.gz: ca479af01bac2b0dd8b654294c63f0f1bc675cd69036f9704ae9fd1b22684546
+  data.tar.gz: c2252be5532689f299dfb3084215beab37a797358d41cc355e74fa820c63cf42
 SHA512:
-  metadata.gz: 53f6244770f02a67315852e6d67cab6f13f6b7ce72ea8c60a93caf2a4ddc47eeb4764ca2fd65cc74413cb4f90f0f1f1792697f874dd0bffa754c9bd1c8fa1cb6
-  data.tar.gz: daac32d9daac91a0353bbe73ccdbdee5fdb47a39b41f63c4b2fbd50fa532ee1f5771b371053c417e968f98a6e44bbb55da79f09dd1e4f6ad63d5f9b7145b46fc
+  metadata.gz: 27abb64b012188c2dd762c4e1a856dd84a80624a7d2c478b55ed84ab7cde54952c507847ac52a13c5c9170c9bfce5114ca4174c0ac5ae0d05fe234bd7a8a8f8a
+  data.tar.gz: 1f4a3e1ef357eba8709fe91a24c0d677835b40586232427c62372c0ce2a45b707cce51c02618235cdaf44567a408ab30c7da5e4172ef6010cdb6a20f9b57fdf1

data/Gemfile

@@ -1,3 +1,5 @@
+# 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
@@ -20,14 +22,6 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in elasticsearch.gemspec
 gemspec
 
-if File.exist? File.expand_path("../../elasticsearch-api/elasticsearch-api.gemspec", __FILE__)
-  gem 'elasticsearch-api', :path => File.expand_path("../../elasticsearch-api", __FILE__), :require => false
-end
-
-if File.exist? File.expand_path("../../elasticsearch-transport/elasticsearch-transport.gemspec", __FILE__)
-  gem 'elasticsearch-transport', :path => File.expand_path("../../elasticsearch-transport", __FILE__), :require => false
-end
-
-if File.exist? File.expand_path("../../elasticsearch-extensions", __FILE__)
-  gem 'elasticsearch-extensions', :path => File.expand_path("../../elasticsearch-extensions", __FILE__), :require => true
+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

data/README.md

@@ -2,6 +2,29 @@
 
 The `elasticsearch` library provides a Ruby client and API for [Elasticsearch](http://elasticsearch.com).
 
+## Usage
+
+This gem is a wrapper for two separate libraries:
+
+* [`elasticsearch-transport`](https://github.com/elasticsearch/elasticsearch-ruby/tree/main/elasticsearch-transport), which provides a low-level Ruby client for connecting to [Elastic](http://elasticsearch.com) services.
+* [`elasticsearch-api`](https://github.com/elasticsearch/elasticsearch-ruby/tree/main/elasticsearch-api), which provides a Ruby API for the Elasticsearch RESTful API.
+
+Install the `elasticsearch` package and use the API directly:
+
+```ruby
+require 'elasticsearch'
+
+client = Elasticsearch::Client.new(log: true)
+
+client.cluster.health
+
+client.transport.reload_connections!
+
+client.search(q: 'test')
+
+# etc.
+```
+
 Features overview:
 
 * Pluggable logging and tracing
@@ -14,25 +37,13 @@ Features overview:
 * Extensive documentation and examples
 * Emphasis on modularity and extendability of both the client and API libraries
 
-(For integration with Ruby models and Rails applications,
-see the <https://github.com/elasticsearch/elasticsearch-rails> project.)
+(For integration with Ruby models and Rails applications, see the <https://github.com/elasticsearch/elasticsearch-rails> project.)
 
 ## Compatibility
 
-The Elasticsearch client for Ruby is compatible with Ruby 1.9 and higher.
+We follow Ruby’s own maintenance policy and officially support all currently maintained versions per [Ruby Maintenance Branches](https://www.ruby-lang.org/en/downloads/branches/).
 
-The client's API is compatible with Elasticsearch's API versions from 0.90 till current,
-just use a release matching major version of Elasticsearch.
-
-| Ruby          |   | Elasticsearch |
-|:-------------:|:-:| :-----------: |
-| 0.90          | → | 0.90          |
-| 1.x           | → | 1.x           |
-| 2.x           | → | 2.x           |
-| 5.x           | → | 5.x           |
-| 6.x           | → | 6.x           |
-| 7.x           | → | 7.x           |
-| master        | → | master        |
+Language clients are forward compatible; meaning that clients support communicating with greater minor versions of Elasticsearch. Elastic language clients are also backwards compatible with lesser supported minor Elasticsearch versions.
 
 ## Installation
 
@@ -51,45 +62,73 @@ or install it from a source code checkout:
     bundle install
     rake install
 
-## Usage
+## Configuration
 
-This library is a wrapper for two separate libraries:
+* [Identifying running tasks with X-Opaque-Id](#identifying-running-tasks-with-x-opaque-id)
+* [Api Key Authentication](#api-key-authentication)
 
-* [`elasticsearch-transport`](https://github.com/elasticsearch/elasticsearch-ruby/tree/master/elasticsearch-transport),
-  which provides a low-level Ruby client for connecting to an [Elasticsearch](http://elasticsearch.com) cluster
-* [`elasticsearch-api`](https://github.com/elasticsearch/elasticsearch-ruby/tree/master/elasticsearch-api),
-  which provides a Ruby API for the Elasticsearch RESTful API
+### Identifying running tasks with X-Opaque-Id
 
-Install the `elasticsearch` package and use the API directly:
+The X-Opaque-Id header allows to track certain calls, or associate certain tasks with the client that started them ([more on the Elasticsearch docs](https://www.elastic.co/guide/en/elasticsearch/reference/master/tasks.html#_identifying_running_tasks)). To use this feature, you need to set an id for `opaque_id` on the client on each request. Example:
 
 ```ruby
-require 'elasticsearch'
+client = Elasticsearch::Client.new
+client.search(index: 'myindex', q: 'title:test', opaque_id: '123456')
+```
+The search request will include the following HTTP Header:
+```
+X-Opaque-Id: 123456
+```
+
+You can also 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. Example:
+```ruby
+client = Elastic::Transport::Client.new(opaque_id_prefix: 'eu-west1_')
+client.search(index: 'myindex', q: 'title:test', opaque_id: '123456')
+```
+The request will include the following HTTP Header:
+```
+X-Opaque-Id: eu-west1_123456
+```
 
-client = Elasticsearch::Client.new log: true
+### Api Key Authentication
 
-client.cluster.health
+You can use [**API Key authentication**](https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-create-api-key.html):
 
-client.transport.reload_connections!
+``` ruby
+Elasticsearch::Client.new(
+  host: host,
+  transport_options: transport_options,
+  api_key: credentials
+)
+```
 
-client.search q: 'test'
+Where credentials is either the base64 encoding of `id` and `api_key` joined by a colon or a hash with the `id` and `api_key`:
 
-# etc.
+``` ruby
+Elasticsearch::Client.new(
+  host: host,
+  transport_options: transport_options,
+  api_key: {id: 'my_id', api_key: 'my_api_key'}
+)
 ```
 
+## API and Transport
+
 Please refer to the specific library documentation for details:
 
 * **Transport**:
-   [[README]](https://github.com/elasticsearch/elasticsearch-ruby/blob/master/elasticsearch-transport/README.md)
+   [[README]](https://github.com/elasticsearch/elasticsearch-ruby/blob/main/elasticsearch-transport/README.md)
    [[Documentation]](http://rubydoc.info/gems/elasticsearch-transport/file/README.markdown)
 
 * **API**:
-   [[README]](https://github.com/elasticsearch/elasticsearch-ruby/blob/master/elasticsearch-api/README.md)
+   [[README]](https://github.com/elasticsearch/elasticsearch-ruby/blob/main/elasticsearch-api/README.md)
    [[Documentation]](http://rubydoc.info/gems/elasticsearch-api/file/README.markdown)
 
+
 ## Development
 
 You can run `rake -T` to check the test tasks. Use `COVERAGE=true` before running a test task to check the coverage with Simplecov.
 
 ## License
 
-This software is licensed under the [Apache 2 license](./LICENSE).
+This software is licensed under the [Apache 2 license](./LICENSE).

data/bin/elastic_ruby_console

@@ -1,17 +1,14 @@
 #!/usr/bin/env ruby
 
 $LOAD_PATH.unshift(File.expand_path('../../elasticsearch/lib', __dir__))
-$LOAD_PATH.unshift(File.expand_path('../../elasticsearch-transport/lib', __dir__))
 $LOAD_PATH.unshift(File.expand_path('../../elasticsearch-dsl/lib', __dir__))
 $LOAD_PATH.unshift(File.expand_path('../../elasticsearch-api/lib', __dir__))
-$LOAD_PATH.unshift(File.expand_path('../../elasticsearch-xpack/lib', __dir__))
-$LOAD_PATH.unshift(File.expand_path('../../elasticsearch-extensions/lib', __dir__))
 
 require 'elasticsearch'
-require 'elasticsearch-transport'
 require 'elasticsearch-api'
+require 'elasticsearch-dsl'
 
-gems_not_loaded = ['elasticsearch-dsl', 'elasticsearch/xpack', 'elasticsearch-extensions'].reject do |gem|
+gems_not_loaded = ['elasticsearch-dsl'].reject do |gem|
   begin
     (require gem) || true
   rescue LoadError

data/elasticsearch.gemspec

@@ -25,33 +25,33 @@ Gem::Specification.new do |s|
   s.authors       = ['Karel Minarik']
   s.email         = ['karel.minarik@elasticsearch.org']
   s.summary       = 'Ruby integrations for Elasticsearch'
-  s.homepage      = 'https://www.elastic.co/guide/en/elasticsearch/client/ruby-api/7.x/index.html'
+  s.homepage      = 'https://www.elastic.co/guide/en/elasticsearch/client/ruby-api/current/index.html'
   s.license       = 'Apache-2.0'
   s.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'
   }
-  s.files         = `git ls-files`.split($/)
-  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.files = `git ls-files`.split($/)
+  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' ]
-  s.rdoc_options      = [ '--charset=UTF-8' ]
+  s.extra_rdoc_files  = ['README.md', 'LICENSE.txt']
+  s.rdoc_options      = ['--charset=UTF-8']
 
-  s.required_ruby_version = '>= 2.4'
+  s.required_ruby_version = '>= 2.5'
 
-  s.add_dependency 'elasticsearch-transport', '7.14.0'
-  s.add_dependency 'elasticsearch-api',       '7.14.0'
+  s.add_dependency 'elastic-transport', '8.0.0.pre2'
+  s.add_dependency 'elasticsearch-api', '8.0.0.pre1'
 
   s.add_development_dependency 'bundler'
   s.add_development_dependency 'byebug' unless defined?(JRUBY_VERSION) || defined?(Rubinius)
   s.add_development_dependency 'pry'
-  s.add_development_dependency 'rake', '~> 13'
+  s.add_development_dependency 'rake'
   s.add_development_dependency 'require-prof' unless defined?(JRUBY_VERSION) || defined?(Rubinius)
   s.add_development_dependency 'rspec'
   s.add_development_dependency 'ruby-prof' unless defined?(JRUBY_VERSION) || defined?(Rubinius)

data/lib/elasticsearch/version.rb

@@ -16,5 +16,5 @@
 # under the License.
 
 module Elasticsearch
-  VERSION = '7.14.0'.freeze
+  VERSION = '8.0.0.pre1'.freeze
 end

data/lib/elasticsearch.rb

@@ -16,41 +16,76 @@
 # under the License.
 
 require 'elasticsearch/version'
-require 'elasticsearch/transport'
+require 'elastic/transport'
 require 'elasticsearch/api'
 
 module Elasticsearch
-  SECURITY_PRIVILEGES_VALIDATION_WARNING = 'The client is unable to verify that the server is Elasticsearch due to security privileges on the server side. Some functionality may not be compatible if the server is running an unsupported product.'.freeze
   NOT_ELASTICSEARCH_WARNING = 'The client noticed that the server is not Elasticsearch and we do not support this unknown product.'.freeze
-  NOT_SUPPORTED_ELASTICSEARCH_WARNING = 'The client noticed that the server is not a supported distribution of Elasticsearch.'.freeze
-  YOU_KNOW_FOR_SEARCH = 'You Know, for Search'.freeze
+  SECURITY_PRIVILEGES_VALIDATION_WARNING = 'The client is unable to verify that the server is Elasticsearch due to security privileges on the server side. Some functionality may not be compatible if the server is running an unsupported product.'.freeze
 
+  # This is the stateful Elasticsearch::Client, using an instance of elastic-transport.
   class Client
     include Elasticsearch::API
-    attr_accessor :transport
-
-    # See Elasticsearch::Transport::Client for initializer parameters
+    # The default port to use if connecting using a Cloud ID.
+    # Updated from 9243 to 443 in client version 7.10.1
+    #
+    # @since 7.2.0
+    DEFAULT_CLOUD_PORT = 443
+
+    # Create a client connected to an Elasticsearch cluster.
+    #
+    # @option arguments [String] :cloud_id - The Cloud ID to connect to Elastic Cloud
+    # @option api_key [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 opaque_id_prefix [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
     def initialize(arguments = {}, &block)
       @verified = false
-      @transport = Elasticsearch::Transport::Client.new(arguments, &block)
+      @opaque_id_prefix = arguments[:opaque_id_prefix] || nil
+      api_key(arguments) if arguments[:api_key]
+      if arguments[:cloud_id]
+        arguments[:hosts] = setup_cloud_host(
+          arguments[:cloud_id],
+          arguments[:user],
+          arguments[:password],
+          arguments[:port]
+        )
+      end
+      @transport = Elastic::Transport::Client.new(arguments, &block)
     end
 
     def method_missing(name, *args, &block)
-      if name == :perform_request
-        verify_elasticsearch unless @verified
-        @transport.perform_request(*args, &block)
-      else
+      if methods.include?(name)
         super
+      elsif name == :perform_request
+        # The signature for perform_request is:
+        # method, path, params, body, headers
+        if (opaque_id = args[2]&.delete(:opaque_id))
+          headers = args[4] || {}
+          opaque_id = @opaque_id_prefix ? "#{@opaque_id_prefix}#{opaque_id}" : opaque_id
+          args[4] = headers.merge('X-Opaque-Id' => opaque_id)
+        end
+        if name == :perform_request
+          verify_elasticsearch unless @verified
+          @transport.perform_request(*args, &block)
+        end
+      else
+        @transport.send(name, *args, &block)
       end
     end
 
+    def respond_to_missing?(method_name, *args)
+      @transport.respond_to?(method_name) || super
+    end
+
     private
 
     def verify_elasticsearch
       begin
         response = elasticsearch_validation_request
-      rescue Elasticsearch::Transport::Transport::Errors::Unauthorized,
-             Elasticsearch::Transport::Transport::Errors::Forbidden
+      rescue Elastic::Transport::Transport::Errors::Unauthorized,
+             Elastic::Transport::Transport::Errors::Forbidden
         @verified = true
         warn(SECURITY_PRIVILEGES_VALIDATION_WARNING)
         return
@@ -63,36 +98,65 @@ module Elasticsearch
                response.body
              end
       version = body.dig('version', 'number')
-      verify_with_version_or_header(body, version, response.headers)
+      verify_with_version_or_header(version, response.headers)
     end
 
-    def verify_with_version_or_header(body, version, headers)
-      raise Elasticsearch::UnsupportedProductError if version.nil? || version < '6.0.0'
+    def verify_with_version_or_header(version, headers)
+      if version.nil? ||
+         Gem::Version.new(version) < Gem::Version.new('8.0.0.pre') && version != '8.0.0-SNAPSHOT' ||
+         headers['x-elastic-product'] != 'Elasticsearch'
 
-      if version == '7.x-SNAPSHOT' || Gem::Version.new(version) >= Gem::Version.new('7.14-SNAPSHOT')
-        raise Elasticsearch::UnsupportedProductError unless headers['x-elastic-product'] == 'Elasticsearch'
+        raise Elasticsearch::UnsupportedProductError
+      end
 
-        @verified = true
-      elsif Gem::Version.new(version) > Gem::Version.new('6.0.0') &&
-            Gem::Version.new(version) < Gem::Version.new('7.0.0')
-        raise Elasticsearch::UnsupportedProductError unless
-          body['tagline'] == YOU_KNOW_FOR_SEARCH
+      @verified = true
+    end
 
-        @verified = true
-      elsif Gem::Version.new(version) >= Gem::Version.new('7.0.0') &&
-            Gem::Version.new(version) < Gem::Version.new('7.14-SNAPSHOT')
-        raise Elasticsearch::UnsupportedProductError unless body['tagline'] == YOU_KNOW_FOR_SEARCH
-        raise Elasticsearch::UnsupportedProductError.new(NOT_SUPPORTED_ELASTICSEARCH_WARNING) unless body.dig('version', 'build_flavor') == 'default'
+    def setup_cloud_host(cloud_id, user, password, port)
+      name = cloud_id.split(':')[0]
+      cloud_url, elasticsearch_instance = Base64.decode64(cloud_id.gsub("#{name}:", '')).split('$')
 
-        @verified = true
+      if cloud_url.include?(':')
+        url, port = cloud_url.split(':')
+        host = "#{elasticsearch_instance}.#{url}"
+      else
+        host = "#{elasticsearch_instance}.#{cloud_url}"
+        port ||= DEFAULT_CLOUD_PORT
+      end
+      [{ scheme: 'https', user: user, password: password, host: host, port: port.to_i }]
+    end
+
+    def api_key(arguments)
+      api_key = if arguments[:api_key].is_a? Hash
+                  encode(arguments[:api_key])
+                else
+                  arguments[:api_key]
+                end
+      arguments.delete(:user)
+      arguments.delete(:password)
+      authorization = { 'Authorization' => "ApiKey #{api_key}" }
+      if (headers = arguments.dig(:transport_options, :headers))
+        headers.merge!(authorization)
+      else
+        arguments[:transport_options] = {
+          headers: authorization
+        }
       end
     end
 
+    # Encode credentials for the Authorization Header
+    # Credentials is the base64 encoding of id and api_key joined by a colon
+    # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-create-api-key.html
+    def encode(api_key)
+      Base64.strict_encode64([api_key[:id], api_key[:api_key]].join(':'))
+    end
+
     def elasticsearch_validation_request
       @transport.perform_request('GET', '/')
     end
   end
 
+  # Error class for when we detect an unsupported version of Elasticsearch
   class UnsupportedProductError < StandardError
     def initialize(message = NOT_ELASTICSEARCH_WARNING)
       super(message)
@@ -100,6 +164,7 @@ module Elasticsearch
   end
 end
 
+# Helper for the meta-header value for Cloud
 module Elastic
   # If the version is X.X.X.pre/alpha/beta, use X.X.Xp for the meta-header:
   def self.client_meta_version
@@ -110,6 +175,6 @@ module Elastic
     Elasticsearch::VERSION
   end
 
-  # Constant for elasticsearch-transport meta-header
+  # Constant for elastic-transport meta-header
   ELASTICSEARCH_SERVICE_VERSION = [:es, client_meta_version].freeze
 end

data/spec/integration/client_integration_spec.rb

@@ -14,6 +14,9 @@
 # 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'
 
@@ -23,7 +26,9 @@ context 'Elasticsearch client' do
   let(:client) do
     Elasticsearch::Client.new(
       host: ELASTICSEARCH_URL,
-      logger: logger
+      logger: logger,
+      user: 'elastic',
+      password: 'changeme'
     )
   end
 
@@ -49,9 +54,10 @@ context 'Elasticsearch client' do
   end
 
   context 'Reports the right meta header' do
-    it 'Reports es service name and gem version' do
-      headers = client.transport.transport.connections.first.connection.headers
-      expect(headers['x-elastic-client-meta']).to match /^es=#{Elasticsearch::VERSION}/
+    it 'Reports es service name and gem versio' 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

data/spec/spec_helper.rb

@@ -18,9 +18,14 @@
 require 'elasticsearch'
 require 'rspec'
 
-ELASTICSEARCH_URL = ENV['TEST_ES_SERVER'] || "http://localhost:#{(ENV['PORT'] || 9200)}"
-raise URI::InvalidURIError unless ELASTICSEARCH_URL =~ /\A#{URI::DEFAULT_PARSER.make_regexp}\z/
-
 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,101 @@
+# 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 where 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 '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