elasticsearch-transport 7.13.1 → 7.14.1.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ae324619e058030508ffb4a2f69577c3ba49e7cb526afaf258c502739829cb33
-  data.tar.gz: 5e9ea4dd558023c2ae3153e69cda25a8de11d6bf559d7d38ed9f4a50f2218084
+  metadata.gz: 69804f86ed3bff5b4277e47adb97b727e3324cc2f5a7a7da2155266433d29b39
+  data.tar.gz: 4ed9685fca9531e8caff5396cfefe5b7f2e429b2b9b2a48dc325e73d3bae7c9f
 SHA512:
-  metadata.gz: c5960e2df76af2158c217847c794ffe2cf331feb9e531fc71d4ca9bbd5b79275c83bf3e6dacd7b9d4310f49ec7e146d246eea61c01df43048dbe418ef6ecf24c
-  data.tar.gz: 9325ff41a6cbb4f3a3bf1e3d5b1ffd6c8bcb6bb10b2724ae52a07f879cc5d6347efad13166bbcd08534887e91be6f63fc8d7d0449575e080679f435afa3008f0
+  metadata.gz: b958fb03c5494824be0c6683c751ec22cdac5d7cf270824ba62e746b93abbefc9ede940955408e8f228adb424f78364cd7452e28c965019476a65854026ad07a
+  data.tar.gz: b2f73320b43a84a8bb1de43c6afa9d37fa162d48fe587c7a9b8b78fd3c4a010c240f6f160ccbc596bb0e393d5279aa913fa930d46e6ced540ec2b5b6982c8781

data/Gemfile

@@ -20,16 +20,12 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in elasticsearch-transport.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
+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
 
-if File.exist? File.expand_path('../../elasticsearch-extensions/elasticsearch-extensions.gemspec', __FILE__)
-  gem 'elasticsearch-extensions', path: File.expand_path('../../elasticsearch-extensions', __FILE__), require: false
-end
-
-if File.exist? File.expand_path('../../elasticsearch/elasticsearch.gemspec', __FILE__)
-  gem 'elasticsearch', path: File.expand_path('../../elasticsearch', __FILE__), require: false
+if File.exist? File.expand_path('../elasticsearch/elasticsearch.gemspec', __dir__)
+  gem 'elasticsearch', path: File.expand_path('../elasticsearch', __dir__), require: false
 end
 
 group :development, :test do

data/README.md

@@ -424,10 +424,7 @@ To configure the _Faraday_ instance directly, use a block:
       f.adapter  :patron
     end
 
-You can use any standard Faraday middleware and plugins in the configuration block, for example sign the requests for the [AWS Elasticsearch service](https://aws.amazon.com/elasticsearch-service/). See [the AWS documentation](https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-request-signing.html#es-request-signing-ruby) for an example.
-
-You can also initialize the transport class yourself, and pass it to the client constructor
-as the `transport` argument:
+You can use any standard Faraday middleware and plugins in the configuration block. You can also initialize the transport class yourself, and pass it to the client constructor as the `transport` argument:
 
 ```ruby
 require 'patron'
@@ -561,16 +558,14 @@ Github's pull requests and issues are used to communicate, send bug reports and
 To work on the code, clone and bootstrap the main repository first --
 please see instructions in the main [README](../README.md#development).
 
-To run tests, launch a testing cluster -- again, see instructions
-in the main [README](../README.md#development) -- and use the Rake tasks:
+To run tests, launch a testing cluster and use the Rake tasks:
 
 ```
 time rake test:unit
 time rake test:integration
 ```
 
-Unit tests have to use Ruby 1.8 compatible syntax, integration tests
-can use Ruby 2.x syntax and features.
+Use `COVERAGE=true` before running a test task to check coverage with Simplecov.
 
 ## License
 

data/Rakefile

@@ -27,38 +27,37 @@ require 'rake/testtask'
 require 'rspec/core/rake_task'
 
 namespace :test do
-
-  desc "Wait for Elasticsearch to be in a green state"
+  desc 'Wait for Elasticsearch to be in a green state'
   task :wait_for_green do
     sh '../scripts/wait-cluster.sh'
   end
 
-  task :spec => :wait_for_green
   RSpec::Core::RakeTask.new(:spec)
 
   Rake::TestTask.new(:unit) do |test|
     test.libs << 'lib' << 'test'
-    test.test_files = FileList["test/unit/**/*_test.rb"]
+    test.test_files = FileList['test/unit/**/*_test.rb']
     test.verbose = false
     test.warning = false
   end
 
   Rake::TestTask.new(:integration) do |test|
     test.libs << 'lib' << 'test'
-    test.test_files = FileList["test/integration/**/*_test.rb"]
-    test.deps = [ 'test:wait_for_green', 'test:spec' ]
+    test.test_files = FileList['test/integration/**/*_test.rb']
+    test.deps = ['test:wait_for_green', 'test: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"]
+  desc 'Run all tests'
+  task :all do
+    Rake::Task['test:unit'].invoke
+    Rake::Task['test:integration'].invoke
   end
 
   Rake::TestTask.new(:profile) do |test|
     test.libs << 'lib' << 'test'
-    test.test_files = FileList["test/profile/**/*_test.rb"]
+    test.test_files = FileList['test/profile/**/*_test.rb']
   end
 
   namespace :cluster do

data/elasticsearch-transport.gemspec

@@ -47,29 +47,29 @@ Gem::Specification.new do |s|
   s.add_dependency 'multi_json'
   s.add_dependency 'faraday', '~> 1'
 
+  s.add_development_dependency 'ansi'
+  s.add_development_dependency 'bundler'
   s.add_development_dependency 'cane'
-  s.add_development_dependency 'curb'   unless defined? JRUBY_VERSION
+  s.add_development_dependency 'curb' unless defined? JRUBY_VERSION
+  s.add_development_dependency 'elasticsearch', ['>= 7', '< 8.0.0']
   s.add_development_dependency 'elasticsearch-extensions'
-  s.add_development_dependency 'minitest'
-  s.add_development_dependency 'minitest-reporters'
-  s.add_development_dependency 'rake', '~> 13'
-  s.add_development_dependency 'require-prof' unless defined?(JRUBY_VERSION) || defined?(Rubinius)
-  s.add_development_dependency 'ruby-prof'    unless defined?(JRUBY_VERSION) || defined?(Rubinius)
-  s.add_development_dependency 'simplecov', '~> 0.17', '< 0.18'
-  s.add_development_dependency 'simplecov-rcov'
-  s.add_development_dependency 'ansi'
   s.add_development_dependency 'hashie'
   s.add_development_dependency 'httpclient'
-  s.add_development_dependency 'manticore', '~> 0.6' if defined? JRUBY_VERSION
+  s.add_development_dependency 'manticore' if defined? JRUBY_VERSION
+  s.add_development_dependency 'minitest'
+  s.add_development_dependency 'minitest-reporters'
   s.add_development_dependency 'mocha'
   s.add_development_dependency 'net-http-persistent'
   s.add_development_dependency 'patron' unless defined? JRUBY_VERSION
   s.add_development_dependency 'pry'
+  s.add_development_dependency 'rake', '~> 13'
+  s.add_development_dependency 'require-prof' unless defined?(JRUBY_VERSION) || defined?(Rubinius)
+  s.add_development_dependency 'ruby-prof'    unless defined?(JRUBY_VERSION) || defined?(Rubinius)
   s.add_development_dependency 'shoulda-context'
+  s.add_development_dependency 'simplecov'
   s.add_development_dependency 'test-unit', '~> 2'
   s.add_development_dependency 'typhoeus', '~> 1.4'
   s.add_development_dependency 'yard'
-  s.add_development_dependency 'bundler'
 
   s.description = <<-DESC.gsub(/^    /, '')
     Ruby client for Elasticsearch. See the `elasticsearch` gem for full integration.

data/lib/elasticsearch/transport.rb

@@ -15,35 +15,23 @@
 # specific language governing permissions and limitations
 # under the License.
 
-require "uri"
-require "time"
-require "timeout"
-require "multi_json"
-require "faraday"
+require 'uri'
+require 'time'
+require 'timeout'
+require 'multi_json'
+require 'faraday'
 
-require "elasticsearch/transport/transport/loggable"
-require "elasticsearch/transport/transport/serializer/multi_json"
-require "elasticsearch/transport/transport/sniffer"
-require "elasticsearch/transport/transport/response"
-require "elasticsearch/transport/transport/errors"
-require "elasticsearch/transport/transport/base"
-require "elasticsearch/transport/transport/connections/selector"
-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/transport/loggable'
+require 'elasticsearch/transport/transport/serializer/multi_json'
+require 'elasticsearch/transport/transport/sniffer'
+require 'elasticsearch/transport/transport/response'
+require 'elasticsearch/transport/transport/errors'
+require 'elasticsearch/transport/transport/base'
+require 'elasticsearch/transport/transport/connections/selector'
+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"
-
-module Elasticsearch
-  module Client
-
-    # A convenience wrapper for {::Elasticsearch::Transport::Client#initialize}.
-    #
-    def new(arguments={}, &block)
-      Elasticsearch::Transport::Client.new(arguments, &block)
-    end
-    extend self
-  end
-end
+require 'elasticsearch/transport/version'

data/lib/elasticsearch/transport/client.rb

@@ -20,14 +20,13 @@ require 'elasticsearch/transport/meta_header'
 
 module Elasticsearch
   module Transport
-
     # Handles communication with an Elasticsearch cluster.
     #
     # See {file:README.md README} for usage and code examples.
     #
     class Client
       include MetaHeader
-      DEFAULT_TRANSPORT_CLASS  = Transport::HTTP::Faraday
+      DEFAULT_TRANSPORT_CLASS = Transport::HTTP::Faraday
 
       DEFAULT_LOGGER = lambda do
         require 'logger'

data/lib/elasticsearch/transport/transport/errors.rb

@@ -64,6 +64,7 @@ module Elasticsearch
         418 => 'ImATeapot',
         421 => 'TooManyConnectionsFromThisIP',
         426 => 'UpgradeRequired',
+        429 => 'TooManyRequests',
         450 => 'BlockedByWindowsParentalControls',
         494 => 'RequestHeaderTooLarge',
         497 => 'HTTPToHTTPS',

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

@@ -37,33 +37,44 @@ module Elasticsearch
               connection.connection.url = connection.full_url(path, params)
 
               case method
-                when 'HEAD'
-                  connection.connection.set :nobody, true
-                when 'GET', 'POST', 'PUT', 'DELETE'
-                  connection.connection.set :nobody, false
-
-                  connection.connection.put_data = __convert_to_json(body) if body
-
-                  if headers
-                    if connection.connection.headers
-                      connection.connection.headers.merge!(headers)
-                    else
-                      connection.connection.headers = headers
-                    end
+              when 'HEAD'
+                connection.connection.set :nobody, true
+              when 'GET', 'POST', 'PUT', 'DELETE'
+                connection.connection.set :nobody, false
+                connection.connection.put_data = __convert_to_json(body) if body
+                if headers
+                  if connection.connection.headers
+                    connection.connection.headers.merge!(headers)
+                  else
+                    connection.connection.headers = headers
                   end
-
-                else raise ArgumentError, "Unsupported HTTP method: #{method}"
+                end
+              else
+                raise ArgumentError, "Unsupported HTTP method: #{method}"
               end
 
               connection.connection.http(method.to_sym)
 
-              response_headers = {}
-              response_headers['content-type'] = 'application/json' if connection.connection.header_str =~ /\/json/
+              Response.new(
+                connection.connection.response_code,
+                decompress_response(connection.connection.body_str),
+                headers(connection)
+              )
+            end
+          end
 
-              Response.new connection.connection.response_code,
-                           decompress_response(connection.connection.body_str),
-                           response_headers
+          def headers(connection)
+            headers_string = connection.connection.header_str
+            return nil if headers_string.nil?
+
+            response_headers = headers_string&.split(/\\r\\n|\r\n/).reject(&:empty?)
+            response_headers.shift # Removes HTTP status string
+            processed_header = response_headers.flat_map { |s| s.scan(/^(\S+): (.+)/) }
+            headers_hash = Hash[processed_header].transform_keys(&:downcase)
+            if headers_hash['content-type']&.match?(/application\/json/)
+              headers_hash['content-type'] = 'application/json'
             end
+            headers_hash
           end
 
           # Builds and returns a connection
@@ -72,9 +83,8 @@ module Elasticsearch
           #
           def __build_connection(host, options={}, block=nil)
             client = ::Curl::Easy.new
-
             apply_headers(client, options)
-            client.url     = __full_url(host)
+            client.url = __full_url(host)
 
             if host[:user]
               client.http_auth_types = host[:auth_type] || :basic
@@ -106,13 +116,13 @@ module Elasticsearch
 
           def user_agent_header(client)
             @user_agent ||= begin
-              meta = ["RUBY_VERSION: #{RUBY_VERSION}"]
-              if RbConfig::CONFIG && RbConfig::CONFIG['host_os']
-                meta << "#{RbConfig::CONFIG['host_os'].split('_').first[/[a-z]+/i].downcase} #{RbConfig::CONFIG['target_cpu']}"
-              end
-              meta << "Curb #{Curl::CURB_VERSION}"
-              "elasticsearch-ruby/#{VERSION} (#{meta.join('; ')})"
-            end
+                              meta = ["RUBY_VERSION: #{RUBY_VERSION}"]
+                              if RbConfig::CONFIG && RbConfig::CONFIG['host_os']
+                                meta << "#{RbConfig::CONFIG['host_os'].split('_').first[/[a-z]+/i].downcase} #{RbConfig::CONFIG['target_cpu']}"
+                              end
+                              meta << "Curb #{Curl::CURB_VERSION}"
+                              "elasticsearch-ruby/#{VERSION} (#{meta.join('; ')})"
+                            end
           end
         end
       end

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

@@ -19,7 +19,6 @@ module Elasticsearch
   module Transport
     module Transport
       module HTTP
-
         # The default transport implementation, using the [_Faraday_](https://rubygems.org/gems/faraday)
         # library for abstracting the HTTP client.
         #
@@ -45,10 +44,12 @@ module Elasticsearch
                           headers
                         end
 
-              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, decompress_response(response.body), response.headers
             end

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

@@ -63,6 +63,7 @@ module Elasticsearch
           include Base
 
           def initialize(arguments={}, &block)
+            @request_options = { headers: (arguments.dig(:transport_options, :headers) || {}) }
             @manticore = build_client(arguments[:options] || {})
             super(arguments, &block)
           end
@@ -109,7 +110,6 @@ module Elasticsearch
           # @return [Connections::Collection]
           #
           def __build_connections
-            @request_options = {}
             apply_headers(@request_options, options[:transport_options])
             apply_headers(@request_options, options)
 
@@ -155,11 +155,11 @@ module Elasticsearch
           private
 
           def apply_headers(request_options, options)
-            headers = (options && options[:headers]) || {}
+            headers = options&.[](:headers) || {}
             headers[CONTENT_TYPE_STR] = find_value(headers, CONTENT_TYPE_REGEX) || DEFAULT_CONTENT_TYPE
             headers[USER_AGENT_STR] = find_value(headers, USER_AGENT_REGEX) || user_agent_header
             headers[ACCEPT_ENCODING] = GZIP if use_compression?
-            request_options.merge!(headers: headers)
+            request_options[:headers].merge!(headers)
           end
 
           def user_agent_header

data/lib/elasticsearch/transport/version.rb

@@ -17,6 +17,6 @@
 
 module Elasticsearch
   module Transport
-    VERSION = '7.13.1'.freeze
+    VERSION = '7.14.1.pre'.freeze
   end
 end

data/spec/elasticsearch/transport/base_spec.rb

@@ -32,14 +32,14 @@ describe Elasticsearch::Transport::Transport::Base do
         expect(logger).not_to receive(:error).with(/secret_password/)
 
         expect {
-          client.cluster.stats
+          client.perform_request('GET', '_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
+          client.perform_request('GET', '_cluster/stats')
         }.to raise_exception(Faraday::ConnectionFailed)
       end
     end
@@ -65,7 +65,27 @@ describe Elasticsearch::Transport::Transport::Base do
         }
       end
 
-      it_behaves_like 'a redacted string'
+      if jruby?
+        let(:client) { Elasticsearch::Transport::Client.new(arguments) }
+        let(:logger) { double('logger', fatal?: true, fatal: '') }
+
+        it 'does not include the password in the logged string' do
+          expect(logger).not_to receive(:fatal).with(/secret_password/)
+
+          expect {
+            client.perform_request('GET', '_cluster/stats')
+          }.to raise_exception(Faraday::SSLError)
+        end
+
+        it 'replaces the password with the string \'REDACTED\'' do
+          expect(logger).to receive(:fatal).with(/REDACTED/)
+          expect {
+            client.perform_request('GET', '_cluster/stats')
+          }.to raise_exception(Faraday::SSLError)
+        end
+      else
+        it_behaves_like 'a redacted string'
+      end
     end
 
     context 'when the user and password are provided in the URI object' do
@@ -75,8 +95,27 @@ describe Elasticsearch::Transport::Transport::Base do
           logger: logger
         }
       end
-
-      it_behaves_like 'a redacted string'
+      if jruby?
+        let(:client) { Elasticsearch::Transport::Client.new(arguments) }
+        let(:logger) { double('logger', fatal?: true, fatal: '') }
+
+        it 'does not include the password in the logged string' do
+          expect(logger).not_to receive(:fatal).with(/secret_password/)
+
+          expect {
+            client.perform_request('GET', '_cluster/stats')
+          }.to raise_exception(Faraday::SSLError)
+        end
+
+        it 'replaces the password with the string \'REDACTED\'' do
+          expect(logger).to receive(:fatal).with(/REDACTED/)
+          expect {
+            client.perform_request('GET', '_cluster/stats')
+          }.to raise_exception(Faraday::SSLError)
+        end
+      else
+        it_behaves_like 'a redacted string'
+      end
     end
   end
 
@@ -94,7 +133,7 @@ describe Elasticsearch::Transport::Transport::Base do
     end
 
     it 'raises an exception' do
-      expect { client.info }.to raise_exception(Faraday::ConnectionFailed)
+      expect { client.perform_request('GET', '/') }.to raise_exception(Faraday::ConnectionFailed)
     end
   end
 
@@ -129,7 +168,7 @@ describe Elasticsearch::Transport::Transport::Base do
 
       let(:arguments) do
         {
-          hosts: ['http://localhost:9250'],
+          hosts: ELASTICSEARCH_HOSTS,
           retry_on_status: ['404']
         }
       end