opensearch-transport 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b809e35525d32ad2894329c5ce3b8baf64d71642e757cc028d7349eca78767e0
-  data.tar.gz: 02af151d8dbcfdc0e3d3fe7135c3e7cda0ea7d164d54288f719552b20dec80ab
+  metadata.gz: e414746942105120cd20aeda377568e039f869009de7d02de8162f70b8510d6d
+  data.tar.gz: fdca1d3e46fb709f3881732758af151223d796bcbbd5270527cdf39a0b164b4a
 SHA512:
-  metadata.gz: 95a242a7809cefd6d62a1251251e555d7292868023bfc605ed50bfdb48d4e0718191f0b3f99f5c28318bd2b7669a54a3e8583127f34cb9f1fcdec1f2e54a9826
-  data.tar.gz: eed74608e96e773770165a6e1a62889391ab14d5837640215e69e1f73bf10b748eeb34fa1e3010a6c84f8494b61291546e99d548a9ef9904b1cb5282808a7fe7
+  metadata.gz: 39aecd9063de2387b8defe7bd1ab2fa87e2545199b9c60ffeabd8e8febcd5350dec33990c5948994606757196284fe03fa56e060848026eb425a75fd2954b90d
+  data.tar.gz: 38a4f956daf5351aabb2ab2308ab93d35fa576feee35a6a554c6f5b5578f8c629c21ea1eb21eaea8299692ccc2f75c4d5fc3ab4628ff2e029c06729a7fd9b4f8

data/Gemfile

@@ -37,6 +37,8 @@ if File.exist? File.expand_path('../opensearch/opensearch.gemspec', __dir__)
   gem 'opensearch-ruby', path: File.expand_path('../opensearch', __dir__), require: false
 end
 
+gem 'faraday', ENV['FARADAY_VERSION'], require: false if ENV.key?('FARADAY_VERSION')
+
 group :development, :test do
   gem 'rspec'
   if defined?(JRUBY_VERSION)

data/README.md

@@ -28,16 +28,22 @@ Features overview:
 * Node reloading (based on cluster state) on errors or on demand
 
 For optimal performance, use a HTTP library which supports persistent ("keep-alive") connections,
-such as [patron](https://github.com/toland/patron) or [Typhoeus](https://github.com/typhoeus/typhoeus).
-Just require the library (`require 'patron'`) in your code, and it will be automatically used.
+such as [Patron](https://github.com/toland/patron) or [Typhoeus](https://github.com/typhoeus/typhoeus).
+Most such HTTP libraries are used through the [Faraday](https://rubygems.org/gems/faraday) HTTP library
+and its [adapters](https://github.com/lostisland/awesome-faraday/#adapters).
+
+Include the library's gem and adapter gem, and require the library and adapter in your code, and it will be automatically used.
+If you don't use Bundler, you may need to require the library explicitly (like `require 'faraday/patron'`).
 
 Currently these libraries will be automatically detected and used:
-- [Patron](https://github.com/toland/patron)
-- [Typhoeus](https://github.com/typhoeus/typhoeus)
-- [HTTPClient](https://rubygems.org/gems/httpclient)
-- [Net::HTTP::Persistent](https://rubygems.org/gems/net-http-persistent)
+- [Patron](https://github.com/toland/patron) through [faraday-patron](https://github.com/lostisland/faraday-patron)
+- [Typhoeus](https://github.com/typhoeus/typhoeus) through [faraday-typhoeus](https://github.com/dleavitt/faraday-typhoeus) for Faraday 2 or higher, or Faraday's built-in adapter for Faraday 1.
+- [HTTPClient](https://rubygems.org/gems/httpclient) through [faraday-httpclient](https://github.com/lostisland/faraday-httpclient)
+- [Net::HTTP::Persistent](https://rubygems.org/gems/net-http-persistent) through [faraday-net_http_persistent](https://github.com/lostisland/faraday-net_http_persistent)
+
+**Note on [Typhoeus](https://github.com/typhoeus/typhoeus)**: You need to use v1.4.0 or up since older versions are not compatible with Faraday 1.0 or higher.
 
-**Note on [Typhoeus](https://github.com/typhoeus/typhoeus)**: You need to use v1.4.0 or up since older versions are not compatible with Faraday 1.0.
+**Note on [Faraday](https://rubygems.org/gems/faraday)**: If you use Faraday 2.0 or higher, if the adapter is in a separate gem, you will likely need to declare that gem as well. Only the Net::HTTP adapter gem is included by default. Faraday 1.x includes most common adapter gems already.
 
 For detailed information, see example configurations [below](#transport-implementations).
 
@@ -350,10 +356,22 @@ as a transport implementation.
 It will auto-detect and use an _adapter_ for _Faraday_ based on gems loaded in your code,
 preferring HTTP clients with support for persistent connections.
 
-To use the [_Patron_](https://github.com/toland/patron) HTTP, for example, just require it:
+Faraday uses adapters, usually in separate gems, to connect to the HTTP library. You need to
+make sure that your code refers to both the HTTP library gem and the adapter gem. See this
+list of [Faraday adapters](https://github.com/lostisland/awesome-faraday/#adapters) for details.
+
+To use the [_Patron_](https://github.com/toland/patron) HTTP, for example, you need to refer to these gems:
+
+```ruby
+gem 'patron'
+gem 'faraday-patron'
+```
+
+If you don't use Bundler, you may need to require the libraries explicitly in your code:
 
 ```ruby
 require 'patron'
+require 'faraday/patron'
 ```
 
 Then, create a new client, and the _Patron_  gem will be used as the "driver":
@@ -396,8 +414,6 @@ constructor, use the `transport_options` key:
 
 To configure the _Faraday_ instance directly, use a block:
 
-    require 'patron'
-
     client = OpenSearch::Client.new(host: 'localhost', port: '9200') do |f|
       f.response :logger
       f.adapter  :patron
@@ -406,8 +422,6 @@ To configure the _Faraday_ instance directly, use a block:
 You can use any standard Faraday middleware and plugins in the configuration block. You can also initialize the transport class yourself, and pass it to the client constructor as the `transport` argument:
 
 ```ruby
-require 'patron'
-
 transport_configuration = lambda do |f|
   f.response :logger
   f.adapter  :patron

data/lib/opensearch/transport/client.rb

@@ -330,14 +330,23 @@ module OpenSearch
       # @api private
       #
       def __auto_detect_adapter
+        # Get the Faraday adapter list without initializing it.
+        if Faraday::Adapter.respond_to?(:registered_middleware) # Faraday 2.x
+          adapter = ->(name) { Faraday::Adapter.registered_middleware[name] }
+        elsif Faraday::Adapter.respond_to?(:fetch_middleware) # Faraday 1.x
+          adapter = ->(name) { Faraday::Adapter.fetch_middleware(name) }
+        else
+          adapter = {} # fallback behavior that should never happen
+        end
+        # Pick an adapter that has both the client and adapter defined.
         case
-        when defined?(::Patron)
+        when defined?(::Patron) && adapter[:patron]
           :patron
-        when defined?(::Typhoeus)
+        when defined?(::Typhoeus) && adapter[:typhoeus]
           :typhoeus
-        when defined?(::HTTPClient)
+        when defined?(::HTTPClient) && adapter[:httpclient]
           :httpclient
-        when defined?(::Net::HTTP::Persistent)
+        when defined?(::Net::HTTP::Persistent) && adapter[:net_http_persistent]
           :net_http_persistent
         else
           ::Faraday.default_adapter

data/lib/opensearch/transport/version.rb

@@ -26,6 +26,6 @@
 
 module OpenSearch
   module Transport
-    VERSION = '1.0.0'.freeze
+    VERSION = '1.0.1'.freeze
   end
 end

data/opensearch-transport.gemspec

@@ -61,7 +61,7 @@ Gem::Specification.new do |s|
   s.required_ruby_version = '>= 2.4'
 
   s.add_dependency 'multi_json'
-  s.add_dependency 'faraday', '~> 1'
+  s.add_dependency 'faraday', '>= 1.0', '< 3'
 
   s.add_development_dependency 'ansi'
   s.add_development_dependency 'bundler'
@@ -70,12 +70,15 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'opensearch-ruby'
   s.add_development_dependency 'hashie'
   s.add_development_dependency 'httpclient'
+  s.add_development_dependency 'faraday-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 'faraday-net_http_persistent'
   s.add_development_dependency 'patron' unless defined? JRUBY_VERSION
+  s.add_development_dependency 'faraday-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)
@@ -84,6 +87,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'simplecov'
   s.add_development_dependency 'test-unit', '~> 2'
   s.add_development_dependency 'typhoeus', '~> 1.4'
+  s.add_development_dependency 'faraday-typhoeus' if !ENV.key?('FARADAY_VERSION') && Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('2.6')
   s.add_development_dependency 'yard'
 
   s.description = <<-DESC.gsub(/^    /, '')

data/spec/opensearch/transport/base_spec.rb

@@ -184,7 +184,7 @@ describe OpenSearch::Transport::Transport::Base do
 
       it 'retries on 404 status the specified number of max_retries' do
         expect do
-          client.transport.perform_request('GET', 'myindex/mydoc/1?routing=FOOBARBAZ', {}, nil, nil, retry_on_failure: 5)
+          client.transport.perform_request('GET', 'myindex/_doc/1?routing=FOOBARBAZ', {}, nil, nil, retry_on_failure: 5)
         end.to raise_exception(OpenSearch::Transport::Transport::Errors::NotFound)
       end
     end

data/spec/opensearch/transport/client_spec.rb

@@ -247,7 +247,7 @@ describe OpenSearch::Transport::Client do
       end unless jruby?
     end
 
-    context 'when the adapter is patron' do
+    context 'when the adapter is patron', unless: jruby? do
       let(:adapter) do
         client.transport.connections.all.first.connection.builder.adapter
       end
@@ -275,7 +275,7 @@ describe OpenSearch::Transport::Client do
       end
     end unless jruby?
 
-    context 'when the adapter is specified as a string key' do
+    context 'when the adapter is specified as a string key', unless: jruby? do
       let(:adapter) do
         client.transport.connections.all.first.connection.builder.adapter
       end
@@ -305,7 +305,7 @@ describe OpenSearch::Transport::Client do
       end
     end
 
-    context 'when the Faraday adapter is configured' do
+    context 'when the Faraday adapter is configured', unless: jruby? do
 
       let(:client) do
         described_class.new do |faraday|
@@ -1680,12 +1680,12 @@ describe OpenSearch::Transport::Client do
           client.perform_request('DELETE', '_all')
           client.perform_request('DELETE', 'myindex') rescue
           client.perform_request('PUT', 'myindex', {}, { settings: { number_of_shards: 2, number_of_replicas: 0 } })
-          client.perform_request('PUT', 'myindex/mydoc/1', { routing: 'XYZ', timeout: '1s' }, { foo: 'bar' })
+          client.perform_request('PUT', 'myindex/_doc/1', { routing: 'XYZ', timeout: '1s' }, { foo: 'bar' })
           client.perform_request('GET', '_cluster/health?wait_for_status=green&timeout=2s', {})
         end
 
         let(:response) do
-          client.perform_request('GET', 'myindex/mydoc/1?routing=XYZ')
+          client.perform_request('GET', 'myindex/_doc/1?routing=XYZ')
         end
 
         it 'handles paths and URL paramters' do
@@ -1700,7 +1700,7 @@ describe OpenSearch::Transport::Client do
       context 'when an invalid url is specified' do
         it 'raises an exception' do
           expect {
-            client.perform_request('GET', 'myindex/mydoc/1?routing=FOOBARBAZ')
+            client.perform_request('GET', 'myindex/_doc/1?routing=FOOBARBAZ')
           }.to raise_exception(OpenSearch::Transport::Transport::Errors::NotFound)
         end
       end

data/spec/spec_helper.rb

@@ -29,6 +29,8 @@ if ENV['COVERAGE'] && ENV['CI'].nil?
 end
 
 require 'opensearch-transport'
+require 'faraday/httpclient'
+require 'faraday/net_http_persistent'
 require 'logger'
 require 'ansi/code'
 require 'hashie/mash'
@@ -37,6 +39,8 @@ if defined?(JRUBY_VERSION)
   require 'pry-nav'
 else
   require 'pry-byebug'
+  require 'faraday/patron'
+  require 'faraday/typhoeus' if Gem::Version.new(Faraday::VERSION) >= Gem::Version.new('2')
   require 'opensearch/transport/transport/http/curb'
   require 'curb'
 end

data/test/integration/transport_test.rb

@@ -34,8 +34,10 @@ class OpenSearch::Transport::ClientIntegrationTest < Minitest::Test
     end
 
     should "allow to customize the Faraday adapter to Typhoeus" do
+      # Require the library so autodetection finds it.
       require 'typhoeus'
-      require 'typhoeus/adapters/faraday'
+      # Require the adapter so autodetection finds it.
+      require 'faraday/typhoeus' if Gem::Version.new(Faraday::VERSION) >= Gem::Version.new('2')
 
       transport = OpenSearch::Transport::Transport::HTTP::Faraday.new \
         :hosts => [ { host: @host, port: @port } ] do |f|
@@ -44,11 +46,18 @@ class OpenSearch::Transport::ClientIntegrationTest < Minitest::Test
         end
 
       client = OpenSearch::Transport::Client.new transport: transport
-      client.perform_request 'GET', ''
+      response = client.perform_request 'GET', ''
+
+      assert_respond_to(response.body, :to_hash)
+      assert_not_nil response.body['name']
+      assert_equal 'application/json; charset=UTF-8', response.headers['content-type']
     end unless jruby?
 
     should "allow to customize the Faraday adapter to NetHttpPersistent" do
+      # Require the library so autodetection finds it.
       require 'net/http/persistent'
+      # Require the adapter so autodetection finds it.
+      require 'faraday/net_http_persistent'
 
       transport = OpenSearch::Transport::Transport::HTTP::Faraday.new \
                                                                        :hosts => [ { host: @host, port: @port } ] do |f|

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: opensearch-transport
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Jayesh Hathila
@@ -33,7 +33,7 @@ cert_chain:
   yXikuH6LEVykA8pgOcB9gKsB2/zMd2ZlSj2monM8Qw9EfB14ZSDTYS8VYuwWCeF0
   eFmXXk0ufQFKl1Yll7quHkmQ0PzKkvXTpONBT6qPkXE=
   -----END CERTIFICATE-----
-date: 2021-12-06 00:00:00.000000000 Z
+date: 2022-07-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -53,16 +53,22 @@ dependencies:
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1'
+        version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '1'
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: ansi
   requirement: !ruby/object:Gem::Requirement
@@ -161,6 +167,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday-httpclient
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -217,6 +237,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday-net_http_persistent
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: patron
   requirement: !ruby/object:Gem::Requirement
@@ -231,6 +265,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday-patron
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -343,6 +391,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: faraday-typhoeus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement

metadata.gz.sig

@@ -1 +1,2 @@
-a��v��]~������s�T�aH��ݠ\�,4��ߧ��]��1w����>#�Ӫe�#���~	�����K�d��ƯT�Nj�L8������t�/�j1�w+�Ɉ�������[����A�L���R�j;��D؉�S2����G�Ӌ�-�w�:�i���__��B���U�u0��<�|_�{����3�e�yM~^$��sKs
+V�R$��+)b"�w�5)C�0��ldz�Ƭ���$��ڥd�d�`�s�7-�[+JͯTb��%�����7HӇ�7=8-��G��%�n�d�/bk�A�!^���{�����&0)��֦~h_��w
�+䝤�Et�3��ȁ����&c��˽�����oh��`�M�._�<����&� 
+���0��m�d��#� �C�J�}V%�<�Og