excon 0.49.0 → 0.88.0

data/lib/excon/test/server.rb

@@ -0,0 +1,106 @@
+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]
+      Excon.defaults.merge!(
+        connect_timeout: 5,
+        read_timeout: 5,
+        write_timeout: 5
+      )
+
+      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
+          GC.disable if RUBY_VERSION < '1.9'
+          @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(9, pid)
+          GC.enable if RUBY_VERSION < '1.9'
+          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 =~ /(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

data/lib/excon/unix_socket.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Excon
   class UnixSocket < Excon::Socket
 
@@ -19,6 +20,7 @@ module Excon
           begin
             @socket.connect_nonblock(sockaddr)
           rescue Errno::EISCONN
+            0 # same return as connect_nonblock success
           end
         end
       else

data/lib/excon/utils.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Excon
   module Utils
     extend self
@@ -9,31 +10,67 @@ module Excon
     UNESCAPED = /([#{ Regexp.escape(CONTROL + ' ' + DELIMS + UNWISE + NONASCII) }])/
     ESCAPED   = /%([0-9a-fA-F]{2})/
 
+    def binary_encode(string)
+      if FORCE_ENC && string.encoding != Encoding::ASCII_8BIT
+        if string.frozen?
+          string.dup.force_encoding('BINARY')
+        else
+          string.force_encoding('BINARY')
+        end
+      else
+        string
+      end
+    end
+
     def connection_uri(datum = @data)
       unless datum
         raise ArgumentError, '`datum` must be given unless called on a Connection'
       end
       if datum[:scheme] == UNIX
-        '' << datum[:scheme] << '://' << datum[:socket]
+        "#{datum[:scheme]}://#{datum[:socket]}"
       else
-        '' << datum[:scheme] << '://' << datum[:host] << port_string(datum)
+        "#{datum[:scheme]}://#{datum[:host]}#{port_string(datum)}"
       end
     end
 
+    # 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')
+          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
+      end
+      if datum.has_key?(:proxy) && datum[:proxy] && datum[:proxy].has_key?(:password)
+        datum[:proxy] = datum[:proxy].dup
+        datum[:proxy][:password] = REDACTED
+      end
+      datum
+    end
+
     def request_uri(datum)
-      connection_uri(datum) << datum[:path] << query_string(datum)
+      connection_uri(datum) + datum[:path] + query_string(datum)
     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)))
         ''
       else
-        ':' << datum[:port].to_s
+        ':' + datum[:port].to_s
       end
     end
 
     def query_string(datum)
-      str = ''
+      str = String.new
       case datum[:query]
       when String
         str << '?' << datum[:query]
@@ -58,31 +95,49 @@ module Excon
     def split_header_value(str)
       return [] if str.nil?
       str = str.dup.strip
-      str.force_encoding('BINARY') if FORCE_ENC
-      str.scan(%r'\G((?:"(?:\\.|[^"])+?"|[^",]+)+)
+      str = binary_encode(str)
+      str.scan(%r'\G((?:"(?:\\.|[^"])+?"|[^",])+)
                     (?:,\s*|\Z)'xn).flatten
     end
 
     # Escapes HTTP reserved and unwise characters in +str+
     def escape_uri(str)
       str = str.dup
-      str.force_encoding('BINARY') if FORCE_ENC
+      str = binary_encode(str)
       str.gsub(UNESCAPED) { "%%%02X" % $1[0].ord }
     end
 
     # Unescapes HTTP reserved and unwise characters in +str+
     def unescape_uri(str)
       str = str.dup
-      str.force_encoding('BINARY') if FORCE_ENC
+      str = binary_encode(str)
       str.gsub(ESCAPED) { $1.hex.chr }
     end
 
     # Unescape form encoded values in +str+
     def unescape_form(str)
       str = str.dup
-      str.force_encoding('BINARY') if FORCE_ENC
+      str = binary_encode(str)
       str.gsub!(/\+/, ' ')
       str.gsub(ESCAPED) { $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.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"')
+        end
+        [values].flatten.each do |value|
+          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"')
+          end
+          headers_str << key.to_s << ': ' << value.to_s << CR_NL
+        end
+      end
+      headers_str
+    end
   end
 end

data/lib/excon/version.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+module Excon
+  VERSION = '0.88.0'
+end

data/lib/excon.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 $:.unshift(File.dirname(__FILE__)) unless
   $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
 
@@ -11,6 +12,8 @@ require 'uri'
 require 'zlib'
 require 'stringio'
 
+require 'excon/version'
+
 require 'excon/extensions/uri'
 
 require 'excon/middlewares/base'
@@ -20,11 +23,11 @@ require 'excon/middlewares/instrumentor'
 require 'excon/middlewares/mock'
 require 'excon/middlewares/response_parser'
 
+require 'excon/error'
 require 'excon/constants'
 require 'excon/utils'
 
 require 'excon/connection'
-require 'excon/errors'
 require 'excon/headers'
 require 'excon/response'
 require 'excon/middlewares/decompress'
@@ -34,7 +37,8 @@ require 'excon/middlewares/capture_cookies'
 require 'excon/pretty_printer'
 require 'excon/socket'
 require 'excon/ssl_socket'
-require 'excon/standard_instrumentor'
+require 'excon/instrumentors/standard_instrumentor'
+require 'excon/instrumentors/logging_instrumentor'
 require 'excon/unix_socket'
 
 # Define defaults first so they will be available to other files
@@ -55,10 +59,18 @@ module Excon
     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") }"
+        $stderr.puts "[excon][WARNING] #{warning}\n#{ caller.join("\n") }"
+      end
+
+      if @raise_on_warnings
+        raise Error::Warning.new(warning)
       end
     end
 
+    def set_raise_on_warnings!(should_raise)
+      @raise_on_warnings = should_raise
+    end
+
     # Status of mocking
     def mock
       display_warning('Excon#mock is deprecated, use Excon.defaults[:mock] instead.')
@@ -101,12 +113,15 @@ module Excon
 
     # @see Connection#initialize
     # Initializes a new keep-alive session for a given remote host
-    #   @param [String] url The destination URL
-    #   @param [Hash<Symbol, >] params One or more option params to set on the Connection instance
-    #   @return [Connection] A new Excon::Connection instance
+    # @param [String] url The destination URL
+    # @param [Hash<Symbol, >] params One or more option params to set on the Connection instance
+    # @return [Connection] A new Excon::Connection instance
     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
@@ -128,13 +143,13 @@ module Excon
     end
 
     # push an additional stub onto the list to check for mock requests
-    #   @param [Hash<Symbol, >] request params to match against, omitted params match all
-    #   @param [Hash<Symbol, >] response params to return from matched request or block to call with params
-    def stub(request_params = {}, response_params = nil)
-      if method = request_params.delete(:method)
+    # @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
+    def stub(request_params = {}, response_params = nil, &block)
+      if (method = request_params.delete(:method))
         request_params[:method] = method.to_s.downcase.to_sym
       end
-      if url = request_params.delete(:url)
+      if (url = request_params.delete(:url))
         uri = URI.parse(url)
         request_params = {
           :host              => uri.host,
@@ -146,7 +161,7 @@ module Excon
         if uri.user || uri.password
           request_params[:headers] ||= {}
           user, pass = Utils.unescape_form(uri.user.to_s), Utils.unescape_form(uri.password.to_s)
-          request_params[:headers]['Authorization'] ||= 'Basic ' << ['' << user << ':' << pass].pack('m').delete(Excon::CR_NL)
+          request_params[:headers]['Authorization'] ||= 'Basic ' + ["#{user}:#{pass}"].pack('m').delete(Excon::CR_NL)
         end
       end
       if request_params.has_key?(:headers)
@@ -160,7 +175,7 @@ module Excon
         if response_params
           raise(ArgumentError.new("stub requires either response_params OR a block"))
         else
-          stub = [request_params, Proc.new]
+          stub = [request_params, block]
         end
       elsif response_params
         stub = [request_params, response_params]
@@ -172,10 +187,10 @@ module Excon
     end
 
     # get a stub matching params or nil
-    #   @param [Hash<Symbol, >] request params to match against, omitted params match all
-    #   @return [Hash<Symbol, >] response params to return from matched request or block to call with params
+    # @param request_params [Hash<Symbol, >] request params to match against, omitted params match all
+    # @return [Hash<Symbol, >] response params to return from matched request or block to call with params
     def stub_for(request_params={})
-      if method = request_params.delete(:method)
+      if (method = request_params.delete(:method))
         request_params[:method] = method.to_s.downcase.to_sym
       end
       Excon.stubs.each do |stub, response_params|
@@ -183,7 +198,7 @@ module Excon
         headers_match = !stub.has_key?(:headers) || stub[:headers].keys.all? do |key|
           case value = stub[:headers][key]
           when Regexp
-            if match = value.match(request_params[:headers][key])
+            if (match = value.match(request_params[:headers][key]))
               captures[:headers][key] = match.captures
             end
             match
@@ -194,7 +209,7 @@ module Excon
         non_headers_match = (stub.keys - [:headers]).all? do |key|
           case value = stub[key]
           when Regexp
-            if match = value.match(request_params[key])
+            if (match = value.match(request_params[key]))
               captures[key] = match.captures
             end
             match
@@ -221,8 +236,8 @@ module Excon
     end
 
     # remove first/oldest stub matching request_params
-    #   @param [Hash<Symbol, >] request params to match against, omitted params match all
-    #   @return [Hash<Symbol, >] response params from deleted stub
+    # @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)
       Excon.stubs.delete_at(Excon.stubs.index(stub))

metadata

@@ -1,17 +1,31 @@
 --- !ruby/object:Gem::Specification
 name: excon
 version: !ruby/object:Gem::Version
-  version: 0.49.0
+  version: 0.88.0
 platform: ruby
 authors:
 - dpiddy (Dan Peterson)
 - geemus (Wesley Beary)
 - nextmat (Matt Sanders)
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-03-28 00:00:00.000000000 Z
+date: 2021-10-27 00:00:00.000000000 Z
 dependencies:
+- !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: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -144,55 +158,65 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.8.2
+        version: 1.8.5
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.8.2
+        version: 1.8.5
+- !ruby/object:Gem::Dependency
+  name: puma
+  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
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: EXtended http(s) CONnections
 email: geemus@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files:
 - README.md
+- CONTRIBUTORS.md
+- CONTRIBUTING.md
 files:
 - CONTRIBUTING.md
 - CONTRIBUTORS.md
-- Gemfile
-- Gemfile.lock
 - LICENSE.md
 - README.md
-- Rakefile
-- benchmarks/class_vs_lambda.rb
-- benchmarks/concat_vs_insert.rb
-- benchmarks/concat_vs_interpolate.rb
-- benchmarks/cr_lf.rb
-- benchmarks/downcase-eq-eq_vs_casecmp.rb
-- benchmarks/excon.rb
-- benchmarks/excon_vs.rb
-- benchmarks/for_vs_array_each.rb
-- benchmarks/for_vs_hash_each.rb
-- benchmarks/has_key-vs-lookup.rb
-- benchmarks/headers_case_sensitivity.rb
-- benchmarks/headers_split_vs_match.rb
-- benchmarks/implicit_block-vs-explicit_block.rb
-- benchmarks/merging.rb
-- benchmarks/single_vs_double_quotes.rb
-- benchmarks/string_ranged_index.rb
-- benchmarks/strip_newline.rb
-- benchmarks/vs_stdlib.rb
-- changelog.txt
 - data/cacert.pem
 - excon.gemspec
 - lib/excon.rb
 - lib/excon/connection.rb
 - lib/excon/constants.rb
-- lib/excon/errors.rb
+- lib/excon/error.rb
 - lib/excon/extensions/uri.rb
 - lib/excon/headers.rb
+- 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
@@ -207,66 +231,25 @@ files:
 - lib/excon/response.rb
 - lib/excon/socket.rb
 - lib/excon/ssl_socket.rb
-- lib/excon/standard_instrumentor.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
-- tests/authorization_header_tests.rb
-- tests/bad_tests.rb
-- tests/basic_tests.rb
-- tests/complete_responses.rb
-- tests/data/127.0.0.1.cert.crt
-- tests/data/127.0.0.1.cert.key
-- tests/data/excon.cert.crt
-- tests/data/excon.cert.key
-- tests/data/xs
-- tests/errors_tests.rb
-- tests/header_tests.rb
-- tests/middlewares/canned_response_tests.rb
-- tests/middlewares/capture_cookies_tests.rb
-- tests/middlewares/decompress_tests.rb
-- tests/middlewares/escape_path_tests.rb
-- tests/middlewares/idempotent_tests.rb
-- tests/middlewares/instrumentation_tests.rb
-- tests/middlewares/mock_tests.rb
-- tests/middlewares/redirect_follower_tests.rb
-- tests/pipeline_tests.rb
-- tests/proxy_tests.rb
-- tests/query_string_tests.rb
-- tests/rackups/basic.rb
-- tests/rackups/basic.ru
-- tests/rackups/basic_auth.ru
-- tests/rackups/deflater.ru
-- tests/rackups/proxy.ru
-- tests/rackups/query_string.ru
-- tests/rackups/redirecting.ru
-- tests/rackups/redirecting_with_cookie.ru
-- tests/rackups/request_headers.ru
-- tests/rackups/request_methods.ru
-- tests/rackups/response_header.ru
-- tests/rackups/ssl.ru
-- tests/rackups/ssl_mismatched_cn.ru
-- tests/rackups/ssl_verify_peer.ru
-- tests/rackups/streaming.ru
-- tests/rackups/thread_safety.ru
-- tests/rackups/timeout.ru
-- tests/rackups/webrick_patch.rb
-- tests/request_headers_tests.rb
-- tests/request_method_tests.rb
-- tests/request_tests.rb
-- tests/response_tests.rb
-- tests/servers/bad.rb
-- tests/servers/eof.rb
-- tests/servers/error.rb
-- tests/servers/good.rb
-- tests/test_helper.rb
-- tests/thread_safety_tests.rb
-- tests/timeout_tests.rb
-- tests/utils_tests.rb
+- lib/excon/version.rb
 homepage: https://github.com/excon/excon
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+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
+  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:
@@ -282,9 +265,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: excon
-rubygems_version: 2.5.1
-signing_key: 
-specification_version: 2
+rubygems_version: 3.2.15
+signing_key:
+specification_version: 4
 summary: speed, persistence, http(s)
 test_files: []

data/Gemfile

@@ -1,19 +0,0 @@
-source "http://rubygems.org"
-
-gemspec
-
-gem 'jruby-openssl', :platform => :jruby
-gem 'unicorn', :platforms => [:mri, :rbx]
-gem 'rubysl', '~> 2.0', :platform => :rbx
-gem 'rack', '~> 1.6'
-
-# group :benchmark do
-#   gem 'em-http-request'
-#   gem 'httparty'
-#   gem 'rest-client'
-#   gem 'tach'
-#   gem 'typhoeus'
-#   gem 'sinatra'
-#   gem 'streamly_ffi'
-#   gem 'curb'
-# end