httpx 0.6.7 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '086c7a29b7788e44b3b1e84dff63b55443e0521e7939ba680ba9334690bb3d10'
-  data.tar.gz: d8a69f563dfd7fe892e1227ad8aba6ae258b16a10b22545aa52e5127e6822ee0
+  metadata.gz: e15b3e81842118829ecc251093ce5e80ad0c82dada2c7b2588004b2bf7313f63
+  data.tar.gz: 9d4efcb47f0c269f2c5b9a3c950fe8069c3b76ffb2f9624b557d29a702704712
 SHA512:
-  metadata.gz: 10ef2a61f98d0418eacef74e99f3d7cc3873bbd0f52ed1e312ea705df39eacb9cc943ceac30bc26b880f2faa05e9a5840706a311306616ae0cd417904e492b98
-  data.tar.gz: 729b0ab97ae5e5a4cb6693593218c9e2a6f10505d190dd3c87461fb77f685e833180e2583bca19fdaf8f7267952f21dc752f4b4a9abf22a8a7f67fe1c85ce3c0
+  metadata.gz: 9fbd146e351da8f603c8b00c236d92c7a2a3c383296736f271c88b0ac310086adf0127af7b630e9087ec45c4a22494128b2efafdb2592de43df4aae4a68ef1f3
+  data.tar.gz: eecb817b76bc0f217b728c7e862f73758e4b2db9c6a943311e0c7d10d8e7fe6bfa8e56a7c0d4593158fb605927813a1e720ec85a9d7e70aae8ecce015f5da647

data/README.md

@@ -2,7 +2,7 @@
 
 [![Gem Version](https://badge.fury.io/rb/httpx.svg)](http://rubygems.org/gems/httpx)
 [![pipeline status](https://gitlab.com/honeyryderchuck/httpx/badges/master/pipeline.svg)](https://gitlab.com/honeyryderchuck/httpx/commits/master)
-[![coverage report](https://gitlab.com/honeyryderchuck/httpx/badges/master/coverage.svg)](https://honeyryderchuck.gitlab.io/httpx/coverage/#_AllFiles)
+[![coverage report](https://gitlab.com/honeyryderchuck/httpx/badges/master/coverage.svg?job=coverage)](https://honeyryderchuck.gitlab.io/httpx/coverage/#_AllFiles)
 
 HTTPX is an HTTP client library for the Ruby programming language.
 
@@ -10,19 +10,21 @@ Among its features, it supports:
 
 * HTTP/2 and HTTP/1.x protocol versions
 * Concurrent requests by default
-* Simple and chainable API (based on HTTP.rb, itself based on Python Requests)
+* Simple and chainable API
 * Proxy Support (HTTP(S), Socks4/4a/5)
 * Simple Timeout System
-* Lightweight (explicit feature loading)
+* Lightweight by default (require what you need)
 
-And among others
+And also:
 
 * Compression (gzip, deflate, brotli)
 * Authentication (Basic Auth, Digest Auth)
+* Expect 100-continue
+* Multipart Requests
 * Cookies
 * HTTP/2 Server Push
 * H2C Upgrade
-* Redirect following
+* Automatic follow redirects
 
 ## How
 

data/doc/release_notes/0_0_1.md

@@ -0,0 +1,7 @@
+# Genesis Release
+
+This is the first release of `httpx`.
+
+It accomplishes all the API and feature goals necessary to its first use, which is testing server implementations.
+
+From here on, the sky is the limit. 

data/doc/release_notes/0_0_2.md

@@ -0,0 +1,9 @@
+# 0.0.2
+
+* Hot-Fixed a flaw from the first version which was breaking https calls (SNI was broken).
+
+* Added a few test hackernews scraping scripts, which will be used for trouble-shooting/benchmarking.
+
+* Refactored/Fixed closing connections (HTTP/2 connections were buffering but not sending the GOAWAY frame)
+
+

data/doc/release_notes/0_0_3.md

@@ -0,0 +1,9 @@
+# 0.0.3
+
+* Added `HTTPX::Response#raise_for_status`. If there was an error response, it will raise it's exception. If the HTTP response has a 4xx or 5xx error, it will raise an `HTTPX::HTTPError` exception (this feature was inspired by a similar feature in python requests library).
+
+* Added `HTTPX::Client#wrap`, which allows to use the client inside a block and keep connections open, without resorting to the initializer only.
+
+* TCP connection establishment errors are now wrapped in error responses, like other possible errors.
+
+* SSL non-blocking connection API is now in use (it was previously using the blocking connect API, and was breaking the hackernews script from time to time. Now I'm looking at you, DNS).

data/doc/release_notes/0_0_4.md

@@ -0,0 +1,7 @@
+# 0.0.4
+
+* Added ANSI coloring to the debugging output (when in TTY mode).
+
+* `HTTPX::HTTPError` exceptions now carry the full response object, instead of just the status (so the user can inspect the body and headers if it so desires).
+
+* Fixed a bug related with HTTP/1 multiple requests on a domain which closed connections not being able to open a new socket to the domain.

data/doc/release_notes/0_0_5.md

@@ -0,0 +1,5 @@
+# 0.0.5
+
+* Fixed HTTP/1 pipelining (it's working again).
+
+* Fixed multiple requests to the same domain over https (SSL sockets weren't being properly reopened).

data/doc/release_notes/0_1_0.md

@@ -0,0 +1,9 @@
+# 0.1.0
+
+* Follow Redirects Plugin: Added `:follow_insecure_redirects` option, which will not follow https-to-http redirects.
+
+* Allow optional option `:transport`. TCP sockets are the default tranport, but by passing `:unix`, one can also define it as a UNIX socket. 
+
+* Added Retries Plugin, which will retry a request a certain amount of times, provided that the request is safe.
+
+* Proxy Plugin: allow multiple proxies to be passed. The client will perform requests on the first proxy successfully connected.

data/doc/release_notes/0_2_0.md

@@ -0,0 +1,5 @@
+# 0.2.0
+
+* Custom Resolvers: Non-blocking DNS Resolver, DNS-over-HTTPS Resolver
+
+* HTTP/2 connection coalescing

data/doc/release_notes/0_2_1.md

@@ -0,0 +1,16 @@
+# 0.2.1
+
+* fixed setting timeouts using the chainable API
+
+* Basic Auth: proper user/password escaping
+
+* Improved multi-request support, by allowing to pass request-specific options for multiple requests
+
+```ruby
+tokens = ["TOKEN1", "TOKEN2", "TOKEN3"]
+uri = "https://example.com/protected"
+
+requests = tokens.map { |token| [uri, {headers: {'authorization': token} }] }
+
+responses = HTTPX.get(*requests)
+```

data/doc/release_notes/0_3_0.md

@@ -0,0 +1,12 @@
+# 0.3.0
+
+* removed `http_parser.rb`, which is unmaintained, builds an old version of node's parser, and doesn't work on JRuby 9.2; also, better support over HTTP/1 features.
+
+* Alt-Svc support (all remaining origin requests will be routed there); Supports both `Alt-Svc` header and the `altsvc` HTTP/2 frame.
+
+* moved multipart requests support to a separate plugin, which removed `http_form_data` as a hard dependency (you'll still need it for the plugin though).
+
+* new `HTTP.wrap { |client| }` method.
+
+* We have a cheatsheet! 
+

data/doc/release_notes/0_3_1.md

@@ -0,0 +1,6 @@
+# 0.3.1
+
+* improved DNS resolution error handling (decoding/encoding errors, system resolver)
+
+* hotfix: Native/HTTPS resolver not retrying same record type after cache expired, effectively not working after some time for long-running processes
+

data/doc/release_notes/0_4_0.md

@@ -0,0 +1,51 @@
+# 0.4.0
+
+* Feature: SSH proxy plugin -> send requests over ssh gateway;
+
+```ruby
+HTTPX.plugin(:"proxy/ssh").
+	  with_proxy(uri: "ssh://localhost:2222",
+                 username: "root",
+                 auth_methods: %w[publickey],
+                 host_key: "ssh-rsa",
+                 keys: %w[test/support/ssh/ssh_host_ed25519_key]).get(URI)
+```
+
+* Feature: Faraday Adapter
+
+* refactoring: cookies plugin API simplification (this is a breaking change!):
+
+```ruby
+session = HTTPX.plugin(:cookies)
+session.with_cookies("a" => "b").get(...
+session.cookies #=> session current cookie store, persists/updates session cookies as requests are processed
+session.wrap do |session|
+  session.get(..) #=> "Set-Cookie"
+  ...
+end #=> after this, cookie store resets to the state previous to wrap
+```
+
+Removed `Session#cookie_store`
+
+```ruby
+client = HTTPX.plugin(:cookies)
+redirect_response = client.get(URI) #=> ... 302 ... Set-Cookie: "blablalba" ...
+# this sets the cookies
+# GET .... Cookie: "blablabla" ....
+response = client.get(URI) #=> ... 200 ...
+# also, setting cookies:
+
+client.cookies("a" => "b").get(URI) # ... Cookie: "a=b" ...
+
+#also seamlessly integrates with redirect follows
+client = HTTPX.plugins(:follow_redirects, :cookies)
+response = client.get(URI) #=> ... 200 ...
+```
+
+* refactoring: connection pool now thread-local, improves thread-safety;
+
+* bugfix: leaking dns query when passing IO object as option;
+
+* bugfix: now multiple different resolvers are supported;
+
+* support: JRuby is again supported (as usual, only latest stable is guaranteed)

data/doc/release_notes/0_4_1.md

@@ -0,0 +1,3 @@
+# 0.4.1
+
+This was a fix release for some issues around exceptions on requests, and to make the faraday adapter work well with ssl.

data/doc/release_notes/0_5_0.md

@@ -0,0 +1,15 @@
+# 0.5.0
+
+This release is a minor bump only because it introduces a new dependency:
+
+## the `timers` gem
+
+We've introduced the [`timers` gem](https://github.com/socketry/timers) as a dependency to deal with total timeouts, thereby making the timeout object only a container of values to be refactored. This was in itself a small gain for such a big addition, but other future time-based features can be best built upon it than the existing work.
+
+
+## Bugfixes
+
+* the altsvc header wasn't properly parsed, and was breaking requests to google. Don't break requests to google!
+* Added support for faraday 0.16;
+* Made the IO selector less flaky;
+* Fixed the homepage, which was being displayed without styles;

data/doc/release_notes/0_5_1.md

@@ -0,0 +1,14 @@
+# 0.5.1
+
+## Improvements
+
+* Fixed flakiness of test suite introduced in the 0.4 versions;
+* compression plugin:
+  * do not send `accept-encoding` header when `range` is present;
+  * Remove from `content-encoding` if body stream decodes it;
+  * Added `HTTPX::Response::Body#encodings` to return the decoded encoding(s);
+
+## Bugfixes
+
+* non-UTF-8 bodies weren't being properly handled, which led to a loop report (`slice` -> `byteslice`);
+* connection reuse now also happens for requests with body (it was only working with `GET`s and other bodyless requests before);

data/doc/release_notes/0_6_0.md

@@ -0,0 +1,5 @@
+# 0.6.0
+
+## Improvements
+
+* Switches `http-2` gem with `http-2-next`, a fork with a focus on spec compliance.

data/doc/release_notes/0_6_1.md

@@ -0,0 +1,6 @@
+# 0.6.1
+
+## Bugfixes
+
+* If an http2 connection error happened before streams were open, errors weren't propagated, and there was an infinite loop.
+* Bumping `http-2-next`, fixes the flow control issue causing requests to cloudfront to fail.

data/doc/release_notes/0_6_2.md

@@ -0,0 +1,6 @@
+# 0.6.2
+
+## Bugfixes
+
+* Remove escaping of request uri;
+* strip header value (if value have newline, for example);

data/doc/release_notes/0_6_3.md

@@ -0,0 +1,13 @@
+# 0.6.3
+
+## Improvements
+
+* HTTP/2 `ORIGIN` frame support (https://tools.ietf.org/html/draft-ietf-httpbis-origin-frame-06);
+* Added functional tests for HTTP/2 connection coalescing (and fixed it, as it hasn't been working for a while);
+* Added functional tests for `Alt-Svc` header support;
+
+## Bugfixes
+
+* fixing alternative service redirection if `alt-svc` header pointed to the current peer;
+* fixing `alt-svc` support when ruby version does not support ALPN negotation;
+

data/doc/release_notes/0_6_4.md

@@ -0,0 +1,21 @@
+# 0.6.4
+
+This release takes where the last left off, and makes a concerted effort to improve both the test coverage and the number of features for which there are functional tests.
+
+## Improvements
+
+* Running Ruby 2.7 with no warnings;
+
+* Test suite now has functional tests for:
+  * authentication on proxies (http, socks4a, socks5);
+  * DNS-over-HTTPS;
+  * connect timeouts (still a bit flaky though);
+
+* Improved test coverage of project to 90%;
+
+* building website/blog with Jekyll 4;
+
+## Bugfixes
+
+* fixed regressions on HTTP, SOCKS4a and SOCKS5 proxy authentication;
+* fixed DNS-over-HTTPS implementation to be compliant with the latest RFC;

data/doc/release_notes/0_6_5.md

@@ -0,0 +1,22 @@
+# 0.6.5
+
+This release fixes important bugs, and automates the PKI for the test suite.
+
+## Features
+
+* `resolver_options` can now receive a `:cache` flag (default: `true`). This bypasses caching and forces the lookup;
+
+## Improvements
+
+* Building the TLS certs necessary for the test suite has been scripted, after the initial certs expired and brought the CI to a halt;
+* All DNS resolvers have a functional test, both for the happy as well as the error case;
+* Added functional tests for HTTP and HTTPS proxy with authentication, making all proxy options now tested with authentication;
+
+
+## Bugfixes
+
+* native and https DNS resolvers weren't usable after a resolving error;
+* system DNS resolver could halt the system after a dns resolving error;
+* fixed system halt on HTTP proxy authentication error;
+
+

data/doc/release_notes/0_6_6.md

@@ -0,0 +1,19 @@
+# 0.6.6
+
+## Features
+
+* The `retries` plugin receives two new options:
+  * `retry_on`: a callable that receives the failed response as an argument; the return value will determine whether there'll be a retried request.
+  * `retry_after`: time (in seconds) after which there request will be retried. Can be an integer or a callable that receives the request and returns an integer (one can do exponential back-off like that, for example).
+* Added support for DNS-over-HTTPS GET requests as per the latest spec.
+
+## Improvements
+
+* `HTTPX.plugins` got deprecated; basically, it's great until you have to pass options to a plugin, and then it just works (not). The recommended way to load multiple plugins is `HTTPX.plugin(...).plugin(...)`.
+
+
+## Bugfixes
+
+* fixed a proxy bug where an `Alt-Svc` response header would make the client try to connect. Just like connection coalescing and the ORIGIN frame, it ignores it when going through a proxy.  
+
+

data/doc/release_notes/0_6_7.md

@@ -0,0 +1,5 @@
+# 0.6.7
+
+## Bugfixes
+
+* An error was reported when using the follow plugin allowing insecure redirects: if the insecure redirect would be for the same host, and the original request was performed with HTTP/2, the library would try to coalesce the request, and blocks the reactor. A check was made to ensure that connection only coalesces if both are https connections.

data/doc/release_notes/0_7_0.md

@@ -0,0 +1,46 @@
+# 0.7.0
+
+
+## Features
+
+New option: `:max_requests`. This is a connection-level option signalizing how many requests can be performed on a connection. Although the HTTP/1 parser defined this well, in HTTP/2 this wasn't very clear, so: by definition, the remote MAX_CONCURRENT_STREAMS setting will be used to define it, unless the user explicitly passed the option. You can also pass `:max_requests => Float::INFINITY` if you know that the server allows more requests than that on a connection.
+
+New plugin: `:expect`. 
+
+Although there was support for `expect: 100-continue` header already when passed, this plugin can:
+
+* automatically set the header on requests with body;
+* execute the flow;
+* recover from 417 status errors (i.e. try again without it);
+* send body after X seconds if no 100 response came;
+
+Suport for `with_` methods for the session. As long as the suffix is a valid attribute, it's just like that:
+
+```ruby
+HTTPX.with_timeout(...).with_ssl(...)
+# same as:
+# HTTPX.with(timeout: ..., ssl: ...)
+```
+
+## Improvements
+
+### Connections
+
+The following improvements make the `persistent` plugin way more resilient:
+
+* Better balancing of HTTP/2 connections by distributing requests among X connections depending of how many requests they can process.
+* Exhausted connections can off-load to a new same-origin connection (such as, when the server negotiates less `MAX_CONCURRENT_STREAMS` than what's expected).
+
+### Timeouts
+
+(Timeouts will be one of the main improvements from the 0.7.x series)
+
+`:total_timeout` is now a connection-level directive, which means that this feature will actually make more sense and account for all requests in a block at the same time, instead of one-by-one.
+
+### Options
+
+Option setters were being bypassed, therefore a lot of the type-checks defined there weren't effectively being picked upon, which could have led to weird user errors.
+
+## Bugfixes
+
+* fixed the `push_promise` plugin integration (wasn't working well since `http-2-next` was adopted);

data/doc/release_notes/0_8_0.md

@@ -0,0 +1,27 @@
+# 0.8.0
+
+
+## Features
+
+* `keep_alive_timeout`: for persistent connections, the keep alive timeout will set the connection to be closed if not reused for a request **after** the last received response;
+
+## Improvements
+
+* using `max_requests` for HTTP/1 pipelining as well;
+* `retries` plugin now works with plain HTTP responses (not just error responses);
+* reduced the number of string allocations from log labels;
+* performance: a lot of improvements were made to optimize the "waiting for IO events" phase, which dramatically reduced the CPU usage and make the performance of the library more on-par with other ruby HTTP gems for the 1-shot request scenario.
+
+
+## Bugfixes
+
+* fixed `HTTPX::Response#copy_to`;
+* fixed `compression` plugin not properly compressing request bodies using `gzip`;
+* fixed `compression` plugin not handling `content-encoding: identity` payloads;
+* do not overwrite user-defined `max_requests`on HTTP2 connection handshake;
+* `retries` plugin: connection was blocking when a request with body was retried;
+* `alt-svc: clear` response header was causing the process to hang;
+
+## Tests
+
+* Code coverage improved to 91%;

data/doc/release_notes/0_8_1.md

@@ -0,0 +1,8 @@
+# 0.8.1
+
+
+## Bugfixes
+
+* fixing HTTP/2 handshake IO interests calculation;
+* fixed the double ctrl+f issue when terminating an ongoing HTTP/2 request;
+* fixed connection comparison when passing headers;

data/doc/release_notes/0_8_2.md

@@ -0,0 +1,7 @@
+# 0.8.2
+
+## Features
+
+* `:expect` plugin now supports a new option, `:expect_threshold_size`, meaning: the byte size threshold below which no `expect` header will be sent with requests with payload.
+* `:compression` plugin now supports a new option, `:compression_threshold_size`, meaning: the bytesize threshold below which request payload won't be compressed before being sent.
+* for HTTP/2 connections, when `keep_alive_timeout` expires, a `PING` frame is used to check connection availability; if successful, the connection will be reused.