elastic-transport 8.1.3 → 8.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a0528484d88479954777f01b3d005be41608713eeda4eb757f223b37dcf4de63
-  data.tar.gz: 0351a6d3a75eb9b0df9899a177a26f92666df9422acca5d0b87fb63f87cd625a
+  metadata.gz: aca3fc15486eeb7455f903dbaa5b6a594d4fd410f895cff6b3bf832c0dcad8b4
+  data.tar.gz: 4fd798b71008e3bba436434a5c98321fcd2b15934a6244908966c8b9cdd5c3e0
 SHA512:
-  metadata.gz: 29f63fc511e913532c87e2ff56db0fd2af466ddc07aac40345e4130691d93e6823f4450ed9cb6b1d50c12a41183a2c9e12f6678129541ef8408cd5894bac544c
-  data.tar.gz: d8c965dfb93c49ce3b44ed802b82e853d1a6049d49b0b3e3426cd2f6ce9e37385bf1536212ec024159d6efdd25f60b58a90afe864972e7c0a4247c5a075b372a
+  metadata.gz: a33a557b17fc75fbc2cd9b8fb713603b67c35097fce929ccdee0b81b76c58c05885286aeb1aeed8c72068d6c12a83b51e6dc1f9f07678d6e17f51ce962cb0af8
+  data.tar.gz: 5105d1a01106314206e250a105329abfb9553f6c12170bafaf8b7eb4741f5d7b9b414027919aac9df9867ee0859fbfce6b492fbc64a8335f17eebcc7fd109cf4

data/.github/workflows/license.yml

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

data/.github/workflows/tests.yml

@@ -1,23 +1,25 @@
-name: 8.1 tests
+name: main tests
 on:
   push:
     branches:
-      - 8.1
+      - main
   pull_request:
     branches:
-      - 8.1
+      - main
 jobs:
-  test-ruby:
+  test:
+    name: 'Main tests'
     env:
       TEST_ES_SERVER: http://localhost:9250
       PORT: 9250
     strategy:
       fail-fast: false
       matrix:
-        ruby: [ '2.7', '3.0', '3.1', '3.2', '3.3', 'jruby-9.3', 'jruby-9.4' ]
+        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']
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v2
     - name: Increase system limits
       run: |
         sudo swapoff -a
@@ -26,7 +28,7 @@ jobs:
         sudo sysctl -w vm.max_map_count=262144
     - uses: elastic/elastic-github-actions/elasticsearch@master
       with:
-        stack-version: 8.12-SNAPSHOT
+        stack-version: ${{ matrix.es_version }}
         security-enabled: false
     - uses: ruby/setup-ruby@v1
       with:
@@ -43,4 +45,42 @@ jobs:
       run: bundle exec rake test:spec
     - name: integration tests
       run: bundle exec rake test:integration
-
+  test-faraday1:
+    name: 'Test Faraday 1'
+    env:
+      TEST_ES_SERVER: http://localhost:9250
+      PORT: 9250
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [ '2.7', '3.0', '3.1', '3.2', 'jruby-9.3' ]
+        es_version: ['8.6-SNAPSHOT']
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Increase system limits
+      run: |
+        sudo swapoff -a
+        sudo sysctl -w vm.swappiness=1
+        sudo sysctl -w fs.file-max=262144
+        sudo sysctl -w vm.max_map_count=262144
+    - uses: elastic/elastic-github-actions/elasticsearch@master
+      with:
+        stack-version: ${{ matrix.es_version }}
+        security-enabled: false
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+    - name: Build and test with Rake
+      run: |
+        sudo apt-get update
+        sudo apt-get install libcurl4-openssl-dev
+        ruby -v
+        gem install bundler
+        BUNDLE_GEMFILE=./Gemfile-faraday1.gemfile bundle install
+    - name: faraday1 unit tests
+      run: BUNDLE_GEMFILE=./Gemfile-faraday1.gemfile bundle exec rake test:faraday1:unit
+    - name: specs
+      run: BUNDLE_GEMFILE=./Gemfile-faraday1.gemfile bundle exec rake test:faraday1:spec
+    - name: integration tests
+      run: BUNDLE_GEMFILE=./Gemfile-faraday1.gemfile bundle exec rake test:faraday1:integration

data/.gitignore

@@ -5,7 +5,7 @@
 .bundle
 .config
 .yardoc
-Gemfile.lock
+Gemfile*.lock
 InstalledFiles
 _yardoc
 coverage

data/CHANGELOG.md

@@ -1,22 +1,11 @@
-## 8.1.3
+## 8.2.0
 
-Tested versions of Ruby: (MRI) 2.7, 3.0, 3.1, 3.2, 3.3, JRuby 9.3 and JRuby 9.4
+Tested versions of Ruby: (MRI) 2.7, 3.0, 3.1, 3.2, JRuby 9.3 and JRuby 9.4.
 
-- Removes unneccessary `require 'base64'` found thanks to warning in Ruby 3.3. So this removes the warning too if you were using Ruby 3.3.
-
-## 8.1.2
-
-Backports the following fix from 8.2:
-
-- 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.1.1
-
-Backports the following updates from 8.2:
-
-- 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.
-- 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.
-- 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!
+- 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.
+- 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.
 
 ## 8.1.0
 

data/Gemfile

@@ -20,15 +20,11 @@ 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', __dir__)
-  gem 'elasticsearch-api', path: File.expand_path('../elasticsearch-api', __dir__), require: false
-end
-
-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
+  gem 'faraday-httpclient'
+  gem 'faraday-net_http_persistent'
+  gem 'faraday-patron' unless defined? JRUBY_VERSION
+  gem 'faraday-typhoeus'
   gem 'rspec'
   if defined?(JRUBY_VERSION)
     gem 'pry-nav'

data/Gemfile-faraday1.gemfile

@@ -0,0 +1,39 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+source 'https://rubygems.org'
+
+# Usage:
+#
+# $ BUNDLE_GEMFILE=./Gemfile-faraday1.gemfile bundle install
+# $ BUNDLE_GEMFILE=./Gemfile-faraday1.gemfile bundle exec rake test:faraday1:unit
+
+gem 'faraday', '~> 1'
+gemspec path: './'
+
+group :development, :test do
+  gem 'httpclient'
+  gem 'net-http-persistent'
+  gem 'patron' unless defined? JRUBY_VERSION
+  gem 'rspec'
+  gem 'typhoeus'
+  if defined?(JRUBY_VERSION)
+    gem 'pry-nav'
+  else
+    gem 'pry-byebug'
+  end
+end

data/README.md

@@ -15,7 +15,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://www.elastic.co/guide/en/elasticsearch/client/ruby-api/current/advanced-config.html) to read about more configuration options.**
+**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.**
 
 ## Compatibility
 

data/Rakefile

@@ -18,13 +18,22 @@
 require 'bundler/gem_tasks'
 require 'mkmf'
 
-desc "Run unit tests"
+desc 'Run unit tests'
 task default: 'test:unit'
 task test: 'test:unit'
 
 # ----- Test tasks ------------------------------------------------------------
 require 'rake/testtask'
 require 'rspec/core/rake_task'
+FARADAY1_GEMFILE = 'Gemfile-faraday1.gemfile'.freeze
+GEMFILES = ['Gemfile', FARADAY1_GEMFILE].freeze
+
+task :install do
+  GEMFILES.each do |gemfile|
+    gemfile = File.expand_path("../#{gemfile}", __FILE__)
+    sh "bundle install --gemfile #{gemfile}"
+  end
+end
 
 namespace :test do
   RSpec::Core::RakeTask.new(:spec)
@@ -46,6 +55,7 @@ namespace :test do
   desc 'Run all tests'
   task :all do
     Rake::Task['test:unit'].invoke
+    Rake::Task['test:spec'].invoke
     Rake::Task['test:integration'].invoke
   end
 
@@ -53,6 +63,34 @@ namespace :test do
     test.libs << 'lib' << 'test'
     test.test_files = FileList['test/profile/**/*_test.rb']
   end
+
+  namespace :faraday1 do
+    desc 'Faraday 1: Run RSpec with dependency on Faraday 1'
+    task :spec do
+      sh "BUNDLE_GEMFILE=#{FARADAY1_GEMFILE} bundle exec rspec"
+    end
+
+    desc 'Faraday 1: Run unit tests with dependency on Faraday 1'
+    task :unit do
+      Dir.glob('./test/unit/**/**.rb').each do |test|
+        sh "BUNDLE_GEMFILE=#{FARADAY1_GEMFILE} ruby -Ilib:test #{test}"
+      end
+    end
+
+    desc 'Faraday 1: Run integration tests with dependency on Faraday 1'
+    task :integration do
+      Dir.glob('./test/integration/**/**.rb').each do |test|
+        sh "BUNDLE_GEMFILE=#{FARADAY1_GEMFILE} ruby -Ilib:test #{test}"
+      end
+    end
+
+    desc 'Faraday 1: Run all tests'
+    task :all do
+      Rake::Task['test:faraday1:unit'].invoke
+      Rake::Task['test:faraday1:spec'].invoke
+      Rake::Task['test:faraday1:integration'].invoke
+    end
+  end
 end
 
 namespace :docker do
@@ -72,6 +110,15 @@ namespace :docker do
   end
 end
 
+desc 'Run Ruby console with the Elastic transport client libraries loaded'
+task :console do
+  require 'irb'
+  require 'irb/completion'
+  require 'elastic-transport'
+  ARGV.clear
+  IRB.start
+end
+
 # ----- Documentation tasks ---------------------------------------------------
 require 'yard'
 YARD::Rake::YardocTask.new(:doc) do |t|

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         = ['clients-team@elastic.co']
+  s.email         = ['support@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'
@@ -44,20 +44,18 @@ Gem::Specification.new do |s|
 
   s.required_ruby_version = '>= 2.5'
 
+  s.add_dependency 'faraday', '< 3'
   s.add_dependency 'multi_json'
-  s.add_dependency 'faraday', '~> 1'
 
+  # Faraday Adapters
+  s.add_development_dependency 'manticore' if defined? JRUBY_VERSION
+  s.add_development_dependency 'curb' unless defined? JRUBY_VERSION
   s.add_development_dependency 'bundler'
   s.add_development_dependency 'cane'
-  s.add_development_dependency 'curb'   unless defined? JRUBY_VERSION
   s.add_development_dependency 'hashie'
-  s.add_development_dependency 'httpclient'
-  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)
@@ -65,7 +63,6 @@ Gem::Specification.new do |s|
   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.description = <<-DESC.gsub(/^    /, '')

data/lib/elastic/transport/client.rb

@@ -15,6 +15,7 @@
 # specific language governing permissions and limitations
 # under the License.
 
+require 'base64'
 require 'elastic/transport/meta_header'
 
 module Elastic
@@ -282,24 +283,26 @@ module Elastic
       # Auto-detect the best adapter (HTTP "driver") available, based on libraries
       # loaded by the user, preferring those with persistent connections
       # ("keep-alive") by default
+      # Check adapters based on the usage of Faraday 1 or 2. Faraday should be defined here
+      # since this is only called when transport class is Transport::HTTP::Faraday
       #
       # @return [Symbol]
       #
       # @api private
       #
       def __auto_detect_adapter
-        case
-        when defined?(::Patron)
-          :patron
-        when defined?(::Typhoeus)
-          :typhoeus
-        when defined?(::HTTPClient)
-          :httpclient
-        when defined?(::Net::HTTP::Persistent)
-          :net_http_persistent
+        if Gem::Version.new(Faraday::VERSION) >= Gem::Version.new(2)
+          return :patron if defined?(Faraday::Adapter::Patron)
+          return :typhoeus if defined?(Faraday::Adapter::Typhoeus)
+          return :httpclient if defined?(Faraday::Adapter::HTTPClient)
+          return :net_http_persistent if defined?(Faraday::Adapter::NetHttpPersistent)
         else
-          ::Faraday.default_adapter
+          return :patron if defined?(::Patron)
+          return :typhoeus if defined?(::Typhoeus)
+          return :httpclient if defined?(::HTTPClient)
+          return :net_http_persistent if defined?(::Net::HTTP::Persistent)
         end
+        ::Faraday.default_adapter
       end
     end
   end

data/lib/elastic/transport/meta_header.rb

@@ -15,6 +15,8 @@
 # specific language governing permissions and limitations
 # under the License.
 
+require 'base64'
+
 module Elastic
   module Transport
     # Methods for the Elastic meta header used by Cloud.
@@ -101,31 +103,31 @@ module Elastic
           adapter_version = case @arguments[:adapter]
                    when :patron
                      version = Patron::VERSION if defined?(::Patron::VERSION)
-                     {pt: version}
+                     { pt: version }
                    when :net_http
                      version = if defined?(Net::HTTP::VERSION)
                                  Net::HTTP::VERSION
                                elsif defined?(Net::HTTP::HTTPVersion)
                                  Net::HTTP::HTTPVersion
                                end
-                     {nh: version}
+                     { nh: version }
                    when :typhoeus
                      version = Typhoeus::VERSION if defined?(::Typhoeus::VERSION)
-                     {ty: version}
+                     { ty: version }
                    when :httpclient
                      version = HTTPClient::VERSION if defined?(HTTPClient::VERSION)
-                     {hc: version}
+                     { hc: version }
                    when :net_http_persistent
                      version = Net::HTTP::Persistent::VERSION if defined?(Net::HTTP::Persistent::VERSION)
-                     {np: version}
+                     { np: version }
                    else
                      {}
                    end
-          {fd: Faraday::VERSION}.merge(adapter_version)
+          { fd: Faraday::VERSION }.merge(adapter_version)
         elsif defined?(Transport::HTTP::Curb) && @transport_class == Transport::HTTP::Curb
-          {cl: Curl::CURB_VERSION}
+          { cl: Curl::CURB_VERSION }
         elsif defined?(Transport::HTTP::Manticore) && @transport_class == Transport::HTTP::Manticore
-          {mc: Manticore::VERSION}
+          { mc: Manticore::VERSION }
         end
       end
     end