elastic-transport 8.2.0 → 8.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aca3fc15486eeb7455f903dbaa5b6a594d4fd410f895cff6b3bf832c0dcad8b4
-  data.tar.gz: 4fd798b71008e3bba436434a5c98321fcd2b15934a6244908966c8b9cdd5c3e0
+  metadata.gz: 2ed8622f822c6b3d845e86e457a6391c1fac329c61e4d2e72fa6fd4a96eed269
+  data.tar.gz: 94866083c749a687fa5f5f8f25c076cc4823abc2e0afa318fd05cec6afb6de0b
 SHA512:
-  metadata.gz: a33a557b17fc75fbc2cd9b8fb713603b67c35097fce929ccdee0b81b76c58c05885286aeb1aeed8c72068d6c12a83b51e6dc1f9f07678d6e17f51ce962cb0af8
-  data.tar.gz: 5105d1a01106314206e250a105329abfb9553f6c12170bafaf8b7eb4741f5d7b9b414027919aac9df9867ee0859fbfce6b492fbc64a8335f17eebcc7fd109cf4
+  metadata.gz: cd88c9f775083a059f924ab8f4668d4f01fdff475dfa904743533aec4f48d7fbb4b2bbdad596fd295c43e7cbb5195ba4bec3e4daa9bcb6a1b33fd4d60bbfd324
+  data.tar.gz: 3c01c3ad96f481054441fe406c1680cd4c147ccb2bdedc1d46c5ad7adbdfa08fa37dda52647b4b025dc48cde54d21312eb026dfe656fdea893008f8eb85b146e

data/.github/workflows/tests.yml

@@ -15,8 +15,8 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: [ '2.7', '3.0', '3.1', '3.2', 'jruby-9.3', 'jruby-9.4' ]
-        es_version: ['8.4-SNAPSHOT', '8.5-SNAPSHOT', '8.6-SNAPSHOT']
+        ruby: [ '3.0', '3.1', '3.2', 'jruby-9.3', 'jruby-9.4' ]
+        es_version: ['8.7-SNAPSHOT', '8.8-SNAPSHOT', '8.9-SNAPSHOT']
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v2
@@ -53,8 +53,8 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: [ '2.7', '3.0', '3.1', '3.2', 'jruby-9.3' ]
-        es_version: ['8.6-SNAPSHOT']
+        ruby: [ '3.0', '3.1', '3.2', 'jruby-9.3' ]
+        es_version: ['8.9-SNAPSHOT']
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v2

data/CHANGELOG.md

@@ -1,8 +1,20 @@
+## 8.2.2
+
+Tested versions of Ruby: (MRI) 3.0, 3.1, 3.2, JRuby 9.3 and JRuby 9.4
+
+- Refactors `apply_headers` in base and manticore implementation: When passing in an object to the initializer, `apply_headers` would mutate this object and in certain conditions, this would raise `RuntimeError` in JRuby 9.3 and `ConcurrencyError` in JRuby 9.4. This update clones the options object instead.
+
+## 8.2.1
+
+Tested versions of Ruby: (MRI) 2.7, 3.0, 3.1, 3.2, JRuby 9.3 and JRuby 9.4. Ruby 2.7's end of life is coming in a few days, so this'll probably be the last release to test for Ruby 2.7.
+
+- Fixes parsing ipv4 addresses like `inet[/127.0.0.1:9200]` in sniffer, [issue #48](https://github.com/elastic/elastic-transport-ruby/issues/48). [Pull Request](https://github.com/elastic/elastic-transport-ruby/pull/49) by [@robbat2](https://github.com/robbat2), thank you!
+
 ## 8.2.0
 
 Tested versions of Ruby: (MRI) 2.7, 3.0, 3.1, 3.2, JRuby 9.3 and JRuby 9.4.
 
-- Fixes [issue #44](https://github.com/elastic/elastic-transport-ruby/issues/44), raising `Elasticsearch::Transport::Transport::Error` instead of `Faraday::ConnectionFailed` (or any other Faraday error class) when a host is unreachable.
+- Fixes [issue #44](https://github.com/elastic/elastic-transport-ruby/issues/44), raising `Elastic::Transport::Transport::Error` instead of `Faraday::ConnectionFailed` (or any other Faraday error class) when a host is unreachable.
 - Removes development dependency on `ansi`, it hasn't been updated for years.
 - Adds `rake console` task to run IRB with the Elastic transport client libraries loaded.
 - General refactors, cleanup and updates in code for `base.rb` (The base class used by HTTP implementations Faraday, Manticore, Curb), `errors.rb`, `faraday.rb`, and more.

data/CONTRIBUTING.md

@@ -0,0 +1,58 @@
+# Contributing to Elasticsearch Transport Ruby
+
+
+This guide assumes Ruby is already installed. We follow Ruby’s own maintenance policy and officially support all currently maintained versions per [Ruby Maintenance Branches](https://www.ruby-lang.org/en/downloads/branches/). So we can't guarantee the code works for versions of Ruby that have reached their end of life.
+
+To work on the code, clone the project first:
+
+```
+$ git clone git@github.com:elastic/elastic-transport-ruby.git
+```
+
+And run `bundle install` to install dependencies.
+
+# Tests
+
+There are several test tasks in the Rakefile, you can check them with `rake -T` from the project's root directory.
+
+```bash
+rake test:unit
+rake test:spec
+rake test:integration
+```
+
+Use `COVERAGE=true` before running a test task to check coverage with Simplecov.
+
+Github's pull requests and issues are used to communicate, send bug reports and code contributions. Bug fixes and features must be covered by unit tests.
+
+You need an Elasticsearch cluster running for integration tests. The tests will use the default host `localhost:9200`, but you can change this value by setting the environment variables `TEST_ES_SERVER` or `ELASTICSEARCH_HOSTS`:
+
+```
+$ TEST_ES_SERVER=host:port rake test:integration
+```
+
+A rake task is included to launch an Elasticsearch cluster with Docker. You need to install docker on your system and then run:
+```bash
+$ rake docker:start[VERSION]
+```
+
+E.g.:
+```bash
+$ rake docker:start[8.0.0-alpha1]
+```
+
+You can find the available version in [Docker @ Elastic](https://www.docker.elastic.co/r/elasticsearch).
+
+# Contributing
+
+The process for contributing is:
+
+1. It is best to do your work in a separate Git branch. This makes it easier to synchronise your changes with [`rebase`](http://mislav.uniqpath.com/2013/02/merge-vs-rebase/).
+
+2. Make sure your changes don't break any existing tests, and that you add tests for both bugfixes and new functionality.
+
+3. **Sign the contributor license agreement.**
+Please make sure you have signed the [Contributor License Agreement](https://www.elastic.co/contributor-agreement/). We are not asking you to assign copyright to us, but to give us the right to distribute your code without restriction. We ask this of all contributors in order to assure our users of the origin and continuing existence of the code. You only need to sign the CLA once.
+
+4. Submit a pull request.
+Push your local changes to your forked copy of the repository and submit a pull request. In the pull request, describe what your changes do and mention the number of the issue where discussion has taken place, eg “Closes #123″.

data/README.md

@@ -23,32 +23,7 @@ This gem is compatible with maintained Ruby versions. See [Ruby Maintenance Bran
 
 ## Development and Community
 
-For local development, clone the repository and run `bundle install`. See `rake -T` for a list of available Rake tasks for running tests, generating documentation, starting a testing cluster, etc.
-
-Bug fixes and features must be covered by unit tests.
-
-A rake task is included to launch an Elasticsearch cluster with Docker. You need to install docker on your system and then run:
-```bash
-$ rake docker:start[VERSION]
-```
-
-E.g.:
-```bash
-$ rake docker:start[8.0.0-alpha1]
-```
-
-You can find the available version in [Docker @ Elastic](https://www.docker.elastic.co/r/elasticsearch).
-
-To run tests, launch a testing cluster and use the Rake tasks:
-
-```bash
-time rake test:unit
-time rake test:integration
-```
-
-Use `COVERAGE=true` before running a test task to check coverage with Simplecov.
-
-Github's pull requests and issues are used to communicate, send bug reports and code contributions.
+See [CONTRIBUTING](./CONTRIBUTING.md).
 
 ## License
 

data/elastic-transport.gemspec

@@ -24,7 +24,7 @@ Gem::Specification.new do |s|
   s.name          = "elastic-transport"
   s.version       = Elastic::Transport::VERSION
   s.authors       = ['Karel Minarik', 'Emily Stolfo', 'Fernando Briano']
-  s.email         = ['support@elastic.co']
+  s.email         = ['clients-team@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/client.rb

@@ -122,8 +122,7 @@ module Elastic
       # @yield [faraday] Access and configure the `Faraday::Connection` instance directly with a block
       #
       def initialize(arguments = {}, &block)
-        @options = arguments.transform_keys(&:to_sym)
-        @arguments = @options
+        @arguments = arguments.transform_keys(&:to_sym)
         @arguments[:logger] ||= @arguments[:log]   ? DEFAULT_LOGGER.call() : nil
         @arguments[:tracer] ||= @arguments[:trace] ? DEFAULT_TRACER.call() : nil
         @arguments[:reload_connections] ||= false
@@ -134,7 +133,6 @@ module Elastic
         @arguments[:transport_options]  ||= {}
         @arguments[:http]               ||= {}
         @arguments[:enable_meta_header] = arguments.fetch(:enable_meta_header, true)
-        @options[:http]                 ||= {}
 
         @hosts ||= __extract_hosts(@arguments[:hosts] ||
                                    @arguments[:host] ||
@@ -236,7 +234,7 @@ module Elastic
                 end
 
         host_list = hosts.map { |host| __parse_host(host) }
-        @options[:randomize_hosts] ? host_list.shuffle! : host_list
+        @arguments[:randomize_hosts] ? host_list.shuffle! : host_list
       end
 
       def __parse_host(host)
@@ -273,8 +271,8 @@ module Elastic
                        raise ArgumentError, "Please pass host as a String, URI or Hash -- #{host.class} given."
                      end
 
-        @options[:http][:user] ||= host_parts[:user]
-        @options[:http][:password] ||= host_parts[:password]
+        @arguments[:http][:user] ||= host_parts[:user]
+        @arguments[:http][:password] ||= host_parts[:password]
         host_parts[:port] = host_parts[:port].to_i if host_parts[:port]
         host_parts[:path].chomp!('/') if host_parts[:path]
         host_parts

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

@@ -431,7 +431,7 @@ module Elastic
         end
 
         def apply_headers(client, options)
-          headers = options[:headers] || {}
+          headers = options[:headers].clone || {}
           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(client)
           client.headers[ACCEPT_ENCODING] = GZIP if use_compression?

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

@@ -162,7 +162,7 @@ module Elastic
           private
 
           def apply_headers(options)
-            headers = options[:headers] || options.dig(:transport_options, :headers) || {}
+            headers = options[:headers].clone || options.dig(:transport_options, :headers).clone || {}
             headers[CONTENT_TYPE_STR] = find_value(headers, CONTENT_TYPE_REGEX) || DEFAULT_CONTENT_TYPE
             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?

data/lib/elastic/transport/transport/sniffer.rb

@@ -76,7 +76,9 @@ module Elastic
         end
 
         def parse_publish_address(publish_address)
-          # publish_address is in the format hostname/ip:port
+          # When publish_address is in the format 'inet[hostname/ip:port]'
+          return parse_address_port(publish_address[6..-2]) if publish_address =~ /^inet\[.*\]$/
+
           if publish_address =~ /\//
             parts = publish_address.partition('/')
             [ parts[0], parse_address_port(parts[2])[1] ]

data/lib/elastic/transport/version.rb

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

data/spec/elastic/transport/sniffer_spec.rb

@@ -257,6 +257,24 @@ describe Elastic::Transport::Transport::Sniffer do
       end
     end
 
+    context 'when the address is IPv4' do
+      let(:publish_address) do
+        'inet[/127.0.0.1:9200]'
+      end
+
+      it 'parses the response' do
+        expect(hosts.size).to eq(1)
+      end
+
+      it 'correctly parses the host' do
+        expect(hosts[0][:host]).to eq('127.0.0.1')
+      end
+
+      it 'correctly parses the port' do
+        expect(hosts[0][:port]).to eq('9200')
+      end
+    end
+
     context 'when the transport has :randomize_hosts option' do
       let(:raw_response) do
         { 'nodes' => { 'n1' => { 'http' => { 'publish_address' => '127.0.0.1:9250' } },

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: elastic-transport
 version: !ruby/object:Gem::Version
-  version: 8.2.0
+  version: 8.2.2
 platform: ruby
 authors:
 - Karel Minarik
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-01-30 00:00:00.000000000 Z
+date: 2023-07-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -255,7 +255,7 @@ description: 'Low level Ruby client for Elastic. See the `elasticsearch` or `ela
 
   '
 email:
-- support@elastic.co
+- clients-team@elastic.co
 executables: []
 extensions: []
 extra_rdoc_files:
@@ -268,6 +268,7 @@ files:
 - ".github/workflows/tests.yml"
 - ".gitignore"
 - CHANGELOG.md
+- CONTRIBUTING.md
 - Gemfile
 - Gemfile-faraday1.gemfile
 - LICENSE
@@ -338,7 +339,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.4.13
 signing_key: 
 specification_version: 4
 summary: Low level Ruby client for Elastic services.