elasticsearch-transport 1.0.9 → 1.0.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 85aa43e17d7dbb5e43514c2c6c8d61030db7bf0f
-  data.tar.gz: 7220157362dbd60f5f003fbe457cb97d5f03983f
+  metadata.gz: daee16fc525cec703b65be13c6ef73521ef246ed
+  data.tar.gz: 8cbc0e8fb197177c69ee2c9eae1f2ce5a3c97eb6
 SHA512:
-  metadata.gz: e86b6d6fdd5d38114b5a8ff506c114a0270d6ee8bccade584badb9bb5aac51c59f181afa162cfb8cfb5da01b9967507a513dafa1a3e157eed20874253424fd4d
-  data.tar.gz: 44569f981a390c4ad0f1a4bb5a3cb766bd03f5fd114f384c4a705c5b59bf69d73759b0e75b445ecd5b4ca7e67a0e9239f4ae8faad76d4228ac281626657dff12
+  metadata.gz: deebc659d3b87ba4c8eaa6333f8f98f7d946c71aabfcf4833dfbdca0afdc9af998b119aaccdc2730667981cacf48f2274d79a75490a2f14a7adb7066f703fb31
+  data.tar.gz: 170dee5bd767cf824e2c69b8233ff642213b3d0a49dbac53931f3287289cca566f7a15818d83492a6420e3b0b3eb887356348d22919bd9927171d1c87bd36a16

data/README.md

@@ -155,6 +155,15 @@ You can pass the client any conforming logger implementation:
 
     client = Elasticsearch::Client.new logger: log
 
+### Setting Timeouts
+
+For many operations in Elasticsearch, the default timeouts of HTTP libraries are too low.
+To increase the timeout, you can use the `request_timeout` parameter:
+
+    Elasticsearch::Client.new request_timeout: 5*60
+
+You can also use the `transport_options` argument documented below.
+
 ### Randomizing Hosts
 
 If you pass multiple hosts to the client, it rotates across them in a round-robin fashion, by default.

data/lib/elasticsearch/transport/client.rb

@@ -59,6 +59,8 @@ module Elasticsearch
       #
       # @option arguments [Boolean] :reload_on_failure Reload connections after failure (false by default)
       #
+      # @option arguments [Integer] :request_timeout The request timeout to be passed to transport in options
+      #
       # @option arguments [Symbol] :adapter A specific adapter for Faraday (e.g. `:patron`)
       #
       # @option arguments [Hash] :transport_options Options to be passed to the `Faraday::Connection` constructor
@@ -92,6 +94,8 @@ module Elasticsearch
         arguments[:randomize_hosts]    ||= false
         arguments[:transport_options]  ||= {}
 
+        arguments[:transport_options].update(request: { timeout: arguments[:request_timeout] } ) if arguments[:request_timeout]
+
         @send_get_body_as = arguments[:send_get_body_as] || 'GET'
 
         transport_class  = arguments[:transport_class] || DEFAULT_TRANSPORT_CLASS

data/lib/elasticsearch/transport/transport/base.rb

@@ -13,7 +13,9 @@ module Elasticsearch
         DEFAULT_SERIALIZER_CLASS = Serializer::MultiJson
 
         attr_reader   :hosts, :options, :connections, :counter, :last_request_at, :protocol
-        attr_accessor :serializer, :sniffer, :logger, :tracer, :reload_after, :resurrect_after, :max_retries
+        attr_accessor :serializer, :sniffer, :logger, :tracer,
+                      :reload_connections, :reload_after,
+                      :resurrect_after, :max_retries
 
         # Creates a new transport object.
         #
@@ -40,6 +42,7 @@ module Elasticsearch
           @sniffer     = options[:sniffer_class] ? options[:sniffer_class].new(self) : Sniffer.new(self)
           @counter     = 0
           @last_request_at = Time.now
+          @reload_connections = options[:reload_connections]
           @reload_after    = options[:reload_connections].is_a?(Fixnum) ? options[:reload_connections] : DEFAULT_RELOAD_AFTER
           @resurrect_after = options[:resurrect_after] || DEFAULT_RESURRECT_AFTER
           @max_retries     = options[:retry_on_failure].is_a?(Fixnum)   ? options[:retry_on_failure]   : DEFAULT_MAX_RETRIES
@@ -59,7 +62,7 @@ module Elasticsearch
           connection = connections.get_connection(options)
           @counter  += 1
 
-          reload_connections!         if @options[:reload_connections] && counter % reload_after == 0
+          reload_connections!         if reload_connections && counter % reload_after == 0
           connection
         end
 
@@ -211,7 +214,7 @@ module Elasticsearch
             end
 
           rescue Exception => e
-            logger.fatal "[#{e.class}] #{e.message} (#{connection.host.inspect})" if logger
+            logger.fatal "[#{e.class}] #{e.message} (#{connection.host.inspect if connection})" if logger
             raise e
           end
 

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

@@ -84,7 +84,8 @@ module Elasticsearch
               @request_options[:headers] = options[:headers]
             end
 
-            client_options = {:ssl => options[:ssl] || {}}
+            client_options = options[:transport_options] || {}
+            client_options[:ssl] = options[:ssl] || {}
 
             Connections::Collection.new \
               :connections => hosts.map { |host|

data/lib/elasticsearch/transport/version.rb

@@ -1,5 +1,5 @@
 module Elasticsearch
   module Transport
-    VERSION = "1.0.9"
+    VERSION = "1.0.10"
   end
 end

data/test/integration/client_test.rb

@@ -49,6 +49,16 @@ class Elasticsearch::Transport::ClientIntegrationTest < Elasticsearch::Test::Int
       end
     end
 
+    should "pass options to the transport" do
+      @client = Elasticsearch::Client.new \
+        host: "localhost:#{@port}",
+        logger: (ENV['QUIET'] ? nil : @logger),
+        transport_options: { headers: { content_type: 'application/yaml' } }
+
+      response = @client.perform_request 'GET', '_cluster/health'
+      assert_match /---\ncluster_name:/, response.body.to_s
+    end
+
     context "with round robin selector" do
       setup do
         @client = Elasticsearch::Client.new \

data/test/unit/client_test.rb

@@ -63,6 +63,16 @@ class Elasticsearch::Transport::ClientTest < Test::Unit::TestCase
       assert_match /Faraday/, client.transport.connections.first.connection.headers['User-Agent']
     end
 
+    should "pass options to the transport" do
+      client = Elasticsearch::Transport::Client.new :transport_options => { :foo => 'bar' }
+      assert_equal 'bar', client.transport.options[:transport_options][:foo]
+    end
+
+    should "merge request_timeout to the transport options" do
+      client = Elasticsearch::Transport::Client.new :request_timeout => 120
+      assert_equal 120, client.transport.options[:transport_options][:request][:timeout]
+    end
+
     context "when passed hosts" do
       should "have localhost by default" do
         c = Elasticsearch::Transport::Client.new

data/test/unit/transport_base_test.rb

@@ -100,6 +100,24 @@ class Elasticsearch::Transport::Transport::BaseTest < Test::Unit::TestCase
       12.times { @transport.get_connection }
       assert_equal 12, @transport.counter
     end
+
+    should "not reload connections by default" do
+      @transport = DummyTransportPerformer.new
+      @transport.stubs(:connections).returns(stub :get_connection => Object.new)
+      @transport.expects(:reload_connections!).never
+
+      10_010.times { @transport.get_connection }
+      assert_equal 10_010, @transport.counter
+    end
+
+    should "not reload connections when the option is set to false" do
+      @transport = DummyTransportPerformer.new :options => { :reload_connections => false }
+      @transport.stubs(:connections).returns(stub :get_connection => Object.new)
+      @transport.expects(:reload_connections!).never
+
+      10_010.times { @transport.get_connection }
+      assert_equal 10_010, @transport.counter
+    end
   end
 
   context "performing a request" do

data/test/unit/transport_manticore_test.rb

@@ -102,6 +102,15 @@ else
         ::Manticore::Client.expects(:new).with(options)
         transport = Manticore.new :hosts => [ { :host => 'foobar', :port => 1234 } ], :options => options
       end
+
+      should "pass :transport_options to Manticore::Client" do
+        options = {
+          :transport_options => { :potatoes => 1 }
+        }
+
+        ::Manticore::Client.expects(:new).with(:potatoes => 1, :ssl => {})
+        transport = Manticore.new :hosts => [ { :host => 'foobar', :port => 1234 } ], :options => options
+      end
     end
 
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: elasticsearch-transport
 version: !ruby/object:Gem::Version
-  version: 1.0.9
+  version: 1.0.10
 platform: ruby
 authors:
 - Karel Minarik
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-14 00:00:00.000000000 Z
+date: 2015-05-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json