elasticsearch-transport 6.1.0 → 6.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: e353dc91e242f5da6770f9bb54d045e73d891406
-  data.tar.gz: d68e53725c17871ca4dd102b3d0862bc760416d7
+SHA256:
+  metadata.gz: a8e4aede9b2a47e14f9913330cb6278300282e8817474f51cee80a35f2f95c29
+  data.tar.gz: 1be5538c84ddd5f6b293787ec3b4c779e001c8d19750b83fdff248e67e4cdcd3
 SHA512:
-  metadata.gz: 7ff356b55062d3fad230f9849c7416f1450c29e0a5772e7a013351f2fdbdc978adeba64c1ade75d998988f1d81e1dac7a72d5ba017fb6d56eec7639f2d3cea77
-  data.tar.gz: 56cbe39365f0aa8ad13a6ff4bc2be0e7fe5b90d77033f16d9772d7794178ebd50d197b05ab325d05259907d68dc9c2b010c1ccce88c057e3ef460ec80cf5c6b2
+  metadata.gz: af707cc9d8e3675a41bf0e3daa4624c1370047a1ef8f2d10437887744a78329875eb7115d67d05285c51e3301c1f043524b0d8e113eedb6346bd534e9bbcaadf
+  data.tar.gz: 451c56226dce076295231890873aac3d10cc27e5de816183b7bdf87c0891f2f40f34f35ea3e51b6609429994d243e3caae265b036464c31131882ac1378d5de4

data/Gemfile

@@ -14,3 +14,8 @@ end
 if File.exist? File.expand_path("../../elasticsearch/elasticsearch.gemspec", __FILE__)
   gem 'elasticsearch', :path => File.expand_path("../../elasticsearch", __FILE__), :require => false
 end
+
+group :development do
+  gem 'rspec'
+  gem 'pry-nav'
+end

data/Rakefile

@@ -7,7 +7,17 @@ task :test    => 'test:unit'
 # ----- Test tasks ------------------------------------------------------------
 
 require 'rake/testtask'
+require 'rspec/core/rake_task'
+
 namespace :test do
+
+  RSpec::Core::RakeTask.new(:spec)
+
+  desc "Wait for Elasticsearch to be in a green state"
+  task :wait_for_green do
+    sh '../scripts/wait-cluster.sh'
+  end
+
   Rake::TestTask.new(:unit) do |test|
     test.libs << 'lib' << 'test'
     test.test_files = FileList["test/unit/**/*_test.rb"]
@@ -18,13 +28,13 @@ namespace :test do
   Rake::TestTask.new(:integration) do |test|
     test.libs << 'lib' << 'test'
     test.test_files = FileList["test/integration/**/*_test.rb"]
+    test.deps = [ :wait_for_green, :spec ]
     test.verbose = false
     test.warning = false
   end
 
   Rake::TestTask.new(:all) do |test|
-    test.libs << 'lib' << 'test'
-    test.test_files = FileList["test/unit/**/*_test.rb", "test/integration/**/*_test.rb"]
+    test.deps = [ :unit, :integration ]
   end
 
   Rake::TestTask.new(:profile) do |test|

data/elasticsearch-transport.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |s|
   s.email         = ["karel.minarik@elasticsearch.org"]
   s.summary       = "Ruby client for Elasticsearch."
   s.homepage      = "https://github.com/elasticsearch/elasticsearch-ruby/tree/master/elasticsearch-transport"
-  s.license       = "Apache 2"
+  s.license       = "Apache-2.0"
 
   s.files         = `git ls-files`.split($/)
   s.executables   = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
@@ -29,7 +29,7 @@ Gem::Specification.new do |s|
     s.add_dependency "system_timer"
   end
 
-  s.add_development_dependency "bundler", "> 1"
+  s.add_development_dependency "bundler"
 
   if defined?(RUBY_VERSION) && RUBY_VERSION > '1.9'
     s.add_development_dependency "rake", "~> 11.1"

data/lib/elasticsearch/transport.rb

@@ -14,6 +14,7 @@ require "elasticsearch/transport/transport/connections/connection"
 require "elasticsearch/transport/transport/connections/collection"
 require "elasticsearch/transport/transport/http/faraday"
 require "elasticsearch/transport/client"
+require "elasticsearch/transport/redacted"
 
 require "elasticsearch/transport/version"
 

data/lib/elasticsearch/transport/client.rb

@@ -24,6 +24,11 @@ module Elasticsearch
         logger
       end
 
+      # The default host and port to use if not otherwise specified.
+      #
+      # @since 7.0.0
+      DEFAULT_HOST = 'localhost:9200'.freeze
+
       # Returns the transport object.
       #
       # @see Elasticsearch::Transport::Transport::Base
@@ -83,14 +88,8 @@ module Elasticsearch
       # @yield [faraday] Access and configure the `Faraday::Connection` instance directly with a block
       #
       def initialize(arguments={}, &block)
+        @options = arguments
         @arguments = arguments
-
-        hosts = @arguments[:hosts] || \
-                @arguments[:host]  || \
-                @arguments[:url]   || \
-                @arguments[:urls]  || \
-                ENV.fetch('ELASTICSEARCH_URL', 'localhost:9200')
-
         @arguments[:logger] ||= @arguments[:log]   ? DEFAULT_LOGGER.call() : nil
         @arguments[:tracer] ||= @arguments[:trace] ? DEFAULT_TRACER.call() : nil
         @arguments[:reload_connections] ||= false
@@ -99,26 +98,40 @@ module Elasticsearch
         @arguments[:randomize_hosts]    ||= false
         @arguments[:transport_options]  ||= {}
         @arguments[:http]               ||= {}
+        @options[:http]               ||= {}
 
-        @arguments[:transport_options].update(:request => { :timeout => @arguments[:request_timeout] } ) if @arguments[:request_timeout]
-
-        @arguments[:transport_options][:headers] ||= {}
-        @arguments[:transport_options][:headers].update 'Content-Type' => 'application/json' unless @arguments[:transport_options][:headers].keys.any? {|k| k.to_s.downcase =~ /content\-?\_?type/}
+        @seeds = __extract_hosts(@arguments[:hosts] ||
+                                     @arguments[:host] ||
+                                     @arguments[:url] ||
+                                     @arguments[:urls] ||
+                                     ENV['ELASTICSEARCH_URL'] ||
+                                     DEFAULT_HOST)
 
         @send_get_body_as = @arguments[:send_get_body_as] || 'GET'
 
-        transport_class  = @arguments[:transport_class] || DEFAULT_TRANSPORT_CLASS
+        if @arguments[:request_timeout]
+          @arguments[:transport_options][:request] = { :timeout => @arguments[:request_timeout] }
+        end
+
+        @arguments[:transport_options][:headers] ||= {}
+
+        unless @arguments[:transport_options][:headers].keys.any? {|k| k.to_s.downcase =~ /content\-?\_?type/}
+          @arguments[:transport_options][:headers]['Content-Type'] = 'application/json'
+        end
 
-        @transport       = @arguments[:transport] || begin
+        if @arguments[:transport]
+          @transport = @arguments[:transport]
+        else
+          transport_class  = @arguments[:transport_class] || DEFAULT_TRANSPORT_CLASS
           if transport_class == Transport::HTTP::Faraday
-            transport_class.new(:hosts => __extract_hosts(hosts, @arguments), :options => @arguments) do |faraday|
+            @transport = transport_class.new(:hosts => @seeds, :options => @arguments) do |faraday|
               block.call faraday if block
               unless (h = faraday.builder.handlers.last) && h.name.start_with?("Faraday::Adapter")
                 faraday.adapter(@arguments[:adapter] || __auto_detect_adapter)
               end
             end
           else
-            transport_class.new(:hosts => __extract_hosts(hosts, @arguments), :options => @arguments)
+            @transport = transport_class.new(:hosts => @seeds, :options => @arguments)
           end
         end
       end
@@ -127,10 +140,11 @@ module Elasticsearch
       #
       def perform_request(method, path, params={}, body=nil, headers=nil)
         method = @send_get_body_as if 'GET' == method && body
-
-        transport.perform_request method, path, params, body, headers
+        transport.perform_request(method, path, params, body, headers)
       end
 
+      private
+
       # Normalizes and returns hosts configuration.
       #
       # Arrayifies the `hosts_config` argument and extracts `host` and `port` info from strings.
@@ -143,52 +157,57 @@ module Elasticsearch
       #
       # @api private
       #
-      def __extract_hosts(hosts_config, options={})
-        if hosts_config.is_a?(Hash)
-          hosts = [ hosts_config ]
-        else
-          if hosts_config.is_a?(String) && hosts_config.include?(',')
-            hosts = hosts_config.split(/\s*,\s*/)
-          else
-            hosts = Array(hosts_config)
-          end
-        end
-
-        result = hosts.map do |host|
-          host_parts = case host
-            when String
-              if host =~ /^[a-z]+\:\/\//
-                uri = URI.parse(host)
-                { :scheme => uri.scheme, :user => uri.user, :password => uri.password, :host => uri.host, :path => uri.path, :port => uri.port }
-              else
-                host, port = host.split(':')
-                { :host => host, :port => port }
-              end
-            when URI
-              { :scheme => host.scheme, :user => host.user, :password => host.password, :host => host.host, :path => host.path, :port => host.port }
-            when Hash
-              host
-            else
-              raise ArgumentError, "Please pass host as a String, URI or Hash -- #{host.class} given."
-            end
-
-          host_parts[:port] = host_parts[:port].to_i unless host_parts[:port].nil?
-
-          # Transfer the selected host parts such as authentication credentials to `options`,
-          # so we can re-use them when reloading connections
-          #
-          host_parts.select { |k,v| [:scheme, :port, :user, :password].include?(k) }.each do |k,v|
-            @arguments[:http][k] ||= v
-          end
-
-          # Remove the trailing slash
-          host_parts[:path].chomp!('/') if host_parts[:path]
-
-          host_parts
-        end
+      def __extract_hosts(hosts_config)
+        hosts = case hosts_config
+                when String
+                  hosts_config.split(',').map { |h| h.strip! || h }
+                when Array
+                  hosts_config
+                when Hash, URI
+                  [ hosts_config ]
+                else
+                  Array(hosts_config)
+                end
+
+        host_list = hosts.map { |host| __parse_host(host) }
+        @options[:randomize_hosts] ? host_list.shuffle! : host_list
+      end
 
-        result.shuffle! if options[:randomize_hosts]
-        result
+      def __parse_host(host)
+        host_parts = case host
+                     when String
+                       if host =~ /^[a-z]+\:\/\//
+                         uri = URI.parse(host)
+                         { :scheme => uri.scheme,
+                           :user => uri.user,
+                           :password => uri.password,
+                           :host => uri.host,
+                           :path => uri.path,
+                           :port => uri.port }
+                       else
+                         host, port = host.split(':')
+                         { :host => host,
+                           :port => port }
+                       end
+                     when URI
+                       { :scheme => host.scheme,
+                         :user => host.user,
+                         :password => host.password,
+                         :host => host.host,
+                         :path => host.path,
+                         :port => host.port }
+                     when Hash
+                       host
+                     else
+                       raise ArgumentError, "Please pass host as a String, URI or Hash -- #{host.class} given."
+                     end
+
+        @options[:http][:user] ||= host_parts[:user]
+        @options[:http][:password] ||= host_parts[:password]
+
+        host_parts[:port] = host_parts[:port].to_i if host_parts[:port]
+        host_parts[:path].chomp!('/') if host_parts[:path]
+        host_parts
       end
 
       # Auto-detect the best adapter (HTTP "driver") available, based on libraries

data/lib/elasticsearch/transport/redacted.rb

@@ -0,0 +1,75 @@
+# 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.
+
+module Elasticsearch
+  module Transport
+
+    # Class for wrapping a hash that could have sensitive data.
+    # When printed, the sensitive values will be redacted.
+    #
+    # @since 6.2.0
+    class Redacted < ::Hash
+
+      def initialize(elements = nil)
+        super()
+        (elements || {}).each_pair{ |key, value| self[key] = value }
+      end
+
+      # The keys whose values will be redacted.
+      #
+      # @since 6.2.0
+      SENSITIVE_KEYS = [ :password,
+                         :pwd ].freeze
+
+      # The replacement string used in place of the value for sensitive keys.
+      #
+      # @since 6.2.0
+      STRING_REPLACEMENT = '<REDACTED>'.freeze
+
+      # Get a string representation of the hash.
+      #
+      # @return [ String ] The string representation of the hash.
+      #
+      # @since 6.2.0
+      def inspect
+        redacted_string(:inspect)
+      end
+
+      # Get a string representation of the hash.
+      #
+      # @return [ String ] The string representation of the hash.
+      #
+      # @since 6.2.0
+      def to_s
+        redacted_string(:to_s)
+      end
+
+      private
+
+      def redacted_string(method)
+        '{' + reduce([]) do |list, (k, v)|
+          list << "#{k.send(method)}=>#{redact(k, v, method)}"
+        end.join(', ') + '}'
+      end
+
+      def redact(k, v, method)
+        return STRING_REPLACEMENT if SENSITIVE_KEYS.include?(k.to_sym)
+        v.send(method)
+      end
+    end
+  end
+end

data/lib/elasticsearch/transport/transport/base.rb

@@ -32,7 +32,7 @@ module Elasticsearch
           @state_mutex = Mutex.new
 
           @hosts       = arguments[:hosts]   || []
-          @options     = arguments[:options] || {}
+          @options     = arguments[:options] ? arguments[:options].dup : {}
           @options[:http] ||= {}
           @options[:retry_on_status] ||= []
 
@@ -110,7 +110,7 @@ module Elasticsearch
 
             new_connections = __build_connections
             stale_connections = @connections.all.select  { |c| ! new_connections.include?(c) }
-            new_connections = new_connections.reject { |c| @connections.include?(c) }
+            new_connections = new_connections.reject { |c| @connections.all.include?(c) }
 
             @connections.remove(stale_connections)
             @connections.add(new_connections)

data/lib/elasticsearch/transport/transport/connections/connection.rb

@@ -23,7 +23,7 @@ module Elasticsearch
           # @option arguments [Hash]   :options    Options (usually passed in from transport)
           #
           def initialize(arguments={})
-            @host       = arguments[:host]
+            @host       = arguments[:host].is_a?(Hash) ? Redacted.new(arguments[:host]) : arguments[:host]
             @connection = arguments[:connection]
             @options    = arguments[:options] || {}
             @state_mutex = Mutex.new

data/lib/elasticsearch/transport/transport/http/faraday.rb

@@ -20,11 +20,10 @@ module Elasticsearch
             super do |connection, url|
               headers = headers || connection.connection.headers
 
-              response = connection.connection.run_request \
-                method.downcase.to_sym,
-                url,
-                ( body ? __convert_to_json(body) : nil ),
-                headers
+              response = connection.connection.run_request(method.downcase.to_sym,
+                                                           url,
+                                                           ( body ? __convert_to_json(body) : nil ),
+                                                           headers)
 
               Response.new response.status, response.body, response.headers
             end

data/lib/elasticsearch/transport/version.rb

@@ -1,5 +1,5 @@
 module Elasticsearch
   module Transport
-    VERSION = "6.1.0"
+    VERSION = "6.2.0"
   end
 end

data/spec/elasticsearch/transport/base_spec.rb

@@ -0,0 +1,81 @@
+# 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::Transport::Transport::Base do
+
+  context 'when a host is printed in a logged message' do
+
+    shared_examples_for 'a redacted string' do
+
+      let(:client) do
+        Elasticsearch::Transport::Client.new(arguments)
+      end
+
+      let(:logger) do
+        double('logger', error?: true, error: '')
+      end
+
+      it 'does not include the password in the logged string' do
+        expect(logger).not_to receive(:error).with(/secret_password/)
+        expect {
+          client.cluster.stats
+        }.to raise_exception(Faraday::ConnectionFailed)
+      end
+
+      it 'replaces the password with the string \'REDACTED\'' do
+        expect(logger).to receive(:error).with(/REDACTED/)
+        expect {
+          client.cluster.stats
+        }.to raise_exception(Faraday::ConnectionFailed)
+      end
+    end
+
+    context 'when the user and password are provided as separate arguments' do
+
+      let(:arguments) do
+        { hosts: 'fake',
+          logger: logger,
+          password: 'secret_password',
+          user: 'test' }
+      end
+
+      it_behaves_like 'a redacted string'
+    end
+
+    context 'when the user and password are provided in the string URI' do
+
+      let(:arguments) do
+        { hosts: 'http://test:secret_password@fake.com',
+          logger: logger }
+      end
+
+      it_behaves_like 'a redacted string'
+    end
+
+    context 'when the user and password are provided in the URI object' do
+
+      let(:arguments) do
+        { hosts: URI.parse('http://test:secret_password@fake.com'),
+          logger: logger }
+      end
+
+      it_behaves_like 'a redacted string'
+    end
+  end
+end