httpx 1.2.6 → 1.3.1

data/lib/httpx/request.rb

@@ -46,12 +46,43 @@ module HTTPX
     # will be +true+ when request body has been completely flushed.
     def_delegator :@body, :empty?
 
-    # initializes the instance with the given +verb+, an absolute or relative +uri+, and the
-    # request options.
-    def initialize(verb, uri, options = {})
+    # initializes the instance with the given +verb+ (an upppercase String, ex. 'GEt'),
+    # an absolute or relative +uri+ (either as String or URI::HTTP object), the
+    # request +options+ (instance of HTTPX::Options) and an optional Hash of +params+.
+    #
+    # Besides any of the options documented in HTTPX::Options (which would override or merge with what
+    # +options+ sets), it accepts also the following:
+    #
+    # :params :: hash or array of key-values which will be encoded and set in the query string of request uris.
+    # :body :: to be encoded in the request body payload. can be a String, an IO object (i.e. a File), or an Enumerable.
+    # :form :: hash of array of key-values which will be form-urlencoded- or multipart-encoded in requests body payload.
+    # :json :: hash of array of key-values which will be JSON-encoded in requests body payload.
+    # :xml :: Nokogiri XML nodes which will be encoded in requests body payload.
+    #
+    # :body, :form, :json and :xml are all mutually exclusive, i.e. only one of them gets picked up.
+    def initialize(verb, uri, options, params = EMPTY_HASH)
       @verb    = verb.to_s.upcase
-      @options = Options.new(options)
       @uri     = Utils.to_uri(uri)
+
+      @headers = options.headers.dup
+      merge_headers(params.delete(:headers)) if params.key?(:headers)
+
+      @headers["user-agent"] ||= USER_AGENT
+      @headers["accept"]     ||= "*/*"
+
+      # forego compression in the Range request case
+      if @headers.key?("range")
+        @headers.delete("accept-encoding")
+      else
+        @headers["accept-encoding"] ||= options.supported_compression_formats
+      end
+
+      @query_params = params.delete(:params) if params.key?(:params)
+
+      @body = options.request_body_class.new(@headers, options, **params)
+
+      @options = @body.options
+
       if @uri.relative?
         origin = @options.origin
         raise(Error, "invalid URI: #{@uri}") unless origin
@@ -61,28 +92,23 @@ module HTTPX
         @uri = origin.merge("#{base_path}#{@uri}")
       end
 
-      @headers = @options.headers.dup
-      @headers["user-agent"] ||= USER_AGENT
-      @headers["accept"]     ||= "*/*"
-
-      @body = @options.request_body_class.new(@headers, @options)
       @state = :idle
       @response = nil
       @peer_address = nil
       @persistent = @options.persistent
     end
 
-    # the read timeout defied for this requet.
+    # the read timeout defined for this requet.
     def read_timeout
       @options.timeout[:read_timeout]
     end
 
-    # the write timeout defied for this requet.
+    # the write timeout defined for this requet.
     def write_timeout
       @options.timeout[:write_timeout]
     end
 
-    # the request timeout defied for this requet.
+    # the request timeout defined for this requet.
     def request_timeout
       @options.timeout[:request_timeout]
     end
@@ -91,10 +117,12 @@ module HTTPX
       @persistent
     end
 
+    # if the request contains trailer headers
     def trailers?
       defined?(@trailers)
     end
 
+    # returns an instance of HTTPX::Headers containing the trailer headers
     def trailers
       @trailers ||= @options.headers_class.new
     end
@@ -106,6 +134,7 @@ module HTTPX
       :w
     end
 
+    # merges +h+ into the instance of HTTPX::Headers of the request.
     def merge_headers(h)
       @headers = @headers.merge(h)
     end
@@ -172,7 +201,7 @@ module HTTPX
       return @query if defined?(@query)
 
       query = []
-      if (q = @options.params)
+      if (q = @query_params)
         query << Transcoder::Form.encode(q)
       end
       query << @uri.query if @uri.query

data/lib/httpx/resolver/https.rb

@@ -71,9 +71,11 @@ module HTTPX
         connection = @options.connection_class.new(@uri, @options.merge(ssl: { alpn_protocols: %w[h2] }))
         @pool.init_connection(connection, @options)
         # only explicity emit addresses if connection didn't pre-resolve, i.e. it's not an IP.
-        emit_addresses(connection, @family, @uri_addresses) unless connection.addresses
-        @building_connection = false
-        connection
+        catch(:coalesced) do
+          @building_connection = false
+          emit_addresses(connection, @family, @uri_addresses) unless connection.addresses
+          connection
+        end
       end
     end
 
@@ -199,7 +201,7 @@ module HTTPX
           @queries.delete_if { |_, conn| connection == conn }
 
           Resolver.cached_lookup_set(hostname, @family, addresses) if @resolver_options[:cache]
-          emit_addresses(connection, @family, addresses.map { |addr| addr["data"] })
+          catch(:coalesced) { emit_addresses(connection, @family, addresses.map { |addr| addr["data"] }) }
         end
       end
       return if @connections.empty?
@@ -219,7 +221,7 @@ module HTTPX
         uri.query = URI.encode_www_form(params)
         request = rklass.new("GET", uri, @options)
       else
-        request = rklass.new("POST", uri, @options.merge(body: [payload]))
+        request = rklass.new("POST", uri, @options, body: [payload])
         request.headers["content-type"] = "application/dns-message"
       end
       request.headers["accept"] = "application/dns-message"

data/lib/httpx/resolver/native.rb

@@ -329,7 +329,7 @@ module HTTPX
           @timeouts.delete(connection.origin.host)
           @connections.delete(connection)
           Resolver.cached_lookup_set(connection.origin.host, @family, addresses) if @resolver_options[:cache]
-          emit_addresses(connection, @family, addresses.map { |addr| addr["data"] })
+          catch(:coalesced) { emit_addresses(connection, @family, addresses.map { |addr| addr["data"] }) }
         end
       end
       return emit(:close) if @connections.empty?

data/lib/httpx/resolver/resolver.rb

@@ -33,7 +33,7 @@ module HTTPX
     def initialize(family, options)
       @family = family
       @record_type = RECORD_TYPES[family]
-      @options = Options.new(options)
+      @options = options
     end
 
     def close; end

data/lib/httpx/resolver/system.rb

@@ -127,7 +127,7 @@ module HTTPX
           @queries.delete(pair)
 
           family, connection = pair
-          emit_addresses(connection, family, addrs)
+          catch(:coalesced) { emit_addresses(connection, family, addrs) }
         when ERROR
           *pair, error = @pipe_mutex.synchronize { @ips.pop }
           @queries.delete(pair)

data/lib/httpx/response.rb

@@ -247,11 +247,11 @@ module HTTPX
     # the IP address of the peer server.
     def_delegator :@request, :peer_address
 
-    def initialize(request, error, options)
+    def initialize(request, error)
       @request = request
       @response = request.response if request.response.is_a?(Response)
       @error = error
-      @options = Options.new(options)
+      @options = request.options
       log_exception(@error)
     end
 

data/lib/httpx/session.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 module HTTPX
+  EMPTY_HASH = {}.freeze
+
   # Class implementing the APIs being used publicly.
   #
   #   HTTPX.get(..) #=> delegating to an internal HTTPX::Session object.
@@ -9,8 +11,6 @@ module HTTPX
     include Loggable
     include Chainable
 
-    EMPTY_HASH = {}.freeze
-
     # initializes the session with a set of +options+, which will be shared by all
     # requests sent from it.
     #
@@ -65,10 +65,10 @@ module HTTPX
     #  resp1, resp2 = session.request(["POST", "https://server.org/a", form: { "foo" => "bar" }], ["GET", "https://server.org/b"])
     #  resp1, resp2 = session.request("GET", ["https://server.org/a", "https://server.org/b"], headers: { "x-api-token" => "TOKEN" })
     #
-    def request(*args, **options)
+    def request(*args, **params)
       raise ArgumentError, "must perform at least one request" if args.empty?
 
-      requests = args.first.is_a?(Request) ? args : build_requests(*args, options)
+      requests = args.first.is_a?(Request) ? args : build_requests(*args, params)
       responses = send_requests(*requests)
       return responses.first if responses.size == 1
 
@@ -81,10 +81,9 @@ module HTTPX
     #
     #   req = session.build_request("GET", "https://server.com")
     #   resp = session.request(req)
-    def build_request(verb, uri, options = EMPTY_HASH)
-      rklass = @options.request_class
-      options = @options.merge(options) unless options.is_a?(Options)
-      request = rklass.new(verb, uri, options)
+    def build_request(verb, uri, params = EMPTY_HASH, options = @options)
+      rklass = options.request_class
+      request = rklass.new(verb, uri, options, params)
       request.persistent = @persistent
       set_request_callbacks(request)
       request
@@ -126,6 +125,7 @@ module HTTPX
       connection
     end
 
+    # sends the +request+ to the corresponding HTTPX::Connection
     def send_request(request, connections, options = request.options)
       error = catch(:resolve_error) do
         connection = find_connection(request, connections, options)
@@ -133,7 +133,7 @@ module HTTPX
       end
       return unless error.is_a?(Error)
 
-      request.emit(:response, ErrorResponse.new(request, error, options))
+      request.emit(:response, ErrorResponse.new(request, error))
     end
 
     # sets the callbacks on the +connection+ required to process certain specific
@@ -192,22 +192,26 @@ module HTTPX
     end
 
     # returns a set of HTTPX::Request objects built from the given +args+ and +options+.
-    def build_requests(*args, options)
-      request_options = @options.merge(options)
-
+    def build_requests(*args, params)
       requests = if args.size == 1
         reqs = args.first
-        reqs.map do |verb, uri, opts = EMPTY_HASH|
-          build_request(verb, uri, request_options.merge(opts))
+        # TODO: find a way to make requests share same options object
+        reqs.map do |verb, uri, ps = EMPTY_HASH|
+          request_params = params
+          request_params = request_params.merge(ps) unless ps.empty?
+          build_request(verb, uri, request_params)
         end
       else
         verb, uris = args
         if uris.respond_to?(:each)
-          uris.enum_for(:each).map do |uri, opts = EMPTY_HASH|
-            build_request(verb, uri, request_options.merge(opts))
+          # TODO: find a way to make requests share same options object
+          uris.enum_for(:each).map do |uri, ps = EMPTY_HASH|
+            request_params = params
+            request_params = request_params.merge(ps) unless ps.empty?
+            build_request(verb, uri, request_params)
           end
         else
-          [build_request(verb, uris, request_options)]
+          [build_request(verb, uris, params)]
         end
       end
       raise ArgumentError, "wrong number of URIs (given 0, expect 1..+1)" if requests.empty?
@@ -228,6 +232,14 @@ module HTTPX
       end
     end
 
+    def deactivate_connection(request, connections, options)
+      conn = connections.find do |c|
+        c.match?(request.uri, options)
+      end
+
+      pool.deactivate(conn) if conn
+    end
+
     # sends an array of HTTPX::Request +requests+, returns the respective array of HTTPX::Response objects.
     def send_requests(*requests)
       connections = _send_requests(requests)
@@ -258,6 +270,7 @@ module HTTPX
           return responses unless request
 
           catch(:coalesced) { pool.next_tick } until (response = fetch_response(request, connections, request.options))
+          request.emit(:complete, response)
 
           responses << response
           requests.shift
@@ -271,14 +284,16 @@ module HTTPX
           # opportunity to traverse the requests, hence we're returning only a fraction of the errors
           # we were supposed to. This effectively fetches the existing responses and return them.
           while (request = requests.shift)
-            responses << fetch_response(request, connections, request.options)
+            response = fetch_response(request, connections, request.options)
+            request.emit(:complete, response) if response
+            responses << response
           end
           break
         end
         responses
       ensure
         if @persistent
-          pool.deactivate(connections)
+          pool.deactivate(*connections)
         else
           close(connections)
         end

data/lib/httpx/timers.rb

@@ -43,7 +43,7 @@ module HTTPX
 
       elapsed_time = Utils.elapsed_time(@next_interval_at)
 
-      @intervals.delete_if { |interval| interval.elapse(elapsed_time) <= 0 }
+      @intervals = @intervals.drop_while { |interval| interval.elapse(elapsed_time) <= 0 }
 
       @next_interval_at = nil if @intervals.empty?
     end

data/lib/httpx/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module HTTPX
-  VERSION = "1.2.6"
+  VERSION = "1.3.1"
 end

data/sig/chainable.rbs

@@ -3,8 +3,8 @@ module HTTPX
     def request: (*Request, **untyped) -> Array[response]
                | (Request, **untyped) -> response
                | (verb, uri | [uri], **untyped) -> response
-               | (Array[[verb, uri] | [verb, uri, options]], **untyped) -> Array[response]
-               | (verb, _Each[uri | [uri, options]], **untyped) -> Array[response]
+               | (Array[[verb, uri] | [verb, uri, request_params]], **untyped) -> Array[response]
+               | (verb, _Each[uri | [uri, request_params]], **untyped) -> Array[response]
 
     def accept: (String) -> Session
     def wrap: () { (Session) -> void } -> void

data/sig/connection/http1.rbs

@@ -38,7 +38,7 @@ module HTTPX
 
     def consume: () -> void
 
-    def handle_error: (StandardError ex) -> void
+    def handle_error: (StandardError ex, ?Request? request) -> void
 
     def on_start: () -> void
 
@@ -58,7 +58,7 @@ module HTTPX
 
     private
 
-    def initialize: (Buffer, options) -> untyped
+    def initialize: (Buffer buffer, Options options) -> untyped
 
     def manage_connection: (Request request, Response response) -> void
 

data/sig/connection/http2.rbs

@@ -5,7 +5,7 @@ module HTTPX
 
     MAX_CONCURRENT_REQUESTS: Integer
 
-    attr_reader streams: Hash[Request, HTTP2Next::Stream]
+    attr_reader streams: Hash[Request, ::HTTP2::Stream]
     attr_reader pending: Array[Request]
 
     @options: Options
@@ -32,7 +32,7 @@ module HTTPX
 
     def consume: () -> void
 
-    def handle_error: (StandardError ex) -> void
+    def handle_error: (StandardError ex, ?Request? request) -> void
 
     def ping: () -> void
 
@@ -42,35 +42,35 @@ module HTTPX
 
     private
 
-    def initialize: (Buffer, options) -> untyped
+    def initialize: (Buffer buffer, Options options) -> untyped
 
     def send_pending: () -> void
 
     def set_protocol_headers: (Request) -> _Each[[String, String]]
 
-    def handle: (Request request, HTTP2Next::Stream stream) -> void
+    def handle: (Request request, ::HTTP2::Stream stream) -> void
 
     def init_connection: () -> void
 
-    def handle_stream: (HTTP2Next::Stream stream, Request request) -> void
+    def handle_stream: (::HTTP2::Stream stream, Request request) -> void
 
     def join_headline: (Request request) -> String
 
-    def join_headers: (HTTP2Next::Stream stream, Request request) -> void
+    def join_headers: (::HTTP2::Stream stream, Request request) -> void
 
-    def join_trailers: (HTTP2Next::Stream stream, Request request) -> void
+    def join_trailers: (::HTTP2::Stream stream, Request request) -> void
 
-    def join_body: (HTTP2Next::Stream stream, Request request) -> void
+    def join_body: (::HTTP2::Stream stream, Request request) -> void
 
-    def on_stream_headers: (HTTP2Next::Stream stream, Request request, Array[[String, String]] headers) -> void
+    def on_stream_headers: (::HTTP2::Stream stream, Request request, Array[[String, String]] headers) -> void
 
-    def on_stream_trailers: (HTTP2Next::Stream stream, Response response, Array[[String, String]] headers) -> void
+    def on_stream_trailers: (::HTTP2::Stream stream, Response response, Array[[String, String]] headers) -> void
 
-    def on_stream_data: (HTTP2Next::Stream stream, Request request, String data) -> void
+    def on_stream_data: (::HTTP2::Stream stream, Request request, String data) -> void
 
-    def on_stream_refuse: (HTTP2Next::Stream stream, Request request, StandardError error) -> void
+    def on_stream_refuse: (::HTTP2::Stream stream, Request request, StandardError error) -> void
 
-    def on_stream_close: (HTTP2Next::Stream stream, Request request, (Symbol | StandardError)? error) -> void
+    def on_stream_close: (::HTTP2::Stream stream, Request request, (Symbol | StandardError)? error) -> void
 
     def on_frame: (string bytes) -> void
 
@@ -78,13 +78,13 @@ module HTTPX
 
     def on_close: (Integer last_frame, Symbol? error, String? payload) -> void
 
-    def on_frame_sent: (HTTP2Next::frame) -> void
+    def on_frame_sent: (::HTTP2::frame) -> void
 
-    def on_frame_received: (HTTP2Next::frame) -> void
+    def on_frame_received: (::HTTP2::frame) -> void
 
-    def on_altsvc: (String origin, HTTP2Next::frame) -> void
+    def on_altsvc: (String origin, ::HTTP2::frame) -> void
 
-    def on_promise: (HTTP2Next::Stream) -> void
+    def on_promise: (::HTTP2::Stream) -> void
 
     def on_origin: (String) -> void
 

data/sig/connection.rbs

@@ -93,9 +93,9 @@ module HTTPX
 
     private
 
-    def initialize: (http_uri uri, options) -> void
+    def initialize: (http_uri uri, Options options) -> void
 
-    def initialize_type: (http_uri uri, Options) -> io_type
+    def initialize_type: (http_uri uri, Options options) -> io_type
 
     def connect: () -> void
 
@@ -119,14 +119,20 @@ module HTTPX
 
     def build_socket: (?Array[ipaddr]? addrs) -> (TCP | SSL | UNIX)
 
-    def on_error: (HTTPX::TimeoutError | Error | StandardError error) -> void
+    def on_error: (HTTPX::TimeoutError | Error | StandardError error, ?Request? request) -> void
 
-    def handle_error: (StandardError error) -> void
+    def handle_error: (StandardError error, ?Request? request) -> void
 
     def purge_after_closed: () -> void
 
     def set_request_timeouts: (Request request) -> void
 
+    def set_request_read_timeout: (Request request) -> void
+
+    def set_request_write_timeout: (Request request) -> void
+
+    def set_request_request_timeout: (Request request) -> void
+
     def write_timeout_callback: (Request request, Numeric write_timeout) -> void
 
     def read_timeout_callback: (Request request, Numeric read_timeout, ?singleton(RequestTimeoutError) error_type) -> void

data/sig/httpx.rbs

@@ -9,9 +9,9 @@ module HTTPX
   type uri = http_uri | string
   type generic_uri = String | URI::Generic
 
-  type verb = "OPTIONS" | "GET" | "HEAD" | "POST" | "PUT" | "DELETE" | "TRACE" | "CONNECT" |
-              "PROPFIND" | "PROPPATCH" | "MKCOL" | "COPY" | "MOVE" | "LOCK" | "UNLOCK" | "ORDERPATCH" |
-              "ACL" | "REPORT" | "PATCH" | "SEARCH"
+  type verb = String
+
+  type request_params = Hash[Symbol, untyped]
 
   type ip_family = Integer #Socket::AF_INET6 | Socket::AF_INET
 

data/sig/io/tcp.rbs

@@ -15,7 +15,7 @@ module HTTPX
     alias host ip
 
     # TODO: lift when https://github.com/ruby/rbs/issues/1497 fixed
-    def initialize: (URI::Generic origin, Array[ipaddr]? addresses, options options) ?{ (instance) -> void } -> void
+    def initialize: (URI::Generic origin, Array[ipaddr]? addresses, Options options) ?{ (instance) -> void } -> void
 
     def add_addresses: (Array[ipaddr] addrs) -> void
 

data/sig/io/unix.rbs

@@ -15,7 +15,7 @@ module HTTPX
 
     @io: Socket
 
-    def initialize: (http_uri origin, String? path, options options) -> void
+    def initialize: (http_uri origin, String? path, Options options) -> void
 
     def connect: () -> void
 

data/sig/options.rbs

@@ -63,19 +63,7 @@ module HTTPX
     # decompress_response_body
     attr_reader decompress_response_body: bool
 
-    # params
-    attr_reader params: Transcoder::urlencoded_input?
-
-    # form
-    attr_reader form: Transcoder::urlencoded_input?
-
-    # json
-    attr_reader json: _ToJson?
-
-    # body
-    attr_reader body: bodyIO?
-
-    # body
+    # origin
     attr_reader origin: URI::Generic?
 
     # base_path

data/sig/plugins/follow_redirects.rbs

@@ -24,7 +24,7 @@ module HTTPX
       module InstanceMethods
         def max_redirects: (_ToI) -> instance
 
-        def redirect_request_headers: (http_uri original_uri, http_uri redirect_uri, Headers headers, Options & _FollowRedirectsOptions options) -> Headers
+        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

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
 

data/sig/plugins/proxy.rbs

@@ -43,6 +43,8 @@ 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

data/sig/plugins/push_promise.rbs

@@ -9,9 +9,9 @@ module HTTPX
       module InstanceMethods
         private
 
-        def promise_headers: () -> Hash[HTTP2Next::Stream, Request]
-        def __on_promise_request: (Connection::HTTP2, HTTP2Next::Stream, headers_input) -> void
-        def __on_promise_response: (Connection::HTTP2, HTTP2Next::Stream, headers_input) -> void
+        def promise_headers: () -> Hash[::HTTP2::Stream, Request]
+        def __on_promise_request: (Connection::HTTP2, ::HTTP2::Stream, headers_input) -> void
+        def __on_promise_response: (Connection::HTTP2, ::HTTP2::Stream, headers_input) -> void
       end
     end
 

data/sig/pool.rbs

@@ -19,7 +19,7 @@ module HTTPX
 
     def find_connection: (URI::Generic uri, Options options) -> Connection?
 
-    def deactivate: (*Array[Connection]) -> void
+    def deactivate: (*Connection connections) -> void
 
     private
 

data/sig/request/body.rbs

@@ -4,7 +4,7 @@ module HTTPX
     @body: body_encoder?
     @unbounded_body: bool
 
-    def initialize: (Headers headers, Options options) -> void
+    def initialize: (Headers headers, Options options, ?body: bodyIO, ?form: Transcoder::urlencoded_input?, ?json: _ToJson?, **untyped) -> void
 
     def each: () { (String) -> void } -> void
             | () -> Enumerable[String]
@@ -25,8 +25,6 @@ module HTTPX
 
     private
 
-    def initialize_body: (Options options) -> void
-
     def self.initialize_deflater_body: (body_encoder body, Encoding | String encoding) -> body_encoder
   end
 

data/sig/request.rbs

@@ -19,12 +19,13 @@ module HTTPX
 
     attr_writer persistent: bool
 
+    @query_params: Hash[interned, untyped]?
     @trailers: Headers?
     @informational_status: Integer?
     @query: String?
     @drainer: Enumerator[String, void]?
 
-    def initialize: (Symbol | String, generic_uri, ?options) -> untyped
+    def initialize: (Symbol | String verb, generic_uri uri, Options options, ?request_params params) -> untyped
 
     def interests: () -> (:r | :w)
 

data/sig/resolver/resolver.rbs

@@ -26,9 +26,9 @@ module HTTPX
 
       def emit_resolved_connection: (Connection connection, Array[IPAddr] addresses, bool early_resolve) -> void
 
-      def initialize: (ip_family? family, options options) -> void
+      def initialize: (ip_family? family, Options options) -> void
 
-      def early_resolve: (Connection connection, ?hostname: String) -> void
+      def early_resolve: (Connection connection, ?hostname: String) -> boolish
 
       def emit_resolve_error: (Connection connection, ?String hostname, ?StandardError) -> void
 

data/sig/response.rbs

@@ -91,7 +91,7 @@ module HTTPX
 
     private
 
-    def initialize: (Request, Exception, options) -> untyped
+    def initialize: (Request, Exception) -> untyped
   end
 
   type response = Response | ErrorResponse