excon 0.109.0 → 1.5.0

data/lib/excon/utils.rb

@@ -1,14 +1,15 @@
 # frozen_string_literal: true
+
 module Excon
   module Utils
-    extend self
+    module_function
 
-    CONTROL   = (0x0..0x1f).map {|c| c.chr }.join + "\x7f"
+    CONTROL   = "#{(0x0..0x1f).map(&:chr).join}\u007F"
     DELIMS    = '<>#%"'
     UNWISE    = '{}|\\^[]`'
-    NONASCII  = (0x80..0xff).map {|c| c.chr }.join
-    UNESCAPED = /([#{ Regexp.escape(CONTROL + ' ' + DELIMS + UNWISE + NONASCII) }])/
-    ESCAPED   = /%([0-9a-fA-F]{2})/
+    NONASCII  = (0x80..0xff).map(&:chr).join
+    UNESCAPED = /([#{Regexp.escape("#{CONTROL} #{DELIMS}#{UNWISE}#{NONASCII}")}])/.freeze
+    ESCAPED   = /%([0-9a-fA-F]{2})/.freeze
 
     def binary_encode(string)
       if FORCE_ENC && string.encoding != Encoding::ASCII_8BIT
@@ -23,9 +24,8 @@ module Excon
     end
 
     def connection_uri(datum = @data)
-      unless datum
-        raise ArgumentError, '`datum` must be given unless called on a Connection'
-      end
+      raise ArgumentError, '`datum` must be given unless called on a Connection' unless datum
+
       if datum[:scheme] == UNIX
         "#{datum[:scheme]}://#{datum[:socket]}"
       else
@@ -36,21 +36,15 @@ module Excon
     # Redact sensitive info from provided data
     def redact(datum)
       datum = datum.dup
-      if datum.has_key?(:headers)
-        if datum[:headers].has_key?('Authorization') || datum[:headers].has_key?('Proxy-Authorization')
+      if datum.key?(:headers)
+        if datum[:headers].key?('Authorization') || datum[:headers].key?('Proxy-Authorization')
           datum[:headers] = datum[:headers].dup
         end
-        if datum[:headers].has_key?('Authorization')
-          datum[:headers]['Authorization'] = REDACTED
-        end
-        if datum[:headers].has_key?('Proxy-Authorization')
-          datum[:headers]['Proxy-Authorization'] = REDACTED
-        end
-      end
-      if datum.has_key?(:password)
-        datum[:password] = REDACTED
+        datum[:headers]['Authorization'] = REDACTED if datum[:headers].key?('Authorization')
+        datum[:headers]['Proxy-Authorization'] = REDACTED if datum[:headers].key?('Proxy-Authorization')
       end
-      if datum.has_key?(:proxy) && datum[:proxy] && datum[:proxy].has_key?(:password)
+      datum[:password] = REDACTED if datum.key?(:password)
+      if datum.key?(:proxy) && datum[:proxy]&.key?(:password)
         datum[:proxy] = datum[:proxy].dup
         datum[:proxy][:password] = REDACTED
       end
@@ -62,21 +56,27 @@ 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
 
+    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)
-      str = String.new
+      str = +''
       case datum[:query]
       when String
         str << '?' << datum[:query]
       when Hash
         str << '?'
-        datum[:query].sort_by {|k,_| k.to_s }.each do |key, values|
+        datum[:query].sort_by { |k, _| k.to_s }.each do |key, values|
           key = CGI.escape(key.to_s)
           if values.nil?
             str << key << '&'
@@ -94,46 +94,49 @@ module Excon
     # Splits a header value +str+ according to HTTP specification.
     def split_header_value(str)
       return [] if str.nil?
+
       str = str.dup.strip
       str = binary_encode(str)
-      str.scan(%r'\G((?:"(?:\\.|[^"])+?"|[^",])+)
-                    (?:,\s*|\Z)'xn).flatten
+      str.scan(/\G((?:"(?:\\.|[^"])+?"|[^",])+)
+                    (?:,\s*|\Z)/xn).flatten
     end
 
     # Escapes HTTP reserved and unwise characters in +str+
     def escape_uri(str)
       str = str.dup
       str = binary_encode(str)
-      str.gsub(UNESCAPED) { "%%%02X" % $1[0].ord }
+      str.gsub(UNESCAPED) { format('%%%02X', ::Regexp.last_match(1)[0].ord) }
     end
 
     # Unescapes HTTP reserved and unwise characters in +str+
     def unescape_uri(str)
       str = str.dup
       str = binary_encode(str)
-      str.gsub(ESCAPED) { $1.hex.chr }
+      str.gsub(ESCAPED) { ::Regexp.last_match(1).hex.chr }
     end
 
     # Unescape form encoded values in +str+
     def unescape_form(str)
       str = str.dup
       str = binary_encode(str)
-      str.gsub!(/\+/, ' ')
-      str.gsub(ESCAPED) { $1.hex.chr }
+      str.tr!('+', ' ')
+      str.gsub(ESCAPED) { ::Regexp.last_match(1).hex.chr }
     end
 
     # Performs validation on the passed header hash and returns a string representation of the headers
     def headers_hash_to_s(headers)
-      headers_str = String.new
+      headers_str = +''
       headers.each do |key, values|
-        if key.to_s.match(/[\r\n]/)
-          raise Excon::Errors::InvalidHeaderKey.new(key.to_s.inspect + ' contains forbidden "\r" or "\n"')
+        if key.to_s.match?(/[\r\n]/)
+          raise Excon::Errors::InvalidHeaderKey, "#{key.to_s.inspect} contains forbidden \"\\r\" or \"\\n\""
         end
+
         [values].flatten.each do |value|
-          if value.to_s.match(/[\r\n]/)
+          if value.to_s.match?(/[\r\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"')
+            raise Excon::Errors::InvalidHeaderValue, "#{key} header value contains forbidden \"\\r\" or \"\\n\""
           end
+
           headers_str << key.to_s << ': ' << value.to_s << CR_NL
         end
       end

data/lib/excon/version.rb

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

data/lib/excon.rb

@@ -1,9 +1,11 @@
 # frozen_string_literal: true
+
 $:.unshift(File.dirname(__FILE__)) unless
   $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
 
-require 'cgi'
+require 'cgi/escape'
 require 'forwardable'
+require 'ipaddr'
 require 'openssl'
 require 'rbconfig'
 require 'socket'
@@ -17,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'
@@ -24,19 +27,21 @@ require 'excon/middlewares/mock'
 require 'excon/middlewares/response_parser'
 
 require 'excon/error'
+require 'excon/resolver_factory'
 require 'excon/constants'
 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'
 require 'excon/pretty_printer'
 require 'excon/socket'
 require 'excon/ssl_socket'
+require 'excon/socks5'
+require 'excon/socks5_socket'
+require 'excon/socks5_ssl_socket'
 require 'excon/instrumentors/standard_instrumentor'
 require 'excon/instrumentors/logging_instrumentor'
 require 'excon/unix_socket'
@@ -44,27 +49,22 @@ require 'excon/unix_socket'
 # Define defaults first so they will be available to other files
 module Excon
   class << self
-
     # @return [Hash] defaults for Excon connections
     def defaults
-      @defaults ||= DEFAULTS
+      @defaults ||= DEFAULTS.dup
     end
 
     # Change defaults for Excon connections
     # @return [Hash] defaults for Excon connections
-    def defaults=(new_defaults)
-      @defaults = new_defaults
-    end
+    attr_writer :defaults
 
     def display_warning(warning)
       # Show warning if $VERBOSE or ENV['EXCON_DEBUG'] is set
-      if $VERBOSE || ENV['EXCON_DEBUG']
-        $stderr.puts "[excon][WARNING] #{warning}\n#{ caller.join("\n") }"
-      end
+      ($VERBOSE || ENV['EXCON_DEBUG']) && Warning.warn("[excon][WARNING] #{warning}\n#{caller.join("\n")}")
 
-      if @raise_on_warnings
-        raise Error::Warning.new(warning)
-      end
+      return unless @raise_on_warnings
+
+      raise(Error::Warning, warning)
     end
 
     def set_raise_on_warnings!(should_raise)
@@ -119,32 +119,25 @@ module Excon
     def new(url, params = {})
       uri_parser = params[:uri_parser] || defaults[:uri_parser]
       uri = uri_parser.parse(url)
-      if params[:path]
-        uri_parser.parse(params[:path])
-      end
-      unless uri.scheme
-        raise ArgumentError.new("Invalid URI: #{uri}")
-      end
+      params[:path] && uri_parser.parse(params[:path])
+      raise(ArgumentError, "Invalid URI: #{uri}") unless uri.scheme
+
       params = {
-        :host       => uri.host,
-        :hostname   => uri.hostname,
-        :path       => uri.path,
-        :port       => uri.port,
-        :query      => uri.query,
-        :scheme     => uri.scheme
+        host: uri.host,
+        hostname: uri.hostname,
+        path: uri.path,
+        port: uri.port,
+        query: uri.query,
+        scheme: uri.scheme
       }.merge(params)
-      if uri.password
-        params[:password] = Utils.unescape_uri(uri.password)
-      end
-      if uri.user
-        params[:user] = Utils.unescape_uri(uri.user)
-      end
+      uri.password && params[:password] = Utils.unescape_uri(uri.password)
+      uri.user && params[:user] = Utils.unescape_uri(uri.user)
       Excon::Connection.new(params)
     end
 
     # push an additional stub onto the list to check for mock requests
     # @param request_params [Hash<Symbol, >] request params to match against, omitted params match all
-    # @param response_params [Hash<Symbol, >] response params to return from matched request or block to call with params
+    # @param response_params [Hash<Symbol, >] response params to return or block to call with matched params
     def stub(request_params = {}, response_params = nil, &block)
       if (method = request_params.delete(:method))
         request_params[:method] = method.to_s.downcase.to_sym
@@ -152,35 +145,35 @@ module Excon
       if (url = request_params.delete(:url))
         uri = URI.parse(url)
         request_params = {
-          :host              => uri.host,
-          :path              => uri.path,
-          :port              => uri.port,
-          :query             => uri.query,
-          :scheme            => uri.scheme
+          host: uri.host,
+          path: uri.path.empty? ? '/' : uri.path,
+          port: uri.port,
+          query: uri.query,
+          scheme: uri.scheme
         }.merge!(request_params)
         if uri.user || uri.password
           request_params[:headers] ||= {}
-          user, pass = Utils.unescape_form(uri.user.to_s), Utils.unescape_form(uri.password.to_s)
+          user = Utils.unescape_form(uri.user.to_s)
+          pass = Utils.unescape_form(uri.password.to_s)
           request_params[:headers]['Authorization'] ||= 'Basic ' + ["#{user}:#{pass}"].pack('m').delete(Excon::CR_NL)
         end
       end
-      if request_params.has_key?(:headers)
+      if request_params.key?(:headers)
         headers = Excon::Headers.new
         request_params[:headers].each do |key, value|
           headers[key] = value
         end
         request_params[:headers] = headers
       end
+      request_params[:query] = Utils.query_string(request_params)[1...] if request_params.key?(:query)
       if block_given?
-        if response_params
-          raise(ArgumentError.new("stub requires either response_params OR a block"))
-        else
-          stub = [request_params, block]
-        end
+        raise(ArgumentError, 'stub requires either response_params OR a block') if response_params
+
+        stub = [request_params, block]
       elsif response_params
         stub = [request_params, response_params]
       else
-        raise(ArgumentError.new("stub requires either response_params OR a block"))
+        raise(ArgumentError, 'stub requires either response_params OR a block')
       end
       stubs.unshift(stub)
       stub
@@ -193,9 +186,10 @@ module Excon
       if (method = request_params.delete(:method))
         request_params[:method] = method.to_s.downcase.to_sym
       end
+      request_params[:query] = Utils.query_string(request_params)[1...] if request_params.key?(:query)
       Excon.stubs.each do |stub, response_params|
-        captures = { :headers => {} }
-        headers_match = !stub.has_key?(:headers) || stub[:headers].keys.all? do |key|
+        captures = { headers: {} }
+        headers_match = !stub.key?(:headers) || stub[:headers].keys.all? do |key|
           case value = stub[:headers][key]
           when Regexp
             case request_params[:headers][key]
@@ -249,9 +243,9 @@ module Excon
     # @param request_params [Hash<Symbol, >] request params to match against, omitted params match all
     # @return [Hash<Symbol, >] response params from deleted stub
     def unstub(request_params = {})
-      if (stub = stub_for(request_params))
-        Excon.stubs.delete_at(Excon.stubs.index(stub))
-      end
+      return unless (stub = stub_for(request_params))
+
+      Excon.stubs.delete_at(Excon.stubs.index(stub))
     end
 
     # Generic non-persistent HTTP methods

metadata

@@ -1,31 +1,30 @@
 --- !ruby/object:Gem::Specification
 name: excon
 version: !ruby/object:Gem::Version
-  version: 0.109.0
+  version: 1.5.0
 platform: ruby
 authors:
 - dpiddy (Dan Peterson)
 - geemus (Wesley Beary)
 - nextmat (Matt Sanders)
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-01-03 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: logger
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.5.0
-  type: :development
+        version: '0'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.5.0
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -68,6 +67,20 @@ dependencies:
     - - ">="
       - !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
@@ -83,7 +96,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: puma
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -97,7 +110,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: shindo
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -111,7 +124,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: sinatra
+  name: rdoc
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -125,7 +138,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: sinatra-contrib
+  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:
     - - ">="
@@ -139,21 +166,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: json
+  name: sinatra
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.8.5
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.8.5
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: puma
+  name: sinatra-contrib
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -185,9 +212,9 @@ email: geemus@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files:
-- README.md
-- CONTRIBUTORS.md
 - CONTRIBUTING.md
+- CONTRIBUTORS.md
+- README.md
 files:
 - CONTRIBUTING.md
 - CONTRIBUTORS.md
@@ -204,7 +231,6 @@ files:
 - lib/excon/instrumentors/logging_instrumentor.rb
 - lib/excon/instrumentors/standard_instrumentor.rb
 - lib/excon/middlewares/base.rb
-- lib/excon/middlewares/capture_cookies.rb
 - lib/excon/middlewares/decompress.rb
 - lib/excon/middlewares/escape_path.rb
 - lib/excon/middlewares/expects.rb
@@ -214,8 +240,12 @@ files:
 - lib/excon/middlewares/redirect_follower.rb
 - lib/excon/middlewares/response_parser.rb
 - lib/excon/pretty_printer.rb
+- lib/excon/resolver_factory.rb
 - lib/excon/response.rb
 - lib/excon/socket.rb
+- lib/excon/socks5.rb
+- 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
@@ -229,13 +259,13 @@ homepage: https://github.com/excon/excon
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://github.com/excon/excon
   bug_tracker_uri: https://github.com/excon/excon/issues
   changelog_uri: https://github.com/excon/excon/blob/master/changelog.txt
   documentation_uri: https://github.com/excon/excon/blob/master/README.md
+  funding_uri: https://github.com/sponsors/geemus
+  homepage_uri: https://github.com/excon/excon
   source_code_uri: https://github.com/excon/excon
   wiki_uri: https://github.com/excon/excon/wiki
-post_install_message:
 rdoc_options:
 - "--charset=UTF-8"
 require_paths:
@@ -244,15 +274,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 3.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
-signing_key:
+rubygems_version: 4.0.3
 specification_version: 4
 summary: speed, persistence, http(s)
 test_files: []

data/lib/excon/middlewares/capture_cookies.rb

@@ -1,32 +0,0 @@
-# frozen_string_literal: true
-module Excon
-  module Middleware
-    class CaptureCookies < Excon::Middleware::Base
-
-      def extract_cookies_from_set_cookie(set_cookie)
-        set_cookie.split(',').map { |full| full.split(';').first.strip }.join('; ')
-      end
-
-      def get_header(datum, header)
-        _, header_value = datum[:response][:headers].detect do |key, _|
-          key.casecmp(header) == 0
-        end
-        header_value
-      end
-
-      def response_call(datum)
-        cookie = get_header(datum, 'Set-Cookie')
-        if cookie
-          cookie = extract_cookies_from_set_cookie(cookie)
-          unless datum[:headers].key?("Cookie")
-            datum[:headers]["Cookie"] = cookie
-          else
-            original_cookies = datum[:headers]["Cookie"]
-            datum[:headers]["Cookie"] = original_cookies.empty? ? cookie : [original_cookies,cookie].join('; ')
-          end
-        end
-        super(datum)
-      end
-    end
-  end
-end