wyrihaximus/react-http-contextual-middleware-runner

Run a set of react/http middleware when a context checker passes

1.0.0 2018-07-10 06:09 UTC

This package is auto-updated.

Last update: 2020-05-12 16:32:45 UTC


README

Build Status Latest Stable Version Total Downloads Code Coverage License PHP 7 ready

Install

To install via Composer, use the command below, it will automatically detect the latest version and bind it with ^.

composer require wyrihaximus/react-http-contextual-middleware-runner

This middleware removes the raw body from the request. Best used after the request body has been parsed.

Usage

In the following example the CORS to allow everything in the /css/ and /js/ and by falling back to christoph-kluge/reactphp-http-cors-middleware for everything else.

Note: This is an actual use case from WyriMaps.net where there is an embeddable map JS, CSS, and images files served from that domain.

$server = new Server([
    /** Other Middleware */
    new ContextualMiddlewareRunner(
        function (ServerRequestInterface $request) {
            if (substr($request->getUri()->getPath(), 0, 4) === '/js/') {
                return true;
            }

            if (substr($request->getUri()->getPath(), 0, 5) === '/css/') {
                return true;
            }

            return false;
        },
        [
            new WithHeadersMiddleware([
                'Access-Control-Allow-Origin' => '*',
            ]),
        ],
        [
            // Middleware from christoph-kluge/reactphp-http-cors-middleware, not shipping with this package!!!
            // (But highly reccomended!)
            new CorsMiddleware([
                'allow_origin' => [
                    'https://www.wyrimaps.net',
                ],
            ]),
        ]
    )
    /** Other Middleware */
]);

License

The MIT License (MIT)

Copyright (c) 2018 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.