excon 0.85.0 → 0.99.0

data/excon.gemspec

@@ -1,4 +1,5 @@
-require File.join(File.dirname(__FILE__), 'lib', 'excon', 'version')
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), 'lib')
+require 'excon/version'
 
 Gem::Specification.new do |s|
   s.name             = 'excon'
@@ -25,7 +26,6 @@ Gem::Specification.new do |s|
   s.add_development_dependency('eventmachine', '>= 1.0.4')
   s.add_development_dependency('open4')
   s.add_development_dependency('rake')
-  s.add_development_dependency('rdoc')
   s.add_development_dependency('shindo')
   s.add_development_dependency('sinatra')
   s.add_development_dependency('sinatra-contrib')

data/lib/excon/connection.rb

@@ -62,6 +62,7 @@ module Excon
     # @option params [Class] :instrumentor Responds to #instrument as in ActiveSupport::Notifications
     # @option params [String] :instrumentor_name Name prefix for #instrument events.  Defaults to 'excon'
     def initialize(params = {})
+      @pid = Process.pid
       @data = Excon.defaults.dup
       # merge does not deep-dup, so make sure headers is not the original
       @data[:headers] = @data[:headers].dup
@@ -89,7 +90,9 @@ module Excon
       end
 
       if @data[:scheme] == UNIX
-        if @data[:host]
+        # 'uri' >= v0.12.0 returns an empty string instead of nil for no host.
+        # So treat the parameter as present if and only if it is both non-nill and non-empty.
+        if @data[:host] && !@data[:host].empty?
           raise ArgumentError, "The `:host` parameter should not be set for `unix://` connections.\n" +
                                "When supplying a `unix://` URI, it should start with `unix:/` or `unix:///`."
         elsif !@data[:socket]
@@ -190,6 +193,11 @@ module Excon
         case error
         when Excon::Errors::InvalidHeaderKey, Excon::Errors::InvalidHeaderValue, Excon::Errors::StubNotFound, Excon::Errors::Timeout
           raise(error)
+        when Errno::EPIPE
+          # Read whatever remains in the pipe to aid in debugging
+          response = socket.read
+          error = Excon::Error.new(response + error.message)
+          raise_socket_error(error)
         else
           raise_socket_error(error)
         end
@@ -248,6 +256,11 @@ module Excon
         datum[:headers] = { 'Host' => host }.merge(datum[:headers])
       end
 
+      # default to GET if no method specified
+      unless datum[:method]
+        datum[:method] = :get
+      end
+
       # if path is empty or doesn't start with '/', insert one
       unless datum[:path][0, 1] == '/'
         datum[:path] = datum[:path].dup.insert(0, '/')
@@ -468,6 +481,11 @@ module Excon
       @_excon_sockets ||= {}
       @_excon_sockets.compare_by_identity
 
+      if @pid != Process.pid
+        @_excon_sockets.clear # GC will take care of closing sockets
+        @pid = Process.pid
+      end
+
       if @data[:thread_safe_sockets]
         # In a multi-threaded world, if the same connection is used by multiple
         # threads at the same time to connect to the same destination, they may
@@ -567,6 +585,8 @@ module Excon
           raise ArgumentError, "The `:ssl_proxy_headers` parameter should only be used with HTTPS requests."
         end
         if @data[:proxy][:scheme] == UNIX
+          # URI.parse might return empty string for security reasons.
+          @data[:proxy][:host] = nil if @data[:proxy][:host] == ""
           if @data[:proxy][:host]
             raise ArgumentError, "The `:host` parameter should not be set for `unix://` proxies.\n" +
                                  "When supplying a `unix://` URI, it should start with `unix:/` or `unix:///`."

data/lib/excon/constants.rb

@@ -72,6 +72,8 @@ module Excon
     :client_key_pass,
     :client_cert,
     :client_cert_data,
+    :client_chain,
+    :client_chain_data,
     :certificate,
     :certificate_path,
     :disable_proxy,

data/lib/excon/instrumentors/logging_instrumentor.rb

@@ -28,7 +28,7 @@ module Excon
           info << "?"
 
           if params[:query].is_a?(Hash)
-            info << params.to_a.map{ |key,value| "#{key}=#{value}" }.join('&')
+            info << params[:query].to_a.map { |key,value| "#{key}=#{value}" }.join('&')
           else
             info << params[:query]
           end

data/lib/excon/middlewares/decompress.rb

@@ -2,6 +2,10 @@
 module Excon
   module Middleware
     class Decompress < Excon::Middleware::Base
+
+      INFLATE_ZLIB_OR_GZIP  = 47 # Zlib::MAX_WBITS + 32
+      INFLATE_RAW           = -15 # Zlib::MAX_WBITS * -1
+
       def request_call(datum)
         unless datum.has_key?(:response_block)
           key = datum[:headers].keys.detect {|k| k.to_s.casecmp('Accept-Encoding') == 0 } || 'Accept-Encoding'
@@ -19,8 +23,11 @@ module Excon
             encodings = Utils.split_header_value(datum[:response][:headers][key])
             if (encoding = encodings.last)
               if encoding.casecmp('deflate') == 0
-                # assume inflate omits header
-                datum[:response][:body] = Zlib::Inflate.new(-Zlib::MAX_WBITS).inflate(body)
+                datum[:response][:body] = begin
+                  Zlib::Inflate.new(INFLATE_ZLIB_OR_GZIP).inflate(body)
+                rescue Zlib::DataError # fallback to raw on error
+                  Zlib::Inflate.new(INFLATE_RAW).inflate(body)
+                end
                 encodings.pop
               elsif encoding.casecmp('gzip') == 0 || encoding.casecmp('x-gzip') == 0
                 datum[:response][:body] = Zlib::GzipReader.new(StringIO.new(body)).read

data/lib/excon/response.rb

@@ -20,15 +20,24 @@ module Excon
     def host
       @data[:host]
     end
+    def scheme
+      @data[:scheme]
+    end
     def local_address
       @data[:local_address]
     end
     def local_port
       @data[:local_port]
     end
+    def http_method # can't be named "method"
+      @data[:method]
+    end
     def path
       @data[:path]
     end
+    def query
+      @data[:query]
+    end
     def port
       @data[:port]
     end
@@ -72,9 +81,13 @@ module Excon
         :body          => String.new,
         :cookies       => [],
         :host          => datum[:host],
+        :scheme        => datum[:scheme],
+        :method        => datum[:method],
         :headers       => Excon::Headers.new,
         :path          => datum[:path],
+        :query         => datum[:query],
         :port          => datum[:port],
+        :omit_default_port => datum[:omit_default_port],
         :status        => status,
         :status_line   => line,
         :reason_phrase => reason_phrase

data/lib/excon/socket.rb

@@ -40,12 +40,14 @@ module Excon
 
     def_delegators(:@socket, :close)
 
+
     def initialize(data = {})
       @data = data
       @nonblock = data[:nonblock]
       @port ||= @data[:port] || 80
       @read_buffer = String.new
       @eof = false
+      @backend_eof = false
       connect
     end
 
@@ -60,19 +62,31 @@ module Excon
     end
 
     def readline
-      return legacy_readline if RUBY_VERSION.to_f <= 1.8_7
-      buffer = String.new
-      buffer << (read_nonblock(1) || raise(EOFError)) while buffer[-1] != "\n"
-      buffer
-    end
-
-    def legacy_readline
-      begin
-        Timeout.timeout(@data[:read_timeout]) do
-          @socket.readline
+      if @nonblock && RUBY_VERSION.to_f > 1.8_7
+        result = String.new
+        block = @read_buffer
+        @read_buffer = String.new
+
+        loop do
+          idx = block.index("\n")
+          if idx.nil?
+            result << block
+          else
+            result << block.slice!(0, idx+1)
+            add_to_read_buffer(block)
+            break
+          end
+          block = read_nonblock(@data[:chunk_size]) || raise(EOFError)
+        end
+        result
+      else # nonblock/legacy
+        begin
+          Timeout.timeout(@data[:read_timeout]) do
+            @socket.readline
+          end
+        rescue Timeout::Error
+          raise Excon::Errors::Timeout.new('read timeout reached')
         end
-      rescue Timeout::Error
-        raise Excon::Errors::Timeout.new('read timeout reached')
       end
     end
 
@@ -173,20 +187,27 @@ module Excon
       end
     end
 
+    def add_to_read_buffer(str)
+      @read_buffer << str
+      @eof = false
+    end
+
     def read_nonblock(max_length)
       begin
         if max_length
-          until @read_buffer.length >= max_length
+          until @backend_eof || @read_buffer.length >= max_length
             @read_buffer << @socket.read_nonblock(max_length - @read_buffer.length)
           end
         else
-          loop do
+          while !@backend_eof
             @read_buffer << @socket.read_nonblock(@data[:chunk_size])
           end
         end
       rescue OpenSSL::SSL::SSLError => error
         if error.message == 'read would block'
-          select_with_timeout(@socket, :read) && retry
+          if @read_buffer.empty?
+            select_with_timeout(@socket, :read) && retry
+          end
         else
           raise(error)
         end
@@ -196,10 +217,10 @@ module Excon
           select_with_timeout(@socket, :read) && retry
         end
       rescue EOFError
-        @eof = true
+        @backend_eof = true
       end
 
-      if max_length
+      ret = if max_length
         if @read_buffer.empty?
           nil # EOF met at beginning
         else
@@ -209,6 +230,8 @@ module Excon
         # read until EOFError, so return everything
         @read_buffer.slice!(0, @read_buffer.length)
       end
+      @eof = @backend_eof && @read_buffer.empty?
+      ret
     end
 
     def read_block(max_length)
@@ -220,9 +243,7 @@ module Excon
         raise(error)
       end
     rescue *READ_RETRY_EXCEPTION_CLASSES
-      if @read_buffer.empty?
-        select_with_timeout(@socket, :read) && retry
-      end
+      select_with_timeout(@socket, :read) && retry
     rescue EOFError
       @eof = true
     end

data/lib/excon/ssl_socket.rb

@@ -54,11 +54,13 @@ module Excon
           ssl_context.cert_store = cert_store
         end
 
-        # no defaults, fallback to bundled
-        unless ca_file || ca_path || cert_store
+        if cert_store.nil?
           ssl_context.cert_store = OpenSSL::X509::Store.new
           ssl_context.cert_store.set_default_paths
+        end
 
+        # no defaults, fallback to bundled
+        unless ca_file || ca_path || cert_store
           # workaround issue #257 (JRUBY-6970)
           ca_file = DEFAULT_CA_FILE
           ca_file = ca_file.gsub(/^jar:/, '') if ca_file =~ /^jar:file:\//
@@ -88,6 +90,14 @@ module Excon
         else
           ssl_context.key = OpenSSL::PKey::RSA.new(client_key_data, client_key_pass)
         end
+        if client_chain_data && OpenSSL::X509::Certificate.respond_to?(:load)
+          ssl_context.extra_chain_cert = OpenSSL::X509::Certificate.load(client_chain_data)
+        elsif client_chain_data
+          certs = client_chain_data.scan(/-----BEGIN CERTIFICATE-----(?:.|\n)+?-----END CERTIFICATE-----/)
+          ssl_context.extra_chain_cert = certs.map do |cert|
+            OpenSSL::X509::Certificate.new(cert)
+          end
+        end
       elsif @data.key?(:certificate) && @data.key?(:private_key)
         ssl_context.cert = OpenSSL::X509::Certificate.new(@data[:certificate])
         if OpenSSL::PKey.respond_to? :read
@@ -131,7 +141,7 @@ module Excon
 
       # Server Name Indication (SNI) RFC 3546
       if @socket.respond_to?(:hostname=)
-        @socket.hostname = @data[:host]
+        @socket.hostname = @data[:ssl_verify_peer_host] || @data[:host]
       end
 
       begin
@@ -169,6 +179,14 @@ module Excon
                             end
     end
 
+    def client_chain_data
+      @client_chain_data ||= if (ccd = @data[:client_chain_data])
+                               ccd
+                             elsif (path = @data[:client_chain])
+                               File.read path
+                             end
+    end
+
     def connect
       # backwards compatability for things lacking nonblock
       @nonblock = HAVE_NONBLOCK && @nonblock

data/lib/excon/test/plugin/server/exec.rb

@@ -4,10 +4,13 @@ module Excon
       module Server
         module Exec
           def start(app_str = app)
-            line = ''
             open_process(app_str)
+            process_stderr = ""
+            line = ''
             until line =~ /\Aready\Z/
               line = error.gets
+              raise process_stderr if line.nil?
+              process_stderr << line
               fatal_time = elapsed_time > timeout
               if fatal_time
                 msg = "executable #{app_str} has taken too long to start"

data/lib/excon/test/plugin/server/puma.rb

@@ -4,10 +4,13 @@ module Excon
       module Server
         module Puma
           def start(app_str = app, bind_uri = bind)
-            open_process('puma', '-b', bind_uri.to_s, app_str)
+            open_process(RbConfig.ruby, '-S', 'puma', '-b', bind_uri.to_s, app_str)
+            process_stderr = ""
             line = ''
             until line =~ /Use Ctrl-C to stop/
               line = read.gets
+              raise process_stderr if line.nil?
+              process_stderr << line
               fatal_time = elapsed_time > timeout
               raise 'puma server has taken too long to start' if fatal_time
             end

data/lib/excon/test/plugin/server/unicorn.rb

@@ -13,6 +13,8 @@ module Excon
               bind_str = "#{host}:#{bind_uri.port}"
             end
             args = [ 
+              RbConfig.ruby,
+              '-S',
               'unicorn', 
               '--no-default-middleware', 
               '-l',
@@ -20,9 +22,12 @@ module Excon
               app_str
             ]
             open_process(*args)
+            process_stderr = ''
             line = ''
             until line =~ /worker\=0 ready/
               line = error.gets
+              raise process_stderr if line.nil?
+              process_stderr << line
               fatal_time = elapsed_time > timeout
               raise 'unicorn server has taken too long to start' if fatal_time
             end

data/lib/excon/test/plugin/server/webrick.rb

@@ -7,10 +7,13 @@ module Excon
             bind_uri = URI.parse(bind_uri) unless bind_uri.is_a? URI::Generic
             host = bind_uri.host.gsub(/[\[\]]/, '')
             port = bind_uri.port.to_s
-            open_process('rackup', '-s', 'webrick', '--host', host, '--port', port, app_str)
+            open_process(RbConfig.ruby, '-S', 'rackup', '-s', 'webrick', '--host', host, '--port', port, app_str)
+            process_stderr = ""
             line = ''
             until line =~ /HTTPServer#start/
               line = error.gets
+              raise process_stderr if line.nil?
+              process_stderr << line
               fatal_time = elapsed_time > timeout
               raise 'webrick server has taken too long to start' if fatal_time
             end

data/lib/excon/utils.rb

@@ -131,7 +131,8 @@ module Excon
         end
         [values].flatten.each do |value|
           if value.to_s.match(/[\r\n]/)
-            raise Excon::Errors::InvalidHeaderValue.new(value.to_s.inspect + ' contains forbidden "\r" or "\n"')
+            # Don't include the potentially sensitive header value (i.e. authorization token) in the message
+            raise Excon::Errors::InvalidHeaderValue.new(key.to_s + ' header value contains forbidden "\r" or "\n"')
           end
           headers_str << key.to_s << ': ' << value.to_s << CR_NL
         end

data/lib/excon/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module Excon
-  VERSION = '0.85.0'
+  VERSION = '0.99.0'
 end

data/lib/excon.rb

@@ -198,8 +198,13 @@ module Excon
         headers_match = !stub.has_key?(:headers) || stub[:headers].keys.all? do |key|
           case value = stub[:headers][key]
           when Regexp
-            if (match = value.match(request_params[:headers][key]))
-              captures[:headers][key] = match.captures
+            case request_params[:headers][key]
+            when String
+              if (match = value.match(request_params[:headers][key]))
+                captures[:headers][key] = match.captures
+              end
+            when Regexp # for unstub on regex params
+              match = (value == request_params[:headers][key])
             end
             match
           else
@@ -209,8 +214,13 @@ module Excon
         non_headers_match = (stub.keys - [:headers]).all? do |key|
           case value = stub[key]
           when Regexp
-            if (match = value.match(request_params[key]))
-              captures[key] = match.captures
+            case request_params[key]
+            when String
+              if (match = value.match(request_params[key]))
+                captures[key] = match.captures
+              end
+            when Regexp # for unstub on regex params
+              match = (value == request_params[key])
             end
             match
           else

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: excon
 version: !ruby/object:Gem::Version
-  version: 0.85.0
+  version: 0.99.0
 platform: ruby
 authors:
 - dpiddy (Dan Peterson)
 - geemus (Wesley Beary)
 - nextmat (Matt Sanders)
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-07-16 00:00:00.000000000 Z
+date: 2023-02-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -96,20 +96,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: rdoc
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: shindo
   requirement: !ruby/object:Gem::Requirement
@@ -249,7 +235,7 @@ metadata:
   documentation_uri: https://github.com/excon/excon/blob/master/README.md
   source_code_uri: https://github.com/excon/excon
   wiki_uri: https://github.com/excon/excon/wiki
-post_install_message:
+post_install_message: 
 rdoc_options:
 - "--charset=UTF-8"
 require_paths:
@@ -265,8 +251,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.15
-signing_key:
+rubygems_version: 3.4.1
+signing_key: 
 specification_version: 4
 summary: speed, persistence, http(s)
 test_files: []