httpx 1.3.3 → 1.4.0

data/sig/resolver/native.rbs

@@ -7,8 +7,6 @@ module HTTPX
       DEFAULTS: Hash[Symbol, untyped]
       DNS_PORT: Integer
 
-      attr_reader family: ip_family
-
       @options: Options
       @ns_index: Integer
       @nameserver: Array[String]

data/sig/resolver/resolver.rbs

@@ -6,8 +6,17 @@ module HTTPX
 
       RECORD_TYPES: Hash[Integer, singleton(Resolv::DNS::Resource)]
 
+      attr_reader family: ip_family
+
+      attr_reader options: Options
+
+      attr_writer current_selector: Selector?
+
+      attr_writer current_session: Session?
+
+      attr_accessor multi: Multi?
+
       @record_type: singleton(Resolv::DNS::Resource)
-      @options: Options
       @resolver_options: Hash[Symbol, untyped]
       @queries: Hash[String, Connection]
       @system_resolver: Resolv::Hosts
@@ -20,6 +29,8 @@ module HTTPX
 
       def empty?: () -> bool
 
+      def each_connection: () { (Connection connection) -> void } -> void
+
       def emit_addresses: (Connection connection, ip_family family, Array[IPAddr], ?bool early_resolve) -> void
 
       private
@@ -28,7 +39,15 @@ module HTTPX
 
       def initialize: (ip_family? family, Options options) -> void
 
-      def early_resolve: (Connection connection, ?hostname: String) -> boolish
+      def early_resolve: (Connection connection, ?hostname: String) -> bool
+
+      def set_resolver_callbacks: () -> void
+
+      def resolve_connection: (Connection connection) -> void
+
+      def emit_connection_error: (Connection connection, StandardError error) -> void
+
+      def close_resolver: (Resolver resolver) -> void
 
       def emit_resolve_error: (Connection connection, ?String hostname, ?StandardError) -> void
 

data/sig/resolver.rbs

@@ -28,12 +28,16 @@ module HTTPX
 
     def self?.cached_lookup_set: (String hostname, ip_family family, Array[dns_result] addresses) -> void
 
-    def self?.lookup: (String hostname, Numeric ttl) -> Array[IPAddr]?
+    def self?.lookup: (String hostname, Hash[String, Array[dns_result]] lookups, Numeric ttl) -> Array[IPAddr]?
 
     def self?.generate_id: () -> Integer
 
     def self?.encode_dns_query: (String hostname, ?type: dns_resource, ?message_id: Integer) -> String
 
     def self?.decode_dns_answer: (String) -> dns_decoding_response
+
+    def self?.lookup_synchronize: [U] () { (Hash[String, Array[dns_result]] lookups) -> U } -> U
+
+    def self?.id_synchronize: () { () -> void } -> void
   end
 end

data/sig/response/body.rbs

@@ -4,8 +4,8 @@ module HTTPX
     include _ToS
     include _ToStr
 
-    attr_reader encoding: Encoding | String
-    attr_reader encodings: Array[Encoding | String]
+    attr_reader encoding: Encoding
+    attr_reader encodings: Array[String]
 
     @response: Response
     @headers: Headers

data/sig/response/buffer.rbs

@@ -5,11 +5,11 @@ module HTTPX
     @encoding: Encoding
     @buffer: StringIO | Tempfile
 
-    def initialize: (threshold_size: Integer, ?bytesize: Integer, ?encoding: Encoding | String) -> void
+    def initialize: (threshold_size: Integer, ?bytesize: Integer, ?encoding: Encoding) -> void
 
     def size: () -> Integer
 
-    def write: (String) -> void
+    def write: (String chunk) -> Integer
 
     def to_s: () -> String
 

data/sig/selector.rbs

@@ -1,22 +1,48 @@
 module HTTPX
+  type selectable = Connection | Resolver::Native
+
   class Selector
-    type selectable = Connection | Resolver::Native | Resolver::System
+    include _Each[selectable]
 
     READABLE: Array[Symbol]
     WRITABLE: Array[Symbol]
+
+    @timers: Timers
+
     @selectables: Array[selectable]
 
+    def next_tick: () -> void
+
+    def terminate: () -> void
+
+    def find_resolver: (Options options) -> Resolver::Resolver?
+
+    def find_connection: (http_uri request_uri, Options options) -> Connection?
+
+    def each_connection: () { (Connection) -> void} -> void
+                       | () -> Enumerable[Connection]
+
+    def find_mergeable_connection: (Connection connection) -> Connection?
+
+    def empty?: () -> bool
+
     def register: (selectable io) -> void
-    def deregister: (selectable io) -> selectable?
 
-    def select: (Numeric? interval) { (selectable) -> void } -> void
+    def deregister: (selectable io) -> selectable?
 
     private
 
-    def initialize: () -> untyped
+    def initialize: () -> void
+
+    def select: (Numeric? interval) { (selectable) -> void } -> void
 
     def select_many: (Numeric? interval) { (selectable) -> void } -> void
+
     def select_one: (Numeric? interval) { (selectable) -> void } -> void
+
+    def next_timeout: () -> Numeric?
+
+    def emit_error: (StandardError e) -> void
   end
 
   type io_interests = :r | :w | :rw

data/sig/session.rbs

@@ -7,40 +7,50 @@ module HTTPX
 
     @options: Options
     @responses: Hash[Request, response]
-    @persistent: bool?
+
+    # returns the HTTPX::Pool object which manages the networking required to
+    # perform requests.
+    @pool: Pool
+
+    @persistent: bool
+    @wrapped: bool
 
     def self.plugin: (Symbol | Module plugin, ?options? options) ?{ (Class) -> void } -> singleton(Session)
 
     def wrap: () { (instance) -> void } -> void
 
-    def close: (*untyped) -> void
+    def close: (?Selector selector) -> void
 
     def build_request: (verb verb, generic_uri uri, ?request_params params, ?Options options) -> Request
 
-    def initialize: (?options) { (self) -> void } -> void
-                  | (?options) -> void
+    def select_connection: (Connection connection, Selector selector) -> void
 
-    private
+    def deselect_connection: (Connection connection, Selector selector, ?bool cloned) -> void
 
-    def pool: -> Pool
+    def select_resolver: (Resolver::Native | Resolver::HTTPS resolver, Selector selector) -> void
 
-    def on_response: (Request, response) -> void
+    def deselect_resolver: (Resolver::Resolver resolver, Selector selector) -> void
 
-    def on_promise: (untyped, untyped) -> void
+    def try_clone_connection: (Connection connection, Selector selector, Integer? family) -> Connection
 
-    def fetch_response: (Request request, Array[Connection] connections, untyped options) -> response?
+    def find_connection: (http_uri request_uri, Selector selector, Options options) -> Connection
 
-    def find_connection: (Request request, Array[Connection] connections, Options options) -> Connection
+    private
 
-    def deactivate_connection: (Request request, Array[Connection] connections, Options options) -> void
+    def initialize: (?options) { (self) -> void } -> void
+                  | (?options) -> void
 
-    def send_request: (Request request, Array[Connection] connections, ?Options options) -> void
+    def deactivate: (Selector selector) -> void
 
-    def set_connection_callbacks: (Connection connection, Array[Connection] connections, Options options, ?cloned: bool) -> void
+    def on_response: (Request, response) -> void
 
-    def set_request_callbacks: (Request request) -> void
+    def on_promise: (untyped, untyped) -> void
+
+    def fetch_response: (Request request, Selector selector, Options options) -> response?
+
+    def send_request: (Request request, Selector selector, ?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 & AltSvc::ConnectionMixin)?
+    def set_request_callbacks: (Request request) -> void
 
     def build_requests: (verb, uri, request_params) -> Array[Request]
                       | (Array[[verb, uri, request_params]], Hash[Symbol, untyped]) -> Array[Request]
@@ -48,13 +58,30 @@ module HTTPX
                       | (verb, _Each[[uri, request_params]], Hash[Symbol, untyped]) -> Array[Request]
                       | (verb, _Each[uri], request_params) -> Array[Request]
 
-    def init_connection: (http_uri uri, Options options) -> Connection
+    def do_init_connection: (Connection connection, Selector selector) -> void
 
     def send_requests: (*Request) -> Array[response]
 
-    def _send_requests: (Array[Request] requests) -> Array[Connection]
+    def _send_requests: (Array[Request] requests, Selector selector) -> void
+
+    def receive_requests: (Array[Request] requests, Selector selector) -> Array[response]
+
+    def resolve_connection: (Connection connection, Selector selector) -> void
+
+    def on_resolver_connection: (Connection connection, Selector selector) -> void
+
+    def on_resolver_close: (Resolver::Resolver resolver, Selector selector) -> void
+
+    def find_resolver_for: (Connection connection, Selector selector) -> (Resolver::Multi | Resolver::Resolver)
+
+    def coalesce_connections: (Connection conn1, Connection conn2, Selector selector, bool from_pool) -> bool
+
+    def get_current_selector: () -> Selector?
+                            | () { () -> Selector } -> Selector
+
+    def set_current_selector: (Selector? selector) -> void
 
-    def receive_requests: (Array[Request] requests, Array[Connection] connections) -> Array[response]
+    def selector_store: () -> Hash[instance, Selector]
 
     attr_reader self.default_options: Options
   end

data/sig/transcoder/body.rbs

@@ -7,7 +7,7 @@ module HTTPX
       class Encoder
         extend Forwardable
 
-        @raw: bodyIO
+        @raw: Object & bodyIO
 
         def bytesize: () -> (Integer | Float)
 

data/sig/transcoder/chunker.rbs

@@ -8,7 +8,7 @@ module HTTPX::Transcoder
     def self?.encode: (_Each[String] chunks) -> Encoder
 
     class Encoder
-      @raw: _Each[String]
+      @raw: Object & _Each[String]
 
       def each: () { (String) -> void } -> void
               | () -> Enumerator[String, void]

data/sig/transcoder/deflate.rbs

@@ -5,6 +5,7 @@ module HTTPX
       def self?.decode: (Response body, ?bytesize: Integer) -> GZIP::Inflater
 
       class Deflater < Transcoder::Deflater
+        @deflater: Zlib::Deflate
       end
     end
   end

data/sig/transcoder/form.rbs

@@ -6,6 +6,8 @@ module HTTPX::Transcoder
   type urlencoded_input = Enumerable[[_ToS, form_nested_value | Multipart::multipart_nested_value]]
 
   module Form
+    PARAM_DEPTH_LIMIT: Integer
+
     def self?.encode: (urlencoded_input form) -> (Encoder | Multipart::Encoder)
     def self?.decode: (HTTPX::Response response) -> _Decoder
     def self?.multipart?: (form_nested_value | Multipart::multipart_nested_value data) -> bool
@@ -14,6 +16,8 @@ module HTTPX::Transcoder
       extend Forwardable
       include _ToS
 
+      @raw: String
+
       def bytesize: () -> Integer
 
       def content_type: () -> String
@@ -22,5 +26,9 @@ module HTTPX::Transcoder
 
       def initialize: (urlencoded_input form) -> untyped
     end
+
+    module Decoder
+      def self?.call: (HTTPX::Response response, *untyped) -> Hash[String, untyped]
+    end
   end
 end

data/sig/transcoder/gzip.rbs

@@ -1,7 +1,7 @@
 module HTTPX
   module Transcoder
     module GZIP
-      def self?.encode: (_Encoder body) -> Deflater
+      def self?.encode: (body_encoder body) -> Deflater
       def self?.decode: (Response response, ?bytesize: Integer) -> Inflater
 
       class Deflater < Transcoder::Deflater
@@ -15,6 +15,9 @@ module HTTPX
       end
 
       class Inflater
+        @inflater: Zlib::Inflate
+        @bytesize: Integer
+
         def initialize: (Integer | Float bytesize) -> void
 
         def call: (String chunk) -> String

data/sig/transcoder/multipart.rbs

@@ -9,7 +9,7 @@ module HTTPX
 
       MULTIPART_VALUE_COND: ^(_Reader | record_multipart_value value) -> bool
 
-      type multipart_value = string | Pathname | File | _Reader
+      type multipart_value = string | Pathname | File | Tempfile | _Reader
 
       type record_multipart_value = { content_type: String, filename: String, body: multipart_value } |
                                     { content_type: String, body: multipart_value }
@@ -83,13 +83,13 @@ module HTTPX
 
       module Part
         def self?.call: [U] (Object & _MultipartInput multipart_input) -> [U, String, String]
-                      | (Object & multipart_nested_value input) -> ([StringIO, String, String?] | [File, String, String])
+                      | (multipart_nested_value value) -> ([StringIO, String, String?] | [File | Tempfile, String, String])
       end
 
       module MimeTypeDetector
         DEFAULT_MIMETYPE: String
 
-        def self?.call: (::IO file, String filename) -> String?
+        def self?.call: (::IO | Tempfile file, String filename) -> String?
       end
     end
   end

data/sig/transcoder/utils/body_reader.rbs

@@ -1,9 +1,9 @@
 module HTTPX
   module Transcoder
     class BodyReader
-      @body: _Reader | _Each[String]
+      @body: Object & (_Reader | _Each[String])
 
-      def initialize: (bodyIO body) -> void
+      def initialize: (body_encoder body) -> void
 
       def bytesize: () -> (Integer | Float)
 

data/sig/transcoder/utils/deflater.rbs

@@ -5,12 +5,12 @@ module HTTPX
 
       @body: BodyReader
       @buffer: Response::Buffer?
-      @body: _Encoder | StringIO
+      @body: BodyReader
       @closed: bool
 
       attr_reader content_type: String
 
-      def initialize: (_Encoder body) -> void
+      def initialize: (body_encoder body) -> void
 
       def bytesize: () -> (Integer | Float)
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: httpx
 version: !ruby/object:Gem::Version
-  version: 1.3.3
+  version: 1.4.0
 platform: ruby
 authors:
 - Tiago Cardoso
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-10-31 00:00:00.000000000 Z
+date: 2024-12-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http-2
@@ -148,6 +148,8 @@ extra_rdoc_files:
 - doc/release_notes/1_3_1.md
 - doc/release_notes/1_3_2.md
 - doc/release_notes/1_3_3.md
+- doc/release_notes/1_3_4.md
+- doc/release_notes/1_4_0.md
 files:
 - LICENSE.txt
 - README.md
@@ -267,6 +269,8 @@ files:
 - doc/release_notes/1_3_1.md
 - doc/release_notes/1_3_2.md
 - doc/release_notes/1_3_3.md
+- doc/release_notes/1_3_4.md
+- doc/release_notes/1_4_0.md
 - lib/httpx.rb
 - lib/httpx/adapters/datadog.rb
 - lib/httpx/adapters/faraday.rb
@@ -305,6 +309,7 @@ files:
 - lib/httpx/plugins/circuit_breaker.rb
 - lib/httpx/plugins/circuit_breaker/circuit.rb
 - lib/httpx/plugins/circuit_breaker/circuit_store.rb
+- lib/httpx/plugins/content_digest.rb
 - lib/httpx/plugins/cookies.rb
 - lib/httpx/plugins/cookies/cookie.rb
 - lib/httpx/plugins/cookies/jar.rb
@@ -337,6 +342,7 @@ files:
 - lib/httpx/plugins/upgrade.rb
 - lib/httpx/plugins/upgrade/h2.rb
 - lib/httpx/plugins/webdav.rb
+- lib/httpx/plugins/xml.rb
 - lib/httpx/pmatch_extensions.rb
 - lib/httpx/pool.rb
 - lib/httpx/punycode.rb
@@ -371,7 +377,6 @@ files:
 - lib/httpx/transcoder/utils/body_reader.rb
 - lib/httpx/transcoder/utils/deflater.rb
 - lib/httpx/transcoder/utils/inflater.rb
-- lib/httpx/transcoder/xml.rb
 - lib/httpx/utils.rb
 - lib/httpx/version.rb
 - sig/altsvc.rbs
@@ -405,6 +410,7 @@ files:
 - sig/plugins/callbacks.rbs
 - sig/plugins/circuit_breaker.rbs
 - sig/plugins/compression.rbs
+- sig/plugins/content_digest.rbs
 - sig/plugins/cookies.rbs
 - sig/plugins/cookies/cookie.rbs
 - sig/plugins/cookies/jar.rbs
@@ -428,8 +434,11 @@ files:
 - sig/plugins/rate_limiter.rbs
 - sig/plugins/response_cache.rbs
 - sig/plugins/retries.rbs
+- sig/plugins/ssrf_filter.rbs
 - sig/plugins/stream.rbs
 - sig/plugins/upgrade.rbs
+- sig/plugins/webdav.rbs
+- sig/plugins/xml.rbs
 - sig/pool.rbs
 - sig/request.rbs
 - sig/request/body.rbs
@@ -456,7 +465,6 @@ files:
 - sig/transcoder/utils/body_reader.rbs
 - sig/transcoder/utils/deflater.rbs
 - sig/transcoder/utils/inflater.rbs
-- sig/transcoder/xml.rbs
 - sig/utils.rbs
 homepage: https://gitlab.com/os85/httpx
 licenses:

data/lib/httpx/transcoder/xml.rb

@@ -1,52 +0,0 @@
-# frozen_string_literal: true
-
-require "delegate"
-require "forwardable"
-require "uri"
-
-module HTTPX::Transcoder
-  module Xml
-    module_function
-
-    MIME_TYPES = %r{\b(application|text)/(.+\+)?xml\b}.freeze
-
-    class Encoder
-      def initialize(xml)
-        @raw = xml
-      end
-
-      def content_type
-        charset = @raw.respond_to?(:encoding) ? @raw.encoding.to_s.downcase : "utf-8"
-        "application/xml; charset=#{charset}"
-      end
-
-      def bytesize
-        @raw.to_s.bytesize
-      end
-
-      def to_s
-        @raw.to_s
-      end
-    end
-
-    def encode(xml)
-      Encoder.new(xml)
-    end
-
-    begin
-      require "nokogiri"
-
-      def decode(response)
-        content_type = response.content_type.mime_type
-
-        raise HTTPX::Error, "invalid form mime type (#{content_type})" unless MIME_TYPES.match?(content_type)
-
-        Nokogiri::XML.method(:parse)
-      end
-    rescue LoadError
-      def decode(_response)
-        raise HTTPX::Error, "\"nokogiri\" is required in order to decode XML"
-      end
-    end
-  end
-end

data/sig/transcoder/xml.rbs

@@ -1,22 +0,0 @@
-module HTTPX::Transcoder
-  module Xml
-    MIME_TYPES: Regexp
-
-    def self?.encode: (untyped xml) -> Encoder
-    def self?.decode: (HTTPX::Response response) -> _Decoder
-
-    class Encoder
-      @raw: untyped # can be nokogiri object
-
-      def content_type: () -> String
-
-      def bytesize: () -> (Integer | Float)
-
-      def to_s: () -> String
-
-      private
-
-      def initialize: (String xml) -> void
-    end
-  end
-end