httpx 1.1.5 → 1.2.0

data/sig/connection.rbs

@@ -44,25 +44,23 @@ module HTTPX
 
     def addresses: () -> Array[ipaddr]?
 
-    def addresses=: (Array[ipaddr]) -> void
+    def addresses=: (Array[ipaddr] addresses) -> void
+
+    def send: (Request request) -> void
 
     def match?: (URI::Generic uri, Options options) -> bool
 
     def expired?: () -> boolish
 
-    def mergeable?: (Connection) -> bool
+    def mergeable?: (Connection connection) -> bool
 
-    def coalescable?: (Connection) -> bool
+    def coalescable?: (Connection connection) -> bool
 
     def create_idle: (?Hash[Symbol, untyped] options) -> Connection
 
-    def merge: (Connection) -> void
-
-    def purge_pending: () { (Request) -> void } -> void
-
-    def match_altsvcs?: (URI::Generic uri) -> bool
+    def merge: (Connection connection) -> void
 
-    def match_altsvc_options?: (URI::Generic uri, Options options) -> bool
+    def purge_pending: () { (Request request) -> void } -> void
 
     def connecting?: () -> bool
 
@@ -74,12 +72,12 @@ module HTTPX
 
     def call: () -> void
 
+    def terminate: () -> void
+
     def close: () -> void
 
     def reset: () -> void
 
-    def send: (Request) -> void
-
     def timeout: () -> Numeric?
 
     def idling: () -> void
@@ -94,7 +92,9 @@ module HTTPX
 
     private
 
-    def initialize: (io_type, URI::Generic, options) -> untyped
+    def initialize: (URI::Generic uri, options) -> void
+
+    def initialize_type: (URI::Generic uri, options) -> io_type
 
     def connect: () -> void
 
@@ -112,15 +112,15 @@ module HTTPX
 
     def set_parser_callbacks: (HTTP1 | HTTP2 parser) -> void
 
-    def transition: (Symbol) -> void
+    def transition: (Symbol nextstate) -> void
 
-    def handle_transition: (Symbol) -> void
+    def handle_transition: (Symbol nextstate) -> void
 
     def build_socket: (?Array[ipaddr]? addrs) -> (TCP | SSL | UNIX)
 
-    def on_error: (HTTPX::TimeoutError | Error | StandardError) -> void
+    def on_error: (HTTPX::TimeoutError | Error | StandardError error) -> void
 
-    def handle_error: (StandardError) -> void
+    def handle_error: (StandardError error) -> void
 
     def purge_after_closed: () -> void
 

data/sig/options.rbs

@@ -9,9 +9,11 @@ module HTTPX
     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 | :read_timeout | :write_timeout | :request_timeout
+    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
@@ -120,10 +122,16 @@ 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]

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 | 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/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/follow_redirects.rbs

@@ -12,6 +12,8 @@ module HTTPX
         def follow_insecure_redirects: () -> bool?
 
         def allow_auth_to_other_origins: () -> bool?
+
+        def redirect_on: (http_uri) -> bool?
       end
 
       def self.extra_options: (Options) -> (Options & _FollowRedirectsOptions)

data/sig/plugins/proxy/socks4.rbs

@@ -1,5 +1,6 @@
 module HTTPX
-  Socks4Error: singleton(Error)
+  class Socks4Error < HTTPProxyError
+  end
 
   module Plugins
     module Proxy

data/sig/plugins/proxy/socks5.rbs

@@ -1,5 +1,6 @@
 module HTTPX
-  Socks5Error: singleton(Error)
+  class Socks5Error < HTTPProxyError
+  end
 
   module Plugins
     module Proxy

data/sig/plugins/proxy.rbs

@@ -1,5 +1,8 @@
 module HTTPX
-  class HTTPProxyError < Error
+  class HTTPProxyError < ConnectionError
+  end
+
+  class ProxySSL < SSL
   end
 
   module Plugins
@@ -36,6 +39,13 @@ module HTTPX
 
       module InstanceMethods
         @__proxy_uris: Array[generic_uri]
+
+        private
+
+        def proxy_error?: (Request request, response) -> bool
+      end
+
+      module ConnectionMethods
       end
     end
 

data/sig/pool.rbs

@@ -6,8 +6,6 @@ module HTTPX
     @timers: Timers
     @selector: Selector
     @connections: Array[Connection]
-    @eden_connections: Array[Connection]
-    @connected_connections: Integer
 
     def empty?: () -> void
 
@@ -37,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
 

data/sig/resolver/resolver.rbs

@@ -14,6 +14,8 @@ module HTTPX
 
       def close: () -> void
 
+      alias terminate close
+
       def closed?: () -> bool
 
       def empty?: () -> bool
@@ -22,7 +24,7 @@ module HTTPX
 
       private
 
-      def emit_resolved_connection: (Connection connection, Array[IPAddr] addresses) -> void
+      def emit_resolved_connection: (Connection connection, Array[IPAddr] addresses, bool early_resolve) -> void
 
       def initialize: (ip_family? family, options options) -> void
 

data/sig/session.rbs

@@ -33,7 +33,9 @@ module HTTPX
 
     def set_connection_callbacks: (Connection connection, Array[Connection] connections, Options options) -> void
 
-    def build_altsvc_connection: (Connection existing_connection, Array[Connection] connections, URI::Generic alt_origin, String origin, Hash[String, String] alt_params, Options options) -> Connection?
+    def set_request_callbacks: (Request request) -> void
+
+    def build_altsvc_connection: (Connection existing_connection, Array[Connection] connections, URI::Generic alt_origin, String origin, Hash[String, String] alt_params, Options options) -> (Connection & AltSvc::ConnectionMixin)?
 
     def build_requests: (verb, uri, options) -> Array[Request]
                       | (Array[[verb, uri, options]], options) -> Array[Request]
@@ -41,9 +43,7 @@ module HTTPX
                       | (verb, _Each[[uri, options]], Options) -> Array[Request]
                       | (verb, _Each[uri], options) -> Array[Request]
 
-    def build_connection: (URI::HTTP | URI::HTTP uri, Options options) -> Connection
-
-    def init_connection: (String type, URI::HTTP | URI::HTTP uri, Options options) -> Connection
+    def init_connection: (URI::HTTP | URI::HTTP uri, Options options) -> Connection
 
     def send_requests: (*Request) -> Array[response]
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: httpx
 version: !ruby/object:Gem::Version
-  version: 1.1.5
+  version: 1.2.0
 platform: ruby
 authors:
 - Tiago Cardoso
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-11-23 00:00:00.000000000 Z
+date: 2023-12-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http-2-next
@@ -137,6 +137,7 @@ extra_rdoc_files:
 - doc/release_notes/1_1_3.md
 - doc/release_notes/1_1_4.md
 - doc/release_notes/1_1_5.md
+- doc/release_notes/1_2_0.md
 files:
 - LICENSE.txt
 - README.md
@@ -245,6 +246,7 @@ files:
 - doc/release_notes/1_1_3.md
 - doc/release_notes/1_1_4.md
 - doc/release_notes/1_1_5.md
+- doc/release_notes/1_2_0.md
 - lib/httpx.rb
 - lib/httpx/adapters/datadog.rb
 - lib/httpx/adapters/faraday.rb
@@ -279,6 +281,7 @@ files:
 - lib/httpx/plugins/aws_sigv4.rb
 - lib/httpx/plugins/basic_auth.rb
 - lib/httpx/plugins/brotli.rb
+- lib/httpx/plugins/callbacks.rb
 - lib/httpx/plugins/circuit_breaker.rb
 - lib/httpx/plugins/circuit_breaker/circuit.rb
 - lib/httpx/plugins/circuit_breaker/circuit_store.rb
@@ -309,6 +312,7 @@ files:
 - lib/httpx/plugins/response_cache/file_store.rb
 - lib/httpx/plugins/response_cache/store.rb
 - lib/httpx/plugins/retries.rb
+- lib/httpx/plugins/ssrf_filter.rb
 - lib/httpx/plugins/stream.rb
 - lib/httpx/plugins/upgrade.rb
 - lib/httpx/plugins/upgrade/h2.rb
@@ -350,6 +354,7 @@ files:
 - lib/httpx/transcoder/xml.rb
 - lib/httpx/utils.rb
 - lib/httpx/version.rb
+- sig/altsvc.rbs
 - sig/buffer.rbs
 - sig/callbacks.rbs
 - sig/chainable.rbs
@@ -377,6 +382,7 @@ files:
 - sig/plugins/aws_sigv4.rbs
 - sig/plugins/basic_auth.rbs
 - sig/plugins/brotli.rbs
+- sig/plugins/callbacks.rbs
 - sig/plugins/circuit_breaker.rbs
 - sig/plugins/compression.rbs
 - sig/plugins/cookies.rbs
@@ -437,8 +443,8 @@ licenses:
 - Apache 2.0
 metadata:
   bug_tracker_uri: https://gitlab.com/os85/httpx/issues
-  changelog_uri: https://os85.gitlab.io/httpx/#release-notes
-  documentation_uri: https://os85.gitlab.io/httpx/rdoc/
+  changelog_uri: https://honeyryderchuck.gitlab.io/httpx/#release-notes
+  documentation_uri: https://honeyryderchuck.gitlab.io/httpx/rdoc/
   source_code_uri: https://gitlab.com/os85/httpx
   homepage_uri: https://honeyryderchuck.gitlab.io/httpx/
   rubygems_mfa_required: 'true'