httpx 1.6.2 → 1.7.0

data/lib/httpx/transcoder.rb

@@ -4,20 +4,18 @@ module HTTPX
   module Transcoder
     module_function
 
-    def normalize_keys(key, value, cond = nil, &block)
-      if cond && cond.call(value)
-        block.call(key.to_s, value)
-      elsif value.respond_to?(:to_ary)
+    def normalize_keys(key, value, transcoder = self, &block)
+      if value.respond_to?(:to_ary)
         if value.empty?
           block.call("#{key}[]")
         else
           value.to_ary.each do |element|
-            normalize_keys("#{key}[]", element, cond, &block)
+            transcoder.normalize_keys("#{key}[]", element, transcoder, &block)
           end
         end
       elsif value.respond_to?(:to_hash)
         value.to_hash.each do |child_key, child_value|
-          normalize_keys("#{key}[#{child_key}]", child_value, cond, &block)
+          transcoder.normalize_keys("#{key}[#{child_key}]", child_value, transcoder, &block)
         end
       else
         block.call(key.to_s, value)

data/lib/httpx/version.rb

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

data/sig/altsvc.rbs

@@ -1,6 +1,7 @@
 module HTTPX
   module AltSvc
     module ConnectionMixin
+      H2_ALTSVC_SCHEMES: Array[String]
 
       def send: (Request request) -> void
 
@@ -11,6 +12,8 @@ module HTTPX
       def match_altsvcs?: (URI::Generic uri) -> bool
 
       def match_altsvc_options?: (URI::Generic uri, Options options) -> bool
+
+      def altsvc_match?: (uri uri, uri other_uri) -> bool
     end
 
     type altsvc_params = Hash[String, untyped]

data/sig/chainable.rbs

@@ -1,7 +1,7 @@
 module HTTPX
   module Chainable
-    def request: (*Request, **untyped) -> Array[response]
-               | (Request, **untyped) -> response
+    def request: (Request, **untyped) -> response
+               | (*Request, **untyped) -> Array[response]
                | (verb, uri | [uri], **untyped) -> response
                | (Array[[verb, uri] | [verb, uri, request_params]], **untyped) -> Array[response]
                | (verb, _Each[uri | [uri, request_params]], **untyped) -> Array[response]
@@ -12,7 +12,7 @@ module HTTPX
     def with: (options) -> Session
             | (options) { (Session) -> void } -> void
 
-    def plugin: (:auth, ?options) -> Plugins::sessionAuthorization
+    def plugin: (:auth, ?options) -> Plugins::sessionAuth
               | (:basic_auth, ?options) -> Plugins::sessionBasicAuth
               | (:digest_auth, ?options) -> Plugins::sessionDigestAuth
               | (:ntlm_auth, ?options) -> Plugins::sessionNTLMAuth

data/sig/connection.rbs

@@ -46,6 +46,7 @@ module HTTPX
     @exhausted: bool
     @cloned: bool
     @coalesced_connection: instance?
+    @altsvc_connection: instance?
     @sibling: instance?
     @main_sibling: bool
 
@@ -60,15 +61,15 @@ module HTTPX
 
     def addresses?: () -> boolish
 
-    def match?: (URI::Generic uri, Options options) -> bool
+    def match?: (http_uri uri, Options options) -> bool
 
     def mergeable?: (Connection connection) -> bool
 
     def coalesce!: (instance connection) -> void
 
-    def coalescable?: (Connection connection) -> bool
+    def coalesced?: () -> boolish
 
-    def create_idle: (?Hash[Symbol, untyped] options) -> instance
+    def coalescable?: (Connection connection) -> bool
 
     def merge: (Connection connection) -> void
 
@@ -76,7 +77,9 @@ module HTTPX
 
     def connecting?: () -> bool
 
-    def io_connected?: () -> bool
+    def current_context?: () -> bool
+
+    def io_connected?: () -> boolish
 
     def inflight?: () -> boolish
 
@@ -90,6 +93,8 @@ module HTTPX
 
     def close: () -> void
 
+    def force_close: (?bool delete_pending) -> void
+
     def force_reset: (?bool cloned) -> void
 
     def reset: () -> void
@@ -112,6 +117,8 @@ module HTTPX
 
     def disconnect: () -> void
 
+    def on_error: (HTTPX::TimeoutError | Error | StandardError error, ?Request? request) -> void
+
     private
 
     def initialize: (http_uri uri, Options options) -> void
@@ -130,6 +137,8 @@ module HTTPX
 
     def send_request_to_parser: (Request request) -> void
 
+    def enqueue_pending_requests_from_parser: (HTTP1 | HTTP2 parser) -> void
+
     def build_parser: (?String protocol) -> (Object & _Parser)
 
     def set_parser_callbacks: (HTTP1 | HTTP2 parser) -> void
@@ -142,8 +151,6 @@ module HTTPX
 
     def build_socket: (?Array[Resolver::Entry]? addrs) -> (TCP | SSL | UNIX)
 
-    def on_error: (HTTPX::TimeoutError | Error | StandardError error, ?Request? request) -> void
-
     def handle_error: (StandardError error, ?Request? request) -> void
 
     def close_sibling: () -> void

data/sig/loggable.rbs

@@ -12,6 +12,10 @@ module HTTPX
 
     def log_exception: (Exception error, ?level: Integer, ?color: Symbol, ?debug_level: Integer, ?debug: _IOLogger?) -> void
 
-    def log_redact: (_ToS text, ?bool should_redact) -> String
+    def log_redact_headers: (_ToS text) -> String
+
+    def log_redact_body: (_ToS text) -> String
+
+    def log_redact: (_ToS text, bool should_redact) -> String
   end
 end

data/sig/options.rbs

@@ -17,9 +17,11 @@ module HTTPX
 
     DEFAULT_OPTIONS: Hash[Symbol, untyped]
     REQUEST_BODY_IVARS: Array[Symbol]
+    USER_AGENT: String
 
     type timeout_type = :connect_timeout | :settings_timeout | :close_handshake_timeout | :operation_timeout | :keep_alive_timeout | :read_timeout | :write_timeout | :request_timeout
     type timeout = Hash[timeout_type, Numeric?]
+    type redact_value = :headers | :body | bool
 
     def self.new: (?options) -> instance
 
@@ -136,7 +138,7 @@ module HTTPX
 
     def options_equals?: (Options other, ?Array[Symbol] ignore_ivars) -> bool
 
-    def merge: (_ToHash[Symbol, untyped] other) -> instance
+    def merge: (Object & _ToHash[Symbol, untyped] other) -> (instance | self)
 
     def to_hash: () -> Hash[Symbol, untyped]
 
@@ -146,6 +148,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
 
     # integer
@@ -175,7 +179,7 @@ module HTTPX
     def option_io: (io_option value) -> io_option
     def option_fallback_protocol: (String value) -> String
     def option_debug: (_IOLogger value) -> _IOLogger
-    def option_debug_redact: (bool value) -> bool
+    def option_debug_redact: (redact_value value) -> redact_value
     def option_compress_request_body: (bool value) -> bool
     def option_decompress_response_body: (bool value) -> bool
     def option_persistent: (bool value) -> bool

data/sig/plugins/auth/digest.rbs

@@ -2,9 +2,13 @@ module HTTPX
   module Plugins
     module Authentication
       class Digest
+        Error: singleton(HTTPX::Error)
+
+
         @user: String
         @password: String
         @hashed: bool
+        @nonce: Integer
 
         def can_authenticate?: (String? authenticate) -> boolish
 
@@ -19,6 +23,8 @@ module HTTPX
         def make_cnonce: () -> String
 
         def next_nonce: () -> Integer
+
+        def raise_format_error: () -> void
       end
     end
   end

data/sig/plugins/auth.rbs

@@ -1,13 +1,37 @@
 module HTTPX
   module Plugins
-    module Authorization
+    module Auth
+      interface _AuthOptions
+        def auth_header_value: () -> (String | ^(Request request) -> string)?
+
+        def auth_header_type: () -> String?
+      end
+
       module InstanceMethods
-        def authorization: (string token) -> instance
+        @auth_header_value: String
+        @skip_auth_header_value: bool
+
+        def authorization: (?string token, ?auth_header_type: string) ?{ (Request) -> string } -> instance
+
+        def bearer_auth: (?string token) ?{ (Request) -> string } -> instance
+
+        def skip_auth_header: [T] { () -> T } -> T
+
+        def reset_auth_header_value!: () -> void
+
+        private
+
+        def generate_auth_token: () -> String?
+      end
+
+      module RequestMethods
+        def authorize: (String auth_value) -> void
+      end
 
-        def bearer_auth: (string token) -> instance
+      module AuthRetries
       end
     end
 
-    type sessionAuthorization = Session & Authorization::InstanceMethods
+    type sessionAuth = Session & Auth::InstanceMethods
   end
 end

data/sig/plugins/basic_auth.rbs

@@ -1,15 +1,15 @@
 module HTTPX
   module Plugins
     module BasicAuth
-      def self.load_dependencies: (singleton(Session)) -> void
+      def self.load_dependencies: (singleton(Session) klass) -> void
 
-      def self.configure: (singleton(Session)) -> void
+      def self.configure: (singleton(Session) klass) -> void
 
       module InstanceMethods
         def basic_auth: (string user, string password) -> instance
       end
     end
 
-    type sessionBasicAuth = sessionAuthorization & BasicAuth::InstanceMethods
+    type sessionBasicAuth = sessionAuth & BasicAuth::InstanceMethods
   end
 end

data/sig/plugins/callbacks.rbs

@@ -31,6 +31,9 @@ module HTTPX
 
         def emit_or_callback_error: (*untyped) -> void
       end
+
+      module ConnectionMethods
+      end
     end
 
     type sessionCallbacks = Session & Callbacks::InstanceMethods

data/sig/plugins/digest_auth.rbs

@@ -1,21 +1,19 @@
 module HTTPX
   module Plugins
     module DigestAuth
-      DigestError: singleton(Error)
-
       interface _DigestOptions
         def digest: () -> Authentication::Digest?
       end
 
       def self.extra_options: (Options) -> (Options & _DigestOptions)
 
-      def self.load_dependencies: (*untyped) -> void
+      def self.load_dependencies: (singleton(Session) klass) -> void
 
       module InstanceMethods
         def digest_auth: (string user, string password, ?hashed: bool) -> instance
       end
     end
 
-    type sessionDigestAuth = sessionAuthorization & DigestAuth::InstanceMethods
+    type sessionDigestAuth = sessionAuth & DigestAuth::InstanceMethods
   end
 end

data/sig/plugins/fiber_concurrency.rbs

@@ -43,6 +43,12 @@ module HTTPX
         end
       end
 
+       module FiberConcurrencyStream
+        module StreamResponseMethods
+          def close: () -> void
+        end
+      end
+
       type request = Request & RequestMethods
     end
 

data/sig/plugins/ntlm_auth.rbs

@@ -8,7 +8,7 @@ module HTTPX
 
       def self.extra_options: (Options) -> (Options & _NTLMOptions)
 
-      def self.load_dependencies: (*untyped) -> void
+      def self.load_dependencies: (singleton(Session) klass) -> void
 
       module InstanceMethods
         def ntlm_auth: (string user, string password, ?string? domain) -> instance
@@ -16,6 +16,6 @@ module HTTPX
 
     end
 
-    type sessionNTLMAuth = sessionAuthorization & NTLMAuth::InstanceMethods
+    type sessionNTLMAuth = sessionAuth & NTLMAuth::InstanceMethods
   end
 end

data/sig/plugins/oauth.rbs

@@ -15,19 +15,18 @@ module HTTPX
       SUPPORTED_AUTH_METHODS: ::Array[token_auth_method]
 
       class OAuthSession
-        attr_reader grant_type: grant_type
-
-        attr_reader client_id: String
-
-        attr_reader client_secret: String
-
         attr_reader access_token: String?
 
         attr_reader refresh_token: String?
 
-        attr_reader scope: Array[String]?
-
-        attr_reader audience: String?
+        @issuer: http_uri
+        @grant_type: grant_type
+        @client_id: String
+        @client_secret: String
+        @token_endpoint: http_uri?
+        @scope: Array[String]?
+        @audience: String?
+        @token_endpoint_auth_method: String?
 
         def initialize: (
           issuer: uri,
@@ -37,32 +36,64 @@ module HTTPX
           ?refresh_token: String?,
           ?scope: (Array[String] | String)?,
           ?token_endpoint: String?,
-          ?response_type: String?,
           ?grant_type: String?,
           ?token_endpoint_auth_method: ::String,
           ?audience: ::String
         ) -> void
 
-        def token_endpoint: () -> String
+        def token_endpoint: () -> uri
+
+        def token_endpoint_auth_method: () -> String
 
-        def token_endpoint_auth_method: () -> token_auth_method
+        def reset!: () -> void
 
-        def load: (Session http) -> void
+        def fetch_access_token: (sessionOAuth http) -> String
 
         def merge: (instance | Hash[untyped, untyped] other) -> instance
+
+        private
+
+
+        def load: (sessionOAuth http) -> void
       end
 
-      interface _AwsSdkOptions
+      interface _OAuthOptions
         def oauth_session: () -> OAuthSession?
+
+        def oauth_options: () -> {
+          issuer: uri,
+          client_id: String,
+          client_secret: String,
+          ?access_token: String?,
+          ?refresh_token: String?,
+          ?scope: (Array[String] | String)?,
+          ?token_endpoint: String?,
+          ?response_type: String?,
+          ?grant_type: String?,
+          ?token_endpoint_auth_method: ::String,
+          ?audience: ::String
+        }?
       end
 
       module InstanceMethods
+        attr_reader oauth_session: OAuthSession
+        @options: Options & _OAuthOptions
+
         def oauth_auth: (**untyped args) -> instance
 
         def with_access_token: () -> instance
+
+        def refresh_oauth_tokens!: () -> void
+      end
+
+      module OAuthRetries
+        def self?.response_oauth_error?: (response res) -> bool
+
+        module InstanceMethods
+        end
       end
     end
 
-    type sessionOAuth = Session & OAuth::InstanceMethods
+    type sessionOAuth = Session & Auth::InstanceMethods & OAuth::InstanceMethods
   end
 end

data/sig/plugins/rate_limiter.rbs

@@ -5,7 +5,7 @@ module HTTPX
 
       def self.load_dependencies: (singleton(Session)) -> void
 
-      def self.retry_on_rate_limited_response: (_Response) -> bool
+      def self.retry_on_rate_limited_response?: (_Response) -> bool
 
       def self.retry_after_rate_limit: (untyped, response) -> Numeric?
     end

data/sig/plugins/response_cache/file_store.rbs

@@ -2,6 +2,8 @@ module HTTPX
   module Plugins
     module ResponseCache
       class FileStore
+        CRLF: String
+
         @dir: Pathname
 
         include _ResponseCacheStore

data/sig/plugins/response_cache.rbs

@@ -39,6 +39,7 @@ module HTTPX
 
       module RequestMethods
         attr_accessor cached_response: cacheResponse?
+        attr_reader options: cacheOptions
 
         @response_cache_key: String
 
@@ -51,6 +52,9 @@ module HTTPX
         attr_writer original_request: cacheRequest
 
         @cache: bool
+        @cache_control: Array[String]?
+        @vary: Array[String]?
+        @date: Time?
 
         def original_request: () -> cacheRequest?
 

data/sig/plugins/retries.rbs

@@ -6,13 +6,18 @@ module HTTPX
       RECONNECTABLE_ERRORS: Array[singleton(StandardError)]
       RETRYABLE_ERRORS: Array[singleton(StandardError)]
       DEFAULT_JITTER: ^(Numeric) -> Numeric
+      BACKOFF_ALGORITHMS: Array[Symbol]
+
+      def self?.retry_after_polynomial_backoff: (retriesRequest request, response response) -> Numeric
+
+      def self?.retry_after_exponential_backoff: (retriesRequest request, response response) -> Numeric
 
       interface _RetryCallback
         def call: (response response) -> bool?
       end
 
       interface _RetriesOptions
-        def retry_after: () -> Numeric?
+        def retry_after: () -> (^(retriesRequest request, response response) -> Numeric | Numeric)?
 
         def retry_jitter: () -> ^(Numeric jitter) -> Numeric
 
@@ -38,10 +43,11 @@ module HTTPX
 
         def try_partial_retry: (retriesRequest request, (retriesResponse | ErrorResponse) response) -> void
 
+        def prepare_to_retry: (Request & RequestMethods request, response response) -> void
       end
 
       module RequestMethods
-        @options: Options & _RetriesOptions
+        attr_reader options: retriesOptions
 
         attr_accessor retries: Integer
 

data/sig/plugins/stream.rbs

@@ -1,11 +1,21 @@
 module HTTPX
   module Plugins
     module Stream
+      STREAM_REQUEST_OPTIONS: Hash[Symbol, untyped]
+
+      interface _StreamOptions
+        def stream: () -> boolish
+
+        def retry_stream_response_class: () -> singleton(StreamResponse)
+      end
+
       module InstanceMethods
+        @options: Options & _StreamOptions
+
         private
 
-        def request: (*Request, ?stream: bool, **untyped?) -> (response | Array[response] | StreamResponse)
-                   | (*untyped, ?stream: bool, **untyped?) -> (response | Array[response] | StreamResponse)
+        def request: (*Request, **untyped?) -> (response | Array[response] | StreamResponse)
+                   | (*untyped, **untyped?) -> (response | Array[response] | StreamResponse)
       end
 
       module RequestMethods
@@ -30,7 +40,7 @@ module HTTPX
     type streamRequest = Request & Plugins::Stream::RequestMethods
 
     attr_reader request: streamRequest
-    @options: Options
+    @options: Options & _StreamOptions
 
     @session: Plugins::sessionStream
     @response_enum: Enumerator[String]?

data/sig/plugins/stream_bidi.rbs

@@ -5,7 +5,7 @@ module HTTPX
 
       def self.extra_options: (Options) -> (Options)
 
-      class HTTP2Bidi < Connection::HTTP2
+      module HTTP2Methods
         @lock: Thread::Mutex
 
         private
@@ -16,7 +16,7 @@ module HTTPX
       end
 
       class BidiBuffer < Buffer
-        @parent_thread: Thread
+        @buffer_mutex: Thread::Mutex
         @oob_mutex: Thread::Mutex
         @oob_buffer: String
 
@@ -24,6 +24,8 @@ module HTTPX
       end
 
       class Signal
+        attr_reader error: Exception?
+
         @closed: bool
         @pipe_read: IO
         @pipe_write: IO
@@ -32,7 +34,7 @@ module HTTPX
 
         def wakeup: () -> void
 
-        def mergeable?: () -> bool
+        def inflight?: () -> bool
 
         def terminate: () -> void
       end
@@ -55,10 +57,6 @@ module HTTPX
 
       module ConnectionMethods
         @write_buffer: BidiBuffer
-
-        private
-
-        def parser_type: (String protocol) -> (singleton(Connection::HTTP1) | singleton(Connection::HTTP2) | singleton(HTTP2Bidi))
       end
 
     end

data/sig/pool.rbs

@@ -15,7 +15,7 @@ module HTTPX
     @options: Options
     @resolvers: Hash[Class, Array[resolver_manager]]
     @resolver_mtx: Thread::Mutex
-    @connections: Hash[String, Array[Connection]]
+    @connections: Array[Connection]
     @connection_mtx: Thread::Mutex
     @connections_counter: Integer
     @max_connections_cond: ConditionVariable

data/sig/resolver/https.rbs

@@ -11,11 +11,14 @@ module HTTPX
       attr_reader family: ip_family
 
       @options: Options
+      @_timeouts: Array[Numeric]
+      @timeouts: Hash[String, Array[Numeric]]
       @queries: Hash[String, Connection]
       @requests: Hash[Request, String]
       @connections: Array[Connection]
       @uri: http_uri
       @uri_addresses: Array[String]?
+      @name: String?
       @resolver: Resolv::DNS
       @resolver_connection: Connection
 
@@ -29,6 +32,8 @@ module HTTPX
 
       def resolver_connection: () -> Connection
 
+      def send_request: (String hostname, Connection connection) -> void
+
       def on_response: (Request, response) -> void
 
       def parse: (Request request, Response response) -> void
@@ -40,6 +45,8 @@ module HTTPX
       def decode_response_body: (Response) -> dns_decoding_response
 
       def reset_hostname: (String hostname, ?reset_candidates: bool) -> Connection?
+
+      def close_or_resolve: (?bool should_deactivate) -> void
     end
   end
 end

data/sig/resolver/multi.rbs

@@ -8,7 +8,8 @@ module HTTPX
       @current_selector: Selector?
       @current_session: Session?
       @resolver_options: Hash[Symbol, untyped]
-      # @errors: Hash[Symbol, untyped]
+
+      def state: () -> String
 
       def current_selector=: (Selector s) -> void
 
@@ -16,14 +17,6 @@ module HTTPX
 
       def closed?: () -> bool
 
-      def empty?: () -> bool
-
-      def timeout: () -> Numeric?
-
-      def close: () -> void
-
-      def connections: () -> Array[Connection]
-
       def early_resolve: (Connection connection) -> bool
 
       def lazy_resolve: (Connection connection) -> void

data/sig/resolver/native.rbs

@@ -64,7 +64,7 @@ module HTTPX
 
       def transition: (Symbol nextstate) -> void
 
-      def handle_error: (NativeResolveError | StandardError) -> void
+      def reset_query: () -> void
 
       def reset_hostname: (String hostname, ?connection: Connection, ?reset_candidates: bool) -> void