httpx 0.21.0 → 1.2.1

data/sig/plugins/grpc/call.rbs

@@ -0,0 +1,19 @@
+module HTTPX
+  module Plugins
+    module GRPC
+      class Call
+        attr_writer decoder: _Callable
+
+        def metadata: () -> headers
+
+        def trailing_metadata: () -> headers?
+
+        private
+
+        def initialize: (Response | StreamResponse response) -> untyped
+
+        def grpc_response: () -> grpc_response
+      end
+    end
+  end
+end

data/sig/plugins/grpc/grpc_encoding.rbs

@@ -0,0 +1,37 @@
+module HTTPX
+  module Transcoder
+    module GRPCEncoding
+
+      def self?.encode: (body_encoder body, compressed: bool) -> Deflater
+
+      def self?.decode: (Response | StreamResponse response) -> Inflater
+
+      class Deflater
+        attr_reader content_type: String
+
+        @body: BodyReader
+        @compressed: bool
+
+        def initialize: (body_encoder body, compressed: bool) -> void
+
+        def bytesize: () -> (Integer | Float)
+
+        def read: (?int? length, ?string outbuf) -> String?
+      end
+
+      class Inflater
+        @response: Response
+        @grpc_encodings: Array[String]
+
+        def initialize: (Response | StreamResponse response) -> void
+
+        def call: (String message) ?{ (String) -> void } -> String
+
+        private
+
+        def grpc_encodings: () -> Array[String]
+      end
+
+    end
+  end
+end

data/sig/plugins/grpc/message.rbs

@@ -0,0 +1,17 @@
+
+module HTTPX
+  module Plugins
+    module GRPC
+      module Message
+        def self?.unary: (response) -> grpc_message
+
+        def self?.stream: (StreamResponse) { (String) -> void } -> void
+                        | (StreamResponse) -> Enumerable[String]
+
+        def self?.cancel: (Request) -> void
+
+        def self?.verify_status: (StreamResponse | response) -> void
+      end
+    end
+  end
+end

data/sig/plugins/grpc.rbs

@@ -17,36 +17,6 @@ module HTTPX
 
       type credentials = Proc
 
-      class Call
-        attr_writer decoder: _Callable
-
-        def metadata: () -> headers
-
-        def trailing_metadata: () -> headers?
-
-        private
-
-        def initialize: (Response | StreamResponse response) -> untyped
-
-        def grpc_response: () -> grpc_response
-      end
-
-      module Message
-        def self?.unary: (response) -> grpc_message
-
-        def self?.stream: (StreamResponse) { (String) -> void } -> void
-                        | (StreamResponse) -> Enumerable[String]
-
-        def self?.encode: (String bytes, ?deflater: Compression::_Deflater?) -> String
-
-        def self?.decode: (String message, encodings: Array[String], encoders: Compression::encodings_registry) -> String
-                        | (String message, encodings: Array[String], encoders: Compression::encodings_registry) { (String) -> void } -> void
-
-        def self?.cancel: (Request) -> void
-
-        def self?.verify_status: (StreamResponse | response) -> void
-      end
-
       interface _GRPCOptions
         def grpc_service: () -> String?
 
@@ -63,9 +33,9 @@ module HTTPX
       def self.load_dependencies: (singleton(Session)) -> void
 
       module ResponseMethods
-        def merge_headers: (headers_input trailers) -> void
+        attr_reader trailing_metadata: Hash[String, untyped]
 
-        def encoders: () -> Compression::encodings_registry
+        def encoders: () -> Array[String | Encoding]
       end
 
       module InstanceMethods

data/sig/plugins/h2c.rbs

@@ -1,7 +1,7 @@
 module HTTPX
   module Plugins
     module H2C
-      VALID_H2C_VERBS: Array[Symbol]
+      VALID_H2C_VERBS: Array[verb]
 
       def self.load_dependencies: (*untyped) -> void
       def self.configure: (singleton(Session)) -> void

data/sig/plugins/{ntlm_authentication.rbs → ntlm_auth.rbs}

@@ -11,11 +11,11 @@ module HTTPX
       def self.load_dependencies: (*untyped) -> void
 
       module InstanceMethods
-        def ntlm_authentication: (string user, string password, ?string? domain) -> instance
+        def ntlm_auth: (string user, string password, ?string? domain) -> instance
       end
 
     end
 
-    type sessionNTLMAuth = sessionAuthentication & NTLMAuth::InstanceMethods
+    type sessionNTLMAuth = sessionAuthorization & NTLMAuth::InstanceMethods
   end
 end

data/sig/plugins/oauth.rbs

@@ -0,0 +1,54 @@
+module HTTPX
+  module Plugins
+    #
+    # https://gitlab.com/os85/httpx/wikis/OAuth
+    #
+    module OAuth
+      def self.load_dependencies: (singleton(Session) klass) -> void
+
+      type grant_type = "client_credentials" | "refresh_token"
+
+      type token_auth_method = "client_secret_basic" | "client_secret_post"
+
+      SUPPORTED_GRANT_TYPES: ::Array[grant_type]
+
+      SUPPORTED_AUTH_METHODS: ::Array[token_auth_method]
+
+      class OAuthSession
+        attr_reader token_endpoint_auth_method: token_auth_method
+
+        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]?
+
+        def initialize: (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) -> void
+
+        def token_endpoint: () -> String
+
+        def load: (Session http) -> void
+
+        def merge: (instance | Hash[untyped, untyped] other) -> instance
+      end
+
+      interface _AwsSdkOptions
+        def oauth_session: () -> OAuthSession?
+      end
+
+      module InstanceMethods
+        def oauth_auth: (**untyped args) -> instance
+
+        def with_access_token: () -> instance
+      end
+    end
+
+    type sessionOAuth = Session & OAuth::InstanceMethods
+  end
+end

data/sig/plugins/proxy/socks4.rbs

@@ -1,20 +1,20 @@
 module HTTPX
-  Socks4Error: singleton(Error)
+  class Socks4Error < HTTPProxyError
+  end
 
   module Plugins
     module Proxy
       module Socks4
-      
+
         module ConnectionMethods
           def __socks4_proxy_connect: () ->  void
           def __socks4_on_packet: (String packet) ->  void
           def on_socks4_error: (string) -> void
         end
-        
+
         class SocksParser
           include Callbacks
 
-          def timeout: () -> Integer
           def close: () -> void
           def consume: (*untyped) -> void
           def empty: () -> bool

data/sig/plugins/proxy/socks5.rbs

@@ -1,5 +1,6 @@
 module HTTPX
-  Socks5Error: singleton(Error)
+  class Socks5Error < HTTPProxyError
+  end
 
   module Plugins
     module Proxy
@@ -16,7 +17,6 @@ module HTTPX
         class SocksParser
           include Callbacks
 
-          def timeout: () -> Integer
           def close: () -> void
           def consume: (*untyped) -> void
           def empty: () -> bool

data/sig/plugins/proxy/ssh.rbs

@@ -7,7 +7,7 @@ module HTTPX
         module InstanceMethods
           private
 
-          def build_gateway_socket: (int, URI::HTTP | URI::HTTPS, Options) ->  _ToIO
+          def build_gateway_socket: (int, http_uri, Options) ->  _ToIO
         end
       end
     end

data/sig/plugins/proxy.rbs

@@ -1,5 +1,8 @@
 module HTTPX
-  class HTTPProxyError < Error
+  class HTTPProxyError < ConnectionError
+  end
+
+  class ProxySSL < SSL
   end
 
   module Plugins
@@ -35,11 +38,14 @@ module HTTPX
       def self.extra_options: (Options) -> (Options & _ProxyOptions)
 
       module InstanceMethods
+        @__proxy_uris: Array[generic_uri]
+
         private
 
-        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
+        def proxy_error?: (Request request, response) -> bool
+      end
+
+      module ConnectionMethods
       end
     end
 

data/sig/plugins/response_cache.rbs

@@ -1,15 +1,18 @@
 module HTTPX
   module Plugins
     module ResponseCache
-      CACHEABLE_VERBS: Array[Symbol]
+      CACHEABLE_VERBS: Array[verb]
+      CACHEABLE_STATUS_CODES: Array[Integer]
 
-      def self?.cacheable_request?: (Request request) -> bool
-      def self?.cacheable_response?: (response response) -> bool
+      def self?.cacheable_request?: (Request & RequestMethods request) -> bool
+      def self?.cacheable_response?: (::HTTPX::ErrorResponse | (Response & ResponseMethods) response) -> bool
       def self?.cached_response?: (response response) -> bool
 
       class Store
         @store: Hash[String, Array[Response]]
 
+        @store_mutex: Thread::Mutex
+
         def lookup: (Request request) -> Response?
 
         def cached?: (Request request) -> boolish
@@ -21,6 +24,10 @@ module HTTPX
         private
 
         def match_by_vary?: (Request request, Response response) -> bool
+
+        def _get: (Request request) -> Array[Response]?
+
+        def _set: (Request request, Response response) -> void
       end
 
       module InstanceMethods
@@ -30,6 +37,8 @@ module HTTPX
       end
 
       module RequestMethods
+        @response_cache_key: String
+
         def response_cache_key: () -> String
       end
 

data/sig/plugins/retries.rbs

@@ -2,40 +2,60 @@ module HTTPX
   module Plugins
     module Retries
       MAX_RETRIES: Integer
-      IDEMPOTENT_METHODS: Array[verb]
+      IDEMPOTENT_METHODS: Array[String]
       RETRYABLE_ERRORS: Array[singleton(StandardError)]
       DEFAULT_JITTER: ^(Numeric) -> Numeric
 
       interface _RetryCallback
-        def call: (response) -> bool?
+        def call: (response response) -> bool?
       end
 
       interface _RetriesOptions
         def retry_after: () -> Numeric?
 
-        def retry_jitter: () -> ^(Numeric) -> Numeric
+        def retry_jitter: () -> ^(Numeric jitter) -> Numeric
 
-        def max_retries: () -> Integer?
+        def max_retries: () -> Integer
 
         def retry_change_requests: () -> boolish
 
         def retry_on: () -> _RetryCallback?
       end
 
-      def self.extra_options: (Options) -> (Options & _RetriesOptions)
+      def self.extra_options: (Options options) -> retriesOptions
 
       module InstanceMethods
         def max_retries: (int) -> instance
 
         private
 
-        def __repeatable_request?: (Request, Options) -> boolish
-        def __retryable_error?: (_Exception) -> bool
+        def __repeatable_request?: (retriesRequest request, retriesOptions options) -> boolish
+
+        def __retryable_error?: (_Exception error) -> bool
+
+        def __try_partial_retry: (retriesRequest request, (retriesResponse | ErrorResponse) response) -> void
+
       end
 
       module RequestMethods
-      	def retries: () -> Integer
+        @options: Options & _RetriesOptions
+
+        attr_accessor retries: Integer
+
+        attr_writer partial_response: Response?
+
+        def response=: (retriesResponse | ErrorResponse response) -> void
       end
+
+      module ResponseMethods
+        def from_partial_response: (Response response) -> void
+      end
+
+      type retriesOptions = Options & _RetriesOptions
+
+      type retriesRequest = Request & RequestMethods
+
+      type retriesResponse = Response & ResponseMethods
     end
 
     type sessionRetries = Session & Retries::InstanceMethods

data/sig/plugins/stream.rbs

@@ -1,21 +1,4 @@
 module HTTPX
-  class StreamResponse
-    include _ToS
-
-    def each: () { (String) -> void } -> void
-            | () -> Enumerable[String]
-
-    def each_line: () { (String) -> void } -> void
-                 | () -> Enumerable[String]
-
-    def on_chunk: (string) -> void
-
-    private
-
-    def response: () -> response
-    def initialize: (Request, Session, Array[Connection]) -> untyped
-  end
-
   module Plugins
     module Stream
       module InstanceMethods
@@ -37,4 +20,28 @@ module HTTPX
 
     type sessionStream = Session & Stream::InstanceMethods
   end
+
+  class StreamResponse
+    include _ToS
+
+    type streamRequest = Request & Plugins::Stream::RequestMethods
+
+    @request: streamRequest
+    @session: Plugins::sessionStream
+    @on_chunk: ^(String) -> void | nil
+
+    def each: () { (String) -> void } -> void
+            | () -> Enumerable[String]
+
+    def each_line: () { (String) -> void } -> void
+                 | () -> Enumerable[String]
+
+    def on_chunk: (string) -> void
+
+    def initialize: (streamRequest, Plugins::sessionStream) -> void
+
+    private
+
+    def response: () -> response
+  end
 end

data/sig/plugins/upgrade.rbs

@@ -1,18 +1,20 @@
 module HTTPX
   module Plugins
     module Upgrade
-      type handlers_registry = Registry[Symbol, Class]
+      interface _Upgrader
+        def call: (Connection connection, Request request, Response response) -> void
+      end
 
       def self.configure: (singleton(Session)) -> void
 
       interface _UpgradeOptions
-        def upgrade_handlers: () -> handlers_registry?
+        def upgrade_handlers: () -> Hash[String, _Upgrader]
       end
 
       def self.extra_options: (Options) -> (Options & _UpgradeOptions)
 
       module ConnectionMethods
-        attr_reader upgrade_protocol: Symbol?
+        attr_reader upgrade_protocol: String?
         attr_reader hijacked: boolish
 
         def hijack_io: () -> void

data/sig/pool.rbs

@@ -6,7 +6,6 @@ module HTTPX
     @timers: Timers
     @selector: Selector
     @connections: Array[Connection]
-    @connected_connections: Integer
 
     def empty?: () -> void
 
@@ -22,7 +21,9 @@ module HTTPX
 
     private
 
-    def initialize: () -> untyped
+    def initialize: () -> void
+
+    def try_clone_connection: (Connection connection, Integer? family) -> Connection
 
     def resolve_connection: (Connection) -> void
 
@@ -34,7 +35,7 @@ module HTTPX
 
     def register_connection: (Connection) -> void
 
-    def unregister_connection: (Connection) -> void
+    def unregister_connection: (Connection, ?bool cleanup) -> void
 
     def select_connection: (Selector::selectable) -> void
 
@@ -42,7 +43,7 @@ module HTTPX
 
     def coalesce_connections: (Connection coalescable, Connection coalescing) -> void
 
-    def next_timeout: () -> (Integer | Float | nil)
+    def next_timeout: () -> Numeric?
 
     def find_resolver_for: (Connection) { (Resolver::Resolver resolver) -> void } -> resolver_manager
   end

data/sig/request/body.rbs

@@ -0,0 +1,40 @@
+module HTTPX
+  class Request::Body
+    @headers: Headers
+    @body: body_encoder?
+    @unbounded_body: bool
+
+    def initialize: (Headers headers, Options options) -> void
+
+    def each: () { (String) -> void } -> void
+            | () -> Enumerable[String]
+
+    def rewind: () -> void
+
+    def empty?: () -> bool
+
+    def bytesize: () -> (Integer | Float)
+
+    def stream: (Transcoder::_Encoder) -> bodyIO
+
+    def unbounded_body?: () -> bool
+
+    def chunked?: () -> bool
+
+    def chunk!: () -> void
+
+    private
+
+    def initialize_body: (Options options) -> void
+
+    def self.initialize_deflater_body: (body_encoder body, Encoding | String encoding) -> body_encoder
+  end
+
+  class ProcIO
+    @block: ^(String) -> void
+
+    def initialize: (^(String) -> void) -> untyped
+
+    def write: (String data) -> Integer
+  end
+end

data/sig/request.rbs

@@ -6,8 +6,8 @@ module HTTPX
     METHODS: Array[Symbol]
     USER_AGENT: String
 
-    attr_reader verb: Symbol
-    attr_reader uri: URI::Generic
+    attr_reader verb: verb
+    attr_reader uri: http_uri
     attr_reader headers: Headers
     attr_reader body: Body
     attr_reader state: Symbol
@@ -15,6 +15,10 @@ module HTTPX
     attr_reader response: response?
     attr_reader drain_error: StandardError?
 
+    attr_accessor peer_address: ipaddr?
+
+    attr_writer persistent: bool
+
     @trailers: Headers?
     @informational_status: Integer?
     @query: String?
@@ -50,37 +54,17 @@ module HTTPX
 
     def trailers?: () -> boolish
 
-    def read_timeout: () -> Numeric
-
-    def write_timeout: () -> Numeric
-
-    def request_timeout: () -> Numeric
+    def persistent?: () -> bool
 
-    class Body
-      @headers: Headers
-      @body: body_encoder?
-      @unbounded_body: bool
+    def read_timeout: () -> Numeric?
 
-      def initialize: (Headers, Options) -> untyped
-      def each: () { (String) -> void } -> void
-              | () -> Enumerable[String]
+    def write_timeout: () -> Numeric?
 
-      def rewind: () -> void
-      def empty?: () -> bool
-      def bytesize: () -> (Integer | Float)
-      def stream: (Transcoder::_Encoder) -> bodyIO
-      def unbounded_body?: () -> bool
-      def chunked?: () -> bool
-      def chunk!: () -> void
-      def inspect: () -> String
-    end
+    def request_timeout: () -> Numeric?
 
-    class ProcIO
-      @block: ^(String) -> void
+    private
 
-      def initialize: (^(String) -> void) -> untyped
+    def initialize_body: (Options options) -> Transcoder::_Encoder?
 
-      def write: (String data) -> Integer
-    end
   end
 end

data/sig/resolver/https.rbs

@@ -6,7 +6,8 @@ module HTTPX
       DEFAULTS: Hash[Symbol, untyped]
       FAMILY_TYPES: Hash[singleton(Resolv::DNS::Resource), String]
 
-      @family: ip_family
+      attr_reader family: ip_family
+
       @options: Options
       @requests: Hash[Request, String]
       @connections: Array[Connection]
@@ -31,9 +32,13 @@ module HTTPX
 
       def parse: (Request request, Response response) -> void
 
+      def parse_addresses: (Array[dns_result] answers, Request request) -> void
+
       def build_request: (String hostname) -> Request
 
-      def decode_response_body: (Response) -> Array[dns_result]
+      def decode_response_body: (Response) -> dns_decoding_response
+
+      def reset_hostname: (String hostname, ?reset_candidates: bool) -> Connection?
     end
   end
 end

data/sig/resolver/native.rbs

@@ -7,10 +7,12 @@ module HTTPX
       DEFAULTS: Hash[Symbol, untyped]
       DNS_PORT: Integer
 
-      @family: ip_family
+      attr_reader family: ip_family
+
       @options: Options
       @ns_index: Integer
-      @nameserver: Array[String]?
+      @nameserver: Array[String]
+      @socket_type: :udp | :tcp
       @ndots: Integer
       @start_timeout: Float?
       @search: Array[String]
@@ -19,6 +21,8 @@ module HTTPX
       @connections: Array[Connection]
       @read_buffer: String
       @write_buffer: Buffer
+      @large_packet: Buffer?
+      @io: UDP | TCP
 
       attr_reader state: Symbol
 
@@ -30,7 +34,7 @@ module HTTPX
 
       def timeout: () -> Numeric?
 
-      def raise_timeout_error: (Numeric interval) -> void
+      def handle_socket_timeout: (Numeric interval) -> void
 
       private
 
@@ -53,11 +57,13 @@ module HTTPX
 
       def generate_candidates: (String) -> Array[String]
 
-      def build_socket: () -> void
+      def build_socket: () -> (UDP | TCP)
 
       def transition: (Symbol nextstate) -> void
 
       def handle_error: (NativeResolveError | StandardError) -> void
+
+      def reset_hostname: (String hostname, ?connection: Connection, ?reset_candidates: bool) -> void
     end
   end
 end