elastic-transport 8.0.0.pre2 → 8.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e2c04c9ca950389cb71ceda4d1fe1c7e4266c844ed95c73fd3b7815ea28c6134
-  data.tar.gz: 07deccf3f9278235cb4989cfaada2be0e271d21615f72fac8eeaab00e81058c6
+  metadata.gz: 51e53310c92bb9b3e3cb43d0ffb2587e980218f6a4de9052f21fa1dee645b319
+  data.tar.gz: 960f931aff3f04f14d93c45d585b37e1bc23fcf6273d731c7c3ec3d7a217bea3
 SHA512:
-  metadata.gz: 3e27a172d2fa106208b210fd4ab1cdd1bc76f6ef49e4b7aefae6a6a525dd650478e21c1e173335733c703f0119ec5e3935fdd0f46eb477573ae6cbceccc2ff34
-  data.tar.gz: a4cf7f2a840c75a43a6ed74d15f04fcab1c780fa9a2250892af38ca206c3eaa021f8548ed5a53f1339bb344bf41bc2225a92ed077ef227fdecd33d882b43f32e
+  metadata.gz: 77748ed0f93bbf3c065331bb4d6bc2b76b5ee254a1412728b68feb4c7679277a3eafb39bfd3267a67374cc410b2f9277ceea42e899869624134af5cf7f8429e2
+  data.tar.gz: 645430db2265232b924d2c85877cde70d7e54d8c4ad5f2a0b98003419c61db42ffe0f1629a964436ca4fcbfb1bca5fe29b97f8991784170af6f8219ee83eaed4

data/.github/workflows/tests.yml

@@ -14,7 +14,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: [ 2.5, 2.6, 2.7, 3.0, jruby-9.2 ]
+        ruby: [ '2.6', '2.7', '3.0', '3.1', 'jruby-9.3' ]
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v2

data/CHANGELOG.md

@@ -1,13 +1,17 @@
-## 8.0.0.pre2
+## 8.0.1
 
+- Minor code cleanup
+- Adds Elastic Transport service token, updates specs for meta header.
+
+## 8.0.0
+
+- Library renamed from [`elasticsearch-transport`](https://github.com/elastic/elasticsearch-ruby/tree/7.x/elasticsearch-transport) to `elastic-transport` and promoted to its own repository.
 - Fixes tracing for Manticore [commit](https://github.com/elastic/elastic-transport-ruby/commit/98c81d19de4fee394f9c1a5079a1892ec951e0f9).
 - Implements CA Fingerprinting [pull request](https://github.com/elastic/elastic-transport-ruby/pull/13)
 - Adds `delay_on_retry` to wait between each failed connection, thanks @DinoPullerUqido! [commit](https://github.com/elastic/elastic-transport-ruby/commit/c2f8311409ca63a293588cb7eea5a0c672dbd436)
 - Fixes compression, thanks @johnnyshields! [commit](https://github.com/elastic/elastic-transport-ruby/commit/8b326d643f76f037075500e19bbe096b2c298099)
-
-## 8.0.0.pre1
-
-- Library renamed from [`elasticsearch-transport`](https://github.com/elastic/elasticsearch-ruby/tree/7.x/elasticsearch-transport) to `elastic-transport` and promoted to its own repository.
+- Tested in Ruby 3.1, JRuby 9.3, drops Ruby 2.5 in test Matrix. Version 8.0.0 tested for Ruby (MRI) 2.6, 2.7, 3.0 and 3.1 and JRuby 9.3.
+- Updates Manticore implementation headers setup. When using the Manticore HTTP implementation, adding a custom `User-Agent` value in the headers on initialization would get overwritten. [Pull Request](https://github.com/elastic/elastic-transport-ruby/pull/22) - [Issue reported in elastic/elasticsearch-ruby#1684](https://github.com/elastic/elasticsearch-ruby/issues/1684).
 
 # Changes from elasticsearch-transport:
 

data/lib/elastic/transport/client.rb

@@ -211,14 +211,6 @@ module Elastic
         )
       end
 
-      def add_header(header)
-        headers = @arguments[:transport_options]&.[](:headers) || {}
-        headers.merge!(header)
-        @arguments[:transport_options].merge!(
-          headers: headers
-        )
-      end
-
       # Normalizes and returns hosts configuration.
       #
       # Arrayifies the `hosts_config` argument and extracts `host` and `port` info from strings.

data/lib/elastic/transport/meta_header.rb

@@ -48,7 +48,7 @@ module Elastic
         elsif defined?(Elasticsearch::VERSION)
           [:es, client_meta_version(Elasticsearch::VERSION)]
         else
-          [:es, client_meta_version(Elastic::Transport::VERSION)]
+          [:et, client_meta_version(Elastic::Transport::VERSION)]
         end
       end
 

data/lib/elastic/transport/transport/base.rb

@@ -435,7 +435,7 @@ module Elastic
         end
 
         def find_value(hash, regex)
-          key_value = hash.find { |k,v| k.to_s.downcase =~ regex }
+          key_value = hash.find { |k, _| k.to_s.downcase =~ regex }
           if key_value
             hash.delete(key_value[0])
             key_value[1]

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

@@ -62,14 +62,20 @@ module Elastic
         class Manticore
           include Base
 
-          def initialize(arguments={}, &block)
-            @request_options = { headers: (arguments.dig(:transport_options, :headers) || {}) }
+          def initialize(arguments = {}, &block)
+            @request_options = {
+              headers: (
+                arguments.dig(:transport_options, :headers) ||
+                arguments.dig(:options, :transport_options, :headers) ||
+                {}
+              )
+            }
             @manticore = build_client(arguments[:options] || {})
             super(arguments, &block)
           end
 
           # Should just be run once at startup
-          def build_client(options={})
+          def build_client(options = {})
             client_options = options[:transport_options] || {}
             client_options[:ssl] = options[:ssl] || {}
 
@@ -81,7 +87,7 @@ module Elastic
           # @return [Response]
           # @see    Transport::Base#perform_request
           #
-          def perform_request(method, path, params={}, body=nil, headers=nil, opts={})
+          def perform_request(method, path, params = {}, body = nil, headers = nil, opts = {})
             super do |connection, url|
               body = body ? __convert_to_json(body) : nil
               body, headers = compress_request(body, @request_options[:headers])
@@ -90,20 +96,20 @@ module Elastic
               params[:headers] = headers if headers
               params = params.merge @request_options
               case method
-              when "GET"
+              when 'GET'
                 resp = connection.connection.get(url, params)
-              when "HEAD"
+              when 'HEAD'
                 resp = connection.connection.head(url, params)
-              when "PUT"
+              when 'PUT'
                 resp = connection.connection.put(url, params)
-              when "POST"
+              when 'POST'
                 resp = connection.connection.post(url, params)
-              when "DELETE"
+              when 'DELETE'
                 resp = connection.connection.delete(url, params)
               else
                 raise ArgumentError.new "Method #{method} not supported"
               end
-              Response.new resp.code, resp.read_body, resp.headers
+              Response.new(resp.code, resp.read_body, resp.headers)
             end
           end
 
@@ -113,23 +119,21 @@ module Elastic
           # @return [Connections::Collection]
           #
           def __build_connections
-            apply_headers(@request_options, options[:transport_options])
-            apply_headers(@request_options, options)
+            apply_headers(options)
 
-            Connections::Collection.new \
-              :connections => hosts.map { |host|
-                host[:protocol]   = host[:scheme] || DEFAULT_PROTOCOL
-                host[:port]     ||= DEFAULT_PORT
+            Connections::Collection.new(
+              connections: hosts.map do |host|
+                host[:protocol] = host[:scheme] || DEFAULT_PROTOCOL
+                host[:port] ||= DEFAULT_PORT
 
                 host.delete(:user)     # auth is not supported here.
                 host.delete(:password) # use the headers
 
-                Connections::Connection.new \
-                  :host => host,
-                  :connection => @manticore
-              },
-              :selector_class => options[:selector_class],
-              :selector => options[:selector]
+                Connections::Connection.new(host: host, connection: @manticore)
+              end,
+              selector_class: options[:selector_class],
+              selector: options[:selector]
+            )
           end
 
           # Closes all connections by marking them as dead
@@ -157,16 +161,16 @@ module Elastic
 
           private
 
-          def apply_headers(request_options, options)
-            headers = options&.[](:headers) || {}
+          def apply_headers(options)
+            headers = options[:headers] || options.dig(:transport_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[USER_AGENT_STR] = find_value(headers, USER_AGENT_REGEX) || find_value(@request_options[:headers], USER_AGENT_REGEX) || user_agent_header
             headers[ACCEPT_ENCODING] = GZIP if use_compression?
-            request_options[:headers].merge!(headers)
+            @request_options[:headers].merge!(headers)
           end
 
           def user_agent_header
-            @user_agent ||= begin
+            @user_agent_header ||= begin
               meta = ["RUBY_VERSION: #{JRUBY_VERSION}"]
               if RbConfig::CONFIG && RbConfig::CONFIG['host_os']
                 meta << "#{RbConfig::CONFIG['host_os'].split('_').first[/[a-z]+/i].downcase} #{RbConfig::CONFIG['target_cpu']}"

data/lib/elastic/transport/version.rb

@@ -17,6 +17,6 @@
 
 module Elastic
   module Transport
-    VERSION = '8.0.0.pre2'.freeze
+    VERSION = '8.0.1'.freeze
   end
 end

data/spec/elastic/transport/meta_header_spec.rb

@@ -26,14 +26,14 @@ describe Elastic::Transport::Client do
     let(:adapter_code) { "nh=#{defined?(Net::HTTP::VERSION) ? Net::HTTP::VERSION : Net::HTTP::HTTPVersion}" }
     let(:meta_header) do
       if jruby?
-        "es=#{meta_version},rb=#{RUBY_VERSION},t=#{Elastic::Transport::VERSION},jv=#{ENV_JAVA['java.version']},jr=#{JRUBY_VERSION},fd=#{Faraday::VERSION},#{adapter_code}"
+        "et=#{meta_version},rb=#{RUBY_VERSION},t=#{Elastic::Transport::VERSION},jv=#{ENV_JAVA['java.version']},jr=#{JRUBY_VERSION},fd=#{Faraday::VERSION},#{adapter_code}"
       else
-        "es=#{meta_version},rb=#{RUBY_VERSION},t=#{Elastic::Transport::VERSION},fd=#{Faraday::VERSION},#{adapter_code}"
+        "et=#{meta_version},rb=#{RUBY_VERSION},t=#{Elastic::Transport::VERSION},fd=#{Faraday::VERSION},#{adapter_code}"
       end
     end
 
     context 'client_meta_version' do
-      let(:version) { ['7.1.0-alpha', '7.11.0.pre.1', '8.0.0-beta', '8.0.0.beta.2']}
+      let(:version) { ['7.1.0-alpha', '7.11.0.pre.1', '8.0.0-beta', '8.0.0.beta.2'] }
 
       it 'converts the version to X.X.Xp' do
         expect(client.send(:client_meta_version, '7.0.0-alpha')).to eq('7.0.0p')
@@ -81,9 +81,9 @@ describe Elastic::Transport::Client do
     context 'adapters' do
       let(:meta_header) do
         if jruby?
-          "es=#{meta_version},rb=#{RUBY_VERSION},t=#{Elastic::Transport::VERSION},jv=#{ENV_JAVA['java.version']},jr=#{JRUBY_VERSION},fd=#{Faraday::VERSION}"
+          "et=#{meta_version},rb=#{RUBY_VERSION},t=#{Elastic::Transport::VERSION},jv=#{ENV_JAVA['java.version']},jr=#{JRUBY_VERSION},fd=#{Faraday::VERSION}"
         else
-          "es=#{meta_version},rb=#{RUBY_VERSION},t=#{Elastic::Transport::VERSION},fd=#{Faraday::VERSION}"
+          "et=#{meta_version},rb=#{RUBY_VERSION},t=#{Elastic::Transport::VERSION},fd=#{Faraday::VERSION}"
         end
       end
       let(:client) { described_class.new(adapter: adapter) }
@@ -246,9 +246,9 @@ describe Elastic::Transport::Client do
       let(:subject) { client.instance_variable_get('@arguments')[:transport_options][:headers] }
       let(:meta_header) do
         if jruby?
-          "es=#{meta_version},rb=#{RUBY_VERSION},t=#{Elastic::Transport::VERSION},jv=#{ENV_JAVA['java.version']},jr=#{JRUBY_VERSION}"
+          "et=#{meta_version},rb=#{RUBY_VERSION},t=#{Elastic::Transport::VERSION},jv=#{ENV_JAVA['java.version']},jr=#{JRUBY_VERSION}"
         else
-          "es=#{meta_version},rb=#{RUBY_VERSION},t=#{Elastic::Transport::VERSION}"
+          "et=#{meta_version},rb=#{RUBY_VERSION},t=#{Elastic::Transport::VERSION}"
         end
       end
 
@@ -258,14 +258,29 @@ describe Elastic::Transport::Client do
       end
     end
 
-    context 'when using a different service version' do
+    context 'when Elasticsearch is being used' do
       before do
-        stub_const('Elastic::ELASTICSEARCH_SERVICE_VERSION', [:ent, '8.0.0'])
+        stub_const('Elastic::ELASTICSEARCH_SERVICE_VERSION', [:es, '8.0.0'])
       end
 
       let(:client) { Elastic::Transport::Client.new }
 
       it 'sets the service version in the metaheader' do
+        allow_any_instance_of(Kernel).to receive(:caller).and_return(['elasticsearch'])
+        expect(subject['x-elastic-client-meta']).to match(regexp)
+        expect(subject['x-elastic-client-meta']).to start_with('es=8.0.0')
+      end
+    end
+
+    context 'when Enterprise Search is being used' do
+      before do
+        stub_const('Elastic::ENTERPRISE_SERVICE_VERSION', [:ent, '8.0.0'])
+      end
+
+      let(:client) { Elastic::Transport::Client.new }
+
+      it 'sets the service version in the metaheader' do
+        allow_any_instance_of(Kernel).to receive(:caller).and_return(['enterprise-search-ruby'])
         expect(subject['x-elastic-client-meta']).to match(regexp)
         expect(subject['x-elastic-client-meta']).to start_with('ent=8.0.0')
       end

data/test/unit/transport_manticore_test.rb

@@ -209,28 +209,6 @@ if JRUBY
                 transport = Manticore.new hosts: [{ host: 'foobar', port: 1234 }], options: options
               end
 
-              should 'allow custom headers' do
-                transport_options = { headers: { 'Authorization' => 'Basic token' } }
-                transport = Manticore.new(
-                  hosts: [{ host: 'foobar', port: 1234 }],
-                  transport_options: transport_options
-                )
-
-                assert_equal(
-                  transport.instance_variable_get(:@request_options)[:headers]['Authorization'],
-                  'Basic token'
-                )
-                transport.connections.first.connection
-                  .expects(:get)
-                  .with do |_host, _options|
-                  assert_equal('Basic token', _options[:headers]['Authorization'])
-                  true
-                end
-                  .returns(stub_everything)
-
-                transport.perform_request('GET', '/', {})
-              end
-
               should 'pass :transport_options to Manticore::Client' do
                 options = {
                   transport_options: { potatoes: 1 }
@@ -238,6 +216,45 @@ if JRUBY
 
                 ::Manticore::Client.expects(:new).with(potatoes: 1, ssl: {})
                 transport = Manticore.new(hosts: [{ host: 'foobar', port: 1234 }], options: options)
+                assert_equal(transport.options[:transport_options][:potatoes], 1)
+              end
+
+              context 'custom headers' do
+                should 'allow authorization headers' do
+                  transport_options = { headers: { 'Authorization' => 'Basic token' } }
+                  transport = Manticore.new(
+                    hosts: [{ host: 'foobar', port: 1234 }],
+                    transport_options: transport_options
+                  )
+
+                  assert_equal(
+                    transport.instance_variable_get(:@request_options)[:headers]['Authorization'],
+                    'Basic token'
+                  )
+                  transport.connections.first.connection.expects(:get).with do |_host, options|
+                    assert_equal('Basic token', options[:headers]['Authorization'])
+                    true
+                  end.returns(stub_everything)
+                  transport.perform_request('GET', '/', {})
+                end
+
+                should 'allow user agent headers' do
+                  transport_options = { headers: { 'User-Agent' => 'Custom UA' } }
+                  transport = Manticore.new(
+                    hosts: [{ host: 'localhost' }],
+                    transport_options: transport_options
+                  )
+                  transport.connections.first.connection.expects(:get).with do |_host, options|
+                    assert_equal('Custom UA', options[:headers]['User-Agent'])
+                    true
+                  end.returns(stub_everything)
+                  transport.perform_request('GET', '/', {})
+
+                  assert_equal(
+                    transport.instance_variable_get('@request_options')[:headers]['User-Agent'],
+                    'Custom UA'
+                  )
+                end
               end
             end
           end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: elastic-transport
 version: !ruby/object:Gem::Version
-  version: 8.0.0.pre2
+  version: 8.0.1
 platform: ruby
 authors:
 - Karel Minarik
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-10-08 00:00:00.000000000 Z
+date: 2022-05-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -388,11 +388,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.3.3
 signing_key: 
 specification_version: 4
 summary: Low level Ruby client for Elastic services.