httpx 0.20.0 → 1.3.1

data/sig/options.rbs

@@ -2,21 +2,25 @@ module HTTPX
   class Options
     # include _ToHash
 
+    BUFFER_SIZE: Integer
     WINDOW_SIZE: Integer
     MAX_BODY_THRESHOLD_SIZE: Integer
     CONNECT_TIMEOUT: Integer
+    READ_TIMEOUT: Integer
+    WRITE_TIMEOUT: Integer
+    REQUEST_TIMEOUT: Integer
     OPERATION_TIMEOUT: Integer
     KEEP_ALIVE_TIMEOUT: Integer
     SETTINGS_TIMEOUT: Integer
+    CLOSE_HANDSHAKE_TIMEOUT: Integer
     DEFAULT_OPTIONS: Hash[Symbol, untyped]
+    REQUEST_BODY_IVARS: Array[Symbol]
 
-    type timeout_type = :connect_timeout | :settings_timeout | :operation_timeout | :keep_alive_timeout | :total_timeout
-    type timeout = Hash[timeout_type, Numeric]
+    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?]
 
     def self.new: (?options) -> instance
 
-    def self.def_option: (Symbol, ?String) -> void
-                       | (Symbol) { (*nil) -> untyped } -> void
     # headers
     attr_reader uri: URI?
 
@@ -33,38 +37,38 @@ module HTTPX
     attr_reader max_concurrent_requests: Integer?
 
     # max_requests
-    attr_reader max_requests: Integer?
+    attr_reader max_requests: Numeric?
 
     # window_size
     attr_reader window_size: Integer
 
+    # buffer_size
+    attr_reader buffer_size: Integer
+
     # body_threshold_size
     attr_reader body_threshold_size: Integer
 
     # transport
-    attr_reader transport: String?
-
-    # transport_options
-    attr_reader transport_options: Hash[untyped, untyped]?
+    attr_reader transport: io_type | nil
 
     # addresses
     attr_reader addresses: Array[ipaddr]?
 
-    # params
-    attr_reader params: Transcoder::urlencoded_input?
+    # supported_compression_formats
+    attr_reader supported_compression_formats: Array[String]
 
-    # form
-    attr_reader form: Transcoder::urlencoded_input?
+    # compress_request_body
+    attr_reader compress_request_body: bool
 
-    # json
-    attr_reader json: _ToJson?
+    # decompress_response_body
+    attr_reader decompress_response_body: bool
 
-    # body
-    attr_reader body: bodyIO?
-
-    # body
+    # origin
     attr_reader origin: URI::Generic?
 
+    # base_path
+    attr_reader base_path: String?
+
     # ssl
 
     # http2_settings
@@ -109,17 +113,23 @@ module HTTPX
     # ip_families
     attr_reader ip_families: Array[ip_family]
 
-    def ==: (untyped other) -> bool
+    def ==: (Options other) -> bool
+
+    def options_equals?: (Options other, ?Array[Symbol] ignore_ivars) -> bool
+
     def merge: (_ToHash[Symbol, untyped] other) -> instance
+
     def to_hash: () -> Hash[Symbol, untyped]
 
+    def extend_with_plugin_classes: (Module pl) -> void
+
     private
 
     REQUEST_IVARS: Array[Symbol]
 
-    def initialize: (?options options) -> untyped
+    def initialize: (?options options) -> void
 
-    def __initialize__: (?options options) -> untyped
+    def do_initialize: (?options options) -> void
   end
 
   type options = Options | Hash[Symbol, untyped]

data/sig/parser/http1.rbs

@@ -29,7 +29,7 @@ module HTTPX
       @_has_trailers: bool
       @upgrade: bool
 
-      def <<: (String chunk) -> void
+      def <<: (string chunk) -> void
 
       def reset!: () -> void
 

data/sig/plugins/{authentication → auth}/basic.rbs

@@ -5,8 +5,6 @@ module HTTPX
         @user: String
         @password: String
 
-        def can_authenticate?: (String? authenticate) -> boolish
-
         def authenticate: (*untyped) -> String
 
         private

data/sig/plugins/{authentication → auth}/digest.rbs

@@ -4,6 +4,7 @@ module HTTPX
       class Digest
         @user: String
         @password: String
+        @hashed: bool
 
         def can_authenticate?: (String? authenticate) -> boolish
 
@@ -13,7 +14,7 @@ module HTTPX
 
         def generate_header: (String meth, String uri, String authenticate) -> String
 
-        def initialize: (string user, string password) -> void
+        def initialize: (string user, string password, ?hashed: bool, **untyped) -> void
 
         def make_cnonce: () -> String
 

data/sig/plugins/auth.rbs

@@ -0,0 +1,13 @@
+module HTTPX
+  module Plugins
+    module Authorization
+      module InstanceMethods
+        def authorization: (string token) -> instance
+
+        def bearer_auth: (string token) -> instance
+      end
+    end
+
+    type sessionAuthorization = Session & Authorization::InstanceMethods
+  end
+end

data/sig/plugins/{basic_authentication.rbs → basic_auth.rbs}

@@ -6,10 +6,10 @@ module HTTPX
       def self.configure: (singleton(Session)) -> void
 
       module InstanceMethods
-        def basic_authentication: (string user, string password) -> instance
+        def basic_auth: (string user, string password) -> instance
       end
     end
 
-    type sessionBasicAuth = sessionAuthentication & Authentication::InstanceMethods & BasicAuth::InstanceMethods
+    type sessionBasicAuth = sessionAuthorization & BasicAuth::InstanceMethods
   end
 end

data/sig/plugins/brotli.rbs

@@ -0,0 +1,22 @@
+module HTTPX
+  module Plugins
+    module Brotli
+      def self?.load_dependencies: (singleton(Session)) -> void
+
+      def self?.encode: (body_encoder body) -> Deflater
+
+      def self?.decode: (HTTPX::Response response, ?bytesize: Integer) -> Transcoder::_Decoder
+
+      class Deflater < Transcoder::Deflater
+      end
+
+      module RequestBodyClassMethods
+        def initialize_deflater_body: (body_encoder body, Encoding | String encoding) -> body_encoder
+      end
+
+      module ResponseBodyClassMethods
+        def initialize_inflater_by_encoding: (Encoding | String encoding, Response response, ?bytesize: Integer) -> (Transcoder::_Decoder | Transcoder::GZIP::Inflater)
+      end
+    end
+  end
+end

data/sig/plugins/callbacks.rbs

@@ -0,0 +1,38 @@
+module HTTPX
+  module Plugins
+    module Callbacks
+      class CallbackError < Exception
+      end
+
+      module InstanceMethods
+        include HTTPX::Callbacks
+
+        type socket = TCPSocket | OpenSSL::SSL::SSLSocket | UNIXSocket
+
+        def on_connection_opened: () { (http_uri origin, socket sock) -> void } -> self
+
+        def on_connection_closed: () { (http_uri origin) -> void } -> self
+
+        def on_request_error: () { (Request request, StandardError error) -> void } -> self
+
+        def on_request_started: () { (Request request) -> void } -> self
+
+        def on_request_body_chunk: () { (Request request, String chunk) -> void } -> self
+
+        def on_request_completed: () { (Request request) -> void } -> self
+
+        def on_response_started: () { (Request request, Response response) -> void } -> self
+
+        def on_response_body_chunk: () { (Request request, Response response, String chunk) -> void } -> self
+
+        def on_response_completed: () { (Request request, response response) -> void } -> self
+
+        private
+
+        def emit_or_callback_error: (*untyped) -> void
+      end
+    end
+
+    type sessionCallbacks = Session & Callbacks::InstanceMethods
+  end
+end

data/sig/plugins/circuit_breaker.rbs

@@ -0,0 +1,71 @@
+module HTTPX
+  module Plugins
+    module CircuitBreaker
+
+      class CircuitStore
+        @circuits: Hash[String, Circuit]
+
+        @circuits_mutex: Thread::Mutex
+
+        def try_open: (uri uri, response response) -> response?
+
+        def try_respond: (Request request) -> response?
+
+        def try_close: (http_uri uri) -> void
+
+        private
+
+        def get_circuit_for_uri: (uri uri) -> Circuit
+
+        def initialize: (Options & _CircuitOptions options) -> void
+      end
+
+      class Circuit
+        @state: :closed | :open | :half_open
+        @max_attempts: Integer
+        @reset_attempts_in: Float
+        @break_in: Float
+        @circuit_breaker_half_open_drip_rate: Float
+        @attempts: Integer
+        @real_attempts: Integer
+        @drip_factor: Integer
+
+        @response: response?
+        @opened_at: Float?
+        @attempted_at: Float?
+
+        def respond: () -> response?
+
+        def try_open: (response) -> response?
+
+        def try_close: () -> void
+
+        private
+
+        def initialize: (Integer max_attempts, Float reset_attempts_in, Float break_in, Float circuit_breaker_half_open_drip_rate) -> void
+      end
+
+      interface _CircuitOptions
+        def circuit_breaker_max_attempts: () -> Integer
+        def circuit_breaker_reset_attempts_in: () -> Float
+        def circuit_breaker_break_in: () -> Float
+        def circuit_breaker_half_open_drip_rate: () -> Float
+        def circuit_breaker_break_on: () -> (^(Response) -> boolish | nil)
+      end
+
+      def self.load_dependencies: (singleton(Session)) -> void
+      def self.extra_options: (Options) -> (Options & _CircuitOptions)
+
+      module InstanceMethods
+        @circuit_store: CircuitStore
+
+        private
+
+        def try_circuit_open: (Request request, response response) -> response?
+      end
+
+    end
+
+    type sessionCircuitBreaker = Session & CircuitBreaker::InstanceMethods
+  end
+end

data/sig/plugins/compression.rbs

@@ -1,7 +1,6 @@
 module HTTPX
   module Plugins
     module Compression
-      type encodings_registry = Registry[Symbol, Class]
 
       type deflatable = _Reader | _ToS
 
@@ -13,15 +12,18 @@ module HTTPX
       interface _Inflater
         def inflate: (string) -> String
 
-        def initialize: (Numeric bytesize) -> untyped
+        def initialize: (Integer | Float bytesize) -> untyped
+      end
+
+      interface _Compressor
+        def deflater: () -> _Deflater
+        def inflater: (Integer | Float bytesize) -> _Inflater
       end
 
       def self.configure: (singleton(Session)) -> void
 
       interface _CompressionOptions
-        def compression_threshold_size: () -> Integer?
-
-        def encodings: () -> encodings_registry?
+        def encodings: () -> Hash[String, _Compressor]
       end
 
       def self.extra_options: (Options) -> (Options & _CompressionOptions)

data/sig/plugins/cookies/jar.rbs

@@ -13,8 +13,8 @@ module HTTPX
 
       def []: (uri) -> Array[Cookie]
 
-      def each: (?uri) { (Cookie) -> void } -> void
-              | (?uri) -> Enumerable[Cookie]
+      def each: (?uri?) { (Cookie) -> void } -> void
+              | (?uri?) -> Enumerable[Cookie]
 
       def merge: (_Each[cookie] cookies) -> instance
 

data/sig/plugins/cookies.rbs

@@ -5,6 +5,8 @@ module HTTPX
 
       interface _CookieOptions
         def cookies: () -> Jar?
+
+        def merge_cookie_in_jar: (Array[String] cookies, Jar jar) -> void
       end
 
       def self.extra_options: (Options) -> (Options & _CookieOptions)

data/sig/plugins/{digest_authentication.rbs → digest_auth.rbs}

@@ -12,10 +12,10 @@ module HTTPX
       def self.load_dependencies: (*untyped) -> void
 
       module InstanceMethods
-        def digest_authentication: (string user, string password) -> instance
+        def digest_auth: (string user, string password, ?hashed: bool) -> instance
       end
     end
 
-    type sessionDigestAuth = sessionAuthentication & DigestAuth::InstanceMethods
+    type sessionDigestAuth = sessionAuthorization & DigestAuth::InstanceMethods
   end
 end

data/sig/plugins/follow_redirects.rbs

@@ -5,11 +5,18 @@ module HTTPX
     module FollowRedirects
       MAX_REDIRECTS: Integer
       REDIRECT_STATUS: Range[Integer]
+      REQUEST_BODY_HEADERS: Array[String]
+
+      type redirect_request = Request & RequestMethods
 
       interface _FollowRedirectsOptions
         def max_redirects: () -> Integer?
 
         def follow_insecure_redirects: () -> bool?
+
+        def allow_auth_to_other_origins: () -> bool?
+
+        def redirect_on: () -> (^(http_uri) -> boolish | nil)
       end
 
       def self.extra_options: (Options) -> (Options & _FollowRedirectsOptions)
@@ -17,13 +24,20 @@ module HTTPX
       module InstanceMethods
         def max_redirects: (_ToI) -> instance
 
-        def build_redirect_request: (Request, Response, Options) -> Request
-        def __get_location_from_response: (Response) -> (URI::HTTP | URI::HTTPS)
+        def handle_after_redirect_request: (http_uri original_uri, http_uri redirect_uri, Request request, Options & _FollowRedirectsOptions options) -> void
+
+        def __get_location_from_response: (Response) -> http_uri
       end
 
       module RequestMethods
-        def redirect_request: () -> Request
-        def redirect_request=: (Request) -> void
+        attr_accessor root_request: instance?
+
+        @redirect_request: redirect_request
+
+        def redirect_request: () -> redirect_request
+
+        def redirect_request=: (redirect_request req) -> void
+
         def max_redirects: () -> Integer
       end
     end

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

@@ -7,6 +7,11 @@ module HTTPX
 
   module Plugins
     module GRPC
+      DEADLINE: Integer
+      MARSHAL_METHOD: Symbol
+      UNMARSHAL_METHOD: Symbol
+      HEADERS: Hash[String, String]
+
       type compression_option = bool | String
       type rpc_def = [String, untyped, untyped, Hash[Symbol, untyped]]
 
@@ -17,36 +22,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 +38,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 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 token_endpoint_auth_method: () -> token_auth_method
+
+        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/http.rbs

@@ -16,6 +16,9 @@ module HTTPX
           def __http_on_connect: (top, Response) ->  void
         end
 
+        class ConnectRequest < Request
+          def initialize: (generic_uri uri, Options options) -> void
+        end
       end
     end