elasticsearch-transport 7.6.0 → 7.7.0.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 954bd7789cddfa4566eb6776fd47a747c88507efdbaa0fe2bcdd74e374ecbc40
-  data.tar.gz: e2103eae1740df19f3fb1ec25f9e49bb83d86d511611d8e6bbbefb9ec5ce2bfc
+  metadata.gz: 514552f2ef4e92c8ba16f376cbe452963c62e79afcb4feba64ff62a9562d9463
+  data.tar.gz: 48dabfa3c58ab1aa80af7c1fe5b487582c46f8822f7fec6816f67da16f11959e
 SHA512:
-  metadata.gz: ea3ea8fcd19ce804cff739c0c6e1671c1eede31a47414442c718b100b3c22c627a9341f58150be12ea0f3f70d98e2465b70f4eeae877353f7b930deaafe3372e
-  data.tar.gz: 6a2adbbe5f396eb12e9c7a558dc66bf613b42c2464fd82f9205344777b2c9a560b8fd27482cc058a66b746defe4c66a1920649af04621a14aabe2a455a4b0c8b
+  metadata.gz: 97084b1748a5043dbef690c1d946e893a7a4d565d149e1369d70eacbce18cb9ce0fda5c450cc113acce6beaf09701173d8f9d08f0186e028677ef5e2f84fa647
+  data.tar.gz: e58a5aa7a30cc7a282649bb87cc957f25a33b98b1ca8554c157ee855b52af81b4247da82ac7d3ecffaef78b3a9fc3b6584258ba3f0e63000d59c4c95a9f8280c

data/README.md

@@ -37,7 +37,7 @@ Currently these libraries will be automatically detected and used:
 - [HTTPClient](https://rubygems.org/gems/httpclient)
 - [Net::HTTP::Persistent](https://rubygems.org/gems/net-http-persistent)
 
-**Note on [Typhoeus](https://github.com/typhoeus/typhoeus)**: Typhoeus is compatible and will be automatically detected too. However, the latest release (v1.3.1 at the moment of writing this) is not compatible with Faraday 1.0. [It still uses the deprecated `Faraday::Error` namespace](https://github.com/typhoeus/typhoeus/blob/v1.3.1/lib/typhoeus/adapters/faraday.rb#L100). If you want to use it with this gem, we suggest getting `master` from GitHub, since this has been fixed for v1.4.0. We'll update this if/when v1.4.0 is released.
+**Note on [Typhoeus](https://github.com/typhoeus/typhoeus)**: Typhoeus is compatible and will be automatically detected too. However, the latest release (v1.3.1 at the moment of writing this) is not compatible with Faraday 1.0. [It still uses the deprecated `Faraday::Error` namespace](https://github.com/typhoeus/typhoeus/blob/v1.3.1/lib/typhoeus/adapters/faraday.rb#L100). If you want to use it with this gem, we suggest getting `master` from GitHub, since this has been fixed for v1.4.0. We'll update this if/when v1.4.0 is released.a
 
 For detailed information, see example configurations [below](#transport-implementations).
 
@@ -78,6 +78,7 @@ Full documentation is available at <http://rubydoc.info/gems/elasticsearch-trans
 * [Connect using an Elastic Cloud ID](#connect-using-an-elastic-cloud-id)
 * [Authentication](#authentication)
 * [Logging](#logging)
+* [Custom HTTP Headers](#custom-http-headers)
 * [Identifying running tasks with X-Opaque-Id](#identifying-running-tasks-with-x-opaque-id)
 * [Setting Timeouts](#setting-timeouts)
 * [Randomizing Hosts](#randomizing-hosts)
@@ -189,30 +190,61 @@ Elasticsearch::Client.new(
 To log requests and responses to standard output with the default logger (an instance of Ruby's {::Logger} class),
 set the `log` argument:
 
-    Elasticsearch::Client.new log: true
+```ruby
+Elasticsearch::Client.new log: true
+```
+
 
 To trace requests and responses in the _Curl_ format, set the `trace` argument:
 
-    Elasticsearch::Client.new trace: true
+```ruby
+Elasticsearch::Client.new trace: true
+```
 
 You can customize the default logger or tracer:
 
+```ruby
     client.transport.logger.formatter = proc { |s, d, p, m| "#{s}: #{m}\n" }
     client.transport.logger.level = Logger::INFO
+```
 
 Or, you can use a custom `::Logger` instance:
 
-    Elasticsearch::Client.new logger: Logger.new(STDERR)
+```ruby
+Elasticsearch::Client.new logger: Logger.new(STDERR)
+```
 
 You can pass the client any conforming logger implementation:
 
-    require 'logging' # https://github.com/TwP/logging/
+```ruby
+require 'logging' # https://github.com/TwP/logging/
+
+log = Logging.logger['elasticsearch']
+log.add_appenders Logging.appenders.stdout
+log.level = :info
+
+client = Elasticsearch::Client.new logger: log
+```
 
-    log = Logging.logger['elasticsearch']
-    log.add_appenders Logging.appenders.stdout
-    log.level = :info
+### Custom HTTP Headers
+
+You can set a custom HTTP header on the client's initializer:
+
+```ruby
+client = Elasticsearch::Client.new(
+  transport_options: {
+    headers:
+      {user_agent: "My App"}
+  }
+)
+```
+
+You can also pass in `headers` as a parameter to any of the API Endpoints to set custom headers for the request:
+
+```ruby
+client.search(index: 'myindex', q: 'title:test', headers: {user_agent: "My App"})
+```
 
-    client = Elasticsearch::Client.new logger: log
 ### Identifying running tasks with X-Opaque-Id
 
 The X-Opaque-Id header allows to track certain calls, or associate certain tasks with the client that started them ([more on the Elasticsearch docs](https://www.elastic.co/guide/en/elasticsearch/reference/master/tasks.html#_identifying_running_tasks)). To use this feature, you need to set an id for `opaque_id` on the client on each request. Example:
@@ -330,25 +362,29 @@ preferring HTTP clients with support for persistent connections.
 
 To use the [_Patron_](https://github.com/toland/patron) HTTP, for example, just require it:
 
-    require 'patron'
+```ruby
+require 'patron'
+```
 
 Then, create a new client, and the _Patron_  gem will be used as the "driver":
 
-    client = Elasticsearch::Client.new
+```ruby
+client = Elasticsearch::Client.new
 
-    client.transport.connections.first.connection.builder.adapter
-    # => Faraday::Adapter::Patron
+client.transport.connections.first.connection.builder.adapter
+# => Faraday::Adapter::Patron
 
-    10.times do
-      client.nodes.stats(metric: 'http')['nodes'].values.each do |n|
-        puts "#{n['name']} : #{n['http']['total_opened']}"
-      end
-    end
+10.times do
+  client.nodes.stats(metric: 'http')['nodes'].values.each do |n|
+    puts "#{n['name']} : #{n['http']['total_opened']}"
+  end
+end
 
-    # => Stiletoo : 24
-    # => Stiletoo : 24
-    # => Stiletoo : 24
-    # => ...
+# => Stiletoo : 24
+# => Stiletoo : 24
+# => Stiletoo : 24
+# => ...
+```
 
 To use a specific adapter for _Faraday_, pass it as the `adapter` argument:
 

data/elasticsearch-transport.gemspec

@@ -34,7 +34,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'elasticsearch-extensions'
   s.add_development_dependency 'minitest'
   s.add_development_dependency 'minitest-reporters'
-  s.add_development_dependency 'rake', '~> 11.1'
+  s.add_development_dependency 'rake', '~> 13'
   s.add_development_dependency 'require-prof' unless defined?(JRUBY_VERSION) || defined?(Rubinius)
   s.add_development_dependency 'ruby-prof'    unless defined?(JRUBY_VERSION) || defined?(Rubinius)
   s.add_development_dependency 'simplecov', '~> 0.17', '< 0.18'

data/lib/elasticsearch/transport/version.rb

@@ -4,6 +4,6 @@
 
 module Elasticsearch
   module Transport
-    VERSION = "7.6.0"
+    VERSION = "7.7.0.pre"
   end
 end

data/spec/elasticsearch/transport/client_spec.rb

@@ -1129,10 +1129,22 @@ describe Elasticsearch::Transport::Client do
           allow(client).to receive(:perform_request) { OpenStruct.new(body: '') }
           expect { client.search(opaque_id: 'opaque_id') }.not_to raise_error
           expect(client).to have_received(:perform_request)
-            .with('GET', '_search', { opaque_id: 'opaque_id' }, nil)
+            .with('GET', '_search', { opaque_id: 'opaque_id' }, nil, {})
         end
       end
     end
+
+    context 'when a header is set on an endpoint request' do
+      let(:client) { described_class.new(host: hosts) }
+      let(:headers) { { 'user-agent' => 'my ruby app' } }
+
+      it 'performs the request with the header' do
+        allow(client).to receive(:perform_request) { OpenStruct.new(body: '') }
+        expect { client.search(headers: headers) }.not_to raise_error
+        expect(client).to have_received(:perform_request)
+          .with('GET', '_search', {}, nil, headers)
+      end
+    end
   end
 
   context 'when the client connects to Elasticsearch' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: elasticsearch-transport
 version: !ruby/object:Gem::Version
-  version: 7.6.0
+  version: 7.7.0.pre
 platform: ruby
 authors:
 - Karel Minarik
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-07 00:00:00.000000000 Z
+date: 2020-04-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -114,14 +114,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11.1'
+        version: '13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11.1'
+        version: '13'
 - !ruby/object:Gem::Dependency
   name: require-prof
   requirement: !ruby/object:Gem::Requirement
@@ -419,9 +419,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.1.2
 signing_key: