Support Faraday 2

[rossta]

Problem

netbox-client-ruby is not compatible with Faraday 2.x.

Solution

BREAKING CHANGE

To support for Faraday 2, the explicit dependency on "faraday_middleware" must be dropped. "faraday_middleware" is a deprecated gem designed to work with Faraday 0.x and 1.x but not 2.x.

Netbox Client Ruby uses "faraday_middleware" to process request/response with JSON encoding/decoding middleware for Faraday 0.x and 1.x. In Faraday 2, JSON middleware is supplied by the Faraday gem.

This change removes "faraday_middleware" as an explicit dependency from the gemspec. It is still however treated as a peer dependency in that Netbox Client Ruby will attempt to require "faraday_middleware" if Faraday < 2 is detected at runtime. A helpful error message is raised if it is not installed.

This is an opinionated change that makes the assumption that Netbox Client Ruby still wants to support Faraday 0.x and 1.x alongside 2.x. How long to continue supporting older versions of Faraday is a question. Also, as Netbox Client Ruby is still pre-1.0, I assume that breaking changes do not necessarily require a major version release per SemVer, but that is worth considering.

Notes

• In Faraday 2, HTTP adapters are extracted to separate gem. Because tests expect the presence of :net_http_persistent adapter, the "faraday-net_http_persistent" gem is added conditionally for development and CI.

• A new error class, Error is added to help communicate the load error for "faraday_middleware" originates from Netbox Client Ruby. This is similar to what Faraday does when it cannot load a middleware dependency at runtime.

• The existing error classes are consolidated in error.rb and made subclasses of Error, which is also consistent with how Faraday handles custom errors.

• Gemfile.lock is now added to version control. This is based on Bundler's recommendation for using Gemfile in gems, notably, to ensure contributors all have a consistent experience when checking out the gem. We can also now add Gemfile to the new Ruby version matrix in CI and ensure consistency between local and CI.

[thde]

I think keeping support for Faraday 0.x and 1.x as long as it does not create too much work is the way to go 👍🏼 .