httpx 0.8.0 → 0.10.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4ac832ee93155b950d27dde3d7295fae2b817a8b2c55c881ec07f73e97736c59
-  data.tar.gz: 28251067c648230eed4435b9df7cf75bfc1c552162f37928a8ee6c5b485d6c3b
+  metadata.gz: ed5ebccf22cf5c4719a81db15ee29a7d05e08fa43bd83b14c3b2682c083615be
+  data.tar.gz: 2befada7d0c17d0c20d0afce44fc0a9d3192ffb2bb311322ee171107d285d050
 SHA512:
-  metadata.gz: d7b9f1419af3bb823ff58de80dca6a933bf25a756e27ff35f76c5ad7948ad1aab1c1f63f8eaf20bc9fc05bb0b2ed4932fd5ff1e33bcd7a8cda061bee2c54e4ac
-  data.tar.gz: f410653e0e1646f36eeaf90746bfae17d8c344abdf44eb92df2a992897d24843d16e370ec54f6441bedfe779981d17e4b9c5316f73115adc77e0639cb8dba53f
+  metadata.gz: 9abffdd09d11f8c22c51f38064525d6d5250fe1e72a2e369f79c98e7d02ee6fe7a7442ac76758bf60cbc87eabe51a3faa30a675f4a30cb83a01e09aa98334d0a
+  data.tar.gz: 9c0706ac930dc0e082845795784a5007d0cd9bb25f4a81435be6d8e081ba29528a0df05fc03713dc07615329944ca586e4df8386766c6b5ff440c96d90dc472e

data/LICENSE.txt

@@ -189,3 +189,51 @@
    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    See the License for the specific language governing permissions and
    limitations under the License.
+
+
+* lib/httpx/domain_name.rb
+
+This file is derived from the implementation of punycode available at
+here:
+
+https://www.verisign.com/en_US/channel-resources/domain-registry-products/idn-sdks/index.xhtml
+
+Copyright (C) 2000-2002 Verisign Inc., All rights reserved.
+
+Redistribution and use in source and binary forms, with or
+without modification, are permitted provided that the following
+conditions are met:
+
+ 1) Redistributions of source code must retain the above copyright
+    notice, this list of conditions and the following disclaimer.
+
+ 2) Redistributions in binary form must reproduce the above copyright
+    notice, this list of conditions and the following disclaimer in
+    the documentation and/or other materials provided with the
+    distribution.
+
+ 3) Neither the name of the VeriSign Inc. nor the names of its
+    contributors may be used to endorse or promote products derived
+    from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
+FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
+COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
+INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
+BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
+OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
+AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
+ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGE.
+
+This software is licensed under the BSD open source license. For more
+information visit www.opensource.org.
+
+Authors:
+ John Colosi (VeriSign)
+ Srikanth Veeramachaneni (VeriSign)
+ Nagesh Chigurupati (Verisign)
+ Praveen Srinivasan(Verisign)

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,23 @@ 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)
+* Streaming Requests
 * Authentication (Basic Auth, Digest Auth)
+* Expect 100-continue
+* Multipart Requests
 * Cookies
 * HTTP/2 Server Push
 * H2C Upgrade
-* Redirect following
+* Automatic follow redirects
+* International Domain Names
 
 ## 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_10_0.md

@@ -0,0 +1,66 @@
+# 0.10.0
+
+## Features
+
+### Streaming Requests
+
+The `stream` plugin adds functionality to handle long-lived stream responses, such as the Twitter Streaming API:
+
+```ruby
+http = HTTPX.plugin(:stream)
+
+http.get(stream_api_endpoint, stream: true).each_line do |line|
+  payload = JSON.parse(line)
+  # do smth with this
+end
+```
+
+https://gitlab.com/honeyryderchuck/httpx/-/wikis/Stream
+
+### Rate Limiter
+
+The `rate_limiter` plugin adds functionality for automatically hooking into rate-limiting responses coming from the server, and waits-and-retries them according to what the server advertises.
+
+```ruby
+HTTPX.plugin(:rate_limiter).get(rate_limited_api_endpoint)
+# => 429 Too Many Requests .... Retry-After: 3
+# waits 3 seconds before retrying
+```
+
+https://gitlab.com/honeyryderchuck/httpx/-/wikis/Rate-Limiter
+
+### Ruby 3
+
+This release is the first testing against and targeting Ruby 3 and some of the new features.
+
+It ships with RBS signatures for all of the client-facing APIs. There's non 100% typinng coverage yet, but I'm gradually (pun intended) working on it.
+
+
+## Improvements
+
+### IDN support
+
+Requests where the domains are formed by non-ASCII characters, are now supported (if you're using ruby 2.3 or more recent).
+
+```ruby
+HTTPX.get("http://bücher.ch") # it works!
+```
+
+### cookies plugin full implementation
+
+
+The `cookies` plugin is now independent of 3rd-party gems. The motivation for this was that `http-cookie` was dependent of both `domain_name` and `unf` gems, which are currently unusable in ruby 3, and haven't received any update in the last 3 years.
+
+The implementation is still compliant with RFC6265, and all of the features provided in earlier versions were ported, exceptwhen loading the cookie jar stored in a Netscape-format file or Mozilla sqlite database, which were not documented for `httpx` anyway, and I considered too niche to backport. If you feel `httpx` should support those, do let me know.
+
+Some code from these gems, including the ruby punycode implementation, is now part of the source tree, along with its licenses and attribution mentions.
+
+## Bugfixes
+
+
+Several edge-case bugs have been fixed solely by the integration of RBS runtime type checking, including some bugs around closing a connection pool that can cause loops.
+
+
+## Regressions
+
+`HTTPX::ErrorResponse`'s methods `#headers` and `#reason` were removed, as they didn't provide much value. Consider calling `#raise_for_status` or checking the API (`is_a?(HTTPX::ErrorResponse)` or `respond_to?(:error)` are strategies for this).

data/doc/release_notes/0_10_1.md

@@ -0,0 +1,39 @@
+# 0.10.1
+
+## Improvements
+
+### URL-encoded nested params
+
+url encoder now supports nested params, which is a standard of rack-based frameworks:
+
+```ruby
+HTTPX.post("https://httpbin.org/post", form: { a: { b: 1 }, c: [2, 3] })
+# a[b]=1&c[]=2&c[]=3
+```
+
+This encoding scheme is now the standard for URL-encoded request bodies, query params, and `:multipart` plugin requests.
+
+### Socks4 IPv6 addresses
+
+HTTPX supports IPv6 Socks4 proxies now. This support is restricted to rubies where `IPAddr#hton` is implemented though, so you are encouraged to upgrade.
+
+## More verbose HTTP Errors
+
+`HTTPX::Response#raise_for_status` was raising exceptions for client/server HTTP errors codes (4xx/5xx). However, only the status code was part of the message.
+
+From now on, both headers and the responnse payload will also appear, so expected more verbosity, but also more meaningful information.
+
+## Bugfixes
+
+* HTTP/2 and HTTP/1.1 exhausted connections now get properly migrated into a new connection;
+* HTTP/2 421 responses will now correctly migrate the connection and pendign requests to HTTP/1.1 (a hanging loop was being caused);
+* HTTP/2 connection failed with a GOAWAY settings timeout will now return error responses (instead of hanging indefinitely);
+* Non-IP proxy name-resolving errors will now move on to the next available proxy in the list (instead of hanging indefinitely);
+* Non-IP DNS resolve errors for `native` and `https` variannts will now return the appropriate error response (instead of hanging indefinitely);
+* 
+
+
+## Chore
+
+* `HTTPX.plugins` is now officially deprecated (use `HTTPX.plugin` instead);
+

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;