httpx 1.3.4 → 1.4.0

data/lib/httpx.rb

@@ -2,28 +2,11 @@
 
 require "httpx/version"
 
-require "httpx/extensions"
-
-require "httpx/errors"
-require "httpx/utils"
-require "httpx/punycode"
-require "httpx/domain_name"
-require "httpx/altsvc"
-require "httpx/callbacks"
-require "httpx/loggable"
-require "httpx/transcoder"
-require "httpx/timers"
-require "httpx/pool"
-require "httpx/headers"
-require "httpx/request"
-require "httpx/response"
-require "httpx/options"
-require "httpx/chainable"
-
 # Top-Level Namespace
 #
 module HTTPX
   EMPTY = [].freeze
+  EMPTY_HASH = {}.freeze
 
   # All plugins should be stored under this module/namespace. Can register and load
   # plugins.
@@ -53,10 +36,26 @@ module HTTPX
       m.synchronize { h[name] = mod }
     end
   end
-
-  extend Chainable
 end
 
+require "httpx/extensions"
+
+require "httpx/errors"
+require "httpx/utils"
+require "httpx/punycode"
+require "httpx/domain_name"
+require "httpx/altsvc"
+require "httpx/callbacks"
+require "httpx/loggable"
+require "httpx/transcoder"
+require "httpx/timers"
+require "httpx/pool"
+require "httpx/headers"
+require "httpx/request"
+require "httpx/response"
+require "httpx/options"
+require "httpx/chainable"
+
 require "httpx/session"
 require "httpx/session_extensions"
 

data/sig/callbacks.rbs

@@ -6,7 +6,6 @@ module HTTPX
   module Callbacks
     def on: (Symbol) { (*untyped) -> void } -> self
     def once: (Symbol) { (*untyped) -> void } -> self
-    def only: (Symbol) { (*untyped) -> void } -> self
     def emit: (Symbol, *untyped) -> void
 
     def callbacks_for?: (Symbol) -> bool

data/sig/chainable.rbs

@@ -35,6 +35,10 @@ module HTTPX
               | (:circuit_breaker, ?options) -> Plugins::sessionCircuitBreaker
               | (:oauth, ?options) -> Plugins::sessionOAuth
               | (:callbacks, ?options) -> Plugins::sessionCallbacks
+              | (:content_digest, ?options) -> Plugins::sessionContentDigest
+              | (:ssrf_filter, ?options) -> Plugins::sessionSsrf
+              | (:webdav, ?options) -> Plugins::sessionWebDav
+              | (:xml, ?options) -> Plugins::sessionXML
               | (Symbol | Module, ?options) { (Class) -> void } -> Session
               | (Symbol | Module, ?options) -> Session
 

data/sig/connection/http2.rbs

@@ -28,7 +28,7 @@ module HTTPX
 
     def can_buffer_more_requests?: () -> bool
 
-    def send: (Request) -> void
+    def send: (Request request, ?bool head) -> bool
 
     def consume: () -> void
 

data/sig/connection.rbs

@@ -26,8 +26,9 @@ module HTTPX
     attr_reader pending: Array[Request]
     attr_reader options: Options
     attr_reader ssl_session: OpenSSL::SSL::Session?
-    attr_writer timers: Timers
-
+    attr_writer current_selector: Selector?
+    attr_writer coalesced_connection: instance?
+    attr_accessor current_session: Session?
     attr_accessor family: Integer?
 
     @window_size: Integer
@@ -42,9 +43,13 @@ module HTTPX
     @connected_at: Float
     @response_received_at: Float
     @intervals: Array[Timers::Interval]
+    @exhausted: bool
+    @cloned: bool
 
     def addresses: () -> Array[ipaddr]?
 
+    def peer: () -> URI::Generic
+
     def addresses=: (Array[ipaddr] addresses) -> void
 
     def send: (Request request) -> void
@@ -57,7 +62,7 @@ module HTTPX
 
     def coalescable?: (Connection connection) -> bool
 
-    def create_idle: (?Hash[Symbol, untyped] options) -> Connection
+    def create_idle: (?Hash[Symbol, untyped] options) -> instance
 
     def merge: (Connection connection) -> void
 
@@ -77,6 +82,8 @@ module HTTPX
 
     def close: () -> void
 
+    def force_reset: (?bool cloned) -> void
+
     def reset: () -> void
 
     def timeout: () -> Numeric?
@@ -99,6 +106,8 @@ module HTTPX
 
     def connect: () -> void
 
+    def disconnect: () -> void
+
     def exhausted?: () -> boolish
 
     def consume: () -> void
@@ -117,6 +126,8 @@ module HTTPX
 
     def handle_transition: (Symbol nextstate) -> void
 
+    def build_altsvc_connection: (URI::Generic alt_origin, String origin, Hash[String, String] alt_params) -> void
+
     def build_socket: (?Array[ipaddr]? addrs) -> (TCP | SSL | UNIX)
 
     def on_error: (HTTPX::TimeoutError | Error | StandardError error, ?Request? request) -> void

data/sig/errors.rbs

@@ -17,6 +17,12 @@ module HTTPX
     def initialize: (Numeric timeout, String message) -> untyped
   end
 
+  class PoolTimeoutError < TimeoutError
+    attr_reader origin: String
+
+    def initialize: (String origin, Numeric timeout) -> void
+  end
+
   class ConnectTimeoutError < TimeoutError
   end
 

data/sig/loggable.rbs

@@ -4,6 +4,8 @@ module HTTPX
   end
 
   module Loggable
+    USE_DEBUG_LOGS: bool
+
     COLORS: Hash[Symbol, Integer]
 
     def log: (?level: Integer?, ?color: Symbol?) { () -> String } -> void

data/sig/options.rbs

@@ -77,6 +77,8 @@ module HTTPX
     # classes
     attr_reader connection_class: singleton(Connection)
 
+    attr_reader pool_class: singleton(Pool)
+
     attr_reader request_class: singleton(Request)
 
     attr_reader response_class: singleton(Response)
@@ -110,6 +112,9 @@ module HTTPX
     # resolver_options
     attr_reader resolver_options: Hash[Symbol, untyped]
 
+    # resolver_options
+    attr_reader pool_options: pool_options
+
     # ip_families
     attr_reader ip_families: Array[ip_family]
 
@@ -130,6 +135,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
   end
 
   type options = Options | Hash[Symbol, untyped]

data/sig/plugins/aws_sigv4.rbs

@@ -17,8 +17,14 @@ module HTTPX
 
 
       class Signer
-
+        @credentials: Object & _SigV4Credentials
+        @service: String
+        @region: String
         @unsigned_headers: Set[String]
+        @apply_checksum_header: bool
+        @provider_prefix: String
+        @header_provider_field: String
+        @algorithm: String
 
         def sign!: (Request & RequestMethods request) -> void
 
@@ -41,7 +47,7 @@ module HTTPX
         ) -> untyped
 
 
-        def hexdigest: (bodyIO value) -> String
+        def hexdigest: (Request::Body value) -> String
 
         def hmac: (String key, String value) -> String
 

data/sig/plugins/content_digest.rbs

@@ -0,0 +1,51 @@
+module HTTPX
+  module Plugins
+    module ContentDigest
+      class Error < HTTPX::Error
+      end
+      class ValidationError < Error
+        attr_reader response: Response
+
+        def initialize: (String message, Response response) -> void
+      end
+      class MissingContentDigestError < ValidationError
+      end
+      class InvalidContentDigestError < ValidationError
+      end
+
+      SUPPORTED_ALGORITHMS: Hash[String, singleton(OpenSSL::Digest)]
+
+      interface _ContentDigestOptions
+        def digest_algorithm: () -> String
+        def encode_content_digest: () -> (bool | ^(Request) -> boolish)
+        def validate_content_digest: () -> (bool | ^(contentDigestResponse) -> boolish)
+      end
+
+      # def self.extra_options: (Options) -> contentDigestOptions
+
+      module InstanceMethods
+        private
+
+        def validate_content_digest: (Response response) -> void
+
+        def extract_content_digests: (String) -> Hash[String, String]
+
+        def base64digest: (Request::Body | contentDigestResponseBody body) -> String
+      end
+
+      module ResponseMethods
+        attr_reader body: contentDigestResponseBody
+      end
+
+      module ResponseBodyMethods
+        attr_reader content_digest_buffer: Response::Buffer?
+      end
+
+      type contentDigestOptions = Options & _ContentDigestOptions
+      type contentDigestResponse = Response & ResponseMethods
+      type contentDigestResponseBody = Response::Body & ResponseBodyMethods
+    end
+
+    type sessionContentDigest = Session & ContentDigest::InstanceMethods
+  end
+end

data/sig/plugins/cookies/cookie.rbs

@@ -17,6 +17,10 @@ module HTTPX
 
       attr_reader created_at: Time
 
+      @for_domain: bool
+
+      @domain_name: DomainName
+
       def path=: (string) -> void
 
       def domain=: (string) -> void
@@ -43,6 +47,11 @@ module HTTPX
                     | (_ToS, _ToS, ?cookie_attributes) -> untyped
 
       def acceptable_from_uri?: (uri) -> bool
+
+      module Scanner
+        RE_BAD_CHAR: Regexp
+        def self?.quote: (String s) -> String
+      end
     end
   end
 end

data/sig/plugins/grpc/call.rbs

@@ -4,6 +4,10 @@ module HTTPX
       class Call
         attr_writer decoder: _Callable
 
+        @response: Response | StreamResponse
+        @consumed: bool
+        @grpc_response: Enumerator[String] | String
+
         def metadata: () -> headers
 
         def trailing_metadata: () -> headers?

data/sig/plugins/persistent.rbs

@@ -4,8 +4,11 @@ module HTTPX
       def self.load_dependencies: (singleton(Session)) -> void
 
       def self.extra_options: (Options) -> (Options)
+
+      module InstanceMethods
+      end
     end
 
-    type sessionPersistent = sessionFollowRedirects
+    type sessionPersistent = Session & Persistent::InstanceMethods
   end
 end

data/sig/plugins/proxy/socks5.rbs

@@ -6,6 +6,14 @@ module HTTPX
     module Proxy
       module Socks5
         VERSION: Integer
+        NOAUTH: Integer
+        PASSWD: Integer
+        NONE: Integer
+        CONNECT: Integer
+        IPV4: Integer
+        DOMAIN: Integer
+        IPV6: Integer
+        SUCCESS: Integer
 
         module ConnectionMethods
           def __socks5_proxy_connect: () ->  void
@@ -31,9 +39,9 @@ module HTTPX
         end
 
         module Packet
-          def self?.negotiate: (Parameters) -> String
-          def self?.authenticate: (Parameters) -> String
-          def self?.connect: (uri) -> String
+          def self?.negotiate: (Parameters parameters) -> String
+          def self?.authenticate: (Parameters parameters) -> String
+          def self?.connect: (uri uri) -> String
         end
       end
     end

data/sig/plugins/proxy.rbs

@@ -6,15 +6,25 @@ module HTTPX
   end
 
   module Plugins
+    interface _Authenticator
+      def authenticate: (Request request, String authenticate) -> String
+    end
+
     module Proxy
       Error: singleton(HTTPProxyError)
       PROXY_ERRORS: Array[singleton(StandardError)]
 
       class Parameters
-        attr_reader uri: URI::Generic
+        attr_reader uri: URI::Generic?
         attr_reader username: String?
         attr_reader password: String?
         attr_reader scheme: String?
+        attr_reader no_proxy: Array[String]?
+
+        @uris: Array[URI::Generic | String]
+        @authenticator: _Authenticator
+
+        def shift: () -> void
 
         def can_authenticate?: (*untyped) -> boolish
 
@@ -24,15 +34,17 @@ module HTTPX
 
         private
 
-        def initialize: (uri: generic_uri, ?scheme: String, ?username: String, ?password: String, **untyped) -> untyped
+        def initialize: (?uri: generic_uri | Array[generic_uri], ?scheme: String, ?username: String, ?password: String, ?no_proxy: Array[generic_uri] | generic_uri, **untyped) -> void
+
+        def infer_default_auth_scheme: (URI::Generic uri) -> String?
+
+        def load_authenticator: (String scheme, String username, String password, **untyped) -> _Authenticator
       end
 
       def self.configure: (singleton(Session)) -> void
 
-      type proxyParam = Parameters | Hash[Symbol, untyped]
-
       interface _ProxyOptions
-        def proxy: () -> proxyParam?
+        def proxy: () -> Parameters?
       end
 
       def self.extra_options: (Options) -> (Options & _ProxyOptions)
@@ -42,12 +54,7 @@ module HTTPX
 
         private
 
-        def proxy_error?: (Request request, response) -> bool
-
-        def proxy_options: (http_uri request_uri, Options & _ProxyOptions options) -> (Options & _ProxyOptions)
-      end
-
-      module ConnectionMethods
+        def proxy_error?: (Request request, response, Options options) -> bool
       end
     end
 

data/sig/plugins/push_promise.rbs

@@ -2,11 +2,14 @@ module HTTPX
   module Plugins
     module PushPromise
       module ResponseMethods
+        @__pushed: bool?
+
         def pushed?: () -> boolish
         def mark_as_pushed!: () -> void
       end
 
       module InstanceMethods
+        @promise_headers: Hash[::HTTP2::Stream, Request]?
         private
 
         def promise_headers: () -> Hash[::HTTP2::Stream, Request]

data/sig/plugins/rate_limiter.rbs

@@ -1,6 +1,8 @@
 module HTTPX
   module Plugins
     module RateLimiter
+      RATE_LIMIT_CODES: Array[Integer]
+
       def self.load_dependencies: (singleton(Session)) -> void
 
       def self.retry_on_rate_limited_response: (_Response) -> bool

data/sig/plugins/retries.rbs

@@ -29,7 +29,7 @@ module HTTPX
 
         private
 
-        def fetch_response: (retriesRequest request, Array[Connection] connections, retriesOptions options) -> (retriesResponse | ErrorResponse)?
+        def fetch_response: (retriesRequest request, Selector selector, retriesOptions options) -> (retriesResponse | ErrorResponse)?
 
         def __repeatable_request?: (retriesRequest request, retriesOptions options) -> boolish
 

data/sig/plugins/ssrf_filter.rbs

@@ -0,0 +1,26 @@
+module HTTPX
+  class ServerSideRequestForgeryError < Error
+  end
+
+  module Plugins
+    module SsrfFilter
+      IPV4_BLACKLIST: Array[IPAddr]
+
+      IPV6_BLACKLIST: Array[[IPAddr, IPAddr]]
+
+      def self?.unsafe_ip_address?: (IPAddr) -> bool
+
+      interface _Options
+        def allowed_schemes: () -> Array[String]
+      end
+
+      module InstanceMethods
+      end
+
+      module ConnectionMethods
+      end
+    end
+
+    type sessionSsrf = Session & SsrfFilter::InstanceMethods
+  end
+end

data/sig/plugins/webdav.rbs

@@ -0,0 +1,23 @@
+module HTTPX
+  module Plugins
+    module WebDav
+      module InstanceMethods
+        def copy: (String src, String dst) -> (Response | ErrorResponse)
+
+        def move: (String src, String dst) -> (Response | ErrorResponse)
+
+        def lock: (String path, ?timeout: Numeric) ?{ (Response response) -> void } -> (Response | ErrorResponse)
+
+        def unlock: (String path, String? lock_token) -> (Response | ErrorResponse)
+
+        def mkcol: (String dir) -> Response
+
+        def propfind: (String path, ?(:acl | String) xml) -> Response
+
+        def proppatch: (String path, String xml) -> Response
+      end
+    end
+
+    type sessionWebDav = Session & WebDav::InstanceMethods
+  end
+end

data/sig/plugins/xml.rbs

@@ -0,0 +1,37 @@
+module HTTPX
+  module Plugins
+    module XML
+      MIME_TYPES: Regexp
+
+      module Transcoder
+        def self?.encode: (Nokogiri::XML::Node | String xml) -> Encoder
+        def self?.decode: (HTTPX::Response response) -> HTTPX::Transcoder::_Decoder
+
+        class Encoder
+          @raw: Nokogiri::XML::Node | String # can be nokogiri object
+
+          def content_type: () -> String
+
+          def bytesize: () -> (Integer | Float)
+
+          def to_s: () -> String
+
+          private
+
+          def initialize: (Nokogiri::XML::Node | String xml) -> void
+        end
+      end
+
+      module InstanceMethods
+      end
+
+      module ResponseMethods
+        def xml: () -> Nokogiri::XML::Node
+      end
+
+      module RequestBodyClassMethods
+      end
+    end
+    type sessionXML = Session & XML::InstanceMethods
+  end
+end

data/sig/pool.rbs

@@ -1,52 +1,44 @@
 module HTTPX
+  type pool_options = {
+    max_connections_per_origin: Integer?,
+    pool_timeout: Numeric?
+  }
+
   class Pool
     type resolver_manager = Resolver::Multi | Resolver::System
 
-    @resolvers: Hash[Class, resolver_manager]
-    @timers: Timers
-    @selector: Selector
-    @connections: Array[Connection]
+    @max_connections_per_origin: Integer
+    @pool_timeout: Numeric
+    @options: Options
+    @resolvers: Hash[Class, Array[resolver_manager]]
+    @resolver_mtx: Thread::Mutex
+    @connections: Hash[String, Array[Connection]]
+    @connection_mtx: Thread::Mutex
+    @origin_counters: Hash[String, Integer]
+    @origin_conds: Hash[String, ConditionVariable]
 
-    def wrap: () { (instance) -> void } -> void
+    def pop_connection: () -> Connection?
 
-    def empty?: () -> void
+    def checkout_connection: (http_uri uri, Options options) -> Connection
 
-    def next_tick: () -> void
+    def checkin_connection: (Connection connection) -> void
 
-    def close: (?Array[Connection] connections) -> void
+    def checkout_mergeable_connection: (Connection connection) -> Connection?
 
-    def init_connection: (Connection connection, Options options) -> void
+    def reset_resolvers: () -> void
 
-    def find_connection: (URI::Generic uri, Options options) -> Connection?
+    def checkout_resolver: (Options options) -> resolver_manager
 
-    def deactivate: (*Connection connections) -> void
+    def checkin_resolver: (Resolver::Resolver resolver) -> void
 
     private
 
-    def initialize: () -> void
-
-    def try_clone_connection: (Connection connection, Integer? family) -> Connection
-
-    def resolve_connection: (Connection) -> void
-
-    def on_resolver_connection: (Connection) -> void
-
-    def on_resolver_error: (Connection, StandardError) -> void
-
-    def on_resolver_close: (Resolver::Resolver) -> void
-
-    def register_connection: (Connection) -> void
-
-    def unregister_connection: (Connection, ?bool cleanup) -> void
-
-    def select_connection: (Selector::selectable) -> void
-
-    def deselect_connection: (Selector::selectable) -> Selector::selectable?
+    def initialize: (pool_options options) -> void
 
-    def coalesce_connections: (Connection coalescable, Connection coalescing) -> void
+    def acquire_connection: (http_uri uri, Options options) -> Connection?
 
-    def next_timeout: () -> Numeric?
+    def checkout_new_connection: (http_uri uri, Options options) -> Connection
 
-    def find_resolver_for: (Connection) { (Resolver::Resolver resolver) -> void } -> resolver_manager
+    def checkout_new_resolver: (Class resolver_type, Options options) -> resolver_manager
   end
 end

data/sig/request/body.rbs

@@ -1,10 +1,12 @@
 module HTTPX
   class Request::Body
+    attr_reader options: Options
+
     @headers: Headers
     @body: body_encoder?
     @unbounded_body: bool
 
-    def initialize: (Headers headers, Options options, ?body: bodyIO, ?form: Transcoder::urlencoded_input?, ?json: _ToJson?, **untyped) -> void
+    def initialize: (Headers h, Options options, **untyped) -> void
 
     def each: () { (String) -> void } -> void
             | () -> Enumerable[String]
@@ -25,6 +27,8 @@ module HTTPX
 
     private
 
+    def self.initialize_body: (Hash[Symbol, untyped] params) -> body_encoder?
+
     def self.initialize_deflater_body: (body_encoder body, Encoding | String encoding) -> body_encoder
   end
 

data/sig/resolver/multi.rbs

@@ -1,7 +1,32 @@
 module HTTPX
   module Resolver
     class Multi
-      def early_resolve: (Connection connection, ?hostname: String) -> void
+      attr_reader resolvers: Array[Native | HTTPS]
+
+      attr_reader options: Options
+
+      @current_selector: Selector?
+      @current_session: Session?
+      @resolver_options: Hash[Symbol, untyped]
+      # @errors: Hash[Symbol, untyped]
+
+      def current_selector=: (Selector s) -> void
+
+      def current_session=: (Session s) -> void
+
+      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
     end
   end
 end