httpx 0.20.3 → 0.21.0

data/lib/httpx/transcoder/json.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require "forwardable"
-require "json"
 
 module HTTPX::Transcoder
   module JSON
@@ -19,7 +18,7 @@ module HTTPX::Transcoder
       def_delegator :@raw, :bytesize
 
       def initialize(json)
-        @raw = ::JSON.dump(json)
+        @raw = JSON.json_dump(json)
         @charset = @raw.encoding.name.downcase
       end
 
@@ -37,8 +36,25 @@ module HTTPX::Transcoder
 
       raise HTTPX::Error, "invalid json mime type (#{content_type})" unless JSON_REGEX.match?(content_type)
 
-      ::JSON.method(:parse)
+      method(:json_load)
     end
+
+    # rubocop:disable Style/SingleLineMethods
+    if defined?(MultiJson)
+      def json_load(*args); MultiJson.load(*args); end
+      def json_dump(*args); MultiJson.dump(*args); end
+    elsif defined?(Oj)
+      def json_load(response, *args); Oj.load(response.to_s, *args); end
+      def json_dump(*args); Oj.dump(*args); end
+    elsif defined?(Yajl)
+      def json_load(response, *args); Yajl::Parser.new(*args).parse(response.to_s); end
+      def json_dump(*args); Yajl::Encoder.encode(*args); end
+    else
+      require "json"
+      def json_load(*args); ::JSON.parse(*args); end
+      def json_dump(*args); ::JSON.dump(*args); end
+    end
+    # rubocop:enable Style/SingleLineMethods
   end
   register "json", JSON
 end

data/lib/httpx/transcoder/xml.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require "delegate"
+require "forwardable"
+require "uri"
+
+module HTTPX::Transcoder
+  module Xml
+    using HTTPX::RegexpExtensions
+
+    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"
+
+      # rubocop:disable Lint/DuplicateMethods
+      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
+    # rubocop:enable Lint/DuplicateMethods
+  end
+  register "xml", Xml
+end

data/lib/httpx/transcoder.rb

@@ -90,4 +90,5 @@ end
 require "httpx/transcoder/body"
 require "httpx/transcoder/form"
 require "httpx/transcoder/json"
+require "httpx/transcoder/xml"
 require "httpx/transcoder/chunker"

data/lib/httpx/version.rb

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

data/sig/buffer.rbs

@@ -15,7 +15,7 @@ module HTTPX
     # delegated
     def <<: (string data) -> String
     def empty?: () -> bool
-    def bytesize: () -> Integer
+    def bytesize: () -> (Integer | Float)
     def clear: () -> void
     def replace: (string) -> void
 

data/sig/chainable.rbs

@@ -33,6 +33,7 @@ module HTTPX
               | (:aws_sigv4, ?options) -> Plugins::awsSigV4Session
               | (:grpc, ?options) -> Plugins::grpcSession
               | (:response_cache, ?options) -> Plugins::sessionResponseCache
+              | (:circuit_breaker, ?options) -> Plugins::sessionCircuitBreaker
               | (Symbol | Module, ?options) { (Class) -> void } -> Session
               | (Symbol | Module, ?options) -> Session
 

data/sig/connection.rbs

@@ -28,7 +28,7 @@ module HTTPX
     attr_reader options: Options
     attr_writer timers: Timers
 
-    @origins: Array[URI::Generic]
+    @type: io_type
     @window_size: Integer
     @read_buffer: Buffer
     @write_buffer: Buffer
@@ -40,7 +40,7 @@ module HTTPX
 
     def addresses=: (Array[ipaddr]) -> void
 
-    def match?: (URI::Generic, options) -> bool
+    def match?: (URI::Generic uri, Options options) -> bool
 
     def mergeable?: (Connection) -> bool
 
@@ -54,13 +54,15 @@ module HTTPX
 
     def match_altsvcs?: (URI::Generic uri) -> bool
 
+    def match_altsvc_options?: (URI::Generic uri, Options options) -> bool
+
     def connecting?: () -> bool
 
     def inflight?: () -> boolish
 
     def interests: () -> io_interests?
 
-    def to_io: () -> IO
+    def to_io: () -> ::IO
 
     def call: () -> void
 
@@ -77,7 +79,7 @@ module HTTPX
 
     private
 
-    def initialize: (String, URI::Generic, options) -> untyped
+    def initialize: (io_type, URI::Generic, options) -> untyped
 
     def connect: () -> void
 
@@ -103,5 +105,11 @@ module HTTPX
     def handle_error: (StandardError) -> void
 
     def purge_after_closed: () -> void
+
+    def set_request_timeouts: (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
   end
 end

data/sig/errors.rbs

@@ -23,6 +23,19 @@ module HTTPX
   class ResolveTimeoutError < TimeoutError
   end
 
+  class RequestTimeoutError < TimeoutError
+    attr_reader request: Request
+    attr_reader response: response?
+
+    def initialize: (Request request, response? response, Numeric timeout) -> void
+  end
+
+  class ReadTimeoutError < RequestTimeoutError
+  end
+
+  class WriteTimeoutError < RequestTimeoutError
+  end
+
   class ResolveError < Error
   end
 

data/sig/io.rbs

@@ -0,0 +1,6 @@
+module HTTPX
+  type io_type = "udp" | "tcp" | "ssl" | "unix"
+
+  module IO
+  end
+end

data/sig/options.rbs

@@ -10,7 +10,7 @@ module HTTPX
     SETTINGS_TIMEOUT: Integer
     DEFAULT_OPTIONS: Hash[Symbol, untyped]
 
-    type timeout_type = :connect_timeout | :settings_timeout | :operation_timeout | :keep_alive_timeout | :total_timeout
+    type timeout_type = :connect_timeout | :settings_timeout | :operation_timeout | :keep_alive_timeout | :total_timeout | :read_timeout | :write_timeout | :request_timeout
     type timeout = Hash[timeout_type, Numeric]
 
     def self.new: (?options) -> instance
@@ -65,6 +65,9 @@ module HTTPX
     # body
     attr_reader origin: URI::Generic?
 
+    # base_path
+    attr_reader base_path: String?
+
     # ssl
 
     # http2_settings

data/sig/plugins/circuit_breaker.rbs

@@ -0,0 +1,61 @@
+module HTTPX
+  module Plugins
+    module CircuitBreaker
+
+      class CircuitStore
+        @circuits: Hash[String, Circuit]
+
+        def try_open: (generic_uri uri, response response) -> void
+
+        def try_respond: (Request request) -> response?
+
+        private
+
+        def get_circuit_for_uri: (generic_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
+
+        @response: response?
+        @opened_at: Float?
+        @attempted_at: Float?
+
+        def respond: () -> response?
+
+        def try_open: (response) -> void
+
+        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
+      end
+
+    end
+
+    type sessionCircuitBreaker = Session & CircuitBreaker::InstanceMethods
+  end
+end

data/sig/plugins/compression/brotli.rbs

@@ -6,7 +6,7 @@ module HTTPX
         def self.configure: (singleton(Session)) -> void
 
         def self?.deflater: () -> _Deflater
-        def self?.decoder: (Numeric bytesize) -> Inflater
+        def self?.decoder: (Integer | Float bytesize) -> Inflater
 
         module Deflater
           extend _Deflater

data/sig/plugins/compression/deflate.rbs

@@ -6,7 +6,7 @@ module HTTPX
         def self.configure: (singleton(Session)) -> void
 
         def self?.deflater: () -> _Deflater
-        def self?.inflater: (Numeric bytesize) -> GZIP::Inflater
+        def self?.inflater: (Integer | Float bytesize) -> GZIP::Inflater
 
         module Deflater
           extend _Deflater

data/sig/plugins/compression/gzip.rbs

@@ -6,15 +6,15 @@ module HTTPX
         def self.configure: (singleton(Session)) -> void
 
         def self?.deflater: () -> _Deflater
-        def self?.inflater: (Numeric bytesize) -> Inflater
+        def self?.inflater: (Integer | Float bytesize) -> Inflater
 
         class Deflater
           include _Deflater
 
           @compressed_chunk: String
-          
+
           private
-          
+
           def initialize: () -> untyped
           def write: (string) -> void
           def compressed_chunk: () -> String

data/sig/plugins/compression.rbs

@@ -13,7 +13,7 @@ module HTTPX
       interface _Inflater
         def inflate: (string) -> String
 
-        def initialize: (Numeric bytesize) -> untyped
+        def initialize: (Integer | Float bytesize) -> untyped
       end
 
       def self.configure: (singleton(Session)) -> void

data/sig/plugins/multipart.rbs

@@ -61,7 +61,7 @@ module HTTPX
         @boundary: String
         @intermediate_boundary: String
 
-        def call: (Response response, untyped) -> Hash[String, untyped]
+        def call: (Response response, *untyped) -> Hash[String, untyped]
 
         private
 

data/sig/plugins/proxy/socks5.rbs

@@ -4,14 +4,15 @@ module HTTPX
   module Plugins
     module Proxy
       module Socks5
-      
+        VERSION: Integer
+
         module ConnectionMethods
           def __socks5_proxy_connect: () ->  void
           def __socks5_on_packet: (String packet) ->  void
           def __socks5_check_version: (int) -> void
           def __on_socks5_error: (string) -> void
         end
-        
+
         class SocksParser
           include Callbacks
 

data/sig/plugins/proxy.rbs

@@ -21,7 +21,7 @@ module HTTPX
 
         private
 
-        def initialize: (uri: generic_uri, ?scheme: String, ?username: String, ?password: String, **extra) -> untyped
+        def initialize: (uri: generic_uri, ?scheme: String, ?username: String, ?password: String, **untyped) -> untyped
       end
 
       def self.configure: (singleton(Session)) -> void

data/sig/plugins/response_cache.rbs

@@ -8,15 +8,19 @@ module HTTPX
       def self?.cached_response?: (response response) -> bool
 
       class Store
-        @store: Hash[URI::Generic, Response]
+        @store: Hash[String, Array[Response]]
 
-        def lookup: (URI::Generic uri) -> Response?
+        def lookup: (Request request) -> Response?
 
-        def cached?: (URI::Generic uri) -> bool
+        def cached?: (Request request) -> boolish
 
-        def cache: (URI::Generic uri, Response response) -> void
+        def cache: (Request request, Response response) -> void
 
         def prepare: (Request request) -> void
+
+        private
+
+        def match_by_vary?: (Request request, Response response) -> bool
       end
 
       module InstanceMethods
@@ -25,8 +29,24 @@ module HTTPX
         def clear_response_cache: () -> void
       end
 
+      module RequestMethods
+        def response_cache_key: () -> String
+      end
+
       module ResponseMethods
         def copy_from_cached: (Response other) -> void
+
+        def fresh?: () -> bool
+
+        def cache_control: () -> Array[String]?
+
+        def vary: () -> Array[String]?
+
+        private
+
+        def age: () -> Integer
+
+        def date: () -> Time
       end
     end
 

data/sig/registry.rbs

@@ -1,12 +1,13 @@
-module HTTPX::Registry[T, V]
+module HTTPX::Registry[unchecked out T, unchecked out V]
   class Error < HTTPX::Error
   end
 
   # type registrable = Symbol | String | Class
 
-  def self.registry: (T tag) -> Class
-                   | () -> Hash[T, V]
-  def self.register: (T tag,  V handler) -> void
+  def self.registry: [T, V] (T) -> Class
+                   | [T, V] () -> Hash[T, V]
+
+  def self.register: [T, V] (T tag,  V handler) -> void
 
   def registry: (?T tag) -> V
 end

data/sig/request.rbs

@@ -50,6 +50,12 @@ module HTTPX
 
     def trailers?: () -> boolish
 
+    def read_timeout: () -> Numeric
+
+    def write_timeout: () -> Numeric
+
+    def request_timeout: () -> Numeric
+
     class Body
       @headers: Headers
       @body: body_encoder?
@@ -61,7 +67,7 @@ module HTTPX
 
       def rewind: () -> void
       def empty?: () -> bool
-      def bytesize: () -> Numeric
+      def bytesize: () -> (Integer | Float)
       def stream: (Transcoder::_Encoder) -> bodyIO
       def unbounded_body?: () -> bool
       def chunked?: () -> bool

data/sig/resolver/native.rbs

@@ -10,7 +10,10 @@ module HTTPX
       @family: ip_family
       @options: Options
       @ns_index: Integer
-      @nameserver: String
+      @nameserver: Array[String]?
+      @ndots: Integer
+      @start_timeout: Float?
+      @search: Array[String]
       @_timeouts: Array[Numeric]
       @timeouts: Hash[String, Array[Numeric]]
       @connections: Array[Connection]
@@ -37,7 +40,7 @@ module HTTPX
 
       def consume: () -> void
 
-      def do_retry: (?Numeric loop_time) -> void
+      def do_retry: (?Numeric? loop_time) -> void
 
       def dread: (Integer) -> void
                | () -> void

data/sig/response.rbs

@@ -1,5 +1,7 @@
 module HTTPX
   interface _Response
+    def finished?: () -> bool
+
     def raise_for_status: () -> self
 
     def error: () -> StandardError?
@@ -61,7 +63,7 @@ module HTTPX
       def each: () { (String) -> void } -> void
               | () -> Enumerable[String]
 
-      def bytesize: () -> Numeric
+      def bytesize: () -> (Integer | Float)
       def empty?: () -> bool
       def copy_to: (String | File | _Writer destination) -> void
       def close: () -> void
@@ -96,6 +98,7 @@ module HTTPX
   class ErrorResponse
     include _Response
     include Loggable
+    extend Forwardable
 
     @options: Options
     @error: Exception
@@ -104,6 +107,8 @@ module HTTPX
 
     def status: () -> (Integer | _ToS)
 
+    def uri: () -> URI::Generic
+
     private
 
     def initialize: (Request, Exception, options) -> untyped

data/sig/timers.rbs

@@ -1,7 +1,7 @@
 module HTTPX
   class Timers
     @intervals: Array[Interval]
-    @next_interval_at: Numeric
+    @next_interval_at: Float
 
     def after: (Numeric interval_in_secs) { () -> void } -> void
 

data/sig/transcoder/json.rbs

@@ -5,6 +5,9 @@ module HTTPX::Transcoder
     def self?.encode: (_ToJson json) -> Encoder
     def self?.decode: (HTTPX::Response response) -> _Decoder
 
+    def self?.json_load: (string source, ?json_options) -> untyped
+    def self?.json_dump: (_ToJson obj, *untyped) -> String
+
     class Encoder
       extend Forwardable
       include _Encoder
@@ -17,7 +20,7 @@ module HTTPX::Transcoder
 
       private
 
-      def initialize: (_ToJson json) -> untyped
+      def initialize: (_ToJson json) -> void
     end
   end
 end

data/sig/transcoder/xml.rbs

@@ -0,0 +1,21 @@
+module HTTPX::Transcoder
+  module XML
+
+    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

data/sig/transcoder.rbs

@@ -18,11 +18,11 @@ module HTTPX
     end
 
     interface _Encoder
-      def bytesize: () -> Numeric
+      def bytesize: () -> (Integer | Float)
     end
 
     interface _Decoder
-      def call: (Response response, untyped options) -> untyped
+      def call: (Response response, *untyped) -> untyped
     end
   end
 end

data/sig/utils.rbs

@@ -4,9 +4,9 @@ module HTTPX
 
     def self?.parse_retry_after: (String) -> Numeric
 
-    def self?.now: () -> Numeric
+    def self?.now: () -> Float
 
-    def self?.elapsed_time: (Numeric monotonic_time) -> Numeric
+    def self?.elapsed_time: (Integer | Float monotonic_time) -> Float
 
     def self?.to_uri: (generic_uri uri) -> URI::Generic
   end