coolblue/http-client-middleware

A middleware solution for PSR-18 compliant http clients.

1.2.0 2023-12-20 09:01 UTC

Requires

• php: ^8.0
• psr/http-client: ^1.0
• psr/http-message: ^1.0 || ^2.0

Requires (Dev)

• phpspec/prophecy: ^1.17
• phpunit/phpunit: ^9.0 || ^10.0
• squizlabs/php_codesniffer: ^3.5

MIT

README

HTTP Client middleware is a middleware solution for PSR-18 (HTTP Client).

This package contains both a middleware interface as well as a ready to use HTTP Client that is capable of handling middleware.

NB This package does not contain any middleware implementations.

Rationale

The interface offered by PSR-18 (HTTP Client) does not offer any (configuration) options offered by known HTTP abstractions - for example Guzzle and Symfony HttpClient. This makes implementations of this interface exchangeable, but does require you to write these configurations yourself. This can mean additional code that is repeated in multiple locations. Something that might be undesirable.

This might be solved by using a solution similar to the middleware defined in PSR-15 (HTTP Server Request Handlers). Using middleware will allow centralization of functionality without the necessity of extending or wrapping a client. It also enables you to perform actions both before performing the actual request and after the actual request.

Installation

composer require coolblue/http-client-middleware 

Usage

Middleware needs to comply to the interface \Coolblue\Http\Client\MiddlewareInterface:

<?php

declare(strict_types=1);

namespace Coolblue\Http\Client;

use Psr\Http\Client\ClientInterface;
use Psr\Http\Message\RequestInterface;
use Psr\Http\Message\ResponseInterface;

interface MiddlewareInterface
{    
    public function process(RequestInterface $request, ClientInterface $client): ResponseInterface;
}

To create a middleware enabled client:

$client = new Client(); // an instance of \Psr\Http\Client\ClientInterface
$middlewareOne = new Middleware(); // an instance of \Coolblue\Client\Http\MiddlewareInterface
$middlewareTwo = new Middleware(); // an instance of \Coolblue\Client\Http\MiddlewareInterface

$middlewareClient = new \Coolblue\Http\Client\MiddlewareClient(
    $client, 
    $middlewareOne, 
    $middlewareTwo
);