elasticsearch-transport 1.0.16.pre2 → 1.0.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5ed8d1ac139a80ce2d895c36d50d8e046d0b07f4
-  data.tar.gz: d42f554630cce9427f2cfc6824cb2f4f67d3e229
+  metadata.gz: 110c72e9d30c5a91ffd9e8f0910fb1c3bdb5b31c
+  data.tar.gz: 3f39c7af7cfe467c6ef5f755b8410a86898caa4f
 SHA512:
-  metadata.gz: fa8c9b62eafdbc8955a9eca420428a1fecd2235e3b8a58d837fafc8957e90272f69c7eb27a834656d4a79a6b9bef52cf11f25b1435dc2710b320abd900c6db21
-  data.tar.gz: c443d1e6ab4254cf8e7d805ee6f3809c21328bd8e15ba14024cdbe10b00b611b130e7ce90b71a66a92f8de77381791accd8fea3935983693ff6861c0a35eefe5
+  metadata.gz: 6b070500608e152cf6a0d43a1a7ea6b7d1fe1b2db2f119e7be2b054a9c65097ef340f090b26e3f4210a231244e292c39db19ade36c34c9f1a0b0de04604fdde9
+  data.tar.gz: b61a1757529a8a82490c90852ca36bee8d3f662e04d40b2b9ffae25c41fab58b991c836786ef1fa327480b606f72ea555c7253153ee7cb07770694a05aafb58e

data/README.md

@@ -211,6 +211,14 @@ The reloading will timeout if not finished under 1 second by default. To change
 
     Elasticsearch::Client.new hosts: ['localhost:9200', 'localhost:9201'], sniffer_timeout: 3
 
+**NOTE:** When using reloading hosts ("sniffing") together with authentication, just pass the scheme,
+          user and password with the host info -- or, for more clarity, in the `http` options:
+
+    Elasticsearch::Client.new host: 'localhost:9200',
+                              http: { scheme: 'https', user: 'U', password: 'P' },
+                              reload_connections: true,
+                              reload_on_failure: true
+
 ### Connection Selector
 
 By default, the client will rotate the connections in a round-robin fashion, using the

data/lib/elasticsearch/transport/client.rb

@@ -83,36 +83,39 @@ module Elasticsearch
       # @yield [faraday] Access and configure the `Faraday::Connection` instance directly with a block
       #
       def initialize(arguments={}, &block)
-        hosts = arguments[:hosts] || \
-                arguments[:host]  || \
-                arguments[:url]   || \
-                arguments[:urls]  || \
+        @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
-        arguments[:retry_on_failure]   ||= false
-        arguments[:reload_on_failure]  ||= false
-        arguments[:randomize_hosts]    ||= false
-        arguments[:transport_options]  ||= {}
+        @arguments[:logger] ||= @arguments[:log]   ? DEFAULT_LOGGER.call() : nil
+        @arguments[:tracer] ||= @arguments[:trace] ? DEFAULT_TRACER.call() : nil
+        @arguments[:reload_connections] ||= false
+        @arguments[:retry_on_failure]   ||= false
+        @arguments[:reload_on_failure]  ||= false
+        @arguments[:randomize_hosts]    ||= false
+        @arguments[:transport_options]  ||= {}
+        @arguments[:http]               ||= {}
 
-        arguments[:transport_options].update(:request => { :timeout => arguments[:request_timeout] } ) if arguments[:request_timeout]
+        @arguments[:transport_options].update(:request => { :timeout => @arguments[:request_timeout] } ) if @arguments[:request_timeout]
 
-        @send_get_body_as = arguments[:send_get_body_as] || 'GET'
+        @send_get_body_as = @arguments[:send_get_body_as] || 'GET'
 
-        transport_class  = arguments[:transport_class] || DEFAULT_TRANSPORT_CLASS
+        transport_class  = @arguments[:transport_class] || DEFAULT_TRANSPORT_CLASS
 
-        @transport       = arguments[:transport] || begin
+        @transport       = @arguments[:transport] || begin
           if transport_class == Transport::HTTP::Faraday
-            transport_class.new(:hosts => __extract_hosts(hosts, arguments), :options => arguments) do |faraday|
+            transport_class.new(:hosts => __extract_hosts(hosts, @arguments), :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)
+                faraday.adapter(@arguments[:adapter] || __auto_detect_adapter)
               end
             end
           else
-            transport_class.new(:hosts => __extract_hosts(hosts, arguments), :options => arguments)
+            transport_class.new(:hosts => __extract_hosts(hosts, @arguments), :options => @arguments)
           end
         end
       end
@@ -167,6 +170,14 @@ module Elasticsearch
             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
+
           host_parts
         end
 

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

@@ -11,7 +11,7 @@ module Elasticsearch
         DEFAULT_RESURRECT_AFTER  = 60     # Seconds
         DEFAULT_MAX_RETRIES      = 3      # Requests
         DEFAULT_SERIALIZER_CLASS = Serializer::MultiJson
-        SANITIZED_PASSWORD       = '*'*rand(15)
+        SANITIZED_PASSWORD       = '*' * (rand(14)+1)
 
         attr_reader   :hosts, :options, :connections, :counter, :last_request_at, :protocol
         attr_accessor :serializer, :sniffer, :logger, :tracer,
@@ -33,6 +33,8 @@ module Elasticsearch
 
           @hosts       = arguments[:hosts]   || []
           @options     = arguments[:options] || {}
+          @options[:http] ||= {}
+
           @block       = block
           @connections = __build_connections
 

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

@@ -34,13 +34,14 @@ module Elasticsearch
           def __build_connections
             Connections::Collection.new \
               :connections => hosts.map { |host|
-                host[:protocol] = host[:scheme] || options[:scheme] || DEFAULT_PROTOCOL
-                host[:port] ||= options[:port] || DEFAULT_PORT
-                if options[:user] && !host[:user]
-                  host[:user] ||= options[:user]
-                  host[:password] ||= options[:password]
+                host[:protocol] = host[:scheme] || options[:scheme] || options[:http][:scheme] || DEFAULT_PROTOCOL
+                host[:port] ||= options[:port] || options[:http][:scheme] || DEFAULT_PORT
+                if (options[:user] || options[:http][:user]) && !host[:user]
+                  host[:user] ||= options[:user] || options[:http][:user]
+                  host[:password] ||= options[:password] || options[:http][:password]
                 end
-                url               = __full_url(host)
+
+                url = __full_url(host)
 
                 Connections::Connection.new \
                   :host => host,

data/lib/elasticsearch/transport/version.rb

@@ -1,5 +1,5 @@
 module Elasticsearch
   module Transport
-    VERSION = "1.0.16.pre2"
+    VERSION = "1.0.16"
   end
 end

data/test/unit/client_test.rb

@@ -295,5 +295,59 @@ class Elasticsearch::Transport::ClientTest < Test::Unit::TestCase
       end
     end
 
+    context "when passed options" do
+      setup do
+        Elasticsearch::Transport::Client::DEFAULT_TRANSPORT_CLASS.any_instance.unstub(:__build_connections)
+      end
+
+      should "configure the HTTP scheme" do
+        c = Elasticsearch::Transport::Client.new \
+          :hosts => ['node1', 'node2'],
+          :port => 1234, :scheme => 'https', :user => 'USERNAME', :password => 'PASSWORD'
+
+        assert_equal 'https://USERNAME:PASSWORD@node1:1234/', c.transport.connections[0].full_url('')
+        assert_equal 'https://USERNAME:PASSWORD@node2:1234/', c.transport.connections[1].full_url('')
+      end
+
+      should "keep the credentials after reloading" do
+        Elasticsearch::Transport::Client::DEFAULT_TRANSPORT_CLASS.any_instance.
+          stubs(:sniffer).
+          returns( mock(:hosts => [ {:host => 'foobar', :port => 4567, :id => 'foobar4567'} ]) )
+
+        c = Elasticsearch::Transport::Client.new \
+          :url => 'http://foo:1234',
+          :user => 'USERNAME', :password => 'PASSWORD'
+
+        assert_equal 'http://USERNAME:PASSWORD@foo:1234/', c.transport.connections.first.full_url('')
+
+        c.transport.reload_connections!
+
+        assert_equal 'http://USERNAME:PASSWORD@foobar:4567/', c.transport.connections.first.full_url('')
+      end
+
+      should "transfer selected host parts into the 'http' options" do
+        c = Elasticsearch::Transport::Client.new \
+          :host => { :scheme => 'https', :port => '8080', :host => 'node1', :user => 'U', :password => 'P' }
+
+        assert_equal 'https://U:P@node1:8080/', c.transport.connections.first.full_url('')
+
+        assert_equal 'https', c.transport.options[:http][:scheme]
+        assert_equal 8080,    c.transport.options[:http][:port]
+        assert_equal 'U',     c.transport.options[:http][:user]
+        assert_equal 'P',     c.transport.options[:http][:password]
+      end
+
+      should "transfer selected host parts from URL into the 'http' options" do
+        c = Elasticsearch::Transport::Client.new :url => 'https://U:P@node1:8080'
+
+        assert_equal 'https://U:P@node1:8080/', c.transport.connections.first.full_url('')
+
+        assert_equal 'https', c.transport.options[:http][:scheme]
+        assert_equal 8080,    c.transport.options[:http][:port]
+        assert_equal 'U',     c.transport.options[:http][:user]
+        assert_equal 'P',     c.transport.options[:http][:password]
+      end
+    end
+
   end
 end

data/test/unit/transport_curb_test.rb

@@ -90,6 +90,13 @@ else
         assert_equal 'foo', transport.connections.first.connection.username
         assert_equal 'bar', transport.connections.first.connection.password
       end
+
+      should "use global http configuration" do
+        transport = Faraday.new :hosts => [ { :host => 'foobar', :port => 1234 } ],
+                                :options => { :http => { :scheme => 'https', :user => 'U', :password => 'P' } }
+
+        assert_equal 'https://U:P@foobar:1234/', transport.connections.first.full_url('')
+      end
     end
 
   end

data/test/unit/transport_faraday_test.rb

@@ -172,6 +172,13 @@ class Elasticsearch::Transport::Transport::HTTP::FaradayTest < Test::Unit::TestC
       assert_instance_of ::Faraday::Connection, transport.connections.first.connection
       assert_equal 'http://foobar:1234/',       transport.connections.first.connection.url_prefix.to_s
     end
+
+    should "use global http configuration" do
+      transport = Faraday.new :hosts => [ { :host => 'foobar', :port => 1234 } ],
+                              :options => { :http => { :scheme => 'https', :user => 'U', :password => 'P' } }
+
+      assert_equal 'https://U:P@foobar:1234/', transport.connections.first.full_url('')
+    end
   end
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: elasticsearch-transport
 version: !ruby/object:Gem::Version
-  version: 1.0.16.pre2
+  version: 1.0.16
 platform: ruby
 authors:
 - Karel Minarik
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-01 00:00:00.000000000 Z
+date: 2016-04-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -394,9 +394,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.2.2