api-clients/middleware

Request middleware

4.0.0 2017-06-28 19:24 UTC

Requires

• php: ^7.0
• doctrine/annotations: ^1.4
• psr/http-message: ^1.0
• react/promise: ^2.4
• wyrihaximus/doctrine-annotation-autoloader: ^1.0

Requires (Dev)

• api-clients/test-utilities: ^4.1
• guzzlehttp/psr7: ^1.3
• psr/container: ^1.0

Suggests

• api-clients/middleware-cache: Cache requests with different strategies
• api-clients/middleware-log: Log requests and their context
• api-clients/middleware-oauth1: Sign requests with oauth1
• api-clients/middleware-pool: Pool the maximum concurrent requests
• psr/container: Add a ContainerInterface implementation to use the ContainerLocator

MIT

• Cees-Jan Kiewiet

README

This library contains the a async MiddlewareRunner used in our api clients. It provides an interface for all middlewares. Middlewares are ordered by priority when they where added to the MiddlewareRunner. Order of middlewares with the same priority is not guaranteed.

A number of traits are provided for your convenience, if your middleware implementation does not require all the methods defined in the MiddlewareInterface.

Locator

The locator can be used by your application to fetch middleware instances. It will check whether the created instance implements the MiddlewareInterface. Currently the only provided locator is the ContainerLocator which accepts a Psr\Container\ContainerInterface to fetch your middleware instances.

Example

    $container = /* ... */;
    $locator = new ContainerLocator($container);
    $middlewares = [];
    
    $config = [
        'middlewares' => [/*...*/]
        'options' => [/*...*/]
    ];
       
    foreach ($config['middlewares'] as $middleware) {
       $middlewares[] = $locator->get($middleware);
    }
    
    $runner = new MiddlewareRunner($config['options'], $middelwares);
    
    $runner->pre($request)->then(function ($request) use ($options) {
        return resolve($this->browser->send(
            $request
        ));
    }, function (ResponseInterface $response) {
        return resolve($response);
    })->then(function (ResponseInterface $response) use ($runner) {
        return $runner->post($response);
    })->otherwise(function (Throwable $throwable) use ($runner) {
        return reject($runner->error($throwable));
    });

License

The MIT License (MIT)

Copyright (c) 2017 Cees-Jan Kiewiet

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.