setup middleware pipeline for Ruby request adapter

[baywet]

related #120
related #635

To implement cross cutting concerns (like retrying on transient errors) we need the current http client to support middleware handlers, that is intercepting and change the request before it's sent over the wire, and the response before it's returned to the caller.

The first step here is to check the documentation of the client we're currently using to see whether it supports two things:

• Defining and injecting middleware handlers in the requests execution pipeline
• Defining and attaching request options to the request object (to be picked up by a middleware handler)

If it doesn't, we should design an overhead API for the native client that offers similar methods prototypes (what we did with TypeScript & fetch).

Additionally:

• the abstractions needs to have a middleware request option interface defined
• we need a client factory in the http library so consumers can get a client with the same middleware configuration as the request adapter is using by default.
• the request information type needs to be able to carry request options
• the options property property on request configuration needs to be of this new type (update the refiner)
• generator method needs to pass the options to the request information object
• the request adapter implementation needs to pass these options to the native request object

[osose-e]

As NET::HTTP does not offer support for defining and injecting middleware handlers, there may be a suitable middleware that can be easily added on. I found these libraries:

Excon
"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." Excon's last commit was within the last couple months, it is relatively active. This library offers a lot of features, like pipeline-ing requests; however, my fear is that this library is too big. It is also a wrapper library of net/http and not an adapter, so the current http microsoft kiota ruby package would have to be changed significantly. Excon is under an MIT license. The codebase is here.

[osose-e]

Middleware
"Middleware is a library which provides a generalized implementation of the chain of responsibility pattern for Ruby." Middleware's last commit was in 2017, so it doesn't look as active as I'd like. However, the library seems to be much smaller than Excon and support mainly Middleware with handy tools like a logger, stack builder, etc. Middleware is under an MIT license. The codebase is here.

[baywet]

After some additional research we decided to adopt faraday for the time being.
Multiple reasons for that:

1. it's popular, widely adopted well maintained.
2. it provides support for middleware https://lostisland.github.io/faraday/middleware/
3. it wraps around multiple http clients, leaving choice to users https://github.com/lostisland/awesome-faraday/#adapters

Some supporting evidence https://www.scrapingbee.com/blog/best-ruby-http-clients/

(Hey Osose in case you're watching, the research and the work you've done on Ruby helped a lot! 👋)