elastic-transport 8.2.2 → 8.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2ed8622f822c6b3d845e86e457a6391c1fac329c61e4d2e72fa6fd4a96eed269
-  data.tar.gz: 94866083c749a687fa5f5f8f25c076cc4823abc2e0afa318fd05cec6afb6de0b
+  metadata.gz: 79d083cf524ffa5874b8e52be857908cf520c551040d40a15730b3e6cd20507d
+  data.tar.gz: 87338ca40ec28d77034f902e67b324bccf70d0e0c871c5e60547291079f2b018
 SHA512:
-  metadata.gz: cd88c9f775083a059f924ab8f4668d4f01fdff475dfa904743533aec4f48d7fbb4b2bbdad596fd295c43e7cbb5195ba4bec3e4daa9bcb6a1b33fd4d60bbfd324
-  data.tar.gz: 3c01c3ad96f481054441fe406c1680cd4c147ccb2bdedc1d46c5ad7adbdfa08fa37dda52647b4b025dc48cde54d21312eb026dfe656fdea893008f8eb85b146e
+  metadata.gz: a1b4d5fbbb1e173d78ec57b4cb2821d852c2bcd899e17253ec6a14e23794ff0143d2184dbada48c897b2e558192163631eaf208e77a879afe0868e7b57aca1ed
+  data.tar.gz: 6e093adf8f2a670f4ed62b21bb60387af00ea47bfc16b66a9da8eba02e891982f54c6a0467c329c4079b202b1425728bf882e87af7494d8a720fd883b1730021

data/.github/workflows/license.yml

@@ -4,7 +4,7 @@ jobs:
   build:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
     - uses: ruby/setup-ruby@v1
       with:
         ruby-version: 3

data/.github/workflows/tests.yml

@@ -19,7 +19,7 @@ jobs:
         es_version: ['8.7-SNAPSHOT', '8.8-SNAPSHOT', '8.9-SNAPSHOT']
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
     - name: Increase system limits
       run: |
         sudo swapoff -a
@@ -57,7 +57,7 @@ jobs:
         es_version: ['8.9-SNAPSHOT']
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
     - name: Increase system limits
       run: |
         sudo swapoff -a

data/CHANGELOG.md

@@ -1,3 +1,16 @@
+## 8.2.4
+
+Tested versions of Ruby: (MRI) 3.0, 3.1, 3.2, JRuby 9.3 and JRuby 9.4
+
+- Fixes [#66](https://github.com/elastic/elastic-transport-ruby/issues/66) - Manticore transport unable to send custom headers with perform_request [Pull Request](https://github.com/elastic/elastic-transport-ruby/pull/69)
+- Fixes [#67](https://github.com/elastic/elastic-transport-ruby/issues/67) - Float with many digits automatically becomes BigDecimal when using Oj. [Pull Request](https://github.com/elastic/elastic-transport-ruby/pull/68), thank you @kyoshidajp!
+
+## 8.2.3
+
+Tested versions of Ruby: (MRI) 3.0, 3.1, 3.2, JRuby 9.3 and JRuby 9.4
+
+- Fixes enforcing UTF-8 in Response body, causing an error when the string is frozen, particularly when using webmock. [issue #63](https://github.com/elastic/elastic-transport-ruby/issues/63)
+
 ## 8.2.2
 
 Tested versions of Ruby: (MRI) 3.0, 3.1, 3.2, JRuby 9.3 and JRuby 9.4

data/Gemfile

@@ -26,6 +26,7 @@ group :development, :test do
   gem 'faraday-patron' unless defined? JRUBY_VERSION
   gem 'faraday-typhoeus'
   gem 'rspec'
+  gem 'oj' unless defined? JRUBY_VERSION
   if defined?(JRUBY_VERSION)
     gem 'pry-nav'
   else

data/Gemfile-faraday1.gemfile

@@ -31,6 +31,7 @@ group :development, :test do
   gem 'patron' unless defined? JRUBY_VERSION
   gem 'rspec'
   gem 'typhoeus'
+  gem 'oj' unless defined? JRUBY_VERSION
   if defined?(JRUBY_VERSION)
     gem 'pry-nav'
   else

data/README.md

@@ -1,4 +1,5 @@
 # Elastic Transport
+[![8.1 tests](https://github.com/elastic/elastic-transport-ruby/actions/workflows/tests.yml/badge.svg?branch=8.1)](https://github.com/elastic/elastic-transport-ruby/actions/workflows/tests.yml)
 [![Run tests](https://github.com/elastic/elastic-transport-ruby/actions/workflows/tests.yml/badge.svg?branch=main)](https://github.com/elastic/elastic-transport-ruby/actions/workflows/tests.yml)
 
 This gem provides a low-level Ruby client for connecting to an [Elastic](http://elastic.co) cluster. It powers both the [Elasticsearch client](https://github.com/elasticsearch/elasticsearch-ruby/) and the [Elastic Enterprise Search](https://github.com/elastic/enterprise-search-ruby/) client.
@@ -15,7 +16,7 @@ response = client.perform_request('GET', '_cluster/health')
 
 **Refer to [the official documentation on Elastic Transport](https://www.elastic.co/guide/en/elasticsearch/client/ruby-api/current/transport.html).**
 
-**Refer to [Advanced Configuration](https://elasticsearch-ruby_1881.docs-preview.app.elstc.co/guide/en/elasticsearch/client/ruby-api/master/advanced-config.html) to read about more configuration options.**
+**Refer to [Advanced Configuration](https://www.elastic.co/guide/en/elasticsearch/client/ruby-api/current/advanced-config.html) to read about more configuration options.**
 
 ## Compatibility
 

data/elastic-transport.gemspec

@@ -23,8 +23,8 @@ require 'elastic/transport/version'
 Gem::Specification.new do |s|
   s.name          = "elastic-transport"
   s.version       = Elastic::Transport::VERSION
-  s.authors       = ['Karel Minarik', 'Emily Stolfo', 'Fernando Briano']
-  s.email         = ['clients-team@elastic.co']
+  s.authors       = ['Elastic Client Library Maintainers']
+  s.email         = ['client-libs@elastic.co']
   s.summary       = 'Low level Ruby client for Elastic services.'
   s.homepage      = 'https://github.com/elastic/elastic-transport-ruby'
   s.license       = 'Apache-2.0'

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

@@ -346,10 +346,17 @@ module Elastic
             __raise_transport_error response unless ignore.include?(response.status.to_i)
           end
 
-          json = serializer.load(response.body) if response.body &&
-                                                       !response.body.empty? &&
-                                                       response.headers &&
-                                                       response.headers["content-type"] =~ /json/
+          if response.body &&
+            !response.body.empty? &&
+            response.headers &&
+            response.headers["content-type"] =~ /json/
+
+            # Prevent Float value from automatically becoming BigDecimal when using Oj
+            load_options = {}
+            load_options[:mode] = :compat if ::MultiJson.adapter.to_s == "MultiJson::Adapters::Oj"
+
+            json = serializer.load(response.body, load_options)
+          end
           took = (json['took'] ? sprintf('%.3fs', json['took'] / 1000.0) : 'n/a') rescue 'n/a'
           __log_response(method, path, params, body, url, response, json, took, duration) unless ignore.include?(response.status.to_i)
           __trace(method, path, params, connection_headers(connection), body, url, response, nil, 'N/A', duration) if tracer

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

@@ -90,11 +90,10 @@ module Elastic
           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])
-
+              body, headers = compress_request(body, parse_headers(headers))
               params[:body] = body if body
               params[:headers] = headers if headers
-              params = params.merge @request_options
+
               case method
               when 'GET'
                 resp = connection.connection.get(url, params)
@@ -161,6 +160,12 @@ module Elastic
 
           private
 
+          def parse_headers(headers)
+            request_headers = @request_options.fetch(:headers, {})
+            headers = request_headers.merge(headers || {})
+            headers.empty? ? nil : headers
+          end
+
           def apply_headers(options)
             headers = options[:headers].clone || options.dig(:transport_options, :headers).clone || {}
             headers[CONTENT_TYPE_STR] = find_value(headers, CONTENT_TYPE_REGEX) || DEFAULT_CONTENT_TYPE

data/lib/elastic/transport/transport/response.rb

@@ -19,8 +19,7 @@ module Elastic
   module Transport
     module Transport
       # Wraps the response from Elasticsearch.
-      # It provides `body`, `status` and `headers` methods, but you can treat is as a hash and
-      # access the keys directly.
+      # It provides `body`, `status` and `headers` methods
       class Response
         attr_reader :status, :body, :headers
 
@@ -29,7 +28,7 @@ module Elastic
         # @param headers [Hash]    Response headers
         def initialize(status, body, headers = {})
           @status, @body, @headers = status, body, headers
-          @body = body.force_encoding('UTF-8') if body.respond_to?(:force_encoding)
+          @body = body.force_encoding('UTF-8') if body.respond_to?(:force_encoding) && !body.frozen?
         end
       end
     end

data/lib/elastic/transport/version.rb

@@ -17,6 +17,6 @@
 
 module Elastic
   module Transport
-    VERSION = '8.2.2'.freeze
+    VERSION = '8.2.4'.freeze
   end
 end

data/spec/elastic/transport/client_spec.rb

@@ -1190,6 +1190,49 @@ describe Elastic::Transport::Client do
         expect(logger).to have_received(:warn).with(warning)
       end
     end
+
+    context 'when Elasticsearch response includes long precision Float' do
+      let(:client) do
+        Elastic::Transport::Client.new(hosts: hosts)
+      end
+      before do
+        expect_any_instance_of(Faraday::Connection).to receive(:run_request) do
+          Elastic::Transport::Transport::Response.new(200, "{\"score\":1.11111111111111111}", { 'content-type' => 'application/json; charset=UTF-8' })
+        end
+      end
+
+      context 'when default JSON engine is used' do
+        after do
+          # Clear MultiJson's adapter
+          ::MultiJson.instance_variable_set(:@adapter, nil)
+        end
+        it 'returns as a Float' do
+          response = client.perform_request('GET', '/')
+          score = response.body['score']
+          expect(score).to eq 1.11111111111111111
+          expect(score.class).to eq Float
+        end
+      end
+
+      unless defined?(JRUBY_VERSION)
+        context 'when Oj is used as a JSON engine' do
+          before do
+            require 'oj'
+          end
+          after do
+            # Clear MultiJson's adapter
+            ::MultiJson.instance_variable_set(:@adapter, nil)
+          end
+
+          it 'returns as a Float' do
+            response = client.perform_request('GET', '/')
+            score = response.body['score']
+            expect(score).to eq 1.11111111111111111
+            expect(score.class).to eq Float
+          end
+        end
+      end
+    end
   end
 
   context 'when the client connects to Elasticsearch' do

data/spec/elastic/transport/http/manticore_spec.rb

@@ -53,7 +53,7 @@ if defined?(JRUBY_VERSION)
         expect(perform_request).to be_kind_of(Elastic::Transport::Transport::Response)
       end
 
-      it 'run body with preper params' do
+      it 'runs body with proper params' do
         expect(
           client.transport.connections.first.connection
         ).to receive(:post).with(
@@ -121,7 +121,7 @@ if defined?(JRUBY_VERSION)
           gzip.close.string
         end
 
-        it 'run body with preper params' do
+        it 'runs body with proper params' do
           expect(
             client.transport.connections.first.connection
           ).to receive(:post).with(*request_params).and_return(response)
@@ -141,6 +141,24 @@ if defined?(JRUBY_VERSION)
           end
         end
       end
+
+      context 'headers' do
+        it 'sends custom headers' do
+          client = Elastic::Transport::Client.new(
+            transport_class: described_class,
+            transport_options: { headers: { 'Elastic-Api-Version'=>'2023-10-31' } }
+          )
+          expect(
+            client.transport.connections.first.connection
+          ).to receive(:get).with(
+                 'http://localhost:9200/',
+                 {
+                   headers: expected_headers.merge({ 'Elastic-Api-Version'=>'2023-10-31' })
+                 }
+               ).and_return(response)
+          client.perform_request('GET', '/', {}, nil, headers)
+        end
+      end
     end
   end
 end

data/test/test_helper.rb

@@ -83,4 +83,4 @@ def is_faraday_v2?
   Gem::Version.new(Faraday::VERSION) >= Gem::Version.new(2)
 end
 
-Minitest::Reporters.use! FixedMinitestSpecReporter.new
+Minitest::Reporters.use! Minitest::Reporters::SpecReporter.new(print_failure_summary: true)

data/test/unit/transport_manticore_test.rb

@@ -111,7 +111,7 @@ if JRUBY
                     {
                       body: '{"foo":"bar"}',
                       headers: {
-                        'Content-Type' => 'application/json',
+                        'Content-Type' => 'application/x-ndjson',
                         'User-Agent' => @transport.send(:user_agent_header)
                       }
                     }

metadata

@@ -1,16 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: elastic-transport
 version: !ruby/object:Gem::Version
-  version: 8.2.2
+  version: 8.2.4
 platform: ruby
 authors:
-- Karel Minarik
-- Emily Stolfo
-- Fernando Briano
+- Elastic Client Library Maintainers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-07-04 00:00:00.000000000 Z
+date: 2023-09-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -255,7 +253,7 @@ description: 'Low level Ruby client for Elastic. See the `elasticsearch` or `ela
 
   '
 email:
-- clients-team@elastic.co
+- client-libs@elastic.co
 executables: []
 extensions: []
 extra_rdoc_files:
@@ -339,7 +337,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.13
+rubygems_version: 3.4.19
 signing_key: 
 specification_version: 4
 summary: Low level Ruby client for Elastic services.