elasticsearch-transport 1.0.0 → 1.0.1

data/README.md

@@ -28,8 +28,9 @@ Features overview:
 * Node reloading (based on cluster state) on errors or on demand
 
 For optimal performance, you should use a HTTP library which supports persistent ("keep-alive") connections,
-e.g. [Typhoeus](https://github.com/typhoeus/typhoeus) or [Curb](https://github.com/taf2/curb/) --
-see example configurations [below](#transport-implementations).
+e.g. [Typhoeus](https://github.com/typhoeus/typhoeus) or [Patron](https://github.com/toland/patron).
+Just `require 'typhoeus'` or `require 'patron'` in your code, and it will be used.
+For detailed information, see example configurations [below](#transport-implementations).
 
 ## Installation
 
@@ -198,29 +199,61 @@ Only when these would be unavailable, the strategy will use the other nodes:
 ### Transport Implementations
 
 By default, the client will use the [_Faraday_](https://rubygems.org/gems/faraday) HTTP library
-as a transport implementation. You can configure the _Faraday_ instance, eg. to use a different
-HTTP adapter (such as Typhoeus) or custom middleware, by passing a configuration block
-to the transport constructor:
+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:
+
+    require 'patron'
+
+Then, create a new client, and the _Patron_  gem will be used as the "driver":
+
+    client = Elasticsearch::Client.new
+
+    client.transport.connections.first.connection.builder.handlers
+    # => [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
+
+    # => Stiletoo : 24
+    # => Stiletoo : 24
+    # => Stiletoo : 24
+    # => ...
+
+To use a specific adapter for _Faraday_, pass it as the `adapter` argument:
+
+    client = Elasticsearch::Client.new adapter: :net_http_persistent
+
+    client.transport.connections.first.connection.builder.handlers
+    # => [Faraday::Adapter::NetHttpPersistent]
+
+To configure the _Faraday_ instance, pass a configuration block to the transport constructor:
 
     require 'typhoeus'
     require 'typhoeus/adapters/faraday'
 
-    configuration = lambda do |f|
+    transport_configuration = lambda do |f|
       f.response :logger
       f.adapter  :typhoeus
     end
 
     transport = Elasticsearch::Transport::Transport::HTTP::Faraday.new \
       hosts: [ { host: 'localhost', port: '9200' } ],
-      &configuration
+      &transport_configuration
 
     # Pass the transport to the client
     #
     client = Elasticsearch::Client.new transport: transport
 
 To pass options to the
-[`Faraday::Connection`](https://github.com/lostisland/faraday/blob/master/lib/faraday/connection.rb) constructor,
-use the `transport_options` key:
+[`Faraday::Connection`](https://github.com/lostisland/faraday/blob/master/lib/faraday/connection.rb)
+constructor, use the `transport_options` key:
 
     client = Elasticsearch::Client.new transport_options: {
       request: { open_timeout: 1 },
@@ -233,9 +266,11 @@ You can also use a bundled [_Curb_](https://rubygems.org/gems/curb) based transp
     require 'curb'
     require 'elasticsearch/transport/transport/http/curb'
 
-    # Use Curb as the HTTP client
     client = Elasticsearch::Client.new transport_class: Elasticsearch::Transport::Transport::HTTP::Curb
 
+    client.transport.connections.first.connection
+    # => #<Curl::Easy http://localhost:9200/>
+
 It's possible to customize the _Curb_ instance by passing a block to the constructor as well
 (in this case, as an inline block):
 
@@ -273,8 +308,7 @@ Instead of passing the transport to the constructor, you can inject it at run ti
 
 You can write your own transport implementation easily, by including the
 {Elasticsearch::Transport::Transport::Base} module, implementing the required contract,
-and passing it to the client as the `transport_class` parameter. All the arguments
-passed to client will be passed as the `:options` parameter to the transport constructor.
+and passing it to the client as the `transport_class` parameter -- or injecting it directly.
 
 ### Serializer Implementations
 

data/elasticsearch-transport.gemspec

@@ -43,7 +43,8 @@ Gem::Specification.new do |s|
   s.add_development_dependency "ci_reporter"
 
   # Gems for testing integrations
-  s.add_development_dependency "curb" unless defined? JRUBY_VERSION
+  s.add_development_dependency "curb"   unless defined? JRUBY_VERSION
+  s.add_development_dependency "patron" unless defined? JRUBY_VERSION
   s.add_development_dependency "typhoeus", '~> 0.6'
 
   # Prevent unit test failures on Ruby 1.8

data/lib/elasticsearch/transport/client.rb

@@ -57,6 +57,8 @@ module Elasticsearch
       #
       # @option arguments [Boolean] :reload_on_failure Reload connections after failure (false by default)
       #
+      # @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
       #
       # @option arguments [Constant] :transport_class  A specific transport class to use, will be initialized by
@@ -71,7 +73,6 @@ module Elasticsearch
       #                                        {Elasticsearch::Transport::Transport::Connections::Selector::Base}.
       #
       def initialize(arguments={})
-        transport_class  = arguments[:transport_class] || DEFAULT_TRANSPORT_CLASS
         hosts            = arguments[:hosts] || arguments[:host] || arguments[:url]
 
         arguments[:logger] ||= arguments[:log]   ? DEFAULT_LOGGER.call() : nil
@@ -82,8 +83,17 @@ module Elasticsearch
         arguments[:randomize_hosts]    ||= false
         arguments[:transport_options]  ||= {}
 
-        @transport = arguments[:transport] || \
-                     transport_class.new(:hosts => __extract_hosts(hosts, arguments), :options => arguments)
+        transport_class  = arguments[:transport_class] || DEFAULT_TRANSPORT_CLASS
+
+        @transport       = arguments[:transport] || begin
+          if transport_class == Transport::HTTP::Faraday
+            transport_class.new(:hosts => __extract_hosts(hosts, arguments), :options => arguments) do |faraday|
+              faraday.adapter(arguments[:adapter] || __auto_detect_adapter)
+            end
+          else
+            transport_class.new(:hosts => __extract_hosts(hosts, arguments), :options => arguments)
+          end
+        end
       end
 
       # Performs a request through delegation to {#transport}.
@@ -129,6 +139,29 @@ module Elasticsearch
         hosts.shuffle! if options[:randomize_hosts]
         hosts
       end
+
+      # Auto-detect the best adapter (HTTP "driver") available, based on libraries
+      # loaded by the user, preferring those with persistent connections
+      # ("keep-alive") by default
+      #
+      # @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
+        else
+          ::Faraday.default_adapter
+        end
+      end
     end
   end
 end

data/lib/elasticsearch/transport/version.rb

@@ -1,5 +1,5 @@
 module Elasticsearch
   module Transport
-    VERSION = "1.0.0"
+    VERSION = "1.0.1"
   end
 end

data/test/integration/client_test.rb

@@ -6,6 +6,11 @@ class Elasticsearch::Transport::ClientIntegrationTest < Elasticsearch::Test::Int
   end
 
   context "Elasticsearch client" do
+    teardown do
+      begin; Object.send(:remove_const, :Typhoeus); rescue NameError; end
+      begin; Object.send(:remove_const, :Patron); rescue NameError; end
+    end
+
     setup do
       @port = (ENV['TEST_CLUSTER_PORT'] || 9250).to_i
       system "curl -X DELETE http://localhost:#{@port}/_all > /dev/null 2>&1"
@@ -116,5 +121,14 @@ class Elasticsearch::Transport::ClientIntegrationTest < Elasticsearch::Test::Int
       end
     end
 
+    context "with Faraday adapters" do
+      should "automatically use the Patron client when loaded" do
+        require 'patron'
+        client = Elasticsearch::Transport::Client.new host: "localhost:#{@port}"
+
+        response = @client.perform_request 'GET', '_cluster/health'
+        assert_equal 200, response.status
+      end unless JRUBY
+    end
   end
 end

data/test/integration/transport_test.rb

@@ -8,6 +8,7 @@ class Elasticsearch::Transport::ClientIntegrationTest < Elasticsearch::Test::Int
   context "Transport" do
     setup do
       @port = (ENV['TEST_CLUSTER_PORT'] || 9250).to_i
+      begin; Object.send(:remove_const, :Patron);   rescue NameError; end
     end
 
     should "allow to customize the Faraday adapter" do

data/test/profile/client_benchmark_test.rb

@@ -8,7 +8,7 @@ class Elasticsearch::Transport::ClientProfilingTest < Elasticsearch::Test::Profi
   context "Elasticsearch client benchmark" do
     setup do
       @port = (ENV['TEST_CLUSTER_PORT'] || 9250).to_i
-      client = Elasticsearch::Client.new host: "localhost:#{@port}"
+      client = Elasticsearch::Client.new host: "localhost:#{@port}", adapter: ::Faraday.default_adapter
       client.perform_request 'DELETE', '/ruby_test_benchmark/' rescue nil
       client.perform_request 'POST',   '/ruby_test_benchmark/', {index: {number_of_shards: 1, number_of_replicas: 0}}
       100.times do client.perform_request 'POST',   '/ruby_test_benchmark_search/test/', {}, {foo: 'bar'}; end
@@ -20,9 +20,9 @@ class Elasticsearch::Transport::ClientProfilingTest < Elasticsearch::Test::Profi
       client.perform_request 'DELETE', '/ruby_test_benchmark_search/'
     end
 
-    context "with a single-node cluster" do
+    context "with a single-node cluster and the default adapter" do
       setup do
-        @client = Elasticsearch::Client.new hosts: "localhost:#{@port}"
+        @client = Elasticsearch::Client.new hosts: "localhost:#{@port}", adapter: ::Faraday.default_adapter
       end
 
       measure "get the cluster info", count: 1_000 do
@@ -38,9 +38,9 @@ class Elasticsearch::Transport::ClientProfilingTest < Elasticsearch::Test::Profi
       end
     end
 
-    context "with a two-node cluster" do
+    context "with a two-node cluster and the default adapter" do
       setup do
-        @client = Elasticsearch::Client.new hosts: ["localhost:#{@port}", "localhost:#{@port+1}"]
+        @client = Elasticsearch::Client.new hosts: ["localhost:#{@port}", "localhost:#{@port+1}"], adapter: ::Faraday.default_adapter
       end
 
       measure "get the cluster info", count: 1_000 do
@@ -78,9 +78,12 @@ class Elasticsearch::Transport::ClientProfilingTest < Elasticsearch::Test::Profi
     end
 
     context "with a single-node cluster and the Typhoeus client" do
+      require 'typhoeus'
+      require 'typhoeus/adapters/faraday'
+
       # Fix for incompatibility of the Typhoeus adapter
       # Related commit: elasticsearch/elasticsearch-ruby@adc4810227fad03ae5cabfbb2a0905fb75bfb331
-      # Related: lostisland/faraday/pull/323, lostisland/faraday/pull/335
+      # Related: lostisland/faraday/pull/323, lostisland/faraday/issues/333, lostisland/faraday/pull/335
       #
       class ::Faraday::Adapter::Typhoeus
         def configure_ssl(req, env)
@@ -89,9 +92,6 @@ class Elasticsearch::Transport::ClientProfilingTest < Elasticsearch::Test::Profi
       end
 
       setup do
-        require 'typhoeus'
-        require 'typhoeus/adapters/faraday'
-
         transport = Elasticsearch::Transport::Transport::HTTP::Faraday.new \
           :hosts => [ { :host => 'localhost', :port => @port } ] do |f|
             f.adapter  :typhoeus
@@ -113,6 +113,23 @@ class Elasticsearch::Transport::ClientProfilingTest < Elasticsearch::Test::Profi
       end
     end
 
-  end
+    context "with a single-node cluster and the Patron adapter" do
+      setup do
+        require 'patron'
+        @client = Elasticsearch::Client.new host: "localhost:#{@port}", adapter: :patron
+      end
+
+      measure "get the cluster info", count: 1_000 do
+        @client.perform_request 'GET', ''
+      end
 
+      measure "index a document" do
+        @client.perform_request 'POST', '/ruby_test_benchmark/test/', {}, {foo: 'bar'}
+      end
+
+      measure "search" do
+        @client.perform_request 'POST', '/ruby_test_benchmark_search/test/_search', {}, {query: {match: {foo: 'bar'}}}
+      end
+    end
+  end
 end

data/test/unit/client_test.rb

@@ -169,5 +169,35 @@ class Elasticsearch::Transport::ClientTest < Test::Unit::TestCase
       end
     end
 
+    context "detecting adapter for Faraday" do
+      setup do
+        Elasticsearch::Transport::Client::DEFAULT_TRANSPORT_CLASS.any_instance.unstub(:__build_connections)
+        begin; Object.send(:remove_const, :Typhoeus); rescue NameError; end
+        begin; Object.send(:remove_const, :Patron);   rescue NameError; end
+      end
+
+      should "use the default adapter" do
+        c = Elasticsearch::Transport::Client.new
+        handlers = c.transport.connections.all.first.connection.builder.handlers
+
+        assert_includes handlers, Faraday::Adapter::NetHttp
+      end
+
+      should "use the adapter from arguments" do
+        c = Elasticsearch::Transport::Client.new :adapter => :typhoeus
+        handlers = c.transport.connections.all.first.connection.builder.handlers
+
+        assert_includes handlers, Faraday::Adapter::Typhoeus
+      end
+
+      should "detect the adapter" do
+        require 'patron'
+        c = Elasticsearch::Transport::Client.new
+        handlers = c.transport.connections.all.first.connection.builder.handlers
+
+        assert_includes handlers, Faraday::Adapter::Patron
+      end
+    end
+
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: elasticsearch-transport
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-12 00:00:00.000000000 Z
+date: 2014-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -219,6 +219,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: patron
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: typhoeus
   requirement: !ruby/object:Gem::Requirement