doppiogancio/mocked-client

A simple way to mock a client

v4.1.4 2023-10-24 15:01 UTC

Requires

• php: ^8.1
• league/route: ^5.1.2
• psr/http-factory: ^1.0
• psr/log: ^2.0|^3.0

Requires (Dev)

• ext-json: *
• doctrine/coding-standard: ^12.0
• guzzlehttp/guzzle: ^7.5
• php-http/discovery: ^1.17
• phpstan/phpstan: ^1.10
• phpunit/phpunit: ^10.1
• slevomat/coding-standard: ^8.11
• squizlabs/php_codesniffer: ^3.7
• symfony/var-dumper: ^6.2

MIT

• Fabrizio Gargiulo

• php
• http
• testing
• client
• mock
• Guzzle

README

Mocked Client

This package will help test components that depend on clients for HTTP calls. At the moment only Guzzle Client is supported.

Install

Via Composer

$ composer require doppiogancio/mocked-client guzzlehttp/guzzle php-http/discovery

Requirements

This version requires a minimum PHP version 8.1

How to mock a client

use DoppioGancio\MockedClient\HandlerBuilder;
use DoppioGancio\MockedClient\ClientBuilder;
use DoppioGancio\MockedClient\Route\RouteBuilder;
use GuzzleHttp\Psr7\Response;
use Http\Discovery\Psr17FactoryDiscovery;
use Psr\Log\NullLogger;

$handlerBuilder = new HandlerBuilder(
    Psr17FactoryDiscovery::findServerRequestFactory(),
    new NullLogger()
);

$route = new RouteBuilder(
    Psr17FactoryDiscovery::findResponseFactory(),
    Psr17FactoryDiscovery::findStreamFactory(),
);

// Route with Response
$handlerBuilder->addRoute(
    $route->new()
        ->withMethod('GET')
        ->withPath('/country/IT')
        ->withResponse(new Response(200, [], '{"id":"+39","code":"IT","name":"Italy"}'))
        ->build()
);


$clientBuilder = new ClientBuilder($handlerBuilder);
$client = $clientBuilder->build();

Advanced examples

1. Route with a file
2. Route with a string
3. Route with consecutive calls
4. Route with callbacks
5. Guzzle client with middlewares

How to use the client

$response = $client->request('GET', '/country/DE/json');
$body = (string) $response->getBody();
$country = json_decode($body, true);

print_r($country);

// will return
Array
(
    [id] => +49
    [code] => DE
    [name] => Germany
)

Some recommendations...

Fail Fast, Fail Often

If you don't know in advance which routes are needed, don't worry, start with a client without routes, and let it suggests which routes to add.

$handlerBuilder = new HandlerBuilder(
    Psr17FactoryDiscovery::findServerRequestFactory(),
    new NullLogger()
);

// don't add any route for now...

$clientBuilder = new ClientBuilder($handlerBuilder);
$client = $clientBuilder->build();

Run the test: the test will fail, but it will suggest you the route that is missing. By doing this, it will only specify the needed routes.

An example:

DoppioGancio\MockedClient\Exception\RouteNotFound: Mocked route GET /admin/dashboard not found

Inject the client in the service container

If you have a service container, add the client to it, so that every service depending on it will be able to auto wire.

self::$container->set(Client::class, $client);

// In Symfony
self::$container->set('eight_points_guzzle.client.my_client', $client);