excon 1.8.0 → 1.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d7a177488f1722e063f04d9d2e0f82eb6b06c29febdc7823ac09006257c84ef3
-  data.tar.gz: baf57fb9742edd1fc5e28cfa272a60a59bd9d476e53f3a753e0b9537ede6c7b3
+  metadata.gz: 92c10c40bd4ae5913caef9236145d027dc83f7ae9bf3942a91590f8b57024788
+  data.tar.gz: fa4d2d738e0cad415c7857773df9e8bfdaef62c13c13169f576037f602b3d9ff
 SHA512:
-  metadata.gz: b378a72d6a9c703e9150adb6f6d18e2bc5045f4c273b7caec53948ab301f03a5df9142f0f6dff6b93b38cddd51403ed1a1acd575e18dc76eb172d3a71d931970
-  data.tar.gz: d1699bfde750945682253c74f5763168ef605aff5bd4a6cebb37be7e9af7051f833fd42eb22cebd9651d2df3a1dc7c6ed8884241812602f0e26ed1f0511d1bb0
+  metadata.gz: '048afa1b1b171dc7f39c0423030b4ebe3b02fdc8ad321e10c42ee13b51937b66122252ccd8aa9172c3562a9c0344937c4a8031f511f55bc160d188c360e0b061'
+  data.tar.gz: 82949f5756c66d7f027f417d78b71bbaa7941954e71f6fee9925d4eccaa6f64f3e2939f7b6273cf76556c9172a2d8fcbaddbb4aca1b4a9211f110f51f9a46f83

data/CONTRIBUTING.md

@@ -9,6 +9,7 @@ New contributors are always welcome, when it doubt please ask questions. We stri
   * Review open [issues](https://github.com/excon/excon/issues) for things to help on.
   * [Create an issue](https://github.com/excon/excon/issues/new) to start a discussion on additions or features.
 * Fork the project, add your changes and tests to cover them in a topic branch.
+  * Tests go in `test/` (minitest), fixtures in `test/fixtures/`. See [AGENTS.md](AGENTS.md#tests).
 * Commit your changes and rebase against `excon/excon` to ensure everything is up to date.
 * [Submit a pull request](https://github.com/excon/excon/compare/).
 

data/README.md

@@ -158,6 +158,8 @@ connection = Excon.new('https://...')
 
 You can modify timeouts and define whether and how many (blocking) retries Excon should attempt if errors occur.
 
+Excon only retries requests marked `:idempotent`. Otherwise `:retry_limit`, `:retry_interval` and `:retry_errors` have no effect, whether they are set on the request, the connection or `Excon.defaults`.
+
 ```ruby
 # this request can be repeated safely, so retry on errors up to 4 times
 connection.request(:idempotent => true)
@@ -466,7 +468,7 @@ The #instrument method will be called for each HTTP request, response, retry, an
 
 For debugging purposes you can also use `Excon::StandardInstrumentor` to output all events to stderr. This can also be specified by setting the `EXCON_DEBUG` ENV var.
 
-See [the documentation for ActiveSupport::Notifications](http://api.rubyonrails.org/classes/ActiveSupport/Notifications.html) for more detail on using the subscription interface. See excon's [instrumentation_test.rb](https://github.com/excon/excon/blob/master/tests/middlewares/instrumentation_tests.rb) for more examples of instrumenting excon.
+See [the documentation for ActiveSupport::Notifications](http://api.rubyonrails.org/classes/ActiveSupport/Notifications.html) for more detail on using the subscription interface. See excon's [instrumentation_test.rb](https://github.com/excon/excon/blob/master/test/middlewares/instrumentation_test.rb) for more examples of instrumenting excon.
 
 ## HTTPS client certificate
 

data/excon.gemspec

@@ -23,17 +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('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/socket.rb

@@ -174,6 +174,10 @@ module Excon
         rescue *CONNECT_RETRY_EXCEPTION_CLASSES
           select_with_timeout(socket, :connect_write)
           begin
+            # macOS 27 raises EISCONN below even when the connect failed, so check SO_ERROR first
+            errno = socket.getsockopt(::Socket::SOL_SOCKET, ::Socket::SO_ERROR).int
+            raise(SystemCallError.new("connect(2) for #{addrinfo.inspect_sockaddr}", errno)) unless errno.zero?
+
             socket.connect_nonblock(sockaddr)
             @socket = socket
           rescue Errno::EISCONN

data/lib/excon/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Excon
-  VERSION = "1.8.0"
+  VERSION = "1.9.1"
 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.8.0
+  version: 1.9.1
 platform: ruby
 authors:
 - dpiddy (Dan Peterson)
@@ -12,47 +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'
+        version: '6'
   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'
-  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
@@ -81,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