excon 0.112.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a595b595665aaaf9b650c664bca78bdc66ad05b80d7641333ce3acbeb6a80c46
-  data.tar.gz: 7200b150fded0987a7c57fb1155580efd0825472f375523ce12e2b0dce2ebf25
+  metadata.gz: 8a1cbd57e645d8d22b4180e346b0fcf365165ffb9e95a69a83fe805f56d50e16
+  data.tar.gz: e073309fd959dded213203af46f07bccded5fc8c1fe4b879902a9b04e5d82046
 SHA512:
-  metadata.gz: 27c315cb6b11bf5f09bdae2802d033cdee746d8d907c77324535452f03b42fe2f77375530761153062f5fc70f39972858e0dfe82d64edecc7e9ab83135ce93ba
-  data.tar.gz: 9c37add84efa4abb2766310f27a4aa7a151e31cc9e53cfdbd321c3aade0909b88d6d9ee0c9dea3accba8761dbb356d6570eb099bf24a52a96ea0576c1217edd9
+  metadata.gz: 109ed16c1c5f49cc84261a0c271c0f8769aabc9258a1482842d1c2f48b96ff48ce558b7018b01a1054d57b0f15f4321430e6cfb5f2f8af354150b41dec976d24
+  data.tar.gz: cb8c80990fea59470508ada7fcff74f217229c2f8f973d5369ef7f7beb32e105fb10013164427f787bcc38ff77f601fe617f0644a9a70407eaf405409444edfc

data/README.md

@@ -190,6 +190,9 @@ connection.request(:timeout => 0.1) # timeout if the entire request takes longer
 #
 connection = Excon.new('http://geemus.com/', :tcp_nodelay => true)
 
+# opt-in to having Excon add a default port (http:80 and https:443)
+connection = Excon.new('http://geemus.com/', :include_default_port => true)
+
 # set longer connect_timeout (default is 60 seconds)
 connection = Excon.new('http://geemus.com/', :connect_timeout => 360)
 

data/lib/excon/connection.rb

@@ -138,7 +138,7 @@ module Excon
 
             # The HTTP spec isn't clear on it, but specifically, GET requests don't usually send bodies;
             # if they don't, sending Content-Length:0 can cause issues.
-            unless datum[:method].to_s.casecmp('GET') == 0 && body.nil?
+            unless datum[:method].to_s.casecmp?('GET') && body.nil?
               unless datum[:headers].has_key?('Content-Length')
                 datum[:headers]['Content-Length'] = detect_content_length(body)
               end
@@ -250,7 +250,7 @@ module Excon
         datum[:headers]['Authorization'] ||= 'Basic ' + ["#{user}:#{pass}"].pack('m').delete(Excon::CR_NL)
       end
 
-      host_key = datum[:headers].keys.detect {|k| k.casecmp('Host') == 0 } || 'Host'
+      host_key = datum[:headers].keys.detect {|k| k.casecmp?('Host') } || 'Host'
       if datum[:scheme] == UNIX
         datum[:headers][host_key] ||= ''
       else
@@ -298,8 +298,8 @@ module Excon
         @persistent_socket_reusable = true
 
         if datum[:persistent]
-          if (key = datum[:response][:headers].keys.detect {|k| k.casecmp('Connection') == 0 })
-            if datum[:response][:headers][key].casecmp('close') == 0
+          if (key = datum[:response][:headers].keys.detect {|k| k.casecmp?('Connection') })
+            if datum[:response][:headers][key].casecmp?('close')
               reset
             end
           end
@@ -338,8 +338,8 @@ module Excon
       end
 
       if @data[:persistent]
-        if (key = responses.last[:headers].keys.detect {|k| k.casecmp('Connection') == 0 })
-          if responses.last[:headers][key].casecmp('close') == 0
+        if (key = responses.last[:headers].keys.detect {|k| k.casecmp?('Connection') })
+          if responses.last[:headers][key].casecmp?('close')
             reset
           end
         end
@@ -446,6 +446,12 @@ module Excon
         raise ArgumentError.new("Invalid validation type '#{validation}'")
       end
 
+      if validation == :connection && params[:omit_default_port] != true
+        Excon.display_warning(
+          'The `omit_default_port` connection option is deprecated, please use `include_default_port` instead.'
+        )
+      end
+
       invalid_keys = params.keys - valid_keys
       unless invalid_keys.empty?
         Excon.display_warning("Invalid Excon #{validation} keys: #{invalid_keys.map(&:inspect).join(', ')}")

data/lib/excon/constants.rb

@@ -14,9 +14,11 @@ module Excon
   DEFAULT_RETRY_LIMIT = 4
 
   DEFAULT_RETRY_ERRORS = [
-    Excon::Error::Timeout,
+    Excon::Error::RequestTimeout,
+    Excon::Error::Server,
     Excon::Error::Socket,
-    Excon::Error::HTTPStatus
+    Excon::Error::Timeout,
+    Excon::Error::TooManyRequests
   ].freeze
 
   FORCE_ENC = CR_NL.respond_to?(:force_encoding)
@@ -84,6 +86,7 @@ module Excon
     keepalive
     host
     hostname
+    include_default_port
     omit_default_port
     nonblock
     reuseaddr
@@ -151,14 +154,16 @@ module Excon
     instrumentor_name: 'excon',
     middlewares: [
       Excon::Middleware::ResponseParser,
+      Excon::Middleware::Decompress,
       Excon::Middleware::Expects,
       Excon::Middleware::Idempotent,
       Excon::Middleware::Instrumentor,
       Excon::Middleware::Mock
     ],
     mock: false,
+    include_default_port: false,
     nonblock: true,
-    omit_default_port: false,
+    omit_default_port: true,
     persistent: false,
     read_timeout: 60,
     resolv_resolver: nil,

data/lib/excon/middlewares/capture_cookies.rb

@@ -9,7 +9,7 @@ module Excon
 
       def get_header(datum, header)
         _, header_value = datum[:response][:headers].detect do |key, _|
-          key.casecmp(header) == 0
+          key.casecmp?(header)
         end
         header_value
       end

data/lib/excon/middlewares/decompress.rb

@@ -1,41 +1,36 @@
 # frozen_string_literal: true
+
 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'
-          if datum[:headers][key].to_s.empty?
-            datum[:headers][key] = 'deflate, gzip'
-          end
+        unless datum.key?(:response_block)
+          key = datum[:headers].keys.detect { |k| k.to_s.casecmp?('Accept-Encoding') } || 'Accept-Encoding'
+          datum[:headers][key] = 'deflate, gzip' if datum[:headers][key].to_s.empty?
         end
         @stack.request_call(datum)
       end
 
       def response_call(datum)
         body = datum[:response][:body]
-        unless datum.has_key?(:response_block) || body.nil? || body.empty?
-          if (key = datum[:response][:headers].keys.detect {|k| k.casecmp('Content-Encoding') == 0 })
-            encodings = Utils.split_header_value(datum[:response][:headers][key])
-            if (encoding = encodings.last)
-              if encoding.casecmp('deflate') == 0
-                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
-                encodings.pop
-              end
-              datum[:response][:headers][key] = encodings.join(', ')
+        if !(datum.key?(:response_block) || body.nil? || body.empty?) &&
+           (key = datum[:response][:headers].keys.detect { |k| k.casecmp?('Content-Encoding') })
+          encodings = Utils.split_header_value(datum[:response][:headers][key])
+          if encodings&.last&.casecmp?('deflate')
+            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 encodings&.last&.casecmp?('gzip') || encodings&.last&.casecmp?('x-gzip')
+            datum[:response][:body] = Zlib::GzipReader.new(StringIO.new(body)).read
+            encodings.pop
           end
+          datum[:response][:headers][key] = encodings.join(', ')
         end
         @stack.response_call(datum)
       end

data/lib/excon/middlewares/redirect_follower.rb

@@ -17,7 +17,7 @@ module Excon
 
       def get_header(datum, header)
         _, header_value = datum[:response][:headers].detect do |key, _|
-          key.casecmp(header) == 0
+          key.casecmp?(header)
         end
         header_value
       end

data/lib/excon/response.rb

@@ -106,9 +106,9 @@ module Excon
 
       unless (['HEAD', 'CONNECT'].include?(datum[:method].to_s.upcase)) || NO_ENTITY.include?(datum[:response][:status])
 
-        if (key = datum[:response][:headers].keys.detect {|k| k.casecmp('Transfer-Encoding') == 0 })
+        if (key = datum[:response][:headers].keys.detect {|k| k.casecmp?('Transfer-Encoding') })
           encodings = Utils.split_header_value(datum[:response][:headers][key])
-          if (encoding = encodings.last) && encoding.casecmp('chunked') == 0
+          if (encoding = encodings.last) && encoding.casecmp?('chunked')
             transfer_encoding_chunked = true
             if encodings.length == 1
               datum[:response][:headers].delete(key)
@@ -156,7 +156,7 @@ module Excon
           end
           parse_headers(socket, datum) # merge trailers into headers
         else
-          if (key = datum[:response][:headers].keys.detect {|k| k.casecmp('Content-Length') == 0 })
+          if (key = datum[:response][:headers].keys.detect {|k| k.casecmp?('Content-Length') })
             content_length = datum[:response][:headers][key].to_i
           end
 
@@ -202,7 +202,7 @@ module Excon
           raise Excon::Error::ResponseParse, 'malformed header' unless value
           # add key/value or append value to existing values
           datum[:response][:headers][key] = ([datum[:response][:headers][key]] << value.strip).compact.join(', ')
-          if key.casecmp('Set-Cookie') == 0
+          if key.casecmp?('Set-Cookie')
             datum[:response][:cookies] << value.strip
           end
           last_key = key

data/lib/excon/ssl_socket.rb

@@ -108,7 +108,7 @@ module Excon
       end
 
       if @data[:proxy]
-        request = "CONNECT #{@data[:host]}#{port_string(@data.merge(:omit_default_port => false))}#{Excon::HTTP_1_1}" +
+        request = "CONNECT #{@data[:host]}#{Excon::HTTP_1_1}" \
                   "Host: #{@data[:host]}#{port_string(@data)}#{Excon::CR_NL}"
 
         if @data[:proxy].has_key?(:user) || @data[:proxy].has_key?(:password)

data/lib/excon/utils.rb

@@ -62,11 +62,34 @@ module Excon
     end
 
     def port_string(datum)
-      if datum[:port].nil? || (datum[:omit_default_port] && ((datum[:scheme].casecmp('http') == 0 && datum[:port] == 80) || (datum[:scheme].casecmp('https') == 0 && datum[:port] == 443)))
-        ''
+      if !default_port?(datum) || datum[:include_default_port] || !datum[:omit_default_port]
+        ":#{datum[:port]}"
       else
-        ':' + datum[:port].to_s
+        ''
+      end
+    end
+
+    # Used to normalize queries for stubs, based on Rack::Utils.parse_query
+    def parse_query_string(string)
+      params = {}
+
+      string.split(/[&;] */n).each do |pair|
+        key, value = pair.split('=', 2).map { |x| CGI.unescape(x) }
+
+        params[key] = if params[key]
+                        [params[key], value].flatten
+                      else
+                        value
+                      end
       end
+
+      params
+    end
+
+    def default_port?(datum)
+      (!datum[:scheme]&.casecmp?('unix') && datum[:port].nil?) ||
+        (datum[:scheme]&.casecmp?('http') && datum[:port] == 80) ||
+        (datum[:scheme]&.casecmp?('https') && datum[:port] == 443)
     end
 
     def query_string(datum)

data/lib/excon/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Excon
-  VERSION = '0.112.0'
+  VERSION = '1.1.0'
 end

data/lib/excon.rb

@@ -19,6 +19,7 @@ require 'excon/version'
 require 'excon/extensions/uri'
 
 require 'excon/middlewares/base'
+require 'excon/middlewares/decompress'
 require 'excon/middlewares/expects'
 require 'excon/middlewares/idempotent'
 require 'excon/middlewares/instrumentor'
@@ -32,7 +33,6 @@ require 'excon/utils'
 require 'excon/connection'
 require 'excon/headers'
 require 'excon/response'
-require 'excon/middlewares/decompress'
 require 'excon/middlewares/escape_path'
 require 'excon/middlewares/redirect_follower'
 require 'excon/middlewares/capture_cookies'
@@ -143,7 +143,7 @@ module Excon
         uri = URI.parse(url)
         request_params = {
           host: uri.host,
-          path: uri.path,
+          path: uri.path.empty? ? '/' : uri.path,
           port: uri.port,
           query: uri.query,
           scheme: uri.scheme
@@ -162,6 +162,9 @@ module Excon
         end
         request_params[:headers] = headers
       end
+      if request_params.key?(:query) && request_params[:query].instance_of?(String)
+        request_params[:query] = Utils.parse_query_string(request_params[:query])
+      end
       if block_given?
         raise(ArgumentError, 'stub requires either response_params OR a block') if response_params
 
@@ -182,6 +185,9 @@ module Excon
       if (method = request_params.delete(:method))
         request_params[:method] = method.to_s.downcase.to_sym
       end
+      if request_params.key?(:query) && request_params[:query].instance_of?(String)
+        request_params[:query] = Utils.parse_query_string(request_params[:query])
+      end
       Excon.stubs.each do |stub, response_params|
         captures = { headers: {} }
         headers_match = !stub.key?(:headers) || stub[:headers].keys.all? do |key|

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: excon
 version: !ruby/object:Gem::Version
-  version: 0.112.0
+  version: 1.1.0
 platform: ruby
 authors:
 - dpiddy (Dan Peterson)
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-10-01 00:00:00.000000000 Z
+date: 2024-10-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec