httpx 0.21.0 → 1.2.1

data/lib/httpx/adapters/sentry.rb

@@ -27,6 +27,11 @@ module HTTPX::Plugins
       def set_sentry_trace_header(request, sentry_span)
         return unless sentry_span
 
+        config = ::Sentry.configuration
+        url = request.uri.to_s
+
+        return unless config.propagate_traces && config.trace_propagation_targets.any? { |target| url.match?(target) }
+
         trace = ::Sentry.get_current_client.generate_sentry_trace(sentry_span)
         request.headers[::Sentry::SENTRY_TRACE_HEADER_NAME] = trace if trace
       end
@@ -43,8 +48,8 @@ module HTTPX::Plugins
 
         request_info = extract_request_info(req)
 
-        data = if response.is_a?(HTTPX::ErrorResponse)
-          { error: res.message, **request_info }
+        data = if res.is_a?(HTTPX::ErrorResponse)
+          { error: res.error.message, **request_info }
         else
           { status: res.status, **request_info }
         end
@@ -63,7 +68,11 @@ module HTTPX::Plugins
 
         request_info = extract_request_info(req)
         sentry_span.set_description("#{request_info[:method]} #{request_info[:url]}")
-        sentry_span.set_data(:status, res.status)
+        if res.is_a?(HTTPX::ErrorResponse)
+          sentry_span.set_data(:error, res.error.message)
+        else
+          sentry_span.set_data(:status, res.status)
+        end
         sentry_span.set_timestamp(::Sentry.utc_now.to_f)
       end
 
@@ -71,7 +80,7 @@ module HTTPX::Plugins
         uri = req.uri
 
         result = {
-          method: req.verb.to_s.upcase,
+          method: req.verb,
         }
 
         if ::Sentry.configuration.send_default_pii
@@ -85,17 +94,27 @@ module HTTPX::Plugins
       end
     end
 
+    module RequestMethods
+      def __sentry_enable_trace!
+        return if @__sentry_enable_trace
+
+        Tracer.call(self)
+        @__sentry_enable_trace = true
+      end
+    end
+
     module ConnectionMethods
       def send(request)
-        Tracer.call(request)
+        request.__sentry_enable_trace!
+
         super
       end
     end
   end
 end
 
-Sentry.register_patch do
-  sentry_session = ::HTTPX.plugin(HTTPX::Plugins::Sentry)
+Sentry.register_patch(:httpx) do
+  sentry_session = HTTPX.plugin(HTTPX::Plugins::Sentry)
 
   HTTPX.send(:remove_const, :Session)
   HTTPX.send(:const_set, :Session, sentry_session.class)

data/lib/httpx/adapters/webmock.rb

@@ -2,13 +2,8 @@
 
 module WebMock
   module HttpLibAdapters
-    if RUBY_VERSION < "2.5"
-      require "webrick/httpstatus"
-      HTTP_REASONS = WEBrick::HTTPStatus::StatusMessage
-    else
-      require "net/http/status"
-      HTTP_REASONS = Net::HTTP::STATUS_CODES
-    end
+    require "net/http/status"
+    HTTP_REASONS = Net::HTTP::STATUS_CODES
 
     #
     # HTTPX plugin for webmock.
@@ -23,7 +18,7 @@ module WebMock
           uri.path = uri.normalized_path.gsub("[^:]//", "/")
 
           WebMock::RequestSignature.new(
-            request.verb,
+            request.verb.downcase.to_sym,
             uri.to_s,
             body: request.body.each.to_a.join,
             headers: request.headers.to_h
@@ -43,12 +38,12 @@ module WebMock
 
           return build_error_response(request, webmock_response.exception) if webmock_response.exception
 
-          response = request.options.response_class.new(request,
-                                                        webmock_response.status[0],
-                                                        "2.0",
-                                                        webmock_response.headers)
-          response << webmock_response.body.dup
-          response
+          request.options.response_class.new(request,
+                                             webmock_response.status[0],
+                                             "2.0",
+                                             webmock_response.headers).tap do |res|
+            res.mocked = true
+          end
         end
 
         def build_error_response(request, exception)
@@ -57,16 +52,36 @@ module WebMock
       end
 
       module InstanceMethods
-        def build_connection(*)
+        def init_connection(*)
           connection = super
           connection.once(:unmock_connection) do
+            unless connection.addresses
+              connection.__send__(:callbacks)[:connect_error].clear
+              pool.__send__(:unregister_connection, connection)
+            end
             pool.__send__(:resolve_connection, connection)
-            pool.__send__(:unregister_connection, connection) unless connection.addresses
           end
           connection
         end
       end
 
+      module ResponseMethods
+        attr_accessor :mocked
+
+        def initialize(*)
+          super
+          @mocked = false
+        end
+      end
+
+      module ResponseBodyMethods
+        def decode_chunk(chunk)
+          return chunk if @response.mocked
+
+          super
+        end
+      end
+
       module ConnectionMethods
         def initialize(*)
           super
@@ -95,6 +110,7 @@ module WebMock
             log { "mocking #{request.uri} with #{mock_response.inspect}" }
             request.response = response
             request.emit(:response, response)
+            response << mock_response.body.dup unless response.is_a?(HTTPX::ErrorResponse)
           elsif WebMock.net_connect_allowed?(request_signature.uri)
             if WebMock::CallbackRegistry.any_callbacks?
               request.on(:response) do |resp|
@@ -122,7 +138,7 @@ module WebMock
 
       class << self
         def enable!
-          @original_session = HTTPX::Session
+          @original_session ||= HTTPX::Session
 
           webmock_session = HTTPX.plugin(Plugin)
 

data/lib/httpx/altsvc.rb

@@ -4,7 +4,59 @@ require "strscan"
 
 module HTTPX
   module AltSvc
-    @altsvc_mutex = Mutex.new
+    # makes connections able to accept requests destined to primary service.
+    module ConnectionMixin
+      using URIExtensions
+
+      def send(request)
+        request.headers["alt-used"] = @origin.authority if @parser && !@write_buffer.full? && match_altsvcs?(request.uri)
+
+        super
+      end
+
+      def match?(uri, options)
+        return false if !used? && (@state == :closing || @state == :closed)
+
+        match_altsvcs?(uri) && match_altsvc_options?(uri, options)
+      end
+
+      private
+
+      # checks if this is connection is an alternative service of
+      # +uri+
+      def match_altsvcs?(uri)
+        @origins.any? { |origin| altsvc_match?(uri, origin) } ||
+          AltSvc.cached_altsvc(@origin).any? do |altsvc|
+            origin = altsvc["origin"]
+            altsvc_match?(origin, uri.origin)
+          end
+      end
+
+      def match_altsvc_options?(uri, options)
+        return @options == options unless @options.ssl.all? do |k, v|
+          v == (k == :hostname ? uri.host : options.ssl[k])
+        end
+
+        @options.options_equals?(options, Options::REQUEST_BODY_IVARS + %i[@ssl])
+      end
+
+      def altsvc_match?(uri, other_uri)
+        other_uri = URI(other_uri)
+
+        uri.origin == other_uri.origin || begin
+          case uri.scheme
+          when "h2"
+            (other_uri.scheme == "https" || other_uri.scheme == "h2") &&
+              uri.host == other_uri.host &&
+              uri.port == other_uri.port
+          else
+            false
+          end
+        end
+      end
+    end
+
+    @altsvc_mutex = Thread::Mutex.new
     @altsvcs = Hash.new { |h, k| h[k] = [] }
 
     module_function
@@ -46,7 +98,7 @@ module HTTPX
 
       altsvc = response.headers["alt-svc"]
 
-      # https://tools.ietf.org/html/rfc7838#section-3
+      # https://datatracker.ietf.org/doc/html/rfc7838#section-3
       # A field value containing the special value "clear" indicates that the
       # origin requests all alternatives for that origin to be invalidated
       # (including those specified in the same response, in case of an
@@ -98,29 +150,14 @@ module HTTPX
       end
     end
 
-    # :nocov:
-    if RUBY_VERSION < "2.2"
-      def parse_altsvc_origin(alt_proto, alt_origin)
-        alt_scheme = parse_altsvc_scheme(alt_proto) or return
-
-        alt_origin = alt_origin[1..-2] if alt_origin.start_with?("\"") && alt_origin.end_with?("\"")
-        if alt_origin.start_with?(":")
-          alt_origin = "#{alt_scheme}://dummy#{alt_origin}"
-          uri = URI.parse(alt_origin)
-          uri.host = nil
-          uri
-        else
-          URI.parse("#{alt_scheme}://#{alt_origin}")
-        end
-      end
-    else
-      def parse_altsvc_origin(alt_proto, alt_origin)
-        alt_scheme = parse_altsvc_scheme(alt_proto) or return
-        alt_origin = alt_origin[1..-2] if alt_origin.start_with?("\"") && alt_origin.end_with?("\"")
+    def parse_altsvc_origin(alt_proto, alt_origin)
+      alt_scheme = parse_altsvc_scheme(alt_proto)
 
-        URI.parse("#{alt_scheme}://#{alt_origin}")
-      end
+      return unless alt_scheme
+
+      alt_origin = alt_origin[1..-2] if alt_origin.start_with?("\"") && alt_origin.end_with?("\"")
+
+      URI.parse("#{alt_scheme}://#{alt_origin}")
     end
-    # :nocov:
   end
 end

data/lib/httpx/base64.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+if RUBY_VERSION < "3.3.0"
+  require "base64"
+elsif !defined?(Base64)
+  module HTTPX
+    # require "base64" will not be a default gem after ruby 3.4.0
+    module Base64
+      module_function
+
+      def decode64(str)
+        str.unpack1("m")
+      end
+
+      def strict_encode64(bin)
+        [bin].pack("m0")
+      end
+
+      def urlsafe_encode64(bin, padding: true)
+        str = strict_encode64(bin)
+        str.chomp!("==") or str.chomp!("=") unless padding
+        str.tr!("+/", "-_")
+        str
+      end
+    end
+  end
+end

data/lib/httpx/buffer.rb

@@ -3,6 +3,14 @@
 require "forwardable"
 
 module HTTPX
+  # Internal class to abstract a string buffer, by wrapping a string and providing the
+  # minimum possible API and functionality required.
+  #
+  #     buffer = Buffer.new(640)
+  #     buffer.full? #=> false
+  #     buffer << "aa"
+  #     buffer.capacity #=> 638
+  #
   class Buffer
     extend Forwardable
 
@@ -31,6 +39,10 @@ module HTTPX
       @buffer.bytesize >= @limit
     end
 
+    def capacity
+      @limit - @buffer.bytesize
+    end
+
     def shift!(fin)
       @buffer = @buffer.byteslice(fin..-1) || "".b
     end

data/lib/httpx/callbacks.rb

@@ -4,6 +4,7 @@ module HTTPX
   module Callbacks
     def on(type, &action)
       callbacks(type) << action
+      self
     end
 
     def once(type, &block)
@@ -11,6 +12,7 @@ module HTTPX
         block.call(*args, &callback)
         :delete
       end
+      self
     end
 
     def only(type, &block)
@@ -22,12 +24,12 @@ module HTTPX
       callbacks(type).delete_if { |pr| :delete == pr.call(*args) } # rubocop:disable Style/YodaCondition
     end
 
-    protected
-
     def callbacks_for?(type)
-      @callbacks.key?(type) && !@callbacks[type].empty?
+      @callbacks.key?(type) && @callbacks[type].any?
     end
 
+    protected
+
     def callbacks(type = nil)
       return @callbacks unless type
 

data/lib/httpx/chainable.rb

@@ -1,89 +1,104 @@
 # frozen_string_literal: true
 
 module HTTPX
+  # Session mixin, implements most of the APIs that the users call.
+  # delegates to a default session when extended.
   module Chainable
-    %i[head get post put delete trace options connect patch].each do |meth|
+    %w[head get post put delete trace options connect patch].each do |meth|
       class_eval(<<-MOD, __FILE__, __LINE__ + 1)
-        def #{meth}(*uri, **options)        # def get(*uri, **options)
-          request(:#{meth}, uri, **options) #   request(:get, uri, **options)
-        end                                 # end
+        def #{meth}(*uri, **options)                # def get(*uri, **options)
+          request("#{meth.upcase}", uri, **options) #   request("GET", uri, **options)
+        end                                         # end
       MOD
     end
 
+    # delegates to the default session (see HTTPX::Session#request).
     def request(*args, **options)
       branch(default_options).request(*args, **options)
     end
 
-    # :nocov:
-    def timeout(**args)
-      warn ":#{__method__} is deprecated, use :with_timeout instead"
-      with(timeout: args)
-    end
-
-    def headers(headers)
-      warn ":#{__method__} is deprecated, use :with_headers instead"
-      with(headers: headers)
-    end
-    # :nocov:
-
     def accept(type)
       with(headers: { "accept" => String(type) })
     end
 
+    # delegates to the default session (see HTTPX::Session#wrap).
     def wrap(&blk)
       branch(default_options).wrap(&blk)
     end
 
+    # returns a new instance loaded with the +pl+ plugin and +options+.
     def plugin(pl, options = nil, &blk)
-      klass = is_a?(Session) ? self.class : Session
+      klass = is_a?(S) ? self.class : Session
       klass = Class.new(klass)
       klass.instance_variable_set(:@default_options, klass.default_options.merge(default_options))
       klass.plugin(pl, options, &blk).new
     end
 
-    # deprecated
-    # :nocov:
-    def plugins(pls)
-      warn ":#{__method__} is deprecated, use :plugin instead"
-      klass = is_a?(Session) ? self.class : Session
-      klass = Class.new(klass)
-      klass.instance_variable_set(:@default_options, klass.default_options.merge(default_options))
-      klass.plugins(pls).new
-    end
-    # :nocov:
-
+    # returns a new instance loaded with +options+.
     def with(options, &blk)
       branch(default_options.merge(options), &blk)
     end
 
     private
 
+    # returns default instance of HTTPX::Options.
     def default_options
       @options || Session.default_options
     end
 
+    # returns a default instance of HTTPX::Session.
     def branch(options, &blk)
-      return self.class.new(options, &blk) if is_a?(Session)
+      return self.class.new(options, &blk) if is_a?(S)
 
       Session.new(options, &blk)
     end
 
-    def method_missing(meth, *args, **options)
-      return super unless meth =~ /\Awith_(.+)/
+    def method_missing(meth, *args, **options, &blk)
+      case meth
+      when /\Awith_(.+)/
 
-      option = Regexp.last_match(1)
+        option = Regexp.last_match(1)
 
-      return super unless option
+        return super unless option
 
-      with(option.to_sym => (args.first || options))
-    end
+        with(option.to_sym => args.first || options)
+      when /\Aon_(.+)/
+        callback = Regexp.last_match(1)
 
-    def respond_to_missing?(meth, *)
-      return super unless meth =~ /\Awith_(.+)/
+        return super unless %w[
+          connection_opened connection_closed
+          request_error
+          request_started request_body_chunk request_completed
+          response_started response_body_chunk response_completed
+        ].include?(callback)
 
-      option = Regexp.last_match(1)
+        warn "DEPRECATION WARNING: calling `.#{meth}` on plain HTTPX sessions is deprecated. " \
+             "Use HTTPX.plugin(:callbacks).#{meth} instead."
 
-      default_options.respond_to?(option) || super
+        plugin(:callbacks).__send__(meth, *args, **options, &blk)
+      else
+        super
+      end
+    end
+
+    def respond_to_missing?(meth, *)
+      case meth
+      when /\Awith_(.+)/
+        option = Regexp.last_match(1)
+
+        default_options.respond_to?(option) || super
+      when /\Aon_(.+)/
+        callback = Regexp.last_match(1)
+
+        %w[
+          connection_opened connection_closed
+          request_error
+          request_started request_body_chunk request_completed
+          response_started response_body_chunk response_completed
+        ].include?(callback) || super
+      else
+        super
+      end
     end
   end
 end