httpx 0.16.1 → 0.18.2

data/sig/chainable.rbs

@@ -1,6 +1,11 @@
 module HTTPX
   module Chainable
-    def request: (*untyped, **untyped) -> (response | Array[response])
+    def request: (*Request, **untyped) -> Array[response]
+               | (Request, **untyped) -> response
+               | (verb | string, uri | [uri], **untyped) -> response
+               | (Array[[verb | string, uri] | [verb | string, uri, options]], **untyped) -> Array[response]
+               | (verb | string, _Each[uri | [uri, options]], **untyped) -> Array[response]
+
     def accept: (String) -> Session
     def wrap: () { (Session) -> void } -> void
 
@@ -27,6 +32,7 @@ module HTTPX
               | (:stream, ?options) -> Plugins::sessionStream
               | (:aws_sigv4, ?options) -> Plugins::awsSigV4Session
               | (:grpc, ?options) -> Plugins::grpcSession
+              | (:response_cache, ?options) -> Plugins::sessionResponseCache
               | (Symbol | Module, ?options) { (Class) -> void } -> Session
               | (Symbol | Module, ?options) -> Session
 

data/sig/connection/http1.rbs

@@ -3,6 +3,10 @@ module HTTPX
     include Callbacks
     include Loggable
 
+    UPCASED: Hash[String, String]
+    MAX_REQUESTS: Integer
+    CRLF: String
+
     attr_reader pending: Array[Request]
     attr_reader requests: Array[Request]
 
@@ -11,6 +15,11 @@ module HTTPX
     @max_requests: Integer
     @parser: Parser::HTTP1
     @buffer: Buffer
+    @version: [Integer, Integer]
+    @handshake_completed: bool
+    @pipelining: bool
+
+    @request: Request?
 
     def interests: () -> io_interests?
 
@@ -30,11 +39,13 @@ module HTTPX
 
     def handle_error: (StandardError ex) -> void
 
+    def on_start: () -> void
+
     def on_headers: (Hash[String, Array[String]] headers) -> void
 
     def on_trailers: (Hash[String, Array[String]] headers) -> void
 
-    def on_data: (string chunk) -> void
+    def on_data: (String chunk) -> void
 
     def on_complete: () -> void
 
@@ -42,7 +53,7 @@ module HTTPX
 
     def ping: () -> void
 
-    def timeout: () -> Integer
+    def timeout: () -> Numeric
 
     private
 
@@ -54,7 +65,7 @@ module HTTPX
 
     def disable_pipelining: () -> void
 
-    def set_protocol_headers: (Request) -> _Each[[headers_key, String]]
+    def set_protocol_headers: (Request) -> _Each[[String, String]]
 
     def headline_uri: (Request) -> String
 
@@ -64,7 +75,7 @@ module HTTPX
 
     def join_trailers: (Request request) -> void
 
-    def join_headers2: (_Each[[headers_key, String]] headers) -> void
+    def join_headers2: (_Each[[String, String]] headers) -> void
 
     def join_body: (Request request) -> void
 

data/sig/connection/http2.rbs

@@ -3,10 +3,13 @@ module HTTPX
     include Callbacks
     include Loggable
 
+    MAX_CONCURRENT_REQUESTS: Integer
+
     attr_reader streams: Hash[Request, HTTP2Next::Stream]
     attr_reader pending: Array[Request]
 
     @options: Options
+    @settings: Hash[Symbol, Integer | bool]
     @max_concurrent_requests: Integer
     @max_requests: Integer
     @drains: Hash[Request, String]
@@ -23,7 +26,7 @@ module HTTPX
 
     def <<: (String) -> void
 
-    def can_buffer_more_requests: () -> bool
+    def can_buffer_more_requests?: () -> bool
 
     def send: (Request) -> void
 
@@ -35,7 +38,7 @@ module HTTPX
 
     alias reset init_connection
 
-    def timeout: () -> Integer
+    def timeout: () -> Numeric
 
     private
 
@@ -45,7 +48,7 @@ module HTTPX
 
     def headline_uri: (Request) -> String
 
-    def set_protocol_headers: (Request) -> _Each[[headers_key, String]]
+    def set_protocol_headers: (Request) -> _Each[[String, String]]
 
     def handle: (Request request, HTTP2Next::Stream stream) -> void
 
@@ -61,9 +64,11 @@ module HTTPX
 
     def on_stream_headers: (HTTP2Next::Stream stream, Request request, Array[[String, String]] headers) -> void
 
-    def on_stream_trailers: (HTTP2Next::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_data: (HTTP2Next::Stream stream, Request request, String data) -> void
 
-    def on_stream_data: (HTTP2Next::Stream stream, Request request, string data) -> void
+    def on_stream_refuse: (HTTP2Next::Stream stream, Request request, StandardError error) -> void
 
     def on_stream_close: (HTTP2Next::Stream stream, Request request, (Symbol | StandardError)? error) -> void
 
@@ -74,12 +79,21 @@ module HTTPX
     def on_close: (Integer last_frame, Symbol? error, String? payload) -> void
 
     def on_frame_sent: (HTTP2Next::frame) -> void
+
     def on_frame_received: (HTTP2Next::frame) -> void
 
+    def on_altsvc: (String origin, HTTP2Next::frame) -> void
+
     def on_promise: (HTTP2Next::Stream) -> void
 
     def on_origin: (String) -> void
 
     def on_pong: (string ping) -> void
+
+    class Error < ::HTTPX::Error
+    end
+
+    class GoawayError < Error
+    end
   end
 end

data/sig/connection.rbs

@@ -1,6 +1,5 @@
 module HTTPX
   class Connection
-
     interface _Parser
 
       def on: (Symbol) { (*untyped) -> void } -> void
@@ -26,6 +25,15 @@ module HTTPX
     attr_reader state: Symbol
     attr_reader pending: Array[Request]
     attr_reader options: Options
+    attr_writer timers: Timers
+
+    @origins: Array[URI::Generic]
+    @window_size: Integer
+    @read_buffer: Buffer
+    @write_buffer: Buffer
+    @inflight: Integer
+    @keep_alive_timeout: Numeric?
+    @total_timeout: Numeric?
 
     def addresses: () -> Array[ipaddr]?
 
@@ -37,8 +45,7 @@ module HTTPX
 
     def coalescable?: (Connection) -> bool
 
-    def create_idle: (options) -> Connection
-                   | () -> Connection
+    def create_idle: (?Hash[Symbol, untyped] options) -> Connection
 
     def merge: (Connection) -> void
 
@@ -47,11 +54,12 @@ module HTTPX
     def match_altsvcs?: (URI::Generic uri) -> bool
 
     def connecting?: () -> bool
+
     def inflight?: () -> boolish
 
     def interests: () -> io_interests?
 
-    def to_io: () -> _ToIO
+    def to_io: () -> IO
 
     def call: () -> void
 
@@ -62,6 +70,7 @@ module HTTPX
 
     def timeout: () -> Numeric?
 
+    def deactivate: () -> void
     private
 
     def initialize: (String, URI::Generic, options) -> untyped
@@ -76,6 +85,8 @@ module HTTPX
 
     def parser: () -> _Parser
 
+    def send_request_to_parser: (Request request) -> void
+
     def build_parser: () -> _Parser
                     | (String) -> _Parser
 
@@ -83,15 +94,10 @@ module HTTPX
 
     def transition: (Symbol) -> void
 
-    def handle_response: () -> void
-
     def on_error: (HTTPX::TimeoutError | Error | StandardError) -> void
 
     def handle_error: (StandardError) -> void
 
-    def total_timeout: () -> untyped?
-    # def total_timeout: () -> Timers::Timer?
-    #
     def purge_after_closed: () -> void
   end
 end

data/sig/headers.rbs

@@ -2,44 +2,45 @@ module HTTPX
   class Headers
     include _ToS
 
-    @headers: headers_hash
+    EMPTY: Array[untyped]
 
-    def self.new: (?untyped headers) -> Headers
+    @headers: Hash[String, Array[String]]
+
+    def self.new: (?untyped headers) -> instance
 
     def ==: (untyped other) -> bool
 
-    def []: (headers_key field) -> _ToS?
-    def []=: (headers_key field, headers_value value) -> void
+    def []: (String field) -> String?
+    def []=: (String field, headers_value value) -> void
 
-    def add: (headers_key field, string value) -> void
-    def delete: (headers_key field) -> Array[String]?
+    def add: (String field, string value) -> void
+    def delete: (String field) -> Array[String]?
 
-    def each: (?_Each[[headers_key, String]]? extra_headers) { (headers_key, String) -> void } -> void
-            | (?_Each[[headers_key, String]]? extra_headers) -> Enumerable[[headers_key, String]]
+    def each: (?_Each[[String, String]]? extra_headers) { (String k, String v) -> void } -> void
+            | (?_Each[[String, String]]? extra_headers) -> Enumerable[[String, String]]
 
-    def get: (headers_key field) -> Array[String]
-    def key?: (headers_key downcased_key) -> bool
+    def get: (String field) -> Array[String]
+    def key?: (String downcased_key) -> bool
 
-    def merge: (_Each[[headers_key, headers_value]] other) -> Headers
+    def merge: (_Each[[String, headers_value]] other) -> Headers
 
     def same_headers?: (untyped headers) -> bool
 
-    def to_a: () -> Array[[headers_key, String]]
-    def to_hash: () -> Hash[headers_key, String]
+    def to_a: () -> Array[[String, String]]
+    def to_hash: () -> Hash[String, String]
     alias to_h to_hash
 
     def inspect: () -> String
 
     private
 
-    def initialize: (headers?) -> untyped
+    def initialize: (?headers?) -> untyped
     def array_value: (headers_value) -> Array[String]
-    def downcased: (headers_key) -> String
+    def downcased: (_ToS field) -> String
   end
 
-  type headers_key = String | Symbol
   type headers_value = _ToS | Array[_ToS]
-  type headers_hash = Hash[headers_key, headers_value]
-  type headers_input = headers_hash | Array[[headers_key, string]]
+  type headers_hash = Hash[_ToS, headers_value]
+  type headers_input = headers_hash | Array[[_ToS, string]]
   type headers = Headers | headers_input
 end

data/sig/options.rbs

@@ -11,7 +11,7 @@ module HTTPX
     DEFAULT_OPTIONS: Hash[Symbol, untyped]
 
     type timeout_type = :connect_timeout | :settings_timeout | :operation_timeout | :keep_alive_timeout | :total_timeout
-    type timeout = Hash[timeout_type, Numeric?]
+    type timeout = Hash[timeout_type, Numeric]
 
     def self.new: (?options) -> instance
 
@@ -26,6 +26,9 @@ module HTTPX
     # timeout
     attr_reader timeout: timeout
 
+    # http2_settings
+    attr_reader http2_settings: Hash[Symbol, Integer | bool]
+
     # max_concurrent_requests
     attr_reader max_concurrent_requests: Integer?
 
@@ -45,7 +48,7 @@ module HTTPX
     attr_reader transport_options: Hash[untyped, untyped]?
 
     # addresses
-    attr_reader addresses: _ToAry[ipaddr]?
+    attr_reader addresses: Array[ipaddr]?
 
     # params
     attr_reader params: Transcoder::urlencoded_input?
@@ -59,6 +62,9 @@ module HTTPX
     # body
     attr_reader body: bodyIO?
 
+    # body
+    attr_reader origin: URI::Generic?
+
     # ssl
 
     # http2_settings
@@ -103,13 +109,15 @@ module HTTPX
     attr_reader resolver_options: Hash[Symbol, untyped]?
 
     def ==: (untyped other) -> bool
-    def merge: (_ToHash[Symbol | String, untyped] other) -> instance
+    def merge: (_ToHash[Symbol, untyped] other) -> instance
     def to_hash: () -> Hash[Symbol, untyped]
 
     private
 
-    def initialize: (?options) -> untyped
+    REQUEST_IVARS: Array[Symbol]
+
+    def initialize: (?options options) -> untyped
   end
 
-  type options = Options | Hash[Symbol | String, untyped]
+  type options = Options | Hash[Symbol, untyped]
 end

data/sig/parser/http1.rbs

@@ -5,9 +5,9 @@ module HTTPX
     interface _HTTP1Events
 
       def on_start: () -> void
-      def on_headers: (parsed_headers) -> void
-      def on_trailers: (parsed_headers) -> void
-      def on_data: (String) -> void
+      def on_headers: (parsed_headers headers) -> void
+      def on_trailers: (parsed_headers trailers) -> void
+      def on_data: (String data) -> void
       def on_complete: () -> void
     end
 

data/sig/plugins/aws_sdk_authentication.rbs

@@ -1,25 +1,43 @@
 module HTTPX
   module Plugins
     module AwsSdkAuthentication
+      class Configuration
+        attr_reader profile: String?
+
+        private
+
+        def initialize: (String? profile) -> void
+      end
+
       class Credentials
+        @aws_credentials: untyped
+
         include _SigV4Credentials
 
         private
-        
+
         def initialize: (untyped aws_credentials) -> untyped
       end
 
+      interface _AwsSdkOptions
+        def aws_profile: () -> String?
+      end
+
       def self.load_dependencies: (singleton(Session)) -> void
 
       def self.configure: (singleton(Session)) -> void
 
-      def self.extra_options: (Options) -> (Options)
+      def self.extra_options: (Options) -> (Options & _AwsSdkOptions)
+
+      def self.credentials: (String? profile) -> Credentials
+
+      def self.region: (String? profile) -> String
 
       module InstanceMethods
-        def aws_sdk_authentication: (**untyped) -> instance
+        def aws_sdk_authentication: (?credentials: Credentials, ?region: String, **untyped) -> instance
       end
     end
 
-    type sessionAwsSdkAuthentication = Session & AwsSdkAuthentication::InstanceMethods
+    type sessionAwsSdkAuthentication = awsSigV4Session & AwsSdkAuthentication::InstanceMethods
   end
 end

data/sig/plugins/aws_sigv4.rbs

@@ -9,13 +9,21 @@ module HTTPX
 
     module AWSSigV4
 
-      Credentials: _SigV4Credentials
+      class Credentials < Struct[[String, String, String?]]
+        attr_reader username: String
+        attr_reader password: String
+        attr_reader security_token: String?
+      end
 
 
       class Signer
 
-        def sign!: (Request) -> void
+        @unsigned_headers: Set[String]
+
+        def sign!: (Request & RequestMethods request) -> void
 
+        def self.new: (instance) -> instance
+                    | (**untyped params) -> instance
         private
 
         def initialize: (
@@ -33,9 +41,10 @@ module HTTPX
         ) -> untyped
 
 
-        def sha256_hexdigest: (bodyIO value) -> String
+        def hexdigest: (bodyIO value) -> String
 
         def hmac: (String key, String value) -> String
+
         def hexhmac: (String key, String value) -> String
       end
 

data/sig/plugins/basic_authentication.rbs

@@ -10,6 +10,6 @@ module HTTPX
       end
     end
 
-    type sessionBasicAuthentication = sessionAuthentication & BasicAuthentication::InstanceMethods
+    type sessionBasicAuthentication = sessionAuthentication & Authentication::InstanceMethods & BasicAuthentication::InstanceMethods
   end
 end

data/sig/plugins/multipart.rbs

@@ -1,41 +1,97 @@
 module HTTPX
   module Plugins
     module Multipart
+      interface _MultipartInput
+        def filename: () -> String
+        def content_type: () -> String
+        def read: (?int? length, ?string? output) -> String?
+      end
+
+      MULTIPART_VALUE_COND: ^(_Reader | record_multipart_value value) -> bool
+
       def self.load_dependencies: (singleton(Session)) -> void
       def self.configure: (*untyped) -> void
       def self?.encode: (untyped) -> (Encoder | Transcoder::Form::Encoder)
+      def self?.decode: (HTTPX::Response response) -> Transcoder::_Decoder
+
+      def self?.normalize_keys: [U] (_ToS key, _ToAry[untyped] | _ToHash[_ToS, untyped] | untyped value) { (String, ?untyped) -> U } -> U
 
       type multipart_value = string | Pathname | File | _Reader
 
-      type record_multipart_value = multipart_value |
-                                    { content_type: String, filename: String, body: multipart_value } |
+      type record_multipart_value = { content_type: String, filename: String, body: multipart_value } |
                                     { content_type: String, body: multipart_value }
 
       type multipart_nested_value = multipart_value | _ToAry[multipart_value] | _ToHash[string, multipart_value]
 
       class Encoder
         include Transcoder::_Encoder
-        include _Reader
+
+        @boundary: String
+        @part_index: Integer
+        @buffer: String
+
+        @form: Enumerable[[Symbol | string, multipart_nested_value]]
+        @parts: Array[_Reader]
 
         def content_type: () -> String
 
+        def read: (?int? length, ?string? buffer) -> String?
+
+        def rewind: () -> void
+
         private
 
-        def initialize: (_Each[[Symbol | string, multipart_nested_value]] multipart_data) -> untyped
+        def to_parts: (Enumerable[[Symbol | string, multipart_nested_value]] multipart_data) -> Array[_Reader]
+
+        def initialize: (Enumerable[[Symbol | string, multipart_nested_value]] multipart_data) -> untyped
 
         def header_part: (string key, String content_type, String? filename) -> StringIO
 
-        def read_chunks: (String buffer, Integer? length) -> void
+        def read_chunks: (String buffer, ?Integer? length) -> void
 
-        def read_from_part: (Integer? max_length) -> void
+        def read_from_part: (?Integer? max_length) -> String?
+      end
+
+      class Decoder
+        BOUNDARY_RE: Regexp
+
+        @state: :idle | :part_header | :part_body | :parse_boundary | :done
+        @buffer: String
+        @parts: Hash[String, untyped]
+        @boundary: String
+        @intermediate_boundary: String
+
+        def call: (Response response, untyped) -> Hash[String, untyped]
+
+        private
+
+        def initialize: (Response response) -> void
+
+        def parse: () -> void
+
+        def get_filename: (String head) -> String?
+      end
+
+      class FilePart #  < SimpleDelegator
+        attr_reader original_filename: String
+        attr_reader content_type: String
+
+        # @file: Tempfile
+
+        # private
+
+        def initialize: (String filename, String content_type) -> void
       end
 
       module Part
-        def self?.call: (multipart_nested_value) -> ([_Reader, String, String?])
+        def self?.call: [U] (_MultipartInput multipart_input) -> [U, String, String]
+                      | (multipart_nested_value input) -> ([StringIO, String, String?] | [File, String, String])
       end
 
       module MimeTypeDetector
-        def self?.call: (::IO file, ?String filename) -> String?
+        DEFAULT_MIMETYPE: String
+
+        def self?.call: (::IO file, String filename) -> String?
       end
     end
   end

data/sig/plugins/proxy.rbs

@@ -9,8 +9,8 @@ module HTTPX
 
       class Parameters
         attr_reader uri: URI::Generic
-        attr_reader username: string?
-        attr_reader password: string?
+        attr_reader username: String?
+        attr_reader password: String?
 
         def authenticated?: () -> boolish
         def token_authentication: () -> String?
@@ -19,7 +19,7 @@ module HTTPX
 
         private
 
-        def initialize: (uri: generic_uri, ?username: string, ?password: string) -> untyped
+        def initialize: (uri: generic_uri, ?username: String, ?password: String) -> untyped
       end
 
       def self.configure: (singleton(Session)) -> void
@@ -35,9 +35,9 @@ module HTTPX
       module InstanceMethods
         private
 
-        def proxy_uris: (uri, Options & _ProxyOptions) -> { uri: (URI | string), username: string, password: string }
-                      | (uri, Options & _ProxyOptions) -> { uri: (URI | string) }
-                      | (uri, Options & _ProxyOptions) -> nil
+        def proxy_uris: (generic_uri, Options & _ProxyOptions) -> { uri: generic_uri, username: String, password: String }
+                      | (generic_uri, Options & _ProxyOptions) -> { uri: generic_uri }
+                      | (generic_uri, Options & _ProxyOptions) -> nil
       end
     end
 

data/sig/plugins/response_cache.rbs

@@ -0,0 +1,35 @@
+module HTTPX
+  module Plugins
+    module ResponseCache
+      CACHEABLE_VERBS: Array[Symbol]
+
+      def self?.cacheable_request?: (Request request) -> bool
+      def self?.cacheable_response?: (response response) -> bool
+      def self?.cached_response?: (response response) -> bool
+
+      class Store
+        @store: Hash[URI::Generic, Response]
+
+        def lookup: (URI::Generic uri) -> Response?
+
+        def cached?: (URI::Generic uri) -> bool
+
+        def cache: (URI::Generic uri, Response response) -> void
+
+        def prepare: (Request request) -> void
+      end
+
+      module InstanceMethods
+        @response_cache: Store
+
+        def clear_response_cache: () -> void
+      end
+
+      module ResponseMethods
+        def copy_from_cached: (Response other) -> void
+      end
+    end
+
+    type sessionResponseCache = Session & ResponseCache::InstanceMethods
+  end
+end

data/sig/plugins/retries.rbs

@@ -4,6 +4,7 @@ module HTTPX
       MAX_RETRIES: Integer
       IDEMPOTENT_METHODS: Array[verb]
       RETRYABLE_ERRORS: Array[singleton(StandardError)]
+      DEFAULT_JITTER: ^(Numeric) -> Numeric
 
       interface _RetryCallback
         def call: (response) -> bool?
@@ -12,6 +13,8 @@ module HTTPX
       interface _RetriesOptions
         def retry_after: () -> Numeric?
 
+        def retry_jitter: () -> ^(Numeric) -> Numeric
+
         def max_retries: () -> Integer?
 
         def retry_change_requests: () -> boolish

data/sig/pool.rbs

@@ -10,6 +10,8 @@ module HTTPX
 
     def find_connection: (generic_uri, Options) -> Connection?
 
+    def deactivate: (*Array[Connection]) -> void
+
     private
 
     def initialize: () -> untyped
@@ -26,6 +28,10 @@ module HTTPX
 
     def unregister_connection: (Connection) -> void
 
+    def select_connection: (resolver | Connection connection) -> void
+
+    def deselect_connection: (resolver | Connection connection) -> void
+
     def coalesce_connections: (Connection, Connection) -> void
 
     def next_timeout: () -> Numeric?