excon 0.49.0 → 0.88.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 89343aee2679e6e6b180e22e1ae3c16f5680bd4c
-  data.tar.gz: 354d695485716081f2b7732bbbb2b15964f8e738
+SHA256:
+  metadata.gz: 4833043db3796214dc4c5e339db701b609f0664fe5e3dd24f9c0c69a4e94d3ca
+  data.tar.gz: 6a2cba5d185ded99cffbf4057ed141ca15993ed409a5bb8059aef83b6d26c680
 SHA512:
-  metadata.gz: 35185514c9f9460e3409282f8da653832110c6e13813e964d1bc53424fccd4d9dfce972a4811bddae2c9929e19b81860c50326620675b4a23f9c71c59bda24bf
-  data.tar.gz: 75d1f86fb2d5d66576d50b183c32d358c43408129ade13adb653a7333b1a2825083d4e66c61dfb476d78729fc4fcca087f14d24fbfa5d4d8dea02815e1efb7ef
+  metadata.gz: 5dc2124ca9454071c435b814a70dff35c2eee0ed7f7f0e90f5cbd7b5705863c7bd8c69ab40f86d626c83672cd94117a7f6b4bf581101d699034bde70be96d93e
+  data.tar.gz: a9048686e48a21fa494dc09394881fa11ff7a6786bb216e06ceb95530d251e3c04c331f5a2b24e04e60cb08e4a5e7003f6ece127c01dc5a4c71df27361d27a66

data/CONTRIBUTORS.md

@@ -1,4 +1,8 @@
+* Aaron Stone <aaron@serendipity.cx>
+* Adam Esterline <adam@esterlines.com>
+* Alexander Sandström <alexander@skovik.com>
 * Andrew Katz <andrew.katz@outright.com>
+* Andy Delcambre <adelcambre@gmail.com>
 * Anshul Khandelwal <anshul@anshulkhandelwal.com>
 * Ash Wilson <smashwilson@gmail.com>
 * Ben Burkert <ben@benburkert.com>
@@ -7,12 +11,15 @@
 * Brandur <brandur@mutelight.org>
 * Brian D. Burns <iosctr@gmail.com>
 * Brian Hartsock <brian.hartsock@gmail.com>
+* Bryan Paxton <starbelly@pobox.com>
 * Caio Chassot <dev@caiochassot.com>
 * Caius Durling <dev@caius.name>
 * Carl Hörberg <carl.hoerberg@gmail.com>
+* Carl Hörberg <carl.hoerberg@gmail.com>
 * Carlos Sanchez <csanchez@maestrodev.com>
+* Casper Thomsen <ct@clearhaus.com>
+* Chris Hanks <christopher.m.hanks@gmail.com>
 * Claudio Poli <masterkain@gmail.com>
-* Colin Dean <colindean@us.ibm.com>
 * Damien Mathieu <damien@heroku.com>
 * Dan Hensgen <dan@methodhead.com>
 * Dan Peterson <dpiddy@gmail.com>
@@ -24,35 +31,44 @@
 * David Biehl <lazylodr@gmail.com>
 * Dimitrij Denissenko <dimitrij@blacksquaremedia.com>
 * Dominik Richter <dominik.richter@gmail.com>
+* Doug McInnes <doug@dougmcinnes.com>
 * Eugene Howe <eugene@xtreme-computers.net>
 * Evan Phoenix <evan@fallingsnow.net>
 * Fabian Wiesel <fabian.wiesel@sap.com>
 * Federico Ravasio <ravasio.federico@gmail.com>
 * Glenn Pratt <glennpratt@gmail.com>
 * Graeme Nelson <graeme.nelson@gmail.com>
+* Guillaume Balaine <igosuki@gmail.com>
 * Hakan Ensari <hakan.ensari@papercavalier.com>
 * Ian Neubert <ian@ianneubert.com>
 * Jacob Atzen <jacob@incremental.dk>
+* James Cox <james@imaj.es>
 * James Watling <watling.james@gmail.com>
+* Jean Mertz <jean@mertz.fm>
 * Jeremy Hinegardner <jeremy@copiousfreetime.org>
+* Jesse Kempf <jesse.kempf@opower.com>
+* Joe Rafaniello <jrafanie@redhat.com>
 * John Keiser <jkeiser@opscode.com>
 * John Leach <john@brightbox.co.uk>
 * Jonas Pfenniger <jonas@pfenniger.name>
 * Jonathan Dance <github@wuputah.com>
 * Jonathan Dance <jd@wuputah.com>
 * Jonathan Roes <jroes@jroes.net>
+* Joshua B. Smith <jbsmith@us.ibm.com>
 * Joshua Gross <joshua@surfeasy.com>
 * Joshua Mckinney <joshmckin@gmail.com>
 * Joshua Napoli <jnapoli@swipely-napoli.home>
 * Joshua Napoli <jnapoli@swipely-napoli.local>
-* Joshua Smith <kognate@gmail.com>
+* Kelly Mahan <kmahan@kmahan.com>
 * Kensuke Nagae <kyanny@gmail.com>
 * Konstantin Shabanov <etehtsea@gmail.com>
 * Kyle Rames <kyle.rames@rackspace.com>
 * Lewis Marshall <lewis@lmars.net>
 * Lincoln Stoll <me@lstoll.net>
 * Louis Sobel <sobel@mit.edu>
+* Mahemoff <michael@mahemoff.com>
 * Mathias Meyer <meyer@paperplanes.de>
+* Matt Gauger <matt.gauger@gmail.com>
 * Matt Sanders <matt@modal.org>
 * Matt Sanders <matt@polycot.com>
 * Matt Snyder <snyder2112@me.com>
@@ -68,16 +84,27 @@
 * Nathan Sutton <nate@zencoder.com>
 * Nick Osborn <nick.osborn@digital.cabinet-office.gov.uk>
 * Nicolas Sanguinetti <contacto@nicolassanguinetti.info>
+* Paul Gideon Dann <pdgiddie@gmail.com>
+* Pavel <pavel.evst@gmail.com>
 * Peter Meier <peter.meier@immerda.ch>
 * Peter Weldon <peter.weldon@null.net>
 * Peter Weldon <peter@lautus.net>
+* Phil Ross <phil.ross@gmail.com>
+* Richard Ramsden <richard@rramsden.ca>
+* Ruslan Korolev <rs3@fastmail.com>
+* Ruslan Korolev <rs41@gmx.com>
 * Ruslan Kyrychuk <ruslan.kyrychuk@gmail.com>
+* Ryan Bigg <radarlistener@fastmail.fm>
 * Ryan Mohr <ryan.mohr@gmail.com>
+* Sam Withrow <sam.withrow@curiousnation.org>
 * Scott Gonyea <me@aitrus.org>
 * Scott Gonyea <me@sgonyea.com>
+* Scott Walkinshaw <scott.walkinshaw@gmail.com>
 * Sean Cribbs <seancribbs@gmail.com>
 * Sergio Rubio <rubiojr@frameos.org>
 * Shai Rosenfeld <shaiguitar@gmail.com>
+* Stefan Merettig <stefan-merettig@nuriaproject.org>
+* Stephen Chu <github@stephenchu.com>
 * Swanand Pagnis <swanandp@users.noreply.github.com>
 * Terry Howe <terrylhowe@gmail.com>
 * Thom Mahoney & Josh Lane <tmahoney@engineyard.com>
@@ -88,12 +115,14 @@
 * Tom Maher <tmaher@tursom.org>
 * Trym Skaar <trym@tryms.no>
 * Tuomas Silen <tuomas.silen@nodeta.fi>
+* Victor Costan <costan@gmail.com>
 * Viven <vivien.schilis@gmail.com>
 * Wesley Beary <geemus+github@gmail.com>
 * Wesley Beary <geemus@engineyard.com>
 * Wesley Beary <geemus@gmail.com>
 * Wesley Beary <wbeary@engineyard.com>
 * Wesley Beary <wesley@heroku.com>
+* Zach Anker <zanker@squareup.com>
 * chrisrhoden <carhoden@gmail.com>
 * dickeyxxx <jeff@dickeyxxx.com>
 * geemus (Wesley Beary) <wbeary@engineyard.com>
@@ -106,5 +135,6 @@
 * rinrinne <rinrin.ne@gmail.com>
 * rkyrychuk <ruslan.kyrychuk@gmail.com>
 * sshaw <skye.shaw@gmail.com>
+* starbelly <starbelly@pobox.com>
 * twrodriguez <tw.rodriguez@gmail.com>
-* zimbatm <zimbatm@zimbatm.com>
+* zimbatm <zimbatm@zimbatm.com>

data/LICENSE.md

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2009-2015 [CONTRIBUTORS.md](https://github.com/excon/excon/blob/master/CONTRIBUTORS.md)
+Copyright (c) 2009-2019 [CONTRIBUTORS.md](https://github.com/excon/excon/blob/master/CONTRIBUTORS.md)
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of
 this software and associated documentation files (the "Software"), to deal in

data/README.md

@@ -4,10 +4,25 @@ Usable, fast, simple Ruby HTTP 1.1
 
 Excon was designed to be simple, fast and performant. It works great as a general HTTP(s) client and is particularly well suited to usage in API clients.
 
-[![Build Status](https://secure.travis-ci.org/excon/excon.svg)](http://travis-ci.org/excon/excon)
-[![Dependency Status](https://gemnasium.com/geemus/excon.svg)](https://gemnasium.com/geemus/excon)
-[![Gem Version](https://badge.fury.io/rb/excon.svg)](http://badge.fury.io/rb/excon)
-[![Gittip](http://img.shields.io/gittip/geemus.svg)](https://www.gittip.com/geemus/)
+[![Build Status](https://github.com/excon/excon/actions/workflows/ruby.yml/badge.svg)](https://github.com/excon/excon/actions/workflows/ruby.yml)
+[![Gem Version](https://badge.fury.io/rb/excon.svg)](https://badge.fury.io/rb/excon)
+
+* [Getting Started](#getting-started)
+* [Options](#options)
+* [Chunked Requests](#chunked-requests)
+* [Pipelining Requests](#pipelining-requests)
+* [Streaming Responses](#streaming-responses)
+* [Proxy Support](#proxy-support)
+* [Reusable ports](#reusable-ports)
+* [Unix Socket Support](#unix-socket-support)
+* [Stubs](#stubs)
+* [Instrumentation](#instrumentation)
+* [HTTPS client certificate](#https-client-certificate)
+* [HTTPS/SSL Issues](#httpsssl-issues)
+* [Getting Help](#getting-help)
+* [Contributing](#contributing)
+* [Plugins and Middlewares](#plugins-and-middlewares)
+* [License](#license)
 
 ## Getting Started
 
@@ -113,12 +128,16 @@ connection.request(:method => 'GET')
 # expect one or more status codes, or raise an error
 connection.request(:expects => [200, 201], :method => :get)
 
-# this request can be repeated safely, so retry on errors up to 3 times
+# this request can be repeated safely, so retry on errors up to 4 times
 connection.request(:idempotent => true)
 
 # this request can be repeated safely, retry up to 6 times
 connection.request(:idempotent => true, :retry_limit => 6)
 
+# this request can be repeated safely, retry up to 6 times and sleep 5 seconds
+# in between each retry
+connection.request(:idempotent => true, :retry_limit => 6, :retry_interval => 5)
+
 # set longer read_timeout (default is 60 seconds)
 connection.request(:read_timeout => 360)
 
@@ -140,6 +159,9 @@ connection = Excon.new('http://geemus.com/', :nonblock => false)
 
 # use basic authentication by supplying credentials in the URL or as parameters
 connection = Excon.new('http://username:password@secure.geemus.com')
+# Note: username & password is unescaped for request, so you should provide escaped values here
+# i. e. instead of `password: 'pa%%word'` you should use `password: Excon::Utils.escape_uri('pa%%word')`,
+# which return `pa%25%25word`
 connection = Excon.new('http://secure.geemus.com',
   :user => 'username', :password => 'password')
 
@@ -155,7 +177,7 @@ Compared to web browsers and other http client libraries, e.g. curl, Excon is a
 connection = Excon.new('http://geemus.com/', :omit_default_port => true)
 
 # accept gzip encoding
-connection = Excon.new('http://geemus.com/', :headers => { "Accept" => "gzip" })
+connection = Excon.new('http://geemus.com/', :headers => { "Accept-Encoding" => "gzip" })
 
 # turn off peer verification (less secure)
 Excon.defaults[:ssl_verify_peer] = false
@@ -194,6 +216,13 @@ connection.requests([{:method => :get}, {:method => :get}])
 By default, each call to `requests` will use a separate persistent socket connection. To make multiple `requests` calls
 using a single persistent connection, set `:persistent => true` when establishing the connection.
 
+For large numbers of simultaneous requests please consider using the `batch_requests` method. This will automatically slice up the requests into batches based on the file descriptor limit of your operating system. The results are the same as the `requests` method, but using this method can help prevent timeout errors.
+
+```ruby
+large_array_of_requests = [{:method => :get, :path => 'some_path'}, { ... }] # Hundreds of items
+connection.batch_requests(large_array_of_requests)
+```
+
 ## Streaming Responses
 
 You can stream responses by passing a block that will receive each chunk.
@@ -224,7 +253,7 @@ The proxy URL must be fully specified, including scheme (e.g. "http://") and por
 
 Proxy support must be set when establishing a connection object and cannot be overridden in individual requests.
 
-NOTE: Excon will use the environment variables `http_proxy` and `https_proxy` if they are present. If these variables are set they will take precedence over a :proxy option specified in code. If "https_proxy" is not set, the value of "http_proxy" will be used for both HTTP and HTTPS connections.
+NOTE: Excon will use `HTTP_PROXY` and `HTTPS_PROXY` environment variables. If set they will take precedence over any :proxy option specified in code. If "HTTPS_PROXY" is not set, "HTTP_PROXY" will be used for both HTTP and HTTPS connections. To disable this behavior, set the `NO_PROXY` environment variable and other environment variable proxy settings will be disregarded.
 
 ## Reusable ports
 
@@ -282,6 +311,12 @@ Excon.stub({}, lambda {|request_params| {:body => request_params[:body], :status
 
 Omitted attributes are assumed to match, so this stub will match *any* request and return an Excon::Response with a body of 'body' and status of 200.  You can add whatever stubs you might like this way and they will be checked against in the order they were added, if none of them match then excon will raise an `Excon::Errors::StubNotFound` error to let you know.
 
+If you want to allow unstubbed requests without raising `StubNotFound`, set the `allow_unstubbed_requests` option either globally or per request.
+
+```ruby
+connection = Excon.new('http://example.com', :mock => true, :allow_unstubbed_requests => true)
+```
+
 To remove a previously defined stub, or all stubs:
 
 ```ruby
@@ -390,6 +425,20 @@ connection = Excon.new('https://example.com',
 
 `client_key_pass` is optional.
 
+If you already have loaded the certificate and key into memory, then pass it through like:
+
+```ruby
+client_cert_data = File.load 'mycert.pem'
+client_key_data = File.load 'mycert.key'
+
+connection = Excon.new('https://example.com',
+                       client_cert_data: client_cert_data,
+                       client_key_data: client_key_data)
+```
+
+This can be useful if your program has already loaded the assets through
+another mechanism (E.g. a remote API call to a secure K:V system like Vault).
+
 ## HTTPS/SSL Issues
 
 By default excon will try to verify peer certificates when using HTTPS. Unfortunately on some operating systems the defaults will not work. This will likely manifest itself as something like `Excon::Errors::CertificateError: SSL_connect returned=1 ...`
@@ -417,6 +466,27 @@ Either of these should allow you to work around the socket error and continue wi
 
 Please refer to [CONTRIBUTING.md](https://github.com/excon/excon/blob/master/CONTRIBUTING.md).
 
+# Plugins and Middlewares
+
+Using Excon's [Middleware system][middleware], you can easily extend Excon's
+functionality with your own. The following plugins extend Excon in their own
+way:
+
+* [excon-addressable](https://github.com/JeanMertz/excon-addressable)
+
+  Set [addressable](https://github.com/sporkmonger/addressable) as the default
+  URI parser, and add support for [URI templating][templating].
+
+* [excon-hypermedia](https://github.com/JeanMertz/excon-hypermedia)
+
+  Teaches Excon to talk with [HyperMedia APIs][hypermedia]. Allowing you to use
+  all of Excon's functionality, while traversing APIs in an easy and
+  self-discovering way.
+
 ## License
 
 Please refer to [LICENSE.md](https://github.com/excon/excon/blob/master/LICENSE.md).
+
+[middleware]: lib/excon/middlewares/base.rb
+[hypermedia]: https://en.wikipedia.org/wiki/HATEOAS
+[templating]: https://www.rfc-editor.org/rfc/rfc6570.txt