httpx 0.15.4 → 0.18.0

data/sig/resolver/resolver_mixin.rbs

@@ -4,6 +4,8 @@ module HTTPX
       include Callbacks
       include Loggable
 
+      CHECK_IF_IP: ^(String name) -> bool
+
       def uncache: (Connection) -> void
 
       private
@@ -16,12 +18,9 @@ module HTTPX
 
       def system_resolve: (String hostname) -> Array[ipaddr]?
 
-      def emit_resolve_error: (Connection, String hostname, StandardError) -> void
-                            | (Connection, String hostname) -> void
-                            | (Connection) -> void
+      def emit_resolve_error: (Connection, ?String hostname, ?StandardError) -> void
 
-      def resolve_error: (String hostname, StandardError?) -> void
-                       | (String hostname) -> void  
+      def resolve_error: (String hostname, ?StandardError?) -> void
     end
   end
 end

data/sig/resolver/system.rbs

@@ -3,6 +3,10 @@ module HTTPX
     class System
       include ResolverMixin
 
+      RESOLV_ERRORS: Array[singleton(StandardError)] # ResolvError
+
+      attr_reader state: Symbol
+
       def closed?: () -> true
 
       def empty?: () -> true

data/sig/resolver.rbs

@@ -4,6 +4,13 @@ module HTTPX
   type resolver = Resolver::System | Resolver::Native | Resolver::HTTPS
 
   module Resolver
+    RESOLVE_TIMEOUT: Integer | Float
+
+    def self.registry: (Symbol tag) -> Class
+    | () -> Hash[Symbol, Class]
+
+    def self.register: (Symbol tag,  Class handler) -> void
+
     type dns_resource = singleton(Resolv::DNS::Resource)
 
     type dns_result = { "name" => String, "TTL" => Numeric, "alias" => String }

data/sig/response.rbs

@@ -1,15 +1,19 @@
 module HTTPX
   interface _Response
-    def raise_for_status: () -> void 
+    def raise_for_status: () -> self
+
+    def error: () -> StandardError?
   end
 
   class Response
+    extend Forwardable
+
     include _Response
     include _ToS
     include _Reader
 
-    attr_reader status: int
-    attr_reader headers: headers
+    attr_reader status: Integer
+    attr_reader headers: Headers
     attr_reader body: Body
     attr_reader version: String
 
@@ -18,56 +22,66 @@ module HTTPX
 
     def copy_to: (_ToPath | _Writer destination) -> void
     def close: () -> void
-    def uri: () -> uri
+    def uri: () -> URI::Generic
 
-    def merge_headers: (headers) -> void
+    def merge_headers: (_Each[[String, headers_value]]) -> void
     def bodyless?: () -> bool
     def content_type: () -> ContentType
     def complete?: () -> bool
 
+    def json: (?json_options opts) -> untyped
+
+    def form: () -> Hash[String, untyped]
+
     private
 
-    def initialize: (Request, _ToS, String, headers?) -> untyped
+    def initialize: (Request request, String | Integer status, String version, headers?) -> untyped
     def no_data?: () -> bool
 
+    def decode:(String format, ?untyped options) -> untyped
+
     class Body
-      include _Writer
       include _Reader
       include _ToS
       include _ToStr
 
-      @state: :idle | :memory | :buffer
+      @state: :idle | :memory | :buffer | :closed
       @threshold_size: Integer
       @window_size: Integer
 
+      def write:(String chunk) -> Integer?
+
       def each: () { (String) -> void } -> void
               | () -> Enumerable[String]
 
       def bytesize: () -> Numeric
       def empty?: () -> bool
-      def copy_to: (_ToPath | _Writer destination) -> void
+      def copy_to: (String | File | _Writer destination) -> void
       def close: () -> void
       def closed?: () -> bool
 
       private
 
-      def initialize: (Response, options) -> untyped
+      def initialize: (Response, Options) -> untyped
       def rewind: () -> void
       def transition: () -> void
     end
   end
 
   class ContentType
+    MIME_TYPE_RE: Regexp
+    CHARSET_RE: Regexp
+
     attr_reader mime_type: String?
     attr_reader charset: String?
 
-    def self.parse: (_ToS) -> instance
+    def self.parse: (_ToS) -> ContentType
     def self.mime_type: (_ToS) -> String?
     def self.charset: (_ToS) -> String?
 
     private
 
-    def initialize: (String?, String?) -> untyped
+    def initialize: (String? header_value) -> void
   end
 
   class ErrorResponse
@@ -77,7 +91,6 @@ module HTTPX
     @options: Options
 
     attr_reader request: Request
-    attr_reader error: Exception
 
     def status: () -> (Integer | _ToS)
 

data/sig/selector.rbs

@@ -1,20 +1,22 @@
 module HTTPX
   class Selector
-    READABLE: :r | :rw
-    WRITABLE: :w | :rw
-    @selectables: Array[_ToIO]
+    type selectable = Connection | Resolver::Native | Resolver::HTTPS
 
-    def register: (_ToIO) -> void
-    def deregister: (_ToIO) -> void
+    READABLE: Array[Symbol]
+    WRITABLE: Array[Symbol]
+    @selectables: Array[selectable]
+
+    def register: (selectable) -> void
+    def deregister: (selectable) -> void
+
+    def select: (Numeric? interval) { (selectable) -> void } -> void
 
-    def select: (Numeric?) { (_ToIO) -> void } -> void
-    
     private
 
     def initialize: () -> untyped
 
-    def select_many: (Numeric?) { (_ToIO) -> void } -> void
-    def select_one: (Numeric?) { (_ToIO) -> void } -> void
+    def select_many: (Numeric? interval) { (selectable) -> void } -> void
+    def select_one: (Numeric? interval) { (selectable) -> void } -> void
   end
 
   type io_interests = :r | :w | :rw

data/sig/session.rbs

@@ -3,51 +3,50 @@ module HTTPX
     include Loggable
     include Chainable
 
-    @options: Options
-    @responses: Hash[Request, Response]
-    @persistent: bool
-
-    def wrap: () { (instance) -> void } -> void
-            | () -> void
-    def close: (*untyped) -> void
+    EMPTY_HASH: Hash[untyped, untyped]
 
-    def request: (*Request, **untyped) -> (response | Array[response])
-               | (*untyped, **untyped) -> (response | Array[response])
+    @options: Options
+    @responses: Hash[Request, response]
+    @persistent: bool?
 
-    def build_request: (String | verb, uri, ?options) -> Request
+    def self.plugin: (Symbol | Module plugin, ?options? options) ?{ (Class) -> void } -> singleton(Session)
 
-    def self.plugin: (Symbol | Module, ?options) { (Class) -> void } -> singleton(Session)
-                   | (Symbol | Module, ?options) -> singleton(Session)
+    def self.default_options: -> Options
 
+    def wrap: () { (instance) -> void } -> void
 
+    def close: (*untyped) -> void
 
-    def self.default_options: -> Options
+    def build_request: (String | verb, generic_uri, ?options) -> Request
 
     private
 
-    def initialize: (?options?) { (instance) -> void } -> untyped
-                  | (?options?) -> untyped
+    def initialize: (?options) { (self) -> void } -> untyped
+                  | (?options) -> untyped
 
     def pool: -> Pool
     def on_response: (Request, response) -> void
     def on_promise: (untyped, untyped) -> void
-    def fetch_response: (Request, *untyped) -> response?
+    def fetch_response: (Request request, untyped, untyped) -> response?
+
+    def find_connection: (Request, Array[Connection] connections, Options options) -> Connection
+
     def set_connection_callbacks: (Connection, Array[Connection], Options) -> void
 
-    def build_altsvc_connection: (Connection, Array[Connection], URI, String, Hash[String, String], Options) -> Connection?
+    def build_altsvc_connection: (Connection, Array[Connection], URI::Generic, String, Hash[String, String], Options) -> Connection?
 
     def build_requests: (verb | string, uri, options) -> Array[Request]
                       | (Array[[verb | string, uri, options]], options) -> Array[Request]
                       | (Array[[verb | string, uri]], options) -> Array[Request]
-                      | (verb | string, _Each[[uri, options], void], Options) -> Array[Request]
-                      | (verb | string, _Each[uri, void], options) -> Array[Request]
+                      | (verb | string, _Each[[uri, options]], Options) -> Array[Request]
+                      | (verb | string, _Each[uri], options) -> Array[Request]
 
-    def build_connection: (URI, Options) -> Connection
+    def build_connection: (URI::Generic, Options) -> Connection
 
-    def send_requests: (*Request, options) -> Array[response]
+    def send_requests: (*Request) -> Array[response]
 
-    def _send_requests: (Array[Request], options) -> Array[Connection]
+    def _send_requests: (Array[Request]) -> Array[Connection]
 
-    def receive_requests: (Array[Request], Array[Connection], options) -> Array[response]
+    def receive_requests: (Array[Request], Array[Connection]) -> Array[response]
   end
 end

data/sig/timers.rbs

@@ -0,0 +1,32 @@
+module HTTPX
+  class Timers
+    @interval: Array[Interval]
+
+    def after: (Numeric interval_in_secs) { () -> void } -> void
+
+    def wait_interval: () -> Numeric?
+
+    def fire: (?StandardError error) -> void
+
+    def cancel: () -> void
+
+    private
+
+    def initialize: () -> void
+
+    class Interval
+      include Comparable
+
+      attr_reader interval: Numeric
+
+      def to_f: () -> Float
+
+      def <<: (^() -> void) -> void
+
+      def elapse: (Numeric elapsed) -> Numeric
+      private
+
+      def initialize: (Numeric interval) -> void
+    end
+  end
+end

data/sig/transcoder/body.rbs

@@ -1,7 +1,12 @@
 module HTTPX
   module Transcoder
     module Body
+      class Error < HTTPX::Error
+      end
+
       class Encoder
+        extend Forwardable
+
         include _Encoder
         include _ToS
 
@@ -11,7 +16,7 @@ module HTTPX
 
         private
 
-        def initialize: (untyped body ) -> untyped
+        def initialize: (untyped body) -> untyped
       end
 
       def self?.encode: (bodyIO body) -> Encoder

data/sig/transcoder/chunker.rbs

@@ -1,6 +1,11 @@
 module HTTPX::Transcoder
   module Chunker
-    def self?.encode: (_Encoder chunks) -> Encoder
+    CRLF: String
+
+    class Error < HTTPX::Error
+    end
+
+    def self?.encode: (_Each[String] chunks) -> Encoder
 
     class Encoder
       @raw: _Each[String]
@@ -9,10 +14,11 @@ module HTTPX::Transcoder
 
       private
 
-      def initialize: (_Encoder chunks) -> untyped
+      def initialize: (_Each[String] chunks) -> untyped
     end
 
     class Decoder
+      extend Forwardable
       include _ToS
       include _Each[String]
 

data/sig/transcoder/form.rbs

@@ -3,12 +3,14 @@ module HTTPX::Transcoder
 
   type form_nested_value = form_value | _ToAry[form_value] | _ToHash[string, form_value]
 
-  type urlencoded_input = Enumerable[[string, form_nested_value], untyped]
+  type urlencoded_input = Enumerable[[_ToS, form_nested_value]]
 
   module Form
     def self?.encode: (urlencoded_input form) -> Encoder
+    def self?.decode: (HTTPX::Response response) -> _Decoder
 
     class Encoder
+      extend Forwardable
       include _Encoder
       include _ToS
 

data/sig/transcoder/json.rbs

@@ -1,8 +1,10 @@
 module HTTPX::Transcoder
   module JSON
     def self?.encode: (_ToJson json) -> Encoder
+    def self?.decode: (HTTPX::Response response) -> _Decoder
 
     class Encoder
+      extend Forwardable
       include _Encoder
       include _ToS
 

data/sig/transcoder.rbs

@@ -1,18 +1,26 @@
 module HTTPX
-  type bodyIO = _Reader | _Each[String, untyped] | _ToS
+  type bodyIO = _Reader | _Each[[String, untyped]] | _ToS
 
   module Transcoder
-    extend HTTPX::Registry[String, Class]
+    def self?.registry: (String tag) -> _Encode
+                   | () -> Hash[String, _Encode]
 
-    def self.normalize_keys: (string | Symbol, top, ?Proc?) { (string, top) -> void } -> void
-                           | (string | Symbol, top, ?Proc?) { (string) -> void } -> void
+    def self?.register: (String tag, _Encode handler) -> void
+
+    def self?.normalize_keys: [U] (_ToS key, _ToAry[untyped] | _ToHash[_ToS, untyped] | untyped value, ?(^(untyped value) -> bool | nil) cond) { (String, ?untyped) -> U } -> U
+
+    def self?.normalize_query: (Hash[String, untyped] params, String name, String v, Integer depth) -> void
+
+    interface _Encode
+      def encode: (untyped payload) -> (_Encoder | _Each[String])
+    end
 
     interface _Encoder
       def bytesize: () -> Numeric
     end
 
     interface _Decoder
-      def decode: (string) -> String
+      def call: (Response response, untyped options) -> untyped
     end
   end
 end

data/sig/utils.rbs

@@ -1,7 +1,13 @@
 module HTTPX
   module Utils
+    URIParser: URI::RFC2396_Parser
+
     def self?.parse_retry_after: (String) -> Numeric
 
+    def self?.now: () -> Numeric
+
+    def self?.elapsed_time: (Numeric monotonic_time) -> Numeric
+
     def self?.to_uri: (generic_uri uri) -> URI::Generic
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: httpx
 version: !ruby/object:Gem::Version
-  version: 0.15.4
+  version: 0.18.0
 platform: ruby
 authors:
 - Tiago Cardoso
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-07-14 00:00:00.000000000 Z
+date: 2021-10-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http-2-next
@@ -24,20 +24,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.4.1
-- !ruby/object:Gem::Dependency
-  name: timers
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 description: A client library for making HTTP requests from Ruby.
 email:
 - cardoso_tiago@hotmail.com
@@ -73,6 +59,10 @@ extra_rdoc_files:
 - doc/release_notes/0_15_2.md
 - doc/release_notes/0_15_3.md
 - doc/release_notes/0_15_4.md
+- doc/release_notes/0_16_0.md
+- doc/release_notes/0_16_1.md
+- doc/release_notes/0_17_0.md
+- doc/release_notes/0_18_0.md
 - doc/release_notes/0_1_0.md
 - doc/release_notes/0_2_0.md
 - doc/release_notes/0_2_1.md
@@ -125,6 +115,10 @@ files:
 - doc/release_notes/0_15_2.md
 - doc/release_notes/0_15_3.md
 - doc/release_notes/0_15_4.md
+- doc/release_notes/0_16_0.md
+- doc/release_notes/0_16_1.md
+- doc/release_notes/0_17_0.md
+- doc/release_notes/0_18_0.md
 - doc/release_notes/0_1_0.md
 - doc/release_notes/0_2_0.md
 - doc/release_notes/0_2_1.md
@@ -195,6 +189,7 @@ files:
 - lib/httpx/plugins/h2c.rb
 - lib/httpx/plugins/internal_telemetry.rb
 - lib/httpx/plugins/multipart.rb
+- lib/httpx/plugins/multipart/decoder.rb
 - lib/httpx/plugins/multipart/encoder.rb
 - lib/httpx/plugins/multipart/mime_type_detector.rb
 - lib/httpx/plugins/multipart/part.rb
@@ -207,6 +202,8 @@ files:
 - lib/httpx/plugins/proxy/ssh.rb
 - lib/httpx/plugins/push_promise.rb
 - lib/httpx/plugins/rate_limiter.rb
+- lib/httpx/plugins/response_cache.rb
+- lib/httpx/plugins/response_cache/store.rb
 - lib/httpx/plugins/retries.rb
 - lib/httpx/plugins/stream.rb
 - lib/httpx/plugins/upgrade.rb
@@ -216,7 +213,6 @@ files:
 - lib/httpx/punycode.rb
 - lib/httpx/registry.rb
 - lib/httpx/request.rb
-- lib/httpx/request2.rb
 - lib/httpx/resolver.rb
 - lib/httpx/resolver/https.rb
 - lib/httpx/resolver/native.rb
@@ -225,6 +221,8 @@ files:
 - lib/httpx/response.rb
 - lib/httpx/selector.rb
 - lib/httpx/session.rb
+- lib/httpx/session2.rb
+- lib/httpx/timers.rb
 - lib/httpx/transcoder.rb
 - lib/httpx/transcoder/body.rb
 - lib/httpx/transcoder/chunker.rb
@@ -271,6 +269,7 @@ files:
 - sig/plugins/proxy/ssh.rbs
 - sig/plugins/push_promise.rbs
 - sig/plugins/rate_limiter.rbs
+- sig/plugins/response_cache.rbs
 - sig/plugins/retries.rbs
 - sig/plugins/stream.rbs
 - sig/plugins/upgrade.rbs
@@ -285,6 +284,7 @@ files:
 - sig/response.rbs
 - sig/selector.rbs
 - sig/session.rbs
+- sig/timers.rbs
 - sig/transcoder.rbs
 - sig/transcoder/body.rbs
 - sig/transcoder/chunker.rbs
@@ -315,7 +315,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.15
+rubygems_version: 3.2.22
 signing_key:
 specification_version: 4
 summary: HTTPX, to the future, and beyond

data/lib/httpx/request2.rb

@@ -1,14 +0,0 @@
-require_relative "request"
-module HTTPX
-  class Request
-    def response=(response)
-      return unless response
-
-      if response.status == 100
-        @informational_status = response.status
-        return
-      end
-      @response = response
-    end
-  end
-end