elasticsearch-transport 6.8.3 → 7.0.0.pre

data/elasticsearch-transport.gemspec

@@ -1,59 +1,92 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#	http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
 # coding: utf-8
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'elasticsearch/transport/version'
 
 Gem::Specification.new do |s|
-  s.name          = 'elasticsearch-transport'
+  s.name          = "elasticsearch-transport"
   s.version       = Elasticsearch::Transport::VERSION
-  s.authors       = ['Karel Minarik']
-  s.email         = ['karel.minarik@elasticsearch.org']
-  s.summary       = 'Ruby client for Elasticsearch.'
-  s.homepage      = 'https://www.elastic.co/guide/en/elasticsearch/client/ruby-api/current/index.html'
-  s.license       = 'Apache-2.0'
-  s.metadata = {
-    'homepage_uri' => 'https://www.elastic.co/guide/en/elasticsearch/client/ruby-api/current/index.html',
-    'changelog_uri' => 'https://github.com/elastic/elasticsearch-ruby/blob/6.x/CHANGELOG.md',
-    'source_code_uri' => 'https://github.com/elastic/elasticsearch-ruby/tree/6.x/elasticsearch-transport',
-    'bug_tracker_uri' => 'https://github.com/elastic/elasticsearch-ruby/issues'
-  }
+  s.authors       = ["Karel Minarik"]
+  s.email         = ["karel.minarik@elasticsearch.org"]
+  s.summary       = "Ruby client for Elasticsearch."
+  s.homepage      = "https://github.com/elasticsearch/elasticsearch-ruby/tree/master/elasticsearch-transport"
+  s.license       = "Apache-2.0"
+
   s.files         = `git ls-files`.split($/)
   s.executables   = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
   s.test_files    = s.files.grep(%r{^(test|spec|features)/})
-  s.require_paths = ['lib']
-
-  s.extra_rdoc_files  = ['README.md', 'LICENSE.txt']
-  s.rdoc_options      = ['--charset=UTF-8']
-
-  s.required_ruby_version = '>= 2.4'
-
-  s.add_dependency 'multi_json'
-  s.add_dependency 'faraday', '~> 1'
-  s.add_development_dependency 'ansi'
-  s.add_development_dependency 'bundler'
-  s.add_development_dependency 'elasticsearch-extensions'
-  s.add_development_dependency 'mocha'
-  s.add_development_dependency 'pry'
-  s.add_development_dependency 'rake', '~> 13'
-  s.add_development_dependency 'shoulda-context'
-  s.add_development_dependency 'turn'
-  s.add_development_dependency 'yard'
+  s.require_paths = ["lib"]
+
+  s.extra_rdoc_files  = [ "README.md", "LICENSE.txt" ]
+  s.rdoc_options      = [ "--charset=UTF-8" ]
+
+  s.required_ruby_version = '>= 1.9'
+
+  s.add_dependency "multi_json"
+  s.add_dependency "faraday"
+
+  if defined?(RUBY_VERSION) && RUBY_VERSION < '1.9'
+    s.add_dependency "system_timer"
+  end
+
+  s.add_development_dependency "bundler"
+
+  if defined?(RUBY_VERSION) && RUBY_VERSION > '1.9'
+    s.add_development_dependency "rake", "~> 11.1"
+  else
+    s.add_development_dependency "rake", "< 11.0"
+  end
+
+  s.add_development_dependency "ansi"
+  s.add_development_dependency "shoulda-context"
+  s.add_development_dependency "mocha"
+  s.add_development_dependency "yard"
+  s.add_development_dependency "pry"
+
   # Gems for testing integrations
-  s.add_development_dependency 'cane'
-  s.add_development_dependency 'hashie'
-  s.add_development_dependency 'httpclient'
-  s.add_development_dependency 'manticore', '~> 0.5.2' if defined? JRUBY_VERSION
-  s.add_development_dependency 'minitest', '~> 4.0'
-  s.add_development_dependency 'net-http-persistent'
-  s.add_development_dependency 'simplecov', '~> 0.17', '< 0.18'
-  s.add_development_dependency 'simplecov-rcov'
-  s.add_development_dependency 'test-unit', '~> 2'
-  s.add_development_dependency 'typhoeus', '~> 1.4'
-  unless defined?(JRUBY_VERSION) || defined?(Rubinius)
-    s.add_development_dependency 'curb'
-    s.add_development_dependency 'patron'
-    s.add_development_dependency 'require-prof'
-    s.add_development_dependency 'ruby-prof'
+  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'
+  s.add_development_dependency "net-http-persistent"
+  s.add_development_dependency "manticore", '~> 0.6' if defined? JRUBY_VERSION
+  s.add_development_dependency "hashie"
+
+  # Prevent unit test failures on Ruby 1.8
+  if defined?(RUBY_VERSION) && RUBY_VERSION < '1.9'
+    s.add_development_dependency "test-unit", '~> 2'
+    s.add_development_dependency "json", '~> 1.8'
+  end
+
+  if defined?(RUBY_VERSION) && RUBY_VERSION > '1.9'
+    s.add_development_dependency "minitest"
+    s.add_development_dependency "minitest-reporters"
+    s.add_development_dependency "elasticsearch-extensions"
+    s.add_development_dependency "ruby-prof"    unless defined?(JRUBY_VERSION) || defined?(Rubinius)
+    s.add_development_dependency "require-prof" unless defined?(JRUBY_VERSION) || defined?(Rubinius)
+    s.add_development_dependency "simplecov"
+    s.add_development_dependency "simplecov-rcov"
+    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(/^    /, '')

data/lib/elasticsearch-transport.rb

@@ -1,5 +1,18 @@
-# Licensed to Elasticsearch B.V under one or more agreements.
-# Elasticsearch B.V licenses this file to you under the Apache 2.0 License.
-# See the LICENSE file in the project root for more information
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#	http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
 
 require 'elasticsearch/transport'

data/lib/elasticsearch/transport.rb

@@ -1,6 +1,19 @@
-# Licensed to Elasticsearch B.V under one or more agreements.
-# Elasticsearch B.V licenses this file to you under the Apache 2.0 License.
-# See the LICENSE file in the project root for more information
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#	http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
 
 require "uri"
 require "time"
@@ -8,6 +21,7 @@ require "timeout"
 require "multi_json"
 require "faraday"
 
+require "elasticsearch/transport/transport/loggable"
 require "elasticsearch/transport/transport/serializer/multi_json"
 require "elasticsearch/transport/transport/sniffer"
 require "elasticsearch/transport/transport/response"

data/lib/elasticsearch/transport/client.rb

@@ -1,6 +1,19 @@
-# Licensed to Elasticsearch B.V under one or more agreements.
-# Elasticsearch B.V licenses this file to you under the Apache 2.0 License.
-# See the LICENSE file in the project root for more information
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#	http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
 
 module Elasticsearch
   module Transport
@@ -89,19 +102,11 @@ module Elasticsearch
       # @option arguments [String] :send_get_body_as Specify the HTTP method to use for GET requests with a body.
       #                                              (Default: GET)
       #
-      # @option api_key [String, Hash] :api_key Use API Key Authentication, either the base64 encoding of `id` and `api_key`
-      #                                         joined by a colon as a String, or a hash with the `id` and `api_key` values.
-      # @option opaque_id_prefix [String] :opaque_id_prefix set a prefix for X-Opaque-Id when initializing the client. This
-      #                                                     will be prepended to the id you set before each request if
-      #                                                     you're using X-Opaque-Id
-      # @option enable_meta_header [Boolean] :enable_meta_header Enable sending the meta data header to Cloud.
-      #                                                          (Default: true)
-      #
       # @yield [faraday] Access and configure the `Faraday::Connection` instance directly with a block
       #
-      def initialize(arguments = {}, &block)
-        @options = arguments.each_with_object({}){ |(k,v), args| args[k.to_sym] = v }
-        @arguments = @options
+      def initialize(arguments={}, &block)
+        @options = arguments
+        @arguments = arguments
         @arguments[:logger] ||= @arguments[:log]   ? DEFAULT_LOGGER.call() : nil
         @arguments[:tracer] ||= @arguments[:trace] ? DEFAULT_TRACER.call() : nil
         @arguments[:reload_connections] ||= false
@@ -110,13 +115,9 @@ module Elasticsearch
         @arguments[:randomize_hosts]    ||= false
         @arguments[:transport_options]  ||= {}
         @arguments[:http]               ||= {}
-        @arguments[:enable_meta_header] = arguments.fetch(:enable_meta_header) { true }
-        @options[:http]                 ||= {}
-
-        set_api_key if (@api_key = @arguments[:api_key])
-
+        @options[:http]               ||= {}
 
-        @seeds ||= __extract_hosts(@arguments[:hosts] ||
+        @seeds = __extract_hosts(@arguments[:hosts] ||
                                      @arguments[:host] ||
                                      @arguments[:url] ||
                                      @arguments[:urls] ||
@@ -124,10 +125,9 @@ module Elasticsearch
                                      DEFAULT_HOST)
 
         @send_get_body_as = @arguments[:send_get_body_as] || 'GET'
-        @opaque_id_prefix = @arguments[:opaque_id_prefix] || nil
 
         if @arguments[:request_timeout]
-          @arguments[:transport_options][:request] = { timeout: @arguments[:request_timeout] }
+          @arguments[:transport_options][:request] = { :timeout => @arguments[:request_timeout] }
         end
 
         @arguments[:transport_options][:headers] ||= {}
@@ -139,120 +139,29 @@ module Elasticsearch
         if @arguments[:transport]
           @transport = @arguments[:transport]
         else
-          @transport_class = @arguments[:transport_class] || DEFAULT_TRANSPORT_CLASS
-          @transport = if @transport_class == Transport::HTTP::Faraday
-                         @arguments[:adapter] ||= __auto_detect_adapter
-                         set_meta_header
-                         @transport_class.new(hosts: @seeds, options: @arguments) do |faraday|
-                           faraday.adapter(@arguments[:adapter])
-                           block&.call faraday
-                         end
-                       else
-                         set_meta_header
-                         @transport_class.new(hosts: @seeds, options: @arguments)
-                       end
+          transport_class  = @arguments[:transport_class] || DEFAULT_TRANSPORT_CLASS
+          if transport_class == Transport::HTTP::Faraday
+            @transport = transport_class.new(:hosts => @seeds, :options => @arguments) do |faraday|
+              block.call faraday if block
+              unless (h = faraday.builder.handlers.last) && h.name.start_with?("Faraday::Adapter")
+                faraday.adapter(@arguments[:adapter] || __auto_detect_adapter)
+              end
+            end
+          else
+            @transport = transport_class.new(:hosts => @seeds, :options => @arguments)
+          end
         end
       end
 
       # Performs a request through delegation to {#transport}.
       #
-      def perform_request(method, path, params = {}, body = nil, headers = nil)
+      def perform_request(method, path, params={}, body=nil, headers=nil)
         method = @send_get_body_as if 'GET' == method && body
-        if (opaque_id = params.delete(:opaque_id))
-          headers = {} if headers.nil?
-          opaque_id = @opaque_id_prefix ? "#{@opaque_id_prefix}#{opaque_id}" : opaque_id
-          headers.merge!('X-Opaque-Id' => opaque_id)
-        end
         transport.perform_request(method, path, params, body, headers)
       end
 
       private
 
-      def set_api_key
-        @api_key = __encode(@api_key) if @api_key.is_a? Hash
-        add_header('Authorization' => "ApiKey #{@api_key}")
-        @arguments.delete(:user)
-        @arguments.delete(:password)
-      end
-
-      def add_header(header)
-        headers = @arguments[:transport_options]&.[](:headers) || {}
-        headers.merge!(header)
-        @arguments[:transport_options].merge!(
-          headers: headers
-        )
-      end
-
-      def set_meta_header
-        return if @arguments[:enable_meta_header] == false
-
-        service, version = meta_header_service_version
-
-        meta_headers = {
-          service.to_sym => version,
-          rb: RUBY_VERSION,
-          t: Elasticsearch::Transport::VERSION
-        }
-        meta_headers.merge!(meta_header_engine) if meta_header_engine
-        meta_headers.merge!(meta_header_adapter) if meta_header_adapter
-
-        add_header({ 'x-elastic-client-meta' => meta_headers.map { |k, v| "#{k}=#{v}" }.join(',') })
-      end
-
-      def meta_header_service_version
-        if defined?(Elastic::META_HEADER_SERVICE_VERSION)
-          Elastic::META_HEADER_SERVICE_VERSION
-        elsif defined?(Elasticsearch::VERSION)
-          [:es, client_meta_version(Elasticsearch::VERSION)]
-        else
-          [:es, client_meta_version(Elasticsearch::Transport::VERSION)]
-        end
-      end
-
-      def client_meta_version(version)
-        regexp = /^([0-9]+\.[0-9]+\.[0-9]+)(\.?[a-z0-9.-]+)?$/
-        match = version.match(regexp)
-        return "#{match[1]}p" if (match[2])
-
-        version
-      end
-
-      def meta_header_engine
-        case RUBY_ENGINE
-        when 'ruby'
-          {}
-        when 'jruby'
-          { jv: ENV_JAVA['java.version'], jr: JRUBY_VERSION }
-        when 'rbx'
-          { rbx: RUBY_VERSION }
-        else
-          { RUBY_ENGINE.to_sym => RUBY_VERSION }
-        end
-      end
-
-      def meta_header_adapter
-        if @transport_class == Transport::HTTP::Faraday
-          {fd: Faraday::VERSION}.merge(
-            case @arguments[:adapter]
-            when :patron
-              {pt: Patron::VERSION}
-            when :net_http
-              {nh: defined?(Net::HTTP::VERSION) ? Net::HTTP::VERSION : Net::HTTP::HTTPVersion}
-            when :typhoeus
-              {ty: Typhoeus::VERSION}
-            when :httpclient
-              {hc: HTTPClient::VERSION}
-            when :net_http_persistent
-              {np: Net::HTTP::Persistent::VERSION}
-            end
-          )
-        elsif defined?(Transport::HTTP::Curb) && @transport_class == Transport::HTTP::Curb
-          {cl: Curl::CURB_VERSION}
-        elsif defined?(Transport::HTTP::Manticore) && @transport_class == Transport::HTTP::Manticore
-          {mc: Manticore::VERSION}
-        end
-      end
-
       # Normalizes and returns hosts configuration.
       #
       # Arrayifies the `hosts_config` argument and extracts `host` and `port` info from strings.
@@ -267,15 +176,15 @@ module Elasticsearch
       #
       def __extract_hosts(hosts_config)
         hosts = case hosts_config
-                when String
-                  hosts_config.split(',').map { |h| h.strip! || h }
-                when Array
-                  hosts_config
-                when Hash, URI
-                  [ hosts_config ]
-                else
-                  Array(hosts_config)
-                end
+        when String
+          hosts_config.split(',').map { |h| h.strip! || h }
+        when Array
+          hosts_config
+        when Hash, URI
+          [ hosts_config ]
+        else
+          Array(hosts_config)
+        end
 
         host_list = hosts.map { |host| __parse_host(host) }
         @options[:randomize_hosts] ? host_list.shuffle! : host_list
@@ -283,42 +192,36 @@ module Elasticsearch
 
       def __parse_host(host)
         host_parts = 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 }
-                       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 }
-                     when Hash
-                       host
-                     else
-                       raise ArgumentError, "Please pass host as a String, URI or Hash -- #{host.class} given."
-                     end
-
-        if @api_key
-          # Remove Basic Auth if using API KEY
-          host_parts.delete(:user)
-          host_parts.delete(:password)
+        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 }
+          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 }
+        when Hash
+          host
         else
-          @options[:http][:user] ||= host_parts[:user]
-          @options[:http][:password] ||= host_parts[:password]
+          raise ArgumentError, "Please pass host as a String, URI or Hash -- #{host.class} given."
         end
 
+        @options[:http][:user] ||= host_parts[:user]
+        @options[:http][:password] ||= host_parts[:password]
+
         host_parts[:port] = host_parts[:port].to_i if host_parts[:port]
         host_parts[:path].chomp!('/') if host_parts[:path]
         host_parts
@@ -346,13 +249,6 @@ module Elasticsearch
           ::Faraday.default_adapter
         end
       end
-
-      # Encode credentials for the Authorization Header
-      # Credentials is the base64 encoding of id and api_key joined by a colon
-      # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-create-api-key.html
-      def __encode(api_key)
-        Base64.strict_encode64([api_key[:id], api_key[:api_key]].join(':'))
-      end
     end
   end
 end