API-Key: Initial work to support Api Key Authentication

Author: picandocodigo

elasticsearch-transport/lib/elasticsearch/transport/client.rb

@@ -109,6 +109,13 @@ def initialize(arguments={}, &block)
 
         @send_get_body_as = @arguments[:send_get_body_as] || 'GET'
 
+        if (api_key = @arguments[:api_key])
+          api_key = __encode(api_key) if api_key.is_a? Hash
+          @arguments[:transport_options].merge!(
+            headers: { 'Authorization' => "ApiKey #{api_key}" }
+          )
+        end
+
         if @arguments[:request_timeout]
           @arguments[:transport_options][:request] = { :timeout => @arguments[:request_timeout] }
         end
@@ -232,6 +239,13 @@ def __auto_detect_adapter
           ::Faraday.default_adapter
         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.encode64([api_key[:id], api_key[:api_key]].join(':'))
+      end
     end
   end
 end

elasticsearch-transport/spec/elasticsearch/transport/client_spec.rb

@@ -45,6 +45,28 @@
     expect(client.transport.hosts[0][:host]).to eq('localhost')
   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(client.transport.connections.first.connection.headers['Authorization']).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(
+        client.transport.connections.first.connection.headers['Authorization']
+      ).to eq("ApiKey #{Base64.encode64('my_id:my_api_key')}")
+    end
+  end
+
   describe 'adapter' do
 
     context 'when no adapter is specified' do