|
| 1 | +[](https://packagist.org/packages/webclient/fake-http-client) |
| 2 | +[](https://packagist.org/packages/webclient/fake-http-client/stats) |
| 3 | +[](https://github.com/phpwebclient/fake-http-client/blob/master/LICENSE) |
| 4 | +[](https://php.net) |
| 5 | + |
| 6 | +# webclient/fake-http-client |
| 7 | + |
| 8 | +Mock for PSR-18 HTTP client |
| 9 | + |
| 10 | +# Install |
| 11 | + |
| 12 | +Add package to project |
| 13 | + |
| 14 | +```bash |
| 15 | +composer require --dev webclient/fake-http-client:^1.0 |
| 16 | +``` |
| 17 | + |
| 18 | +Set autoload |
| 19 | + |
| 20 | +```php |
| 21 | +<?php |
| 22 | + |
| 23 | +include 'vendor/autoload.php'; |
| 24 | +``` |
| 25 | + |
| 26 | +# Using |
| 27 | + |
| 28 | +```php |
| 29 | +<?php |
| 30 | + |
| 31 | +use Webclient\Fake\Client; |
| 32 | +use Psr\Http\Message\RequestInterface; |
| 33 | +use Psr\Http\Server\RequestHandlerInterface; |
| 34 | + |
| 35 | +/** |
| 36 | + * @var RequestHandlerInterface $handler your mock handler |
| 37 | + * @var RequestInterface $request your tested request |
| 38 | + */ |
| 39 | +$client = new Client($handler); |
| 40 | + |
| 41 | +$response = $client->sendRequest($request); |
| 42 | +``` |
| 43 | + |
| 44 | +# Routing |
| 45 | + |
| 46 | +This package provides simple routing. |
| 47 | + |
| 48 | +```php |
| 49 | +<?php |
| 50 | + |
| 51 | +use Webclient\Fake\Client; |
| 52 | +use Webclient\Fake\Handler\SimpleRoutingHandler; |
| 53 | +use Psr\Http\Message\RequestInterface; |
| 54 | +use Psr\Http\Server\RequestHandlerInterface; |
| 55 | + |
| 56 | +/** |
| 57 | + * @var RequestHandlerInterface $notFoundHandler default handler, error 404 |
| 58 | + * @var RequestHandlerInterface $entityCreatedHandler handler for 201 request (POST /entities) |
| 59 | + * @var RequestHandlerInterface $entityHandler handler for 200 request (GET /entities/1) |
| 60 | + * @var RequestHandlerInterface $entityDeletedHandler handler for 204 request (DELETE /entities/2) |
| 61 | + * @var RequestInterface $errorRequest request for unused uri (GET /users) |
| 62 | + * @var RequestInterface $entityCreatingRequest request for creating entity (POST /entities) |
| 63 | + * @var RequestInterface $entityRequest request for getting entity (GET /entities/1) |
| 64 | + * @var RequestInterface $entityDeletingRequest request for deleting entity (DELETE /entities/2) |
| 65 | + */ |
| 66 | + |
| 67 | +$handler = new SimpleRoutingHandler($notFoundHandler); |
| 68 | +$handler |
| 69 | + ->route(['GET', 'HEAD'], '/entities/1', $entityHandler) |
| 70 | + ->route(['POST'], '/entities', $entityCreatedHandler) |
| 71 | + ->route(['DELETED'], '/entities/2', $entityDeletedHandler) |
| 72 | +; |
| 73 | +$client = new Client($handler); |
| 74 | + |
| 75 | +$response1 = $client->sendRequest($errorRequest); // returns error 404 |
| 76 | +$response2 = $client->sendRequest($entityCreatingRequest); // returns success response 201 |
| 77 | +$response3 = $client->sendRequest($entityRequest); // returns success response 200 |
| 78 | +$response4 = $client->sendRequest($entityDeletingRequest); // returns success response 204 |
| 79 | +``` |
| 80 | + |
| 81 | +# Nuance |
| 82 | + |
| 83 | +If you pass the `\Psr\Http\Message\ServerRequestInterface` object to client and want the handler to receive it as is, |
| 84 | + add the attribute `\Webclient\Fake\Client::NO_REPLACE_ATTRIBUTE`: |
| 85 | + |
| 86 | +```php |
| 87 | +<?php |
| 88 | + |
| 89 | +use Webclient\Fake\Client; |
| 90 | +use Psr\Http\Message\ServerRequestInterface; |
| 91 | +use Psr\Http\Server\RequestHandlerInterface; |
| 92 | + |
| 93 | +/** |
| 94 | + * @var RequestHandlerInterface $handler your mock handler |
| 95 | + * @var ServerRequestInterface $request your tested request |
| 96 | + */ |
| 97 | +$client = new Client($handler); |
| 98 | + |
| 99 | +$response = $client->sendRequest($request->withAttribute(Client::NO_REPLACE_ATTRIBUTE, true)); |
| 100 | +``` |
0 commit comments