faraday-highly_available_retries 0.1.0.pre.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0d99996c87cd7bfc2792430d4a7be1dc810889e2d59c1460da5c56bf18a32990
-  data.tar.gz: 4eae695335d5848847bc4e9a34295575dd9ca306c5380b79c77cba059bdc643a
+  metadata.gz: b722b5bd2334c80ef65eede5716baa97c691f12a1753cc34bb4d3e492f9a5f4a
+  data.tar.gz: 03ec8fbe4a4e01493250ca2ee97ff8d5586a00b305ab1aa2f54fbb138329ba9b
 SHA512:
-  metadata.gz: 6262767b39d59b4a7a4e1b1ecf31a8160ca6b0c3bda88d74e6ec49379ee8508d6e7e7235e581ba9c72c6429074a786def5c4369a80f9566e268c8b05789aa020
-  data.tar.gz: b2a1fc4a67ea0c9616194183e164a458dac26e93d186d2ee15f22f076820641404080c4d539cebd815fee2daae907baa5b410c7b6a9f51700fbda984a2a6c4d9
+  metadata.gz: 74224fe3d1bc2a25158610d619c94f3dace2f0d75fa658c838afd77843707ff404e3d5947dce9d34f3b47b5254db05590f19b2fe20b03c7906d7a613a7aea7a9
+  data.tar.gz: ac903a546e4310d95e11fe87da63807acfee70823ca0f9c564932bd309c5acd0d34630a613e3325343b29c3124bc21725c1670c5ef70b22fab348f11b35003e0

data/CHANGELOG.md

@@ -4,6 +4,6 @@ Inspired by [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
 **Note:** this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [0.1.0] - Unreleased
+## [0.1.0] - 2023-08-13
 
 *   Initial release.

data/README.md

@@ -11,9 +11,22 @@ This list of IP addresses is then shuffled, and if a request fails to connect to
 And so on and so forth, until the retries are exhausted. If all of the IPs fail, then we cycle back to the first one and try again.
 
 The reason this is impactful and should be used in conjunction with the retry middleware is that the retry middleware will
-leave DNS resolution to the OS, which has the potential of caching results and not try resolving to a different IP address.
-This means that if a DNS entry resolves to three IPs, `[A, B, C]`, the retry middleware may try all three retries against
-`A`, where as this middleware guarantees that it will try `A`, `B`, and `C`.
+leave DNS resolution to the OS, which has the potential of two pitfalls:
+
+1. Caching results and not try resolving to a different IP address.
+2. Leaving resolution to a roll of the dice allowing the same IP to be tried multiple times.
+
+The issue with the first pitfall is rather obvious, but the second is a bit more subtle. If you have a DNS entry that resolves
+to 2 IP addresses `[A, B]` and 1 attempt, the OS resolution will result in one of the following list of attempts:
+
+1. `[A, A]`
+2. `[A, B]`
+3. `[B. B]`
+4. `[B, A]`
+
+This gives you a 50% chance of hitting the same IP twice, and a 50% chance of hitting the other IP twice, meaning the retry
+has no effect. By using this gem, you can ensure that the list of IPs is resolved ahead of time and cycled through to ensure
+a different IP is tried on each attempt.
 
 ## Installation
 

data/lib/faraday/highly_available_retries/version.rb

@@ -2,6 +2,6 @@
 
 module Faraday
   module HighlyAvailableRetries
-    VERSION = '0.1.0.pre.1'
+    VERSION = '0.1.0'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: faraday-highly_available_retries
 version: !ruby/object:Gem::Version
-  version: 0.1.0.pre.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Invoca Development
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-08-02 00:00:00.000000000 Z
+date: 2023-08-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -49,8 +49,8 @@ licenses:
 metadata:
   allowed_push_host: https://rubygems.org
   bug_tracker_uri: https://github.com/invoca/faraday-highly_available_retries/issues
-  changelog_uri: https://github.com/invoca/faraday-highly_available_retries/blob/v0.1.0.pre.1/CHANGELOG.md
-  documentation_uri: http://www.rubydoc.info/gems/faraday-highly_available_retries/0.1.0.pre.1
+  changelog_uri: https://github.com/invoca/faraday-highly_available_retries/blob/v0.1.0/CHANGELOG.md
+  documentation_uri: http://www.rubydoc.info/gems/faraday-highly_available_retries/0.1.0
   homepage_uri: https://github.com/invoca/faraday-highly_available_retries
   source_code_uri: https://github.com/invoca/faraday-highly_available_retries
   wiki_uri: https://github.com/invoca/faraday-highly_available_retries/wiki
@@ -68,9 +68,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.4.17
 signing_key: