excon 1.7.3 → 1.9.0

data/excon.gemspec

@@ -23,20 +23,9 @@ Gem::Specification.new do |s|
   ]
   s.required_ruby_version = '>= 3.3.0'
 
-  s.add_dependency 'logger'
-
-  s.add_development_dependency('activesupport')
-  s.add_development_dependency('delorean')
-  s.add_development_dependency('eventmachine', '>= 1.0.4')
-  s.add_development_dependency('json', '>= 1.8.5')
-  s.add_development_dependency('open4')
+  s.add_development_dependency('minitest', '>= 6')
   s.add_development_dependency('puma')
   s.add_development_dependency('rake')
-  s.add_development_dependency('rdoc')
-  s.add_development_dependency('rspec', '>= 3.5.0')
-  s.add_development_dependency('shindo')
-  s.add_development_dependency('sinatra')
-  s.add_development_dependency('sinatra-contrib')
   s.add_development_dependency('webrick')
 
   s.metadata = {

data/lib/excon/connection.rb

@@ -56,14 +56,15 @@ module Excon
     # @option params [String] :socket The path to the unix socket (required for 'unix://' connections)
     # @option params [String] :ciphers Only use the specified SSL/TLS cipher suites; use OpenSSL cipher spec format e.g. 'HIGH:!aNULL:!3DES' or 'AES256-SHA:DES-CBC3-SHA'
     # @option params [String] :proxy Proxy server; e.g. 'http://myproxy.com:8888'
-    # @option params [Fixnum] :retry_limit Set how many times we'll retry a failed request.  (Default 4)
-    # @option params [Fixnum] :retry_interval Set how long to wait between retries. (Default 0)
+    # @option params [Fixnum] :retry_limit Set how many times we'll retry a failed request.  (Default 4)  Only applies to :idempotent requests.
+    # @option params [Fixnum] :retry_interval Set how long to wait between retries. (Default 0)  Only applies to :idempotent requests.
     # @option params [Class] :instrumentor Responds to #instrument as in ActiveSupport::Notifications
     # @option params [String] :instrumentor_name Name prefix for #instrument events.  Defaults to 'excon'
     # @option params [Resolv, nil] :resolv_resolver A ready to use +Resolv+ resolver instance.
     # @option params [Class] :resolver_factory Const of the resolver factory.  Defaults to 'Excon::ResolverFactory'
     def initialize(params = {})
       @pid = Process.pid
+      @sockets_mutex = Mutex.new
       @data = Excon.defaults.dup
       # merge does not deep-dup, so make sure headers is not the original
       @data[:headers] = @data[:headers].dup
@@ -512,21 +513,26 @@ module Excon
     end
 
     def sockets
-      if @pid != Process.pid
-        @_excon_sockets&.clear # GC will take care of closing sockets
-        @pid = Process.pid
-      end
+      # Threads sharing this connection all read and write @_excon_sockets.
+      # On a Ruby without a GVL (JRuby) concurrent updates can lose another
+      # thread's entry, so that thread opens a new socket mid-request.
+      @sockets_mutex.synchronize do
+        if @pid != Process.pid
+          @_excon_sockets&.clear # GC will take care of closing sockets
+          @pid = Process.pid
+        end
 
-      if @data[:thread_safe_sockets]
-        @_excon_sockets ||= ObjectSpace::WeakKeyMap.new
+        if @data[:thread_safe_sockets]
+          @_excon_sockets ||= ObjectSpace::WeakKeyMap.new
 
-        # 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
-        # stomp on each other's sockets.  This ensures every thread gets their
-        # own socket cache, within the context of a single connection.
-        @_excon_sockets[Thread.current] ||= {}
-      else
-        @_excon_sockets ||= {}.compare_by_identity
+          # 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
+          # stomp on each other's sockets.  This ensures every thread gets their
+          # own socket cache, within the context of a single connection.
+          @_excon_sockets[Thread.current] ||= {}
+        else
+          @_excon_sockets ||= {}.compare_by_identity
+        end
       end
     end
 
@@ -545,8 +551,10 @@ module Excon
                        rescue IPAddr::Error
                          false
                        end
+                     elsif host == '*'
+                       true
                      else
-                       /(^|\.)#{host}$/.match(@data[:host])
+                       /(^|\.)#{Regexp.escape(host)}$/.match(@data[:host])
                      end
         host_match && (port.nil? || port.to_i == @data[:port])
     end

data/lib/excon/instrumentors/logging_instrumentor.rb

@@ -1,12 +1,19 @@
-require 'logger'
-
 module Excon
   class LoggingInstrumentor
 
+    # Stand-in for Logger.new($stderr), matching Logger's default format, so
+    # excon does not need to depend on the logger gem.
+    module StderrLogger
+      def self.info(message)
+        timestamp = Time.now.strftime('%Y-%m-%dT%H:%M:%S.%6N')
+        $stderr.write("I, [#{timestamp} ##{Process.pid}]  INFO -- : #{message}\n")
+      end
+    end
+
     def self.instrument(name, params = {})
       params = params.dup
 
-      logger = params[:logger] || Logger.new($stderr)
+      logger = params[:logger] || StderrLogger
 
       # reduce duplication/noise of output
       params.delete(:connection)

data/lib/excon/middlewares/redirect_follower.rb

@@ -2,6 +2,14 @@
 module Excon
   module Middleware
     class RedirectFollower < Excon::Middleware::Base
+      CONTENT_HEADERS = %w[
+        Content-Encoding
+        Content-Language
+        Content-Length
+        Content-Location
+        Content-Type
+      ].freeze
+
       REDACTION_HEADERS = %w[
         Authorization
         Cookie
@@ -39,6 +47,10 @@ module Excon
         if datum.has_key?(:response)
           case datum[:response][:status]
           when 301, 302, 303, 307, 308
+            location = get_header(datum, 'Location')
+            # Without a Location there is nowhere to go, so return the response as is
+            return @stack.response_call(datum) unless location
+
             if datum[:redirects_remaining] <= 0
               raise Excon::Errors::TooManyRedirects
             end
@@ -47,7 +59,6 @@ module Excon
 
             uri_parser = datum[:uri_parser] || Excon.defaults[:uri_parser]
 
-            location = get_header(datum, 'Location')
             base_uri = Excon::Utils.request_uri(datum)
             uri = uri_parser.join(base_uri, location)
 
@@ -61,14 +72,18 @@ module Excon
             params.delete(:stack)
             params.delete(:user)
 
+            params[:headers] = datum[:headers].dup
             if [301, 302, 303].include?(response[:status])
               params[:method] = :get
               params.delete(:body)
-              params[:headers].delete('Content-Length')
+              # The body is not sent again, so neither are the header fields describing it
+              params[:headers].delete_if do |key, _|
+                CONTENT_HEADERS.any? { |header| key.to_s.casecmp?(header) }
+              end
             end
-            params[:headers] = datum[:headers].dup
-            REDACTION_HEADERS.each do |header|
-              params[:headers].delete(header)
+            # drop sensitive headers in any casing
+            params[:headers].delete_if do |key, _|
+              REDACTION_HEADERS.any? { |header| key.to_s.casecmp?(header) }
             end
             params.merge!(
               :scheme     => uri.scheme || datum[:scheme],

data/lib/excon/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Excon
-  VERSION = "1.7.3"
+  VERSION = "1.9.0"
 end

data/lib/excon.rb

@@ -139,6 +139,9 @@ module Excon
     # @param request_params [Hash<Symbol, >] request params to match against, omitted params match all
     # @param response_params [Hash<Symbol, >] response params to return or block to call with matched params
     def stub(request_params = {}, response_params = nil, &block)
+      # copy, so later changes to the caller's hash (e.g. stub_for adding
+      # :captures) don't change the stored stub
+      request_params = request_params.dup
       if (method = request_params.delete(:method))
         request_params[:method] = method.to_s.downcase.to_sym
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: excon
 version: !ruby/object:Gem::Version
-  version: 1.7.3
+  version: 1.9.0
 platform: ruby
 authors:
 - dpiddy (Dan Peterson)
@@ -12,89 +12,19 @@ cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: logger
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: activesupport
-  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: delorean
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
+        version: '6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: eventmachine
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.0.4
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.0.4
-- !ruby/object:Gem::Dependency
-  name: json
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.8.5
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.8.5
-- !ruby/object:Gem::Dependency
-  name: open4
-  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'
+        version: '6'
 - !ruby/object:Gem::Dependency
   name: puma
   requirement: !ruby/object:Gem::Requirement
@@ -123,76 +53,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: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.5.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.5.0
-- !ruby/object:Gem::Dependency
-  name: shindo
-  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: sinatra
-  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: sinatra-contrib
-  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: webrick
   requirement: !ruby/object:Gem::Requirement
@@ -247,11 +107,6 @@ files:
 - lib/excon/socks5_socket.rb
 - lib/excon/socks5_ssl_socket.rb
 - lib/excon/ssl_socket.rb
-- lib/excon/test/plugin/server/exec.rb
-- lib/excon/test/plugin/server/puma.rb
-- lib/excon/test/plugin/server/unicorn.rb
-- lib/excon/test/plugin/server/webrick.rb
-- lib/excon/test/server.rb
 - lib/excon/unix_socket.rb
 - lib/excon/utils.rb
 - lib/excon/version.rb

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

@@ -1,26 +0,0 @@
-module Excon
-  module Test
-    module Plugin
-      module Server
-        module Exec
-          def start(app_str = app)
-            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"
-                raise msg
-              end
-            end
-            true
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,23 +0,0 @@
-module Excon
-  module Test
-    module Plugin
-      module Server
-        module Puma
-          def start(app_str = app, bind_uri = bind)
-            open_process(RbConfig.ruby, '-S', 'puma', '-b', bind_uri.to_s, app_str)
-            process_stderr = ""
-            line = ''
-            until line.include?('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
-            true
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,40 +0,0 @@
-module Excon
-  module Test
-    module Plugin
-      module Server
-        module Unicorn
-          def start(app_str = app, bind_uri = bind)
-            bind_uri = URI.parse(bind_uri) unless bind_uri.is_a? URI::Generic
-            is_unix_socket = (bind_uri.scheme == "unix")
-            if is_unix_socket
-              bind_str = bind_uri.to_s
-            else
-              host = bind_uri.host.gsub(/[\[\]]/, '')
-              bind_str = "#{host}:#{bind_uri.port}"
-            end
-            args = [
-              RbConfig.ruby,
-              '-S',
-              'unicorn',
-              '--no-default-middleware',
-              '-l',
-              bind_str,
-              app_str
-            ]
-            open_process(*args)
-            process_stderr = ''
-            line = ''
-            until line.include?('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
-            true
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,26 +0,0 @@
-module Excon
-  module Test
-    module Plugin
-      module Server
-        module Webrick
-          def start(app_str = app, bind_uri = bind)
-            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(RbConfig.ruby, '-S', 'rackup', '-s', 'webrick', '--host', host, '--port', port, app_str)
-            process_stderr = ""
-            line = ''
-            until line.include?('Server#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
-            true
-          end
-        end
-      end
-    end
-  end
-end

data/lib/excon/test/server.rb

@@ -1,99 +0,0 @@
-require 'open4'
-require 'excon'
-require 'excon/test/plugin/server/webrick'
-require 'excon/test/plugin/server/unicorn'
-require 'excon/test/plugin/server/puma'
-require 'excon/test/plugin/server/exec'
-
-
-module Excon
-  module Test
-    class Server
-      attr_accessor :app, :server, :bind, :pid, :read, :write, :error, :started_at, :timeout
-
-      # Methods that must be implemented by a plugin
-      INSTANCE_REQUIRES = [:start]
-
-      def initialize(args)
-        # TODO: Validate these args
-        @server = args.keys.first
-        @app = args[server]
-        args[:bind] ||= 'tcp://127.0.0.1:9292'
-        @bind = URI.parse(args[:bind])
-        @is_unix_socket = (@bind.scheme == 'unix')
-        @bind.host = @bind.host.gsub(/[\[\]]/, '') unless @is_unix_socket
-        if args[:timeout]
-          @timeout = args[:timeout]
-        else
-          @timeout = 20
-        end
-        name = @server.to_s.split('_').collect(&:capitalize).join
-        plug = nested_const_get("Excon::Test::Plugin::Server::#{name}")
-        self.extend plug
-        check_implementation(plug)
-      end
-
-      def open_process(*args)
-        if RUBY_PLATFORM == 'java'
-          @pid, @write, @read, @error = IO.popen4(*args)
-        else
-          @pid, @write, @read, @error = Open4.popen4(*args)
-        end
-        @started_at = Time.now
-      end
-
-      def elapsed_time
-        Time.now - started_at
-      end
-
-      def stop
-        if RUBY_PLATFORM == 'java'
-          Process.kill('USR1', pid)
-        else
-          Process.kill('KILL', pid)
-          Process.wait(pid)
-        end
-
-        if @is_unix_socket
-          socket = @bind.path
-          File.delete(socket) if File.exist?(socket)
-        end
-
-        # TODO: Ensure process is really dead
-        dump_errors
-        true
-      end
-      def dump_errors
-        lines = error.read.split($/)
-        while (line = lines.shift)
-          case line
-            when /(ERROR|Error)/
-              unless line.match?(/(null cert chain|did not return a certificate|SSL_read:: internal error)/)
-                in_err = true
-                puts
-              end
-            when /^(127|localhost)/
-              in_err = false
-            end
-          puts line if in_err
-        end
-      end
-
-      private
-
-      def nested_const_get(namespace)
-        namespace.split('::').inject(Object) do |mod, klass|
-          mod.const_get(klass)
-        end
-      end
-
-      def check_implementation(plug)
-        INSTANCE_REQUIRES.each do |m|
-          unless self.respond_to? m
-            raise "FATAL: #{plug} does not implement ##{m}"
-          end
-        end
-      end
-    end
-  end
-end