zendesk_api gem pins Faraday below 2.0, blocking Faraday 2.x upgrades

TL;DR

The pin existed because the middleware changes in Faraday 2 were non-trivial for this gem, but the maintainers picked it up and released v1.38.0.rc1, a release candidate with Faraday 2 support.

Steps

1. Faraday 2.x is out, but the zendesk_api gemspec pins Faraday to < 2.0.0. I am using Faraday elsewhere in my app and need to upgrade everything to Faraday 2 - the Zendesk gem is blocking me. Is Faraday 2.x support planned?
2. Yes, Faraday 2.x support shipped. The pin existed because the middleware changes in Faraday 2 were non-trivial for this gem, but the maintainers picked it up and released v1.38.0.rc1, a release candidate with Faraday 2 support. So if Faraday 2 is blocking your bundle, update to v1.38.0.rc1 or a newer release that carries the support.

When to use

You are seeing this: Faraday 2.x is out, but the zendeskapi gemspec pins Faraday to < 2.0.0. Use this skill when you run into "zendeskapi gem pins Faraday below 2.0, blocking Faraday 2.x upgrades".

When not to use

If your error message or symptom does not match what is described above, this is probably not your fix. Search for your exact error text instead of forcing this one to fit.

Versions

Versions mentioned in the source: 2.0.0, v1.38.0. If you are on something much newer or older, the details may have shifted.

Why this happens

The original report does not dig into a root cause. It documents the symptom and the fix that resolved it.

Asked in the thread (https://vectle.com/threads/thrqMwPcNxs7Sqv0psU1cX7kg): Faraday 2.x is out, but the zendeskapi gemspec pins Faraday to < 2.0.0. I am using Faraday elsewhere in my app and need to upgrade everything to Faraday 2 - the Zendesk gem is blocking me. Is Faraday 2.x support planned? The verified answer: Yes, Faraday 2.x support shipped. The pin existed because the middleware changes in Faraday 2 were non-trivial for this gem, but the maintainers picked it up and released v1.38.0.rc1, a release candidate with Faraday 2 support. So if Faraday 2 is blocking your bundle, update to v1.38.0.rc1 or a newer release that carries the support.

Source: https://github.com/zendesk/zendeskapiclientrb/issues/488 Thread: https://vectle.com/threads/thrqMwPcNxs7Sqv0psU1cX7kg