elasticsearch-transport 7.12.0 → 7.13.0.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fc7f64d6af1a163b0f6a2fb2f95aaab42e8f797b998e4a3d34fed1bc21ea3ccb
-  data.tar.gz: 1b00c2e0cdd62483465ca14d093475a7ec2f9d976e2e50565c8e27b44b06634d
+  metadata.gz: 2170038c55227e1ebc05cd17dd055ec0c8bd30b4f3cf7e2fb60ff527c768d693
+  data.tar.gz: 7ab94a823a1e57348d6b4ef0b80d84cb958964cdd8ae8cd9a6464ca9fa477621
 SHA512:
-  metadata.gz: '0899b3da62ed4fd0fd7d6d02defa75354d85fd05ed83c9ac3fa40e6ea597011620f84ad38c30273e7fb11deb4e34f2dd3a469407a6848f56ecdcdaf35fb53a8e'
-  data.tar.gz: 41e7690ac6a1d40f7632ae91a16bf707040bda14783074caceaa7f91ab1f66d4c3d58b6c5ec6b2a581c4f7d69e6db94f4e849c15f5d3b8db3bed584f943c655c
+  metadata.gz: f34f54dbfee4ee6f8a4706d9e9634fa38fe96ceee74651b774fa243fe37f65b29608acfcc217bc10843a65c90daca17aaa6b5f8e7b21f1d9a77d0d87c43e04d0
+  data.tar.gz: b1a5ce57f77c59f98a968bf22d79a182c14db2fb27bedf636d07602f6da384dc11d6b111ebd3967cb18c1481e8d4298715a0a45b66ad61d55a91e666accc0f4a

data/lib/elasticsearch/transport/client.rb

@@ -145,14 +145,15 @@ module Elasticsearch
         @options[:http]                 ||= {}
 
         set_api_key if (@api_key = @arguments[:api_key])
+        set_compatibility_header if ENV['ELASTIC_CLIENT_APIVERSIONING']
 
         @seeds = extract_cloud_creds(@arguments)
         @seeds ||= __extract_hosts(@arguments[:hosts] ||
-                                     @arguments[:host] ||
-                                     @arguments[:url] ||
-                                     @arguments[:urls] ||
-                                     ENV['ELASTICSEARCH_URL'] ||
-                                     DEFAULT_HOST)
+                                   @arguments[:host] ||
+                                   @arguments[:url] ||
+                                   @arguments[:urls] ||
+                                   ENV['ELASTICSEARCH_URL'] ||
+                                   DEFAULT_HOST)
 
         @send_get_body_as = @arguments[:send_get_body_as] || 'GET'
         @opaque_id_prefix = @arguments[:opaque_id_prefix] || nil
@@ -200,6 +201,17 @@ module Elasticsearch
         @arguments.delete(:password)
       end
 
+      def set_compatibility_header
+        return unless ['1', 'true'].include?(ENV['ELASTIC_CLIENT_APIVERSIONING'])
+
+        add_header(
+          {
+            'Accept' => 'application/vnd.elasticsearch+json;compatible-with=7',
+            'Content-Type' => 'application/vnd.elasticsearch+json; compatible-with=7'
+          }
+        )
+      end
+
       def add_header(header)
         headers = @arguments[:transport_options]&.[](:headers) || {}
         headers.merge!(header)

data/lib/elasticsearch/transport/meta_header.rb

@@ -19,7 +19,6 @@ require 'base64'
 
 module Elasticsearch
   module Transport
-
     # Methods for the Elastic meta header used by Cloud.
     # X-Elastic-Client-Meta HTTP header which is used by Elastic Cloud and can be disabled when
     # instantiating the Client with the :enable_meta_header parameter set to `false`.
@@ -42,8 +41,10 @@ module Elasticsearch
       end
 
       def meta_header_service_version
-        if defined?(Elastic::META_HEADER_SERVICE_VERSION)
-          Elastic::META_HEADER_SERVICE_VERSION
+        if enterprise_search?
+          Elastic::ENTERPRISE_SERVICE_VERSION
+        elsif elasticsearch?
+          Elastic::ELASTICSEARCH_SERVICE_VERSION
         elsif defined?(Elasticsearch::VERSION)
           [:es, client_meta_version(Elasticsearch::VERSION)]
         else
@@ -51,6 +52,20 @@ module Elasticsearch
         end
       end
 
+      def enterprise_search?
+        defined?(Elastic::ENTERPRISE_SERVICE_VERSION) &&
+          called_from?('enterprise-search-ruby')
+      end
+
+      def elasticsearch?
+        defined?(Elastic::ELASTICSEARCH_SERVICE_VERSION) &&
+          called_from?('elasticsearch')
+      end
+
+      def called_from?(service)
+        !caller.select { |c| c.match?(service) }.empty?
+      end
+
       # We return the current version if it's a release, but if it's a pre/alpha/beta release we
       # return <VERSION_NUMBER>p
       #

data/lib/elasticsearch/transport/version.rb

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

data/spec/elasticsearch/transport/client_spec.rb

@@ -266,7 +266,7 @@ describe Elasticsearch::Transport::Client do
       it 'uses Faraday with the adapter' do
         expect(adapter).to eq Faraday::Adapter::Typhoeus
       end
-    end
+    end unless jruby?
 
     context 'when the adapter is specified as a string key' do
       let(:adapter) do
@@ -1428,6 +1428,46 @@ describe Elasticsearch::Transport::Client do
       end
     end
 
+    context 'when using the API Compatibility Header' do
+      it 'sets the API compatibility headers' do
+        ENV['ELASTIC_CLIENT_APIVERSIONING'] = 'true'
+        client = described_class.new(host: hosts)
+        headers = client.transport.connections.first.connection.headers
+
+        expect(headers['Content-Type']).to eq('application/vnd.elasticsearch+json; compatible-with=7')
+        expect(headers['Accept']).to eq('application/vnd.elasticsearch+json;compatible-with=7')
+
+        response = client.perform_request('GET', '/')
+        expect(response.headers['content-type']).to eq('application/json; charset=UTF-8')
+
+        ENV.delete('ELASTIC_CLIENT_APIVERSIONING')
+      end
+
+      it 'does not use API compatibility headers' do
+        val = ENV.delete('ELASTIC_CLIENT_APIVERSIONING')
+        client = described_class.new(host: hosts)
+        expect(client.transport.connections.first.connection.headers['Content-Type']).to eq('application/json')
+        ENV['ELASTIC_CLIENT_APIVERSIONING'] = val
+      end
+
+      it 'does not use API compatibility headers when it is set to unsupported values' do
+        val = ENV.delete('ELASTIC_CLIENT_APIVERSIONING')
+
+        ENV['ELASTIC_CLIENT_APIVERSIONING'] = 'test'
+        client = described_class.new(host: hosts)
+        expect(client.transport.connections.first.connection.headers['Content-Type']).to eq('application/json')
+
+        ENV['ELASTIC_CLIENT_APIVERSIONING'] = 'false'
+        client = described_class.new(host: hosts)
+        expect(client.transport.connections.first.connection.headers['Content-Type']).to eq('application/json')
+
+        ENV['ELASTIC_CLIENT_APIVERSIONING'] = '3'
+        client = described_class.new(host: hosts)
+        expect(client.transport.connections.first.connection.headers['Content-Type']).to eq('application/json')
+        ENV['ELASTIC_CLIENT_APIVERSIONING'] = val
+      end
+    end
+
     context 'when Elasticsearch response includes a warning header' do
       let(:client) do
         Elasticsearch::Transport::Client.new(hosts: hosts)
@@ -1776,7 +1816,7 @@ describe Elasticsearch::Transport::Client do
             it 'preserves the other headers' do
               expect(client.transport.connections[0].connection.headers['User-Agent'])
             end
-          end
+          end unless jruby?
         end
       end
 

data/spec/elasticsearch/transport/meta_header_spec.rb

@@ -251,7 +251,7 @@ describe Elasticsearch::Transport::Client do
 
     context 'when using a different service version' do
       before do
-        stub_const("Elastic::META_HEADER_SERVICE_VERSION", [:ent, '8.0.0'])
+        stub_const('Elastic::ELASTICSEARCH_SERVICE_VERSION', [:ent, '8.0.0'])
       end
 
       let(:client) { Elasticsearch::Client.new }

data/test/integration/transport_test.rb

@@ -32,7 +32,7 @@ class Elasticsearch::Transport::ClientIntegrationTest < Elasticsearch::Test::Int
       begin; Object.send(:remove_const, :Patron);   rescue NameError; end
     end
 
-    should "allow to customize the Faraday adapter" do
+    should "allow to customize the Faraday adapter to Typhoeus" do
       require 'typhoeus'
       require 'typhoeus/adapters/faraday'
 
@@ -42,6 +42,19 @@ class Elasticsearch::Transport::ClientIntegrationTest < Elasticsearch::Test::Int
           f.adapter  :typhoeus
         end
 
+      client = Elasticsearch::Transport::Client.new transport: transport
+      client.perform_request 'GET', ''
+    end unless jruby?
+
+    should "allow to customize the Faraday adapter to NetHttpPersistent" do
+      require 'net/http/persistent'
+
+      transport = Elasticsearch::Transport::Transport::HTTP::Faraday.new \
+                                                                       :hosts => [ { host: @host, port: @port } ] do |f|
+        f.response :logger
+        f.adapter  :net_http_persistent
+      end
+
       client = Elasticsearch::Transport::Client.new transport: transport
       client.perform_request 'GET', ''
     end

data/test/unit/connection_test.rb

@@ -64,8 +64,8 @@ class Elasticsearch::Transport::Transport::Connections::ConnectionTest < Minites
 
     should "have a string representation" do
       c = Connection.new :host => 'x'
-      assert_match /host: x/, c.to_s
-      assert_match /alive/,   c.to_s
+      assert_match(/host: x/, c.to_s)
+      assert_match(/alive/,   c.to_s)
     end
 
     should "not be dead by default" do

data/test/unit/transport_base_test.rb

@@ -429,7 +429,7 @@ class Elasticsearch::Transport::Transport::BaseTest < Minitest::Test
       @transport.stubs(:get_connection).returns(fake_connection)
 
       @transport.logger.expects(:info).with do |message|
-        assert_match /http:\/\/user:\*{1,15}@localhost\:9200/, message
+        assert_match(/http:\/\/user:\*{1,15}@localhost\:9200/, message)
         true
       end
 

data/test/unit/transport_faraday_test.rb

@@ -149,7 +149,7 @@ class Elasticsearch::Transport::Transport::HTTP::FaradayTest < Minitest::Test
 
       transport.connections.first.connection.expects(:run_request).
         with do |method, url, params, body|
-          assert_match /\?format=yaml/, url
+          assert_match(/\?format=yaml/, url)
           true
         end.
         returns(stub_everything)
@@ -167,7 +167,7 @@ class Elasticsearch::Transport::Transport::HTTP::FaradayTest < Minitest::Test
 
       transport.connections.first.connection.expects(:run_request).
         with do |method, url, params, body|
-          assert_match /\?format=json/, url
+          assert_match(/\?format=json/, url)
           true
         end.
         returns(stub_everything)

data/test/unit/transport_manticore_test.rb

@@ -145,8 +145,8 @@ else
         transport = Manticore.new :hosts => [ { :host => 'foobar', :port => 1234 } ], :options => options
         transport.connections.first.connection
           .expects(:get)
-          .with do |host, options|
-            assert_equal 'myapp-0.0', options[:headers]['User-Agent']
+          .with do |host, _options|
+            assert_equal 'myapp-0.0', _options[:headers]['User-Agent']
             true
           end
           .returns(stub_everything)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: elasticsearch-transport
 version: !ruby/object:Gem::Version
-  version: 7.12.0
+  version: 7.13.0.pre
 platform: ruby
 authors:
 - Karel Minarik
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-23 00:00:00.000000000 Z
+date: 2021-05-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -425,11 +425,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.2.16
 signing_key: 
 specification_version: 4
 summary: Ruby client for Elasticsearch.