excon 0.92.4 → 0.92.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 27d135a08d31acae6470830e52c2106edb009aa323e722b8b4f33f1e363ba751
-  data.tar.gz: 39b76ea9456a60d7bde87139cca00d58da653cc4f518ae3ca65863e9fe8fdda3
+  metadata.gz: a34074d556423d449fa23f52efaa7f5819f44f030df55a2cdcb59b8abc759965
+  data.tar.gz: d45df688f3f126ed199d9cd16616f4c29a0da2e2d6fbe4b1df85fb442ad35778
 SHA512:
-  metadata.gz: 63cdd6010814edb1a94e7bc1c694e7dedb2cca7c51dee26fe89a7bd71fad1f2a803763d49ae0f6e8103c7114acc423e92d0c610620b97ae817a936b0990af484
-  data.tar.gz: f759aa0467043e50c8af544c881fadab669505a7a62b58cc2a68dd7bf1be9a3e6db3656092e66618dd8161310d39deee1d841adf6ed0b8d02719574211d3d983
+  metadata.gz: e59218361989a91d474eb8b6076f6c3928000f77cbffabcb0f155bc41f7033a25f5606af7325c2cf63c61f0fdfe6175a84470f2e03caeb210e05ef0dc76b7bf3
+  data.tar.gz: a3c6c90892e9a329f9bfa4a76826c6c69f0f2945073e44a01bb348eb168ba0052c3078a2ac4e67e39158cb62c13b9d981b3af75ca147261a97af772e9c7beb82

data/README.md

@@ -127,6 +127,38 @@ connection.request(:method => 'GET')
 # expect one or more status codes, or raise an error
 connection.request(:expects => [200, 201], :method => :get)
 
+# 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')
+
+# use custom uri parser
+require 'addressable/uri'
+connection = Excon.new('http://geemus.com/', uri_parser: Addressable::URI)
+```
+
+Compared to web browsers and other http client libraries, e.g. curl, Excon is a bit more low-level and doesn't assume much by default. If you are seeing different results compared to other clients, the following options might help:
+
+```ruby
+# opt-in to omitting port from http:80 and https:443
+connection = Excon.new('http://geemus.com/', :omit_default_port => true)
+
+# accept gzip encoding
+connection = Excon.new('http://geemus.com/', :headers => { "Accept-Encoding" => "gzip" })
+
+# turn off peer verification (less secure)
+Excon.defaults[:ssl_verify_peer] = false
+connection = Excon.new('https://...')
+```
+
+## Timeouts and Retries
+
+You can modify timeouts and define whether and how many (blocking) retries Excon should attempt if errors occur.
+
+```ruby
 # this request can be repeated safely, so retry on errors up to 4 times
 connection.request(:idempotent => true)
 
@@ -137,6 +169,10 @@ connection.request(:idempotent => true, :retry_limit => 6)
 # in between each retry
 connection.request(:idempotent => true, :retry_limit => 6, :retry_interval => 5)
 
+# specify the errors on which to retry (default Timeout, Socket, HTTPStatus)
+# only retry on timeouts
+connection.request(:idempotent => true, :retry_limit => 6, :retry_interval => 5, :retry_errors => [Excon::Error::Timeout] )
+
 # set longer read_timeout (default is 60 seconds)
 connection.request(:read_timeout => 360)
 
@@ -155,32 +191,6 @@ connection = Excon.new('http://geemus.com/', :connect_timeout => 360)
 
 # opt-out of nonblocking operations for performance and/or as a workaround
 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')
-
-# use custom uri parser
-require 'addressable/uri'
-connection = Excon.new('http://geemus.com/', uri_parser: Addressable::URI)
-```
-
-Compared to web browsers and other http client libraries, e.g. curl, Excon is a bit more low-level and doesn't assume much by default. If you are seeing different results compared to other clients, the following options might help:
-
-```ruby
-# opt-in to omitting port from http:80 and https:443
-connection = Excon.new('http://geemus.com/', :omit_default_port => true)
-
-# accept gzip encoding
-connection = Excon.new('http://geemus.com/', :headers => { "Accept-Encoding" => "gzip" })
-
-# turn off peer verification (less secure)
-Excon.defaults[:ssl_verify_peer] = false
-connection = Excon.new('https://...')
 ```
 
 ## Chunked Requests

data/lib/excon/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module Excon
-  VERSION = '0.92.4'
+  VERSION = '0.92.5'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: excon
 version: !ruby/object:Gem::Version
-  version: 0.92.4
+  version: 0.92.5
 platform: ruby
 authors:
 - dpiddy (Dan Peterson)
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-07-20 00:00:00.000000000 Z
+date: 2022-09-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec