elasticsearch-transport 7.0.0 → 7.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7d3fcae6f1a83df06756bda27ed0f155d6b723ee4b2adb3d305c631f14e10702
-  data.tar.gz: c678d2c8aa24b50190cc3f4eef84bdd91537b6273da601def5b00f0f59ce1158
+  metadata.gz: 14188a454b64314c13f7c9279741fc8df5f9f03ff9813f45aeca96abc8da7e39
+  data.tar.gz: dfcd7ac5fb8e0b2a0450b2939272f88a329581648c47b130d62e1fcead705b44
 SHA512:
-  metadata.gz: dc5ea6a71bf2f42ae6bd8f2ee3ddfdbe7511d80e278d6ca303a006b726fe476709acb0820bceed0de1b65441faa21e01ca4649ecf8026f6b0c9c8051ac641be1
-  data.tar.gz: 938b137ae39fa0995370462023d16edbf6c0f88eca4c2a80beac66f3506d00630881c9cd754ba9bfcfcea3fcefaaea1f597f44ef4dc7b5c7f691fe5db5a33601
+  metadata.gz: 36e9583f541ec75994cb27479c16f4624d7ea6a9e6f33360d7cac69541fe10a5c2ee2d7f20b2c1231b5fd07ab85cd32baefb236d6ab77ff11635bb23b1d9d801
+  data.tar.gz: 95faf1016519c04dcafcd6580356dcfb00c8eeb9ef3301bf2ff3c66a90cfcc8ebf676b638ec18f92f708acb5ef01ee2f7ee137f23ed6532774b371e47b02e11f

data/README.md

@@ -6,7 +6,7 @@ please refer to it, unless you want to use this library standalone.**
 ----
 
 The `elasticsearch-transport` library provides a low-level Ruby client for connecting
-to an [Elasticsearch](http://elasticsearch.org) cluster.
+to an [Elasticsearch](http://elasticsearch.com) cluster.
 
 It handles connecting to multiple nodes in the cluster, rotating across connections,
 logging and tracing requests and responses, maintaining failed connections,
@@ -194,7 +194,7 @@ Elasticsearch by default dynamically discovers new nodes in the cluster. You can
 in the client, and periodically check for new nodes to spread the load.
 
 To retrieve and use the information from the
-[_Nodes Info API_](http://www.elasticsearch.org/guide/reference/api/admin-cluster-nodes-info/)
+[_Nodes Info API_](http://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-nodes-info.html)
 on every 10,000th request:
 
     Elasticsearch::Client.new hosts: ['localhost:9200', 'localhost:9201'], reload_connections: true
@@ -460,16 +460,19 @@ can use Ruby 2.x syntax and features.
 
 This software is licensed under the Apache 2 license, quoted below.
 
-    Copyright (c) 2013 Elasticsearch <http://www.elasticsearch.org>
-
-    Licensed under the Apache License, Version 2.0 (the "License");
-    you may not use this file except in compliance with the License.
+    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.
+    
+    	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.

data/lib/elasticsearch/transport/client.rb

@@ -105,8 +105,8 @@ module Elasticsearch
       # @yield [faraday] Access and configure the `Faraday::Connection` instance directly with a block
       #
       def initialize(arguments={}, &block)
-        @options = arguments
-        @arguments = arguments
+        @options = arguments.each_with_object({}){ |(k,v), args| args[k.to_sym] = v }
+        @arguments = @options
         @arguments[:logger] ||= @arguments[:log]   ? DEFAULT_LOGGER.call() : nil
         @arguments[:tracer] ||= @arguments[:trace] ? DEFAULT_TRACER.call() : nil
         @arguments[:reload_connections] ||= false
@@ -194,7 +194,10 @@ module Elasticsearch
         host_parts = case host
         when String
           if host =~ /^[a-z]+\:\/\//
-            uri = URI.parse(host)
+            # Construct a new `URI::Generic` directly from the array returned by URI::split.
+            # This avoids `URI::HTTP` and `URI::HTTPS`, which supply default ports.
+            uri = URI::Generic.new(*URI.split(host))
+
             { :scheme => uri.scheme,
               :user => uri.user,
               :password => uri.password,

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

@@ -284,7 +284,7 @@ module Elasticsearch
             __raise_transport_error(response) if response.status.to_i >= 300 && @retry_on_status.include?(response.status.to_i)
 
           rescue Elasticsearch::Transport::Transport::ServerError => e
-            if @retry_on_status.include?(response.status)
+            if response && @retry_on_status.include?(response.status)
               log_warn "[#{e.class}] Attempt #{tries} to get response from #{url}"
               if tries <= max_retries
                 retry

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

@@ -51,7 +51,7 @@ module Elasticsearch
           # @return [Connections::Connection]
           #
           def __build_connection(host, options={}, block=nil)
-            client = ::Faraday::Connection.new(__full_url(host), options, &block)
+            client = ::Faraday.new(__full_url(host), options, &block)
             Connections::Connection.new :host => host, :connection => client
           end
 

data/lib/elasticsearch/transport/transport/sniffer.rb

@@ -35,7 +35,7 @@ module Elasticsearch
         end
 
         # Retrieves the node list from the Elasticsearch's
-        # [_Nodes Info API_](http://www.elasticsearch.org/guide/reference/api/admin-cluster-nodes-info/)
+        # [_Nodes Info API_](https://www.elastic.co/guide/reference/api/admin-cluster-nodes-info/)
         # and returns a normalized Array of information suitable for passing to transport.
         #
         # Shuffles the collection before returning it when the `randomize_hosts` option is set for transport.

data/lib/elasticsearch/transport/version.rb

@@ -17,6 +17,6 @@
 
 module Elasticsearch
   module Transport
-    VERSION = "7.0.0"
+    VERSION = "7.1.0"
   end
 end

data/spec/elasticsearch/transport/client_spec.rb

@@ -68,7 +68,22 @@ describe Elasticsearch::Transport::Client do
         described_class.new(adapter: :typhoeus)
       end
 
-      it 'uses Faraday' do
+      it 'uses Faraday with the adapter' do
+        expect(adapter).to include(Faraday::Adapter::Typhoeus)
+      end
+    end
+
+    context 'when the adapter is specified as a string key' do
+
+      let(:adapter) do
+        client.transport.connections.all.first.connection.builder.handlers
+      end
+
+      let(:client) do
+        described_class.new('adapter' => :typhoeus)
+      end
+
+      it 'uses Faraday with the adapter' do
         expect(adapter).to include(Faraday::Adapter::Typhoeus)
       end
     end
@@ -126,6 +141,30 @@ describe Elasticsearch::Transport::Client do
         expect(hosts[0][:port]).to be(9200)
       end
 
+      context 'when IPv6 format is used' do
+
+        around do |example|
+          original_setting = Faraday.ignore_env_proxy
+          Faraday.ignore_env_proxy = true
+          example.run
+          Faraday.ignore_env_proxy = original_setting
+        end
+
+        let(:host) do
+          'https://[2090:db8:85a3:9811::1f]:8080'
+        end
+
+        it 'extracts the host' do
+          expect(hosts[0][:host]).to eq('[2090:db8:85a3:9811::1f]')
+          expect(hosts[0][:scheme]).to eq('https')
+          expect(hosts[0][:port]).to be(8080)
+        end
+
+        it 'creates the correct full url' do
+          expect(client.transport.__full_url(client.transport.hosts[0])).to eq('https://[2090:db8:85a3:9811::1f]:8080')
+        end
+      end
+
       context 'when a path is specified' do
 
         let(:host) do
@@ -207,6 +246,53 @@ describe Elasticsearch::Transport::Client do
         expect(hosts[0][:port]).to be(9200)
       end
 
+      context 'when IPv6 format is used' do
+
+        around do |example|
+          original_setting = Faraday.ignore_env_proxy
+          Faraday.ignore_env_proxy = true
+          example.run
+          Faraday.ignore_env_proxy = original_setting
+        end
+
+        let(:host) do
+          { host: '[2090:db8:85a3:9811::1f]', scheme: 'https', port: '443' }
+        end
+
+        it 'extracts the host' do
+          expect(hosts[0][:host]).to eq('[2090:db8:85a3:9811::1f]')
+          expect(hosts[0][:scheme]).to eq('https')
+          expect(hosts[0][:port]).to be(443)
+        end
+
+        it 'creates the correct full url' do
+          expect(client.transport.__full_url(client.transport.hosts[0])).to eq('https://[2090:db8:85a3:9811::1f]:443')
+        end
+      end
+
+      context 'when the host is localhost as a IPv6 address' do
+
+        around do |example|
+          original_setting = Faraday.ignore_env_proxy
+          Faraday.ignore_env_proxy = true
+          example.run
+          Faraday.ignore_env_proxy = original_setting
+        end
+
+        let(:host) do
+          { host: '[::1]' }
+        end
+
+        it 'extracts the host' do
+          expect(hosts[0][:host]).to eq('[::1]')
+          expect(hosts[0][:port]).to be(9200)
+        end
+
+        it 'creates the correct full url' do
+          expect(client.transport.__full_url(client.transport.hosts[0])).to eq('http://[::1]:9200')
+        end
+      end
+
       context 'when the port is specified as a String' do
 
         let(:host) do
@@ -288,6 +374,79 @@ describe Elasticsearch::Transport::Client do
         end
       end
 
+      context 'when there is one host with a protocol and no port' do
+
+        let(:host) do
+          ['http://myhost']
+        end
+
+        it 'extracts the host' do
+          expect(hosts[0][:host]).to eq('myhost')
+          expect(hosts[0][:protocol]).to eq('http')
+          expect(hosts[0][:port]).to be(9200)
+        end
+      end
+
+      context 'when there is one host with a protocol and no port' do
+
+        let(:host) do
+          ['http://myhost']
+        end
+
+        it 'extracts the host' do
+          expect(hosts[0][:host]).to eq('myhost')
+          expect(hosts[0][:protocol]).to eq('http')
+          expect(hosts[0][:port]).to be(9200)
+        end
+      end
+
+      context 'when there is one host with a protocol and the default http port explicitly provided' do
+        let(:host) do
+          ['http://myhost:80']
+        end
+
+        it 'respects the explicit port' do
+          expect(hosts[0][:port]).to be(80)
+        end
+      end
+
+      context 'when there is one host with a protocol and the default https port explicitly provided' do
+        let(:host) do
+          ['https://myhost:443']
+        end
+
+        it 'respects the explicit port' do
+          expect(hosts[0][:port]).to be(443)
+        end
+      end
+
+      context 'when there is one host with a scheme, protocol and no port' do
+
+        let(:host) do
+          ['https://myhost']
+        end
+
+        it 'extracts the host' do
+          expect(hosts[0][:host]).to eq('myhost')
+          expect(hosts[0][:protocol]).to eq('https')
+          expect(hosts[0][:port]).to be(9200)
+        end
+      end
+
+      context 'when there is one host with a scheme, protocol, path, and no port' do
+
+        let(:host) do
+          ['http://myhost/foo/bar']
+        end
+
+        it 'extracts the host' do
+          expect(hosts[0][:host]).to eq('myhost')
+          expect(hosts[0][:protocol]).to eq('http')
+          expect(hosts[0][:port]).to be(9200)
+          expect(hosts[0][:path]).to eq("/foo/bar")
+        end
+      end
+
       context 'when there is more than one host' do
 
         let(:host) do
@@ -353,7 +512,7 @@ describe Elasticsearch::Transport::Client do
   context 'when hosts are specified with the \'host\' key' do
 
     let(:client) do
-      described_class.new(hosts: ['host1', 'host2', 'host3', 'host4'], randomize_hosts: true)
+      described_class.new(host: ['host1', 'host2', 'host3', 'host4'], randomize_hosts: true)
     end
 
     let(:hosts) do
@@ -365,23 +524,38 @@ describe Elasticsearch::Transport::Client do
     end
   end
 
-  context 'when hosts are specified with the \'host\' key' do
+  context 'when hosts are specified with the \'host\' key as a String' do
 
     let(:client) do
-      described_class.new(host: host)
+      described_class.new('host' => ['host1', 'host2', 'host3', 'host4'], 'randomize_hosts' => true)
     end
 
     let(:hosts) do
       client.transport.hosts
     end
 
-    it_behaves_like 'a client that extracts hosts'
+    it 'sets the hosts in random order' do
+      expect(hosts.all? { |host| client.transport.hosts.include?(host) }).to be(true)
+    end
   end
 
   context 'when hosts are specified with the \'hosts\' key' do
 
     let(:client) do
-      described_class.new(host: host)
+      described_class.new(hosts: host)
+    end
+
+    let(:hosts) do
+      client.transport.hosts
+    end
+
+    it_behaves_like 'a client that extracts hosts'
+  end
+
+  context 'when hosts are specified with the \'hosts\' key as a String' do
+
+    let(:client) do
+      described_class.new('hosts' => host)
     end
 
     let(:hosts) do
@@ -394,7 +568,20 @@ describe Elasticsearch::Transport::Client do
   context 'when hosts are specified with the \'url\' key' do
 
     let(:client) do
-      described_class.new(host: host)
+      described_class.new(url: host)
+    end
+
+    let(:hosts) do
+      client.transport.hosts
+    end
+
+    it_behaves_like 'a client that extracts hosts'
+  end
+
+  context 'when hosts are specified with the \'url\' key as a String' do
+
+    let(:client) do
+      described_class.new('url' => host)
     end
 
     let(:hosts) do
@@ -407,7 +594,20 @@ describe Elasticsearch::Transport::Client do
   context 'when hosts are specified with the \'urls\' key' do
 
     let(:client) do
-      described_class.new(host: host)
+      described_class.new(urls: host)
+    end
+
+    let(:hosts) do
+      client.transport.hosts
+    end
+
+    it_behaves_like 'a client that extracts hosts'
+  end
+
+  context 'when hosts are specified with the \'urls\' key as a String' do
+
+    let(:client) do
+      described_class.new('urls' => host)
     end
 
     let(:hosts) do
@@ -464,6 +664,17 @@ describe Elasticsearch::Transport::Client do
       end
     end
 
+    context 'when scheme is specified as a String key' do
+
+      let(:client) do
+        described_class.new('scheme' => 'https')
+      end
+
+      it 'sets the scheme' do
+        expect(client.transport.connections[0].full_url('')).to match(/https/)
+      end
+    end
+
     context 'when user and password are specified' do
 
       let(:client) do
@@ -490,6 +701,32 @@ describe Elasticsearch::Transport::Client do
       end
     end
 
+    context 'when user and password are specified as String keys' do
+
+      let(:client) do
+        described_class.new('user' => 'USERNAME', 'password' => 'PASSWORD')
+      end
+
+      it 'sets the user and password' do
+        expect(client.transport.connections[0].full_url('')).to match(/USERNAME/)
+        expect(client.transport.connections[0].full_url('')).to match(/PASSWORD/)
+      end
+
+      context 'when the connections are reloaded' do
+
+        before do
+          allow(client.transport.sniffer).to receive(:hosts).and_return([{ host: 'foobar', port: 4567, id: 'foobar4567' }])
+          client.transport.reload_connections!
+        end
+
+        it 'sets keeps user and password' do
+          expect(client.transport.connections[0].full_url('')).to match(/USERNAME/)
+          expect(client.transport.connections[0].full_url('')).to match(/PASSWORD/)
+          expect(client.transport.connections[0].full_url('')).to match(/foobar/)
+        end
+      end
+    end
+
     context 'when port is specified' do
 
       let(:client) do
@@ -574,6 +811,17 @@ describe Elasticsearch::Transport::Client do
         expect(client.transport.options[:transport_options][:request]).to eq(timeout: 120)
       end
     end
+
+    context 'when \'request_timeout\' is defined as a String key' do
+
+      let(:client) do
+        described_class.new('request_timeout' => 120)
+      end
+
+      it 'sets the options on the transport' do
+        expect(client.transport.options[:transport_options][:request]).to eq(timeout: 120)
+      end
+    end
   end
 
   describe '#perform_request' do
@@ -926,4 +1174,4 @@ describe Elasticsearch::Transport::Client do
       end
     end
   end
-end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: elasticsearch-transport
 version: !ruby/object:Gem::Version
-  version: 7.0.0
+  version: 7.1.0
 platform: ruby
 authors:
 - Karel Minarik
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-30 00:00:00.000000000 Z
+date: 2019-05-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json