elasticsearch-transport 1.0.6 → 1.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 87070e7148cced0a3dd781855400a2911737bbb7
-  data.tar.gz: 9832698a4ff8193012e957d4e9246775b7968749
+  metadata.gz: ee365b72ccd59176d473e7cfd057d4f246eacd0f
+  data.tar.gz: 2b9ab7f0a21f779cc24957f0b1aad4b0a9c449c1
 SHA512:
-  metadata.gz: a0297406975e141c2a9b4686ecad298cfdf1e444fb87261de335238b8fab42d0c9924c6b9b83ca1971a806e2b94c1d348bb4fe423e599692cf3b0d01560e20d4
-  data.tar.gz: 94364828943fcc5576bdc95a83c398af30762d5dbc15b51872ecfa75f857a21bfbe4f531992b2f81abe2bb56b75656c2db570bb016042f45807ef1dbd97ef106
+  metadata.gz: 23ea14e8d2901165ac026bf0dd4c9e17c1b8560629bc946418d05f24321f31410389edc185cf06701e94b7fc915ac2031d988d35be0ba1b449cf0ff483afa56c
+  data.tar.gz: 7ea2f669de99b231e41e02db9b801bef7ec0a1753e796ad71da98095e5e56192cb3aa48d5600b050eb653bcf0c4e4badbd6f90853077641631db20ba942a504e

data/README.md

@@ -89,6 +89,23 @@ Instead of Strings, you can pass host information as an array of Hashes:
 
     Elasticsearch::Client.new hosts: [ { host: 'myhost1', port: 8080 }, { host: 'myhost2', port: 8080 } ]
 
+Common URL parts -- scheme, HTTP authentication credentials, URL prefixes, etc -- are handled automatically:
+
+    Elasticsearch::Client.new url: 'https://username:password@api.server.org:4430/search'
+
+You can pass multiple URLs separated by a comma:
+
+    Elasticsearch::Client.new urls: 'http://localhost:9200,http://localhost:9201'
+
+Another way to configure the URL(s) is to export the `ELASTICSEARCH_URL` variable.
+
+The client will automatically round-robin across the hosts
+(unless you select or implement a different [connection selector](#connection-selector)).
+
+### Authentication
+
+You can pass the authentication credentials, scheme and port in the host configuration hash:
+
     Elasticsearch::Client.new hosts: [
       { host: 'my-protected-host',
         port: '443',
@@ -97,12 +114,15 @@ Instead of Strings, you can pass host information as an array of Hashes:
         scheme: 'https'
       } ]
 
-Scheme, HTTP authentication credentials and URL prefixes are handled automatically:
+... or simply use the common URL format:
 
-    Elasticsearch::Client.new url: 'https://username:password@api.server.org:4430/search'
+    Elasticsearch::Client.new url: 'https://username:password@example.com:9200'
 
-The client will automatically round-robin across the hosts
-(unless you select or implement a different [connection selector](#connection-selector)).
+To pass a custom certificate for SSL peer verification to Faraday-based clients,
+use the `transport_options` option:
+
+    Elasticsearch::Client.new url: 'https://username:password@example.com:9200',
+                              transport_options: { ssl: { ca_file: '/path/to/cacert.pem' } }
 
 ### Logging
 
@@ -262,7 +282,8 @@ constructor, use the `transport_options` key:
     client = Elasticsearch::Client.new transport_options: {
       request: { open_timeout: 1 },
       headers: { user_agent:   'MyApp' },
-      params:  { :format => 'yaml' }
+      params:  { :format => 'yaml' },
+      ssl:     { verify: false }
     }
 
 You can also use a bundled [_Curb_](https://rubygems.org/gems/curb) based transport implementation:
@@ -374,6 +395,22 @@ Github's pull requests and issues are used to communicate, send bug reports and
 * The {Elasticsearch::Transport::Transport::Connections::Selector::Base} implementations allow to choose connections
   from the pool, eg. in a round-robin or random fashion. You can implement your own selector strategy.
 
+## Development
+
+To work on the code, clone and bootstrap the main repository first --
+please see instructions in the main [README](../README.md#development).
+
+To run tests, launch a testing cluster -- again, see instructions
+in the main [README](../README.md#development) -- and use the Rake tasks:
+
+```
+time rake test:unit
+time rake test:integration
+```
+
+Unit tests have to use Ruby 1.8 compatible syntax, integration tests
+can use Ruby 2.x syntax and features.
+
 ## License
 
 This software is licensed under the Apache 2 license, quoted below.

data/elasticsearch-transport.gemspec

@@ -63,6 +63,10 @@ Gem::Specification.new do |s|
     s.add_development_dependency "cane"
   end
 
+  if defined?(RUBY_VERSION) && RUBY_VERSION > '2.2'
+    s.add_development_dependency "test-unit", '~> 2'
+  end
+
   s.description = <<-DESC.gsub(/^    /, '')
     Ruby client for Elasticsearch. See the `elasticsearch` gem for full integration.
   DESC

data/lib/elasticsearch/transport/client.rb

@@ -78,7 +78,11 @@ module Elasticsearch
       #                                              (Default: GET)
       #
       def initialize(arguments={})
-        hosts = arguments[:hosts] || arguments[:host] || arguments[:url] || ENV.fetch('ELASTICSEARCH_URL', 'localhost:9200')
+        hosts = arguments[:hosts] || \
+                arguments[:host]  || \
+                arguments[:url]   || \
+                arguments[:urls]  || \
+                ENV.fetch('ELASTICSEARCH_URL', 'localhost:9200')
 
         arguments[:logger] ||= arguments[:log]   ? DEFAULT_LOGGER.call() : nil
         arguments[:tracer] ||= arguments[:trace] ? DEFAULT_TRACER.call() : nil
@@ -124,24 +128,32 @@ module Elasticsearch
       # @api private
       #
       def __extract_hosts(hosts_config, options={})
-        hosts_config = Array(hosts_config)
+        if hosts_config.respond_to?(:to_hash)
+          hosts = [ hosts_config ]
+        else
+          if hosts_config.is_a?(String) && hosts_config.include?(',')
+            hosts = hosts_config.split(/\s*,\s*/)
+          else
+            hosts = Array(hosts_config)
+          end
 
-        hosts = hosts_config.map do |host|
-          case host
-          when String
-            if host =~ /^[a-z]+\:\/\//
-              uri = URI.parse(host)
-              { :scheme => uri.scheme, :user => uri.user, :password => uri.password, :host => uri.host, :path => uri.path, :port => uri.port.to_s }
+          hosts.map! do |host|
+            case host
+            when String
+              if host =~ /^[a-z]+\:\/\//
+                uri = URI.parse(host)
+                { :scheme => uri.scheme, :user => uri.user, :password => uri.password, :host => uri.host, :path => uri.path, :port => uri.port.to_s }
+              else
+                host, port = host.split(':')
+                { :host => host, :port => port }
+              end
+            when URI
+              { :scheme => host.scheme, :user => host.user, :password => host.password, :host => host.host, :path => host.path, :port => host.port.to_s }
+            when Hash
+              host
             else
-              host, port = host.split(':')
-              { :host => host, :port => port }
+              raise ArgumentError, "Please pass host as a String, URI or Hash -- #{host.class} given."
             end
-          when URI
-            { :scheme => host.scheme, :user => host.user, :password => host.password, :host => host.host, :path => host.path, :port => host.port.to_s }
-          when Hash
-            host
-          else
-            raise ArgumentError, "Please pass host as a String, URI or Hash -- #{host.class} given."
           end
         end
 
@@ -174,4 +186,3 @@ module Elasticsearch
     end
   end
 end
-

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

@@ -62,6 +62,7 @@ module Elasticsearch
 
                 Connections::Connection.new :host => host, :connection => client
               },
+              :selector_class => options[:selector_class],
               :selector => options[:selector]
           end
 
@@ -70,7 +71,14 @@ module Elasticsearch
           # @return [Array]
           #
           def host_unreachable_exceptions
-            [::Curl::Err::HostResolutionError, ::Curl::Err::ConnectionFailedError, ::Curl::Err::GotNothingError, ::Curl::Err::RecvError, ::Curl::Err::SendError]
+            [
+              ::Curl::Err::HostResolutionError,
+              ::Curl::Err::ConnectionFailedError,
+              ::Curl::Err::GotNothingError,
+              ::Curl::Err::RecvError,
+              ::Curl::Err::SendError,
+              ::Curl::Err::TimeoutError
+            ]
           end
         end
 

data/lib/elasticsearch/transport/version.rb

@@ -1,5 +1,5 @@
 module Elasticsearch
   module Transport
-    VERSION = "1.0.6"
+    VERSION = "1.0.7"
   end
 end

data/test/integration/transport_test.rb

@@ -65,7 +65,7 @@ class Elasticsearch::Transport::ClientIntegrationTest < Elasticsearch::Test::Int
       response = client.perform_request 'GET', ''
 
       assert_respond_to(response.body, :to_hash)
-      assert_equal 200, response.body['status']
+      assert_not_nil response.body['cluster_name']
       assert_equal 'application/json', response.headers['content-type']
     end unless JRUBY
   end

data/test/unit/client_test.rb

@@ -69,13 +69,17 @@ class Elasticsearch::Transport::ClientTest < Test::Unit::TestCase
         assert_equal 'localhost', c.transport.hosts.first[:host]
       end
 
-      should "take :hosts, :host or :url" do
+      should "take :hosts, :host, :url or :urls" do
         c1 = Elasticsearch::Transport::Client.new :hosts => ['foobar']
         c2 = Elasticsearch::Transport::Client.new :host  => 'foobar'
         c3 = Elasticsearch::Transport::Client.new :url   => 'foobar'
-        assert_equal 'foobar', c1.transport.hosts.first[:host]
-        assert_equal 'foobar', c2.transport.hosts.first[:host]
-        assert_equal 'foobar', c3.transport.hosts.first[:host]
+        c4 = Elasticsearch::Transport::Client.new :urls  => 'foo,bar'
+
+        assert_equal 'foobar', c1.transport.hosts[0][:host]
+        assert_equal 'foobar', c2.transport.hosts[0][:host]
+        assert_equal 'foobar', c3.transport.hosts[0][:host]
+        assert_equal 'foo',    c4.transport.hosts[0][:host]
+        assert_equal 'bar',    c4.transport.hosts[1][:host]
       end
 
     end
@@ -84,10 +88,21 @@ class Elasticsearch::Transport::ClientTest < Test::Unit::TestCase
       setup    { ENV['ELASTICSEARCH_URL'] = 'foobar' }
       teardown { ENV.delete('ELASTICSEARCH_URL')     }
 
-      should "use it" do
+      should "use a single host" do
         c = Elasticsearch::Transport::Client.new
+
+        assert_equal 1,     c.transport.hosts.size
         assert_equal 'foobar', c.transport.hosts.first[:host]
       end
+
+      should "use multiple hosts" do
+        ENV['ELASTICSEARCH_URL'] = 'foo, bar'
+        c = Elasticsearch::Transport::Client.new
+
+        assert_equal 2,     c.transport.hosts.size
+        assert_equal 'foo', c.transport.hosts[0][:host]
+        assert_equal 'bar', c.transport.hosts[1][:host]
+      end
     end
 
     context "extracting hosts" do
@@ -98,6 +113,13 @@ class Elasticsearch::Transport::ClientTest < Test::Unit::TestCase
         assert_nil             hosts[0][:port]
       end
 
+      should "extract from hash" do
+        hosts = @client.__extract_hosts( { :host => 'myhost', :scheme => 'https' } )
+
+        assert_equal 'myhost', hosts[0][:host]
+        assert_equal 'https',  hosts[0][:scheme]
+      end
+
       should "extract from array" do
         hosts = @client.__extract_hosts ['myhost']
 
@@ -114,6 +136,8 @@ class Elasticsearch::Transport::ClientTest < Test::Unit::TestCase
       should "extract from array with ports" do
         hosts = @client.__extract_hosts ['host1:1000', 'host2:2000']
 
+        assert_equal 2, hosts.size
+
         assert_equal 'host1', hosts[0][:host]
         assert_equal '1000',  hosts[0][:port]
 
@@ -145,7 +169,7 @@ class Elasticsearch::Transport::ClientTest < Test::Unit::TestCase
         assert_equal '8080',     hosts[0][:port]
       end
 
-      should "pass Hashes over" do
+      should "pass hashes over" do
         hosts = @client.__extract_hosts [{:host => 'myhost', :port => '1000', :foo => 'bar'}]
 
         assert_equal 'myhost', hosts[0][:host]
@@ -164,6 +188,15 @@ class Elasticsearch::Transport::ClientTest < Test::Unit::TestCase
         assert_equal '4430',     hosts[0][:port]
       end
 
+      should "split comma-separated URLs" do
+        hosts = @client.__extract_hosts 'foo, bar'
+
+        assert_equal 2, hosts.size
+
+        assert_equal 'foo', hosts[0][:host]
+        assert_equal 'bar', hosts[1][:host]
+      end
+
       should "raise error for incompatible argument" do
         assert_raise ArgumentError do
           @client.__extract_hosts 123

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: elasticsearch-transport
 version: !ruby/object:Gem::Version
-  version: 1.0.6
+  version: 1.0.7
 platform: ruby
 authors:
 - Karel Minarik
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-23 00:00:00.000000000 Z
+date: 2015-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json