httpx 1.2.6 → 1.4.4

data/lib/httpx/transcoder/json.rb

@@ -6,7 +6,19 @@ module HTTPX::Transcoder
   module JSON
     module_function
 
-    JSON_REGEX = %r{\bapplication/(?:vnd\.api\+|hal\+)?json\b}i.freeze
+    JSON_REGEX = %r{
+      \b
+      application/
+      # optional vendor specific type
+      (?:
+        # token as per https://datatracker.ietf.org/doc/html/rfc7230#section-3.2.6
+        [!#$%&'*+\-.^_`|~0-9a-z]+
+        # literal plus sign
+        \+
+      )?
+      json
+      \b
+    }ix.freeze
 
     class Encoder
       extend Forwardable
@@ -15,6 +27,8 @@ module HTTPX::Transcoder
 
       def_delegator :@raw, :bytesize
 
+      def_delegator :@raw, :==
+
       def initialize(json)
         @raw = JSON.json_dump(json)
         @charset = @raw.encoding.name.downcase
@@ -43,7 +57,7 @@ module HTTPX::Transcoder
       def json_dump(*args); MultiJson.dump(*args); end
     elsif defined?(Oj)
       def json_load(response, *args); Oj.load(response.to_s, *args); end
-      def json_dump(*args); Oj.dump(*args); end
+      def json_dump(obj, options = {}); Oj.dump(obj, { mode: :compat }.merge(options)); end
     elsif defined?(Yajl)
       def json_load(response, *args); Yajl::Parser.new(*args).parse(response.to_s); end
       def json_dump(*args); Yajl::Encoder.encode(*args); end

data/lib/httpx/transcoder/multipart/encoder.rb

@@ -11,6 +11,7 @@ module HTTPX
         @buffer = "".b
 
         @form = form
+        @bytesize = 0
         @parts = to_parts(form)
       end
 
@@ -18,6 +19,12 @@ module HTTPX
         "multipart/form-data; boundary=#{@boundary}"
       end
 
+      def to_s
+        read
+      ensure
+        rewind
+      end
+
       def read(length = nil, outbuf = nil)
         data   = String(outbuf).clear.force_encoding(Encoding::BINARY) if outbuf
         data ||= "".b
@@ -29,11 +36,14 @@ module HTTPX
 
       def rewind
         form = @form.each_with_object([]) do |(key, val), aux|
-          val = val.reopen(val.path, File::RDONLY) if val.is_a?(File) && val.closed?
+          if val.respond_to?(:path) && val.respond_to?(:reopen) && val.respond_to?(:closed?) && val.closed?
+            val = val.reopen(val.path, File::RDONLY)
+          end
           val.rewind if val.respond_to?(:rewind)
           aux << [key, val]
         end
         @form = form
+        @bytesize = 0
         @parts = to_parts(form)
         @part_index = 0
       end
@@ -41,7 +51,6 @@ module HTTPX
       private
 
       def to_parts(form)
-        @bytesize = 0
         params = form.each_with_object([]) do |(key, val), aux|
           Transcoder.normalize_keys(key, val, MULTIPART_VALUE_COND) do |k, v|
             next if v.nil?

data/lib/httpx/transcoder/multipart/part.rb

@@ -19,7 +19,7 @@ module HTTPX
           value = value[:body]
         end
 
-        value = value.open(File::RDONLY) if Object.const_defined?(:Pathname) && value.is_a?(Pathname)
+        value = value.open(File::RDONLY, encoding: Encoding::BINARY) if Object.const_defined?(:Pathname) && value.is_a?(Pathname)
 
         if value.respond_to?(:path) && value.respond_to?(:read)
           # either a File, a Tempfile, or something else which has to quack like a file

data/lib/httpx/transcoder/utils/deflater.rb

@@ -1,13 +1,10 @@
 # frozen_string_literal: true
 
-require "forwardable"
 require_relative "body_reader"
 
 module HTTPX
   module Transcoder
     class Deflater
-      extend Forwardable
-
       attr_reader :content_type
 
       def initialize(body)
@@ -51,6 +48,12 @@ module HTTPX
         @closed = true
       end
 
+      def rewind
+        return unless @buffer
+
+        @buffer.rewind
+      end
+
       private
 
       # rubocop:disable Naming/MemoizedInstanceVariableName
@@ -62,7 +65,7 @@ module HTTPX
         )
         ::IO.copy_stream(self, buffer)
 
-        buffer.rewind
+        buffer.rewind if buffer.respond_to?(:rewind)
 
         @buffer = buffer
       end

data/lib/httpx/transcoder.rb

@@ -86,7 +86,6 @@ end
 require "httpx/transcoder/body"
 require "httpx/transcoder/form"
 require "httpx/transcoder/json"
-require "httpx/transcoder/xml"
 require "httpx/transcoder/chunker"
 require "httpx/transcoder/deflate"
 require "httpx/transcoder/gzip"

data/lib/httpx/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module HTTPX
-  VERSION = "1.2.6"
+  VERSION = "1.4.4"
 end

data/lib/httpx.rb

@@ -2,28 +2,11 @@
 
 require "httpx/version"
 
-require "httpx/extensions"
-
-require "httpx/errors"
-require "httpx/utils"
-require "httpx/punycode"
-require "httpx/domain_name"
-require "httpx/altsvc"
-require "httpx/callbacks"
-require "httpx/loggable"
-require "httpx/transcoder"
-require "httpx/timers"
-require "httpx/pool"
-require "httpx/headers"
-require "httpx/request"
-require "httpx/response"
-require "httpx/options"
-require "httpx/chainable"
-
 # Top-Level Namespace
 #
 module HTTPX
   EMPTY = [].freeze
+  EMPTY_HASH = {}.freeze
 
   # All plugins should be stored under this module/namespace. Can register and load
   # plugins.
@@ -53,15 +36,31 @@ module HTTPX
       m.synchronize { h[name] = mod }
     end
   end
-
-  extend Chainable
 end
 
+require "httpx/extensions"
+
+require "httpx/errors"
+require "httpx/utils"
+require "httpx/punycode"
+require "httpx/domain_name"
+require "httpx/altsvc"
+require "httpx/callbacks"
+require "httpx/loggable"
+require "httpx/transcoder"
+require "httpx/timers"
+require "httpx/pool"
+require "httpx/headers"
+require "httpx/request"
+require "httpx/response"
+require "httpx/options"
+require "httpx/chainable"
+
 require "httpx/session"
 require "httpx/session_extensions"
 
 # load integrations when possible
 
-require "httpx/adapters/datadog" if defined?(DDTrace) || defined?(Datadog)
+require "httpx/adapters/datadog" if defined?(DDTrace) || defined?(Datadog::Tracing)
 require "httpx/adapters/sentry" if defined?(Sentry)
 require "httpx/adapters/webmock" if defined?(WebMock)

data/sig/callbacks.rbs

@@ -4,9 +4,8 @@ module HTTPX
   end
 
   module Callbacks
-    def on: (Symbol) { (*untyped) -> void } -> self
-    def once: (Symbol) { (*untyped) -> void } -> self
-    def only: (Symbol) { (*untyped) -> void } -> self
+    def on: (Symbol) { (*untyped) -> void } -> ^(*untyped) -> void
+    def once: (Symbol) { (*untyped) -> void } -> ^(*untyped) -> void
     def emit: (Symbol, *untyped) -> void
 
     def callbacks_for?: (Symbol) -> bool

data/sig/chainable.rbs

@@ -3,8 +3,8 @@ module HTTPX
     def request: (*Request, **untyped) -> Array[response]
                | (Request, **untyped) -> response
                | (verb, uri | [uri], **untyped) -> response
-               | (Array[[verb, uri] | [verb, uri, options]], **untyped) -> Array[response]
-               | (verb, _Each[uri | [uri, options]], **untyped) -> Array[response]
+               | (Array[[verb, uri] | [verb, uri, request_params]], **untyped) -> Array[response]
+               | (verb, _Each[uri | [uri, request_params]], **untyped) -> Array[response]
 
     def accept: (String) -> Session
     def wrap: () { (Session) -> void } -> void
@@ -35,6 +35,10 @@ module HTTPX
               | (:circuit_breaker, ?options) -> Plugins::sessionCircuitBreaker
               | (:oauth, ?options) -> Plugins::sessionOAuth
               | (:callbacks, ?options) -> Plugins::sessionCallbacks
+              | (:content_digest, ?options) -> Plugins::sessionContentDigest
+              | (:ssrf_filter, ?options) -> Plugins::sessionSsrf
+              | (:webdav, ?options) -> Plugins::sessionWebDav
+              | (:xml, ?options) -> Plugins::sessionXML
               | (Symbol | Module, ?options) { (Class) -> void } -> Session
               | (Symbol | Module, ?options) -> Session
 

data/sig/connection/http1.rbs

@@ -38,7 +38,7 @@ module HTTPX
 
     def consume: () -> void
 
-    def handle_error: (StandardError ex) -> void
+    def handle_error: (StandardError ex, ?Request? request) -> void
 
     def on_start: () -> void
 
@@ -58,7 +58,7 @@ module HTTPX
 
     private
 
-    def initialize: (Buffer, options) -> untyped
+    def initialize: (Buffer buffer, Options options) -> untyped
 
     def manage_connection: (Request request, Response response) -> void
 

data/sig/connection/http2.rbs

@@ -5,9 +5,10 @@ module HTTPX
 
     MAX_CONCURRENT_REQUESTS: Integer
 
-    attr_reader streams: Hash[Request, HTTP2Next::Stream]
+    attr_reader streams: Hash[Request, ::HTTP2::Stream]
     attr_reader pending: Array[Request]
 
+    @connection: HTTP2::Client
     @options: Options
     @settings: Hash[Symbol, Integer | bool]
     @max_concurrent_requests: Integer
@@ -28,11 +29,11 @@ module HTTPX
 
     def can_buffer_more_requests?: () -> bool
 
-    def send: (Request) -> void
+    def send: (Request request, ?bool head) -> bool
 
     def consume: () -> void
 
-    def handle_error: (StandardError ex) -> void
+    def handle_error: (StandardError ex, ?Request? request) -> void
 
     def ping: () -> void
 
@@ -42,35 +43,35 @@ module HTTPX
 
     private
 
-    def initialize: (Buffer, options) -> untyped
+    def initialize: (Buffer buffer, Options options) -> untyped
 
     def send_pending: () -> void
 
     def set_protocol_headers: (Request) -> _Each[[String, String]]
 
-    def handle: (Request request, HTTP2Next::Stream stream) -> void
+    def handle: (Request request, ::HTTP2::Stream stream) -> void
 
     def init_connection: () -> void
 
-    def handle_stream: (HTTP2Next::Stream stream, Request request) -> void
+    def handle_stream: (::HTTP2::Stream stream, Request request) -> void
 
     def join_headline: (Request request) -> String
 
-    def join_headers: (HTTP2Next::Stream stream, Request request) -> void
+    def join_headers: (::HTTP2::Stream stream, Request request) -> void
 
-    def join_trailers: (HTTP2Next::Stream stream, Request request) -> void
+    def join_trailers: (::HTTP2::Stream stream, Request request) -> void
 
-    def join_body: (HTTP2Next::Stream stream, Request request) -> void
+    def join_body: (::HTTP2::Stream stream, Request request) -> void
 
-    def on_stream_headers: (HTTP2Next::Stream stream, Request request, Array[[String, String]] headers) -> void
+    def on_stream_headers: (::HTTP2::Stream stream, Request request, Array[[String, String]] headers) -> void
 
-    def on_stream_trailers: (HTTP2Next::Stream stream, Response response, Array[[String, String]] headers) -> void
+    def on_stream_trailers: (::HTTP2::Stream stream, Response response, Array[[String, String]] headers) -> void
 
-    def on_stream_data: (HTTP2Next::Stream stream, Request request, String data) -> void
+    def on_stream_data: (::HTTP2::Stream stream, Request request, String data) -> void
 
-    def on_stream_refuse: (HTTP2Next::Stream stream, Request request, StandardError error) -> void
+    def on_stream_refuse: (::HTTP2::Stream stream, Request request, StandardError error) -> void
 
-    def on_stream_close: (HTTP2Next::Stream stream, Request request, (Symbol | StandardError)? error) -> void
+    def on_stream_close: (::HTTP2::Stream stream, Request request, (Symbol | StandardError)? error) -> void
 
     def on_frame: (string bytes) -> void
 
@@ -78,13 +79,13 @@ module HTTPX
 
     def on_close: (Integer last_frame, Symbol? error, String? payload) -> void
 
-    def on_frame_sent: (HTTP2Next::frame) -> void
+    def on_frame_sent: (::HTTP2::frame) -> void
 
-    def on_frame_received: (HTTP2Next::frame) -> void
+    def on_frame_received: (::HTTP2::frame) -> void
 
-    def on_altsvc: (String origin, HTTP2Next::frame) -> void
+    def on_altsvc: (String origin, ::HTTP2::frame) -> void
 
-    def on_promise: (HTTP2Next::Stream) -> void
+    def on_promise: (::HTTP2::Stream) -> void
 
     def on_origin: (String) -> void
 
@@ -95,5 +96,8 @@ module HTTPX
 
     class GoawayError < Error
     end
+
+    class PingError < Error
+    end
   end
 end

data/sig/connection.rbs

@@ -26,10 +26,12 @@ module HTTPX
     attr_reader pending: Array[Request]
     attr_reader options: Options
     attr_reader ssl_session: OpenSSL::SSL::Session?
-    attr_writer timers: Timers
-
+    attr_reader sibling: instance?
+    attr_writer current_selector: Selector?
+    attr_accessor current_session: Session?
     attr_accessor family: Integer?
 
+
     @window_size: Integer
     @read_buffer: Buffer
     @write_buffer: Buffer
@@ -41,10 +43,17 @@ module HTTPX
     @parser: Object & _Parser
     @connected_at: Float
     @response_received_at: Float
-    @intervals: Array[Timers::Interval]
+    @exhausted: bool
+    @cloned: bool
+    @coalesced_connection: instance?
+    @sibling: instance?
+    @main_sibling: bool
+
 
     def addresses: () -> Array[ipaddr]?
 
+    def peer: () -> URI::Generic
+
     def addresses=: (Array[ipaddr] addresses) -> void
 
     def send: (Request request) -> void
@@ -57,7 +66,7 @@ module HTTPX
 
     def coalescable?: (Connection connection) -> bool
 
-    def create_idle: (?Hash[Symbol, untyped] options) -> Connection
+    def create_idle: (?Hash[Symbol, untyped] options) -> instance
 
     def merge: (Connection connection) -> void
 
@@ -65,6 +74,8 @@ module HTTPX
 
     def connecting?: () -> bool
 
+    def io_connected?: () -> bool
+
     def inflight?: () -> boolish
 
     def interests: () -> io_interests?
@@ -77,6 +88,8 @@ module HTTPX
 
     def close: () -> void
 
+    def force_reset: (?bool cloned) -> void
+
     def reset: () -> void
 
     def timeout: () -> Numeric?
@@ -91,11 +104,19 @@ module HTTPX
 
     def handle_socket_timeout: (Numeric interval) -> void
 
+    def coalesced_connection=: (instance connection) -> void
+
+    def sibling=: (instance? connection) -> void
+
+    def handle_connect_error: (StandardError error) -> void
+
+    def disconnect: () -> void
+
     private
 
-    def initialize: (http_uri uri, options) -> void
+    def initialize: (http_uri uri, Options options) -> void
 
-    def initialize_type: (http_uri uri, Options) -> io_type
+    def initialize_type: (http_uri uri, Options options) -> io_type
 
     def connect: () -> void
 
@@ -117,21 +138,31 @@ module HTTPX
 
     def handle_transition: (Symbol nextstate) -> void
 
+    def build_altsvc_connection: (URI::Generic alt_origin, String origin, Hash[String, String] alt_params) -> void
+
     def build_socket: (?Array[ipaddr]? addrs) -> (TCP | SSL | UNIX)
 
-    def on_error: (HTTPX::TimeoutError | Error | StandardError error) -> void
+    def on_error: (HTTPX::TimeoutError | Error | StandardError error, ?Request? request) -> void
+
+    def handle_error: (StandardError error, ?Request? request) -> void
 
-    def handle_error: (StandardError error) -> void
+    def close_sibling: () -> void
 
     def purge_after_closed: () -> void
 
     def set_request_timeouts: (Request request) -> void
 
+    def set_request_read_timeout: (Request request) -> void
+
+    def set_request_write_timeout: (Request request) -> void
+
+    def set_request_request_timeout: (Request request) -> void
+
     def write_timeout_callback: (Request request, Numeric write_timeout) -> void
 
     def read_timeout_callback: (Request request, Numeric read_timeout, ?singleton(RequestTimeoutError) error_type) -> void
 
-    def set_request_timeout: (Request request, Numeric timeout, Symbol start_event, Symbol | Array[Symbol] finish_events) { () -> void } -> void
+    def set_request_timeout: (Symbol label, Request request, Numeric timeout, Symbol start_event, Symbol | Array[Symbol] finish_events) { () -> void } -> void
 
     def self.parser_type: (String protocol) -> (singleton(HTTP1) | singleton(HTTP2))
   end

data/sig/errors.rbs

@@ -17,6 +17,12 @@ module HTTPX
     def initialize: (Numeric timeout, String message) -> untyped
   end
 
+  class PoolTimeoutError < TimeoutError
+    attr_reader origin: String
+
+    def initialize: (String origin, Numeric timeout) -> void
+  end
+
   class ConnectTimeoutError < TimeoutError
   end
 
@@ -39,6 +45,9 @@ module HTTPX
   class WriteTimeoutError < RequestTimeoutError
   end
 
+  class OperationTimeoutError < TimeoutError
+  end
+
   class ResolveError < Error
   end
 
@@ -58,7 +67,4 @@ module HTTPX
 
     def initialize: (Connection connection, String hostname, ?String message) -> untyped
   end
-
-  class MisdirectedRequestError < HTTPError
-  end
 end

data/sig/httpx.rbs

@@ -9,9 +9,9 @@ module HTTPX
   type uri = http_uri | string
   type generic_uri = String | URI::Generic
 
-  type verb = "OPTIONS" | "GET" | "HEAD" | "POST" | "PUT" | "DELETE" | "TRACE" | "CONNECT" |
-              "PROPFIND" | "PROPPATCH" | "MKCOL" | "COPY" | "MOVE" | "LOCK" | "UNLOCK" | "ORDERPATCH" |
-              "ACL" | "REPORT" | "PATCH" | "SEARCH"
+  type verb = String
+
+  type request_params = Hash[Symbol, untyped]
 
   type ip_family = Integer #Socket::AF_INET6 | Socket::AF_INET
 

data/sig/io/tcp.rbs

@@ -15,7 +15,7 @@ module HTTPX
     alias host ip
 
     # TODO: lift when https://github.com/ruby/rbs/issues/1497 fixed
-    def initialize: (URI::Generic origin, Array[ipaddr]? addresses, options options) ?{ (instance) -> void } -> void
+    def initialize: (URI::Generic origin, Array[ipaddr]? addresses, Options options) ?{ (instance) -> void } -> void
 
     def add_addresses: (Array[ipaddr] addrs) -> void
 

data/sig/io/unix.rbs

@@ -15,7 +15,7 @@ module HTTPX
 
     @io: Socket
 
-    def initialize: (http_uri origin, String? path, options options) -> void
+    def initialize: (http_uri origin, String? path, Options options) -> void
 
     def connect: () -> void
 

data/sig/loggable.rbs

@@ -4,10 +4,12 @@ module HTTPX
   end
 
   module Loggable
+    USE_DEBUG_LOGS: bool
+
     COLORS: Hash[Symbol, Integer]
 
-    def log: (?level: Integer?, ?color: Symbol?) { () -> String } -> void
+    def log: (?level: Integer?, ?color: Symbol?, ?debug_level: Integer, ?debug: _IOLogger?) { () -> String } -> void
 
-    def log_exception: (Exception error, ?level: Integer, ?color: Symbol) -> void
+    def log_exception: (Exception error, ?level: Integer, ?color: Symbol, ?debug_level: Integer, ?debug: _IOLogger?) -> void
   end
 end

data/sig/options.rbs

@@ -63,19 +63,7 @@ module HTTPX
     # decompress_response_body
     attr_reader decompress_response_body: bool
 
-    # params
-    attr_reader params: Transcoder::urlencoded_input?
-
-    # form
-    attr_reader form: Transcoder::urlencoded_input?
-
-    # json
-    attr_reader json: _ToJson?
-
-    # body
-    attr_reader body: bodyIO?
-
-    # body
+    # origin
     attr_reader origin: URI::Generic?
 
     # base_path
@@ -89,6 +77,8 @@ module HTTPX
     # classes
     attr_reader connection_class: singleton(Connection)
 
+    attr_reader pool_class: singleton(Pool)
+
     attr_reader request_class: singleton(Request)
 
     attr_reader response_class: singleton(Response)
@@ -122,6 +112,9 @@ module HTTPX
     # resolver_options
     attr_reader resolver_options: Hash[Symbol, untyped]
 
+    # resolver_options
+    attr_reader pool_options: pool_options
+
     # ip_families
     attr_reader ip_families: Array[ip_family]
 
@@ -142,6 +135,8 @@ module HTTPX
     def initialize: (?options options) -> void
 
     def do_initialize: (?options options) -> void
+
+    def access_option: (Hash[Symbol, untyped] | Object | nil obj, Symbol k, Hash[Symbol, Symbol]? ivar_map) -> untyped
   end
 
   type options = Options | Hash[Symbol, untyped]

data/sig/plugins/aws_sigv4.rbs

@@ -17,8 +17,14 @@ module HTTPX
 
 
       class Signer
-
+        @credentials: Object & _SigV4Credentials
+        @service: String
+        @region: String
         @unsigned_headers: Set[String]
+        @apply_checksum_header: bool
+        @provider_prefix: String
+        @header_provider_field: String
+        @algorithm: String
 
         def sign!: (Request & RequestMethods request) -> void
 
@@ -41,7 +47,7 @@ module HTTPX
         ) -> untyped
 
 
-        def hexdigest: (bodyIO value) -> String
+        def hexdigest: (Request::Body value) -> String
 
         def hmac: (String key, String value) -> String