excon 0.99.0 → 1.0.0

data/lib/excon/utils.rb

@@ -62,11 +62,33 @@ 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('http').zero? && datum[:port] == 80) ||
+        (datum[:scheme].casecmp('https').zero? && datum[:port] == 443)
     end
 
     def query_string(datum)

data/lib/excon/version.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Excon
-  VERSION = '0.99.0'
+  VERSION = '1.0.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 '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'
@@ -30,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'
@@ -44,7 +46,6 @@ 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
@@ -52,19 +53,15 @@ module Excon
 
     # 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 +116,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 +142,37 @@ 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
+      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?
-        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 +185,12 @@ 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.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]
@@ -245,11 +240,12 @@ module Excon
       end
     end
 
-    # remove first/oldest stub matching request_params
+    # remove first/oldest stub matching request_params or nil if none match
     # @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 = {})
-      stub = stub_for(request_params)
+      return unless (stub = stub_for(request_params))
+
       Excon.stubs.delete_at(Excon.stubs.index(stub))
     end
 

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: excon
 version: !ruby/object:Gem::Version
-  version: 0.99.0
+  version: 1.0.0
 platform: ruby
 authors:
 - dpiddy (Dan Peterson)
 - geemus (Wesley Beary)
 - nextmat (Matt Sanders)
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-02-03 00:00:00.000000000 Z
+date: 2024-10-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -235,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:
@@ -244,15 +244,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.1
-signing_key: 
+rubygems_version: 3.5.18
+signing_key:
 specification_version: 4
 summary: speed, persistence, http(s)
 test_files: []