wreq 1.2.4 → 1.2.6

data/lib/wreq_ruby/body.rb

@@ -2,10 +2,10 @@
 
 unless defined?(Wreq)
   module Wreq
-    # BodySender: for streaming request bodies, allowing thread-safe chunked data push.
-    # Backed by a Rust channel, avoids buffering the entire payload in memory.
+    # Streams a request body through a bounded, thread-safe channel.
     #
-    # Supports multi-threaded chunk push: you can safely call `push` from multiple threads.
+    # The channel applies backpressure instead of buffering the entire request body.
+    # Multiple threads may safely push chunks while a request drains the receiving side.
     #
     # Usage:
     #   sender = Wreq::BodySender.new(8)
@@ -15,22 +15,43 @@ unless defined?(Wreq)
     #   end
     #   resp = client.post(url, body: sender)
     #
-    # Note:
-    #   - Sender is for request upload only, not for response reading.
-    #   - Each BodySender instance can only be used once (single-use):
-    #     after being consumed by a request, further push or reuse is not allowed.
+    # A sender can be attached to one request. Closing it prevents further writes but
+    # retains queued chunks so a request attached afterward can still drain them.
     class BodySender
-      # @param capacity [Integer] channel buffer size, default 8
+      # Create a bounded request-body sender.
+      #
+      # @param capacity [Integer] positive number of chunks that may wait in the channel;
+      #   defaults to 8 and must be greater than zero
+      # @return [Wreq::BodySender] A streaming request body sender
+      # @raise [ArgumentError] if capacity is zero, negative, or too large
+      # @raise [TypeError] if capacity is not an Integer
       def self.new(capacity = 8)
       end
 
+      # Push one binary chunk, waiting while the channel is full.
+      #
       # @param data [String] binary chunk
+      # @return [nil]
+      # @raise [IOError] if the sender or receiving side is closed
       def push(data)
       end
 
-      # Close the sender, signaling end of data.
+      # Close the producer and signal EOF after all queued chunks are read.
+      #
+      # This operation is idempotent.
+      #
+      # @return [nil]
       def close
       end
+
+      # Return whether the sender can no longer accept chunks.
+      #
+      # This becomes true after {#close} or when the request stops consuming
+      # the receiving side.
+      #
+      # @return [Boolean]
+      def closed?
+      end
     end
   end
 end

data/lib/wreq_ruby/client.rb

@@ -11,6 +11,12 @@ unless defined?(Wreq)
     # The client is thread-safe and maintains an internal connection pool for
     # efficient request reuse.
     #
+    # Client and request options are limited to the keys listed below. Unknown,
+    # ambiguous, ineffective, and unavailable platform options raise
+    # ArgumentError. Known values retain the error class from their Ruby or
+    # native conversion, such as TypeError or Wreq::BuilderError. Request
+    # validation finishes before network I/O.
+    #
     # @example Basic usage
     #   client = Wreq::Client.new
     #   # Use client for HTTP requests
@@ -50,8 +56,7 @@ unless defined?(Wreq)
       #   will be returned directly to the caller.
       #
       # @param max_redirects [Integer, nil] Maximum number of redirects to
-      #   follow before returning an error. Only applies when allow_redirects
-      #   is true. Default is typically 10 if not specified.
+      #   follow before returning an error. Requires `allow_redirects: true`.
       #
       # @param cookie_store [Boolean, nil] Enable an in-memory cookie jar
       #   that automatically handles Set-Cookie headers and sends appropriate
@@ -85,7 +90,7 @@ unless defined?(Wreq)
       #
       # @param tcp_user_timeout [Integer, nil] Maximum time in seconds that
       #   transmitted data may remain unacknowledged before the connection is
-      #   forcibly closed. Linux-specific option (Android, Fuchsia, Linux only).
+      #   forcibly closed. Available on Android, Fuchsia, and Linux only.
       #
       # @param tcp_nodelay [Boolean, nil] Enable TCP_NODELAY socket option,
       #   which disables Nagle's algorithm. When true, small packets are sent
@@ -133,7 +138,9 @@ unless defined?(Wreq)
       #   Supports HTTP, HTTPS, and SOCKS5 proxies. Format: "protocol://host:port"
       #   Example: "http://proxy.example.com:8080"
       # @param local_address [String, nil] Bind the client's local source IP address (IPv4/IPv6). Useful on multi-homed hosts to originate connections from a specific address or enforce source routing. Examples: "192.168.1.10", "10.0.0.5", "2001:db8::1". The address must exist on the host and be routable.
-      # @param interface [String, nil] Bind the socket to a specific network interface via `SO_BINDTODEVICE` (e.g., "eth0", "wlan0", "tun0"). Effective only on systems that support the option (Linux/Android/Fuchsia) and typically requires privileges (root or CAP_NET_ADMIN).
+      # @param interface [String, nil] Bind sockets to a network interface on
+      #   platforms supported by the native client. Unsupported platforms raise
+      #   ArgumentError.
       #
       # @param gzip [Boolean, nil] Accept and automatically decompress gzip
       #   content encoding. When true, adds "Accept-Encoding: gzip" header.
@@ -151,10 +158,13 @@ unless defined?(Wreq)
       #
       # @return [Wreq::Client] A configured HTTP client instance ready to make requests.
       #
-      # @raise [ArgumentError] if incompatible options are specified together
-      #   (e.g., http1_only and http2_only both true).
-      # @raise [RuntimeError] if the underlying client cannot be initialized
-      #   due to system resource constraints or invalid configuration.
+      # @raise [ArgumentError] if an option is unknown, conflicting,
+      #   ineffective, or unavailable on the current platform.
+      # @raise [TypeError] if the option argument is not a Hash.
+      # @raise [TypeError, ArgumentError, Wreq::BuilderError] if a known option
+      #   value cannot be converted or validated.
+      # @raise [Wreq::BuilderError, Wreq::TlsError] if the native client cannot
+      #   be initialized.
       #
       # @example Minimal client
       #   client = Wreq::Client.new
@@ -179,8 +189,7 @@ unless defined?(Wreq)
       #   client = Wreq::Client.new(
       #     allow_redirects: true,
       #     max_redirects: 5,
-      #     referer: true,
-      #     history: true
+      #     referer: true
       #   )
       #
       # @example Client with compression
@@ -236,18 +245,22 @@ unless defined?(Wreq)
 
       # Send an HTTP request.
       #
+      # Only the options listed here are accepted. Body options (`body`, `form`,
+      # `json`) and authentication options (`auth`, `bearer_auth`, `basic_auth`)
+      # are mutually exclusive. `max_redirects` requires `allow_redirects: true`.
+      #
       # @param method [Wreq::Method] HTTP method to use
       # @param url [String] Target URL
       # @param headers [Wreq::Headers, Hash{String=>String}, nil] Custom headers for this request
       # @param orig_headers [Array<String>, nil] Original header names used to preserve raw header order and HTTP/1 case-sensitive header handling
-      # @param default_headers [Hash{String=>String}, nil] Default headers to merge
+      # @param default_headers [Boolean, nil] Whether to apply native default headers
       # @param query [Hash, nil] URL query parameters
       # @param auth [String, nil] Authorization header value
       # @param bearer_auth [String, nil] Bearer token for Authorization header
       # @param basic_auth [Array<String>, nil] Username and password for basic auth
       # @param cookies [Hash{String=>String}, String, nil] Cookies to send
       # @param allow_redirects [Boolean, nil] Whether to follow redirects
-      # @param max_redirects [Integer, nil] Maximum number of redirects to follow
+      # @param max_redirects [Integer, nil] Maximum redirects; requires allow_redirects: true
       # @param gzip [Boolean, nil] Enable gzip compression
       # @param brotli [Boolean, nil] Enable Brotli compression
       # @param deflate [Boolean, nil] Enable deflate compression
@@ -256,13 +269,17 @@ unless defined?(Wreq)
       # @param read_timeout [Integer, nil] Per-chunk read timeout (seconds)
       # @param proxy [String, nil] Proxy server URI
       # @param local_address [String, nil] Bind the request's local source IP address (IPv4/IPv6). Useful on multi-homed hosts to originate connections from a specific address or enforce source routing. Examples: "192.168.1.10", "10.0.0.5", "2001:db8::1". The address must exist on the host and be routable or the connection may fail.
-      # @param interface [String, nil] Bind the socket to a specific network interface via `SO_BINDTODEVICE` (e.g., "eth0", "wlan0", "tun0"). Effective only on systems that support the option (Linux/Android/Fuchsia) and typically requires privileges (root or CAP_NET_ADMIN).
+      # @param interface [String, nil] Bind to an interface on supported platforms; unsupported platforms raise ArgumentError.
       # @param emulation [Wreq::Emulation, nil] Device/OS emulation for this request
       # @param version [Wreq::Version, nil] HTTP version to use
       # @param form [Hash{String=>String}, nil] Form data (application/x-www-form-urlencoded)
-      # @param json [Object, nil] JSON body (will be serialized)
-      # @param body [String, IO, nil] Raw request body (string or stream)
+      # @param json [Object, nil] JSON body serialized by the native encoder; Integer values retain arbitrary precision
+      # @param body [String, Wreq::BodySender, nil] Raw or streaming request body
       # @return [Wreq::Response] HTTP response
+      # @raise [ArgumentError] if options are unknown, conflicting, ineffective,
+      #   or unavailable on the current platform
+      # @raise [TypeError, ArgumentError, Wreq::BuilderError] if a known option
+      #   value cannot be converted, validated, or built
       def request(method, url, **options)
       end
 
@@ -271,14 +288,14 @@ unless defined?(Wreq)
       # @param url [String] Target URL
       # @param headers [Wreq::Headers, Hash{String=>String}, nil] Custom headers for this request
       # @param orig_headers [Array<String>, nil] Original header names used to preserve raw header order and HTTP/1 case-sensitive header handling
-      # @param default_headers [Hash{String=>String}, nil] Default headers to merge
+      # @param default_headers [Boolean, nil] Whether to apply native default headers
       # @param query [Hash, nil] URL query parameters
       # @param auth [String, nil] Authorization header value
       # @param bearer_auth [String, nil] Bearer token for Authorization header
       # @param basic_auth [Array<String>, nil] Username and password for basic auth
       # @param cookies [Hash{String=>String}, String, nil] Cookies to send
       # @param allow_redirects [Boolean, nil] Whether to follow redirects
-      # @param max_redirects [Integer, nil] Maximum number of redirects to follow
+      # @param max_redirects [Integer, nil] Maximum redirects; requires allow_redirects: true
       # @param gzip [Boolean, nil] Enable gzip compression
       # @param brotli [Boolean, nil] Enable Brotli compression
       # @param deflate [Boolean, nil] Enable deflate compression
@@ -287,13 +304,15 @@ unless defined?(Wreq)
       # @param read_timeout [Integer, nil] Per-chunk read timeout (seconds)
       # @param proxy [String, nil] Proxy server URI
       # @param local_address [String, nil] Bind the request's local source IP address (IPv4/IPv6). Useful on multi-homed hosts to originate connections from a specific address or enforce source routing. Examples: "192.168.1.10", "10.0.0.5", "2001:db8::1". The address must exist on the host and be routable or the connection may fail.
-      # @param interface [String, nil] Bind the socket to a specific network interface via `SO_BINDTODEVICE` (e.g., "eth0", "wlan0", "tun0"). Effective only on systems that support the option (Linux/Android/Fuchsia) and typically requires privileges (root or CAP_NET_ADMIN).
+      # @param interface [String, nil] Bind to an interface on supported platforms; unsupported platforms raise ArgumentError.
       # @param emulation [Wreq::Emulation, nil] Device/OS emulation for this request
       # @param version [Wreq::Version, nil] HTTP version to use
       # @param form [Hash{String=>String}, nil] Form data (application/x-www-form-urlencoded)
-      # @param json [Object, nil] JSON body (will be serialized)
-      # @param body [String, IO, nil] Raw request body (string or stream)
+      # @param json [Object, nil] JSON body serialized by the native encoder; Integer values retain arbitrary precision
+      # @param body [String, Wreq::BodySender, nil] Raw or streaming request body
       # @return [Wreq::Response] HTTP response
+      # @raise [TypeError, ArgumentError, Wreq::BuilderError] if a known option
+      #   value cannot be converted, validated, or built
       def get(url, **options)
       end
 
@@ -302,14 +321,14 @@ unless defined?(Wreq)
       # @param url [String] Target URL
       # @param headers [Wreq::Headers, Hash{String=>String}, nil] Custom headers for this request
       # @param orig_headers [Array<String>, nil] Original header names used to preserve raw header order and HTTP/1 case-sensitive header handling
-      # @param default_headers [Hash{String=>String}, nil] Default headers to merge
+      # @param default_headers [Boolean, nil] Whether to apply native default headers
       # @param query [Hash, nil] URL query parameters
       # @param auth [String, nil] Authorization header value
       # @param bearer_auth [String, nil] Bearer token for Authorization header
       # @param basic_auth [Array<String>, nil] Username and password for basic auth
       # @param cookies [Hash{String=>String}, String, nil] Cookies to send
       # @param allow_redirects [Boolean, nil] Whether to follow redirects
-      # @param max_redirects [Integer, nil] Maximum number of redirects to follow
+      # @param max_redirects [Integer, nil] Maximum redirects; requires allow_redirects: true
       # @param gzip [Boolean, nil] Enable gzip compression
       # @param brotli [Boolean, nil] Enable Brotli compression
       # @param deflate [Boolean, nil] Enable deflate compression
@@ -318,13 +337,15 @@ unless defined?(Wreq)
       # @param read_timeout [Integer, nil] Per-chunk read timeout (seconds)
       # @param proxy [String, nil] Proxy server URI
       # @param local_address [String, nil] Bind the request's local source IP address (IPv4/IPv6). Useful on multi-homed hosts to originate connections from a specific address or enforce source routing. Examples: "192.168.1.10", "10.0.0.5", "2001:db8::1". The address must exist on the host and be routable or the connection may fail.
-      # @param interface [String, nil] Bind the socket to a specific network interface via `SO_BINDTODEVICE` (e.g., "eth0", "wlan0", "tun0"). Effective only on systems that support the option (Linux/Android/Fuchsia) and typically requires privileges (root or CAP_NET_ADMIN).
+      # @param interface [String, nil] Bind to an interface on supported platforms; unsupported platforms raise ArgumentError.
       # @param emulation [Wreq::Emulation, nil] Device/OS emulation for this request
       # @param version [Wreq::Version, nil] HTTP version to use
       # @param form [Hash{String=>String}, nil] Form data (application/x-www-form-urlencoded)
-      # @param json [Object, nil] JSON body (will be serialized)
-      # @param body [String, IO, nil] Raw request body (string or stream)
+      # @param json [Object, nil] JSON body serialized by the native encoder; Integer values retain arbitrary precision
+      # @param body [String, Wreq::BodySender, nil] Raw or streaming request body
       # @return [Wreq::Response] HTTP response
+      # @raise [TypeError, ArgumentError, Wreq::BuilderError] if a known option
+      #   value cannot be converted, validated, or built
       def head(url, **options)
       end
 
@@ -333,14 +354,14 @@ unless defined?(Wreq)
       # @param url [String] Target URL
       # @param headers [Wreq::Headers, Hash{String=>String}, nil] Custom headers for this request
       # @param orig_headers [Array<String>, nil] Original header names used to preserve raw header order and HTTP/1 case-sensitive header handling
-      # @param default_headers [Hash{String=>String}, nil] Default headers to merge
+      # @param default_headers [Boolean, nil] Whether to apply native default headers
       # @param query [Hash, nil] URL query parameters
       # @param auth [String, nil] Authorization header value
       # @param bearer_auth [String, nil] Bearer token for Authorization header
       # @param basic_auth [Array<String>, nil] Username and password for basic auth
       # @param cookies [Hash{String=>String}, String, nil] Cookies to send
       # @param allow_redirects [Boolean, nil] Whether to follow redirects
-      # @param max_redirects [Integer, nil] Maximum number of redirects to follow
+      # @param max_redirects [Integer, nil] Maximum redirects; requires allow_redirects: true
       # @param gzip [Boolean, nil] Enable gzip compression
       # @param brotli [Boolean, nil] Enable Brotli compression
       # @param deflate [Boolean, nil] Enable deflate compression
@@ -349,13 +370,15 @@ unless defined?(Wreq)
       # @param read_timeout [Integer, nil] Per-chunk read timeout (seconds)
       # @param proxy [String, nil] Proxy server URI
       # @param local_address [String, nil] Bind the request's local source IP address (IPv4/IPv6). Useful on multi-homed hosts to originate connections from a specific address or enforce source routing. Examples: "192.168.1.10", "10.0.0.5", "2001:db8::1". The address must exist on the host and be routable or the connection may fail.
-      # @param interface [String, nil] Bind the socket to a specific network interface via `SO_BINDTODEVICE` (e.g., "eth0", "wlan0", "tun0"). Effective only on systems that support the option (Linux/Android/Fuchsia) and typically requires privileges (root or CAP_NET_ADMIN).
+      # @param interface [String, nil] Bind to an interface on supported platforms; unsupported platforms raise ArgumentError.
       # @param emulation [Wreq::Emulation, nil] Device/OS emulation for this request
       # @param version [Wreq::Version, nil] HTTP version to use
       # @param form [Hash{String=>String}, nil] Form data (application/x-www-form-urlencoded)
-      # @param json [Object, nil] JSON body (will be serialized)
-      # @param body [String, IO, nil] Raw request body (string or stream)
+      # @param json [Object, nil] JSON body serialized by the native encoder; Integer values retain arbitrary precision
+      # @param body [String, Wreq::BodySender, nil] Raw or streaming request body
       # @return [Wreq::Response] HTTP response
+      # @raise [TypeError, ArgumentError, Wreq::BuilderError] if a known option
+      #   value cannot be converted, validated, or built
       def post(url, **options)
       end
 
@@ -364,14 +387,14 @@ unless defined?(Wreq)
       # @param url [String] Target URL
       # @param headers [Wreq::Headers, Hash{String=>String}, nil] Custom headers for this request
       # @param orig_headers [Array<String>, nil] Original header names used to preserve raw header order and HTTP/1 case-sensitive header handling
-      # @param default_headers [Hash{String=>String}, nil] Default headers to merge
+      # @param default_headers [Boolean, nil] Whether to apply native default headers
       # @param query [Hash, nil] URL query parameters
       # @param auth [String, nil] Authorization header value
       # @param bearer_auth [String, nil] Bearer token for Authorization header
       # @param basic_auth [Array<String>, nil] Username and password for basic auth
       # @param cookies [Hash{String=>String}, String, nil] Cookies to send
       # @param allow_redirects [Boolean, nil] Whether to follow redirects
-      # @param max_redirects [Integer, nil] Maximum number of redirects to follow
+      # @param max_redirects [Integer, nil] Maximum redirects; requires allow_redirects: true
       # @param gzip [Boolean, nil] Enable gzip compression
       # @param brotli [Boolean, nil] Enable Brotli compression
       # @param deflate [Boolean, nil] Enable deflate compression
@@ -380,13 +403,15 @@ unless defined?(Wreq)
       # @param read_timeout [Integer, nil] Per-chunk read timeout (seconds)
       # @param proxy [String, nil] Proxy server URI
       # @param local_address [String, nil] Bind the request's local source IP address (IPv4/IPv6). Useful on multi-homed hosts to originate connections from a specific address or enforce source routing. Examples: "192.168.1.10", "10.0.0.5", "2001:db8::1". The address must exist on the host and be routable or the connection may fail.
-      # @param interface [String, nil] Bind the socket to a specific network interface via `SO_BINDTODEVICE` (e.g., "eth0", "wlan0", "tun0"). Effective only on systems that support the option (Linux/Android/Fuchsia) and typically requires privileges (root or CAP_NET_ADMIN).
+      # @param interface [String, nil] Bind to an interface on supported platforms; unsupported platforms raise ArgumentError.
       # @param emulation [Wreq::Emulation, nil] Device/OS emulation for this request
       # @param version [Wreq::Version, nil] HTTP version to use
       # @param form [Hash{String=>String}, nil] Form data (application/x-www-form-urlencoded)
-      # @param json [Object, nil] JSON body (will be serialized)
-      # @param body [String, IO, nil] Raw request body (string or stream)
+      # @param json [Object, nil] JSON body serialized by the native encoder; Integer values retain arbitrary precision
+      # @param body [String, Wreq::BodySender, nil] Raw or streaming request body
       # @return [Wreq::Response] HTTP response
+      # @raise [TypeError, ArgumentError, Wreq::BuilderError] if a known option
+      #   value cannot be converted, validated, or built
       def put(url, **options)
       end
 
@@ -395,14 +420,14 @@ unless defined?(Wreq)
       # @param url [String] Target URL
       # @param headers [Wreq::Headers, Hash{String=>String}, nil] Custom headers for this request
       # @param orig_headers [Array<String>, nil] Original header names used to preserve raw header order and HTTP/1 case-sensitive header handling
-      # @param default_headers [Hash{String=>String}, nil] Default headers to merge
+      # @param default_headers [Boolean, nil] Whether to apply native default headers
       # @param query [Hash, nil] URL query parameters
       # @param auth [String, nil] Authorization header value
       # @param bearer_auth [String, nil] Bearer token for Authorization header
       # @param basic_auth [Array<String>, nil] Username and password for basic auth
       # @param cookies [Hash{String=>String}, String, nil] Cookies to send
       # @param allow_redirects [Boolean, nil] Whether to follow redirects
-      # @param max_redirects [Integer, nil] Maximum number of redirects to follow
+      # @param max_redirects [Integer, nil] Maximum redirects; requires allow_redirects: true
       # @param gzip [Boolean, nil] Enable gzip compression
       # @param brotli [Boolean, nil] Enable Brotli compression
       # @param deflate [Boolean, nil] Enable deflate compression
@@ -411,13 +436,15 @@ unless defined?(Wreq)
       # @param read_timeout [Integer, nil] Per-chunk read timeout (seconds)
       # @param proxy [String, nil] Proxy server URI
       # @param local_address [String, nil] Bind the request's local source IP address (IPv4/IPv6). Useful on multi-homed hosts to originate connections from a specific address or enforce source routing. Examples: "192.168.1.10", "10.0.0.5", "2001:db8::1". The address must exist on the host and be routable or the connection may fail.
-      # @param interface [String, nil] Bind the socket to a specific network interface via `SO_BINDTODEVICE` (e.g., "eth0", "wlan0", "tun0"). Effective only on systems that support the option (Linux/Android/Fuchsia) and typically requires privileges (root or CAP_NET_ADMIN).
+      # @param interface [String, nil] Bind to an interface on supported platforms; unsupported platforms raise ArgumentError.
       # @param emulation [Wreq::Emulation, nil] Device/OS emulation for this request
       # @param version [Wreq::Version, nil] HTTP version to use
       # @param form [Hash{String=>String}, nil] Form data (application/x-www-form-urlencoded)
-      # @param json [Object, nil] JSON body (will be serialized)
-      # @param body [String, IO, nil] Raw request body (string or stream)
+      # @param json [Object, nil] JSON body serialized by the native encoder; Integer values retain arbitrary precision
+      # @param body [String, Wreq::BodySender, nil] Raw or streaming request body
       # @return [Wreq::Response] HTTP response
+      # @raise [TypeError, ArgumentError, Wreq::BuilderError] if a known option
+      #   value cannot be converted, validated, or built
       def delete(url, **options)
       end
 
@@ -426,14 +453,14 @@ unless defined?(Wreq)
       # @param url [String] Target URL
       # @param headers [Wreq::Headers, Hash{String=>String}, nil] Custom headers for this request
       # @param orig_headers [Array<String>, nil] Original header names used to preserve raw header order and HTTP/1 case-sensitive header handling
-      # @param default_headers [Hash{String=>String}, nil] Default headers to merge
+      # @param default_headers [Boolean, nil] Whether to apply native default headers
       # @param query [Hash, nil] URL query parameters
       # @param auth [String, nil] Authorization header value
       # @param bearer_auth [String, nil] Bearer token for Authorization header
       # @param basic_auth [Array<String>, nil] Username and password for basic auth
       # @param cookies [Hash{String=>String}, String, nil] Cookies to send
       # @param allow_redirects [Boolean, nil] Whether to follow redirects
-      # @param max_redirects [Integer, nil] Maximum number of redirects to follow
+      # @param max_redirects [Integer, nil] Maximum redirects; requires allow_redirects: true
       # @param gzip [Boolean, nil] Enable gzip compression
       # @param brotli [Boolean, nil] Enable Brotli compression
       # @param deflate [Boolean, nil] Enable deflate compression
@@ -442,13 +469,15 @@ unless defined?(Wreq)
       # @param read_timeout [Integer, nil] Per-chunk read timeout (seconds)
       # @param proxy [String, nil] Proxy server URI
       # @param local_address [String, nil] Bind the request's local source IP address (IPv4/IPv6). Useful on multi-homed hosts to originate connections from a specific address or enforce source routing. Examples: "192.168.1.10", "10.0.0.5", "2001:db8::1". The address must exist on the host and be routable or the connection may fail.
-      # @param interface [String, nil] Bind the socket to a specific network interface via `SO_BINDTODEVICE` (e.g., "eth0", "wlan0", "tun0"). Effective only on systems that support the option (Linux/Android/Fuchsia) and typically requires privileges (root or CAP_NET_ADMIN).
+      # @param interface [String, nil] Bind to an interface on supported platforms; unsupported platforms raise ArgumentError.
       # @param emulation [Wreq::Emulation, nil] Device/OS emulation for this request
       # @param version [Wreq::Version, nil] HTTP version to use
       # @param form [Hash{String=>String}, nil] Form data (application/x-www-form-urlencoded)
-      # @param json [Object, nil] JSON body (will be serialized)
-      # @param body [String, IO, nil] Raw request body (string or stream)
+      # @param json [Object, nil] JSON body serialized by the native encoder; Integer values retain arbitrary precision
+      # @param body [String, Wreq::BodySender, nil] Raw or streaming request body
       # @return [Wreq::Response] HTTP response
+      # @raise [TypeError, ArgumentError, Wreq::BuilderError] if a known option
+      #   value cannot be converted, validated, or built
       def options(url, **options)
       end
 
@@ -457,14 +486,14 @@ unless defined?(Wreq)
       # @param url [String] Target URL
       # @param headers [Wreq::Headers, Hash{String=>String}, nil] Custom headers for this request
       # @param orig_headers [Array<String>, nil] Original header names used to preserve raw header order and HTTP/1 case-sensitive header handling
-      # @param default_headers [Hash{String=>String}, nil] Default headers to merge
+      # @param default_headers [Boolean, nil] Whether to apply native default headers
       # @param query [Hash, nil] URL query parameters
       # @param auth [String, nil] Authorization header value
       # @param bearer_auth [String, nil] Bearer token for Authorization header
       # @param basic_auth [Array<String>, nil] Username and password for basic auth
       # @param cookies [Hash{String=>String}, String, nil] Cookies to send
       # @param allow_redirects [Boolean, nil] Whether to follow redirects
-      # @param max_redirects [Integer, nil] Maximum number of redirects to follow
+      # @param max_redirects [Integer, nil] Maximum redirects; requires allow_redirects: true
       # @param gzip [Boolean, nil] Enable gzip compression
       # @param brotli [Boolean, nil] Enable Brotli compression
       # @param deflate [Boolean, nil] Enable deflate compression
@@ -473,13 +502,15 @@ unless defined?(Wreq)
       # @param read_timeout [Integer, nil] Per-chunk read timeout (seconds)
       # @param proxy [String, nil] Proxy server URI
       # @param local_address [String, nil] Bind the request's local source IP address (IPv4/IPv6). Useful on multi-homed hosts to originate connections from a specific address or enforce source routing. Examples: "192.168.1.10", "10.0.0.5", "2001:db8::1". The address must exist on the host and be routable or the connection may fail.
-      # @param interface [String, nil] Bind the socket to a specific network interface via `SO_BINDTODEVICE` (e.g., "eth0", "wlan0", "tun0"). Effective only on systems that support the option (Linux/Android/Fuchsia) and typically requires privileges (root or CAP_NET_ADMIN).
+      # @param interface [String, nil] Bind to an interface on supported platforms; unsupported platforms raise ArgumentError.
       # @param emulation [Wreq::Emulation, nil] Device/OS emulation for this request
       # @param version [Wreq::Version, nil] HTTP version to use
       # @param form [Hash{String=>String}, nil] Form data (application/x-www-form-urlencoded)
-      # @param json [Object, nil] JSON body (will be serialized)
-      # @param body [String, IO, nil] Raw request body (string or stream)
+      # @param json [Object, nil] JSON body serialized by the native encoder; Integer values retain arbitrary precision
+      # @param body [String, Wreq::BodySender, nil] Raw or streaming request body
       # @return [Wreq::Response] HTTP response
+      # @raise [TypeError, ArgumentError, Wreq::BuilderError] if a known option
+      #   value cannot be converted, validated, or built
       def trace(url, **options)
       end
 
@@ -488,14 +519,14 @@ unless defined?(Wreq)
       # @param url [String] Target URL
       # @param headers [Wreq::Headers, Hash{String=>String}, nil] Custom headers for this request
       # @param orig_headers [Array<String>, nil] Original header names used to preserve raw header order and HTTP/1 case-sensitive header handling
-      # @param default_headers [Hash{String=>String}, nil] Default headers to merge
+      # @param default_headers [Boolean, nil] Whether to apply native default headers
       # @param query [Hash, nil] URL query parameters
       # @param auth [String, nil] Authorization header value
       # @param bearer_auth [String, nil] Bearer token for Authorization header
       # @param basic_auth [Array<String>, nil] Username and password for basic auth
       # @param cookies [Hash{String=>String}, String, nil] Cookies to send
       # @param allow_redirects [Boolean, nil] Whether to follow redirects
-      # @param max_redirects [Integer, nil] Maximum number of redirects to follow
+      # @param max_redirects [Integer, nil] Maximum redirects; requires allow_redirects: true
       # @param gzip [Boolean, nil] Enable gzip compression
       # @param brotli [Boolean, nil] Enable Brotli compression
       # @param deflate [Boolean, nil] Enable deflate compression
@@ -504,13 +535,15 @@ unless defined?(Wreq)
       # @param read_timeout [Integer, nil] Per-chunk read timeout (seconds)
       # @param proxy [String, nil] Proxy server URI
       # @param local_address [String, nil] Bind the request's local source IP address (IPv4/IPv6). Useful on multi-homed hosts to originate connections from a specific address or enforce source routing. Examples: "192.168.1.10", "10.0.0.5", "2001:db8::1". The address must exist on the host and be routable or the connection may fail.
-      # @param interface [String, nil] Bind the socket to a specific network interface via `SO_BINDTODEVICE` (e.g., "eth0", "wlan0", "tun0"). Effective only on systems that support the option (Linux/Android/Fuchsia) and typically requires privileges (root or CAP_NET_ADMIN).
+      # @param interface [String, nil] Bind to an interface on supported platforms; unsupported platforms raise ArgumentError.
       # @param emulation [Wreq::Emulation, nil] Device/OS emulation for this request
       # @param version [Wreq::Version, nil] HTTP version to use
       # @param form [Hash{String=>String}, nil] Form data (application/x-www-form-urlencoded)
-      # @param json [Object, nil] JSON body (will be serialized)
-      # @param body [String, IO, nil] Raw request body (string or stream)
+      # @param json [Object, nil] JSON body serialized by the native encoder; Integer values retain arbitrary precision
+      # @param body [String, Wreq::BodySender, nil] Raw or streaming request body
       # @return [Wreq::Response] HTTP response
+      # @raise [TypeError, ArgumentError, Wreq::BuilderError] if a known option
+      #   value cannot be converted, validated, or built
       def patch(url, **options)
       end
     end