Compare commits

..

No commits in common. "master" and "v3.0.3" have entirely different histories.

110 changed files with 7544 additions and 7271 deletions

15
.gitattributes vendored
View File

@ -1,15 +1,8 @@
/.env export-ignore
/.gitattributes export-ignore /.gitattributes export-ignore
/.gitignore export-ignore /.gitignore export-ignore
/.php_cs* export-ignore
/.travis.yml export-ignore /.travis.yml export-ignore
/composer.lock export-ignore
/coverage export-ignore
/docker export-ignore
/docker-compose* export-ignore
/docs export-ignore /docs export-ignore
/tests export-ignore /test export-ignore
/phpunit.xml* export-ignore /phpunit.xml.dist export-ignore
/psalm.xml export-ignore /Vagrantfile export-ignore
/public export-ignore /vagrant export-ignore
/vendor export-ignore

15
.gitignore vendored
View File

@ -5,12 +5,8 @@ vendor/
phpdoc/ phpdoc/
# Code coverage report # Code coverage report
coverage/
report/ report/
# Cache
.php_cs.cache
# Sphinx Documentation # Sphinx Documentation
docs/build docs/build
@ -21,10 +17,9 @@ preview
# PhpStorm # PhpStorm
workspace.xml workspace.xml
# Local scratch files # Vagrant
notes .vagrant/
# Local overrides # Vagrant sandbox site files.
.env /htdocs/
docker-compose.override.yml /autoload/
phpunit.xml

11
.travis.yml Normal file
View File

@ -0,0 +1,11 @@
language: php
php:
- "5.6"
- "7.0"
before_script:
- composer selfupdate
- composer install --prefer-source
script:
- vendor/bin/phpunit

137
README.md
View File

@ -1,20 +1,16 @@
WellRESTed WellRESTed
========== ==========
[![Minimum PHP Version](https://img.shields.io/badge/php-%3E%3D7.2-blue)](https://php.net/) [![Build Status](https://travis-ci.org/wellrestedphp/wellrested.svg?branch=master)](https://travis-ci.org/wellrestedphp/wellrested)
[![Documentation Status](https://readthedocs.org/projects/wellrested/badge/?version=latest)](http://wellrested.readthedocs.org/en/latest/) [![Documentation Status](https://readthedocs.org/projects/wellrested/badge/?version=latest)](http://wellrested.readthedocs.org/en/latest/)
[![SensioLabsInsight](https://insight.sensiolabs.com/projects/b0a2efcb-49f8-4a90-a5bd-0c14e409f59e/mini.png)](https://insight.sensiolabs.com/projects/b0a2efcb-49f8-4a90-a5bd-0c14e409f59e)
WellRESTed is a library for creating RESTful APIs and websites in PHP that provides abstraction for HTTP messages, a powerful handler and middleware system, and a flexible router. WellRESTed is a library for creating RESTful Web services in PHP.
This fork (basemaster/wellrested) is back to php 7.2 release. Requirements
------------
### Features - PHP 5.4
- Uses [PSR-7](https://www.php-fig.org/psr/psr-7/) interfaces for requests, responses, and streams. This lets you use other PSR-7 compatable libraries seamlessly with WellRESTed.
- Uses [PSR-15](https://www.php-fig.org/psr/psr-15/) interfaces for handlers and middleware to allow sharing and reusing code
- Router allows you to match paths with variables such as `/foo/{bar}/{baz}`.
- Middleware system provides a way to compose your application from discrete, modular components.
- Lazy-loaded handlers and middleware don't instantiate unless they're needed.
Install Install
------- -------
@ -24,7 +20,7 @@ Add an entry for "wellrested/wellrested" to your composer.json file's `require`
```json ```json
{ {
"require": { "require": {
"wellrested/wellrested": "^5" "wellrested/wellrested": "~3.0"
} }
} }
``` ```
@ -32,7 +28,7 @@ Add an entry for "wellrested/wellrested" to your composer.json file's `require`
Documentation Documentation
------------- -------------
See [the documentation](https://wellrested.readthedocs.org/en/latest/) to get started. See [the documentation](http://wellrested.readthedocs.org/en/latest/) to get started.
Example Example
------- -------
@ -40,89 +36,60 @@ Example
```php ```php
<?php <?php
use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\ServerRequestInterface;
use Psr\Http\Server\RequestHandlerInterface;
use WellRESTed\Message\Response;
use WellRESTed\Message\Stream; use WellRESTed\Message\Stream;
use WellRESTed\Server; use WellRESTed\Server;
// Create a handler using the PSR-15 RequestHandlerInterface require_once "vendor/autoload.php";
class HomePageHandler implements RequestHandlerInterface
{
public function handle(ServerRequestInterface $request): ResponseInterface
{
// Create and return new Response object to return with status code,
// headers, and body.
$response = (new Response(200))
->withHeader('Content-type', 'text/html')
->withBody(new Stream('<h1>Hello, world!</h1>'));
return $response;
}
}
// ----------------------------------------------------------------------------- // Build some middleware. We'll register these with a server below.
// We're using callables to fit this all in one example, but these
// could also be classes implementing WellRESTed\MiddlewareInterface.
// Create a new Server instance. // Set the status code and provide the greeting as the response body.
$hello = function ($request, $response, $next) {
// Check for a "name" attribute which may have been provided as a
// path variable. Use "world" as a default.
$name = $request->getAttribute("name", "world");
// Set the response body to the greeting and the status code to 200 OK.
$response = $response->withStatus(200)
->withHeader("Content-type", "text/plain")
->withBody(new Stream("Hello, $name!"));
// Propagate to the next middleware, if any, and return the response.
return $next($request, $response);
};
// Add a header to the response.
$headerAdder = function ($request, $response, $next) {
// Add the header.
$response = $response->withHeader("X-example", "hello world");
// Propagate to the next middleware, if any, and return the response.
return $next($request, $response);
};
// Create a server
$server = new Server(); $server = new Server();
// Add a router to the server to map methods and endpoints to handlers.
$router = $server->createRouter(); // Start each request-response cycle by dispatching the header adder.
// Register the route GET / with an anonymous function that provides a handler. $server->add($headerAdder);
$router->register("GET", "/", function () { return new HomePageHandler(); });
// Add the router to the server. // The header adder will propagate to this router, which will dispatch the
$server->add($router); // $hello middleware, possibly with a {name} variable.
// Read the request from the client, dispatch a handler, and output. $server->add($server->createRouter()
->register("GET", "/hello", $hello)
->register("GET", "/hello/{name}", $hello)
);
// Read the request from the client, dispatch middleware, and output.
$server->respond(); $server->respond();
``` ```
Development
-----------
Use Docker to run unit tests, manage Composer dependencies, and render a preview of the documentation site.
To get started, run:
```bash
docker-compose build
docker-compose run --rm php composer install
```
To run PHPUnit tests, use the `php` service:
```bash
docker-compose run --rm php phpunit
```
To run Psalm for static analysis:
```bash
docker-compose run --rm php psalm
```
To run PHP Coding Standards Fixer:
```bash
docker-compose run --rm php php-cs-fixer fix
```
To generate documentation, use the `docs` service:
```bash
# Generate
docker-compose run --rm docs
# Clean
docker-compose run --rm docs make clean -C docs
```
To run a local playground site, use:
```bash
docker-compose up -d
```
The runs a site you can access at [http://localhost:8080](http://localhost:8080). You can use this site to browser the [documentation](http://localhost:8080/docs/) or [code coverage report](http://localhost:8080/coverage/).
Copyright and License Copyright and License
--------------------- ---------------------
Copyright © 2020 by PJ Dietz Copyright © 2015 by PJ Dietz
Licensed under the [MIT license](http://opensource.org/licenses/MIT) Licensed under the [MIT license](http://opensource.org/licenses/MIT)

8
Vagrantfile vendored Normal file
View File

@ -0,0 +1,8 @@
port = ENV["HOST_PORT"] || 8080
Vagrant.configure("2") do |config|
# Ubuntu 14.04 LTS
config.vm.box = "ubuntu/trusty64"
config.vm.network "forwarded_port", guest: 80, host: port
config.vm.provision "shell", path: "vagrant/provision.sh"
end

View File

@ -1,7 +1,8 @@
{ {
"name": "basemaster/wellrested", "name": "wellrested/wellrested",
"description": "Clone for Simple PHP Library for RESTful APIs (wellrested.org)", "description": "Simple PHP Library for RESTful APIs",
"keywords": ["rest", "restful", "api", "http", "psr7", "psr-7", "psr15", "psr-15", "psr17", "psr-17"], "keywords": ["rest", "restful", "api", "http"],
"homepage": "https://github.com/pjdietz/wellrested",
"license": "MIT", "license": "MIT",
"type": "library", "type": "library",
"authors": [ "authors": [
@ -11,19 +12,15 @@
} }
], ],
"require": { "require": {
"php": ">=7.2", "php": ">=5.4.0",
"psr/http-factory": "~1.0", "psr/http-message": "~1.0"
"psr/http-message": "~1.0",
"psr/http-server-handler": "~1.0",
"psr/http-server-middleware": "~1.0"
}, },
"provide": { "require-dev": {
"psr/http-message-implementation": "1.0", "phpunit/phpunit": "^5"
"psr/http-factory-implementation": "1.0"
}, },
"autoload": { "autoload": {
"psr-4": { "psr-4": {
"WellRESTed\\": "src/" "WellRESTed\\" : "src/"
} }
} }
} }

1339
composer.lock generated

File diff suppressed because it is too large Load Diff

View File

@ -11,12 +11,8 @@ That being said, there are a number or situations that come up that warrant solu
`Error Handling`_ `Error Handling`_
Classes to facilitate error handling including Classes to facilitate error handling including
`Test Components`_
Test cases and doubles for use with WellRESTed
Or, see WellRESTed_ on GitHub. Or, see WellRESTed_ on GitHub.
.. _HTTP Exceptions: https://github.com/wellrestedphp/http-exceptions .. _HTTP Exceptions: https://github.com/wellrestedphp/http-exceptions
.. _Error Handling: https://github.com/wellrestedphp/error-handling .. _Error Handling: https://github.com/wellrestedphp/error-handling
.. _Test Components: https://github.com/wellrestedphp/test
.. _WellRESTed: https://github.com/wellrestedphp .. _WellRESTed: https://github.com/wellrestedphp

View File

@ -6,6 +6,7 @@ from pygments.lexers.web import PhpLexer
lexers['php'] = PhpLexer(startinline=True, linenos=1) lexers['php'] = PhpLexer(startinline=True, linenos=1)
lexers['php-annotations'] = PhpLexer(startinline=True, linenos=1) lexers['php-annotations'] = PhpLexer(startinline=True, linenos=1)
primary_domain = 'php'
# Add any Sphinx extension module names here, as strings. They can be # Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
@ -25,9 +26,9 @@ master_doc = 'index'
# General information about the project. # General information about the project.
project = u'WellRESTed' project = u'WellRESTed'
copyright = u'2021, PJ Dietz' copyright = u'2015, PJ Dietz'
version = '5.0.0' version = '3.0.0'
release = '5.0.0' release = '3.0.0'
# List of patterns, relative to source directory, that match files and # List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files. # directories to ignore when looking for source files.

View File

@ -3,61 +3,100 @@ Dependency Injection
WellRESTed strives to play nicely with other code and not force developers into using any specific libraries or frameworks. As such, WellRESTed does not provide a dependency injection container, nor does it require you to use a specific container (or any). WellRESTed strives to play nicely with other code and not force developers into using any specific libraries or frameworks. As such, WellRESTed does not provide a dependency injection container, nor does it require you to use a specific container (or any).
This section describes the recommended way of using WellRESTed with Pimple_, a common dependency injection container for PHP. This section describes a handful of ways of making dependencies available to middleware.
Imaging we have a ``FooHandler`` that depends on a ``BarInterface``, and ``BazInterface``. Our handler looks something like this: Request Attribute
^^^^^^^^^^^^^^^^^
``Psr\Http\Message\ServerRequestInterface`` provides "attributes" that allow you attach arbitrary data to a request. You can use this to make your dependency container available to any dispatched middleware.
When you instantiate a ``WellRESTed\Server``, you can provide an array of attributes that the server will add to the request.
.. code-block:: php .. code-block:: php
class FooHandler implements RequestHandlerInterface $container = new MySuperCoolDependencyContainer();
$server = new WellRESTed\Server(["container" => $container]);
// ... Add middleware, routes, etc. ...
When the server dispatches middleware, the middleware will be able to read the container as the "container" attribute.
.. code-block:: php
function ($request, $response, $next) {
$container = $request->getAttribute("container");
// It's a super cool dependency container!
}
.. note::
This approach is technically more of a `service locator`_ pattern. It's easy to implement, and it allows you the most flexibility in how you assign middleware.
It has some drawbacks as well, though. For example, your middleware is now dependent on your container, and describing which items needs to be **in** the container provides its own challenge.
If your interested in a truer dependency injection approach, read on to the next section where we look at registering middleware factories.
Middleware Factories
^^^^^^^^^^^^^^^^^^^^
Another approach is to use a factory function that returns middleware, usually in the form of a ``MiddlewareInterface`` instance. This approach provides the opportunity to pass dependencies to your middleware's constructor, while still delaying instantiation until the middleware is used.
Imagine a middleware ``FooHandler`` that depends on a ``BarInterface``, and ``BazInterface``.
.. code-block:: php
Class FooHandler implements WellRESTed\MiddlewareInterface
{ {
private $bar; private $bar;
private $baz; private $baz;
public function __construct(BarInterface $bar, BazInterface $baz) public function __construct(BarInterface $bar, BazInterface $bar)
{ {
$this->bar = $bar; $this->bar = $bar;
$this->baz = $baz; $this->baz = $baz;
} }
public function handle(ServerRequestInterface $request): ResponseInterface public function __invoke(ServerRequestInterface $request, ResponseInterface $response, $next);
{ {
// Do something with the bar and baz and return a response... // Do something with the bar and baz and update the response.
// ... // ...
return $response;
} }
} }
We can register the handler and these dependencies in a Pimple_ service provider. When you add the middleware to the server or register it with a router, you can use a callable that passes appropriate instances into the constructor.
.. code-block:: php .. code-block:: php
class MyServiceProvider implements ServiceProviderInterface // Assume $bar and $baz exist in this scope.
{ $fooHandlerFactory = function () use ($bar, $bar) {
public function register(Container $c) return new FooHandler($bar, $baz);
{
// Register the Bar and Baz as services.
$c['bar'] = function ($c) {
return new Bar();
};
$c['baz'] = function ($c) {
return new Baz();
};
// Register the Handler as a protected function. When you use
// protect, Pimple returns the function itself instead of the return
// value of the function.
$c['fooHandler'] = $c->protect(function () use ($c) {
return new FooHandler($c['bar'], $c['baz']);
});
}
} }
To register this handler with a router, we can pass the service: $server = new Server();
$server->add(
$server->createRoute()
->register("GET", "/foo/{id}", $fooHandlerFactory)
);
$server->respond();
You can combine this approach with a dependency container. Here's an example using Pimple_).
.. code-block:: php .. code-block:: php
$router->register('GET', '/foo', $c['fooHandler']); $c = new Pimple\Container();
$c["bar"] = /* Return a BarInterface */
$c["baz"] = /* Return a BazInterface */
$c["fooHandler"] = $c->protect(function () use ($c) {
return new FooHandler($c["bar"], $c["baz"]);
});
By "protecting" the ``fooHandler`` service, we are delaying the instantiation of the ``FooHandler``, the ``Bar``, and the ``Baz`` until the handler needs to be dispatched. This works because we're not passing instance of ``FooHandler`` when we register this with a router, we're passing a function to it that does the instantiation on demand. $server = new Server();
$server->add(
$server->createRoute()
->register("GET", "/foo/{id}", $c["fooHandler"])
);
$server->respond();
.. _Pimple: https://pimple.symfony.com/ .. _Pimple: http://pimple.sensiolabs.org
.. _service locator: https://en.wikipedia.org/wiki/Service_locator_pattern

View File

@ -1,82 +1,112 @@
Extending and Customizing Extending and Customizing
========================= =========================
WellRESTed is designed with customization in mind. This section describes some common scenarios for customization, starting with using a handler that implements a different interface. WellRESTed is designed with customization in mind. This section describes some common scenarios for customization, starting with using middleware that implements a different interface.
Custom Handlers and Middleware Custom Middleware
------------------------------ -----------------
Imagine you found a handler class from a third party that does exactly what you need. The only problem is that it implements a different interface. Imagine you found a middleware class from a third party that does exactly what you need. The only problem is that it implements a different middleware interface.
Here's the interface for the third-party handler: Here's the interface for the third-party middleware:
.. code-block:: php .. code-block:: php
interface OtherHandlerInterface interface OtherMiddlewareInterface
{ {
/** /**
* @param ServerRequestInterface $request * @param \Psr\Http\Message\ServerRequestInterface $request
* @return ResponseInterface * @param \Psr\Http\Message\ResponseInterface $response
* @return \Psr\Http\Message\ResponseInterface
*/ */
public function run(ResponseInterface $response); public function run(
\Psr\Http\Message\ServerRequestInterface $request,
\Psr\Http\Message\ResponseInterface $response
);
} }
Wrapping Wrapping
^^^^^^^^ ^^^^^^^^
One solution is to wrap an instance of this handler inside of a ``Psr\Http\Server\RequestHandlerInterface`` instance. One solution is to wrap an instance of this middleware inside of a ``WellRESTed\MiddlewareInterface`` instance.
.. code-block:: php .. code-block:: php
/** /**
* Wraps an instance of OtherHandlerInterface * Wraps an instance of OtherMiddlewareInterface
*/ */
class OtherHandlerWrapper implements RequestHandlerInterface class OtherWrapper implements \WellRESTed\MiddlewareInterface
{ {
private $handler; private $middleware;
public function __construct(OtherHandlerInterface $handler) public function __construct(OtherMiddlewareInterface $middleware)
{ {
$this->handler = $handler; $this->middleware = $middleware;
} }
public function handle(ServerRequestInterface $request): ResponseInterface public function __invoke(
{ \Psr\Http\Message\ServerRequestInterface $request,
return $this->handler->run($request); \Psr\Http\Message\ResponseInterface $response,
$next
) {
// Run the wrapped middleware.
$response = $this->middleware->run($request, $response);
// Pass the middleware's response to $next and return the result.
return $next($request, $myResponse);
} }
} }
.. note::
``OtherMiddlewareInterface`` doesn't provide any information about how to propagate the request and response through a chain of middleware, so I chose to call ``$next`` every time. If there's a sensible way to tell that you should stop propagating, your wrapper class could return a response without calling ``$next`` under those circumstances. It's up to you and the middleware you're wrapping.
To use this wrapped middleware, you can do something like this:
.. code-block:: php
// The class we need to wrap; implements OtherMiddlewareInterface
$other = new OtherMiddleware();
// The wrapper class; implements WellRESTed\MiddlewareInterface
$otherWrapper = new OtherWrapper($other)
$server = new WellRESTed\Server();
$server->add($otherWrapper);
Custom Dispatcher Custom Dispatcher
^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^
Wrapping works well when you have one or two handlers implementing a third-party interface. If you want to integrate a lot of classes that implement a given third-party interface, you're might consider customizing the dispatcher. Wrapping works well when you have one or two middleware implementing a third-party interface. If you want to integrate a lot of middleware classes that implement a given third-party interface, you're better off customizing the dispatcher.
The dispatcher is an instance that unpacks your handlers and middleware and sends the request and response through it. A default dispatcher is created for you when you use your ``WellRESTed\Server``. The dispatcher is an instance that unpacks your middleware and sends the request and response through it. A default dispatcher is created for you when you instantiate your ``WellRESTed\Server`` (without passing the second argument). The server instantiates a ``WellRESTed\Dispatching\Dispatcher`` which is capable of running middleware provided as a callable, a string containing the fully qualified class name of a middleware, or an array of middleware. (See `Using Middleware`_ for a description of what a default dispatcher can dispatch.)
If you need the ability to dispatch other types of middleware, you can create your own by implementing ``WellRESTed\Dispatching\DispatcherInterface``. The easiest way to do this is to subclass ``WellRESTed\Dispatching\Dispatcher``. Here's an example that extends ``Dispatcher`` and adds support for ``OtherHandlerInterface``: If you need the ability to dispatch other types of middleware, you can create your own by implementing ``WellRESTed\Dispatching\DispatcherInterface``. The easiest way to do this is to subclass ``WellRESTed\Dispatching\Dispatcher``. Here's an example that extends ``Dispatcher`` and adds support for ``OtherMiddlewareInterface``:
.. code-block:: php .. code-block:: php
namespace MyApi;
/** /**
* Dispatcher with support for OtherHandlerInterface * Dispatcher with support for OtherMiddlewareInterface
*/ */
class CustomDispatcher extends \WellRESTed\Dispatching\Dispatcher class CustomDispatcher extends \WellRESTed\Dispatching\Dispatcher
{ {
public function dispatch( public function dispatch(
$dispatchable, $middleware,
ServerRequestInterface $request, \Psr\Http\Message\ServerRequestInterface $request,
ResponseInterface $response, \Psr\Http\Message\ResponseInterface $response,
$next $next
) { ) {
try { try {
// Use the dispatch method in the parent class first. // Use the dispatch method in the parent class first.
$response = parent::dispatch($dispatchable, $request, $response, $next); $response = parent::dispatch($middleware, $request, $response, $next);
} catch (\WellRESTed\Dispatching\DispatchException $e) { } catch (\WellRESTed\Dispatching\DispatchException $e) {
// If there's a problem, check if the handler or middleware // If there's a problem, check if the middleware implements
// (the "dispatchable") implements OtherHandlerInterface. // OtherMiddlewareInterface. Dispatch it if it does.
// Dispatch it if it does. if ($middleware instanceof OtherMiddlewareInterface) {
if ($dispatchable instanceof OtherHandlerInterface) { $response = $middleware->run($request, $response);
$response = $dispatchable->run($request); $response = $next($request, $response);
} else { } else {
// Otherwise, re-throw the exception. // Otherwise, re-throw the exception.
throw $e; throw $e;
@ -86,17 +116,104 @@ If you need the ability to dispatch other types of middleware, you can create yo
} }
} }
To use this dispatcher, create an instance implementing ``WellRESTed\Dispatching\DispatcherInterface`` and pass it to the server's ``setDispatcher`` method. To use this dispatcher, pass it to the constructor of ``WellRESTed\Server`` as the second argument. (The first argument is a hash array to use as `request attributes`_.)
.. code-block:: php .. code-block:: php
// Create an instance of your custom dispatcher.
$dispatcher = new MyApi\CustomDispatcher;
// Pass this dispatcher to the server.
$server = new WellRESTed\Server(null, $dispatcher);
// Now, you can add any middleware implementing OtherMiddlewareInterface
$other = new OtherMiddleware();
$server->add($other);
// Registering OtherMiddlewareInterface middleware by FQCN will work, too.
Message Customization
---------------------
In the example above, we passed a custom dispatcher to the server. You can also customize your server in other ways. For example, if you have a different implementation of PSR-7_ messages that you prefer, you can pass them into the ``Server::respond`` method:
.. code-block:: php
// Represents the request submitted by the client.
$request = new ThirdParty\Request();
// A "blank" response.
$response = new ThirdParty\Response();
$server = new WellRESTed\Server(); $server = new WellRESTed\Server();
$server->setDispatcher(new MyApi\CustomDispatcher()); // ...add middleware...
.. warning:: // Pass your request and response to Server::respond
$server->response($request, $response);
When you supply a custom Dispatcher, be sure to call ``Server::setDispatcher`` before you create any routers with ``Server::createRouter`` to allow the ``Server`` to pass you customer ``Dispatcher`` on to the newly created ``Router``. Even if you don't want to use a different implementation, you may still find a reason to provide you're own messages. For example, the default response status code for a ``WellRESTed\Message\Response`` is 500. If you wanted to make the default 200 instead, you could do something like this:
.. _PSR-7: https://www.php-fig.org/psr/psr-7/ .. code-block:: php
.. _Handlers and Middleware: handlers-and-middleware.html
// The first argument is the status code.
$response = new \WellRESTed\Message\Response(200);
$server = new \WellRESTed\Server();
// ...add middleware...
// Pass the response to respond()
$server->respond(null, $response);
Server Customization
--------------------
As an alternative to passing you preferred request and response instances into ``Server::respond``, you can extend ``Server`` to obtain default values from a different source.
Classes such as ``Server`` that create dependencies as defaults keep the instantiation isolated in easy-to-override methods. For example, ``Server`` has a protected method ``getResponse`` that instantiates and returns a new response. You can easily replace this method with your own that returns the default response of your choice.
For example, imagine you have a dependency container that provides the starting messages for you. You can subclass ``Server`` to obtain and use these messages as defaults like this:
.. code-block:: php
class CustomerServer extends WellRESTed\Server
{
/** @var A dependency container */
private $container;
public function __construct(
$container,
array $attributes = null,
DispatcherInterface $dispatcher = null,
$pathVariablesAttributeName = null
) {
// Call the parent constructor with the expected parameters.
parent::__construct($attributes, $dispatcher, $pathVariablesAttributeName);
// Store the container.
$this->container = $container;
}
/**
* Redefine this method, which is called in Server::respond when
* the caller does not provide a request.
*/
protected function getRequest()
{
// Return a request obtained from the container.
return $this->container["request"];
}
/**
* Redefine this method, which is called in Server::respond when
* the caller does not provide a response.
*/
protected function getResponse()
{
// Return a response obtained from the container.
return $this->container["response"];
}
}
In addition to the messages, you can do similar customization for other ``Server`` dependencies such as the dispatcher (see above), the transmitter (which writes the response out to the client), and the routers that are created with ``Server::createRouter``. These dependencies are instantiated in isolated methods as with the request and response to make this sort of customization easy, and other classes such as ``Router`` use this pattern as well. See the source code, and don't hesitated to subclass.
.. _PSR-7: http://www.php-fig.org/psr/psr-7/
.. _Using Middleware: middleware.html#using-middleware
.. _Request Attributes: messages.html#attributes .. _Request Attributes: messages.html#attributes

View File

@ -3,14 +3,15 @@ Getting Started
This page provides a brief introduction to WellRESTed. We'll take a tour of some of the features of WellRESTed without getting into too much depth. This page provides a brief introduction to WellRESTed. We'll take a tour of some of the features of WellRESTed without getting into too much depth.
To start, we'll make a "Hello, world!" to demonstrate the concepts of handlers and routing and show how to read variables from the request path. To start, we'll make a "`Hello, world!`_" to demonstrate the concepts of middleware and routing and show how to read variables from the request path.
Hello, World! Hello, World!
^^^^^^^^^^^^^ ^^^^^^^^^^^^^
Let's start with a very basic "Hello, world!" Here, we will create a server. A ``WellRESTed\Server`` reads the incoming request from the client, dispatches a handler, and transmits a response back to the client. Let's start with a very basic "Hello, world!". Here, we will create a server. A ``WellRESTed\Server`` reads the
incoming request from the client, dispatches some middleware_, and transmits a response back to the client.
Our handler will create and return a response with the status code set to ``200`` and the body set to "Hello, world!". Our middleware is a function that returns a response with the status code set to ``200`` and the body set to "Hello, world!".
.. _`Example 1`: .. _`Example 1`:
.. rubric:: Example 1: Simple "Hello, world!" .. rubric:: Example 1: Simple "Hello, world!"
@ -19,37 +20,31 @@ Our handler will create and return a response with the status code set to ``200`
<?php <?php
use Psr\Http\Server\RequestHandlerInterface;
use WellRESTed\Message\Response;
use WellRESTed\Message\Stream; use WellRESTed\Message\Stream;
use WellRESTed\Server; use WellRESTed\Server;
require_once 'vendor/autoload.php'; require_once "vendor/autoload.php";
// Define a handler implementing the PSR-15 RequestHandlerInterface interface.
class HelloHandler implements RequestHandlerInterface
{
public function handle(ServerRequestInterface $request): ResponseInterface
{
$response = (new Response(200))
->withHeader('Content-type', 'text/plain')
->withBody(new Stream('Hello, world!'));
return $response;
}
}
// Create a new server. // Create a new server.
$server = new Server(); $server = new Server();
// Add this handler to the server. // Add middleware to dispatch that will return a response.
$server->add(new HelloHandler()); // In this case, we'll use an anonymous function.
$server->add(function ($request, $response, $next) {
// Update the response with the greeting, status, and content-type.
$response = $response->withStatus(200)
->withHeader("Content-type", "text/plain")
->withBody(new Stream("Hello, world!"));
// Use $next to forward the request on to the next middleware, if any.
return $next($request, $response);
});
// Read the request sent to the server and use it to output a response. // Read the request sent to the server and use it to output a response.
$server->respond(); $server->respond();
.. note:: .. note::
The handler in this example provides a ``Stream`` as the body instead of a string. This is a feature or PSR-7 where HTTP message bodies are always represented by streams. This allows you to work with very large bodies without having to store the entire contents in memory. The middleware in this example provides a ``Stream`` as the body instead of a string. This is a feature or PSR-7 where HTTP message bodies are always represented by streams. This allows you to work with very large bodies without having to store the entire contents in memory.
WellRESTed provides ``Stream`` and ``NullStream``, but you can use any implementation of ``Psr\Http\Message\StreamInterface``. WellRESTed provides ``Stream`` and ``NullStream``, but you can use any implementation of ``Psr\Http\Message\StreamInterface``.
@ -58,19 +53,35 @@ Routing by Path
This is a good start, but it provides the same response to every request. Let's provide this response only when a client sends a request to ``/hello``. This is a good start, but it provides the same response to every request. Let's provide this response only when a client sends a request to ``/hello``.
For this, we need a router_. A router_ examines the request and sends the request through to the handler that matches the request's HTTP method and path. For this, we need a router_. A router_ is a special type of middleware_ that examines the request and routes the request through to the middleware that matches.
.. _`Example 2`: .. _`Example 2`:
.. rubric:: Example 2: Routed "Hello, world!" .. rubric:: Example 2: Routed "Hello, world!"
.. code-block:: php .. code-block:: php
// Create a new server. <?php
$server = new Server();
// Create a router to map methods and endpoints to handlers. use WellRESTed\Message\Stream;
use WellRESTed\Server;
require_once "vendor/autoload.php";
// Create a new server and use it to create a new router.
$server = new Server();
$router = $server->createRouter(); $router = $server->createRouter();
$router->register('GET', '/hello', new HelloHandler());
// Map middleware to an endpoint and method(s).
$router->register("GET", "/hello", function ($request, $response, $next) {
// Update the response with the greeting, status, and content-type.
$response = $response->withStatus(200)
->withHeader("Content-type", "text/plain")
->withBody(new Stream("Hello, world!"));
// Use $next to forward the request on to the next middleware, if any.
return $next($request, $response);
});
// Add the router to the server.
$server->add($router); $server->add($router);
// Read the request sent to the server and use it to output a response. // Read the request sent to the server and use it to output a response.
@ -81,27 +92,33 @@ Reading Path Variables
Routes can be static (like the one above that matches only ``/hello``), or they can be dynamic. Here's an example that uses a dynamic route to read a portion from the path to use as the greeting. For example, a request to ``/hello/Molly`` will respond "Hello, Molly", while a request to ``/hello/Oscar`` will respond "Hello, Oscar!" Routes can be static (like the one above that matches only ``/hello``), or they can be dynamic. Here's an example that uses a dynamic route to read a portion from the path to use as the greeting. For example, a request to ``/hello/Molly`` will respond "Hello, Molly", while a request to ``/hello/Oscar`` will respond "Hello, Oscar!"
.. _`Example 3`: .. _`Example 3`:
.. rubric:: Example 3: Personalized "Hello, world!" .. rubric:: Example 3: Personalized "Hello, world!"
.. code-block:: php .. code-block:: php
class HelloHandler implements RequestHandlerInterface <?php
{
public function handle(ServerRequestInterface $request): ResponseInterface
{
// Check for a "name" attribute which may have been provided as a
// path variable. Use "world" as a default.
$name = $request->getAttribute("name", "world");
// Set the response body to the greeting and the status code to 200 OK. use WellRESTed\Message\Stream;
$response = (new Response(200)) use WellRESTed\Server;
->withHeader("Content-type", "text/plain")
->withBody(new Stream("Hello, $name!"));
// Return the response. require_once "vendor/autoload.php";
return $response;
} // Define middleware.
$hello = function ($request, $response, $next) {
// Check for a "name" attribute which may have been provided as a
// path variable. The second parameters allows us to set a default.
$name = $request->getAttribute("name", "world");
// Update the response with the greeting, status, and content-type.
$response = $response->withStatus(200)
->withHeader("Content-type", "text/plain")
->withBody(new Stream("Hello, $name!"));
return $next($request, $response);
} }
// Create the server and router. // Create the server and router.
@ -112,58 +129,65 @@ Routes can be static (like the one above that matches only ``/hello``), or they
$router->register("GET", "/hello", $hello); $router->register("GET", "/hello", $hello);
// Register to match a pattern with a variable. // Register to match a pattern with a variable.
$router->register("GET", "/hello/{name}", $hello); $router->register("GET", "/hello/{name}", $hello);
$server->add($router);
$server->add($router);
$server->respond(); $server->respond();
Middleware Multiple Middleware
^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^
In addition to handlers, which provide responses directly, WellRESTed also supports middleware to act on the requests and then pass them on for other middleware or handlers to work with. One thing we haven't seen yet is how middleware work together. For the next example, we'll use an additional middleware that sets an ``X-example: hello world``.
Middleware allows you to compose your application in multiple pieces. In the example, we'll use middleware to add a header to every response, regardless of which handler is called.
.. code-block:: php .. code-block:: php
// This middleware will add a custom header to every response. <?php
class CustomHeaderMiddleware implements MiddlewareInterface
{
public function process(
ServerRequestInterface $request,
RequestHandlerInterface $handler
): ResponseInterface {
// Delegate to the next handler in the chain to obtain a response. use WellRESTed\Message\Stream;
$response = $handler->handle($request); use WellRESTed\Server;
// Add the header to the response we got back from upstream. require_once "vendor/autoload.php";
$response = $response->withHeader("X-example", "hello world");
// Return the altered response. // Set the status code and provide the greeting as the response body.
return $response; $hello = function ($request, $response, $next) {
}
} // Check for a "name" attribute which may have been provided as a
// path variable. Use "world" as a default.
$name = $request->getAttribute("name", "world");
// Set the response body to the greeting and the status code to 200 OK.
$response = $response->withStatus(200)
->withHeader("Content-type", "text/plain")
->withBody(new Stream("Hello, $name!"));
// Propagate to the next middleware, if any, and return the response.
return $next($request, $response);
};
// Add a header to the response.
$headerAdder = function ($request, $response, $next) {
// Add the header.
$response = $response->withHeader("X-example", "hello world");
// Propagate to the next middleware, if any, and return the response.
return $next($request, $response);
};
// Create a server // Create a server
$server = new Server(); $server = new Server();
// Add the header-adding middleware to the server first so that it will // Add $headerAdder to the server first to make it the first to run.
// forward requests on to the router. $server->add($headerAdder);
$server->add(new CustomHeaderMiddleware());
// Create a router to map methods and endpoints to handlers. // When $headerAdder calls $next, it will dispatch the router because it is
$router = $server->createRouter(); // added to the server right after.
$server->add($server->createRouter()
->register("GET", "/hello", $hello)
->register("GET", "/hello/{name}", $hello)
);
$handler = new HelloHandler(); // Read the request from the client, dispatch middleware, and output.
// Register a route to the handler without a variable in the path.
$router->register('GET', '/hello', $handler);
// Register a route that reads a "name" from the path.
// This will make the "name" request attribute available to the handler.
$router->register('GET', '/hello/{name}', $handler);
$server->add($router);
// Read the request from the client, dispatch, and output.
$server->respond(); $server->respond();
.. _middleware: middleware.html .. _middleware: middleware.html
.. _router: router.html .. _router: router.html

View File

@ -1,236 +0,0 @@
Handlers and Middleware
=======================
WellRESTed allows you to define and use your handlers and middleware in a number of ways.
Defining Handlers and Middleware
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
PSR-15 Interfaces
-----------------
The preferred method is to use the interfaces standardized by PSR-15_. This standard includes two interfaces, ``Psr\Http\Server\RequestHandlerInterface`` and ``Psr\Http\Server\MiddlewareInterface``.
Use ``RequestHandlerInterface`` for individual components that generate and return responses.
.. code-block:: php
class HelloHandler implements RequestHandlerInterface
{
public function handle(ServerRequestInterface $request): ResponseInterface
{
// Check for a "name" attribute which may have been provided as a
// path variable. Use "world" as a default.
$name = $request->getAttribute("name", "world");
// Set the response body to the greeting and the status code to 200 OK.
$response = (new Response(200))
->withHeader("Content-type", "text/plain")
->withBody(new Stream("Hello, $name!"));
// Return the response.
return $response;
}
}
Use ``MiddlewareInterface`` for classes that interact with other middleware and handlers. For example, you may have middleware that attempts to retrieve a cached response and delegates to other handlers on a cache miss.
.. code-block:: php
class CacheMiddleware implements MiddlewareInterface
{
public function process(
ServerRequestInterface $request,
RequestHandlerInterface $handler
): ResponseInterface
{
// Inspect the request to see if there is a representation on hand.
$representation = $this->getCachedRepresentation($request);
if ($representation !== null) {
// There is already a cached representation.
// Return it without delegating to the next handler.
return (new Response())
->withStatus(200)
->withBody($representation);
}
// No representation exists. Delegate to the next handler.
$response = $handler->handle($request);
// Attempt to store the response to the cache.
$this->storeRepresentationToCache($response);
return $response
}
private function getCachedRepresentation(ServerRequestInterface $request)
{
// Look for a cached representation. Return null if not found.
// ...
}
private function storeRepresentationToCache(ResponseInterface $response)
{
// Ensure the response contains a success code, a valid body,
// headers that allow caching, etc. and store the representation.
// ...
}
}
Legacy Middleware Interface
---------------------------
Prior to PSR-15, WellRESTed's recommended handler interface was ``WellRESTed\MiddlewareInterface``. This interface is still supported for backwards compatibility.
This interface serves for both handlers and middleware. It differs from the ``Psr\Http\Server\MiddlewareInterface`` in that is expects an incoming ``$response`` parameter which you may use to generate the returned response. It also expected a ``$next`` parameter which is a ``callable`` with this signature:
.. code-block:: php
function next($request, $response): ResponseInterface
Call ``$next`` and pass ``$request`` and ``$response`` to forward the request to the next handler. ``$next`` will return the response from the handler. Here's the cache example above as a ``WellRESTed\MiddlewareInterface``.
.. code-block:: php
class CacheMiddleware implements WellRESTed\MiddlewareInterface
{
public function __invoke(
ServerRequestInterface $request,
ResponseInterface $response,
$next
) {
// Inspect the request to see if there is a representation on hand.
$representation = $this->getCachedRepresentation($request);
if ($representation !== null) {
// There is already a cached representation.
// Return it without delegating to the next handler.
return $response
->withStatus(200)
->withBody($representation);
}
// No representation exists. Delegate to the next handler.
$response = $next($request, $response);
// Attempt to store the response to the cache.
$this->storeRepresentationToCache($response);
return $response
}
private function getCachedRepresentation(ServerRequestInterface $request)
{
// Look for a cached representation. Return null if not found.
// ...
}
private function storeRepresentationToCache(ResponseInterface $response)
{
// Ensure the response contains a success code, a valid body,
// headers that allow caching, etc. and store the representation.
// ...
}
}
Callables
---------
You may also use a ``callable`` similar to the legacy ``WellRESTed\MiddlewareInterface``. The signature of the callable matches the signature of ``WellRESTed\MiddlewareInterface::__invoke``.
.. code-block:: php
$handler = function ($request, $response, $next) {
// Delegate to the next handler.
$response = $next($request, $response);
return $response
->withHeader("Content-type", "text/plain")
->withBody(new Stream("Hello, $name!"));
}
Using Handlers and Middleware
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Methods that accept handlers and middleware (e.g., ``Server::add``, ``Router::register``) allow you to provide them in a number of ways. For example, you can provide an instance, a ``callable`` that returns an instance, or an ``array`` of middleware to use in sequence. The following examples will demonstrate all of the ways you can register handlers and middleware.
Factory Functions
-----------------
The best method is to use a function that returns an instance of your handler. The main benefit of this approach is that no handlers are instantiated until they are needed.
.. code-block:: php
$router->register("GET,PUT,DELETE", "/widgets/{id}",
function () { return new App\WidgetHandler() }
);
If you're using ``Pimple``, a popular `dependency injection`_ container for PHP, you may have code that looks like this:
.. code-block:: php
// Create a DI container.
$c = new Container();
// Store a function to the container that will create and return the handler.
$c['widgetHandler'] = $c->protect(function () use ($c) {
return new App\WidgetHandler();
});
$router->register("GET,PUT,DELETE", "/widgets/{id}", $c['widgetHandler']);
Instance
--------
WellRESTed also allows you to pass an instance of a handler directly. This may be useful for smaller handlers that don't require many dependencies, although the factory function approach is better in most cases.
.. code-block:: php
$widgetHandler = new App\WidgetHandler();
$router->register("GET,PUT,DELETE", "/widgets/{id}", $widgetHandler);
.. warning::
This is simple, but has a significant disadvantage over the other options because each middleware used this way will be loaded and instantiated, even if it's not needed for a given request-response cycle. You may find this approach useful for testing, but avoid if for production code.
Fully Qualified Class Name (FQCN)
---------------------------------
For handlers that do not require any arguments passed to the constructor, you may pass the fully qualified class name of your handler as a ``string``. You can do that like this:
.. code-block:: php
$router->register('GET,PUT,DELETE', '/widgets/{id}', App\WidgetHandler::class);
// ... or ...
$router->register('GET,PUT,DELETE', '/widgets/{id}', 'App\\WidgetHandler');
The class is not loaded, and no instances are created, until the route is matched and dispatched. However, the drawback to this approach is the there is no way to pass any arguments to the constructor.
Array
-----
The final approach is to provide a sequence of middleware and a handler as an ``array``.
For example, imagine if we had a Pimple_ container with these services:
.. code-block:: php
$c['authMiddleware'] // Ensures the user is logged in
$c['cacheMiddleware'] // Provides a cached response if able
$c['widgetHandler'] // Provides a widget representation
We could provide these as a sequence by using an ``array``.
.. code-block:: php
$router->register('GET', '/widgets/{id}', [
$c['authMiddleware'],
$c['cacheMiddleware'],
$c['widgetHandler']
]);
.. _Dependency Injection: dependency-injection.html
.. _Pimple: https://pimple.symfony.com/
.. _PSR-15: https://www.php-fig.org/psr/psr-15/

View File

@ -1,7 +1,7 @@
WellRESTed WellRESTed
========== ==========
WellRESTed is a library for creating RESTful APIs and websites in PHP that provides abstraction for HTTP messages, a powerful handler and middleware system, and a flexible router. WellRESTed is a library for creating RESTful APIs and websites in PHP that provides abstraction for HTTP messages, a powerful middleware system, and a flexible router.
Features Features
-------- --------
@ -13,11 +13,6 @@ Request and response messages are built to the interfaces standardized by PSR-7_
The message abstractions facilitate working with message headers, status codes, variables extracted from the path, message bodies, and all the other aspects of requests and responses. The message abstractions facilitate working with message headers, status codes, variables extracted from the path, message bodies, and all the other aspects of requests and responses.
PSR-15 Handler Interfaces
^^^^^^^^^^^^^^^^^^^^^^^^^
WellRESTed can use handlers and middleware using the interfaces defined by the PSR-15_ standard.
Router Router
^^^^^^ ^^^^^^
@ -28,17 +23,18 @@ WellRESTed's router automates responding to ``OPTIONS`` requests for each endpoi
Middleware Middleware
^^^^^^^^^^ ^^^^^^^^^^
The middleware_ system allows you to build your Web service out of discrete, modular pieces. These pieces can be run in sequences where each has an opportunity to work with the request before handing it off to the next. For example, an authenticator can validate a request and forward it to a cache; the cache can check for a stored representation and forward to another middleware if no cached representation is found, etc. All of this happens without any one middleware needing to know anything about where it is in the chain or which middleware comes before or after. The middleware_ system allows you to build your Web service out of discrete, modular pieces. These pieces can be run in sequences where each has a chance to modify the response before handing it off to the next. For example, an authenticator can validate a request and forward it to a cache; the cache can check for a stored representation and forward to another middleware if no cached representation is found, etc. All of this happens without any one middleware needing to know anything about where it is in the chain or which middleware comes before or after.
Most middleware is never autoloaded or instantiated until it is needed, so a Web service with hundreds of middleware still only creates instances required for the current request-response cycle.
You can register middleware directly, register callables that return middleware (e.g., dependency container services), or register strings containing the middleware class names to autoload and instantiate on demand.
Lazy Loading
^^^^^^^^^^^^
Handlers and middleware can be registered using `factory functions`_ so that they are only instantiated if needed. This way, a Web service with hundreds of handlers and middleware only creates instances required for the current request-response cycle.
Extensible Extensible
^^^^^^^^^^ ^^^^^^^^^^
Most classes are coded to interfaces to allow you to provide your own implementations and use them in place of the built-in classes. For example, if your Web service needs to be able to dispatch middleware that implements a third-party interface, you can provide your own custom ``DispatcherInterface`` implementation. All classes are coded to interfaces to allow you to provide your own implementations and use them in place of the built-in classes. For example, if your Web service needs to be able to dispatch middleware that implements a different interface, you can provide your own custom ``DispatcherInterface`` implementation.
Example Example
------- -------
@ -51,74 +47,54 @@ The site will also provide an ``X-example: hello world`` using dedicated middlew
<?php <?php
use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\ServerRequestInterface;
use Psr\Http\Server\MiddlewareInterface;
use Psr\Http\Server\RequestHandlerInterface;
use WellRESTed\Message\Response;
use WellRESTed\Message\Stream; use WellRESTed\Message\Stream;
use WellRESTed\Server; use WellRESTed\Server;
require_once 'vendor/autoload.php'; require_once "vendor/autoload.php";
// Create a handler that will construct and return a response. We'll // Build some middleware. We'll register these with a server below.
// register this handler with a server and router below. // We're using callables to fit this all in one example, but these
class HelloHandler implements RequestHandlerInterface // could also be classes implementing WellRESTed\MiddlewareInterface.
{
public function handle(ServerRequestInterface $request): ResponseInterface
{
// Check for a "name" attribute which may have been provided as a
// path variable. Use "world" as a default.
$name = $request->getAttribute("name", "world");
// Set the response body to the greeting and the status code to 200 OK. // Set the status code and provide the greeting as the response body.
$response = (new Response(200)) $hello = function ($request, $response, $next) {
->withHeader("Content-type", "text/plain")
->withBody(new Stream("Hello, $name!"));
// Return the response. // Check for a "name" attribute which may have been provided as a
return $response; // path variable. Use "world" as a default.
} $name = $request->getAttribute("name", "world");
}
// Create middleware that will add a custom header to every response. // Set the response body to the greeting and the status code to 200 OK.
class CustomerHeaderMiddleware implements MiddlewareInterface $response = $response->withStatus(200)
{ ->withHeader("Content-type", "text/plain")
public function process( ->withBody(new Stream("Hello, $name!"));
ServerRequestInterface $request,
RequestHandlerInterface $handler
): ResponseInterface {
// Delegate to the next handler in the chain to obtain a response. // Propagate to the next middleware, if any, and return the response.
$response = $handler->handle($request); return $next($request, $response);
// Add the header. };
$response = $response->withHeader("X-example", "hello world");
// Return the altered response. // Add a header to the response.
return $response; $headerAdder = function ($request, $response, $next) {
} // Add the header.
} $response = $response->withHeader("X-example", "hello world");
// Propagate to the next middleware, if any, and return the response.
return $next($request, $response);
};
// Create a server // Create a server
$server = new Server(); $server = new Server();
// Add the header-adding middleware to the server first so that it will // Start each request-response cycle by dispatching the header adder.
// forward requests on to the router. $server->add($headerAdder);
$server->add(new CustomerHeaderMiddleware());
// Create a router to map methods and endpoints to handlers. // The header adder will propagate to this router, which will dispatch the
$router = $server->createRouter(); // $hello middleware, possibly with a {name} variable.
$server->add($server->createRouter()
->register("GET", "/hello", $hello)
->register("GET", "/hello/{name}", $hello)
);
$handler = new HelloHandler(); // Read the request from the client, dispatch middleware, and output.
// Register a route to the handler without a variable in the path.
$router->register('GET', '/hello', $handler);
// Register a route that reads a "name" from the path.
// This will make the "name" request attribute available to the handler.
$router->register('GET', '/hello/{name}', $handler);
$server->add($router);
// Read the request from the client, dispatch, and output.
$server->respond(); $server->respond();
Contents Contents
@ -130,7 +106,7 @@ Contents
overview overview
getting-started getting-started
messages messages
handlers-and-middleware middleware
router router
uri-templates uri-templates
uri-templates-advanced uri-templates-advanced
@ -139,9 +115,7 @@ Contents
additional additional
web-server-configuration web-server-configuration
.. _PSR-7: https://www.php-fig.org/psr/psr-7/ .. _PSR-7: http://www.php-fig.org/psr/psr-7/
.. _PSR-15: https://www.php-fig.org/psr/psr-15/ .. _middleware: middleware.html
.. _factory functions: handlers-and-middleware.html#factory-functions
.. _middleware: handlers-and-middleware.html
.. _router: router.html .. _router: router.html
.. _URI Templates: uri-templates.html .. _URI Templates: uri-templates.html

View File

@ -1,77 +1,98 @@
Messages and PSR-7 Messages and PSR-7
================== ==================
WellRESTed uses the PSR-7_ interfaces for HTTP messages. This section provides an introduction to working with these interfaces and the implementations provided with WellRESTed. For more information, please read about PSR-7_. WellRESTed uses PSR-7_ as the interfaces for HTTP messages. This section provides an introduction to working with these interfaces and the implementations provided with WellRESTed. For more information, please read PSR-7_.
Obtaining Instances
-------------------
When working with middleware_, you generally will not need to create requests and responses yourself, as these are passed into the middleware when it is dispatched.
In `Getting Started`_, we saw that middleware looks like this:
.. code-block:: php
/**
* @param Psr\Http\Message\ServerRequestInterface $request
* @param Psr\Http\Message\ResponseInterface $response
* @param callable $next
* @return Psr\Http\Message\ResponseInterface
*/
function ($request, $response, $next) { }
When middleware is called, it receives a ``Psr\Http\Message\ServerRequestInterface`` instance representing the client's request and a ``Psr\Http\Message\ResponseInterface`` instance that serves as a starting place for the response to output to the client. These instances are created by the ``WellRESTed\Server`` when you call ``WellRESTed\Server::respond``.
.. note::
If you want to provide your own custom request and response (either to adjust the initial settings or to use a different implementation), you can do so by passing request and response instances as the first and second parameters to ``WellRESTed\Server::respond``.
Requests Requests
-------- --------
The ``$request`` variable passed to handlers and middleware represents the request message sent by the client. You can inspect this variable to read information such as the request path, method, query, headers, and body. The ``$request`` variable passed to middleware represents the request message sent by the client. Middleware can inspect this variable to read information such as the request path, method, query, headers, and body.
Let's start with a very simple GET request to the path ``/cats/?color=orange``. Let's start with a very simple GET request to the path ``/cats/?color=orange``.
.. code-block:: http .. code-block:: http
GET /cats/?color=orange HTTP/1.1 GET /cats/ HTTP/1.1
Host: example.com Host: example.com
Cache-control: no-cache Cache-control: no-cache
You can read information from the request in your handler like this: You can read information from the request in your middleware like this:
.. code-block:: php .. code-block:: php
class MyHandler implements RequestHandlerInterface function ($request, $response, $next) {
{
public function handle(ServerRequestInterface $request): ResponseInterface
{
$path = $request->getRequestTarget();
// "/cats/?color=orange"
$method = $request->getMethod(); $path = $request->getRequestTarget();
// "GET" // "/cats/?color=orange"
$method = $request->getMethod();
// "GET"
$query = $request->getQueryParams();
/*
Array
(
[color] => orange
)
*/
$query = $request->getQueryParams();
/*
Array
(
[color] => orange
)
*/
}
} }
This example shows that you can use: This example middleware shows that you can use:
- ``getRequestTarget()`` to read the path and query string for the request - ``getRequestTarget()`` to read the path and query string for the request
- ``getMethod()`` to read the HTTP verb (e.g., GET, POST, OPTIONS, DELETE) - ``getMethod()`` to read the HTTP verb (e.g., GET, POST, OPTIONS, DELETE)
- ``getQueryParams()`` to read the query as an associative array - ``getQueryParams()`` to read the query as an associative array
Let's move on to some more interesting features.
Headers Headers
^^^^^^^ ^^^^^^^
The request above also included a ``Cache-control: no-cache`` header. You can read this header a number of ways. The simplest way is with the ``getHeaderLine($name)`` method. The request above also included a ``Cache-control: no-cache`` header. You can read this header a number of ways. The simplest way is with the ``getHeaderLine($name)`` method.
Call ``getHeaderLine($name)`` and pass the case-insensitive name of a header. The method will return the value for the header, or an empty string if the header is not present. Call ``getHeaderLine($name)`` and pass the case-insensitive name of a header. The method will return the value for the header, or an empty string.
.. code-block:: php .. code-block:: php
class MyHandler implements RequestHandlerInterface function ($request, $response, $next) {
{
public function handle(ServerRequestInterface $request): ResponseInterface // This message contains a "Cache-control: no-cache" header.
{ $cacheControl = $request->getHeaderLine("cache-control");
// This message contains a "Cache-control: no-cache" header. // "no-cache"
$cacheControl = $request->getHeaderLine("cache-control");
// "no-cache" // This message does not contain any authorization headers.
$authorization = $request->getHeaderLine("authorization");
// ""
// This message does not contain any authorization headers.
$authorization = $request->getHeaderLine("authorization");
// ""
}
} }
.. note:: .. note::
All methods relating to headers treat header field names case insensitively. All methods relating to headers treat header field name case insensitively.
Because HTTP messages may contain multiple headers with the same field name, ``getHeaderLine($name)`` has one other feature: If multiple headers with the same field name are present in the message, ``getHeaderLine($name)`` returns a string containing all of the values for that field, concatenated by commas. This is more common with responses, particularly with the ``Set-cookie`` header, but is still possible for requests. Because HTTP messages may contain multiple headers with the same field name, ``getHeaderLine($name)`` has one other feature: If multiple headers with the same field name are present in the message, ``getHeaderLine($name)`` returns a string containing all of the values for that field, concatenated by commas. This is more common with responses, particularly with the ``Set-cookie`` header, but is still possible for requests.
@ -87,7 +108,7 @@ PSR-7_ provides access to the body of the request as a stream and—when possibl
Parsed Body Parsed Body
~~~~~~~~~~~ ~~~~~~~~~~~
For POST requests for forms (i.e., the ``Content-type`` header is either ``application/x-www-form-urlencoded`` or ``multipart/form-data``), the request makes the form fields available via the ``getParsedBody`` method. This provides access to the fields without needing to rely on the ``$_POST`` superglobal. When the request contains form fields (i.e., the ``Content-type`` header is either ``application/x-www-form-urlencoded`` or ``multipart/form-data``), the request makes the form fields available via the ``getParsedBody`` method. This provides access to the fields without needing to rely on the ``$_POST`` superglobal.
Given this request: Given this request:
@ -104,19 +125,17 @@ We can read the parsed body like this:
.. code-block:: php .. code-block:: php
class MyHandler implements RequestHandlerInterface function ($request, $response, $next) {
{
public function handle(ServerRequestInterface $request): ResponseInterface $cat = $request->getParsedBody();
{ /*
$cat = $request->getParsedBody(); Array
/* (
Array [name] => Molly
( [color] => calico
[name] => Molly )
[color] => calico */
)
*/
}
} }
Body Stream Body Stream
@ -138,54 +157,50 @@ Using a JSON representation of our cat, we can make a request like this:
"color": "Calico" "color": "Calico"
} }
We can read and parse the JSON body, and even provide it as the parsedBody for later middleware or handlers like this: We can read and parse the JSON body, and even provide it **as** the parsedBody for later middleware like this:
.. code-block:: php .. code-block:: php
class JsonParser implements MiddlewareInterface function ($request, $response, $next) {
{
public function process( $cat = json_decode((string) $request->getBody());
ServerRequestInterface $request, /*
RequestHandlerInterface $handler stdClass Object
): ResponseInterface (
{ [name] => Molly
// Parse the body. [color] => calico
$cat = json_decode((string) $request->getBody()); )
/* */
stdClass Object
( $request = $request->withParsedBody($cat);
[name] => Molly
[color] => calico }
)
*/
// Add the parsed JSON to the request. Because the entity body of a request or response can be very large, PSR-7_ represents bodies as streams using the ``Psr\Htt\Message\StreamInterface`` (see PSR-7_ Section 1.3).
$request = $request->withParsedBody($cat);
// Send the request to the next handler. The JSON example cast the stream to a string, but we can also do things like copy the stream to a local file:
return $handler->handle($request);
.. code-block:: php
function ($request, $response, $next) {
// Store the body to a temp file.
$chunkSize = 2048; // Number of bytes to read at once.
$localPath = tempnam(sys_get_temp_dir(), "body");
$h = fopen($localPath, "wb");
$body = $rqst->getBody();
while (!$body->eof()) {
fwrite($h, $body->read($chunkSize));
} }
fclose($h);
} }
Because the entity body of a request or response can be very large, PSR-7_ represents bodies as streams using the ``Psr\Http\Message\StreamInterface`` (see `PSR-7 Section 1.3`_).
The JSON example casts the stream to a string, but we can also do things like copy the stream to a local file:
.. code-block:: php
// Store the body to a temp file.
$chunkSize = 2048; // Number of bytes to read at once.
$localPath = tempnam(sys_get_temp_dir(), "body");
$h = fopen($localPath, "wb");
$body = $request->getBody();
while (!$body->eof()) {
fwrite($h, $body->read($chunkSize));
}
fclose($h);
Parameters Parameters
^^^^^^^^^^ ^^^^^^^^^^
PSR-7_ eliminates the need to read from many of the superglobals. We already saw how ``getParsedBody`` takes the place of reading directly from ``$_POST`` and ``getQueryParams`` replaces reading from ``$_GET``. Here are some other ``ServerRequestInterface`` methods with brief descriptions. Please see PSR-7_ for full details, particularly for ``getUploadedFiles``. PSR-7_ eliminates the need to read from many of the superglobals. We already saw how ``getParsedBody`` takes the place of reading directly from ``$_POST`` and ``getQueryParams`` replaces reading from ``$_GET``. Here are some other ``ServerRequestInterface`` methods with **brief** descriptions. Please see PSR-7_ for full details, particularly for ``getUploadedFiles``.
.. list-table:: .. list-table::
:header-rows: 1 :header-rows: 1
@ -222,63 +237,107 @@ For a request to ``/cats/Rufus``:
.. code-block:: php .. code-block:: php
$name = $request->getAttribute("name"); function ($request, $response, $next) {
// "Rufus"
$name = $request->getAttribute("name");
// "Rufus"
}
When calling ``getAttribute``, you can optionally provide a default value as the second argument. The value of this argument will be returned if the request has no attribute with that name. When calling ``getAttribute``, you can optionally provide a default value as the second argument. The value of this argument will be returned if the request has no attribute with that name.
.. code-block:: php .. code-block:: php
// Request has no attribute "dog" function ($request, $response, $next) {
$name = $request->getAttribute("dog", "Bear");
// "Bear"
Middleware can also use attributes as a way to provide extra information to subsequent handlers. For example, an authorization middleware could obtain an object representing a user and store is as the "user" attribute which later middleware could read. // Request has no attribute "dog"
$name = $request->getAttribute("dog", "Bear");
// "Bear"
}
Middleware can also use attributes as a way to provide extra information to subsequent middleware. For example, an authorization middleware could obtain an object representing a user and store is as the "user" attribute which later middleware could read.
.. code-block:: php .. code-block:: php
class AuthorizationMiddleware implements MiddlewareInterface $auth = function ($request, $response, $next) {
{
public function process(
ServerRequestInterface $request,
RequestHandlerInterface $handler
): ResponseInterface
try { try {
$user = $this->readUserFromCredentials($request); $user = readUserFromCredentials($request);
} catch (NoCredentialsSupplied $e) { } catch (NoCredentialsSupplied $e) {
return $response->withStatus(401); return $response->withStatus(401);
} catch (UserNotAllowedHere $e) { } catch (UserNotAllowedHere $e) {
return $response->withStatus(403); return $response->withStatus(403);
}
// Store this as an attribute.
$request = $request->withAttribute("user", $user);
// Delegate to the handler, passing the request with the "user" attribute.
return $handler->handle($request);
} }
// Store this as an attribute.
$request = $request->withAttribute("user", $user);
// Call $next, passing the request with the added attribute.
return $next($request, $response);
}; };
class SecureHandler implements RequestHandlerInterface $subsequent = function ($request, $response, $next) {
{
public function handle(ServerRequestInterface $request): ResponseInterface // Read the "user" attribute added by a previous middleware.
{ $user = $request->getAttribute("user");
// Read the "user" attribute added by a previous middleware.
$user = $request->getAttribute("user"); // Do something with $user
// Do something with $user ...
}
} }
$server = new \WellRESTed\Server(); $server = new \WellRESTed\Server();
$server->add(new AuthorizationMiddleware()); $server->add($auth);
$server->add(new SecureHandler()); // Must be added AFTER authorization to get "user" $server->add($subsequent); // Must be added AFTER $auth to get "user"
$server->respond(); $server->respond();
Finally, attributes provide a nice way to provide a `dependency injection`_ container for to your middleware.
Responses Responses
--------- ---------
Initial Response
^^^^^^^^^^^^^^^^
When you call ``WellRESTed\Server::respond``, the server creates a "blank" response instance to pass to dispatched middleware. This response will have a ``500 Internal Server Error`` status, no headers, and an empty body.
You may wish to start each request-response cycle with a response with a different initial state, for example to include a custom header with all responses or to assume success and only change the status code on a failure (or non-``200`` success). Here are two ways to provide this starting response:
Provide middleware as the first middleware that set the default conditions.
.. code-block:: php
$initialResponsePrep = function ($rqst, $resp, $next) {
// Set initial response and forward to subsequent middleware.
$resp = $resp
->withStatus(200)
->withHeader("X-powered-by", "My Super Cool API v1.0.2")
return $next($rqst, $resp);
};
$server = new \WellRESTed\Server();
$server->add($initialResponsePrep);
// ...add other middleware...
$server->respond();
Alternatively, instantiate a response and provide it to ``WellRESTed\Server::respond``.
.. code-block:: php
// Create an initial response. This can be any instance implementing
// Psr\Http\Message\ResponseInterface.
$response = new \WellRESTed\Message\Response(200, [
"X-powered-by" => ["My Super Cool API v1.0.2"]]);
$server = new \WellRESTed\Server();
// ...add middleware middleware...
// Pass the response to respond()
$server->respond(null, $response);
Modifying
^^^^^^^^^
PSR-7_ messages are immutable, so you will not be able to alter values of response properties. Instead, ``with*`` methods provide ways to get a copy of the current message with updated properties. For example, ``ResponseInterface::withStatus`` returns a copy of the original response with the status changed. PSR-7_ messages are immutable, so you will not be able to alter values of response properties. Instead, ``with*`` methods provide ways to get a copy of the current message with updated properties. For example, ``ResponseInterface::withStatus`` returns a copy of the original response with the status changed.
.. code-block:: php .. code-block:: php
@ -301,7 +360,7 @@ Chain multiple ``with`` methods together fluently:
.. code-block:: php .. code-block:: php
// Get a new response with updated status, headers, and body. // Get a new response with updated status, headers, and body.
$response = (new Response()) $response = $response
->withStatus(200) ->withStatus(200)
->withHeader("Content-type", "text/plain") ->withHeader("Content-type", "text/plain")
->withBody(new \WellRESTed\Message\Stream("Hello, world!); ->withBody(new \WellRESTed\Message\Stream("Hello, world!);
@ -315,7 +374,8 @@ Provide the status code for your response with the ``withStatus`` method. When y
The "reason phrase" is the text description of the status that appears in the status line of the response. The "status line" is the very first line in the response that appears before the first header. The "reason phrase" is the text description of the status that appears in the status line of the response. The "status line" is the very first line in the response that appears before the first header.
Although the PSR-7_ ``ResponseInterface::withStatus`` method accepts the reason phrase as an optional second parameter, you generally shouldn't pass anything unless you are using a non-standard status code. (And you probably shouldn't be using a non-standard status code.)
Although the PSR-7_ ``ResponseInterface::withStatus`` method accepts the reason phrase as an optional second parameter, you generally shouldn't pass anything unless you are using a non-standard status code. (And you probably shouldn't be using a non-standard status code.)
.. code-block:: php .. code-block:: php
@ -332,19 +392,19 @@ Provide the status code for your response with the ``withStatus`` method. When y
Headers Headers
^^^^^^^ ^^^^^^^
Use the ``withHeader`` method to add a header to a response. ``withHeader`` will add the header if not already set, or replace the value of an existing header with the same name. Use the ``withHeader`` method to add a header to a response. ``withHeader`` will add the header if not already set, or replace the value of an existing header with that name.
.. code-block:: php .. code-block:: php
// Add a "Content-type" header. // Add a "Content-type" header.
$response = $response->withHeader("Content-type", "text/plain"); $response = $response->withHeader("Content-type", "text/plain");
$response->getHeaderLine("Content-type"); $response->getHeaderLine("Content-type");
// "text/plain" // text/plain
// Calling withHeader a second time updates the value. // Calling withHeader a second time updates the value.
$response = $response->withHeader("Content-type", "text/html"); $response = $response->withHeader("Content-type", "text/html");
$response->getHeaderLine("Content-type"); $response->getHeaderLine("Content-type");
// "text/html" // text/html
To set multiple values for a given header field name (e.g., for ``Set-cookie`` headers), call ``withAddedHeader``. ``withAddedHeader`` adds the new header without altering existing headers with the same name. To set multiple values for a given header field name (e.g., for ``Set-cookie`` headers), call ``withAddedHeader``. ``withAddedHeader`` adds the new header without altering existing headers with the same name.
@ -395,31 +455,45 @@ When you pass a string to the constructor, the Stream instance uses `php://temp`
.. code-block:: php .. code-block:: php
// Pass the beginning of the contents to the constructor as a string. function ($rqst, $resp, $next) {
$body = new \WellRESTed\Message\Stream("Hello ");
// Append more contents. // Pass the beginning of the contents to the constructor as a string.
$body->write("world!"); $body = new \WellRESTed\Message\Stream("Hello ");
// Set the body and status code. // Append more contents.
$response = (new Response()) $body->write("world!");
->withStatus(200)
->withBody($body); // Set the body and status code.
$resp = $resp
->withStatus(200)
->withBody($body);
// Forward to the next middleware.
return $next($rqst, $resp);
}
To respond with the contents of an existing file, use ``fopen`` to open the file with read access and pass the pointer to the constructor. To respond with the contents of an existing file, use ``fopen`` to open the file with read access and pass the pointer to the constructor.
.. code-block:: php .. code-block:: php
// Open the file with read access. function ($rqst, $resp, $next) {
$resource = fopen("/home/user/some/file", "rb");
// Pass the file pointer resource to the constructor. // Open the file with read access.
$body = new \WellRESTed\Message\Stream($resource); $resource = fopen("/home/user/some/file", "rb");
// Set the body and status code. // Pass the file pointer resource to the constructor.
$response = (new Response()) $body = new \WellRESTed\Message\Stream($resource);
->withStatus(200)
->withBody($body); // Set the body and status code.
$resp = $resp
->withStatus(200)
->withBody($body);
// Forward to the next middleware.
return $next($rqst, $resp);
}
NullStream NullStream
~~~~~~~~~~ ~~~~~~~~~~
@ -428,16 +502,23 @@ Each PSR-7_ message MUST have a body, so there's no ``withoutBody`` method. You
.. code-block:: php .. code-block:: php
$response = (new Response()) function ($rqst, $resp, $next) {
->withStatus(200)
->withBody(new \WellRESTed\Message\NullStream());
.. _HTTP Status Code Registry: https://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml // Set the body and status code.
$resp = $resp
->withStatus(304)
->withBody(new \WellRESTed\Message\NullStream());
// Forward to the next middleware.
return $next($rqst, $resp);
}
.. _HTTP Status Code Registry: http://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml
.. _PSR-7: http://www.php-fig.org/psr/psr-7/ .. _PSR-7: http://www.php-fig.org/psr/psr-7/
.. _PSR-7 Section 1.3: https://www.php-fig.org/psr/psr-7/#13-streams
.. _Getting Started: getting-started.html .. _Getting Started: getting-started.html
.. _Middleware: middleware.html .. _Middleware: middleware.html
.. _template routes: router.html#template-routes .. _template routes: router.html#template-routes
.. _regex routes: router.html#regex-routes .. _regex routes: router.html#regex-routes
.. _dependency injection: dependency-injection.html .. _dependency injection: dependency-injection.html
.. _`php://temp`: https://php.net/manual/ro/wrappers.php.php .. _`php://temp`: http://php.net/manual/ro/wrappers.php.php

295
docs/source/middleware.rst Normal file
View File

@ -0,0 +1,295 @@
Middleware
==========
Okay, so what exactly **is** middleware? It's a nebulous term, and it's a bit reminiscent of the Underpants gnomes.
- Phase 1: Request
- Phase 2: ???
- Phase 3: Response
Middleware is indeed Phase 2. It's something (a callable or object) that takes a request and a response as inputs, does something with the response, and sends the altered response back out.
A Web service can built from many, many pieces of middleware, with each piece managing a specific task such as authentication or parsing representations. When each middleware runs, it is responsible for propagating the request through to the next middleware in the sequence—or deciding not to.
So what's it look like? In essence, a single piece of middleware looks something like this:
.. code-block:: php
function ($request, $response, $next) {
// Update the response.
/* $response = ... */
// Determine if any other middleware should be called after this.
if (/* Stop now without calling more middleware? */) {
// Return the response without calling any other middleware.
return $response;
}
// Let the next middleware work on the response. This propagates "up"
// the chain of middleware, and will eventually return a response.
$response = $next($request, $response);
// Possibly update the response some more.
/* $response = ... */
// Return the response.
return $response;
}
Defining Middleware
^^^^^^^^^^^^^^^^^^^
Middleware can be a callable (as in the `Getting Started`_) or an implementation of the ``WellRESTed\MiddlewareInterface`` (which implements ``__invoke`` so is technically a callable, too).
.. rubric:: Callable
.. code-block:: php
/**
* @param Psr\Http\Message\ServerRequestInterface $request
* @param Psr\Http\Message\ResponseInterface $response
* @param callable $next
* @return Psr\Http\Message\ResponseInterface
*/
function ($request, $response, $next) { }
.. rubric:: MiddlewareInterface
.. code-block:: php
<?php
namespace WellRESTed;
use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\ServerRequestInterface;
interface MiddlewareInterface
{
/**
* @param ServerRequestInterface $request
* @param ResponseInterface $response
* @param callable $next
* @return ResponseInterface
*/
public function __invoke(ServerRequestInterface $request, ResponseInterface $response, $next);
}
Using Middleware
^^^^^^^^^^^^^^^^
Methods that accept middleware (e.g., ``Server::add``, ``Router::register``) allow you to provide middleware in a number of ways. For example, you can provide a string containing a class name, a middleware callable, a factory callable, or even an array containing a sequence of middleware.
Fully Qualified Class Name (FQCN)
---------------------------------
Assume your Web service has an autoloadable class named ``Webservice\Widgets\WidgetHandler``. You can register it with a router by passing a string containing the fully qualified class name (FQCN):
.. code-block:: php
$router->register("GET,PUT,DELETE", "/widgets/{id}", 'Webservice\Widgets\WidgetHandler');
The class is not loaded, and no instances are created, until the route is matched and dispatched. Even for a router with 100 routes, no middleware registered by string name is loaded, except for the one that matches the request.
Factory Callable
----------------
You can also use a callable to instantiate and return a ``MiddlewareInterface`` instance or middleware callable.
.. code-block:: php
$router->add("GET,PUT,DELETE", "/widgets/{id}", function () {
return new \Webservice\Widgets\WidgetHandler();
});
This still delays instantiation, but gives you some added flexibility. For example, you could define middleware that receives some dependencies upon construction.
.. code-block:: php
$container = new MySuperCoolDependencyContainer();
$router->add("GET,PUT,DELETE", "/widgets/{id}", function () use ($container) {
return new \Webservice\Widgets\WidgetHandler($container["foo"], $container["baz"]);
});
This is one approach to `dependency injection`_.
Middleware Callable
-------------------
Use a middleware callable directly.
.. code-block:: php
$router->add("GET,PUT,DELETE", "/widgets/{id}", function ($request, $response, $next) {
$response = $response->withStatus(200)
->withHeader("Content-type", "text/plain")
->withBody(new \WellRESTed\Message\Stream("It's a bunch of widgets!"));
return $next($request, $response);
});
Because ``WellRESTed\MiddlewareInterface`` has an ``__invoke`` method, implementing instances are also middleware callables. Assuming ``WidgetHandler`` implements ``MiddelewareInterface``, you can do this:
.. code-block:: php
$router->add("GET,PUT,DELETE", "/widgets/{id}", new \Webservice\Widgets\WidgetHandler());
.. warning::
This is simple, but has a significant disadvantage over the other options because each middleware used this way will be loaded and instantiated, even if it's not needed for a given request-response cycle. You may find this approach useful for testing, but avoid if for production code.
Array
-----
Why use one middleware when you can use more?
Provide a sequence of middleware as an array. Each component of the array can be any of the varieties listed in this section.
When dispatched, the middleware in the array will run in order, with each calling the one following via the ``$next`` parameter.
.. code-block:: php
$router->add("GET", "/widgets/{id}", ['Webservice\Auth', $jsonParser, $widgetHandler]);
Chaining Middleware
^^^^^^^^^^^^^^^^^^^
Chaining middleware together allows you to build your Web service in a discrete, modular pieces. Each middleware in the chain makes the decision to either move the request up the chain by calling ``$next``, or stop propagation by returning a response without calling ``$next``.
Propagating Up the Chain
------------------------
Imagine we want to add authorization to the ``/widgets/{id}`` endpoint. We can do this without altering the existing middleware that deals with the widget itself.
What we do is create an additional middleware that performs just the authorization task. This middleware will inspect the incoming request for authorization headers, and either move the request on up the chain to the next middleware if all looks good, or send a request back out with an appropriate status code.
Here's an example authorization middleware using pseudocode.
.. code-block:: php
namespace Webservice;
class Authorization implements \WellRESTed\MiddlewareInterface
{
public function __invoke(ServerRequestInterface $request, ResponseInterface $response, $next)
{
// Validate the headers in the request.
try {
$validateUser($request);
} catch (InvalidHeaderException $e) {
// User did not supply the right headers.
// Respond with a 401 Unauthorized status.
return $response->withStatus(401);
} catch (BadUserException $e) {
// User is not permitted to access this resource.
// Respond with a 403 Forbidden status.
return $response->withStatus(403);
}
// No exception was thrown, so propagate to the next middleware.
return $next($request, $response);
}
}
We can add authorization for just the ``/widgets/{id}`` endpoint like this:
.. code-block:: php
$server = new \WellRESTed\Server();
$server->add($server->createRouter()
->register("GET,PUT,DELETE", "/widgets/{id}", [
'Webservice\Authorization',
'Webservice\Widgets\WidgetHandler'
])
->respond();
Or, if you wanted to use the authorization for the entire service, you can add it to the ``Server`` in front of the ``Router``.
.. code-block:: php
$server = new \WellRESTed\Server();
$server
->add('Webservice\Authorization')
->add($server->createRouter()
->register("GET,PUT,DELETE", "/widgets/{id}", 'Webservice\Widgets\WidgetHandler')
)
->respond();
Moving Back Down the Chain
--------------------------
The authorization example returned ``$next($request, $response)`` immediately, but you can do some interesting things by working with the response that comes back from ``$next``. Think of the request as taking a round trip on the subway with each middleware being a stop along the way. Each of the stops you go through going up the chain, you also go through on the way back down.
We could add a caching middleware in front of ``GET`` requests for a specific widget. This middleware will check if a cached representation exists for the resource the client requested. If it exists, it will send it out to the client without ever bothering the ``WidgetHandler``. If there's no representation cached, it will call ``$next`` to propagate the request up the chain. On the return trip (when the call to ``$next`` finishes), the caching middleware will inspect the response and store the body to the cache for next time.
Here's a pseudocode example:
.. code-block:: php
namespace Webservice;
class Cache implements \WellRESTed\MiddlewareInterface
{
public function dispatch(ServerRequestInterface $request, ResponseInterface $response, $next)
{
// Inspect the request path to see if there is a representation on
// hand for this resource.
$representation = $this->getCachedRepresentation($request);
if ($representation !== null) {
// There is already a cached representation. Send it out
// without propagating.
return $response
->withStatus(200)
->withBody($representation);
}
// No representation exists. Propagate to the next middleware.
$response = $next($request, $response);
// Attempt to store the response to the cache.
$this->storeRepresentationToCache($response);
return $response;
}
private function getCachedRepresentation(ServerRequestInterface $request)
{
// Look for a cached representation. Return null if not found.
// ...
}
private function storeRepresentationToCache(ResponseInterface $response)
{
// Ensure the response contains a success code, a valid body,
// headers that allow caching, etc. and store the representation.
// ...
}
}
We can add this caching middleware in the chain between the authorization middleware and the Widget.
.. code-block:: php
$router->register("GET,PUT,DELETE", "/widgets/{id}", [
'Webservice\Authorization',
'Webservice\Cache',
'Webservice\Widgets\WidgetHandler'
]);
Or, if you wanted to use the authorization and caching middleware for the entire service, you can add them to the ``Server`` in front of the ``Router``.
.. code-block:: php
$server = new \WellRESTed\Server();
$server
->add('Webservice\Authorization')
->add('Webservice\Cache')
->add($server->createRouter()
->register("GET,PUT,DELETE", "/widgets/{id}", 'Webservice\Widgets\WidgetHandler')
)
->respond();
.. _Dependency Injection: dependency-injection.html
.. _Getting Started: getting-started.html

View File

@ -4,20 +4,20 @@ Overview
Installation Installation
^^^^^^^^^^^^ ^^^^^^^^^^^^
The recommended method for installing WellRESTed is to use Composer_. Add an entry for WellRESTed in your project's ``composer.json`` file. The recommended method for installing WellRESTed is to use the PHP dependency manager Composer_. Add an entry for WellRESTed in your project's ``composer.json`` file.
.. code-block:: js .. code-block:: js
{ {
"require": { "require": {
"wellrested/wellrested": "^5" "wellrested/wellrested": "~3.0"
} }
} }
Requirements Requirements
^^^^^^^^^^^^ ^^^^^^^^^^^^
- PHP 7.3 - PHP 5.4.0
License License
^^^^^^^ ^^^^^^^
@ -26,7 +26,7 @@ Licensed using the `MIT license <http://opensource.org/licenses/MIT>`_.
The MIT License (MIT) The MIT License (MIT)
Copyright (c) 2021 PJ Dietz Copyright (c) 2015 PJ Dietz
Permission is hereby granted, free of charge, to any person obtaining a copy Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal of this software and associated documentation files (the "Software"), to deal
@ -46,4 +46,4 @@ Licensed using the `MIT license <http://opensource.org/licenses/MIT>`_.
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE. THE SOFTWARE.
.. _Composer: https://getcomposer.org/ .. _Composer: http://getcomposer.org/

View File

@ -1,7 +1,8 @@
Router Router
====== ======
A router is a type of middleware that organizes the components of a site by associating HTTP methods and paths with handlers and middleware. When the router receives a request, it examines the path components of the request's URI, determines which "route" matches, and dispatches the associated handler. The dispatched handler is then responsible for reacting to the request and providing a response. A router is a type of middleware_ that organizes the components of a site by associating URI paths with other middleware_. When the router receives a request, it examines the path components of the request's URI, determines which "route" matches, and dispatches the associated middleware_. The dispatched middleware_ is then responsible for reacting to the request and providing a response.
Basic Usage Basic Usage
^^^^^^^^^^^ ^^^^^^^^^^^
@ -13,7 +14,7 @@ Typically, you will want to use the ``WellRESTed\Server::createRouter`` method t
$server = new WellRESTed\Server(); $server = new WellRESTed\Server();
$router = $server->createRouter(); $router = $server->createRouter();
Suppose ``$catHandler`` is a handler that you want to dispatch whenever a client makes a ``GET`` request to the path ``/cats/``. Use the ``register`` method map it to that path and method. Suppose ``$catHandler`` is a middleware that you want to dispatch whenever a client makes a ``GET`` request to the path ``/cats/``. Use the ``register`` method map it to that path and method.
.. code-block:: php .. code-block:: php
@ -41,12 +42,12 @@ The ``register`` method is fluent, so you can add multiple routes in either of t
Paths Paths
^^^^^ ^^^^^
A router can map a handler to an exact path, or to a pattern of paths. A router can map middleware to an exact path, or to a pattern of paths.
Static Routes Static Routes
------------- -------------
The simplest type of route is called a "static route". It maps a handler to an exact path. The simplest type of route is called a "static route". It maps middleware to an exact path.
.. code-block:: php .. code-block:: php
@ -76,14 +77,17 @@ For example, this template will match requests to ``/cats/12``, ``/cats/molly``,
$router->register("GET", "/cats/{cat}", $catHandler); $router->register("GET", "/cats/{cat}", $catHandler);
When the router dispatches a route matched by a template route, it provides the extracted variables as request attributes. To access a variable, call the request object's ``getAttribute`` method and pass the variable's name. When the router dispatches a route matched by a template route, it provides the extracted variables as an associative array. To access a variable, call the request object's ``getAttribute`` method method and pass the variable's name.
For a request to ``/cats/molly``: For a request to ``/cats/molly``:
.. code-block:: php .. code-block:: php
$name = $request->getAttribute("cat"); $catHandler = function ($request, $response, $next) {
// "molly" $name = $request->getAttribute("cat");
// molly
...
}
Template routes are very powerful, and this only scratches the surface. See `URI Templates`_ for a full explanation of the syntax supported. Template routes are very powerful, and this only scratches the surface. See `URI Templates`_ for a full explanation of the syntax supported.
@ -102,28 +106,32 @@ For a request to ``/cats/molly-90``:
.. code-block:: php .. code-block:: php
$vars = $request->getAttributes(); $catHandler = function ($request, $response, $next) {
/* $vars = $request->getAttributes();
Array /*
( Array
[0] => cats/molly-12 (
[name] => molly [0] => cats/molly-12
[1] => molly [name] => molly
[number] => 12 [1] => molly
[2] => 12 [number] => 12
) [2] => 12
*/ ... Plus any other attributes that were set ...
)
*/
...
}
Route Priority Route Priority
-------------- --------------
A router will often contain many routes, and sometimes more than one route will match for a given request. When the router looks for a matching route, it performs these checks in order. A router will often contain many routes, and sometimes more than one route will match for a given request. When the router looks for a matching route, it performs these checks:
#. If there is a static route with exact match to path, dispatch it. #. If there is a static route with exact match to path, dispatch it.
#. If one prefix route matches the beginning of the path, dispatch it. #. If one prefix route matches the beginning of the path, dispatch it.
#. If multiple prefix routes match, dispatch the longest matching prefix route. #. If multiple prefix routes match, dispatch the longest matching prefix route.
#. Inspect each pattern route (template and regular expression) in the order in which they were added to the router. Dispatch the first route that matches. #. Inspect each pattern route (template and regular expression) in the order added. Dispatch the first route that matches.
#. If no pattern routes match, return a response with a ``404 Not Found`` status. (**Note:** This is the default behavior. To configure a router to delegate to the next middleware when no route matches, call the router's ``continueOnNotFound()`` method.) #. If no pattern routes match, return a response with a ``404 Not Found`` status.
Static vs. Prefix Static vs. Prefix
~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~
@ -166,12 +174,12 @@ Given these routes:
->register("GET", "/dogs/*", $prefix); ->register("GET", "/dogs/*", $prefix);
->register("GET", "/dogs/{group}/{breed}", $pattern); ->register("GET", "/dogs/{group}/{breed}", $pattern);
``$pattern`` will **never** be dispatched because any route that matches ``/dogs/{group}/{breed}`` also matches ``/dogs/*``, and prefix routes have priority over pattern routes. ``$pattern`` will never be dispatched because any route that matches ``/dogs/{group}/{breed}`` also matches ``/dogs/*``, and prefix routes have priority over pattern routes.
Pattern vs. Pattern Pattern vs. Pattern
~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~
When multiple pattern routes match a path, the first one that was added to the router will be the one dispatched. **Be careful to add the specific routes before the general routes.** For example, say you want to send traffic to two similar looking URIs to different handlers based whether the variables were supplied as numbers or letters—``/dogs/102/132`` should be dispatched to ``$numbers``, while ``/dogs/herding/australian-shepherd`` should be dispatched to ``$letters``. When multiple pattern routes match a path, the first one that was added to the router will be the one dispatched. Be careful to add the specific routes before the general routes. For example, say you want to send traffic to two similar looking URIs to different middleware based whether the variables were supplied as numbers or letters—``/dogs/102/132`` should be dispatched to ``$numbers``, while ``/dogs/herding/australian-shepherd`` should be dispatched to ``$letters``.
This will work: This will work:
@ -191,7 +199,7 @@ This will **NOT** work:
// Matches only when the variables are digits. // Matches only when the variables are digits.
$router->register("GET", "~/dogs/([0-9]+)/([0-9]+)", $numbers); $router->register("GET", "~/dogs/([0-9]+)/([0-9]+)", $numbers);
This is because ``/dogs/{group}/{breed}`` will match both ``/dogs/102/132`` **and** ``/dogs/herding/australian-shepherd``. If it is added to the router before the route for ``$numbers``, it will be dispatched before the route for ``$numbers`` is ever evaluated. This is because ``/dogs/{group}/{breed}`` will match both ``/dogs/102/132`` and ``/dogs/herding/australian-shepherd``. If it is added to the router before the route for ``$numbers``, it will be dispatched before the route for ``$numbers`` is ever evaluated.
Methods Methods
^^^^^^^ ^^^^^^^
@ -201,7 +209,7 @@ When you register a route, you can provide a specific method, a list of methods,
Registering by Method Registering by Method
--------------------- ---------------------
Specify a specific handler for a path and method by including the method as the first parameter. Specify a specific middleware for a path and method by including the method as the first parameter.
.. code-block:: php .. code-block:: php
@ -214,7 +222,7 @@ Specify a specific handler for a path and method by including the method as the
Registering by Method List Registering by Method List
-------------------------- --------------------------
Specify the same handler for multiple methods for a given path by proving a comma-separated list of methods as the first parameter. Specify the same middleware for multiple methods for a given path by proving a comma-separated list of methods as the first parameter.
.. code-block:: php .. code-block:: php
@ -230,7 +238,7 @@ Specify the same handler for multiple methods for a given path by proving a comm
Registering by Wildcard Registering by Wildcard
----------------------- -----------------------
Specify a handler for all methods for a given path by proving a ``*`` wildcard. Specify middleware for all methods for a given path by proving a ``*`` wildcard.
.. code-block:: php .. code-block:: php
@ -283,51 +291,44 @@ A ``POST`` request to ``/cats/12`` will provide:
HTTP/1.1 405 Method Not Allowed HTTP/1.1 405 Method Not Allowed
Allow: GET,PUT,DELETE,HEAD,OPTIONS Allow: GET,PUT,DELETE,HEAD,OPTIONS
Error Responses Error Responses
^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^
Then a router is able to locate a route that matches the path, but that route doesn't support the request's method, the router will respond ``405 Method Not Allowed``. When a router is unable to dispatch a route because either the path or method does not match a defined route, it will provide an appropriate error response code—either ``404 Not Found`` or ``405 Method Not Allowed``.
When a router is unable to match the route, it will delegate to the next middleware. The router always checks the path first. If route for that path matches, the router responds ``404 Not Found``.
.. note:: If the router is able to locate a route that matches the path, but that route doesn't support the request's method, the router will respond ``405 Method Not Allowed``.
When no route matches, the Router will delegate to the next middleware in the server. This is a change from previous versions of WellRESTed where there Router would return a 404 Not Found response. This new behaviour allows a servers to have multiple routers. Given this router:
Router-specific Middleware
^^^^^^^^^^^^^^^^^^^^^^^^^^
WellRESTed allows a Router to have a set of middleware to dispatch whenever it finds a route that matches. This middleware runs before the handler for the matched route, and only when a route matches.
This feature allows you to build a site where some sections use certain middleware and other do not. For example, suppose your site has a public section that does not require authentication and a private section that does. We can use a different router for each section, and provide authentication middleware on only the router for the private area.
.. code-block:: php .. code-block:: php
$server = new Server(); $router
->register("GET", "/cats/", $catReader)
->register("POST", "/cats/", $catWriter)
->register("GET", "/dogs/", $catItemReader)
// Add the "public" router. The following requests wil provide these responses:
$public = $server->createRouter();
$public->register('GET', '/', $homeHandler);
$public->register('GET', '/about', $homeHandler);
// Set the router call the next middleware when no route matches.
$public->continueOnNotFound();
$server->add($public);
// Add the "private" router. ====== ========== ========
$private = $server->createRouter(); Method Path Response
// Authorization middleware checks for an Authorization header and ====== ========== ========
// responds 401 when the header is missing or invalid. GET /hamsters/ 404 Not Found
$private->add($authorizationMiddleware); PUT /cats/ 405 Method Not Allowed
$private->register('GET', '/secret', $secretHandler); ====== ========== ========
$private->register('GET', '/members-only', $otherHandler);
$server->add($private);
$server->respond(); .. note::
When the router fails to dispatch a route, or when it responds to an ``OPTIONS`` request, is will stop propagation, and any middleware that comes after the router will not be dispatched.
Nested Routers Nested Routers
^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^
For large Web services with large numbers of endpoints, a single, monolithic router may not to optimal. To avoid having each request test every pattern-based route, you can break up a router into a hierarchy of routers. For large Web services with large numbers of endpoints, a single, monolithic router may not to optimal. To avoid having each request test every pattern-based route, you can break up a router into sub-routers.
This works because a ``Router`` is type of middleware, and can be used wherever middleware can be used.
Here's an example where all of the traffic beginning with ``/cats/`` is sent to one router, and all the traffic for endpoints beginning with ``/dogs/`` is sent to another. Here's an example where all of the traffic beginning with ``/cats/`` is sent to one router, and all the traffic for endpoints beginning with ``/dogs/`` is sent to another.
@ -353,6 +354,7 @@ Here's an example where all of the traffic beginning with ``/cats/`` is sent to
$server->respond(); $server->respond();
.. _preg_match: https://php.net/manual/en/function.preg-match.php .. _preg_match: http://php.net/manual/en/function.preg-match.php
.. _URI Template: `URI Templates`_s .. _URI Template: `URI Templates`_s
.. _URI Templates: uri-templates.html .. _URI Templates: uri-templates.html
.. _middleware: middleware.html

View File

@ -1,7 +1,7 @@
URI Templates (Advanced) URI Templates (Advanced)
======================== ========================
In `URI Templates`_, we looked at the most common ways to use URI Templates. Here, we'll look at some of the extended syntaxes that URI Templates provide. In `URI Templates`_, we looked at the most common ways to use URI Templates. In this chapter, we'll look at some of the extended syntaxes that URI Templates provide.
Path Components Path Components
^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^

View File

@ -1,7 +1,7 @@
URI Templates URI Templates
============= =============
WellRESTed allows you to register handlers with a router using URI Templates, based on the URI Templates defined in `RFC 6570`_. These templates include variables (enclosed in curly braces) which are extracted and made available to the dispatched middleware. WellRESTed allows you to register middleware with a router using URI Templates, based on the URI Templates defined in `RFC 6570`_. These templates include variables (enclosed in curly braces) which are extracted and made available to the dispatched middleware.
Reading Variables Reading Variables
^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^
@ -9,7 +9,7 @@ Reading Variables
Basic Usage Basic Usage
----------- -----------
Register a handler with a URI Template by providing a path that include at least one section enclosed in curly braces. The curly braces define variables for the template. Register middleware with a URI Template by providing a path that include at least one section enclosed in curly braces. The curly braces define variables for the template.
.. code-block:: php .. code-block:: php
@ -17,17 +17,16 @@ Register a handler with a URI Template by providing a path that include at least
The router will match requests for paths like ``/widgets/12`` and ``/widgets/mega-widget`` and dispatch ``$widgetHandler`` with the extracted variables made available as request attributes. The router will match requests for paths like ``/widgets/12`` and ``/widgets/mega-widget`` and dispatch ``$widgetHandler`` with the extracted variables made available as request attributes.
To read a path variable, router inspects the request attribute named ``"id"``, since ``id`` is what appears inside curly braces in the URI template. To read a path variable, the ``$widgetHandler`` middleware inspects the request attribute named ``"id"``, since ``id`` is what appears inside curly braces in the URI template.
.. code-block:: php .. code-block:: php
// For a request to /widgets/12 $widgetHandler = function ($request, $response, $next) {
$id = $request->getAttribute("id"); // Read the variable extracted form the path.
// "12" $id = $request->getAttribute("id");
};
// For a request to /widgets/mega-widget When the request path is ``/widgets/12``, the value returned by ``$request->getAttribute("id")`` is ``"12"``. For ``/widgets/mega-widget``, the value is ``"mega-widget"``.
$id = $request->getAttribute("id");
// "mega-widget"
.. note:: .. note::
@ -36,7 +35,7 @@ To read a path variable, router inspects the request attribute named ``"id"``, s
Multiple Variables Multiple Variables
------------------ ------------------
The example above included one variable, but URI Templates may include multiple. Each variable will be provided as a request attribute, so be sure to give your variables unique names. The example above included one variable, but URI Templates may include multiple variables. Each variable will be provided as a request attribute, so be sure to give your variables unique names.
Here's an example with a handful of variables. Suppose we have a template describing the path for a user's avatar image. The image is identified by a username and the image dimensions. Here's an example with a handful of variables. Suppose we have a template describing the path for a user's avatar image. The image is identified by a username and the image dimensions.
@ -48,13 +47,15 @@ A request for ``GET /avatars/zoidberg-100x150.jpg`` will provide these request a
.. code-block:: php .. code-block:: php
// Read the variables extracted form the path. $avatarHandlers = function ($request, $response, $next) {
$username = $request->getAttribute("username"); // Read the variables extracted form the path.
// "zoidberg" $username = $request->getAttribute("username");
$width = $request->getAttribute("width"); // "zoidberg"
// "100" $width = $request->getAttribute("width");
$height = $request->getAttribute("height"); // "100"
// "150" $height = $request->getAttribute("height");
// "150"
};
Arrays Arrays
------ ------
@ -107,7 +108,7 @@ Given the template ``/users/{user}``, the following paths provide these values f
* - /users/zoidberg%40planetexpress.com * - /users/zoidberg%40planetexpress.com
- "zoidberg@planetexpress.com" - "zoidberg@planetexpress.com"
A request for ``GET /uses/zoidberg@planetexpress.com`` will **not** match this template, because ``@`` is a reserved character and is not percent encoded. A request for ``GET /uses/zoidberg@planetexpress.com`` will **not** match this template, because ``@`` is not an unreserved character and is not percent encoded.
Reserved Characters Reserved Characters
------------------- -------------------
@ -126,14 +127,17 @@ The router will dispatch ``$pathHandler`` with for a request to ``GET /my-favori
.. code-block:: php .. code-block:: php
$path = $request->getAttribute("path"); $pathHandler = function ($request, $response, $next) {
// "/has/a/few/slashes.jpg" // Read the variable extracted form the path.
$path = $request->getAttribute("path");
// "/has/a/few/slashes.jpg"
};
.. note:: .. note::
Combine the ``+`` operator and ``*`` modifier to match reserved characters as an array. For example, the template ``/{+vars*}`` will match the path ``/c@t,d*g``, providing the array ``["c@t", "d*g"]``. Combine the ``+`` operator and ``*`` modifier to match reserved characters as an array. For example, the template ``/{+vars*}`` will match the path ``/c@t,d*g``, providing the array ``["c@t", "d*g"]``.
.. _RFC 3968 Section 2.3: https://tools.ietf.org/html/rfc3986#section-2.3 .. _RFC 3968 Section 2.3: https://tools.ietf.org/html/rfc3986#section-2.3
.. _PSR-7: https://www.php-fig.org/psr/psr-7/ .. _PSR-7: http://www.php-fig.org/psr/psr-7/
.. _RFC 6570: https://tools.ietf.org/html/rfc6570 .. _RFC 6570: https://tools.ietf.org/html/rfc6570
.. _RFC 6570 Section 3.2.7: https://tools.ietf.org/html/rfc6570#section-3.2.7 .. _RFC 6570 Section 3.2.7: https://tools.ietf.org/html/rfc6570#section-3.2.7

29
phpunit.xml.dist Normal file
View File

@ -0,0 +1,29 @@
<?xml version="1.0" encoding="UTF-8"?>
<phpunit
bootstrap="test/bootstrap.php"
colors="true"
convertErrorsToExceptions="true"
convertNoticesToExceptions="true"
convertWarningsToExceptions="true"
processIsolation="false"
stopOnFailure="false"
syntaxCheck="false"
verbose="true"
>
<testsuites>
<testsuite name="unit">
<directory>./test/tests/unit</directory>
</testsuite>
<testsuite name="integration">
<directory>./test/tests/integration</directory>
</testsuite>
</testsuites>
<filter>
<whitelist>
<directory suffix=".php">./src</directory>
</whitelist>
</filter>
<logging>
<log type="coverage-html" target="./report" charset="UTF-8" hightlight="true" />
</logging>
</phpunit>

View File

@ -1,59 +0,0 @@
<?php
use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\ServerRequestInterface;
use Psr\Http\Server\RequestHandlerInterface;
use WellRESTed\Message\Response;
use WellRESTed\Message\Stream;
use WellRESTed\Server;
ini_set('display_errors', 1);
ini_set('display_startup_errors', 1);
error_reporting(E_ALL);
require_once __DIR__ . '/../vendor/autoload.php';
// Create a handler using the PSR-15 RequestHandlerInterface
class HomePageHandler implements RequestHandlerInterface
{
public function handle(ServerRequestInterface $request): ResponseInterface
{
$view = <<<HTML
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>WellRESTed Development Site</title>
</head>
<body>
<h1>WellRESTed Development Site</h1>
<p>To run unit tests, run:</p>
<code>docker-compose run --rm php phpunit</code>
<p>View the <a href="/coverage/">code coverage report</a>.</p>
<p>To generate documentation, run:</p>
<code>docker-compose run --rm docs</code>
<p>View <a href="/docs/"> documentation</a>.</p>
</body>
</html>
HTML;
return (new Response(200))
->withHeader('Content-type', 'text/html')
->withBody(new Stream($view));
}
}
// -----------------------------------------------------------------------------
// Create a new Server instance.
$server = new Server();
// Add a router to the server to map methods and endpoints to handlers.
$router = $server->createRouter();
// Register the route GET / with an anonymous function that provides a handler.
$router->register("GET", "/", function () { return new HomePageHandler(); });
// Add the router to the server.
$server->add($router);
// Read the request from the client, dispatch a handler, and output.
$server->respond();

View File

@ -2,8 +2,6 @@
namespace WellRESTed\Dispatching; namespace WellRESTed\Dispatching;
use InvalidArgumentException; class DispatchException extends \InvalidArgumentException
class DispatchException extends InvalidArgumentException
{ {
} }

View File

@ -10,11 +10,12 @@ use Psr\Http\Message\ServerRequestInterface;
*/ */
class DispatchStack implements DispatchStackInterface class DispatchStack implements DispatchStackInterface
{ {
/** @var mixed[] */
private $stack; private $stack;
/** @var DispatcherInterface */
private $dispatcher; private $dispatcher;
/**
* @param DispatcherInterface $dispatcher
*/
public function __construct(DispatcherInterface $dispatcher) public function __construct(DispatcherInterface $dispatcher)
{ {
$this->dispatcher = $dispatcher; $this->dispatcher = $dispatcher;
@ -25,7 +26,7 @@ class DispatchStack implements DispatchStackInterface
* Push a new middleware onto the stack. * Push a new middleware onto the stack.
* *
* @param mixed $middleware Middleware to dispatch in sequence * @param mixed $middleware Middleware to dispatch in sequence
* @return static * @return self
*/ */
public function add($middleware) public function add($middleware)
{ {
@ -39,7 +40,7 @@ class DispatchStack implements DispatchStackInterface
* The first middleware that was added is dispatched first. * The first middleware that was added is dispatched first.
* *
* Each middleware, when dispatched, receives a $next callable that, when * Each middleware, when dispatched, receives a $next callable that, when
* called, will dispatch the following middleware in the sequence. * called, will dispatch the next middleware in the sequence.
* *
* When the stack is dispatched empty, or when all middleware in the stack * When the stack is dispatched empty, or when all middleware in the stack
* call the $next argument they were passed, this method will call the * call the $next argument they were passed, this method will call the
@ -53,11 +54,8 @@ class DispatchStack implements DispatchStackInterface
* @param callable $next * @param callable $next
* @return ResponseInterface * @return ResponseInterface
*/ */
public function __invoke( public function __invoke(ServerRequestInterface $request, ResponseInterface $response, $next)
ServerRequestInterface $request, {
ResponseInterface $response,
$next
) {
$dispatcher = $this->dispatcher; $dispatcher = $this->dispatcher;
// This flag will be set to true when the last middleware calls $next. // This flag will be set to true when the last middleware calls $next.
@ -65,30 +63,19 @@ class DispatchStack implements DispatchStackInterface
// The final middleware's $next returns $response unchanged and sets // The final middleware's $next returns $response unchanged and sets
// the $stackCompleted flag to indicate the stack has completed. // the $stackCompleted flag to indicate the stack has completed.
$chain = function ( $chain = function ($request, $response) use (&$stackCompleted) {
ServerRequestInterface $request,
ResponseInterface $response
) use (&$stackCompleted): ResponseInterface {
$stackCompleted = true; $stackCompleted = true;
return $response; return $response;
}; };
// Create a chain of callables. // Create a chain of callables.
// //
// Each callable will take $request and $response parameters, and will // Each callable wil take $request and $response parameters, and will
// contain a dispatcher, the associated middleware, and a $next function // contain a dispatcher, the associated middleware, and a $next
// that serves as the link to the next middleware in the chain. // that is the links to the next middleware in the chain.
foreach (array_reverse($this->stack) as $middleware) { foreach (array_reverse($this->stack) as $middleware) {
$chain = function ( $chain = function ($request, $response) use ($dispatcher, $middleware, $chain) {
ServerRequestInterface $request, return $dispatcher->dispatch($middleware, $request, $response, $chain);
ResponseInterface $response
) use ($dispatcher, $middleware, $chain): ResponseInterface {
return $dispatcher->dispatch(
$middleware,
$request,
$response,
$chain
);
}; };
} }

View File

@ -17,7 +17,7 @@ interface DispatchStackInterface extends MiddlewareInterface
* This method MUST preserve the order in which middleware are added. * This method MUST preserve the order in which middleware are added.
* *
* @param mixed $middleware Middleware to dispatch in sequence * @param mixed $middleware Middleware to dispatch in sequence
* @return static * @return self
*/ */
public function add($middleware); public function add($middleware);
@ -48,9 +48,5 @@ interface DispatchStackInterface extends MiddlewareInterface
* @param callable $next * @param callable $next
* @return ResponseInterface * @return ResponseInterface
*/ */
public function __invoke( public function __invoke(ServerRequestInterface $request, ResponseInterface $response, $next);
ServerRequestInterface $request,
ResponseInterface $response,
$next
);
} }

View File

@ -4,78 +4,40 @@ namespace WellRESTed\Dispatching;
use Psr\Http\Message\ResponseInterface; use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\ServerRequestInterface; use Psr\Http\Message\ServerRequestInterface;
use Psr\Http\Server\MiddlewareInterface;
use Psr\Http\Server\RequestHandlerInterface;
/**
* Runs a handler or middleware with a request and return the response.
*/
class Dispatcher implements DispatcherInterface class Dispatcher implements DispatcherInterface
{ {
/** /**
* Run a handler or middleware with a request and return the response. * @param mixed $middleware
*
* Dispatcher can dispatch any of the following:
* - An instance implementing one of these interfaces:
* - Psr\Http\Server\RequestHandlerInterface
* - Psr\Http\Server\MiddlewareInterface
* - WellRESTed\MiddlewareInterface
* - Psr\Http\Message\ResponseInterface
* - A string containing the fully qualified class name of a class
* implementing one of the interfaces listed above.
* - A callable that returns an instance implementing one of the
* interfaces listed above.
* - A callable with a signature matching the signature of
* WellRESTed\MiddlewareInterface::__invoke
* - An array containing any of the items in this list.
*
* When Dispatcher receives a $dispatchable that is not of a type it
* can dispatch, it throws a DispatchException.
*
* @param mixed $dispatchable
* @param ServerRequestInterface $request * @param ServerRequestInterface $request
* @param ResponseInterface $response * @param ResponseInterface $response
* @param callable $next * @param callable $next
* @return ResponseInterface * @return ResponseInterface
* @throws DispatchException Unable to dispatch $middleware * @throws DispatchException Unable to dispatch $middleware
*/ */
public function dispatch( public function dispatch($middleware, ServerRequestInterface $request, ResponseInterface $response, $next)
$dispatchable, {
ServerRequestInterface $request, if (is_callable($middleware)) {
ResponseInterface $response, $middleware = $middleware($request, $response, $next);
$next } elseif (is_string($middleware)) {
) { $middleware = new $middleware();
if (is_callable($dispatchable)) { } elseif (is_array($middleware)) {
$dispatchable = $dispatchable($request, $response, $next); $middleware = $this->getDispatchStack($middleware);
} elseif (is_string($dispatchable)) {
$dispatchable = new $dispatchable();
} elseif (is_array($dispatchable)) {
$dispatchable = $this->getDispatchStack($dispatchable);
} }
if (is_callable($middleware)) {
if (is_callable($dispatchable)) { return $middleware($request, $response, $next);
return $dispatchable($request, $response, $next); } elseif ($middleware instanceof ResponseInterface) {
} elseif ($dispatchable instanceof RequestHandlerInterface) { return $middleware;
return $dispatchable->handle($request);
} elseif ($dispatchable instanceof MiddlewareInterface) {
$delegate = new DispatcherDelegate($response, $next);
return $dispatchable->process($request, $delegate);
} elseif ($dispatchable instanceof ResponseInterface) {
return $dispatchable;
} else { } else {
throw new DispatchException('Unable to dispatch handler.'); throw new DispatchException("Unable to dispatch middleware.");
} }
} }
/** protected function getDispatchStack($middlewares)
* @param mixed[] $dispatchables
* @return DispatchStack
*/
private function getDispatchStack($dispatchables)
{ {
$stack = new DispatchStack($this); $stack = new DispatchStack($this);
foreach ($dispatchables as $dispatchable) { foreach ($middlewares as $middleware) {
$stack->add($dispatchable); $stack->add($middleware);
} }
return $stack; return $stack;
} }

View File

@ -1,29 +0,0 @@
<?php
namespace WellRESTed\Dispatching;
use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\ServerRequestInterface;
use Psr\Http\Server\RequestHandlerInterface;
/**
* Adapter to allow use of PSR-15 Middleware with double pass implementations.
*/
class DispatcherDelegate implements RequestHandlerInterface
{
/** @var ResponseInterface */
private $response;
/** @var callable */
private $next;
public function __construct(ResponseInterface $response, callable $next)
{
$this->response = $response;
$this->next = $next;
}
public function handle(ServerRequestInterface $request): ResponseInterface
{
return call_user_func($this->next, $request, $this->response);
}
}

View File

@ -6,47 +6,38 @@ use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\ServerRequestInterface; use Psr\Http\Message\ServerRequestInterface;
/** /**
* Runs a handler or middleware with a request and return the response. * Dispatches middleware
*/ */
interface DispatcherInterface interface DispatcherInterface
{ {
/** /**
* Run a handler or middleware with a request and return the response. * Dispatch middleware and return the response.
* *
* Dispatchables (middleware and handlers) comes in a number of varieties * This method MUST pass $request, $response, and $next to the middleware
* (e.g., instance, string, callable). DispatcherInterface interface unpacks * to be dispatched.
* the dispatchable and dispatches it. *
* $middleware comes in a number of varieties (e.g., instance, string,
* callable). DispatcherInterface interface exist to unpack the middleware
* and dispatch it.
* *
* Implementations MUST be able to dispatch the following: * Implementations MUST be able to dispatch the following:
* - An instance implementing one of these interfaces: * - An instance implementing MiddlewareInterface
* - Psr\Http\Server\RequestHandlerInterface * - A string containing the fully qualified class name of a class
* - Psr\Http\Server\MiddlewareInterface * implementing MiddlewareInterface
* - WellRESTed\MiddlewareInterface * - A callable that returns an instance implementing MiddlewareInterface
* - Psr\Http\Message\ResponseInterface * - A callable with a signature matching MiddlewareInterface::__invoke
* - A string containing the fully qualified class name of a class
* implementing one of the interfaces listed above.
* - A callable that returns an instance implementing one of the
* interfaces listed above.
* - A callable with a signature matching the signature of
* WellRESTed\MiddlewareInterface::__invoke
* - An array containing any of the items in this list.
* *
* Implementation MAY dispatch other types of middleware. * Implementation MAY dispatch other types of middleware.
* *
* When an implementation receives a $dispatchable that is not of a type it * When an implementation receives a $middleware that is not of a type it can
* can dispatch, it MUST throw a DispatchException. * dispatch, it MUST throw a DispatchException.
* *
* @param mixed $dispatchable * @param mixed $middleware
* @param ServerRequestInterface $request * @param ServerRequestInterface $request
* @param ResponseInterface $response * @param ResponseInterface $response
* @param callable $next * @param callable $next
* @return ResponseInterface * @return ResponseInterface
* @throws DispatchException Unable to dispatch $middleware * @throws DispatchException Unable to dispatch $middleware
*/ */
public function dispatch( public function dispatch($middleware, ServerRequestInterface $request, ResponseInterface $response, $next);
$dispatchable,
ServerRequestInterface $request,
ResponseInterface $response,
$next
);
} }

View File

@ -8,50 +8,57 @@ use Iterator;
/** /**
* HeaderCollection provides case-insensitive access to lists of header values. * HeaderCollection provides case-insensitive access to lists of header values.
* *
* This class is an internal class used by Message and is not intended for
* direct use by consumers.
*
* HeaderCollection preserves the cases of keys as they are set, but treats key * HeaderCollection preserves the cases of keys as they are set, but treats key
* access case insensitively. * access case insensitively.
* *
* Any values added to HeaderCollection are added to list arrays. Subsequent * Any values added to HeaderCollection are added to list arrays. Subsequent
* calls to add a value for a given key will append the new value to the list * calls to add a value for a given key will append the new value to the list
* array of values for that key. * array of values for that key.
*
* @internal This class is an internal class used by Message and is not intended
* for direct use by consumers.
*/ */
class HeaderCollection implements ArrayAccess, Iterator class HeaderCollection implements ArrayAccess, Iterator
{ {
/** /**
* @var array
*
* Hash array mapping lowercase header names to original case header names. * Hash array mapping lowercase header names to original case header names.
*
* @var array<string, string>
*/ */
private $fields = []; private $fields;
/** /**
* @var array
*
* Hash array mapping lowercase header names to values as string[] * Hash array mapping lowercase header names to values as string[]
*
* @var array<string, string[]>
*/ */
private $values = []; private $values;
/** /**
* List array of lowercase header names.
*
* @var string[] * @var string[]
*
* List array of lowercase header names.
*/ */
private $keys = []; private $keys;
/** @var int */ /** @var int */
private $position = 0; private $position = 0;
// ------------------------------------------------------------------------- public function __construct()
{
$this->keys = [];
$this->fields = [];
$this->values = [];
}
// ------------------------------------------------------------------------
// ArrayAccess // ArrayAccess
/** /**
* @param string $offset * @param string $offset
* @return bool * @return bool
*/ */
public function offsetExists($offset): bool public function offsetExists($offset)
{ {
return isset($this->values[strtolower($offset)]); return isset($this->values[strtolower($offset)]);
} }
@ -60,7 +67,7 @@ class HeaderCollection implements ArrayAccess, Iterator
* @param mixed $offset * @param mixed $offset
* @return string[] * @return string[]
*/ */
public function offsetGet($offset): array public function offsetGet($offset)
{ {
return $this->values[strtolower($offset)]; return $this->values[strtolower($offset)];
} }
@ -69,7 +76,7 @@ class HeaderCollection implements ArrayAccess, Iterator
* @param string $offset * @param string $offset
* @param string $value * @param string $value
*/ */
public function offsetSet($offset, $value): void public function offsetSet($offset, $value)
{ {
$normalized = strtolower($offset); $normalized = strtolower($offset);
@ -92,7 +99,7 @@ class HeaderCollection implements ArrayAccess, Iterator
/** /**
* @param string $offset * @param string $offset
*/ */
public function offsetUnset($offset): void public function offsetUnset($offset)
{ {
$normalized = strtolower($offset); $normalized = strtolower($offset);
unset($this->fields[$normalized]); unset($this->fields[$normalized]);
@ -104,33 +111,30 @@ class HeaderCollection implements ArrayAccess, Iterator
} }
} }
// ------------------------------------------------------------------------- // ------------------------------------------------------------------------
// Iterator // Iterator
/** public function current()
* @return string[]
*/
public function current(): array
{ {
return $this->values[$this->keys[$this->position]]; return $this->values[$this->keys[$this->position]];
} }
public function next(): void public function next()
{ {
++$this->position; ++$this->position;
} }
public function key(): string public function key()
{ {
return $this->fields[$this->keys[$this->position]]; return $this->fields[$this->keys[$this->position]];
} }
public function valid(): bool public function valid()
{ {
return isset($this->keys[$this->position]); return isset($this->keys[$this->position]);
} }
public function rewind(): void public function rewind()
{ {
$this->position = 0; $this->position = 0;
} }

View File

@ -2,7 +2,6 @@
namespace WellRESTed\Message; namespace WellRESTed\Message;
use InvalidArgumentException;
use Psr\Http\Message\MessageInterface; use Psr\Http\Message\MessageInterface;
use Psr\Http\Message\StreamInterface; use Psr\Http\Message\StreamInterface;
@ -16,38 +15,39 @@ abstract class Message implements MessageInterface
/** @var StreamInterface */ /** @var StreamInterface */
protected $body; protected $body;
/** @var string */ /** @var string */
protected $protocolVersion = '1.1'; protected $protocolVersion = "1.1";
/** /**
* Create a new Message, optionally with headers and a body. * Create a new Message, optionally with headers and a body.
* *
* $headers is an optional associative array with header field names as * If provided, $headers MUST by an associative array with header field
* string keys and values as either string or string[]. * names as (string) keys and lists of header field values (string[])
* as values.
* *
* If no StreamInterface is provided for $body, the instance will create * If no StreamInterface is provided for $body, the instance will create
* a NullStream instance for the message body. * a NullStream instance for the message body.
* *
* @param array $headers Associative array with header field names as * @param array $headers Associative array of headers fields with header
* keys and values as string|string[] * field names as keys and list arrays of field values as values
* @param StreamInterface|null $body A stream representation of the message * @param StreamInterface $body A stream representation of the message
* entity body * entity body
*/ */
public function __construct( public function __construct(array $headers = null, StreamInterface $body = null)
array $headers = [], {
?StreamInterface $body = null
) {
$this->headers = new HeaderCollection(); $this->headers = new HeaderCollection();
if ($headers) {
foreach ($headers as $name => $values) { foreach ($headers as $name => $values) {
if (is_string($values)) { foreach ($values as $value) {
$values = [$values]; $this->headers[$name] = $value;
} }
foreach ($values as $value) {
$this->headers[$name] = $value;
} }
} }
$this->body = $body ?? new Stream(''); if ($body !== null) {
$this->body = $body;
} else {
$this->body = new NullStream();
}
} }
public function __clone() public function __clone()
@ -55,12 +55,14 @@ abstract class Message implements MessageInterface
$this->headers = clone $this->headers; $this->headers = clone $this->headers;
} }
// ------------------------------------------------------------------------- // ------------------------------------------------------------------------
// Psr\Http\Message\MessageInterface // Psr\Http\Message\MessageInterface
/** /**
* Retrieves the HTTP protocol version as a string. * Retrieves the HTTP protocol version as a string.
* *
* The string MUST contain only the HTTP version number (e.g., "1.1", "1.0").
*
* @return string HTTP protocol version. * @return string HTTP protocol version.
*/ */
public function getProtocolVersion() public function getProtocolVersion()
@ -71,8 +73,11 @@ abstract class Message implements MessageInterface
/** /**
* Create a new instance with the specified HTTP protocol version. * Create a new instance with the specified HTTP protocol version.
* *
* The version string MUST contain only the HTTP version number (e.g.,
* "1.1", "1.0").
*
* @param string $version HTTP protocol version * @param string $version HTTP protocol version
* @return static * @return self
*/ */
public function withProtocolVersion($version) public function withProtocolVersion($version)
{ {
@ -89,7 +94,7 @@ abstract class Message implements MessageInterface
* *
* // Represent the headers as a string * // Represent the headers as a string
* foreach ($message->getHeaders() as $name => $values) { * foreach ($message->getHeaders() as $name => $values) {
* echo $name . ': ' . implode(', ', $values); * echo $name . ": " . implode(", ", $values);
* } * }
* *
* // Emit headers iteratively: * // Emit headers iteratively:
@ -102,7 +107,7 @@ abstract class Message implements MessageInterface
* While header names are not case-sensitive, getHeaders() will preserve the * While header names are not case-sensitive, getHeaders() will preserve the
* exact case in which headers were originally specified. * exact case in which headers were originally specified.
* *
* @return string[][] Returns an associative array of the message's headers. * @return array Returns an associative array of the message's headers.
*/ */
public function getHeaders() public function getHeaders()
{ {
@ -172,9 +177,9 @@ abstract class Message implements MessageInterface
public function getHeaderLine($name) public function getHeaderLine($name)
{ {
if (isset($this->headers[$name])) { if (isset($this->headers[$name])) {
return join(', ', $this->headers[$name]); return join(", ", $this->headers[$name]);
} else { } else {
return ''; return "";
} }
} }
@ -187,8 +192,8 @@ abstract class Message implements MessageInterface
* *
* @param string $name Case-insensitive header field name. * @param string $name Case-insensitive header field name.
* @param string|string[] $value Header value(s). * @param string|string[] $value Header value(s).
* @return static * @return self
* @throws InvalidArgumentException for invalid header names or values. * @throws \InvalidArgumentException for invalid header names or values.
*/ */
public function withHeader($name, $value) public function withHeader($name, $value)
{ {
@ -211,8 +216,8 @@ abstract class Message implements MessageInterface
* *
* @param string $name Case-insensitive header field name to add. * @param string $name Case-insensitive header field name to add.
* @param string|string[] $value Header value(s). * @param string|string[] $value Header value(s).
* @return static * @return self
* @throws InvalidArgumentException for invalid header names or values. * @throws \InvalidArgumentException for invalid header names or values.
*/ */
public function withAddedHeader($name, $value) public function withAddedHeader($name, $value)
{ {
@ -229,7 +234,7 @@ abstract class Message implements MessageInterface
* Creates a new instance, without the specified header. * Creates a new instance, without the specified header.
* *
* @param string $name Case-insensitive header field name to remove. * @param string $name Case-insensitive header field name to remove.
* @return static * @return self
*/ */
public function withoutHeader($name) public function withoutHeader($name)
{ {
@ -254,8 +259,8 @@ abstract class Message implements MessageInterface
* The body MUST be a StreamInterface object. * The body MUST be a StreamInterface object.
* *
* @param StreamInterface $body Body. * @param StreamInterface $body Body.
* @return static * @return self
* @throws InvalidArgumentException When the body is not valid. * @throws \InvalidArgumentException When the body is not valid.
*/ */
public function withBody(StreamInterface $body) public function withBody(StreamInterface $body)
{ {
@ -264,34 +269,24 @@ abstract class Message implements MessageInterface
return $message; return $message;
} }
// ------------------------------------------------------------------------- // ------------------------------------------------------------------------
/** private function getValidatedHeaders($name, $value)
* @param mixed $name
* @param mixed|mixed[] $values
* @return string[]
* @throws InvalidArgumentException Name is not a string or value is not
* a string or array of strings
*/
private function getValidatedHeaders($name, $values)
{ {
if (!is_string($name)) { $is_allowed = function ($item) {
throw new InvalidArgumentException('Header name must be a string'); return is_string($item) || is_numeric($item);
}
if (!is_array($values)) {
$values = [$values];
}
$isNotStringOrNumber = function ($item): bool {
return !(is_string($item) || is_numeric($item));
}; };
$invalid = array_filter($values, $isNotStringOrNumber); if (!is_string($name)) {
if ($invalid) { throw new \InvalidArgumentException("Header name must be a string");
throw new InvalidArgumentException('Header values must be a string or string[]');
} }
return array_map('strval', $values); if ($is_allowed($value)) {
return [$value];
} elseif (is_array($value) && count($value) === count(array_filter($value, $is_allowed))) {
return $value;
} else {
throw new \InvalidArgumentException("Header values must be a string or string[]");
}
} }
} }

View File

@ -3,7 +3,6 @@
namespace WellRESTed\Message; namespace WellRESTed\Message;
use Psr\Http\Message\StreamInterface; use Psr\Http\Message\StreamInterface;
use RuntimeException;
/** /**
* NullStream is a minimal, always-empty, non-writable stream. * NullStream is a minimal, always-empty, non-writable stream.
@ -19,7 +18,7 @@ class NullStream implements StreamInterface
*/ */
public function __toString() public function __toString()
{ {
return ''; return "";
} }
/** /**
@ -38,7 +37,6 @@ class NullStream implements StreamInterface
*/ */
public function detach() public function detach()
{ {
return null;
} }
/** /**
@ -52,10 +50,9 @@ class NullStream implements StreamInterface
} }
/** /**
* Returns the current position of the file read/write pointer * Returns 0
* *
* @return int Position of the file pointer * @return int|bool Position of the file pointer or false on error.
* @throws RuntimeException on error.
*/ */
public function tell() public function tell()
{ {
@ -92,12 +89,11 @@ class NullStream implements StreamInterface
* PHP $whence values for `fseek()`. SEEK_SET: Set position equal to * PHP $whence values for `fseek()`. SEEK_SET: Set position equal to
* offset bytes SEEK_CUR: Set position to current location plus offset * offset bytes SEEK_CUR: Set position to current location plus offset
* SEEK_END: Set position to end-of-stream plus offset. * SEEK_END: Set position to end-of-stream plus offset.
* @return void * @throws \RuntimeException on failure.
* @throws RuntimeException on failure.
*/ */
public function seek($offset, $whence = SEEK_SET) public function seek($offset, $whence = SEEK_SET)
{ {
throw new RuntimeException('Unable to seek to position.'); throw new \RuntimeException("Unable to seek to position.");
} }
/** /**
@ -105,12 +101,11 @@ class NullStream implements StreamInterface
* *
* @see seek() * @see seek()
* @link http://www.php.net/manual/en/function.fseek.php * @link http://www.php.net/manual/en/function.fseek.php
* @return void * @throws \RuntimeException on failure.
* @throws RuntimeException on failure.
*/ */
public function rewind() public function rewind()
{ {
throw new RuntimeException('Unable to rewind stream.'); throw new \RuntimeException("Unable to rewind stream.");
} }
/** /**
@ -128,11 +123,11 @@ class NullStream implements StreamInterface
* *
* @param string $string The string that is to be written. * @param string $string The string that is to be written.
* @return int Returns the number of bytes written to the stream. * @return int Returns the number of bytes written to the stream.
* @throws RuntimeException on failure. * @throws \RuntimeException on failure.
*/ */
public function write($string) public function write($string)
{ {
throw new RuntimeException('Unable to write to stream.'); throw new \RuntimeException("Unable to write to stream.");
} }
/** /**
@ -153,23 +148,23 @@ class NullStream implements StreamInterface
* call returns fewer bytes. * call returns fewer bytes.
* @return string Returns the data read from the stream, or an empty string * @return string Returns the data read from the stream, or an empty string
* if no bytes are available. * if no bytes are available.
* @throws RuntimeException if an error occurs. * @throws \RuntimeException if an error occurs.
*/ */
public function read($length) public function read($length)
{ {
return ''; return "";
} }
/** /**
* Returns the remaining contents in a string * Returns the remaining contents in a string
* *
* @return string * @return string
* @throws RuntimeException if unable to read or an error occurs while * @throws \RuntimeException if unable to read or an error occurs while
* reading. * reading.
*/ */
public function getContents() public function getContents()
{ {
return ''; return "";
} }
/** /**

View File

@ -2,7 +2,6 @@
namespace WellRESTed\Message; namespace WellRESTed\Message;
use InvalidArgumentException;
use Psr\Http\Message\RequestInterface; use Psr\Http\Message\RequestInterface;
use Psr\Http\Message\StreamInterface; use Psr\Http\Message\StreamInterface;
use Psr\Http\Message\UriInterface; use Psr\Http\Message\UriInterface;
@ -23,42 +22,37 @@ class Request extends Message implements RequestInterface
{ {
/** @var string */ /** @var string */
protected $method; protected $method;
/** @var string|null */ /** @var string */
protected $requestTarget; protected $requestTarget;
/** @var UriInterface */ /** @var UriInterface */
protected $uri; protected $uri;
// ------------------------------------------------------------------------- // ------------------------------------------------------------------------
/** /**
* Create a new Request. * Create a new Request.
* *
* $headers is an optional associative array with header field names as * @see WellRESTed\Message\Message
* string keys and values as either string or string[]. * @param UriInterface $uri
*
* If no StreamInterface is provided for $body, the instance will create
* a NullStream instance for the message body.
*
* @param string $method * @param string $method
* @param string|UriInterface $uri * @param array $headers
* @param array $headers Associative array with header field names as * @param StreamInterface $body
* keys and values as string|string[]
* @param StreamInterface|null $body A stream representation of the message
* entity body
*/ */
public function __construct( public function __construct(
string $method = 'GET', UriInterface $uri = null,
$uri = '', $method = "GET",
array $headers = [], array $headers = null,
?StreamInterface $body = null StreamInterface $body = null
) { ) {
parent::__construct($headers, $body); parent::__construct($headers, $body);
$this->method = $method;
if (!($uri instanceof UriInterface)) { if ($uri !== null) {
$uri = new Uri($uri); $this->uri = $uri;
} else {
$this->uri = new Uri();
} }
$this->uri = $uri;
$this->requestTarget = null; $this->method = $method;
} }
public function __clone() public function __clone()
@ -67,7 +61,7 @@ class Request extends Message implements RequestInterface
parent::__clone(); parent::__clone();
} }
// ------------------------------------------------------------------------- // ------------------------------------------------------------------------
// Psr\Http\Message\RequestInterface // Psr\Http\Message\RequestInterface
/** /**
@ -89,7 +83,7 @@ class Request extends Message implements RequestInterface
public function getRequestTarget() public function getRequestTarget()
{ {
// Use the explicitly set request target first. // Use the explicitly set request target first.
if ($this->requestTarget !== null) { if (isset($this->requestTarget)) {
return $this->requestTarget; return $this->requestTarget;
} }
@ -97,11 +91,11 @@ class Request extends Message implements RequestInterface
$target = $this->uri->getPath(); $target = $this->uri->getPath();
$query = $this->uri->getQuery(); $query = $this->uri->getQuery();
if ($query) { if ($query) {
$target .= '?' . $query; $target .= "?" . $query;
} }
// Return "/" if the origin form is empty. // Return "/" if the origin form is empty.
return $target ?: '/'; return $target ?: "/";
} }
/** /**
@ -115,7 +109,7 @@ class Request extends Message implements RequestInterface
* @link http://tools.ietf.org/html/rfc7230#section-2.7 (for the various * @link http://tools.ietf.org/html/rfc7230#section-2.7 (for the various
* request-target forms allowed in request messages) * request-target forms allowed in request messages)
* @param mixed $requestTarget * @param mixed $requestTarget
* @return static * @return self
*/ */
public function withRequestTarget($requestTarget) public function withRequestTarget($requestTarget)
{ {
@ -142,8 +136,8 @@ class Request extends Message implements RequestInterface
* modify the given string. * modify the given string.
* *
* @param string $method Case-insensitive method. * @param string $method Case-insensitive method.
* @return static * @return self
* @throws InvalidArgumentException for invalid HTTP methods. * @throws \InvalidArgumentException for invalid HTTP methods.
*/ */
public function withMethod($method) public function withMethod($method)
{ {
@ -188,25 +182,25 @@ class Request extends Message implements RequestInterface
* @link http://tools.ietf.org/html/rfc3986#section-4.3 * @link http://tools.ietf.org/html/rfc3986#section-4.3
* @param UriInterface $uri New request URI to use. * @param UriInterface $uri New request URI to use.
* @param bool $preserveHost Preserve the original state of the Host header. * @param bool $preserveHost Preserve the original state of the Host header.
* @return static * @return self
*/ */
public function withUri(UriInterface $uri, $preserveHost = false) public function withUri(UriInterface $uri, $preserveHost = false)
{ {
$request = clone $this; $request = clone $this;
$newHost = $uri->getHost(); $newHost = $uri->getHost();
$oldHost = $request->headers['Host'] ?? ''; $oldHost = isset($request->headers["Host"]) ? $request->headers["Host"] : "";
if ($preserveHost === false) { if ($preserveHost === false) {
// Update Host // Update Host
if ($newHost && $newHost !== $oldHost) { if ($newHost && $newHost !== $oldHost) {
unset($request->headers['Host']); unset($request->headers["Host"]);
$request->headers['Host'] = $newHost; $request->headers["Host"] = $newHost;
} }
} else { } else {
// Preserve Host // Preserve Host
if (!$oldHost && $newHost) { if (!$oldHost && $newHost) {
$request->headers['Host'] = $newHost; $request->headers["Host"] = $newHost;
} }
} }
@ -214,21 +208,21 @@ class Request extends Message implements RequestInterface
return $request; return $request;
} }
// ------------------------------------------------------------------------- // ------------------------------------------------------------------------
/** /**
* @param mixed $method * @param string $method
* @return string * @return string
* @throws InvalidArgumentException * @throws \InvalidArgumentException
*/ */
private function getValidatedMethod($method) private function getValidatedMethod($method)
{ {
if (!is_string($method)) { if (!is_string($method)) {
throw new InvalidArgumentException('Method must be a string.'); throw new \InvalidArgumentException("Method must be a string.");
} }
$method = trim($method); $method = trim($method);
if (strpos($method, ' ') !== false) { if (strpos($method, " ") !== false) {
throw new InvalidArgumentException('Method cannot contain spaces.'); throw new \InvalidArgumentException("Method cannot contain spaces.");
} }
return $method; return $method;
} }

View File

@ -1,25 +0,0 @@
<?php
namespace WellRESTed\Message;
use Psr\Http\Message\RequestFactoryInterface;
use Psr\Http\Message\RequestInterface;
use Psr\Http\Message\UriInterface;
class RequestFactory implements RequestFactoryInterface
{
/**
* Create a new request.
*
* @param string $method The HTTP method associated with the request.
* @param UriInterface|string $uri The URI associated with the request. If
* the value is a string, the factory MUST create a UriInterface
* instance based on it.
*
* @return RequestInterface
*/
public function createRequest(string $method, $uri): RequestInterface
{
return new Request($method, $uri);
}
}

View File

@ -2,7 +2,6 @@
namespace WellRESTed\Message; namespace WellRESTed\Message;
use InvalidArgumentException;
use Psr\Http\Message\ResponseInterface; use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\StreamInterface; use Psr\Http\Message\StreamInterface;
@ -21,7 +20,7 @@ class Response extends Message implements ResponseInterface
{ {
/** @var string Text explanation of the HTTP Status Code. */ /** @var string Text explanation of the HTTP Status Code. */
private $reasonPhrase; private $reasonPhrase;
/** @var int HTTP status code */ /** @var int HTTP status code */
private $statusCode; private $statusCode;
/** /**
@ -34,23 +33,19 @@ class Response extends Message implements ResponseInterface
* If no StreamInterface is provided for $body, the instance will create * If no StreamInterface is provided for $body, the instance will create
* a NullStream instance for the message body. * a NullStream instance for the message body.
* *
* @see \WellRESTed\Message\Message * @see WellRESTed\Message\Message
*
* @param int $statusCode * @param int $statusCode
* @param array $headers * @param array $headers
* @param StreamInterface|null $body * @param StreamInterface $body
*/ */
public function __construct( public function __construct($statusCode = 500, array $headers = null, StreamInterface $body = null)
int $statusCode = 500, {
array $headers = [],
?StreamInterface $body = null
) {
parent::__construct($headers, $body); parent::__construct($headers, $body);
$this->statusCode = $statusCode; $this->statusCode = $statusCode;
$this->reasonPhrase = $this->getDefaultReasonPhraseForStatusCode($statusCode); $this->reasonPhrase = $this->getDefaultReasonPhraseForStatusCode($statusCode);
} }
// ------------------------------------------------------------------------- // ------------------------------------------------------------------------
// Psr\Http\Message\ResponseInterface // Psr\Http\Message\ResponseInterface
/** /**
@ -59,7 +54,7 @@ class Response extends Message implements ResponseInterface
* The status code is a 3-digit integer result code of the server's attempt * The status code is a 3-digit integer result code of the server's attempt
* to understand and satisfy the request. * to understand and satisfy the request.
* *
* @return int Status code. * @return integer Status code.
*/ */
public function getStatusCode() public function getStatusCode()
{ {
@ -74,14 +69,14 @@ class Response extends Message implements ResponseInterface
* reason phrase, if possible. * reason phrase, if possible.
* *
* @link http://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml * @link http://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml
* @param int $code The 3-digit integer result code to set. * @param integer $code The 3-digit integer result code to set.
* @param string $reasonPhrase The reason phrase to use with the * @param string $reasonPhrase The reason phrase to use with the
* provided status code; if none is provided, implementations MAY * provided status code; if none is provided, implementations MAY
* use the defaults as suggested in the HTTP specification. * use the defaults as suggested in the HTTP specification.
* @return static * @return self
* @throws InvalidArgumentException For invalid status code arguments. * @throws \InvalidArgumentException For invalid status code arguments.
*/ */
public function withStatus($code, $reasonPhrase = '') public function withStatus($code, $reasonPhrase = "")
{ {
$response = clone $this; $response = clone $this;
$response->statusCode = $code; $response->statusCode = $code;
@ -108,70 +103,73 @@ class Response extends Message implements ResponseInterface
/** /**
* @param int $statusCode * @param int $statusCode
* @return string * @return string|null
*/ */
private function getDefaultReasonPhraseForStatusCode($statusCode) private function getDefaultReasonPhraseForStatusCode($statusCode)
{ {
$reasonPhraseLookup = [ $reasonPhraseLookup = [
100 => 'Continue', 100 => "Continue",
101 => 'Switching Protocols', 101 => "Switching Protocols",
102 => 'Processing', 102 => "Processing",
200 => 'OK', 200 => "OK",
201 => 'Created', 201 => "Created",
202 => 'Accepted', 202 => "Accepted",
203 => 'Non-Authoritative Information', 203 => "Non-Authoritative Information",
204 => 'No Content', 204 => "No Content",
205 => 'Reset Content', 205 => "Reset Content",
206 => 'Partial Content', 206 => "Partial Content",
207 => 'Multi-Status', 207 => "Multi-Status",
208 => 'Already Reported', 208 => "Already Reported",
226 => 'IM Used', 226 => "IM Used",
300 => 'Multiple Choices', 300 => "Multiple Choices",
301 => 'Moved Permanently', 301 => "Moved Permanently",
302 => 'Found', 302 => "Found",
303 => 'See Other', 303 => "See Other",
304 => 'Not Modified', 304 => "Not Modified",
305 => 'Use Proxy', 305 => "Use Proxy",
307 => 'Temporary Redirect', 307 => "Temporary Redirect",
308 => 'Permanent Redirect', 308 => "Permanent Redirect",
400 => 'Bad Request', 400 => "Bad Request",
401 => 'Unauthorized', 401 => "Unauthorized",
402 => 'Payment Required', 402 => "Payment Required",
403 => 'Forbidden', 403 => "Forbidden",
404 => 'Not Found', 404 => "Not Found",
405 => 'Method Not Allowed', 405 => "Method Not Allowed",
406 => 'Not Acceptable', 406 => "Not Acceptable",
407 => 'Proxy Authentication Required', 407 => "Proxy Authentication Required",
408 => 'Request Timeout', 408 => "Request Timeout",
409 => 'Conflict', 409 => "Conflict",
410 => 'Gone', 410 => "Gone",
411 => 'Length Required', 411 => "Length Required",
412 => 'Precondition Failed', 412 => "Precondition Failed",
413 => 'Payload Too Large', 413 => "Payload Too Large",
414 => 'URI Too Long', 414 => "URI Too Long",
415 => 'Unsupported Media Type', 415 => "Unsupported Media Type",
416 => 'Range Not Satisfiable', 416 => "Range Not Satisfiable",
417 => 'Expectation Failed', 417 => "Expectation Failed",
421 => 'Misdirected Request', 421 => "Misdirected Request",
422 => 'Unprocessable Entity', 422 => "Unprocessable Entity",
423 => 'Locked', 423 => "Locked",
424 => 'Failed Dependency', 424 => "Failed Dependency",
426 => 'Upgrade Required', 426 => "Upgrade Required",
428 => 'Precondition Required', 428 => "Precondition Required",
429 => 'Too Many Requests', 429 => "Too Many Requests",
431 => 'Request Header Fields Too Large', 431 => "Request Header Fields Too Large",
500 => 'Internal Server Error', 500 => "Internal Server Error",
501 => 'Not Implemented', 501 => "Not Implemented",
502 => 'Bad Gateway', 502 => "Bad Gateway",
503 => 'Service Unavailable', 503 => "Service Unavailable",
504 => 'Gateway Timeout', 504 => "Gateway Timeout",
505 => 'HTTP Version Not Supported', 505 => "HTTP Version Not Supported",
506 => 'Variant Also Negotiates', 506 => "Variant Also Negotiates",
507 => 'Insufficient Storage', 507 => "Insufficient Storage",
508 => 'Loop Detected', 508 => "Loop Detected",
510 => 'Not Extended', 510 => "Not Extended",
511 => 'Network Authentication Required' 511 => "Network Authentication Required"
]; ];
return $reasonPhraseLookup[$statusCode] ?? ''; if (isset($reasonPhraseLookup[$statusCode])) {
return $reasonPhraseLookup[$statusCode];
}
return null;
} }
} }

View File

@ -1,27 +0,0 @@
<?php
namespace WellRESTed\Message;
use Psr\Http\Message\ResponseFactoryInterface;
use Psr\Http\Message\ResponseInterface;
class ResponseFactory implements ResponseFactoryInterface
{
/**
* Create a new response.
*
* @param int $code HTTP status code; defaults to 200
* @param string $reasonPhrase Reason phrase to associate with status code
* in generated response; if none is provided implementations MAY use
* the defaults as suggested in the HTTP specification.
*
* @return ResponseInterface
*/
public function createResponse(
int $code = 200,
string $reasonPhrase = ''
): ResponseInterface {
return (new Response())
->withStatus($code, $reasonPhrase);
}
}

View File

@ -2,11 +2,9 @@
namespace WellRESTed\Message; namespace WellRESTed\Message;
use InvalidArgumentException;
use Psr\Http\Message\ServerRequestInterface; use Psr\Http\Message\ServerRequestInterface;
use Psr\Http\Message\StreamInterface; use Psr\Http\Message\StreamInterface;
use Psr\Http\Message\UploadedFileInterface; use Psr\Http\Message\UploadedFileInterface;
use Psr\Http\Message\UriInterface;
/** /**
* Representation of an incoming, server-side HTTP request. * Representation of an incoming, server-side HTTP request.
@ -51,37 +49,24 @@ class ServerRequest extends Request implements ServerRequestInterface
/** @var array */ /** @var array */
private $uploadedFiles; private $uploadedFiles;
// ------------------------------------------------------------------------- // ------------------------------------------------------------------------
/** /**
* Create a new ServerRequest. * Creates a new, empty representation of a server-side HTTP request.
* *
* $headers is an optional associative array with header field names as * To obtain a ServerRequest representing the request sent to the server
* string keys and values as either string or string[]. * instantiating the request, use the factory method
* ServerRequest::getServerRequest
* *
* If no StreamInterface is provided for $body, the instance will create * @see ServerRequest::getServerRequest
* a NullStream instance for the message body.
*
* @param string $method
* @param string|UriInterface $uri
* @param array $headers Associative array with header field names as
* keys and values as string|string[]
* @param StreamInterface|null $body A stream representation of the message
* entity body
* @param array $serverParams An array of Server API (SAPI) parameters
*/ */
public function __construct( public function __construct()
string $method = 'GET', {
$uri = '', parent::__construct();
array $headers = [], $this->attributes = [];
?StreamInterface $body = null,
array $serverParams = []
) {
parent::__construct($method, $uri, $headers, $body);
$this->serverParams = $serverParams;
$this->cookieParams = []; $this->cookieParams = [];
$this->queryParams = []; $this->queryParams = [];
$this->attributes = []; $this->serverParams = [];
$this->uploadedFiles = []; $this->uploadedFiles = [];
} }
@ -93,7 +78,7 @@ class ServerRequest extends Request implements ServerRequestInterface
parent::__clone(); parent::__clone();
} }
// ------------------------------------------------------------------------- // ------------------------------------------------------------------------
// Psr\Http\Message\ServerRequestInterface // Psr\Http\Message\ServerRequestInterface
/** /**
@ -130,7 +115,7 @@ class ServerRequest extends Request implements ServerRequestInterface
* be injected at instantiation. * be injected at instantiation.
* *
* @param array $cookies Array of key/value pairs representing cookies. * @param array $cookies Array of key/value pairs representing cookies.
* @return static * @return self
*/ */
public function withCookieParams(array $cookies) public function withCookieParams(array $cookies)
{ {
@ -172,7 +157,7 @@ class ServerRequest extends Request implements ServerRequestInterface
* *
* @param array $query Array of query string arguments, typically from * @param array $query Array of query string arguments, typically from
* $_GET. * $_GET.
* @return static * @return self
*/ */
public function withQueryParams(array $query) public function withQueryParams(array $query)
{ {
@ -202,15 +187,14 @@ class ServerRequest extends Request implements ServerRequestInterface
* Create a new instance with the specified uploaded files. * Create a new instance with the specified uploaded files.
* *
* @param array $uploadedFiles An array tree of UploadedFileInterface instances. * @param array $uploadedFiles An array tree of UploadedFileInterface instances.
* @return static * @return self
* @throws InvalidArgumentException if an invalid structure is provided. * @throws \InvalidArgumentException if an invalid structure is provided.
*/ */
public function withUploadedFiles(array $uploadedFiles) public function withUploadedFiles(array $uploadedFiles)
{ {
if (!$this->isValidUploadedFilesTree($uploadedFiles)) { if (!$this->isValidUploadedFilesTree($uploadedFiles)) {
throw new InvalidArgumentException( throw new \InvalidArgumentException(
'withUploadedFiles expects an array tree with UploadedFileInterface leaves.' "withUploadedFiles expects an array tree with UploadedFileInterface leaves.");
);
} }
$request = clone $this; $request = clone $this;
@ -258,12 +242,12 @@ class ServerRequest extends Request implements ServerRequestInterface
* *
* @param null|array|object $data The deserialized body data. This will * @param null|array|object $data The deserialized body data. This will
* typically be in an array or object. * typically be in an array or object.
* @return static * @return self
*/ */
public function withParsedBody($data) public function withParsedBody($data)
{ {
if (!(is_null($data) || is_array($data) || is_object($data))) { if (!(is_null($data) || is_array($data) || is_object($data))) {
throw new InvalidArgumentException('Parsed body must be null, array, or object.'); throw new \InvalidArgumentException("Parsed body must be null, array, or object.");
} }
$request = clone $this; $request = clone $this;
@ -319,7 +303,7 @@ class ServerRequest extends Request implements ServerRequestInterface
* @see getAttributes() * @see getAttributes()
* @param string $name The attribute name. * @param string $name The attribute name.
* @param mixed $value The value of the attribute. * @param mixed $value The value of the attribute.
* @return static * @return self
*/ */
public function withAttribute($name, $value) public function withAttribute($name, $value)
{ {
@ -341,7 +325,7 @@ class ServerRequest extends Request implements ServerRequestInterface
* *
* @see getAttributes() * @see getAttributes()
* @param string $name The attribute name. * @param string $name The attribute name.
* @return static * @return self
*/ */
public function withoutAttribute($name) public function withoutAttribute($name)
{ {
@ -350,7 +334,156 @@ class ServerRequest extends Request implements ServerRequestInterface
return $request; return $request;
} }
// ------------------------------------------------------------------------- // ------------------------------------------------------------------------
protected function readFromServerRequest(array $attributes = null)
{
$this->attributes = $attributes ?: [];
$this->serverParams = $_SERVER;
$this->cookieParams = $_COOKIE;
$this->readUploadedFiles($_FILES);
$this->queryParams = [];
$this->uri = $this->readUri();
if (isset($_SERVER["QUERY_STRING"])) {
parse_str($_SERVER["QUERY_STRING"], $this->queryParams);
}
if (isset($_SERVER["SERVER_PROTOCOL"]) && $_SERVER["SERVER_PROTOCOL"] === "HTTP/1.0") {
// The default is 1.1, so only update if 1.0
$this->protocolVersion = "1.0";
}
if (isset($_SERVER["REQUEST_METHOD"])) {
$this->method = $_SERVER["REQUEST_METHOD"];
}
$headers = $this->getServerRequestHeaders();
foreach ($headers as $key => $value) {
$this->headers[$key] = $value;
}
$this->body = $this->getStreamForBody();
$contentType = $this->getHeaderLine("Content-type");
if (strpos($contentType, "application/x-www-form-urlencoded") !== false
|| strpos($contentType, "multipart/form-data") !== false) {
$this->parsedBody = $_POST;
}
}
protected function readUploadedFiles($input)
{
$uploadedFiles = [];
foreach ($input as $name => $value) {
$this->addUploadedFilesToBranch($uploadedFiles, $name, $value);
}
$this->uploadedFiles = $uploadedFiles;
}
protected function addUploadedFilesToBranch(&$branch, $name, $value)
{
// Check for each of the expected keys.
if (isset($value["name"], $value["type"], $value["tmp_name"], $value["error"], $value["size"])) {
// This is a file. It may be a single file, or a list of files.
// Check if these items are arrays.
if (is_array($value["name"])
&& is_array($value["type"])
&& is_array($value["tmp_name"])
&& is_array($value["error"])
&& is_array($value["size"])
) {
// Each item is an array. This is a list of uploaded files.
$files = [];
$keys = array_keys($value["name"]);
foreach ($keys as $key) {
$files[$key] = new UploadedFile(
$value["name"][$key],
$value["type"][$key],
$value["size"][$key],
$value["tmp_name"][$key],
$value["error"][$key]
);
}
$branch[$name] = $files;
} else {
// All expected keys are present and are not arrays. This is an uploaded file.
$uploadedFile = new UploadedFile(
$value["name"], $value["type"], $value["size"], $value["tmp_name"], $value["error"]
);
$branch[$name] = $uploadedFile;
}
} else {
// Add another branch
$nextBranch = [];
foreach ($value as $nextName => $nextValue) {
$this->addUploadedFilesToBranch($nextBranch, $nextName, $nextValue);
}
$branch[$name] = $nextBranch;
}
}
protected function readUri()
{
$uri = "";
$scheme = "http";
if (isset($_SERVER["HTTPS"]) && $_SERVER["HTTPS"] && $_SERVER["HTTPS"] !== "off") {
$scheme = "https";
}
if (isset($_SERVER["HTTP_HOST"])) {
$authority = $_SERVER["HTTP_HOST"];
$uri .= "$scheme://$authority";
}
// Path and query string
if (isset($_SERVER["REQUEST_URI"])) {
$uri .= $_SERVER["REQUEST_URI"];
}
return new Uri($uri);
}
/**
* Return a reference to the singleton instance of the Request derived
* from the server's information about the request sent to the server.
*
* @param array $attributes Key-value pairs to add to the request.
* @return self
* @static
*/
public static function getServerRequest(array $attributes = null)
{
$request = new static();
$request->readFromServerRequest($attributes);
return $request;
}
/**
* Return a stream representing the request's body.
*
* Override this method to use a specific StreamInterface implementation.
*
* @return StreamInterface
*/
protected function getStreamForBody()
{
return new Stream(fopen("php://input", "r"));
}
/**
* Read and return all request headers from the request issued to the server.
*
* @return array Associative array of headers
*/
protected function getServerRequestHeaders()
{
// http://www.php.net/manual/en/function.getallheaders.php#84262
$headers = array();
foreach ($_SERVER as $name => $value) {
if (substr($name, 0, 5) === "HTTP_") {
$headers[str_replace(" ", "-", ucwords(strtolower(str_replace("_", " ", substr($name, 5)))))] = $value;
}
}
return $headers;
}
/** /**
* @param array $root * @param array $root
@ -365,7 +498,7 @@ class ServerRequest extends Request implements ServerRequestInterface
// If not empty, the array MUST have all string keys. // If not empty, the array MUST have all string keys.
$keys = array_keys($root); $keys = array_keys($root);
if (count($keys) !== count(array_filter($keys, 'is_string'))) { if (count($keys) !== count(array_filter($keys, "is_string"))) {
return false; return false;
} }
@ -378,11 +511,7 @@ class ServerRequest extends Request implements ServerRequestInterface
return true; return true;
} }
/** private function isValidUploadedFilesBranch($branch)
* @param UploadedFileInterface|array $branch
* @return bool
*/
private function isValidUploadedFilesBranch($branch): bool
{ {
if (is_array($branch)) { if (is_array($branch)) {
// Branch. // Branch.

View File

@ -1,191 +0,0 @@
<?php
namespace WellRESTed\Message;
use Psr\Http\Message\ServerRequestInterface;
use Psr\Http\Message\StreamInterface;
use Psr\Http\Message\UriInterface;
class ServerRequestMarshaller
{
/**
* Read the request as sent from the client and construct a ServerRequest
* representation.
*
* @return ServerRequestInterface
* @internal
*/
public function getServerRequest(): ServerRequestInterface
{
$method = self::parseMethod($_SERVER);
$uri = self::readUri($_SERVER);
$headers = self::parseHeaders($_SERVER);
$body = self::readBody();
$request = (new ServerRequest($method, $uri, $headers, $body, $_SERVER))
->withProtocolVersion(self::parseProtocolVersion($_SERVER))
->withUploadedFiles(self::readUploadedFiles($_FILES))
->withCookieParams($_COOKIE)
->withQueryParams(self::parseQuery($_SERVER));
if (self::isForm($request)) {
$request = $request->withParsedBody($_POST);
}
return $request;
}
private static function parseQuery(array $serverParams): array
{
$queryParams = [];
if (isset($serverParams['QUERY_STRING'])) {
parse_str($serverParams['QUERY_STRING'], $queryParams);
}
return $queryParams;
}
private static function parseProtocolVersion(array $serverParams): string
{
if (isset($serverParams['SERVER_PROTOCOL'])
&& $serverParams['SERVER_PROTOCOL'] === 'HTTP/1.0') {
return '1.0';
}
return '1.1';
}
private static function parseHeaders(array $serverParams): array
{
// http://www.php.net/manual/en/function.getallheaders.php#84262
$headers = [];
foreach ($serverParams as $name => $value) {
if (substr($name, 0, 5) === 'HTTP_') {
$name = self::normalizeHeaderName(substr($name, 5));
$headers[$name] = trim($value);
} elseif (self::isContentHeader($name) && !empty(trim($value))) {
$name = self::normalizeHeaderName($name);
$headers[$name] = trim($value);
}
}
return $headers;
}
private static function normalizeHeaderName(string $name): string
{
$name = ucwords(strtolower(str_replace('_', ' ', $name)));
return str_replace(' ', '-', $name);
}
private static function isContentHeader(string $name): bool
{
return $name === 'CONTENT_LENGTH' || $name === 'CONTENT_TYPE';
}
private static function parseMethod(array $serverParams): string
{
return $serverParams['REQUEST_METHOD'] ?? 'GET';
}
private static function readBody(): StreamInterface
{
$input = fopen('php://input', 'rb');
$temp = fopen('php://temp', 'wb+');
stream_copy_to_stream($input, $temp);
rewind($temp);
return new Stream($temp);
}
private static function readUri(array $serverParams): UriInterface
{
$uri = '';
$scheme = 'http';
if (isset($serverParams['HTTPS']) && $serverParams['HTTPS'] && $serverParams['HTTPS'] !== 'off') {
$scheme = 'https';
}
if (isset($serverParams['HTTP_HOST'])) {
$authority = $serverParams['HTTP_HOST'];
$uri .= "$scheme://$authority";
}
// Path and query string
if (isset($serverParams['REQUEST_URI'])) {
$uri .= $serverParams['REQUEST_URI'];
}
return new Uri($uri);
}
private static function isForm(ServerRequestInterface $request): bool
{
$contentType = $request->getHeaderLine('Content-type');
return (strpos($contentType, 'application/x-www-form-urlencoded') !== false)
|| (strpos($contentType, 'multipart/form-data') !== false);
}
private static function readUploadedFiles(array $input): array
{
$uploadedFiles = [];
foreach ($input as $name => $value) {
self::addUploadedFilesToBranch($uploadedFiles, $name, $value);
}
return $uploadedFiles;
}
private static function addUploadedFilesToBranch(
array &$branch,
string $name,
array $value
): void {
if (self::isUploadedFile($value)) {
if (self::isUploadedFileList($value)) {
$files = [];
$keys = array_keys($value['name']);
foreach ($keys as $key) {
$files[$key] = new UploadedFile(
$value['name'][$key],
$value['type'][$key],
$value['size'][$key],
$value['tmp_name'][$key],
$value['error'][$key]
);
}
$branch[$name] = $files;
} else {
// Single uploaded file
$uploadedFile = new UploadedFile(
$value['name'],
$value['type'],
$value['size'],
$value['tmp_name'],
$value['error']
);
$branch[$name] = $uploadedFile;
}
} else {
// Add another branch
$nextBranch = [];
foreach ($value as $nextName => $nextValue) {
self::addUploadedFilesToBranch($nextBranch, $nextName, $nextValue);
}
$branch[$name] = $nextBranch;
}
}
private static function isUploadedFile(array $value): bool
{
// Check for each of the expected keys. If all are present, this is a
// a file. It may be a single file, or a list of files.
return isset($value['name'], $value['type'], $value['tmp_name'], $value['error'], $value['size']);
}
private static function isUploadedFileList(array $value): bool
{
// When each item is an array, this is a list of uploaded files.
return is_array($value['name'])
&& is_array($value['type'])
&& is_array($value['tmp_name'])
&& is_array($value['error'])
&& is_array($value['size']);
}
}

View File

@ -2,21 +2,15 @@
namespace WellRESTed\Message; namespace WellRESTed\Message;
use Exception;
use InvalidArgumentException;
use Psr\Http\Message\StreamInterface; use Psr\Http\Message\StreamInterface;
use RuntimeException;
class Stream implements StreamInterface class Stream implements StreamInterface
{ {
private const READABLE_MODES = ['r', 'r+', 'w+', 'a+', 'x+', 'c+']; /** @var resource */
private const WRITABLE_MODES = ['r+', 'w', 'w+', 'a', 'a+', 'x', 'x+', 'c', 'c+'];
/** @var resource|null */
private $resource; private $resource;
/** /**
* Create a new Stream by passing either a stream resource handle (e.g., * Create a new Stream passing either a stream resource handle (e.g.,
* from fopen) or a string. * from fopen) or a string.
* *
* If $resource is a string, the Stream will open a php://temp stream, * If $resource is a string, the Stream will open a php://temp stream,
@ -25,17 +19,17 @@ class Stream implements StreamInterface
* @param resource|string $resource A file system pointer resource or * @param resource|string $resource A file system pointer resource or
* string * string
*/ */
public function __construct($resource = '') public function __construct($resource)
{ {
if (is_resource($resource) && get_resource_type($resource) === 'stream') { if (is_resource($resource) && get_resource_type($resource) === "stream") {
$this->resource = $resource; $this->resource = $resource;
} elseif (is_string($resource)) { } elseif (is_string($resource)) {
$this->resource = fopen('php://temp', 'wb+'); $this->resource = fopen("php://temp", "wb+");
if ($resource !== '') { if ($resource !== "") {
$this->write($resource); $this->write($resource);
} }
} else { } else {
throw new InvalidArgumentException('Expected resource or string.'); throw new \InvalidArgumentException("Expected a resource handler.");
} }
} }
@ -52,16 +46,16 @@ class Stream implements StreamInterface
*/ */
public function __toString() public function __toString()
{ {
$string = "";
try { try {
if ($this->isSeekable()) { if ($this->isSeekable()) {
$this->rewind(); rewind($this->resource);
} }
return $this->getContents(); $string = $this->getContents();
} catch (Exception $e) { } catch (\Exception $e) {
// Silence exceptions in order to conform with PHP's string casting // Silence exceptions in order to conform with PHP's string casting operations.
// operations.
return '';
} }
return $string;
} }
/** /**
@ -71,13 +65,7 @@ class Stream implements StreamInterface
*/ */
public function close() public function close()
{ {
if ($this->resource === null) { fclose($this->resource);
return;
}
$resource = $this->resource;
fclose($resource);
$this->resource = null;
} }
/** /**
@ -89,9 +77,9 @@ class Stream implements StreamInterface
*/ */
public function detach() public function detach()
{ {
$resource = $this->resource; $stream = $this->resource;
$this->resource = null; $this->resource = null;
return $resource; return $stream;
} }
/** /**
@ -101,32 +89,23 @@ class Stream implements StreamInterface
*/ */
public function getSize() public function getSize()
{ {
if ($this->resource === null) {
return null;
}
$statistics = fstat($this->resource); $statistics = fstat($this->resource);
if ($statistics && $statistics['size']) { return $statistics["size"] ?: null;
return $statistics['size'];
}
return null;
} }
/** /**
* Returns the current position of the file read/write pointer * Returns the current position of the file read/write pointer
* *
* @return int Position of the file pointer * @return int Position of the file pointer
* @throws RuntimeException on error. * @throws \RuntimeException on error.
*/ */
public function tell() public function tell()
{ {
if ($this->resource === null) {
throw new RuntimeException('Unable to retrieve current position of detached stream.');
}
$position = ftell($this->resource); $position = ftell($this->resource);
if ($position === false) { if ($position === false) {
throw new RuntimeException('Unable to retrieve current position of file pointer.'); // @codeCoverageIgnoreStart
throw new \RuntimeException("Unable to retrieve current position of file pointer.");
// @codeCoverageIgnoreEnd
} }
return $position; return $position;
} }
@ -138,10 +117,6 @@ class Stream implements StreamInterface
*/ */
public function eof() public function eof()
{ {
if ($this->resource === null) {
return true;
}
return feof($this->resource); return feof($this->resource);
} }
@ -152,11 +127,7 @@ class Stream implements StreamInterface
*/ */
public function isSeekable() public function isSeekable()
{ {
if ($this->resource === null) { return $this->getMetadata("seekable") == 1;
return false;
}
return $this->getMetadata('seekable') == 1;
} }
/** /**
@ -169,21 +140,18 @@ class Stream implements StreamInterface
* PHP $whence values for `fseek()`. SEEK_SET: Set position equal to * PHP $whence values for `fseek()`. SEEK_SET: Set position equal to
* offset bytes SEEK_CUR: Set position to current location plus offset * offset bytes SEEK_CUR: Set position to current location plus offset
* SEEK_END: Set position to end-of-stream plus offset. * SEEK_END: Set position to end-of-stream plus offset.
* @return void * @throws \RuntimeException on failure.
* @throws RuntimeException on failure.
*/ */
public function seek($offset, $whence = SEEK_SET) public function seek($offset, $whence = SEEK_SET)
{ {
if ($this->resource === null) {
throw new RuntimeException('Unable to seek detached stream.');
}
$result = -1; $result = -1;
if ($this->isSeekable()) { if ($this->isSeekable()) {
$result = fseek($this->resource, $offset, $whence); $result = fseek($this->resource, $offset, $whence);
} }
if ($result === -1) { if ($result === -1) {
throw new RuntimeException('Unable to seek to position.'); // @codeCoverageIgnoreStart
throw new \RuntimeException("Unable to seek to position.");
// @codeCoverageIgnoreEnd
} }
} }
@ -195,21 +163,18 @@ class Stream implements StreamInterface
* *
* @see seek() * @see seek()
* @link http://www.php.net/manual/en/function.fseek.php * @link http://www.php.net/manual/en/function.fseek.php
* @return void * @throws \RuntimeException on failure.
* @throws RuntimeException on failure.
*/ */
public function rewind() public function rewind()
{ {
if ($this->resource === null) {
throw new RuntimeException('Unable to seek detached stream.');
}
$result = false; $result = false;
if ($this->isSeekable()) { if ($this->isSeekable()) {
$result = rewind($this->resource); $result = rewind($this->resource);
} }
if ($result === false) { if ($result === false) {
throw new RuntimeException('Unable to rewind.'); // @codeCoverageIgnoreStart
throw new \RuntimeException("Unable to seek to position.");
// @codeCoverageIgnoreEnd
} }
} }
@ -220,12 +185,8 @@ class Stream implements StreamInterface
*/ */
public function isWritable() public function isWritable()
{ {
if ($this->resource === null) { $mode = $this->getMetadata("mode");
return false; return $mode[0] !== "r" || strpos($mode, "+") !== false;
}
$mode = $this->getBasicMode();
return in_array($mode, self::WRITABLE_MODES);
} }
/** /**
@ -233,20 +194,16 @@ class Stream implements StreamInterface
* *
* @param string $string The string that is to be written. * @param string $string The string that is to be written.
* @return int Returns the number of bytes written to the stream. * @return int Returns the number of bytes written to the stream.
* @throws RuntimeException on failure. * @throws \RuntimeException on failure.
*/ */
public function write($string) public function write($string)
{ {
if ($this->resource === null) {
throw new RuntimeException('Unable to write to detached stream.');
}
$result = false; $result = false;
if ($this->isWritable()) { if ($this->isWritable()) {
$result = fwrite($this->resource, $string); $result = fwrite($this->resource, $string);
} }
if ($result === false) { if ($result === false) {
throw new RuntimeException('Unable to write to stream.'); throw new \RuntimeException("Unable to write to stream.");
} }
return $result; return $result;
} }
@ -258,12 +215,8 @@ class Stream implements StreamInterface
*/ */
public function isReadable() public function isReadable()
{ {
if ($this->resource === null) { $mode = $this->getMetadata("mode");
return false; return strpos($mode, "r") !== false || strpos($mode, "+") !== false;
}
$mode = $this->getBasicMode();
return in_array($mode, self::READABLE_MODES);
} }
/** /**
@ -274,20 +227,16 @@ class Stream implements StreamInterface
* call returns fewer bytes. * call returns fewer bytes.
* @return string Returns the data read from the stream, or an empty string * @return string Returns the data read from the stream, or an empty string
* if no bytes are available. * if no bytes are available.
* @throws RuntimeException if an error occurs. * @throws \RuntimeException if an error occurs.
*/ */
public function read($length) public function read($length)
{ {
if ($this->resource === null) {
throw new RuntimeException('Unable to read to detached stream.');
}
$result = false; $result = false;
if ($this->isReadable()) { if ($this->isReadable()) {
$result = fread($this->resource, $length); $result = fread($this->resource, $length);
} }
if ($result === false) { if ($result === false) {
throw new RuntimeException('Unable to read from stream.'); throw new \RuntimeException("Unable to read from stream.");
} }
return $result; return $result;
} }
@ -296,21 +245,17 @@ class Stream implements StreamInterface
* Returns the remaining contents in a string * Returns the remaining contents in a string
* *
* @return string * @return string
* @throws RuntimeException if unable to read or an error occurs while * @throws \RuntimeException if unable to read or an error occurs while
* reading. * reading.
*/ */
public function getContents() public function getContents()
{ {
if ($this->resource === null) {
throw new RuntimeException('Unable to read to detached stream.');
}
$result = false; $result = false;
if ($this->isReadable()) { if ($this->isReadable()) {
$result = stream_get_contents($this->resource); $result = stream_get_contents($this->resource);
} }
if ($result === false) { if ($result === false) {
throw new RuntimeException('Unable to read from stream.'); throw new \RuntimeException("Unable to read from stream.");
} }
return $result; return $result;
} }
@ -322,17 +267,13 @@ class Stream implements StreamInterface
* stream_get_meta_data() function. * stream_get_meta_data() function.
* *
* @link http://php.net/manual/en/function.stream-get-meta-data.php * @link http://php.net/manual/en/function.stream-get-meta-data.php
* @param string|null $key Specific metadata to retrieve. * @param string $key Specific metadata to retrieve.
* @return array|mixed|null Returns an associative array if no key is * @return array|mixed|null Returns an associative array if no key is
* provided. Returns a specific key value if a key is provided and the * provided. Returns a specific key value if a key is provided and the
* value is found, or null if the key is not found. * value is found, or null if the key is not found.
*/ */
public function getMetadata($key = null) public function getMetadata($key = null)
{ {
if ($this->resource === null) {
return null;
}
$metadata = stream_get_meta_data($this->resource); $metadata = stream_get_meta_data($this->resource);
if ($key === null) { if ($key === null) {
return $metadata; return $metadata;
@ -340,14 +281,4 @@ class Stream implements StreamInterface
return $metadata[$key]; return $metadata[$key];
} }
} }
/**
* @return string Mode for the resource reduced to only the characters
* r, w, a, x, c, and + needed to determine readable and writeable status.
*/
private function getBasicMode()
{
$mode = $this->getMetadata('mode') ?? '';
return preg_replace('/[^rwaxc+]/', '', $mode);
}
} }

View File

@ -1,53 +0,0 @@
<?php
namespace WellRESTed\Message;
use Psr\Http\Message\StreamFactoryInterface;
use Psr\Http\Message\StreamInterface;
use RuntimeException;
class StreamFactory implements StreamFactoryInterface
{
/**
* Create a new stream from a string.
*
* @param string $content String content with which to populate the stream.
* @return StreamInterface
*/
public function createStream(string $content = ''): StreamInterface
{
return new Stream($content);
}
/**
* Create a stream from an existing file.
*
* @param string $filename Filename or stream URI to use as basis of stream.
* @param string $mode Mode with which to open the underlying file/stream.
*
* @return StreamInterface
* @throws RuntimeException If the file cannot be opened.
*/
public function createStreamFromFile(
string $filename,
string $mode = 'r'
): StreamInterface {
$f = fopen($filename, $mode);
if ($f === false) {
throw new RuntimeException();
}
return new Stream($f);
}
/**
* Create a new stream from an existing resource.
*
* @param resource $resource PHP resource to use as basis of stream.
*
* @return StreamInterface
*/
public function createStreamFromResource($resource): StreamInterface
{
return new Stream($resource);
}
}

View File

@ -2,33 +2,24 @@
namespace WellRESTed\Message; namespace WellRESTed\Message;
use InvalidArgumentException;
use Psr\Http\Message\StreamInterface; use Psr\Http\Message\StreamInterface;
use Psr\Http\Message\UploadedFileInterface; use Psr\Http\Message\UploadedFileInterface;
use RuntimeException;
/** /**
* Value object representing a file uploaded through an HTTP request. * Value object representing a file uploaded through an HTTP request.
*/ */
class UploadedFile implements UploadedFileInterface class UploadedFile implements UploadedFileInterface
{ {
/** @var string */
private $clientFilename; private $clientFilename;
/** @var string */
private $clientMediaType; private $clientMediaType;
/** @var int */
private $error; private $error;
/** @var bool */
private $moved = false; private $moved = false;
/** @var int */
private $size; private $size;
/** @var StreamInterface */
private $stream; private $stream;
/** @var string|null */
private $tmpName; private $tmpName;
/** /**
* Create a new UploadedFile. The arguments correspond with keys from arrays * Create a new Uri. The arguments correspond with keys from arrays
* provided by $_FILES. For example, given this structure for $_FILES: * provided by $_FILES. For example, given this structure for $_FILES:
* *
* array( * array(
@ -66,11 +57,10 @@ class UploadedFile implements UploadedFileInterface
$this->size = $size; $this->size = $size;
if (file_exists($tmpName)) { if (file_exists($tmpName)) {
$this->stream = new Stream(fopen($tmpName, 'rb'));
$this->tmpName = $tmpName; $this->tmpName = $tmpName;
$this->stream = new Stream(fopen($tmpName, "r"));
} else { } else {
$this->stream = new NullStream(); $this->stream = new NullStream();
$this->tmpName = null;
} }
} }
@ -87,19 +77,16 @@ class UploadedFile implements UploadedFileInterface
* raise an exception. * raise an exception.
* *
* @return StreamInterface Stream representation of the uploaded file. * @return StreamInterface Stream representation of the uploaded file.
* @throws RuntimeException in cases when no stream is available or can * @throws \RuntimeException in cases when no stream is available or can
* be created. * be created.
*/ */
public function getStream() public function getStream()
{ {
if ($this->tmpName === null) {
throw new RuntimeException('Unable to read uploaded file.');
}
if ($this->moved) { if ($this->moved) {
throw new RuntimeException('File has already been moved.'); throw new \RuntimeException("File has already been moved");
} }
if (php_sapi_name() !== 'cli' && !is_uploaded_file($this->tmpName)) { if (php_sapi_name() !== "cli" && !is_uploaded_file($this->tmpName)) {
throw new RuntimeException('File is not an uploaded file.'); throw new \RuntimeException("File is not an uploaded file.");
} }
return $this->stream; return $this->stream;
} }
@ -117,21 +104,20 @@ class UploadedFile implements UploadedFileInterface
* *
* @see http://php.net/is_uploaded_file * @see http://php.net/is_uploaded_file
* @see http://php.net/move_uploaded_file * @see http://php.net/move_uploaded_file
* @param string $targetPath Path to which to move the uploaded file. * @param string $path Path to which to move the uploaded file.
* @return void * @throws \InvalidArgumentException if the $path specified is invalid.
* @throws InvalidArgumentException if the $path specified is invalid. * @throws \RuntimeException on any error during the move operation, or on
* @throws RuntimeException on any error during the move operation, or on
* the second or subsequent call to the method. * the second or subsequent call to the method.
*/ */
public function moveTo($targetPath) public function moveTo($path)
{ {
if ($this->tmpName === null || !file_exists($this->tmpName)) { if ($this->tmpName === null || !file_exists($this->tmpName)) {
throw new RuntimeException("File {$this->tmpName} does not exist."); throw new \RuntimeException("File " . $this->tmpName . " does not exist.");
} }
if (php_sapi_name() === 'cli') { if (php_sapi_name() === "cli") {
rename($this->tmpName, $targetPath); rename($this->tmpName, $path);
} else { } else {
move_uploaded_file($this->tmpName, $targetPath); move_uploaded_file($this->tmpName, $path);
} }
$this->moved = true; $this->moved = true;
} }

View File

@ -2,7 +2,6 @@
namespace WellRESTed\Message; namespace WellRESTed\Message;
use InvalidArgumentException;
use Psr\Http\Message\UriInterface; use Psr\Http\Message\UriInterface;
/** /**
@ -18,41 +17,60 @@ use Psr\Http\Message\UriInterface;
*/ */
class Uri implements UriInterface class Uri implements UriInterface
{ {
private const MIN_PORT = 0; const MIN_PORT = 0;
private const MAX_PORT = 65535; const MAX_PORT = 65535;
/** @var string */ /** @var string */
private $scheme; private $scheme = "";
/** @var string */ /** @var string */
private $user; private $user = "";
/** @var string */ /** @var string|null */
private $password; private $password;
/** @var string */ /** @var string */
private $host; private $host = "";
/** @var int|null */ /** @var int|null */
private $port; private $port;
/** @var string */ /** @var string */
private $path; private $path = "";
/** @var string */ /** @var string */
private $query; private $query = "";
/** @var string */ /** @var string */
private $fragment; private $fragment = "";
/** /**
* @param string $uri A string representation of a URI. * @param string $uri A string representation of a URI.
*/ */
public function __construct(string $uri = '') public function __construct($uri = "")
{ {
$parsed = parse_url($uri); if (is_string($uri) && $uri !== "") {
$parsed = parse_url($uri);
$this->scheme = $parsed['scheme'] ?? ''; if ($parsed !== false) {
$this->user = $parsed['user'] ?? ''; if (isset($parsed["scheme"])) {
$this->password = $parsed['pass'] ?? ''; $this->scheme = $parsed["scheme"];
$this->host = strtolower($parsed['host'] ?? ''); }
$this->port = $parsed['port'] ?? null; if (isset($parsed["host"])) {
$this->path = $parsed['path'] ?? ''; $this->host = strtolower($parsed["host"]);
$this->query = $parsed['query'] ?? ''; }
$this->fragment = $parsed['fragment'] ?? ''; if (isset($parsed["port"])) {
$this->port = $parsed["port"];
}
if (isset($parsed["user"])) {
$this->user = $parsed["user"];
}
if (isset($parsed["pass"])) {
$this->password = $parsed["pass"];
}
if (isset($parsed["path"])) {
$this->path = $parsed["path"];
}
if (isset($parsed["query"])) {
$this->query = $parsed["query"];
}
if (isset($parsed["fragment"])) {
$this->fragment = $parsed["fragment"];
}
}
}
} }
/** /**
@ -94,38 +112,33 @@ class Uri implements UriInterface
*/ */
public function getAuthority() public function getAuthority()
{ {
$authority = "";
$host = $this->getHost(); $host = $this->getHost();
if (!$host) { if ($host !== "") {
return '';
}
$authority = ''; // User Info
$userInfo = $this->getUserInfo();
if ($userInfo !== "") {
$authority .= $userInfo . "@";
}
// User Info // Host
$userInfo = $this->getUserInfo(); $authority .= $host;
if ($userInfo) {
$authority .= $userInfo . '@';
}
// Host // Port: Include only if set AND non-standard.
$authority .= $host; $port = $this->getPort();
if ($port !== null) {
// Port: Include only if non-standard $scheme = $this->getScheme();
if ($this->nonStandardPort()) { if (($scheme === "http" && $port !== 80 ) || ($scheme === "https" && $port !== 443)) {
$authority .= ':' . $this->getPort(); $authority .= ":" . $port;
}
}
} }
return $authority; return $authority;
} }
private function nonStandardPort(): bool
{
$port = $this->getPort();
$scheme = $this->getScheme();
return $scheme === 'http' && $port !== 80
|| $scheme === 'https' && $port !== 443;
}
/** /**
* Retrieve the user information component of the URI. * Retrieve the user information component of the URI.
* *
@ -145,7 +158,7 @@ class Uri implements UriInterface
{ {
$userInfo = $this->user; $userInfo = $this->user;
if ($userInfo && $this->password) { if ($userInfo && $this->password) {
$userInfo .= ':' . $this->password; $userInfo .= ":" . $this->password;
} }
return $userInfo; return $userInfo;
} }
@ -185,9 +198,9 @@ class Uri implements UriInterface
{ {
if ($this->port === null) { if ($this->port === null) {
switch ($this->scheme) { switch ($this->scheme) {
case 'http': case "http":
return 80; return 80;
case 'https': case "https":
return 443; return 443;
default: default:
return null; return null;
@ -223,7 +236,7 @@ class Uri implements UriInterface
*/ */
public function getPath() public function getPath()
{ {
if ($this->path === '*') { if ($this->path === "*") {
return $this->path; return $this->path;
} }
return $this->percentEncode($this->path); return $this->percentEncode($this->path);
@ -287,14 +300,14 @@ class Uri implements UriInterface
* An empty scheme is equivalent to removing the scheme. * An empty scheme is equivalent to removing the scheme.
* *
* @param string $scheme The scheme to use with the new instance. * @param string $scheme The scheme to use with the new instance.
* @return static A new instance with the specified scheme. * @return self A new instance with the specified scheme.
* @throws InvalidArgumentException for invalid or unsupported schemes. * @throws \InvalidArgumentException for invalid or unsupported schemes.
*/ */
public function withScheme($scheme) public function withScheme($scheme)
{ {
$scheme = strtolower($scheme ?? ''); $scheme = $scheme ? strtolower($scheme) : "";
if (!in_array($scheme, ['', 'http', 'https'])) { if (!in_array($scheme, ["", "http", "https"])) {
throw new InvalidArgumentException('Scheme must be http, https, or empty.'); throw new \InvalidArgumentException("Scheme must be http, https, or empty.");
} }
$uri = clone $this; $uri = clone $this;
$uri->scheme = $scheme; $uri->scheme = $scheme;
@ -313,13 +326,13 @@ class Uri implements UriInterface
* *
* @param string $user The user name to use for authority. * @param string $user The user name to use for authority.
* @param null|string $password The password associated with $user. * @param null|string $password The password associated with $user.
* @return static A new instance with the specified user information. * @return self A new instance with the specified user information.
*/ */
public function withUserInfo($user, $password = null) public function withUserInfo($user, $password = null)
{ {
$uri = clone $this; $uri = clone $this;
$uri->user = $user; $uri->user = $user;
$uri->password = $password ?? ''; $uri->password = $password;
return $uri; return $uri;
} }
@ -332,13 +345,13 @@ class Uri implements UriInterface
* An empty host value is equivalent to removing the host. * An empty host value is equivalent to removing the host.
* *
* @param string $host The hostname to use with the new instance. * @param string $host The hostname to use with the new instance.
* @return static A new instance with the specified host. * @return self A new instance with the specified host.
* @throws InvalidArgumentException for invalid hostnames. * @throws \InvalidArgumentException for invalid hostnames.
*/ */
public function withHost($host) public function withHost($host)
{ {
if (!is_string($host)) { if (!is_string($host)) {
throw new InvalidArgumentException('Host must be a string.'); throw new \InvalidArgumentException("Host must be a string.");
} }
$uri = clone $this; $uri = clone $this;
@ -360,19 +373,19 @@ class Uri implements UriInterface
* *
* @param null|int $port The port to use with the new instance; a null value * @param null|int $port The port to use with the new instance; a null value
* removes the port information. * removes the port information.
* @return static A new instance with the specified port. * @return self A new instance with the specified port.
* @throws InvalidArgumentException for invalid ports. * @throws \InvalidArgumentException for invalid ports.
*/ */
public function withPort($port) public function withPort($port)
{ {
if (is_numeric($port)) { if (is_numeric($port)) {
if ($port < self::MIN_PORT || $port > self::MAX_PORT) { if ($port < self::MIN_PORT || $port > self::MAX_PORT) {
$message = sprintf('Port must be between %s and %s.', self::MIN_PORT, self::MAX_PORT); $message = sprintf("Port must be between %s and %s.", self::MIN_PORT, self::MAX_PORT);
throw new InvalidArgumentException($message); throw new \InvalidArgumentException($message);
} }
$port = (int) $port; $port = (int) $port;
} elseif ($port !== null) { } elseif ($port !== null) {
throw new InvalidArgumentException('Port must be an int or null.'); throw new \InvalidArgumentException("Port must be an int or null.");
} }
$uri = clone $this; $uri = clone $this;
@ -394,13 +407,13 @@ class Uri implements UriInterface
* Implementations ensure the correct encoding as outlined in getPath(). * Implementations ensure the correct encoding as outlined in getPath().
* *
* @param string $path The path to use with the new instance. * @param string $path The path to use with the new instance.
* @return static A new instance with the specified path. * @return self A new instance with the specified path.
* @throws InvalidArgumentException for invalid paths. * @throws \InvalidArgumentException for invalid paths.
*/ */
public function withPath($path) public function withPath($path)
{ {
if (!is_string($path)) { if (!is_string($path)) {
throw new InvalidArgumentException('Path must be a string'); throw new \InvalidArgumentException("Path must be a string");
} }
$uri = clone $this; $uri = clone $this;
$uri->path = $path; $uri->path = $path;
@ -419,8 +432,8 @@ class Uri implements UriInterface
* An empty query string value is equivalent to removing the query string. * An empty query string value is equivalent to removing the query string.
* *
* @param string $query The query string to use with the new instance. * @param string $query The query string to use with the new instance.
* @return static A new instance with the specified query string. * @return self A new instance with the specified query string.
* @throws InvalidArgumentException for invalid query strings. * @throws \InvalidArgumentException for invalid query strings.
*/ */
public function withQuery($query) public function withQuery($query)
{ {
@ -441,12 +454,12 @@ class Uri implements UriInterface
* An empty fragment value is equivalent to removing the fragment. * An empty fragment value is equivalent to removing the fragment.
* *
* @param string $fragment The fragment to use with the new instance. * @param string $fragment The fragment to use with the new instance.
* @return static A new instance with the specified fragment. * @return self A new instance with the specified fragment.
*/ */
public function withFragment($fragment) public function withFragment($fragment)
{ {
$uri = clone $this; $uri = clone $this;
$uri->fragment = $fragment ?? ''; $uri->fragment = $fragment;
return $uri; return $uri;
} }
@ -475,29 +488,29 @@ class Uri implements UriInterface
*/ */
public function __toString() public function __toString()
{ {
$string = ''; $string = "";
$authority = $this->getAuthority(); $authority = $this->getAuthority();
if ($authority !== '') { if ($authority !== "") {
$scheme = $this->getScheme(); $scheme = $this->getScheme();
if ($scheme !== '') { if ($scheme !== "") {
$string = $scheme . ':'; $string = $scheme . ":";
} }
$string .= "//$authority"; $string .= "//$authority";
} }
$path = $this->getPath(); $path = $this->getPath();
if ($path !== '') { if ($path !== "") {
$string .= $path; $string .= $path;
} }
$query = $this->getQuery(); $query = $this->getQuery();
if ($query !== '') { if ($query !== "") {
$string .= "?$query"; $string .= "?$query";
} }
$fragment = $this->getFragment(); $fragment = $this->getFragment();
if ($fragment !== '') { if ($fragment !== "") {
$string .= "#$fragment"; $string .= "#$fragment";
} }
@ -520,12 +533,12 @@ class Uri implements UriInterface
* @param string $subject * @param string $subject
* @return string * @return string
*/ */
private function percentEncode(string $subject) private function percentEncode($subject)
{ {
$reserved = ':/?#[]@!$&\'()*+,;='; $reserved = ':/?#[]@!$&\'()*+,;=';
$reserved = preg_quote($reserved); $reserved = preg_quote($reserved);
$pattern = '~(?:%(?![a-fA-F0-9]{2}))|(?:[^%a-zA-Z0-9\-\.\_\~' . $reserved . ']{1})~'; $pattern = '~(?:%(?![a-fA-F0-9]{2}))|(?:[^%a-zA-Z0-9\-\.\_\~' . $reserved . ']{1})~';
$callback = function (array $matches): string { $callback = function ($matches) {
return urlencode($matches[0]); return urlencode($matches[0]);
}; };
return preg_replace_callback($pattern, $callback, $subject); return preg_replace_callback($pattern, $callback, $subject);

View File

@ -1,23 +1,17 @@
<?php <?php
namespace WellRESTed\Routing\Route; namespace WellRESTed\Routing;
use Psr\Http\Message\ResponseInterface; use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\ServerRequestInterface; use Psr\Http\Message\ServerRequestInterface;
use WellRESTed\Dispatching\DispatcherInterface; use WellRESTed\Dispatching\DispatcherInterface;
use WellRESTed\MiddlewareInterface;
/** class MethodMap implements MethodMapInterface
* @internal
*/
class MethodMap implements MiddlewareInterface
{ {
/** @var DispatcherInterface */
private $dispatcher; private $dispatcher;
/** @var array */
private $map; private $map;
// ------------------------------------------------------------------------- // ------------------------------------------------------------------------
public function __construct(DispatcherInterface $dispatcher) public function __construct(DispatcherInterface $dispatcher)
{ {
@ -25,33 +19,41 @@ class MethodMap implements MiddlewareInterface
$this->dispatcher = $dispatcher; $this->dispatcher = $dispatcher;
} }
// ------------------------------------------------------------------------
// MethodMapInterface
/** /**
* Register a dispatchable (e.g.m handler or middleware) with a method. * Register middleware with a method.
* *
* $method may be: * $method may be:
* - A single verb ("GET"), * - A single verb ("GET"),
* - A comma-separated list of verbs ("GET,PUT,DELETE") * - A comma-separated list of verbs ("GET,PUT,DELETE")
* - "*" to indicate any method. * - "*" to indicate any method.
* *
* $dispatchable may be anything a Dispatcher can dispatch. * $middleware may be:
* @see DispatcherInterface::dispatch * - An instance implementing MiddlewareInterface
* - A string containing the fully qualified class name of a class
* implementing MiddlewareInterface
* - A callable that returns an instance implementing MiddleInterface
* - A callable matching the signature of MiddlewareInterface::dispatch
* @see DispatchedInterface::dispatch
* *
* $dispatchable may also be null, in which case any previously set * $middleware may also be null, in which case any previously set
* handlers and middle for that method or methods will be unset. * middleware for that method or methods will be unset.
* *
* @param string $method * @param string $method
* @param mixed $dispatchable * @param mixed $middleware
*/ */
public function register(string $method, $dispatchable): void public function register($method, $middleware)
{ {
$methods = explode(',', $method); $methods = explode(",", $method);
$methods = array_map('trim', $methods); $methods = array_map("trim", $methods);
foreach ($methods as $method) { foreach ($methods as $method) {
$this->map[$method] = $dispatchable; $this->map[$method] = $middleware;
} }
} }
// ------------------------------------------------------------------------- // ------------------------------------------------------------------------
// MiddlewareInterface // MiddlewareInterface
/** /**
@ -60,11 +62,8 @@ class MethodMap implements MiddlewareInterface
* @param callable $next * @param callable $next
* @return ResponseInterface * @return ResponseInterface
*/ */
public function __invoke( public function __invoke(ServerRequestInterface $request, ResponseInterface $response, $next)
ServerRequestInterface $request, {
ResponseInterface $response,
$next
) {
$method = $request->getMethod(); $method = $request->getMethod();
// Dispatch middleware registered with the explicitly matching method. // Dispatch middleware registered with the explicitly matching method.
if (isset($this->map[$method])) { if (isset($this->map[$method])) {
@ -72,18 +71,18 @@ class MethodMap implements MiddlewareInterface
return $this->dispatchMiddleware($middleware, $request, $response, $next); return $this->dispatchMiddleware($middleware, $request, $response, $next);
} }
// For HEAD, dispatch GET by default. // For HEAD, dispatch GET by default.
if ($method === 'HEAD' && isset($this->map['GET'])) { if ($method === "HEAD" && isset($this->map["GET"])) {
$middleware = $this->map['GET']; $middleware = $this->map["GET"];
return $this->dispatchMiddleware($middleware, $request, $response, $next); return $this->dispatchMiddleware($middleware, $request, $response, $next);
} }
// Dispatch * middleware, if registered. // Dispatch * middleware, if registered.
if (isset($this->map['*'])) { if (isset($this->map["*"])) {
$middleware = $this->map['*']; $middleware = $this->map["*"];
return $this->dispatchMiddleware($middleware, $request, $response, $next); return $this->dispatchMiddleware($middleware, $request, $response, $next);
} }
// Respond describing the allowed methods, either as a 405 response or // Respond describing the allowed methods, either as a 405 response or
// in response to an OPTIONS request. // in response to an OPTIONS request.
if ($method === 'OPTIONS') { if ($method === "OPTIONS") {
$response = $response->withStatus(200); $response = $response->withStatus(200);
} else { } else {
$response = $response->withStatus(405); $response = $response->withStatus(405);
@ -91,44 +90,37 @@ class MethodMap implements MiddlewareInterface
return $this->addAllowHeader($response); return $this->addAllowHeader($response);
} }
// ------------------------------------------------------------------------- // ------------------------------------------------------------------------
private function addAllowHeader(ResponseInterface $response): ResponseInterface private function addAllowHeader(ResponseInterface $response)
{ {
$methods = join(',', $this->getAllowedMethods()); $methods = join(",", $this->getAllowedMethods());
return $response->withHeader('Allow', $methods); return $response->withHeader("Allow", $methods);
} }
/** private function getAllowedMethods()
* @return string[]
*/
private function getAllowedMethods(): array
{ {
$methods = array_keys($this->map); $methods = array_keys($this->map);
// Add HEAD if GET is allowed and HEAD is not present. // Add HEAD if GET is allowed and HEAD is not present.
if (in_array('GET', $methods) && !in_array('HEAD', $methods)) { if (in_array("GET", $methods) && !in_array("HEAD", $methods)) {
$methods[] = 'HEAD'; $methods[] = "HEAD";
} }
// Add OPTIONS if not already present. // Add OPTIONS if not already present.
if (!in_array('OPTIONS', $methods)) { if (!in_array("OPTIONS", $methods)) {
$methods[] = 'OPTIONS'; $methods[] = "OPTIONS";
} }
return $methods; return $methods;
} }
/** /**
* @param mixed $middleware * @param $middleware
* @param ServerRequestInterface $request * @param ServerRequestInterface $request
* @param ResponseInterface $response * @param ResponseInterface $response
* @param callable $next * @param $next
* @return ResponseInterface * @return ResponseInterface
*/ */
private function dispatchMiddleware( private function dispatchMiddleware($middleware, ServerRequestInterface $request, ResponseInterface &$response, $next)
$middleware, {
ServerRequestInterface $request,
ResponseInterface $response,
$next
) {
return $this->dispatcher->dispatch($middleware, $request, $response, $next); return $this->dispatcher->dispatch($middleware, $request, $response, $next);
} }
} }

View File

@ -0,0 +1,47 @@
<?php
namespace WellRESTed\Routing;
use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\ServerRequestInterface;
use WellRESTed\MiddlewareInterface;
/**
* Maps HTTP methods to middleware
*/
interface MethodMapInterface extends MiddlewareInterface
{
/**
* Evaluate $request's method and dispatches matching middleware.
*
* Implementations MUST pass $request, $response, and $next to the matching
* middleware.
*
* @param ServerRequestInterface $request
* @param ResponseInterface $response
* @param callable $next
* @return ResponseInterface
*/
public function __invoke(ServerRequestInterface $request, ResponseInterface $response, $next);
/**
* Register middleware with a method.
*
* $method may be:
* - A single verb ("GET"),
* - A comma-separated list of verbs ("GET,PUT,DELETE")
* - "*" to indicate any method.
*
* $middleware may be:
* - An instance implementing MiddlewareInterface
* - A string containing the fully qualified class name of a class
* implementing MiddlewareInterface
* - A callable that returns an instance implementing MiddleInterface
* - A callable matching the signature of MiddlewareInterface::dispatch
* @see DispatcherInterface::dispatch
*
* @param string $method
* @param mixed $middleware
*/
public function register($method, $middleware);
}

View File

@ -2,28 +2,26 @@
namespace WellRESTed\Routing\Route; namespace WellRESTed\Routing\Route;
/**
* @internal
*/
class PrefixRoute extends Route class PrefixRoute extends Route
{ {
public function __construct(string $target, MethodMap $methodMap) public function __construct($target, $methodMap)
{ {
parent::__construct(rtrim($target, '*'), $methodMap); $this->target = rtrim($target, "*");
$this->methodMap = $methodMap;
} }
public function getType(): int public function getType()
{ {
return Route::TYPE_PREFIX; return RouteInterface::TYPE_PREFIX;
} }
/** /**
* Examines a request target to see if it is a match for the route. * Examines a request target to see if it is a match for the route.
* *
* @param string $requestTarget * @param string $requestTarget
* @return bool * @return boolean
*/ */
public function matchesRequestTarget(string $requestTarget): bool public function matchesRequestTarget($requestTarget)
{ {
return strrpos($requestTarget, $this->target, -strlen($requestTarget)) !== false; return strrpos($requestTarget, $this->target, -strlen($requestTarget)) !== false;
} }
@ -31,7 +29,7 @@ class PrefixRoute extends Route
/** /**
* Always returns an empty array. * Always returns an empty array.
*/ */
public function getPathVariables(): array public function getPathVariables()
{ {
return []; return [];
} }

View File

@ -2,28 +2,22 @@
namespace WellRESTed\Routing\Route; namespace WellRESTed\Routing\Route;
use RuntimeException;
/**
* @internal
*/
class RegexRoute extends Route class RegexRoute extends Route
{ {
/** @var array */ private $captures;
private $captures = [];
public function getType(): int public function getType()
{ {
return Route::TYPE_PATTERN; return RouteInterface::TYPE_PATTERN;
} }
/** /**
* Examines a request target to see if it is a match for the route. * Examines a request target to see if it is a match for the route.
* *
* @param string $requestTarget * @param string $requestTarget
* @return bool * @return boolean
*/ */
public function matchesRequestTarget(string $requestTarget): bool public function matchesRequestTarget($requestTarget)
{ {
$this->captures = []; $this->captures = [];
$matched = preg_match($this->getTarget(), $requestTarget, $captures); $matched = preg_match($this->getTarget(), $requestTarget, $captures);
@ -31,7 +25,7 @@ class RegexRoute extends Route
$this->captures = $captures; $this->captures = $captures;
return true; return true;
} elseif ($matched === false) { } elseif ($matched === false) {
throw new RuntimeException('Invalid regular expression: ' . $this->getTarget()); throw new \RuntimeException("Invalid regular expression: " . $this->getTarget());
} }
return false; return false;
} }
@ -42,7 +36,7 @@ class RegexRoute extends Route
* @see \preg_match * @see \preg_match
* @return array * @return array
*/ */
public function getPathVariables(): array public function getPathVariables()
{ {
return $this->captures; return $this->captures;
} }

View File

@ -4,106 +4,39 @@ namespace WellRESTed\Routing\Route;
use Psr\Http\Message\ResponseInterface; use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\ServerRequestInterface; use Psr\Http\Message\ServerRequestInterface;
use RuntimeException; use WellRESTed\Routing\MethodMapInterface;
use WellRESTed\MiddlewareInterface;
/** abstract class Route implements RouteInterface
* @internal
*/
abstract class Route implements MiddlewareInterface
{ {
/** Matches when request path is an exact match to entire target */
public const TYPE_STATIC = 0;
/** Matches when request path is an exact match to start of target */
public const TYPE_PREFIX = 1;
/** Matches by request path by pattern and may extract matched varialbes */
public const TYPE_PATTERN = 2;
/** @var string */ /** @var string */
protected $target; protected $target;
/** @var MethodMap */ /** @var MethodMapInterface */
protected $methodMap; protected $methodMap;
public function __construct(string $target, MethodMap $methodMap) public function __construct($target, $methodMap)
{ {
$this->target = $target; $this->target = $target;
$this->methodMap = $methodMap; $this->methodMap = $methodMap;
} }
/** /**
* Return the Route::TYPE_ constants that identifies the type. * Return the instance mapping methods to middleware for this route.
* *
* TYPE_STATIC indicates the route MUST match only when the path is an * @return MethodMapInterface
* exact match to the route's entire target. This route type SHOULD NOT
* provide path variables.
*
* TYPE_PREFIX indicates the route MUST match when the route's target
* appears in its entirety at the beginning of the path.
*
* TYPE_PATTERN indicates that matchesRequestTarget MUST be used
* to determine a match against a given path. This route type SHOULD
* provide path variables.
*
* @return int One of the Route::TYPE_ constants.
*/ */
abstract public function getType(): int; public function getMethodMap()
{
return $this->methodMap;
}
/** /**
* Return an array of variables extracted from the path most recently
* passed to matchesRequestTarget.
*
* If the path does not contain variables, or if matchesRequestTarget
* has not yet been called, this method MUST return an empty array.
*
* @return array
*/
abstract public function getPathVariables(): array;
/**
* Examines a request target to see if it is a match for the route.
*
* @param string $requestTarget
* @return bool
* @throws RuntimeException Error occurred testing the target such as an
* invalid regular expression
*/
abstract public function matchesRequestTarget(string $requestTarget): bool;
/**
* Path, partial path, or pattern to match request paths against.
*
* @return string * @return string
*/ */
public function getTarget(): string public function getTarget()
{ {
return $this->target; return $this->target;
} }
/**
* Register a dispatchable (handler or middleware) with a method.
*
* $method may be:
* - A single verb ("GET"),
* - A comma-separated list of verbs ("GET,PUT,DELETE")
* - "*" to indicate any method.
*
* $dispatchable may be anything a Dispatcher can dispatch.
* @see DispatcherInterface::dispatch
*
* @param string $method
* @param mixed $dispatchable
*/
public function register(string $method, $dispatchable): void
{
$this->methodMap->register($method, $dispatchable);
}
/**
* @param ServerRequestInterface $request
* @param ResponseInterface $response
* @param callable $next
* @return ResponseInterface
*/
public function __invoke(ServerRequestInterface $request, ResponseInterface $response, $next) public function __invoke(ServerRequestInterface $request, ResponseInterface $response, $next)
{ {
$map = $this->methodMap; $map = $this->methodMap;

View File

@ -3,11 +3,12 @@
namespace WellRESTed\Routing\Route; namespace WellRESTed\Routing\Route;
use WellRESTed\Dispatching\DispatcherInterface; use WellRESTed\Dispatching\DispatcherInterface;
use WellRESTed\Routing\MethodMap;
/** /**
* @internal * Class for creating routes
*/ */
class RouteFactory class RouteFactory implements RouteFactoryInterface
{ {
private $dispatcher; private $dispatcher;
@ -25,16 +26,16 @@ class RouteFactory
* - Regular expressions will create RegexRoutes * - Regular expressions will create RegexRoutes
* *
* @param string $target Route target or target pattern * @param string $target Route target or target pattern
* @return Route * @return RouteInterface
*/ */
public function create(string $target): Route public function create($target)
{ {
if ($target[0] === '/') { if ($target[0] === "/") {
// Possible static, prefix, or template // Possible static, prefix, or template
// PrefixRoutes end with * // PrefixRoutes end with *
if (substr($target, -1) === '*') { if (substr($target, -1) === "*") {
return new PrefixRoute($target, new MethodMap($this->dispatcher)); return new PrefixRoute($target, new MethodMap($this->dispatcher));
} }

View File

@ -0,0 +1,19 @@
<?php
namespace WellRESTed\Routing\Route;
interface RouteFactoryInterface
{
/**
* Creates a route for the given target.
*
* - Targets with no special characters will create StaticRoutes
* - Targets ending with * will create PrefixRoutes
* - Targets containing URI variables (e.g., {id}) will create TemplateRoutes
* - Regular expressions will create RegexRoutes
*
* @param string $target Route target or target pattern
* @return RouteInterface
*/
public function create($target);
}

View File

@ -0,0 +1,67 @@
<?php
namespace WellRESTed\Routing\Route;
use WellRESTed\MiddlewareInterface;
use WellRESTed\Routing\MethodMapInterface;
interface RouteInterface extends MiddlewareInterface
{
/** Matches when path is an exact match only */
const TYPE_STATIC = 0;
/** Matches when path has the expected beginning */
const TYPE_PREFIX = 1;
/** Matches by pattern. Use matchesRequestTarget to test for matches */
const TYPE_PATTERN = 2;
/**
* @return string
*/
public function getTarget();
/**
* Return the RouteInterface::TYPE_ constants that identifies the type.
*
* TYPE_STATIC indicates the route MUST match only when the path is an
* exact match to the route's target. This route type SHOULD NOT
* provide path variables.
*
* TYPE_PREFIX indicates the route MUST match when the route's target
* appears in its entirety at the beginning of the path.
*
* TYPE_PATTERN indicates that matchesRequestTarget MUST be used
* to determine a match against a given path. This route type SHOULD
* provide path variables.
*
* @return int One of the RouteInterface::TYPE_ constants.
*/
public function getType();
/**
* Return an array of variables extracted from the path most recently
* passed to matchesRequestTarget.
*
* If the path does not contain variables, or if matchesRequestTarget
* has not yet been called, this method MUST return an empty array.
*
* @return array
*/
public function getPathVariables();
/**
* Return the instance mapping methods to middleware for this route.
*
* @return MethodMapInterface
*/
public function getMethodMap();
/**
* Examines a request target to see if it is a match for the route.
*
* @param string $requestTarget
* @return boolean
* @throw \RuntimeException Error occurred testing the target such as an
* invalid regular expression
*/
public function matchesRequestTarget($requestTarget);
}

View File

@ -2,23 +2,20 @@
namespace WellRESTed\Routing\Route; namespace WellRESTed\Routing\Route;
/**
* @internal
*/
class StaticRoute extends Route class StaticRoute extends Route
{ {
public function getType(): int public function getType()
{ {
return Route::TYPE_STATIC; return RouteInterface::TYPE_STATIC;
} }
/** /**
* Examines a request target to see if it is a match for the route. * Examines a request target to see if it is a match for the route.
* *
* @param string $requestTarget * @param string $requestTarget
* @return bool * @return boolean
*/ */
public function matchesRequestTarget(string $requestTarget): bool public function matchesRequestTarget($requestTarget)
{ {
return $requestTarget === $this->getTarget(); return $requestTarget === $this->getTarget();
} }
@ -26,7 +23,7 @@ class StaticRoute extends Route
/** /**
* Always returns an empty array. * Always returns an empty array.
*/ */
public function getPathVariables(): array public function getPathVariables()
{ {
return []; return [];
} }

View File

@ -2,41 +2,36 @@
namespace WellRESTed\Routing\Route; namespace WellRESTed\Routing\Route;
/**
* @internal
*/
class TemplateRoute extends Route class TemplateRoute extends Route
{ {
/** Regular expression matching a URI template variable (e.g., {id}) */ private $pathVariables;
public const URI_TEMPLATE_EXPRESSION_RE = '/{([+.\/]?[a-zA-Z0-9_,]+\*?)}/'; private $explosions;
/** /**
* Regular expression matching 1 or more unreserved characters. * Regular expression matching 1 or more unreserved characters.
* ALPHA / DIGIT / "-" / "." / "_" / "~" * ALPHA / DIGIT / "-" / "." / "_" / "~"
*/ */
private const RE_UNRESERVED = '[0-9a-zA-Z\-._\~%]*'; const RE_UNRESERVED = '[0-9a-zA-Z\-._\~%]*';
/** Regular expression matching a URI template variable (e.g., {id}) */
const URI_TEMPLATE_EXPRESSION_RE = '/{([+.\/]?[a-zA-Z0-9_,]+\*?)}/';
/** @var array */ public function getType()
private $pathVariables = [];
/** @var array */
private $explosions = [];
public function getType(): int
{ {
return Route::TYPE_PATTERN; return RouteInterface::TYPE_PATTERN;
} }
public function getPathVariables(): array public function getPathVariables()
{ {
return $this->pathVariables; return $this->pathVariables ?: [];
} }
/** /**
* Examines a request target to see if it is a match for the route. * Examines a request target to see if it is a match for the route.
* *
* @param string $requestTarget * @param string $requestTarget
* @return bool * @return boolean
*/ */
public function matchesRequestTarget(string $requestTarget): bool public function matchesRequestTarget($requestTarget)
{ {
$this->pathVariables = []; $this->pathVariables = [];
$this->explosions = []; $this->explosions = [];
@ -54,55 +49,54 @@ class TemplateRoute extends Route
return false; return false;
} }
private function matchesStartOfRequestTarget(string $requestTarget): bool private function matchesStartOfRequestTarget($requestTarget)
{ {
$firstVarPos = strpos($this->target, '{'); $firstVarPos = strpos($this->target, "{");
if ($firstVarPos === false) { return (substr($requestTarget, 0, $firstVarPos) === substr($this->target, 0, $firstVarPos));
return $requestTarget === $this->target;
}
return substr($requestTarget, 0, $firstVarPos) === substr($this->target, 0, $firstVarPos);
} }
private function processMatches(array $matches): array private function processMatches($matches)
{ {
$variables = []; $variables = [];
// Isolate the named captures. // Isolate the named captures.
$keys = array_filter(array_keys($matches), 'is_string'); $keys = array_filter(array_keys($matches), "is_string");
// Store named captures to the variables. // Store named captures to the variables.
foreach ($keys as $key) { foreach ($keys as $key) {
$value = $matches[$key]; $value = $matches[$key];
if (isset($this->explosions[$key])) { if (isset($this->explosions[$key])) {
$values = explode($this->explosions[$key], $value); $values = explode($this->explosions[$key], $value);
$variables[$key] = array_map('urldecode', $values); $variables[$key] = array_map("urldecode", $values);
} else { } else {
$value = urldecode($value); $value = urldecode($value);
$variables[$key] = $value; $variables[$key] = $value;
} }
} }
return $variables; return $variables;
} }
private function getMatchingPattern(): string private function getMatchingPattern()
{ {
// Convert the template into the pattern // Convert the template into the pattern
$pattern = $this->target; $pattern = $this->target;
// Escape allowable characters with regex meaning. // Escape allowable characters with regex meaning.
$escape = [ $escape = [
'.' => '\\.', "." => "\\.",
'-' => '\\-', "-" => "\\-",
'+' => '\\+', "+" => "\\+",
'*' => '\\*' "*" => "\\*"
]; ];
$pattern = str_replace(array_keys($escape), array_values($escape), $pattern); $pattern = str_replace(array_keys($escape), array_values($escape), $pattern);
$unescape = [ $unescape = [
'{\\+' => '{+', "{\\+" => "{+",
'{\\.' => '{.', "{\\." => "{.",
'\\*}' => '*}' "\\*}" => "*}"
]; ];
$pattern = str_replace(array_keys($unescape), array_values($unescape), $pattern); $pattern = str_replace(array_keys($unescape), array_values($unescape), $pattern);
@ -111,47 +105,47 @@ class TemplateRoute extends Route
$pattern = preg_replace_callback( $pattern = preg_replace_callback(
self::URI_TEMPLATE_EXPRESSION_RE, self::URI_TEMPLATE_EXPRESSION_RE,
[$this, 'uriVariableReplacementCallback'], [$this, "uriVariableReplacementCallback"],
$pattern $pattern
); );
return $pattern; return $pattern;
} }
private function uriVariableReplacementCallback(array $matches): string private function uriVariableReplacementCallback($matches)
{ {
$name = $matches[1]; $name = $matches[1];
$pattern = self::RE_UNRESERVED; $pattern = self::RE_UNRESERVED;
$prefix = ''; $prefix = "";
$delimiter = ','; $delimiter = ",";
$explodeDelimiter = ','; $explodeDelimiter = ",";
// Read the first character as an operator. This determines which // Read the first character as an operator. This determines which
// characters to allow in the match. // characters to allow in the match.
$operator = $name[0]; $operator = $name[0];
// Read the last character as the modifier. // Read the last character as the modifier.
$explosion = (substr($name, -1, 1) === '*'); $explosion = (substr($name, -1, 1) === "*");
switch ($operator) { switch ($operator) {
case '+': case "+":
$name = substr($name, 1); $name = substr($name, 1);
$pattern = '.*'; $pattern = ".*";
break; break;
case '.': case ".":
$name = substr($name, 1); $name = substr($name, 1);
$prefix = '\\.'; $prefix = "\\.";
$delimiter = '\\.'; $delimiter = "\\.";
$explodeDelimiter = '.'; $explodeDelimiter = ".";
break; break;
case '/': case "/":
$name = substr($name, 1); $name = substr($name, 1);
$prefix = '\\/'; $prefix = "\\/";
$delimiter = '\\/'; $delimiter = "\\/";
if ($explosion) { if ($explosion) {
$pattern = '[0-9a-zA-Z\-._\~%,\/]*'; // Unreserved + "," and "/" $pattern = '[0-9a-zA-Z\-._\~%,\/]*'; // Unreserved + "," and "/"
$explodeDelimiter = '/'; $explodeDelimiter = "/";
} }
break; break;
} }
@ -165,7 +159,7 @@ class TemplateRoute extends Route
$this->explosions[$name] = $explodeDelimiter; $this->explosions[$name] = $explodeDelimiter;
} }
$names = explode(',', $name); $names = explode(",", $name);
$results = []; $results = [];
foreach ($names as $name) { foreach ($names as $name) {
$results[] = "(?<{$name}>{$pattern})"; $results[] = "(?<{$name}>{$pattern})";

View File

@ -4,32 +4,27 @@ namespace WellRESTed\Routing;
use Psr\Http\Message\ResponseInterface; use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\ServerRequestInterface; use Psr\Http\Message\ServerRequestInterface;
use WellRESTed\Dispatching\Dispatcher;
use WellRESTed\Dispatching\DispatcherInterface; use WellRESTed\Dispatching\DispatcherInterface;
use WellRESTed\MiddlewareInterface;
use WellRESTed\Routing\Route\Route;
use WellRESTed\Routing\Route\RouteFactory; use WellRESTed\Routing\Route\RouteFactory;
use WellRESTed\Routing\Route\RouteFactoryInterface;
use WellRESTed\Routing\Route\RouteInterface;
class Router implements MiddlewareInterface class Router implements RouterInterface
{ {
/** @var string|null Attribute name for matched path variables */ /** @var string ServerRequestInterface attribute name for matched path variables */
private $pathVariablesAttributeName; private $pathVariablesAttributeName;
/** @var DispatcherInterface */ /** @var DispatcherInterface */
private $dispatcher; private $dispatcher;
/** @var RouteFactory */ /** @var RouteFactoryInterface */
private $factory; private $factory;
/** @var Route[] Array of Route objects */ /** @var RouteInterface[] Array of Route objects */
private $routes; private $routes;
/** @var Route[] Hash array mapping exact paths to routes */ /** @var RouteInterface[] Hash array mapping exact paths to routes */
private $staticRoutes; private $staticRoutes;
/** @var Route[] Hash array mapping path prefixes to routes */ /** @var RouteInterface[] Hash array mapping path prefixes to routes */
private $prefixRoutes; private $prefixRoutes;
/** @var Route[] Hash array mapping path prefixes to routes */ /** @var RouteInterface[] Hash array mapping path prefixes to routes */
private $patternRoutes; private $patternRoutes;
/** @var mixed[] List array of middleware */
private $stack;
/** @var bool Call the next middleware when no route matches */
private $continueOnNotFound = false;
/** /**
* Create a new Router. * Create a new Router.
@ -42,57 +37,40 @@ class Router implements MiddlewareInterface
* stored with the name. The value will be an array containing all of the * stored with the name. The value will be an array containing all of the
* path variables. * path variables.
* *
* Use Server->createRouter to instantiate a new Router rather than calling * @param DispatcherInterface $dispatcher Instance to use for dispatching
* this constructor manually. * middleware.
* * @param string|null $pathVariablesAttributeName Attribute name for
* @param string|null $pathVariablesAttributeName * matched path variables. A null value sets attributes directly.
* Attribute name for matched path variables. A null value sets
* attributes directly.
* @param DispatcherInterface|null $dispatcher
* Instance to use for dispatching middleware and handlers.
* @param RouteFactory|null $routeFactory
*/ */
public function __construct( public function __construct(DispatcherInterface $dispatcher = null, $pathVariablesAttributeName = null)
?string $pathVariablesAttributeName = null, {
?DispatcherInterface $dispatcher = null, $this->dispatcher = $dispatcher;
?RouteFactory $routeFactory = null
) {
$this->pathVariablesAttributeName = $pathVariablesAttributeName; $this->pathVariablesAttributeName = $pathVariablesAttributeName;
$this->dispatcher = $dispatcher ?? new Dispatcher(); $this->factory = $this->getRouteFactory($this->dispatcher);
$this->factory = $routeFactory ?? new RouteFactory($this->dispatcher);
$this->routes = []; $this->routes = [];
$this->staticRoutes = []; $this->staticRoutes = [];
$this->prefixRoutes = []; $this->prefixRoutes = [];
$this->patternRoutes = []; $this->patternRoutes = [];
$this->stack = [];
} }
/** public function __invoke(ServerRequestInterface $request, ResponseInterface $response, $next)
* @param ServerRequestInterface $request {
* @param ResponseInterface $response // Use only the path for routing.
* @param callable $next $requestTarget = parse_url($request->getRequestTarget(), PHP_URL_PATH);
* @return ResponseInterface
*/
public function __invoke(
ServerRequestInterface $request,
ResponseInterface $response,
$next
): ResponseInterface {
$path = $this->getPath($request->getRequestTarget());
$route = $this->getStaticRoute($path); $route = $this->getStaticRoute($requestTarget);
if ($route) { if ($route) {
return $this->dispatch($route, $request, $response, $next); return $route($request, $response, $next);
} }
$route = $this->getPrefixRoute($path); $route = $this->getPrefixRoute($requestTarget);
if ($route) { if ($route) {
return $this->dispatch($route, $request, $response, $next); return $route($request, $response, $next);
} }
// Try each of the routes. // Try each of the routes.
foreach ($this->patternRoutes as $route) { foreach ($this->patternRoutes as $route) {
if ($route->matchesRequestTarget($path)) { if ($route->matchesRequestTarget($requestTarget)) {
$pathVariables = $route->getPathVariables(); $pathVariables = $route->getPathVariables();
if ($this->pathVariablesAttributeName) { if ($this->pathVariablesAttributeName) {
$request = $request->withAttribute($this->pathVariablesAttributeName, $pathVariables); $request = $request->withAttribute($this->pathVariablesAttributeName, $pathVariables);
@ -101,92 +79,30 @@ class Router implements MiddlewareInterface
$request = $request->withAttribute($name, $value); $request = $request->withAttribute($name, $value);
} }
} }
return $this->dispatch($route, $request, $response, $next); return $route($request, $response, $next);
} }
} }
if (!$this->continueOnNotFound) { // If no route exists, set the status code of the response to 404 and
return $response->withStatus(404); // return the response without propagating.
} return $response->withStatus(404);
return $next($request, $response);
}
private function getPath(string $requestTarget): string
{
$queryStart = strpos($requestTarget, '?');
if ($queryStart === false) {
return $requestTarget;
}
return substr($requestTarget, 0, $queryStart);
}
private function dispatch(
callable $route,
ServerRequestInterface $request,
ResponseInterface $response,
callable $next
): ResponseInterface {
if (!$this->stack) {
return $route($request, $response, $next);
}
$stack = array_merge($this->stack, [$route]);
return $this->dispatcher->dispatch(
$stack,
$request,
$response,
$next
);
} }
/** /**
* Register handlers and middleware with the router for a given path and * Register middleware with the router for a given path and method.
* method.
* *
* $method may be: * $method may be:
* - A single verb ("GET"), * - A single verb ("GET"),
* - A comma-separated list of verbs ("GET,PUT,DELETE") * - A comma-separated list of verbs ("GET,PUT,DELETE")
* - "*" to indicate any method. * - "*" to indicate any method.
* @see MethodMapInterface::register
* *
* $target may be: * $target may be:
* - An exact path (e.g., "/path/") * - An exact path (e.g., "/path/")
* - A prefix path ending with "*"" ("/path/*"") * - An prefix path ending with "*"" ("/path/*"")
* - A URI template with variables enclosed in "{}" ("/path/{id}") * - A URI template with variables enclosed in "{}" ("/path/{id}")
* - A regular expression ("~/cat/([0-9]+)~") * - A regular expression ("~/cat/([0-9]+)~")
* *
* $dispatchable may be:
* - An instance implementing one of these interfaces:
* - Psr\Http\Server\RequestHandlerInterface
* - Psr\Http\Server\MiddlewareInterface
* - WellRESTed\MiddlewareInterface
* - Psr\Http\Message\ResponseInterface
* - A string containing the fully qualified class name of a class
* implementing one of the interfaces listed above.
* - A callable that returns an instance implementing one of the
* interfaces listed above.
* - A callable with a signature matching the signature of
* WellRESTed\MiddlewareInterface::__invoke
* - An array containing any of the items in this list.
* @see DispatchedInterface::dispatch
*
* @param string $method HTTP method(s) to match
* @param string $target Request target or pattern to match
* @param mixed $dispatchable Handler or middleware to dispatch
* @return static
*/
public function register(string $method, string $target, $dispatchable): Router
{
$route = $this->getRouteForTarget($target);
$route->register($method, $dispatchable);
return $this;
}
/**
* Push a new middleware onto the stack.
*
* Middleware for a router runs before the middleware and handler for the
* matched route and runs only when a route matched.
*
* $middleware may be: * $middleware may be:
* - An instance implementing MiddlewareInterface * - An instance implementing MiddlewareInterface
* - A string containing the fully qualified class name of a class * - A string containing the fully qualified class name of a class
@ -195,28 +111,34 @@ class Router implements MiddlewareInterface
* - A callable matching the signature of MiddlewareInterface::dispatch * - A callable matching the signature of MiddlewareInterface::dispatch
* @see DispatchedInterface::dispatch * @see DispatchedInterface::dispatch
* *
* @param mixed $middleware Middleware to dispatch in sequence * @param string $target Request target or pattern to match
* @return static * @param string $method HTTP method(s) to match
* @param mixed $middleware Middleware to dispatch
* @return self
*/ */
public function add($middleware): Router public function register($method, $target, $middleware)
{ {
$this->stack[] = $middleware; $route = $this->getRouteForTarget($target);
$route->getMethodMap()->register($method, $middleware);
return $this; return $this;
} }
/** /**
* Configure the instance to delegate to the next middleware when no route * @param DispatcherInterface
* matches. * @return RouteFactoryInterface
*
* @return static
*/ */
public function continueOnNotFound(): Router protected function getRouteFactory($dispatcher)
{ {
$this->continueOnNotFound = true; return new RouteFactory($dispatcher);
return $this;
} }
private function getRouteForTarget(string $target): Route /**
* Return the route for a given target.
*
* @param $target
* @return RouteInterface
*/
private function getRouteForTarget($target)
{ {
if (isset($this->routes[$target])) { if (isset($this->routes[$target])) {
$route = $this->routes[$target]; $route = $this->routes[$target];
@ -227,26 +149,26 @@ class Router implements MiddlewareInterface
return $route; return $route;
} }
private function registerRouteForTarget(Route $route, string $target): void private function registerRouteForTarget($route, $target)
{ {
// Store the route to the hash indexed by original target. // Store the route to the hash indexed by original target.
$this->routes[$target] = $route; $this->routes[$target] = $route;
// Store the route to the array of routes for its type. // Store the route to the array of routes for its type.
switch ($route->getType()) { switch ($route->getType()) {
case Route::TYPE_STATIC: case RouteInterface::TYPE_STATIC:
$this->staticRoutes[$route->getTarget()] = $route; $this->staticRoutes[$route->getTarget()] = $route;
break; break;
case Route::TYPE_PREFIX: case RouteInterface::TYPE_PREFIX:
$this->prefixRoutes[rtrim($route->getTarget(), '*')] = $route; $this->prefixRoutes[rtrim($route->getTarget(), "*")] = $route;
break; break;
case Route::TYPE_PATTERN: case RouteInterface::TYPE_PATTERN:
$this->patternRoutes[] = $route; $this->patternRoutes[] = $route;
break; break;
} }
} }
private function getStaticRoute(string $requestTarget): ?Route private function getStaticRoute($requestTarget)
{ {
if (isset($this->staticRoutes[$requestTarget])) { if (isset($this->staticRoutes[$requestTarget])) {
return $this->staticRoutes[$requestTarget]; return $this->staticRoutes[$requestTarget];
@ -254,37 +176,28 @@ class Router implements MiddlewareInterface
return null; return null;
} }
private function getPrefixRoute(string $requestTarget): ?Route private function getPrefixRoute($requestTarget)
{ {
// Find all prefixes that match the start of this path. // Find all prefixes that match the start of this path.
$prefixes = array_keys($this->prefixRoutes); $prefixes = array_keys($this->prefixRoutes);
$matches = array_filter( $matches = array_filter(
$prefixes, $prefixes,
function ($prefix) use ($requestTarget) { function ($prefix) use ($requestTarget) {
return $this->startsWith($requestTarget, $prefix); return (strrpos($requestTarget, $prefix, -strlen($requestTarget)) !== false);
} }
); );
if (!$matches) { if ($matches) {
return null; if (count($matches) > 0) {
// If there are multiple matches, sort them to find the one with the longest string length.
$compareByLength = function ($a, $b) {
return strlen($b) - strlen($a);
};
usort($matches, $compareByLength);
}
$route = $this->prefixRoutes[$matches[0]];
return $route;
} }
return null;
// If there are multiple matches, sort them to find the one with the
// longest string length.
if (count($matches) > 1) {
$compareByLength = function (string $a, string $b): int {
return strlen($b) - strlen($a);
};
usort($matches, $compareByLength);
}
$bestMatch = array_values($matches)[0];
return $this->prefixRoutes[$bestMatch];
}
private function startsWith(string $haystack, string $needle): bool
{
$length = strlen($needle);
return substr($haystack, 0, $length) === $needle;
} }
} }

View File

@ -0,0 +1,56 @@
<?php
namespace WellRESTed\Routing;
use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\ServerRequestInterface;
use WellRESTed\MiddlewareInterface;
/**
* Maps HTTP methods and paths to middleware
*/
interface RouterInterface extends MiddlewareInterface
{
/**
* Evaluate $request's path and method and dispatches matching middleware.
*
* Implementations MUST pass $request, $response, and $next to the matching
* middleware.
*
* @param ServerRequestInterface $request
* @param ResponseInterface $response
* @param callable $next
* @return ResponseInterface
*/
public function __invoke(ServerRequestInterface $request, ResponseInterface $response, $next);
/**
* Register middleware with the router for a given path and method.
*
* $method may be:
* - A single verb ("GET")
* - A comma-separated list of verbs ("GET,PUT,DELETE")
* - "*" to indicate any method
* @see MethodMapInterface::register
*
* $target may be:
* - An exact path (e.g., "/path/")
* - A prefix path ending with "*"" ("/path/*"")
* - A URI template with one or more variables ("/path/{id}")
* - A regular expression ("~/cat/([0-9]+)~")
*
* $middleware may be:
* - An instance implementing MiddlewareInterface
* - A string containing the fully qualified class name of a class
* implementing MiddlewareInterface
* - A callable that returns an instance implementing MiddleInterface
* - A callable matching the signature of MiddlewareInterface::dispatch
* @see DispatchedInterface::dispatch
*
* @param string $target Request target or pattern to match
* @param string $method HTTP method(s) to match
* @param mixed $middleware Middleware to dispatch
* @return self
*/
public function register($method, $target, $middleware);
}

View File

@ -7,165 +7,204 @@ use Psr\Http\Message\ServerRequestInterface;
use WellRESTed\Dispatching\Dispatcher; use WellRESTed\Dispatching\Dispatcher;
use WellRESTed\Dispatching\DispatcherInterface; use WellRESTed\Dispatching\DispatcherInterface;
use WellRESTed\Message\Response; use WellRESTed\Message\Response;
use WellRESTed\Message\ServerRequestMarshaller; use WellRESTed\Message\ServerRequest;
use WellRESTed\Routing\Router; use WellRESTed\Routing\Router;
use WellRESTed\Transmission\Transmitter; use WellRESTed\Transmission\Transmitter;
use WellRESTed\Transmission\TransmitterInterface; use WellRESTed\Transmission\TransmitterInterface;
class Server class Server
{ {
/** @var mixed[] */ /** @var array */
private $attributes = []; protected $attributes;
/** @var string ServerRequestInterface attribute name for matched path variables */
protected $pathVariablesAttributeName;
/** @var mixed[] List array of middleware */
protected $stack;
/** @var DispatcherInterface */ /** @var DispatcherInterface */
private $dispatcher; private $dispatcher;
/** @var string|null attribute name for matched path variables */
private $pathVariablesAttributeName = null;
/** @var ServerRequestInterface|null */
private $request = null;
/** @var ResponseInterface */
private $response;
/** @var TransmitterInterface */
private $transmitter;
/** @var mixed[] List array of middleware */
private $stack;
public function __construct() /**
{ * Create a new server.
*
* By default, when a route containing path variables matches, the path
* variables are stored individually as attributes on the
* ServerRequestInterface.
*
* When $pathVariablesAttributeName is set, a single attribute will be
* stored with the name. The value will be an array containing all of the
* path variables.
*
* @param array $attributes key-value pairs to register as attributes
* with the server request.
* @param DispatcherInterface $dispatcher Dispatches middleware. If no
* object is passed, the Server will create a
* WellRESTed\Dispatching\Dispatcher
* @param string|null $pathVariablesAttributeName Attribute name for
* matched path variables. A null value sets attributes directly.
*/
public function __construct(
array $attributes = null,
DispatcherInterface $dispatcher = null,
$pathVariablesAttributeName = null
) {
if ($attributes === null) {
$attributes = [];
}
$this->attributes = $attributes;
if ($dispatcher === null) {
$dispatcher = $this->getDefaultDispatcher();
}
$this->dispatcher = $dispatcher;
$this->pathVariablesAttributeName = $pathVariablesAttributeName;
$this->stack = []; $this->stack = [];
$this->response = new Response();
$this->dispatcher = new Dispatcher();
$this->transmitter = new Transmitter();
} }
/** /**
* Push a new middleware onto the stack. * Push a new middleware onto the stack.
* *
* @param mixed $middleware Middleware to dispatch in sequence * @param mixed $middleware Middleware to dispatch in sequence
* @return Server * @return self
*/ */
public function add($middleware): Server public function add($middleware)
{ {
$this->stack[] = $middleware; $this->stack[] = $middleware;
return $this; return $this;
} }
/** /**
* Return a new Router that uses the server's configuration. * Dispatch the contained middleware in the order in which they were added.
*
* The first middleware added to the stack is the first to be dispatched.
*
* Each middleware, when dispatched, will receive a $next callable that
* dispatches the middleware that follows it. The only exception to this is
* the last middleware in the stack which much receive a $next callable the
* returns the response unchanged.
*
* If the instance is dispatched with no middleware added, the instance
* MUST call $next passing $request and $response and return the returned
* response.
*
* @param ServerRequestInterface $request
* @param ResponseInterface $response
* @param callable $next
* @return ResponseInterface
*/
public function dispatch(ServerRequestInterface $request, ResponseInterface $response, $next)
{
return $this->dispatcher->dispatch($this->stack, $request, $response, $next);
}
// ------------------------------------------------------------------------
/**
* Return a new Router that uses the server's dispatcher.
* *
* @return Router * @return Router
*/ */
public function createRouter(): Router public function createRouter()
{ {
return new Router( return new Router($this->getDispatcher(), $this->pathVariablesAttributeName);
$this->pathVariablesAttributeName, }
$this->dispatcher
); /**
* Return the dispatched used by the server.
*
* @return DispatcherInterface
*/
public function getDispatcher()
{
return $this->dispatcher;
} }
/** /**
* Perform the request-response cycle. * Perform the request-response cycle.
* *
* This method reads a server request, dispatches the request through the * This method reads a server request, dispatches the request through the
* server's stack of middleware, and outputs the response via a Transmitter. * server's stack of middleware, and outputs the response.
*
* @param ServerRequestInterface $request Request provided by the client
* @param ResponseInterface $response Initial starting place response to
* propagate to middleware.
* @param TransmitterInterface $transmitter Instance to outputting the
* final response to the client.
*/ */
public function respond(): void public function respond(
{ ServerRequestInterface $request = null,
$request = $this->getRequest(); ResponseInterface $response = null,
TransmitterInterface $transmitter = null
) {
if ($request === null) {
$request = $this->getRequest();
}
foreach ($this->attributes as $name => $value) { foreach ($this->attributes as $name => $value) {
$request = $request->withAttribute($name, $value); $request = $request->withAttribute($name, $value);
} }
if ($response === null) {
$next = function ( $response = $this->getResponse();
ServerRequestInterface $rqst,
ResponseInterface $resp
): ResponseInterface {
return $resp;
};
$response = $this->response;
$response = $this->dispatcher->dispatch(
$this->stack,
$request,
$response,
$next
);
$this->transmitter->transmit($request, $response);
}
// -------------------------------------------------------------------------
/* Configuration */
/**
* @param array $attributes
* @return Server
*/
public function setAttributes(array $attributes): Server
{
$this->attributes = $attributes;
return $this;
}
/**
* @param DispatcherInterface $dispatcher
* @return Server
*/
public function setDispatcher(DispatcherInterface $dispatcher): Server
{
$this->dispatcher = $dispatcher;
return $this;
}
/**
* @param string $name
* @return Server
*/
public function setPathVariablesAttributeName(string $name): Server
{
$this->pathVariablesAttributeName = $name;
return $this;
}
/**
* @param ServerRequestInterface $request
* @return Server
*/
public function setRequest(ServerRequestInterface $request): Server
{
$this->request = $request;
return $this;
}
/**
* @param ResponseInterface $response
* @return Server
*/
public function setResponse(ResponseInterface $response): Server
{
$this->response = $response;
return $this;
}
/**
* @param TransmitterInterface $transmitter
* @return Server
*/
public function setTransmitter(TransmitterInterface $transmitter): Server
{
$this->transmitter = $transmitter;
return $this;
}
// -------------------------------------------------------------------------
/* Defaults */
private function getRequest(): ServerRequestInterface
{
if (!$this->request) {
$marshaller = new ServerRequestMarshaller();
return $marshaller->getServerRequest();
} }
return $this->request; if ($transmitter === null) {
$transmitter = $this->getTransmitter();
}
$next = function ($request, $response) {
return $response;
};
$response = $this->dispatch($request, $response, $next);
$transmitter->transmit($request, $response);
} }
// ------------------------------------------------------------------------
// The following method provide instances using default classes. To use
// custom classes, subclass Server and override methods as needed.
/**
* Return an instance to dispatch middleware.
*
* @return DispatcherInterface
*/
protected function getDefaultDispatcher()
{
return new Dispatcher();
}
// @codeCoverageIgnoreStart
/**
* Return an instance representing the request submitted to the server.
*
* @return ServerRequestInterface
*/
protected function getRequest()
{
return ServerRequest::getServerRequest();
}
/**
* Return an instance that will output the response to the client.
*
* @return TransmitterInterface
*/
protected function getTransmitter()
{
return new Transmitter();
}
/**
* Return a "blank" response instance to populate.
*
* The response will be dispatched through the middleware and eventually
* output to the client.
*
* @return ResponseInterface
*/
protected function getResponse()
{
return new Response();
}
// @codeCoverageIgnoreEnd
} }

View File

@ -5,11 +5,21 @@ namespace WellRESTed\Transmission;
use Psr\Http\Message\ResponseInterface; use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\ServerRequestInterface; use Psr\Http\Message\ServerRequestInterface;
use Psr\Http\Message\StreamInterface; use Psr\Http\Message\StreamInterface;
use WellRESTed\Dispatching\Dispatcher;
use WellRESTed\Dispatching\DispatcherInterface;
class Transmitter implements TransmitterInterface class Transmitter implements TransmitterInterface
{ {
/** @var int */ /** @var int */
private $chunkSize = 8192; private $chunkSize = 0;
public function __construct(DispatcherInterface $dispatcher = null)
{
if ($dispatcher === null) {
$dispatcher = new Dispatcher();
}
$this->dispatcher = $dispatcher;
}
/** /**
* Outputs a response to the client. * Outputs a response to the client.
@ -24,10 +34,8 @@ class Transmitter implements TransmitterInterface
* @param ServerRequestInterface $request * @param ServerRequestInterface $request
* @param ResponseInterface $response Response to output * @param ResponseInterface $response Response to output
*/ */
public function transmit( public function transmit(ServerRequestInterface $request, ResponseInterface $response)
ServerRequestInterface $request, {
ResponseInterface $response
): void {
// Prepare the response for output. // Prepare the response for output.
$response = $this->prepareResponse($request, $response); $response = $this->prepareResponse($request, $response);
@ -48,35 +56,34 @@ class Transmitter implements TransmitterInterface
} }
} }
public function setChunkSize(int $chunkSize): void /**
* @param int $chunkSize
*/
public function setChunkSize($chunkSize)
{ {
$this->chunkSize = $chunkSize; $this->chunkSize = $chunkSize;
} }
private function prepareResponse( protected function prepareResponse(ServerRequestInterface $request, ResponseInterface $response)
ServerRequestInterface $request, {
ResponseInterface $response // Add a Content-length header to the response when all of these are true:
): ResponseInterface {
// Add Content-length header to the response when all of these are true:
// //
// - Response does not have a Content-length header // - Response does not have a Content-length header
// - Response does not have a Transfer-encoding: chunked header // - Response does not have a Transfer-encoding: chunked header
// - Response body stream is readable and reports a non-null size // - Response body stream is readable and reports a non-null size
// //
$contentLengthMissing = !$response->hasHeader('Content-length'); if (!$response->hasHeader("Content-length")
$notChunked = strtolower($response->getHeaderLine('Transfer-encoding')) && !(strtolower($response->getHeaderLine("Transfer-encoding")) === "chunked")
!== 'chunked'; ) {
$size = $response->getBody()->getSize(); $size = $response->getBody()->getSize();
if ($size !== null) {
if ($contentLengthMissing && $notChunked && $size !== null) { $response = $response->withHeader("Content-length", (string) $size);
$response = $response->withHeader('Content-length', (string) $size); }
} }
return $response; return $response;
} }
private function getStatusLine(ResponseInterface $response): string private function getStatusLine(ResponseInterface $response)
{ {
$protocol = $response->getProtocolVersion(); $protocol = $response->getProtocolVersion();
$statusCode = $response->getStatusCode(); $statusCode = $response->getStatusCode();
@ -88,7 +95,7 @@ class Transmitter implements TransmitterInterface
} }
} }
private function outputBody(StreamInterface $body): void private function outputBody(StreamInterface $body)
{ {
if ($this->chunkSize > 0) { if ($this->chunkSize > 0) {
if ($body->isSeekable()) { if ($body->isSeekable()) {

View File

@ -18,5 +18,5 @@ interface TransmitterInterface
* @param ServerRequestInterface $request * @param ServerRequestInterface $request
* @param ResponseInterface $response Response to output * @param ResponseInterface $response Response to output
*/ */
public function transmit(ServerRequestInterface $request, ResponseInterface $response): void; public function transmit(ServerRequestInterface $request, ResponseInterface $response);
} }

6
test/bootstrap.php Normal file
View File

@ -0,0 +1,6 @@
<?php
error_reporting(E_ALL);
$loader = require __DIR__ . '/../vendor/autoload.php';
$loader->addPsr4('WellRESTed\\Test\\', __DIR__ . '/src');

View File

@ -10,7 +10,6 @@ class NextMock
public $called = false; public $called = false;
public $request = null; public $request = null;
public $response = null; public $response = null;
public $upstreamResponse = null;
public function __invoke( public function __invoke(
ServerRequestInterface $request, ServerRequestInterface $request,
@ -19,10 +18,6 @@ class NextMock
$this->called = true; $this->called = true;
$this->request = $request; $this->request = $request;
$this->response = $response; $this->response = $response;
if ($this->upstreamResponse) { return $response;
return $this->upstreamResponse;
} else {
return $response;
}
} }
} }

28
test/src/HeaderStack.php Normal file
View File

@ -0,0 +1,28 @@
<?php
namespace WellRESTed\Transmission;
class HeaderStack
{
private static $headers;
public static function reset()
{
self::$headers = [];
}
public static function push($header)
{
self::$headers[] = $header;
}
public static function getHeaders()
{
return self::$headers;
}
}
function header($string, $dummy = true)
{
HeaderStack::push($string);
}

View File

@ -0,0 +1,24 @@
<?php
namespace WellRESTed\Message;
class UploadedFileState
{
public static $php_sapi_name;
public static $is_uploaded_file;
}
function php_sapi_name()
{
return UploadedFileState::$php_sapi_name;
}
function move_uploaded_file($source, $target)
{
return rename($source, $target);
}
function is_uploaded_file($file)
{
return UploadedFileState::$is_uploaded_file;
}

View File

@ -0,0 +1,202 @@
<?php
namespace WellRESTed\Test\Integration;
use Prophecy\Argument;
use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\ServerRequestInterface;
use WellRESTed\Message\Response;
use WellRESTed\Message\ServerRequest;
use WellRESTed\Message\Stream;
use WellRESTed\MiddlewareInterface;
use WellRESTed\Server;
use WellRESTed\Transmission\TransmitterInterface;
/**
* @coversNothing
*/
class ServerTest extends \PHPUnit_Framework_TestCase
{
public function testDispatchesMiddleware()
{
$server = new Server();
$server->add(function ($rqst, $resp, $next) {
$resp = $resp->withStatus(200)
->withBody(new Stream("Hello, world!"));
return $next($rqst, $resp);
});
$request = new ServerRequest();
$response = new Response();
$transmitter = new CallableTransmitter(function ($request, $response) {
$this->assertEquals("Hello, world!", (string) $response->getBody());
});
$server->respond($request, $response, $transmitter);
}
public function testDispatchesMiddlewareChain()
{
$server = new Server();
$server->add(function ($rqst, $resp, $next) {
return $next($rqst, $resp);
});
$server->add(function ($rqst, $resp, $next) {
$resp = $resp->withStatus(200)
->withBody(new Stream("Hello, world!"));
return $next($rqst, $resp);
});
$request = new ServerRequest();
$response = new Response();
$transmitter = new CallableTransmitter(function ($request, $response) {
$this->assertEquals("Hello, world!", (string) $response->getBody());
});
$server->respond($request, $response, $transmitter);
}
/**
* @dataProvider routeProvider
*/
public function testDispatchesAssortedMiddlewareTypesByPath($requestTarget, $expectedBody)
{
$stringMiddlewareWrapper = function ($string) {
return new StringMiddleware($string);
};
$server = new Server();
$server->add(function ($rqst, $resp, $next) {
return $next($rqst, $resp);
});
$server->add($server->createRouter()
->register("GET", "/fry", [
new StringMiddleware("Philip "),
new StringMiddleware("J. "),
new StringMiddleware("Fry")
])
->register("GET", "/leela", new StringMiddleware("Turanga Leela"))
->register("GET", "/bender", __NAMESPACE__ . '\BenderMiddleware')
->register("GET", "/professor", $stringMiddlewareWrapper("Professor Hubert J. Farnsworth"))
->register("GET", "/amy", function ($request, $response, $next) {
$message = "Amy Wong";
$body = $response->getBody();
if ($body->isWritable()) {
$body->write($message);
} else {
$response = $response->withBody(new Stream($message));
}
return $next($request, $response);
})
->register("GET", "/hermes", [
new StringMiddleware("Hermes "),
new StringMiddleware("Conrad", false),
new StringMiddleware(", CPA")
])
->register("GET", "/zoidberg", [
function ($request, $response, $next) {
// Prepend "Doctor " to the dispatched response on the return trip.
$response = $next($request, $response);
$message = "Doctor " . (string) $response->getBody();
return $response->withBody(new Stream($message));
},
new StringMiddleware("John "),
new StringMiddleware("Zoidberg")
])
);
$server->add(function ($rqst, $resp, $next) {
$resp = $resp->withStatus(200);
return $next($rqst, $resp);
});
$request = (new ServerRequest())->withRequestTarget($requestTarget);
$response = new Response();
$transmitter = new CallableTransmitter(function ($request, $response) use ($expectedBody) {
$this->assertEquals($expectedBody, (string) $response->getBody());
});
$server->respond($request, $response, $transmitter);
}
public function routeProvider()
{
return [
["/fry", "Philip J. Fry"],
["/leela", "Turanga Leela"],
["/bender", "Bender Bending Rodriguez"],
["/professor", "Professor Hubert J. Farnsworth"],
["/amy", "Amy Wong"],
["/hermes", "Hermes Conrad"],
["/zoidberg", "Doctor John Zoidberg"]
];
}
}
class CallableTransmitter implements TransmitterInterface
{
private $callable;
public function __construct($callable)
{
$this->callable = $callable;
}
public function transmit(ServerRequestInterface $request, ResponseInterface $response)
{
$callable = $this->callable;
$callable($request, $response);
}
}
class StringMiddleware implements MiddlewareInterface
{
private $string;
private $propagate;
public function __construct($string, $propagate = true)
{
$this->string = $string;
$this->propagate = $propagate;
}
/**
* @param ServerRequestInterface $request
* @param ResponseInterface $response
* @param callable $next
* @return ResponseInterface
*/
public function __invoke(ServerRequestInterface $request, ResponseInterface $response, $next)
{
$body = $response->getBody();
if ($body->isWritable()) {
$body->write($this->string);
} else {
$response = $response->withBody(new Stream($this->string));
}
if ($this->propagate) {
return $next($request, $response);
} else {
return $response;
}
}
}
class BenderMiddleware implements MiddlewareInterface
{
/**
* @param ServerRequestInterface $request
* @param ResponseInterface $response
* @param callable $next
* @return ResponseInterface
*/
public function __invoke(ServerRequestInterface $request, ResponseInterface $response, $next)
{
$message = "Bender Bending Rodriguez";
$body = $response->getBody();
if ($body->isWritable()) {
$body->write($message);
} else {
$response = $response->withBody(new Stream($message));
}
return $next($request, $response);
}
}

View File

@ -1,19 +1,24 @@
<?php <?php
namespace WellRESTed\Dispatching; namespace WellRESTed\Test\Unit\Dispatching;
use WellRESTed\Dispatching\Dispatcher;
use WellRESTed\Dispatching\DispatchStack;
use WellRESTed\Message\Response; use WellRESTed\Message\Response;
use WellRESTed\Message\ServerRequest; use WellRESTed\Message\ServerRequest;
use WellRESTed\Test\Doubles\NextMock; use WellRESTed\Test\Doubles\NextMock;
use WellRESTed\Test\TestCase;
class DispatchStackTest extends TestCase /**
* @covers WellRESTed\Dispatching\DispatchStack
* @group dispatching
*/
class DispatchStackTest extends \PHPUnit_Framework_TestCase
{ {
private $request; private $request;
private $response; private $response;
private $next; private $next;
protected function setUp(): void public function setUp()
{ {
parent::setUp(); parent::setUp();
$this->request = new ServerRequest(); $this->request = new ServerRequest();
@ -21,35 +26,35 @@ class DispatchStackTest extends TestCase
$this->next = new NextMock(); $this->next = new NextMock();
} }
public function testDispatchesMiddlewareInOrderAdded(): void public function testDispatchesMiddlewareInOrderAdded()
{ {
// Each middleware will add its "name" to this array. // Each middleware will add its "name" to this array.
$callOrder = []; $callOrder = [];
$stack = new DispatchStack(new Dispatcher()); $stack = new DispatchStack(new Dispatcher());
$stack->add(function ($request, $response, $next) use (&$callOrder) { $stack->add(function ($request, $response, $next) use (&$callOrder) {
$callOrder[] = 'first'; $callOrder[] = "first";
return $next($request, $response); return $next($request, $response);
}); });
$stack->add(function ($request, $response, $next) use (&$callOrder) { $stack->add(function ($request, $response, $next) use (&$callOrder) {
$callOrder[] = 'second'; $callOrder[] = "second";
return $next($request, $response); return $next($request, $response);
}); });
$stack->add(function ($request, $response, $next) use (&$callOrder) { $stack->add(function ($request, $response, $next) use (&$callOrder) {
$callOrder[] = 'third'; $callOrder[] = "third";
return $next($request, $response); return $next($request, $response);
}); });
$stack($this->request, $this->response, $this->next); $stack($this->request, $this->response, $this->next);
$this->assertEquals(['first', 'second', 'third'], $callOrder); $this->assertEquals(["first", "second", "third"], $callOrder);
} }
public function testCallsNextAfterDispatchingEmptyStack(): void public function testCallsNextAfterDispatchingEmptyStack()
{ {
$stack = new DispatchStack(new Dispatcher()); $stack = new DispatchStack(new Dispatcher());
$stack($this->request, $this->response, $this->next); $stack($this->request, $this->response, $this->next);
$this->assertTrue($this->next->called); $this->assertTrue($this->next->called);
} }
public function testCallsNextAfterDispatchingStack(): void public function testCallsNextAfterDispatchingStack()
{ {
$middleware = function ($request, $response, $next) use (&$callOrder) { $middleware = function ($request, $response, $next) use (&$callOrder) {
return $next($request, $response); return $next($request, $response);
@ -64,7 +69,7 @@ class DispatchStackTest extends TestCase
$this->assertTrue($this->next->called); $this->assertTrue($this->next->called);
} }
public function testDoesNotCallNextWhenStackStopsEarly(): void public function testDoesNotCallNextWhenStackStopsEarly()
{ {
$middlewareGo = function ($request, $response, $next) use (&$callOrder) { $middlewareGo = function ($request, $response, $next) use (&$callOrder) {
return $next($request, $response); return $next($request, $response);

View File

@ -0,0 +1,102 @@
<?php
namespace WellRESTed\Test\Unit\Dispatching;
use Prophecy\Argument;
use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\ServerRequestInterface;
use WellRESTed\Dispatching\Dispatcher;
use WellRESTed\Message\Response;
use WellRESTed\Message\ServerRequest;
use WellRESTed\MiddlewareInterface;
use WellRESTed\Test\Doubles\NextMock;
/**
* @covers WellRESTed\Dispatching\Dispatcher
* @group dispatching
*/
class DispatcherTest extends \PHPUnit_Framework_TestCase
{
private $request;
private $response;
private $next;
public function setUp()
{
$this->request = new ServerRequest();
$this->response = new Response();
$this->next = new NextMock();
}
public function testDispatchesCallableThatReturnsResponse()
{
$middleware = function ($request, $response, $next) {
return $next($request, $response->withStatus(200));
};
$dispatcher = new Dispatcher();
$response = $dispatcher->dispatch($middleware, $this->request, $this->response, $this->next);
$this->assertEquals(200, $response->getStatusCode());
}
public function testDispatchesMiddlewareInstanceFromCallable()
{
$middleware = function () {
return new DispatcherTest_Middleware();
};
$dispatcher = new Dispatcher();
$response = $dispatcher->dispatch($middleware, $this->request, $this->response, $this->next);
$this->assertEquals(200, $response->getStatusCode());
}
public function testDispatchesMiddlewareFromClassNameString()
{
$middleware = __NAMESPACE__ . '\DispatcherTest_Middleware';
$dispatcher = new Dispatcher();
$response = $dispatcher->dispatch($middleware, $this->request, $this->response, $this->next);
$this->assertEquals(200, $response->getStatusCode());
}
public function testDispatchesMiddlewareInstance()
{
$middleware = new DispatcherTest_Middleware();
$dispatcher = new Dispatcher();
$response = $dispatcher->dispatch($middleware, $this->request, $this->response, $this->next);
$this->assertEquals(200, $response->getStatusCode());
}
/**
* @uses WellRESTed\Dispatching\DispatchStack
*/
public function testDispatchesArrayAsDispatchStack()
{
$middleware = new DispatcherTest_Middleware();
$dispatcher = new Dispatcher();
$response = $dispatcher->dispatch([$middleware], $this->request, $this->response, $this->next);
$this->assertEquals(200, $response->getStatusCode());
}
/**
* @expectedException \WellRESTed\Dispatching\DispatchException
*/
public function testThrowsExceptionWhenUnableToDispatch()
{
$middleware = null;
$dispatcher = new Dispatcher();
$dispatcher->dispatch($middleware, $this->request, $this->response, $this->next);
}
}
class DispatcherTest_Middleware implements MiddlewareInterface
{
public function __invoke(ServerRequestInterface $request, ResponseInterface $response, $next)
{
$response = $response->withStatus(200);
return $next($request, $response);
}
}

View File

@ -0,0 +1,108 @@
<?php
namespace WellRESTed\Test\Unit\Message;
use WellRESTed\Message\HeaderCollection;
/**
* @covers WellRESTed\Message\HeaderCollection
* @group message
*/
class HeaderCollectionTest extends \PHPUnit_Framework_TestCase
{
public function testAddsSingleHeaderAndIndicatesCaseInsensitiveIsset()
{
$collection = new HeaderCollection();
$collection["Content-Type"] = "application/json";
$this->assertTrue(isset($collection["content-type"]));
}
public function testAddsMultipleHeadersAndIndicatesCaseInsensitiveIsset()
{
$collection = new HeaderCollection();
$collection["Set-Cookie"] = "cat=Molly";
$collection["SET-COOKIE"] = "dog=Bear";
$this->assertTrue(isset($collection["set-cookie"]));
}
public function testReturnsHeadersWithCaseInsensitiveHeaderName()
{
$collection = new HeaderCollection();
$collection["Set-Cookie"] = "cat=Molly";
$collection["SET-COOKIE"] = "dog=Bear";
$headers = $collection["set-cookie"];
$this->assertEquals(2, count(array_intersect($headers, ["cat=Molly", "dog=Bear"])));
}
public function testRemovesHeadersWithCaseInsensitiveHeaderName()
{
$collection = new HeaderCollection();
$collection["Set-Cookie"] = "cat=Molly";
$collection["SET-COOKIE"] = "dog=Bear";
unset($collection["set-cookie"]);
$this->assertFalse(isset($collection["set-cookie"]));
}
/** @coversNothing */
public function testCloneMakesDeepCopyOfHeaders()
{
$collection = new HeaderCollection();
$collection["Set-Cookie"] = "cat=Molly";
$clone = clone $collection;
unset($clone["Set-Cookie"]);
$this->assertTrue(isset($collection["set-cookie"]) && !isset($clone["set-cookie"]));
}
public function testIteratesWithOriginalKeys()
{
$collection = new HeaderCollection();
$collection["Content-length"] = "100";
$collection["Set-Cookie"] = "cat=Molly";
$collection["Set-Cookie"] = "dog=Bear";
$collection["Content-type"] = "application/json";
unset($collection["Content-length"]);
$headers = [];
foreach ($collection as $key => $values) {
$headers[] = $key;
}
$expected = ["Content-type", "Set-Cookie"];
$countUnmatched = count(array_diff($expected, $headers)) + count(array_diff($headers, $expected));
$this->assertEquals(0, $countUnmatched);
}
public function testIteratesWithOriginalKeysAndValues()
{
$collection = new HeaderCollection();
$collection["Content-length"] = "100";
$collection["Set-Cookie"] = "cat=Molly";
$collection["Set-Cookie"] = "dog=Bear";
$collection["Content-type"] = "application/json";
unset($collection["Content-length"]);
$headers = [];
foreach ($collection as $key => $values) {
foreach ($values as $value) {
if (isset($headers[$key])) {
$headers[$key][] = $value;
} else {
$headers[$key] = [$value];
}
}
}
$expected = [
"Set-Cookie" => ["cat=Molly", "dog=Bear"],
"Content-type" => ["application/json"]
];
$this->assertEquals($expected, $headers);
}
}

View File

@ -0,0 +1,231 @@
<?php
namespace WellRESTed\Test\Unit\Message;
/**
* @covers WellRESTed\Message\Message
* @group message
*/
class MessageTest extends \PHPUnit_Framework_TestCase
{
public function testSetsHeadersOnConstruction()
{
$headers = ["X-foo" => ["bar", "baz"]];
$body = null;
$message = $this->getMockForAbstractClass('\WellRESTed\Message\Message', [$headers, $body]);
$this->assertEquals(["bar", "baz"], $message->getHeader("X-foo"));
}
public function testSetsBodyOnConstruction()
{
$headers = null;
$body = $this->prophesize('\Psr\Http\Message\StreamInterface');
$message = $this->getMockForAbstractClass('\WellRESTed\Message\Message', [$headers, $body->reveal()]);
$this->assertSame($body->reveal(), $message->getBody());
}
public function testCloneMakesDeepCopyOfHeaders()
{
$message1 = $this->getMockForAbstractClass('\WellRESTed\Message\Message');
$message1 = $message1->withHeader("Content-type", "text/plain");
$message2 = $message1->withHeader("Content-type", "application/json");
$this->assertNotEquals($message1->getHeader("Content-type"), $message2->getHeader("Content-type"));
}
// ------------------------------------------------------------------------
// Protocol Version
public function testGetProtocolVersionReturnsProtocolVersion1Point1ByDefault()
{
$message = $this->getMockForAbstractClass('\WellRESTed\Message\Message');
$this->assertEquals("1.1", $message->getProtocolVersion());
}
public function testGetProtocolVersionReturnsProtocolVersion()
{
$message = $this->getMockForAbstractClass('\WellRESTed\Message\Message');
$message = $message->withProtocolVersion("1.0");
$this->assertEquals("1.0", $message->getProtocolVersion());
}
public function testGetProtocolVersionReplacesProtocolVersion()
{
$message = $this->getMockForAbstractClass('\WellRESTed\Message\Message');
$message = $message->withProtocolVersion("1.0");
$this->assertEquals("1.0", $message->getProtocolVersion());
}
// ------------------------------------------------------------------------
// Headers
/** @dataProvider validHeaderValueProvider */
public function testWithHeaderReplacesHeader($expected, $value)
{
$message = $this->getMockForAbstractClass('\WellRESTed\Message\Message');
$message = $message->withHeader("X-foo", "Original value");
$message = $message->withHeader("X-foo", $value);
$this->assertEquals($expected, $message->getHeader("X-foo"));
}
public function validHeaderValueProvider()
{
return [
[["0"], 0],
[["molly","bear"],["molly","bear"]]
];
}
/**
* @expectedException \InvalidArgumentException
* @dataProvider invalidHeaderProvider
*/
public function testWithHeaderThrowsExceptionWithInvalidArgument($name, $value)
{
$message = $this->getMockForAbstractClass('\WellRESTed\Message\Message');
$message->withHeader($name, $value);
}
public function invalidHeaderProvider()
{
return [
[0, 1024],
["Content-length", false],
["Content-length", [false]]
];
}
public function testWithAddedHeaderSetsHeader()
{
$message = $this->getMockForAbstractClass('\WellRESTed\Message\Message');
$message = $message->withAddedHeader("Content-type", "application/json");
$this->assertEquals(["application/json"], $message->getHeader("Content-type"));
}
public function testWithAddedHeaderAppendsValue()
{
$message = $this->getMockForAbstractClass('\WellRESTed\Message\Message');
$message = $message->withAddedHeader("Set-Cookie", ["cat=Molly"]);
$message = $message->withAddedHeader("Set-Cookie", ["dog=Bear"]);
$cookies = $message->getHeader("Set-Cookie");
$this->assertTrue(in_array("cat=Molly", $cookies) && in_array("dog=Bear", $cookies));
}
public function testWithoutHeaderRemovesHeader()
{
$message = $this->getMockForAbstractClass('\WellRESTed\Message\Message');
$message = $message->withHeader("Content-type", "application/json");
$message = $message->withoutHeader("Content-type");
$this->assertFalse($message->hasHeader("Content-type"));
}
public function testGetHeaderReturnsEmptyArrayForUnsetHeader()
{
$message = $this->getMockForAbstractClass('\WellRESTed\Message\Message');
$this->assertEquals([], $message->getHeader("X-name"));
}
public function testGetHeaderReturnsSingleHeader()
{
$message = $this->getMockForAbstractClass('\WellRESTed\Message\Message');
$message = $message->withAddedHeader("Content-type", "application/json");
$this->assertEquals(["application/json"], $message->getHeader("Content-type"));
}
public function testGetHeaderReturnsMultipleValuesForHeader()
{
$message = $this->getMockForAbstractClass('\WellRESTed\Message\Message');
$message = $message->withAddedHeader("X-name", "cat=Molly");
$message = $message->withAddedHeader("X-name", "dog=Bear");
$this->assertEquals(["cat=Molly", "dog=Bear"], $message->getHeader("X-name"));
}
public function testGetHeaderLineReturnsEmptyStringForUnsetHeader()
{
$message = $this->getMockForAbstractClass('\WellRESTed\Message\Message');
$this->assertSame("", $message->getHeaderLine("X-not-set"));
}
public function testGetHeaderLineReturnsMultipleHeadersJoinedByCommas()
{
$message = $this->getMockForAbstractClass('\WellRESTed\Message\Message');
$message = $message->withAddedHeader("X-name", "cat=Molly");
$message = $message->withAddedHeader("X-name", "dog=Bear");
$this->assertEquals("cat=Molly, dog=Bear", $message->getHeaderLine("X-name"));
}
public function testHasHeaderReturnsTrueWhenHeaderIsSet()
{
$message = $this->getMockForAbstractClass('\WellRESTed\Message\Message');
$message = $message->withHeader("Content-type", "application/json");
$this->assertTrue($message->hasHeader("Content-type"));
}
public function testHasHeaderReturnsFalseWhenHeaderIsNotSet()
{
$message = $this->getMockForAbstractClass('\WellRESTed\Message\Message');
$this->assertFalse($message->hasHeader("Content-type"));
}
public function testGetHeadersReturnOriginalHeaderNamesAsKeys()
{
$message = $this->getMockForAbstractClass('\WellRESTed\Message\Message');
$message = $message->withHeader("Set-Cookie", "cat=Molly");
$message = $message->withAddedHeader("Set-Cookie", "dog=Bear");
$message = $message->withHeader("Content-type", "application/json");
$headers = [];
foreach ($message->getHeaders() as $key => $values) {
$headers[] = $key;
}
$expected = ["Content-type", "Set-Cookie"];
$countUnmatched = count(array_diff($expected, $headers)) + count(array_diff($headers, $expected));
$this->assertEquals(0, $countUnmatched);
}
public function testGetHeadersReturnOriginalHeaderNamesAndValues()
{
$message = $this->getMockForAbstractClass('\WellRESTed\Message\Message');
$message = $message->withHeader("Set-Cookie", "cat=Molly");
$message = $message->withAddedHeader("Set-Cookie", "dog=Bear");
$message = $message->withHeader("Content-type", "application/json");
$headers = [];
foreach ($message->getHeaders() as $key => $values) {
foreach ($values as $value) {
if (isset($headers[$key])) {
$headers[$key][] = $value;
} else {
$headers[$key] = [$value];
}
}
}
$expected = [
"Set-Cookie" => ["cat=Molly", "dog=Bear"],
"Content-type" => ["application/json"]
];
$this->assertEquals($expected, $headers);
}
// ------------------------------------------------------------------------
// Body
public function testGetBodyReturnsEmptyStreamByDefault()
{
$message = $this->getMockForAbstractClass('\WellRESTed\Message\Message');
$this->assertEquals("", (string) $message->getBody());
}
public function testGetBodyReturnsAttachedStream()
{
$stream = $this->prophesize('\Psr\Http\Message\StreamInterface');
$stream = $stream->reveal();
$message = $this->getMockForAbstractClass('\WellRESTed\Message\Message');
$message = $message->withBody($stream);
$this->assertSame($stream, $message->getBody());
}
}

View File

@ -0,0 +1,112 @@
<?php
namespace WellRESTed\Test\Unit\Message;
use WellRESTed\Message\NullStream;
/**
* @covers WellRESTed\Message\NullStream
* @group message
*/
class NullStreamTest extends \PHPUnit_Framework_TestCase
{
public function testCastsToString()
{
$stream = new NullStream();
$this->assertEquals("", (string) $stream);
}
public function testCloseDoesNothing()
{
$stream = new \WellRESTed\Message\NullStream();
$stream->close();
$this->assertTrue(true); // Asserting no exception occured.
}
public function testDetachReturnsNull()
{
$stream = new \WellRESTed\Message\NullStream();
$this->assertNull($stream->detach());
}
public function testSizeReturnsZero()
{
$stream = new \WellRESTed\Message\NullStream();
$this->assertEquals(0, $stream->getSize());
}
public function testTellReturnsZero()
{
$stream = new \WellRESTed\Message\NullStream();
$this->assertEquals(0, $stream->tell());
}
public function testEofReturnsTrue()
{
$stream = new \WellRESTed\Message\NullStream();
$this->assertTrue($stream->eof());
}
public function testIsSeekableReturnsFalse()
{
$stream = new \WellRESTed\Message\NullStream();
$this->assertFalse($stream->isSeekable());
}
/** @expectedException \RuntimeException */
public function testSeekReturnsFalse()
{
$stream = new NullStream();
$stream->seek(10);
}
/** @expectedException \RuntimeException */
public function testRewindThrowsException()
{
$stream = new \WellRESTed\Message\NullStream();
$stream->rewind();
}
public function testIsWritableReturnsFalse()
{
$stream = new NullStream();
$this->assertFalse($stream->isWritable());
}
/** @expectedException \RuntimeException */
public function testWriteThrowsException()
{
$stream = new \WellRESTed\Message\NullStream();
$stream->write("");
}
public function testIsReadableReturnsTrue()
{
$stream = new \WellRESTed\Message\NullStream();
$this->assertTrue($stream->isReadable());
}
public function testReadReturnsEmptyString()
{
$stream = new \WellRESTed\Message\NullStream();
$this->assertEquals("", $stream->read(100));
}
public function testGetContentsReturnsEmptyString()
{
$stream = new NullStream();
$this->assertEquals("", $stream->getContents());
}
public function testGetMetadataReturnsNull()
{
$stream = new \WellRESTed\Message\NullStream();
$this->assertNull($stream->getMetadata());
}
public function testGetMetadataReturnsNullWithKey()
{
$stream = new \WellRESTed\Message\NullStream();
$this->assertNull($stream->getMetadata("size"));
}
}

View File

@ -0,0 +1,203 @@
<?php
namespace WellRESTed\Test\Unit\Message;
use WellRESTed\Message\NullStream;
use WellRESTed\Message\Request;
use WellRESTed\Message\Uri;
/**
* @covers WellRESTed\Message\Request
* @group message
*/
class RequestTest extends \PHPUnit_Framework_TestCase
{
// ------------------------------------------------------------------------
// Construction
public function testCreatesInstanceWithNoParameters()
{
$request = new Request();
$this->assertNotNull($request);
}
public function testCreatesInstanceWithUri()
{
$uri = new Uri();
$request = new Request($uri);
$this->assertSame($uri, $request->getUri());
}
public function testCreatesInstanceWithMethod()
{
$method = "POST";
$request = new Request(null, $method);
$this->assertSame($method, $request->getMethod());
}
public function testSetsHeadersOnConstruction()
{
$request = new Request(null, null, [
"X-foo" => ["bar","baz"]
]);
$this->assertEquals(["bar","baz"], $request->getHeader("X-foo"));
}
public function testSetsBodyOnConstruction()
{
$body = new NullStream();
$request = new Request(null, null, [], $body);
$this->assertSame($body, $request->getBody());
}
// ------------------------------------------------------------------------
// Request Target
public function testGetRequestTargetPrefersExplicitRequestTarget()
{
$request = new Request();
$request = $request->withRequestTarget("*");
$this->assertEquals("*", $request->getRequestTarget());
}
public function testGetRequestTargetUsesOriginFormOfUri()
{
$uri = new Uri('/my/path?cat=Molly&dog=Bear');
$request = new Request();
$request = $request->withUri($uri);
$this->assertEquals("/my/path?cat=Molly&dog=Bear", $request->getRequestTarget());
}
public function testGetRequestTargetReturnsSlashByDefault()
{
$request = new Request();
$this->assertEquals("/", $request->getRequestTarget());
}
public function testWithRequestTargetCreatesNewInstance()
{
$request = new Request();
$request = $request->withRequestTarget("*");
$this->assertEquals("*", $request->getRequestTarget());
}
// ------------------------------------------------------------------------
// Method
public function testGetMethodReturnsGetByDefault()
{
$request = new Request();
$this->assertEquals("GET", $request->getMethod());
}
public function testWithMethodCreatesNewInstance()
{
$request = new Request();
$request = $request->withMethod("POST");
$this->assertEquals("POST", $request->getMethod());
}
/**
* @dataProvider invalidMethodProvider
* @expectedException \InvalidArgumentException
*/
public function testWithMethodThrowsExceptionOnInvalidMethod($method)
{
$request = new Request();
$request->withMethod($method);
}
public function invalidMethodProvider()
{
return [
[0],
[false],
["WITH SPACE"]
];
}
// ------------------------------------------------------------------------
// Request URI
public function testGetUriReturnsEmptyUriByDefault()
{
$request = new Request();
$uri = new Uri();
$this->assertEquals($uri, $request->getUri());
}
public function testWithUriCreatesNewInstance()
{
$uri = new Uri();
$request = new Request();
$request = $request->withUri($uri);
$this->assertSame($uri, $request->getUri());
}
public function testWithUriPreservesOriginalRequest()
{
$uri1 = new Uri();
$uri2 = new Uri();
$request1 = new Request();
$request1 = $request1->withUri($uri1);
$request1 = $request1->withHeader("Accept", "application/json");
$request2 = $request1->withUri($uri2);
$request2 = $request2->withHeader("Accept", "text/plain");
$this->assertNotEquals($request1->getHeader("Accept"), $request2->getHeader("Accept"));
}
public function testWithUriUpdatesHostHeader()
{
$hostname = "bar.com";
$uri = new uri("http://$hostname");
$request = new Request();
$request = $request->withHeader("Host", "foo.com");
$request = $request->withUri($uri);
$this->assertSame([$hostname], $request->getHeader("Host"));
}
public function testWithUriDoesNotUpdatesHostHeaderWhenUriHasNoHost()
{
$hostname = "foo.com";
$uri = new Uri();
$request = new Request();
$request = $request->withHeader("Host", $hostname);
$request = $request->withUri($uri);
$this->assertSame([$hostname], $request->getHeader("Host"));
}
public function testPreserveHostUpdatesHostHeaderWhenHeaderIsOriginallyMissing()
{
$hostname = "foo.com";
$uri = new uri("http://$hostname");
$request = new Request();
$request = $request->withUri($uri, true);
$this->assertSame([$hostname], $request->getHeader("Host"));
}
public function testPreserveHostDoesNotUpdatesWhenBothAreMissingHosts()
{
$uri = new Uri();
$request = new Request();
$request = $request->withUri($uri, true);
$this->assertSame([], $request->getHeader("Host"));
}
public function testPreserveHostDoesNotUpdateHostHeader()
{
$hostname = "foo.com";
$uri = new uri("http://bar.com");
$request = new Request();
$request = $request->withHeader("Host", $hostname);
$request = $request->withUri($uri, true);
$this->assertSame([$hostname], $request->getHeader("Host"));
}
}

View File

@ -0,0 +1,112 @@
<?php
namespace WellRESTed\Test\Unit\Message;
use WellRESTed\Message\NullStream;
use WellRESTed\Message\Response;
/**
* @covers WellRESTed\Message\Response
* @group message
*/
class ResponseTest extends \PHPUnit_Framework_TestCase
{
// ------------------------------------------------------------------------
// Construction
public function testSetsStatusCodeOnConstruction()
{
$response = new Response(200);
$this->assertSame(200, $response->getStatusCode());
}
public function testSetsHeadersOnConstruction()
{
$response = new Response(200, [
"X-foo" => ["bar","baz"]
]);
$this->assertEquals(["bar","baz"], $response->getHeader("X-foo"));
}
public function testSetsBodyOnConstruction()
{
$body = new NullStream();
$response = new Response(200, [], $body);
$this->assertSame($body, $response->getBody());
}
// ------------------------------------------------------------------------
// Status and Reason Phrase
public function testCreatesNewInstanceWithStatusCode()
{
$response = new Response();
$copy = $response->withStatus(200);
$this->assertEquals(200, $copy->getStatusCode());
}
/** @dataProvider statusProvider */
public function testCreatesNewInstanceWithReasonPhrase($code, $reasonPhrase, $expected)
{
$response = new Response();
$copy = $response->withStatus($code, $reasonPhrase);
$this->assertEquals($expected, $copy->getReasonPhrase());
}
public function statusProvider()
{
return [
[100, null, "Continue"],
[101, null, "Switching Protocols"],
[200, null, "OK"],
[201, null, "Created"],
[202, null, "Accepted"],
[203, null, "Non-Authoritative Information"],
[204, null, "No Content"],
[205, null, "Reset Content"],
[206, null, "Partial Content"],
[300, null, "Multiple Choices"],
[301, null, "Moved Permanently"],
[302, null, "Found"],
[303, null, "See Other"],
[304, null, "Not Modified"],
[305, null, "Use Proxy"],
[400, null, "Bad Request"],
[401, null, "Unauthorized"],
[402, null, "Payment Required"],
[403, null, "Forbidden"],
[404, null, "Not Found"],
[405, null, "Method Not Allowed"],
[406, null, "Not Acceptable"],
[407, null, "Proxy Authentication Required"],
[408, null, "Request Timeout"],
[409, null, "Conflict"],
[410, null, "Gone"],
[411, null, "Length Required"],
[412, null, "Precondition Failed"],
[413, null, "Payload Too Large"],
[414, null, "URI Too Long"],
[415, null, "Unsupported Media Type"],
[500, null, "Internal Server Error"],
[501, null, "Not Implemented"],
[502, null, "Bad Gateway"],
[503, null, "Service Unavailable"],
[504, null, "Gateway Timeout"],
[505, null, "HTTP Version Not Supported"],
[598, null, ""],
[599, "Nonstandard", "Nonstandard"]
];
}
public function testWithStatusCodePreservesOriginalResponse()
{
$response1 = new Response();
$response1 = $response1->withStatus(200);
$response1 = $response1->withHeader("Content-type", "application/json");
$response2 = $response1->withStatus(404);
$response2 = $response2->withHeader("Content-type", "text/plain");
$this->assertNotEquals($response1->getStatusCode(), $response2->getHeader("Content-type"));
}
}

View File

@ -0,0 +1,660 @@
<?php
namespace WellRESTed\Test\Unit\Message;
use WellRESTed\Message\NullStream;
use WellRESTed\Message\ServerRequest;
use WellRESTed\Message\UploadedFile;
use WellRESTed\Message\Uri;
/**
* @covers WellRESTed\Message\ServerRequest
* @group message
*/
class ServerRequestTest extends \PHPUnit_Framework_TestCase
{
// ------------------------------------------------------------------------
// Construction and Marshalling
/** @preserveGlobalState disabled */
public function testGetServerRequestReadsFromRequest()
{
$_SERVER = [
"HTTP_HOST" => "localhost",
"HTTP_ACCEPT" => "application/json",
"HTTP_CONTENT_TYPE" => "application/x-www-form-urlencoded",
"QUERY_STRING" => "guinea_pig=Claude&hamster=Fizzgig"
];
$_COOKIE = [
"cat" => "Molly"
];
$_FILES = [];
$_POST = [
"dog" => "Bear"
];
$attributes = ["guinea_pig" => "Claude"];
$request = ServerRequest::getServerRequest($attributes);
$this->assertNotNull($request);
return $request;
}
// ------------------------------------------------------------------------
// Marshalling Request Information
/**
* @preserveGlobalState disabled
* @dataProvider protocolVersionProvider
*/
public function testGetServerRequestReadsProtocolVersion($expectedProtocol, $serverProtocol)
{
$_SERVER = [
"HTTP_HOST" => "localhost",
"SERVER_PROTOCOL" => $serverProtocol,
"REQUEST_METHOD" => "GET"
];
$request = ServerRequest::getServerRequest();
$this->assertEquals($expectedProtocol, $request->getProtocolVersion());
}
public function protocolVersionProvider()
{
return [
["1.1", "HTTP/1.1"],
["1.0", "HTTP/1.0"],
["1.1", null],
["1.1", "INVALID"]
];
}
/**
* @preserveGlobalState disabled
* @dataProvider methodProvider
*/
public function testGetServerRequestReadsMethod($exectedMethod, $serverMethod)
{
$_SERVER = [
"HTTP_HOST" => "localhost",
"REQUEST_METHOD" => $serverMethod
];
$request = ServerRequest::getServerRequest();
$this->assertEquals($exectedMethod, $request->getMethod());
}
public function methodProvider()
{
return [
["GET", "GET"],
["POST", "POST"],
["DELETE", "DELETE"],
["PUT", "PUT"],
["OPTIONS", "OPTIONS"],
["GET", null]
];
}
/**
* @preserveGlobalState disabled
* @dataProvider requestTargetProvider
*/
public function testGetServerRequestReadsRequestTargetFromRequest($exectedRequestTarget, $serverRequestUri)
{
$_SERVER = [
"HTTP_HOST" => "localhost",
"REQUEST_URI" => $serverRequestUri
];
$request = ServerRequest::getServerRequest();
$this->assertEquals($exectedRequestTarget, $request->getRequestTarget());
}
public function requestTargetProvider()
{
return [
["/", "/"],
["/hello", "/hello"],
["/my/path.txt", "/my/path.txt"],
["/", null]
];
}
/** @depends testGetServerRequestReadsFromRequest */
public function testGetServerRequestReadsHeaders($request)
{
/** @var ServerRequest $request */
$this->assertEquals(["application/json"], $request->getHeader("Accept"));
}
public function testGetServerRequestReadsBody()
{
$body = new NullStream();
$request = $this->getMockBuilder('WellRESTed\Message\ServerRequest')
->setMethods(["getStreamForBody"])
->getMock();
$request->expects($this->any())
->method("getStreamForBody")
->will($this->returnValue($body));
$called = false;
$callReadFromServerRequest = function () use (&$called) {
$called = true;
$this->readFromServerRequest();
};
$callReadFromServerRequest = $callReadFromServerRequest->bindTo($request, $request);
$callReadFromServerRequest();
$this->assertSame($body, $request->getBody());
}
/**
* @preserveGlobalState disabled
* @dataProvider uriProvider
*/
public function testGetServerRequestReadsUri($expected, $server)
{
$_SERVER = $server;
$request = ServerRequest::getServerRequest();
$this->assertEquals($expected, $request->getUri());
}
public function uriProvider()
{
return [
[
new Uri("http://localhost/path"),
[
"HTTPS" => "off",
"HTTP_HOST" => "localhost",
"REQUEST_URI" => "/path",
"QUERY_STRING" => ""
]
],
[
new Uri("https://foo.com/path/to/stuff?cat=molly"),
[
"HTTPS" => "1",
"HTTP_HOST" => "foo.com",
"REQUEST_URI" => "/path/to/stuff?cat=molly",
"QUERY_STRING" => "cat=molly"
]
],
[
new Uri("http://foo.com:8080/path/to/stuff?cat=molly"),
[
"HTTP" => "1",
"HTTP_HOST" => "foo.com:8080",
"REQUEST_URI" => "/path/to/stuff?cat=molly",
"QUERY_STRING" => "cat=molly"
]
]
];
}
// ------------------------------------------------------------------------
// Marshalling ServerRequest Information
/** @depends testGetServerRequestReadsFromRequest */
public function testGetServerRequestReadsServerParams($request)
{
/** @var ServerRequest $request */
$this->assertEquals("localhost", $request->getServerParams()["HTTP_HOST"]);
}
/** @depends testGetServerRequestReadsFromRequest */
public function testGetServerRequestReadsCookieParams($request)
{
/** @var ServerRequest $request */
$this->assertEquals("Molly", $request->getCookieParams()["cat"]);
}
/** @depends testGetServerRequestReadsFromRequest */
public function testGetServerRequestReadsQueryParams($request)
{
/** @var ServerRequest $request */
$this->assertEquals("Claude", $request->getQueryParams()["guinea_pig"]);
}
/**
* @preserveGlobalState disabled
* @dataProvider uploadedFileProvider
*/
public function testGetServerRequestReadsUploadedFiles($file, $path)
{
$_SERVER = [
"HTTP_HOST" => "localhost",
"HTTP_ACCEPT" => "application/json",
"HTTP_CONTENT_TYPE" => "application/x-www-form-urlencoded"
];
$_FILES = [
"single" => [
"name" => "single.txt",
"type" => "text/plain",
"tmp_name" => "/tmp/php9hNlHe",
"error" => UPLOAD_ERR_OK,
"size" => 524
],
"nested" => [
"level2" => [
"name" => "nested.json",
"type" => "application/json",
"tmp_name" => "/tmp/phpadhjk",
"error" => UPLOAD_ERR_OK,
"size" => 1024
]
],
"nestedList" => [
"level2" => [
"name" => [
0 => "nestedList0.jpg",
1 => "nestedList1.jpg",
2 => ""
],
"type" => [
0 => "image/jpeg",
1 => "image/jpeg",
2 => ""
],
"tmp_name" => [
0 => "/tmp/phpjpg0",
1 => "/tmp/phpjpg1",
2 => ""
],
"error" => [
0 => UPLOAD_ERR_OK,
1 => UPLOAD_ERR_OK,
2 => UPLOAD_ERR_NO_FILE
],
"size" => [
0 => 256,
1 => 4096,
2 => 0
]
]
],
"nestedDictionary" => [
"level2" => [
"name" => [
"file0" => "nestedDictionary0.jpg",
"file1" => "nestedDictionary1.jpg"
],
"type" => [
"file0" => "image/png",
"file1" => "image/png"
],
"tmp_name" => [
"file0" => "/tmp/phppng0",
"file1" => "/tmp/phppng1"
],
"error" => [
"file0" => UPLOAD_ERR_OK,
"file1" => UPLOAD_ERR_OK
],
"size" => [
"file0" => 256,
"file1" => 4096
]
]
]
];
$request = ServerRequest::getServerRequest();
$current = $request->getUploadedFiles();
foreach ($path as $item) {
$current = $current[$item];
}
$this->assertEquals($file, $current);
}
public function uploadedFileProvider()
{
return [
[new UploadedFile("single.txt", "text/plain", 524, "/tmp/php9hNlHe", UPLOAD_ERR_OK), ["single"]],
[new UploadedFile("nested.json", "application/json", 1024, "/tmp/phpadhjk", UPLOAD_ERR_OK), ["nested", "level2"]],
[new UploadedFile("nestedList0.jpg", "image/jpeg", 256, "/tmp/phpjpg0", UPLOAD_ERR_OK), ["nestedList", "level2", 0]],
[new UploadedFile("nestedList1.jpg", "image/jpeg", 4096, "/tmp/phpjpg1", UPLOAD_ERR_OK), ["nestedList", "level2", 1]],
[new UploadedFile("", "", 0, "", UPLOAD_ERR_NO_FILE), ["nestedList", "level2", 2]],
[new UploadedFile("nestedDictionary0.jpg", "image/png", 256, "/tmp/phppng0", UPLOAD_ERR_OK), ["nestedDictionary", "level2", "file0"]],
[new UploadedFile("nestedDictionary1.jpg", "image/png", 4096, "/tmp/phppngg1", UPLOAD_ERR_OK), ["nestedDictionary", "level2", "file1"]]
];
}
/**
* @preserveGlobalState disabled
* @dataProvider formContentTypeProvider
*/
public function testGetServerRequestParsesFormBody($contentType)
{
$_SERVER = [
"HTTP_HOST" => "localhost",
"HTTP_CONTENT_TYPE" => $contentType,
];
$_COOKIE = [];
$_FILES = [];
$_POST = [
"dog" => "Bear"
];
$request = ServerRequest::getServerRequest();
$this->assertEquals("Bear", $request->getParsedBody()["dog"]);
}
public function formContentTypeProvider()
{
return [
["application/x-www-form-urlencoded"],
["multipart/form-data"]
];
}
/** @depends testGetServerRequestReadsFromRequest */
public function testGetServerRequestProvidesAttributesIfPassed($request)
{
/** @var ServerRequest $request */
$this->assertEquals("Claude", $request->getAttribute("guinea_pig"));
}
// ------------------------------------------------------------------------
// Server Params
public function testGetServerParamsReturnsEmptyArrayByDefault()
{
$request = new ServerRequest();
$this->assertEquals([], $request->getServerParams());
}
// ------------------------------------------------------------------------
// Cookies
public function testGetCookieParamsReturnsEmptyArrayByDefault()
{
$request = new ServerRequest();
$this->assertEquals([], $request->getCookieParams());
}
/** @depends testGetServerRequestReadsFromRequest */
public function testWithCookieParamsCreatesNewInstance($request1)
{
/** @var ServerRequest $request1 */
$request2 = $request1->withCookieParams([
"cat" => "Oscar"
]);
$this->assertNotEquals($request1->getCookieParams()["cat"], $request2->getCookieParams()["cat"]);
}
// ------------------------------------------------------------------------
// Query
public function testGetQueryParamsReturnsEmptyArrayByDefault()
{
$request = new ServerRequest();
$this->assertEquals([], $request->getQueryParams());
}
/** @depends testGetServerRequestReadsFromRequest */
public function testWithQueryParamsCreatesNewInstance($request1)
{
/** @var ServerRequest $request1 */
$request2 = $request1->withQueryParams([
"guinea_pig" => "Clyde"
]);
$this->assertNotEquals($request1->getQueryParams()["guinea_pig"], $request2->getQueryParams()["guinea_pig"]);
}
// ------------------------------------------------------------------------
// Uploaded Files
public function testGetUploadedFilesReturnsEmptyArrayByDefault()
{
$request = new ServerRequest();
$this->assertEquals([], $request->getUploadedFiles());
}
/** @preserveGlobalState disabled */
public function testGetUploadedFilesReturnsEmptyArrayWhenNoFilesAreUploaded()
{
$_SERVER = [
"HTTP_HOST" => "localhost",
"HTTP_ACCEPT" => "application/json",
"HTTP_CONTENT_TYPE" => "application/x-www-form-urlencoded"
];
$_FILES = [];
$request = ServerRequest::getServerRequest();
$this->assertSame([], $request->getUploadedFiles());
}
public function testWithUploadedFilesCreatesNewInstance()
{
$uploadedFiles = [
"file" => new UploadedFile("index.html", "text/html", 524, "/tmp/php9hNlHe", 0)
];
$request = new ServerRequest();
$request1 = $request->withUploadedFiles([]);
$request2 = $request1->withUploadedFiles($uploadedFiles);
$this->assertNotSame($request2, $request1);
}
/** @dataProvider validUploadedFilesProvider */
public function testWithUploadedFilesStoresPassedUploadedFiles($uploadedFiles)
{
$request = new ServerRequest();
$request = $request->withUploadedFiles($uploadedFiles);
$this->assertSame($uploadedFiles, $request->getUploadedFiles());
}
public function validUploadedFilesProvider()
{
return [
[[]],
[["files" => new UploadedFile("index.html", "text/html", 524, "/tmp/php9hNlHe", 0)]],
[["nested" => [
"level2" => new UploadedFile("index.html", "text/html", 524, "/tmp/php9hNlHe", 0)
]]],
[["nestedList" => [
"level2" => [
new UploadedFile("file1.html", "text/html", 524, "/tmp/php9hNlHe", 0),
new UploadedFile("file2.html", "text/html", 524, "/tmp/php9hNshj", 0)
]
]]],
[["nestedDictionary" => [
"level2" => [
"file1" => new UploadedFile("file1.html", "text/html", 524, "/tmp/php9hNlHe", 0),
"file2" => new UploadedFile("file2.html", "text/html", 524, "/tmp/php9hNshj", 0)
]
]]]
];
}
/**
* @expectedException \InvalidArgumentException
* @dataProvider invalidUploadedFilesProvider
*/
public function testWithUploadedFilesThrowsExceptionWithInvalidTree($uploadedFiles)
{
$request = new ServerRequest();
$request->withUploadedFiles($uploadedFiles);
}
public function invalidUploadedFilesProvider()
{
return [
// All keys must be strings
[[new UploadedFile("index.html", "text/html", 524, "/tmp/php9hNlHe", 0)]],
[
[new UploadedFile("index1.html", "text/html", 524, "/tmp/php9hNlHe", 0)],
[new UploadedFile("index2.html", "text/html", 524, "/tmp/php9hNlHe", 0)]
],
[
"single" => [
"name" => "single.txt",
"type" => "text/plain",
"tmp_name" => "/tmp/php9hNlHe",
"error" => UPLOAD_ERR_OK,
"size" => 524
],
"nested" => [
"level2" => [
"name" => "nested.json",
"type" => "application/json",
"tmp_name" => "/tmp/phpadhjk",
"error" => UPLOAD_ERR_OK,
"size" => 1024
]
]
],
[
"nestedList" => [
"level2" => [
"name" => [
0 => "nestedList0.jpg",
1 => "nestedList1.jpg",
2 => ""
],
"type" => [
0 => "image/jpeg",
1 => "image/jpeg",
2 => ""
],
"tmp_name" => [
0 => "/tmp/phpjpg0",
1 => "/tmp/phpjpg1",
2 => ""
],
"error" => [
0 => UPLOAD_ERR_OK,
1 => UPLOAD_ERR_OK,
2 => UPLOAD_ERR_NO_FILE
],
"size" => [
0 => 256,
1 => 4096,
2 => 0
]
]
]
]
];
}
// ------------------------------------------------------------------------
// Parsed Body
public function testGetParsedBodyReturnsNullByDefault()
{
$request = new ServerRequest();
$this->assertNull($request->getParsedBody());
}
/** @depends testGetServerRequestReadsFromRequest */
public function testWithParsedBodyCreatesNewInstance($request1)
{
/** @var ServerRequest $request1 */
$body1 = $request1->getParsedBody();
$request2 = $request1->withParsedBody([
"guinea_pig" => "Clyde"
]);
$body2 = $request2->getParsedBody();
$this->assertNotSame($body1, $body2);
}
/**
* @expectedException \InvalidArgumentException
* @dataProvider invalidParsedBodyProvider
*/
public function testWithParsedBodyThrowsExceptionWithInvalidType($body)
{
$request = new ServerRequest();
$request->withParsedBody($body);
}
public function invalidParsedBodyProvider()
{
return [
[false],
[1]
];
}
public function testCloneMakesDeepCopiesOfParsedBody()
{
$body = (object) [
"cat" => "Dog"
];
$request1 = new ServerRequest();
$request1 = $request1->withParsedBody($body);
$request2 = $request1->withHeader("X-extra", "hello world");
$this->assertTrue(
$request1->getParsedBody() == $request2->getParsedBody()
&& $request1->getParsedBody() !== $request2->getParsedBody()
);
}
// ------------------------------------------------------------------------
// Attributes
public function testGetAttributesReturnsEmptyArrayByDefault()
{
$request = new ServerRequest();
$this->assertEquals([], $request->getAttributes());
}
public function testGetAttributesReturnsAllAttributes()
{
$request = new ServerRequest();
$request = $request->withAttribute("cat", "Molly");
$request = $request->withAttribute("dog", "Bear");
$expected = [
"cat" => "Molly",
"dog" => "Bear"
];
$this->assertEquals($expected, $request->getAttributes());
}
public function testGetAttributeReturnsDefaultIfNotSet()
{
$request = new ServerRequest();
$this->assertEquals("Oscar", $request->getAttribute("cat", "Oscar"));
}
public function testWithAttributeCreatesNewInstance()
{
$request = new ServerRequest();
$request = $request->withAttribute("cat", "Molly");
$this->assertEquals("Molly", $request->getAttribute("cat"));
}
public function testWithAttributePreserversOtherAttributes()
{
$request = new ServerRequest();
$request = $request->withAttribute("cat", "Molly");
$request = $request->withAttribute("dog", "Bear");
$expected = [
"cat" => "Molly",
"dog" => "Bear"
];
$this->assertEquals($expected, $request->getAttributes());
}
public function testWithoutAttributeCreatesNewInstance()
{
$request = new ServerRequest();
$request = $request->withAttribute("cat", "Molly");
$this->assertNotEquals($request, $request->withoutAttribute("cat"));
}
public function testWithoutAttributeRemovesAttribute()
{
$request = new ServerRequest();
$request = $request->withAttribute("cat", "Molly");
$request = $request->withoutAttribute("cat");
$this->assertEquals("Oscar", $request->getAttribute("cat", "Oscar"));
}
public function testWithoutAttributePreservesOtherAttributes()
{
$request = new ServerRequest();
$request = $request->withAttribute("cat", "Molly");
$request = $request->withAttribute("dog", "Bear");
$request = $request->withoutAttribute("cat");
$this->assertEquals("Bear", $request->getAttribute("dog"));
}
}

View File

@ -0,0 +1,233 @@
<?php
namespace WellRESTed\Test\Unit\Message;
use WellRESTed\Message\Stream;
/**
* @covers WellRESTed\Message\Stream
* @group message
*/
class StreamTest extends \PHPUnit_Framework_TestCase
{
private $resource;
private $content = "Hello, world!";
public function setUp()
{
$this->resource = fopen("php://memory", "w+");
fwrite($this->resource, $this->content);
}
public function tearDown()
{
if (is_resource($this->resource)) {
fclose($this->resource);
}
}
public function testCreatesInstanceWithStreamResource()
{
$stream = new \WellRESTed\Message\Stream($this->resource);
$this->assertNotNull($stream);
}
public function testCreatesInstanceWithString()
{
$stream = new \WellRESTed\Message\Stream("Hello, world!");
$this->assertNotNull($stream);
}
/**
* @expectedException \InvalidArgumentException
* @dataProvider invalidResourceProvider
*/
public function testThrowsExceptiondWithInvalidResource($resource)
{
new \WellRESTed\Message\Stream($resource);
}
public function invalidResourceProvider()
{
return [
[null],
[true],
[4],
[[]]
];
}
public function testCastsToString()
{
$stream = new \WellRESTed\Message\Stream($this->resource);
$this->assertEquals($this->content, (string) $stream);
}
public function testClosesHandle()
{
$stream = new Stream($this->resource);
$stream->close();
$this->assertFalse(is_resource($this->resource));
}
public function testDetachReturnsHandle()
{
$stream = new Stream($this->resource);
$this->assertSame($this->resource, $stream->detach());
}
public function testDetachUnsetsInstanceVariable()
{
$stream = new \WellRESTed\Message\Stream($this->resource);
$stream->detach();
$this->assertNull($stream->detach());
}
public function testReturnsSize()
{
$stream = new \WellRESTed\Message\Stream($this->resource);
$this->assertEquals(strlen($this->content), $stream->getSize());
}
public function testTellReturnsHandlePosition()
{
$stream = new \WellRESTed\Message\Stream($this->resource);
fseek($this->resource, 10);
$this->assertEquals(10, $stream->tell());
}
public function testReturnsOef()
{
$stream = new Stream($this->resource);
$stream->rewind();
$stream->getContents();
$this->assertTrue($stream->eof());
}
public function testReadsSeekableStatusFromMetadata()
{
$stream = new \WellRESTed\Message\Stream($this->resource);
$metadata = stream_get_meta_data($this->resource);
$seekable = $metadata["seekable"] == 1;
$this->assertEquals($seekable, $stream->isSeekable());
}
public function testSeeksToPosition()
{
$stream = new \WellRESTed\Message\Stream($this->resource);
$stream->seek(10);
$this->assertEquals(10, ftell($this->resource));
}
public function testRewindReturnsToBeginning()
{
$stream = new Stream($this->resource);
$stream->seek(10);
$stream->rewind();
$this->assertEquals(0, ftell($this->resource));
}
public function testWritesToHandle()
{
$message = "\nThis is a stream.";
$stream = new \WellRESTed\Message\Stream($this->resource);
$stream->write($message);
$this->assertEquals($this->content . $message, (string) $stream);
}
/** @expectedException \RuntimeException */
public function testThrowsExceptionOnErrorWriting()
{
$filename = tempnam(sys_get_temp_dir(), "php");
$handle = fopen($filename, "r");
$stream = new \WellRESTed\Message\Stream($handle);
$stream->write("Hello, world!");
}
/** @expectedException \RuntimeException */
public function testThrowsExceptionOnErrorReading()
{
$filename = tempnam(sys_get_temp_dir(), "php");
$handle = fopen($filename, "w");
$stream = new \WellRESTed\Message\Stream($handle);
$stream->read(10);
}
public function testReadsFromStream()
{
$stream = new \WellRESTed\Message\Stream($this->resource);
$stream->seek(7);
$string = $stream->read(5);
$this->assertEquals("world", $string);
}
/** @expectedException \RuntimeException */
public function testThrowsExceptionOnErrorReadingToEnd()
{
$filename = tempnam(sys_get_temp_dir(), "php");
$handle = fopen($filename, "w");
$stream = new \WellRESTed\Message\Stream($handle);
$stream->getContents();
}
public function testReadsToEnd()
{
$stream = new Stream($this->resource);
$stream->seek(7);
$string = $stream->getContents();
$this->assertEquals("world!", $string);
}
public function testReturnsMetadataArray()
{
$stream = new \WellRESTed\Message\Stream($this->resource);
$this->assertEquals(stream_get_meta_data($this->resource), $stream->getMetadata());
}
public function testReturnsMetadataItem()
{
$stream = new Stream($this->resource);
$metadata = stream_get_meta_data($this->resource);
$this->assertEquals($metadata["mode"], $stream->getMetadata("mode"));
}
/** @dataProvider modeProvider */
public function testReturnsIsReadableForReadableStreams($mode, $readable, $writeable)
{
$tmp = tempnam(sys_get_temp_dir(), "php");
if ($mode[0] === "x") {
unlink($tmp);
}
$resource = fopen($tmp, $mode);
$stream = new Stream($resource);
$this->assertEquals($readable, $stream->isReadable());
}
/** @dataProvider modeProvider */
public function testReturnsIsWritableForWritableStreams($mode, $readable, $writeable)
{
$tmp = tempnam(sys_get_temp_dir(), "php");
if ($mode[0] === "x") {
unlink($tmp);
}
$resource = fopen($tmp, $mode);
$stream = new \WellRESTed\Message\Stream($resource);
$this->assertEquals($writeable, $stream->isWritable());
}
public function modeProvider()
{
return [
["r", true, false],
["r+", true, true],
["w", false, true],
["w+", true, true],
["a", false, true],
["a+", true, true],
["x", false, true],
["x+", true, true],
["c", false, true],
["c+", true, true]
];
}
}

View File

@ -0,0 +1,157 @@
<?php
namespace WellRESTed\Test\Unit\Message;
use WellRESTed\Message\UploadedFile;
use WellRESTed\Message\UploadedFileState;
// Hides several php core functions for testing.
require_once __DIR__ . "/../../../src/UploadedFileState.php";
/**
* @covers WellRESTed\Message\UploadedFile
* @group message
*/
class UploadedFileTest extends \PHPUnit_Framework_TestCase
{
private $tmpName;
private $movePath;
public function setUp()
{
parent::setUp();
UploadedFileState::$php_sapi_name = "cli";
$this->tmpName = tempnam(sys_get_temp_dir(), "tst");
$this->movePath = tempnam(sys_get_temp_dir(), "tst");
}
public function tearDown()
{
parent::tearDown();
if (file_exists($this->tmpName)) {
unlink($this->tmpName);
}
if (file_exists($this->movePath)) {
unlink($this->movePath);
}
}
// ------------------------------------------------------------------------
// getStream
public function testGetStreamReturnsStreamInterface()
{
$file = new UploadedFile("", "", 0, "", 0);
$this->assertInstanceOf('\Psr\Http\Message\StreamInterface', $file->getStream());
}
public function testGetStreamReturnsStreamWrappingUploadedFile()
{
$content = "Hello, World!";
file_put_contents($this->tmpName, $content);
$file = new UploadedFile("", "", 0, $this->tmpName, "");
$stream = $file->getStream();
$this->assertEquals($content, (string) $stream);
}
public function testGetStreamReturnsEmptyStreamForNoFile()
{
$file = new UploadedFile("", "", 0, "", 0);
$this->assertTrue($file->getStream()->eof());
}
/** @expectedException \RuntimeException */
public function testGetStreamThrowsExceptionAfterMoveTo()
{
$content = "Hello, World!";
file_put_contents($this->tmpName, $content);
$file = new UploadedFile("", "", 0, $this->tmpName, "");
$file->moveTo($this->movePath);
$file->getStream();
}
/** @expectedException \RuntimeException */
public function testGetStreamThrowsExceptionForNonUploadedFile()
{
UploadedFileState::$php_sapi_name = "apache";
UploadedFileState::$is_uploaded_file = false;
$file = new UploadedFile("", "", 0, "", 0);
$file->getStream();
}
// ------------------------------------------------------------------------
// moveTo
public function testMoveToSapiRelocatesUploadedFileToDestiationIfExists()
{
UploadedFileState::$php_sapi_name = "fpm-fcgi";
$content = "Hello, World!";
file_put_contents($this->tmpName, $content);
$originalMd5 = md5_file($this->tmpName);
$file = new UploadedFile("", "", 0, $this->tmpName, "");
$file->moveTo($this->movePath);
$this->assertEquals($originalMd5, md5_file($this->movePath));
}
public function testMoveToNonSapiRelocatesUploadedFileToDestiationIfExists()
{
$content = "Hello, World!";
file_put_contents($this->tmpName, $content);
$originalMd5 = md5_file($this->tmpName);
$file = new UploadedFile("", "", 0, $this->tmpName, "");
$file->moveTo($this->movePath);
$this->assertEquals($originalMd5, md5_file($this->movePath));
}
/** @expectedException \RuntimeException */
public function testMoveToThrowsExceptionOnSubsequentCall()
{
$content = "Hello, World!";
file_put_contents($this->tmpName, $content);
$file = new UploadedFile("", "", 0, $this->tmpName, "");
$file->moveTo($this->movePath);
$file->moveTo($this->movePath);
}
// ------------------------------------------------------------------------
// getSize
public function testGetSizeReturnsSize()
{
$file = new UploadedFile("", "", 1024, "", 0);
$this->assertEquals(1024, $file->getSize());
}
// ------------------------------------------------------------------------
// getError
public function testGetErrorReturnsError()
{
$file = new UploadedFile("", "", 1024, "", UPLOAD_ERR_INI_SIZE);
$this->assertEquals(UPLOAD_ERR_INI_SIZE, $file->getError());
}
// ------------------------------------------------------------------------
// clientFilename
public function testGetClientFilenameReturnsClientFilename()
{
$file = new UploadedFile("clientFilename", "", 0, "", 0);
$this->assertEquals("clientFilename", $file->getClientFilename());
}
// ------------------------------------------------------------------------
// clientMediaType
public function testGetClientMediaTypeReturnsClientMediaType()
{
$file = new UploadedFile("", "clientMediaType", 0, "", 0);
$this->assertEquals("clientMediaType", $file->getClientMediaType());
}
}

View File

@ -0,0 +1,587 @@
<?php
namespace WellRESTed\Test\Unit\Message;
use WellRESTed\Message\Uri;
/**
* @covers WellRESTed\Message\Uri
* @group message
*/
class UriTest extends \PHPUnit_Framework_TestCase
{
// ------------------------------------------------------------------------
// Scheme
public function testDefaultSchemeIsEmpty()
{
$uri = new Uri();
$this->assertSame("", $uri->getScheme());
}
/** @dataProvider schemeProvider */
public function testSetsSchemeCaseInsensitively($expected, $scheme)
{
$uri = new Uri();
$uri = $uri->withScheme($scheme);
$this->assertSame($expected, $uri->getScheme());
}
public function schemeProvider()
{
return [
["http", "http"],
["https", "https"],
["http", "HTTP"],
["https", "HTTPS"],
["", null],
["", ""]
];
}
/** @expectedException \InvalidArgumentException */
public function testInvalidSchemeThrowsException()
{
$uri = new Uri();
$uri->withScheme("gopher");
}
// ------------------------------------------------------------------------
// Authority
public function testDefaultAuthorityIsEmpty()
{
$uri = new Uri();
$this->assertSame("", $uri->getAuthority());
}
public function testRespectsMyAuthoritah()
{
$this->assertTrue(true);
}
/** @dataProvider authorityProvider */
public function testConcatenatesAuthorityFromHostAndUserInfo($expected, $components)
{
$uri = new Uri();
if (isset($components["scheme"])) {
$uri = $uri->withScheme($components["scheme"]);
}
if (isset($components["user"])) {
$user = $components["user"];
$password = null;
if (isset($components["password"])) {
$password = $components["password"];
}
$uri = $uri->withUserInfo($user, $password);
}
if (isset($components["host"])) {
$uri = $uri->withHost($components["host"]);
}
if (isset($components["port"])) {
$uri = $uri->withPort($components["port"]);
}
$this->assertEquals($expected, $uri->getAuthority());
}
public function authorityProvider()
{
return [
[
"localhost",
[
"host" => "localhost"
]
],
[
"user@localhost",
[
"host" => "localhost",
"user" => "user"
]
],
[
"user:password@localhost",
[
"host" => "localhost",
"user" => "user",
"password" => "password"
]
],
[
"localhost",
[
"host" => "localhost",
"password" => "password"
]
],
[
"localhost",
[
"scheme" => "http",
"host" => "localhost",
"port" => 80
]
],
[
"localhost",
[
"scheme" => "https",
"host" => "localhost",
"port" => 443
]
],
[
"localhost:4430",
[
"scheme" => "https",
"host" => "localhost",
"port" => 4430
]
],
[
"localhost:8080",
[
"scheme" => "http",
"host" => "localhost",
"port" => 8080
]
],
[
"user:password@localhost:4430",
[
"scheme" => "https",
"user" => "user",
"password" => "password",
"host" => "localhost",
"port" => 4430
]
],
];
}
// ------------------------------------------------------------------------
// User Info
public function testDefaultUserInfoIsEmpty()
{
$uri = new Uri();
$this->assertSame("", $uri->getUserInfo());
}
/**
* @dataProvider userInfoProvider
*
* @param string $expected The combined user:password value
* @param string $user The username to set
* @param string $password The password to set
*/
public function testSetsUserInfo($expected, $user, $password)
{
$uri = new Uri();
$uri = $uri->withUserInfo($user, $password);
$this->assertSame($expected, $uri->getUserInfo());
}
public function userInfoProvider()
{
return [
["user:password", "user", "password"],
["user", "user", ""],
["user", "user", null],
["", "", "password"],
["", "", ""]
];
}
// ------------------------------------------------------------------------
// Host
public function testDefaultHostIsEmpty()
{
$uri = new Uri();
$this->assertSame("", $uri->getHost());
}
/** @dataProvider hostProvider */
public function testSetsHost($expected, $host)
{
$uri = new Uri();
$uri = $uri->withHost($host);
$this->assertSame($expected, $uri->getHost());
}
public function hostProvider()
{
return [
["", ""],
["localhost", "localhost"],
["localhost", "LOCALHOST"],
["foo.com", "FOO.com"]
];
}
/**
* @expectedException \InvalidArgumentException
* @dataProvider invalidHostProvider
*/
public function testInvalidHostThrowsException($host)
{
$uri = new Uri();
$uri->withHost($host);
}
public function invalidHostProvider()
{
return [
[null],
[false],
[0]
];
}
// ------------------------------------------------------------------------
// Port
public function testDefaultPortWithNoSchemeIsNull()
{
$uri = new Uri();
$this->assertNull($uri->getPort());
}
public function testDefaultPortForHttpSchemeIs80()
{
$uri = new Uri();
$this->assertSame(80, $uri->withScheme("http")->getPort());
}
public function testDefaultPortForHttpsSchemeIs443()
{
$uri = new Uri();
$this->assertSame(443, $uri->withScheme("https")->getPort());
}
/** @dataProvider portAndSchemeProvider */
public function testReturnsPortWithSchemeDefaults($expectedPort, $scheme, $port)
{
$uri = new Uri();
$uri = $uri->withScheme($scheme)->withPort($port);
$this->assertSame($expectedPort, $uri->getPort());
}
public function portAndSchemeProvider()
{
return [
[null, "", null],
[80, "http", null],
[443, "https", null],
[8080, "", 8080],
[8080, "http", "8080"],
[8080, "https", 8080.0]
];
}
/**
* @expectedException \InvalidArgumentException
* @dataProvider invalidPortProvider
*/
public function testInvalidPortThrowsException($port)
{
$uri = new Uri();
$uri->withPort($port);
}
public function invalidPortProvider()
{
return [
[true],
[-1],
[65536],
["dog"]
];
}
// ------------------------------------------------------------------------
// Path
public function testDefaultPathIsEmpty()
{
$uri = new Uri();
$this->assertSame("", $uri->getPath());
}
/** @dataProvider pathProvider */
public function testSetsEncodedPath($expected, $path)
{
$uri = new Uri();
$uri = $uri->withPath($path);
$this->assertSame($expected, $uri->getPath());
}
/** @dataProvider pathProvider */
public function testDoesNotDoubleEncodePath($expected, $path)
{
$uri = new Uri();
$uri = $uri->withPath($path);
$uri = $uri->withPath($uri->getPath());
$this->assertSame($expected, $uri->getPath());
}
public function pathProvider()
{
return [
["", ""],
["/", "/"],
["*", "*"],
["/my/path", "/my/path"],
["/encoded%2Fslash", "/encoded%2Fslash"],
["/percent/%25", "/percent/%"],
["/%C3%A1%C3%A9%C3%AD%C3%B3%C3%BA", "/áéíóú"]
];
}
// ------------------------------------------------------------------------
// Query
public function testDefaultQueryIsEmpty()
{
$uri = new Uri();
$this->assertSame("", $uri->getQuery());
}
/** @dataProvider queryProvider */
public function testSetsEncodedQuery($expected, $query)
{
$uri = new Uri();
$uri = $uri->withQuery($query);
$this->assertSame($expected, $uri->getQuery());
}
/** @dataProvider queryProvider */
public function testDoesNotDoubleEncodeQuery($expected, $query)
{
$uri = new Uri();
$uri = $uri->withQuery($query);
$uri = $uri->withQuery($uri->getQuery($query));
$this->assertSame($expected, $uri->getQuery());
}
public function queryProvider()
{
return [
["cat=molly", "cat=molly"],
["cat=molly&dog=bear", "cat=molly&dog=bear"],
["accents=%C3%A1%C3%A9%C3%AD%C3%B3%C3%BA", "accents=áéíóú"]
];
}
/**
* @expectedException \InvalidArgumentException
* @dataProvider invalidPathProvider
*/
public function testInvalidPathThrowsException($path)
{
$uri = new Uri();
$uri->withPath($path);
}
public function invalidPathProvider()
{
return [
[null],
[false],
[0]
];
}
// ------------------------------------------------------------------------
// Fragment
public function testDefaultFragmentIsEmpty()
{
$uri = new Uri();
$this->assertSame("", $uri->getFragment());
}
/** @dataProvider fragmentProvider */
public function testSetsEncodedFragment($expected, $fragment)
{
$uri = new Uri();
$uri = $uri->withFragment($fragment);
$this->assertSame($expected, $uri->getFragment());
}
/** @dataProvider fragmentProvider */
public function testDoesNotDoubleEncodeFragment($expected, $fragment)
{
$uri = new Uri();
$uri = $uri->withFragment($fragment);
$uri = $uri->withFragment($uri->getFragment($fragment));
$this->assertSame($expected, $uri->getFragment());
}
public function fragmentProvider()
{
return [
["", null],
["molly", "molly"],
["%C3%A1%C3%A9%C3%AD%C3%B3%C3%BA", "áéíóú"]
];
}
// ------------------------------------------------------------------------
// Concatenation
/** @dataProvider componentProvider */
public function testConcatenatesComponents($expected, $components)
{
$uri = new Uri();
if (isset($components["scheme"])) {
$uri = $uri->withScheme($components["scheme"]);
}
if (isset($components["user"])) {
$user = $components["user"];
$password = null;
if (isset($components["password"])) {
$password = $components["password"];
}
$uri = $uri->withUserInfo($user, $password);
}
if (isset($components["host"])) {
$uri = $uri->withHost($components["host"]);
}
if (isset($components["port"])) {
$uri = $uri->withPort($components["port"]);
}
if (isset($components["path"])) {
$uri = $uri->withPath($components["path"]);
}
if (isset($components["query"])) {
$uri = $uri->withQuery($components["query"]);
}
if (isset($components["fragment"])) {
$uri = $uri->withFragment($components["fragment"]);
}
$this->assertEquals($expected, (string) $uri);
}
public function componentProvider()
{
return [
[
"http://localhost/path",
[
"scheme" => "http",
"host" => "localhost",
"path" => "/path"
]
],
[
"//localhost/path",
[
"host" => "localhost",
"path" => "/path"
]
],
[
"/path",
[
"path" => "/path"
]
],
[
"/path?cat=molly&dog=bear",
[
"path" => "/path",
"query" => "cat=molly&dog=bear"
]
],
[
"/path?cat=molly&dog=bear#fragment",
[
"path" => "/path",
"query" => "cat=molly&dog=bear",
"fragment" => "fragment"
]
],
[
"https://user:password@localhost:4430/path?cat=molly&dog=bear#fragment",
[
"scheme" => "https",
"user" => "user",
"password" => "password",
"host" => "localhost",
"port" => 4430,
"path" => "/path",
"query" => "cat=molly&dog=bear",
"fragment" => "fragment"
]
],
// Asterisk Form
[
"*",
[
"path" => "*"
]
],
];
}
/** @dataProvider stringUriProvider */
public function testUriCreatedFromStringNormalizesString($expected, $input)
{
$uri = new Uri($input);
$this->assertSame($expected, (string) $uri);
}
public function stringUriProvider()
{
return [
[
"http://localhost/path",
"http://localhost:80/path"
],
[
"https://localhost/path",
"https://localhost:443/path"
],
[
"https://my.sub.sub.domain.com/path",
"https://my.sub.sub.domain.com/path"
],
[
"https://user:password@localhost:4430/path?cat=molly&dog=bear#fragment",
"https://user:password@localhost:4430/path?cat=molly&dog=bear#fragment"
],
[
"/path",
"/path"
],
[
"//double/slash",
"//double/slash"
],
[
"no/slash",
"no/slash"
],
[
"*",
"*"
]
];
}
}

View File

@ -1,15 +1,20 @@
<?php <?php
namespace WellRESTed\Routing\Route; namespace WellRESTed\Test\Unit\Routing;
use Prophecy\Argument;
use WellRESTed\Dispatching\Dispatcher; use WellRESTed\Dispatching\Dispatcher;
use WellRESTed\Message\Response; use WellRESTed\Message\Response;
use WellRESTed\Message\ServerRequest; use WellRESTed\Message\ServerRequest;
use WellRESTed\Routing\MethodMap;
use WellRESTed\Test\Doubles\MiddlewareMock; use WellRESTed\Test\Doubles\MiddlewareMock;
use WellRESTed\Test\Doubles\NextMock; use WellRESTed\Test\Doubles\NextMock;
use WellRESTed\Test\TestCase;
class MethodMapTest extends TestCase /**
* @covers WellRESTed\Routing\MethodMap
* @group routing
*/
class MethodMapTest extends \PHPUnit_Framework_TestCase
{ {
private $dispatcher; private $dispatcher;
private $request; private $request;
@ -17,7 +22,7 @@ class MethodMapTest extends TestCase
private $next; private $next;
private $middleware; private $middleware;
protected function setUp(): void public function setUp()
{ {
$this->request = new ServerRequest(); $this->request = new ServerRequest();
$this->response = new Response(); $this->response = new Response();
@ -26,117 +31,112 @@ class MethodMapTest extends TestCase
$this->dispatcher = new Dispatcher(); $this->dispatcher = new Dispatcher();
} }
private function getMethodMap(): MethodMap private function getMethodMap() {
{
return new MethodMap($this->dispatcher); return new MethodMap($this->dispatcher);
} }
// ------------------------------------------------------------------------- // -------------------------------------------------------------------------
public function testDispatchesMiddlewareWithMatchingMethod(): void public function testDispatchesMiddlewareWithMatchingMethod()
{ {
$this->request = $this->request->withMethod('GET'); $this->request = $this->request->withMethod("GET");
$map = $this->getMethodMap(); $map = $this->getMethodMap();
$map->register('GET', $this->middleware); $map->register("GET", $this->middleware);
$map($this->request, $this->response, $this->next); $map($this->request, $this->response, $this->next);
$this->assertTrue($this->middleware->called); $this->assertTrue($this->middleware->called);
} }
public function testTreatsMethodNamesCaseSensitively(): void public function testTreatsMethodNamesCaseSensitively()
{ {
$this->request = $this->request->withMethod('get'); $this->request = $this->request->withMethod("get");
$middlewareUpper = new MiddlewareMock(); $middlewareUpper = new MiddlewareMock();
$middlewareLower = new MiddlewareMock(); $middlewareLower = new MiddlewareMock();
$map = $this->getMethodMap(); $map = $this->getMethodMap();
$map->register('GET', $middlewareUpper); $map->register("GET", $middlewareUpper);
$map->register('get', $middlewareLower); $map->register("get", $middlewareLower);
$map($this->request, $this->response, $this->next); $map($this->request, $this->response, $this->next);
$this->assertTrue($middlewareLower->called); $this->assertTrue($middlewareLower->called);
} }
public function testDispatchesWildcardMiddlewareWithNonMatchingMethod(): void public function testDispatchesWildcardMiddlewareWithNonMatchingMethod()
{ {
$this->request = $this->request->withMethod('GET'); $this->request = $this->request->withMethod("GET");
$map = $this->getMethodMap(); $map = $this->getMethodMap();
$map->register('*', $this->middleware); $map->register("*", $this->middleware);
$map($this->request, $this->response, $this->next); $map($this->request, $this->response, $this->next);
$this->assertTrue($this->middleware->called); $this->assertTrue($this->middleware->called);
} }
public function testDispatchesGetMiddlewareForHeadByDefault(): void public function testDispatchesGetMiddlewareForHeadByDefault()
{ {
$this->request = $this->request->withMethod('HEAD'); $this->request = $this->request->withMethod("HEAD");
$map = $this->getMethodMap(); $map = $this->getMethodMap();
$map->register('GET', $this->middleware); $map->register("GET", $this->middleware);
$map($this->request, $this->response, $this->next); $map($this->request, $this->response, $this->next);
$this->assertTrue($this->middleware->called); $this->assertTrue($this->middleware->called);
} }
public function testRegistersMiddlewareForMultipleMethods(): void public function testRegistersMiddlewareForMultipleMethods()
{ {
$map = $this->getMethodMap(); $map = $this->getMethodMap();
$map->register('GET,POST', $this->middleware); $map->register("GET,POST", $this->middleware);
$this->request = $this->request->withMethod('GET'); $this->request = $this->request->withMethod("GET");
$map($this->request, $this->response, $this->next); $map($this->request, $this->response, $this->next);
$this->request = $this->request->withMethod('POST'); $this->request = $this->request->withMethod("POST");
$map($this->request, $this->response, $this->next); $map($this->request, $this->response, $this->next);
$this->assertEquals(2, $this->middleware->callCount); $this->assertEquals(2, $this->middleware->callCount);
} }
public function testSettingNullUnregistersMiddleware(): void public function testSettingNullUnregistersMiddleware()
{ {
$this->request = $this->request->withMethod('POST'); $this->request = $this->request->withMethod("POST");
$map = $this->getMethodMap(); $map = $this->getMethodMap();
$map->register('POST', $this->middleware); $map->register("POST", $this->middleware);
$map->register('POST', null); $map->register("POST", null);
$response = $map($this->request, $this->response, $this->next); $response = $map($this->request, $this->response, $this->next);
$this->assertEquals(405, $response->getStatusCode()); $this->assertEquals(405, $response->getStatusCode());
} }
public function testSetsStatusTo200ForOptions(): void public function testSetsStatusTo200ForOptions()
{ {
$this->request = $this->request->withMethod('OPTIONS'); $this->request = $this->request->withMethod("OPTIONS");
$map = $this->getMethodMap(); $map = $this->getMethodMap();
$map->register('GET', $this->middleware); $map->register("GET", $this->middleware);
$response = $map($this->request, $this->response, $this->next); $response = $map($this->request, $this->response, $this->next);
$this->assertEquals(200, $response->getStatusCode()); $this->assertEquals(200, $response->getStatusCode());
} }
public function testStopsPropagatingAfterOptions(): void public function testStopsPropagatingAfterOptions()
{ {
$this->request = $this->request->withMethod('OPTIONS'); $this->request = $this->request->withMethod("OPTIONS");
$map = $this->getMethodMap(); $map = $this->getMethodMap();
$map->register('GET', $this->middleware); $map->register("GET", $this->middleware);
$map($this->request, $this->response, $this->next); $map($this->request, $this->response, $this->next);
$this->assertFalse($this->next->called); $this->assertFalse($this->next->called);
} }
/** /** @dataProvider allowedMethodProvider */
* @dataProvider allowedMethodProvider public function testSetsAllowHeaderForOptions($methodsDeclared, $methodsAllowed)
* @param string[] $methodsDeclared
* @param string[] $methodsAllowed
*/
public function testSetsAllowHeaderForOptions(array $methodsDeclared, array $methodsAllowed): void
{ {
$this->request = $this->request->withMethod('OPTIONS'); $this->request = $this->request->withMethod("OPTIONS");
$map = $this->getMethodMap(); $map = $this->getMethodMap();
foreach ($methodsDeclared as $method) { foreach ($methodsDeclared as $method) {
@ -144,38 +144,39 @@ class MethodMapTest extends TestCase
} }
$response = $map($this->request, $this->response, $this->next); $response = $map($this->request, $this->response, $this->next);
$this->assertContainsEach($methodsAllowed, $response->getHeaderLine('Allow')); $this->assertContainsEach($methodsAllowed, $response->getHeaderLine("Allow"));
} }
public function testSetsStatusTo405ForBadMethod(): void /** @dataProvider allowedMethodProvider */
public function testSetsStatusTo405ForBadMethod()
{ {
$this->request = $this->request->withMethod('POST'); $this->request = $this->request->withMethod("POST");
$map = $this->getMethodMap(); $map = $this->getMethodMap();
$map->register('GET', $this->middleware); $map->register("GET", $this->middleware);
$response = $map($this->request, $this->response, $this->next); $response = $map($this->request, $this->response, $this->next);
$this->assertEquals(405, $response->getStatusCode()); $this->assertEquals(405, $response->getStatusCode());
} }
public function testStopsPropagatingAfterBadMethod(): void /**
* @coversNothing
* @dataProvider allowedMethodProvider
*/
public function testStopsPropagatingAfterBadMethod()
{ {
$this->request = $this->request->withMethod('POST'); $this->request = $this->request->withMethod("POST");
$map = $this->getMethodMap(); $map = $this->getMethodMap();
$map->register('GET', $this->middleware); $map->register("GET", $this->middleware);
$map($this->request, $this->response, $this->next); $map($this->request, $this->response, $this->next);
$this->assertFalse($this->next->called); $this->assertFalse($this->next->called);
} }
/** /** @dataProvider allowedMethodProvider */
* @dataProvider allowedMethodProvider public function testSetsAllowHeaderForBadMethod($methodsDeclared, $methodsAllowed)
* @param string[] $methodsDeclared
* @param string[] $methodsAllowed
*/
public function testSetsAllowHeaderForBadMethod(array $methodsDeclared, array $methodsAllowed): void
{ {
$this->request = $this->request->withMethod('BAD'); $this->request = $this->request->withMethod("BAD");
$map = $this->getMethodMap(); $map = $this->getMethodMap();
foreach ($methodsDeclared as $method) { foreach ($methodsDeclared as $method) {
@ -183,22 +184,21 @@ class MethodMapTest extends TestCase
} }
$response = $map($this->request, $this->response, $this->next); $response = $map($this->request, $this->response, $this->next);
$this->assertContainsEach($methodsAllowed, $response->getHeaderLine('Allow')); $this->assertContainsEach($methodsAllowed, $response->getHeaderLine("Allow"));
} }
public function allowedMethodProvider(): array public function allowedMethodProvider()
{ {
return [ return [
[['GET'], ['GET', 'HEAD', 'OPTIONS']], [["GET"], ["GET", "HEAD", "OPTIONS"]],
[['GET', 'POST'], ['GET', 'POST', 'HEAD', 'OPTIONS']], [["GET", "POST"], ["GET", "POST", "HEAD", "OPTIONS"]],
[['POST'], ['POST', 'OPTIONS']], [["POST"], ["POST", "OPTIONS"]],
[['POST'], ['POST', 'OPTIONS']], [["POST"], ["POST", "OPTIONS"]],
[['GET', 'PUT,DELETE'], ['GET', 'PUT', 'DELETE', 'HEAD', 'OPTIONS']], [["GET", "PUT,DELETE"], ["GET", "PUT", "DELETE", "HEAD", "OPTIONS"]],
]; ];
} }
private function assertContainsEach($expectedList, $actual): void private function assertContainsEach($expectedList, $actual) {
{
foreach ($expectedList as $expected) { foreach ($expectedList as $expected) {
if (strpos($actual, $expected) === false) { if (strpos($actual, $expected) === false) {
$this->assertTrue(false, "'$actual' does not contain expected '$expected'"); $this->assertTrue(false, "'$actual' does not contain expected '$expected'");

View File

@ -0,0 +1,57 @@
<?php
namespace WellRESTed\Test\Unit\Routing\Route;
use Prophecy\Argument;
use WellRESTed\Routing\Route\PrefixRoute;
use WellRESTed\Routing\Route\RouteInterface;
/**
* @covers WellRESTed\Routing\Route\PrefixRoute
* @group route
* @group routing
*/
class PrefixRouteTest extends \PHPUnit_Framework_TestCase
{
public function testTrimsAsteriskFromEndOfTarget()
{
$methodMap = $this->prophesize('WellRESTed\Routing\MethodMapInterface');
$route = new PrefixRoute("/cats/*", $methodMap->reveal());
$this->assertEquals("/cats/", $route->getTarget());
}
public function testReturnsPrefixType()
{
$methodMap = $this->prophesize('WellRESTed\Routing\MethodMapInterface');
$route = new PrefixRoute("/*", $methodMap->reveal());
$this->assertSame(RouteInterface::TYPE_PREFIX, $route->getType());
}
public function testReturnsEmptyArrayForPathVariables()
{
$methodMap = $this->prophesize('WellRESTed\Routing\MethodMapInterface');
$route = new PrefixRoute("/*", $methodMap->reveal());
$this->assertSame([], $route->getPathVariables());
}
public function testMatchesExactRequestTarget()
{
$methodMap = $this->prophesize('WellRESTed\Routing\MethodMapInterface');
$route = new PrefixRoute("/*", $methodMap->reveal());
$this->assertTrue($route->matchesRequestTarget("/"));
}
public function testMatchesRequestTargetWithSamePrefix()
{
$methodMap = $this->prophesize('WellRESTed\Routing\MethodMapInterface');
$route = new PrefixRoute("/*", $methodMap->reveal());
$this->assertTrue($route->matchesRequestTarget("/cats/"));
}
public function testDoesNotMatchNonmatchingRequestTarget()
{
$methodMap = $this->prophesize('WellRESTed\Routing\MethodMapInterface');
$route = new PrefixRoute("/animals/cats/", $methodMap->reveal());
$this->assertFalse($route->matchesRequestTarget("/animals/dogs/"));
}
}

View File

@ -0,0 +1,108 @@
<?php
namespace WellRESTed\Test\Unit\Routing\Route;
use Prophecy\Argument;
use WellRESTed\Routing\Route\RegexRoute;
use WellRESTed\Routing\Route\RouteInterface;
/**
* @covers WellRESTed\Routing\Route\RegexRoute
* @group route
* @group routing
*/
class RegexRouteTest extends \PHPUnit_Framework_TestCase
{
private $methodMap;
public function setUp()
{
$this->methodMap = $this->prophesize('WellRESTed\Routing\MethodMapInterface');
}
public function testReturnsPatternType()
{
$route = new RegexRoute("/", $this->methodMap->reveal());
$this->assertSame(RouteInterface::TYPE_PATTERN, $route->getType());
}
/** @dataProvider matchingRouteProvider */
public function testMatchesTarget($pattern, $path)
{
$route = new RegexRoute($pattern, $this->methodMap->reveal());
$this->assertTrue($route->matchesRequestTarget($path));
}
/** @dataProvider matchingRouteProvider */
public function testMatchesTargetByRegex($pattern, $target)
{
$route = new RegexRoute($pattern, $this->methodMap->reveal());
$this->assertTrue($route->matchesRequestTarget($target));
}
/** @dataProvider matchingRouteProvider */
public function testExtractsPathVariablesByRegex($pattern, $target, $expectedCaptures)
{
$route = new RegexRoute($pattern, $this->methodMap->reveal());
$route->matchesRequestTarget($target);
$this->assertEquals($expectedCaptures, $route->getPathVariables());
}
public function matchingRouteProvider()
{
return [
["~/cat/[0-9]+~", "/cat/2", [0 => "/cat/2"]],
["#/dog/.*#", "/dog/his-name-is-bear", [0 => "/dog/his-name-is-bear"]],
["~/cat/([0-9]+)~", "/cat/2", [
0 => "/cat/2",
1 => "2"
]],
["~/dog/(?<id>[0-9+])~", "/dog/2", [
0 => "/dog/2",
1 => "2",
"id" => "2"
]]
];
}
/** @dataProvider mismatchingRouteProvider */
public function testDoesNotMatchNonmatchingTarget($pattern, $path)
{
$route = new RegexRoute($pattern, $this->methodMap->reveal());
$this->assertFalse($route->matchesRequestTarget($path));
}
public function mismatchingRouteProvider()
{
return [
["~/cat/[0-9]+~", "/cat/molly"],
["~/cat/[0-9]+~", "/dog/bear"],
["#/dog/.*#", "/dog"]
];
}
/**
* @dataProvider invalidRouteProvider
* @expectedException \RuntimeException
*/
public function testThrowsExceptionOnInvalidPattern($pattern)
{
$route = new RegexRoute($pattern, $this->methodMap->reveal());
\PHPUnit_Framework_Error_Warning::$enabled = false;
\PHPUnit_Framework_Error_Notice::$enabled = false;
$level = error_reporting();
error_reporting($level & ~E_WARNING);
$route->matchesRequestTarget("/");
error_reporting($level);
\PHPUnit_Framework_Error_Warning::$enabled = true;
\PHPUnit_Framework_Error_Notice::$enabled = true;
}
public function invalidRouteProvider()
{
return [
["~/unterminated"],
["/nope"]
];
}
}

View File

@ -0,0 +1,50 @@
<?php
namespace WellRESTed\Test\Unit\Routing\Route;
use Prophecy\Argument;
use WellRESTed\Routing\Route\RouteFactory;
use WellRESTed\Routing\Route\RouteInterface;
/**
* @covers WellRESTed\Routing\Route\RouteFactory
* @group route
* @group routing
*/
class RouteFactoryTest extends \PHPUnit_Framework_TestCase
{
private $dispatcher;
public function setUp()
{
$this->dispatcher = $this->prophesize('WellRESTed\Dispatching\DispatcherInterface');
}
public function testCreatesStaticRoute()
{
$factory = new RouteFactory($this->dispatcher->reveal());
$route = $factory->create("/cats/");
$this->assertSame(RouteInterface::TYPE_STATIC, $route->getType());
}
public function testCreatesPrefixRoute()
{
$factory = new RouteFactory($this->dispatcher->reveal());
$route = $factory->create("/cats/*");
$this->assertSame(RouteInterface::TYPE_PREFIX, $route->getType());
}
public function testCreatesRegexRoute()
{
$factory = new RouteFactory($this->dispatcher->reveal());
$route = $factory->create("~/cat/[0-9]+~");
$this->assertSame(RouteInterface::TYPE_PATTERN, $route->getType());
}
public function testCreatesTemplateRoute()
{
$factory = new RouteFactory($this->dispatcher->reveal());
$route = $factory->create("/cat/{id}");
$this->assertSame(RouteInterface::TYPE_PATTERN, $route->getType());
}
}

View File

@ -0,0 +1,59 @@
<?php
namespace WellRESTed\Test\Unit\Routing\Route;
use Prophecy\Argument;
/**
* @covers WellRESTed\Routing\Route\Route
* @group route
* @group routing
*/
class RouteTest extends \PHPUnit_Framework_TestCase
{
public function testCreatesInstance()
{
$methodMap = $this->prophesize('WellRESTed\Routing\MethodMapInterface');
$route = $this->getMockForAbstractClass(
'WellRESTed\Routing\Route\Route',
["/target", $methodMap->reveal()]);
$this->assertNotNull($route);
}
public function testReturnsTarget()
{
$methodMap = $this->prophesize('WellRESTed\Routing\MethodMapInterface');
$route = $this->getMockForAbstractClass(
'WellRESTed\Routing\Route\Route',
["/target", $methodMap->reveal()]);
$this->assertSame("/target", $route->getTarget());
}
public function testReturnsMethodMap()
{
$methodMap = $this->prophesize('WellRESTed\Routing\MethodMapInterface');
$route = $this->getMockForAbstractClass(
'WellRESTed\Routing\Route\Route',
["/target", $methodMap->reveal()]);
$this->assertSame($methodMap->reveal(), $route->getMethodMap());
}
public function testDispatchesMethodMap()
{
$methodMap = $this->prophesize('WellRESTed\Routing\MethodMapInterface');
$methodMap->__invoke(Argument::cetera())->willReturn();
$route = $this->getMockForAbstractClass(
'WellRESTed\Routing\Route\Route',
["/target", $methodMap->reveal()]);
$request = $this->prophesize('Psr\Http\Message\ServerRequestInterface')->reveal();
$response = $this->prophesize('Psr\Http\Message\ResponseInterface')->reveal();
$next = function ($request, $response) {
return $response;
};
$route->__invoke($request, $response, $next);
$methodMap->__invoke(Argument::cetera())->shouldHaveBeenCalled();
}
}

View File

@ -0,0 +1,43 @@
<?php
namespace WellRESTed\Test\Unit\Routing\Route;
use Prophecy\Argument;
use WellRESTed\Routing\Route\RouteInterface;
use WellRESTed\Routing\Route\StaticRoute;
/**
* @covers WellRESTed\Routing\Route\StaticRoute
* @group route
* @group routing
*/
class StaticRouteTest extends \PHPUnit_Framework_TestCase
{
public function testReturnsStaticType()
{
$methodMap = $this->prophesize('WellRESTed\Routing\MethodMapInterface');
$route = new StaticRoute("/", $methodMap->reveal());
$this->assertSame(RouteInterface::TYPE_STATIC, $route->getType());
}
public function testMatchesExactRequestTarget()
{
$methodMap = $this->prophesize('WellRESTed\Routing\MethodMapInterface');
$route = new StaticRoute("/", $methodMap->reveal());
$this->assertTrue($route->matchesRequestTarget("/"));
}
public function testReturnsEmptyArrayForPathVariables()
{
$methodMap = $this->prophesize('WellRESTed\Routing\MethodMapInterface');
$route = new StaticRoute("/", $methodMap->reveal());
$this->assertSame([], $route->getPathVariables());
}
public function testDoesNotMatchNonmatchingRequestTarget()
{
$methodMap = $this->prophesize('WellRESTed\Routing\MethodMapInterface');
$route = new StaticRoute("/", $methodMap->reveal());
$this->assertFalse($route->matchesRequestTarget("/cats/"));
}
}

View File

@ -0,0 +1,211 @@
<?php
namespace WellRESTed\Test\Unit\Routing\Route;
use Prophecy\Argument;
use WellRESTed\Routing\Route\RouteInterface;
use WellRESTed\Routing\Route\TemplateRoute;
/**
* @covers WellRESTed\Routing\Route\TemplateRoute
* @group route
* @group routing
*/
class TemplateRouteTest extends \PHPUnit_Framework_TestCase
{
private $methodMap;
public function setUp()
{
$this->methodMap = $this->prophesize('WellRESTed\Routing\MethodMapInterface');
}
private function getExpectedValues($keys)
{
$expectedValues = [
"var" => "value",
"hello" => "Hello World!",
"x" => "1024",
"y" => "768",
"path" => "/foo/bar",
"who" => "fred",
"half" => "50%",
"empty" => "",
"count" => ["one", "two", "three"],
"list" => ["red", "green", "blue"]
];
return array_intersect_key($expectedValues, array_flip($keys));
}
private function assertArrayHasSameContents($expected, $actual)
{
ksort($expected);
ksort($actual);
$this->assertEquals($expected, $actual);
}
// ------------------------------------------------------------------------
public function testReturnsPatternType()
{
$route = new TemplateRoute("/", $this->methodMap->reveal());
$this->assertSame(RouteInterface::TYPE_PATTERN, $route->getType());
}
// ------------------------------------------------------------------------
// Matching
/** @dataProvider nonMatchingTargetProvider */
public function testFailsToMatchNonMatchingTarget($template, $target)
{
$route = new TemplateRoute($template, $this->methodMap);
$this->assertFalse($route->matchesRequestTarget($target));
}
public function nonMatchingTargetProvider()
{
return [
["/foo/{var}", "/bar/12", "Mismatch before first template expression"],
["/foo/{foo}/bar/{bar}", "/foo/12/13", "Mismatch after first template expression"],
["/hello/{hello}", "/hello/Hello%20World!", "Requires + operator to match reserver characters"],
["{/var}", "/bar/12", "Path contains more segements than template"],
];
}
// ------------------------------------------------------------------------
// Matching :: Simple Strings
/** @dataProvider simpleStringProvider */
public function testMatchesSimpleStrings($template, $target)
{
$route = new TemplateRoute($template, $this->methodMap);
$this->assertTrue($route->matchesRequestTarget($target));
}
/** @dataProvider simpleStringProvider */
public function testCapturesFromSimpleStrings($template, $target, $variables)
{
$route = new TemplateRoute($template, $this->methodMap);
$route->matchesRequestTarget($target);
$this->assertArrayHasSameContents($this->getExpectedValues($variables), $route->getPathVariables());
}
public function simpleStringProvider()
{
return [
["/foo", "/foo", []],
["/{var}", "/value", ["var"]],
["/{hello}", "/Hello%20World%21", ["hello"]],
["/{x,hello,y}", "/1024,Hello%20World%21,768", ["x", "hello", "y"]],
["/{x,hello,y}", "/1024,Hello%20World%21,768", ["x", "hello", "y"]],
];
}
// ------------------------------------------------------------------------
// Matching :: Reserved
/** @dataProvider reservedStringProvider */
public function testMatchesReservedStrings($template, $target)
{
$route = new TemplateRoute($template, $this->methodMap);
$this->assertTrue($route->matchesRequestTarget($target));
}
/** @dataProvider reservedStringProvider */
public function testCapturesFromReservedStrings($template, $target, $variables)
{
$route = new TemplateRoute($template, $this->methodMap);
$route->matchesRequestTarget($target);
$this->assertSame($this->getExpectedValues($variables), $route->getPathVariables());
}
public function reservedStringProvider()
{
return [
["/{+var}", "/value", ["var"]],
["/{+hello}", "/Hello%20World!", ["hello"]],
["{+path}/here", "/foo/bar/here", ["path"]],
];
}
// ------------------------------------------------------------------------
// Matching :: Label Expansion
/** @dataProvider labelWithDotPrefixProvider */
public function testMatchesLabelWithDotPrefix($template, $target)
{
$route = new TemplateRoute($template, $this->methodMap);
$this->assertTrue($route->matchesRequestTarget($target));
}
/** @dataProvider labelWithDotPrefixProvider */
public function testCapturesFromLabelWithDotPrefix($template, $target, $variables)
{
$route = new TemplateRoute($template, $this->methodMap);
$route->matchesRequestTarget($target);
$this->assertArrayHasSameContents($this->getExpectedValues($variables), $route->getPathVariables());
}
public function labelWithDotPrefixProvider()
{
return [
["/{.who}", "/.fred", ["who"]],
["/{.half,who}", "/.50%25.fred", ["half", "who"]],
["/X{.empty}", "/X.", ["empty"]]
];
}
// ------------------------------------------------------------------------
// Matching :: Path Segments
/** @dataProvider pathSegmentProvider */
public function testMatchesPathSegments($template, $target)
{
$route = new TemplateRoute($template, $this->methodMap);
$this->assertTrue($route->matchesRequestTarget($target));
}
/** @dataProvider pathSegmentProvider */
public function testCapturesFromPathSegments($template, $target, $variables)
{
$route = new TemplateRoute($template, $this->methodMap);
$route->matchesRequestTarget($target);
$this->assertArrayHasSameContents($this->getExpectedValues($variables), $route->getPathVariables());
}
public function pathSegmentProvider()
{
return [
["{/who}", "/fred", ["who"]],
["{/half,who}", "/50%25/fred", ["half", "who"]],
["{/var,empty}", "/value/", ["var", "empty"]]
];
}
// ------------------------------------------------------------------------
// Matching :: Explosion
/** @dataProvider pathExplosionProvider */
public function testMatchesExplosion($template, $target)
{
$route = new TemplateRoute($template, $this->methodMap);
$this->assertTrue($route->matchesRequestTarget($target));
}
/** @dataProvider pathExplosionProvider */
public function testCapturesFromExplosion($template, $target, $variables)
{
$route = new TemplateRoute($template, $this->methodMap);
$route->matchesRequestTarget($target);
$this->assertArrayHasSameContents($this->getExpectedValues($variables), $route->getPathVariables());
}
public function pathExplosionProvider()
{
return [
["/{count*}", "/one,two,three", ["count"]],
["{/count*}", "/one/two/three", ["count"]],
["X{.list*}", "X.red.green.blue", ["list"]]
];
}
}

View File

@ -0,0 +1,388 @@
<?php
namespace WellRESTed\Test\Unit\Routing;
use Prophecy\Argument;
use WellRESTed\Dispatching\Dispatcher;
use WellRESTed\Message\Response;
use WellRESTed\Message\ServerRequest;
use WellRESTed\Routing\Route\RouteInterface;
use WellRESTed\Routing\Router;
use WellRESTed\Test\Doubles\NextMock;
/**
* @covers WellRESTed\Routing\Router
* @group routing
*/
class RouterTest extends \PHPUnit_Framework_TestCase
{
private $dispatcher;
private $methodMap;
private $factory;
private $request;
private $response;
private $route;
private $router;
private $next;
public function setUp()
{
parent::setUp();
$this->methodMap = $this->prophesize('WellRESTed\Routing\MethodMapInterface');
$this->methodMap->register(Argument::cetera());
$this->route = $this->prophesize('WellRESTed\Routing\Route\RouteInterface');
$this->route->__invoke(Argument::cetera())->willReturn();
$this->route->getMethodMap()->willReturn($this->methodMap->reveal());
$this->route->getType()->willReturn(RouteInterface::TYPE_STATIC);
$this->route->getTarget()->willReturn("/");
$this->route->getPathVariables()->willReturn([]);
$this->factory = $this->prophesize('WellRESTed\Routing\Route\RouteFactory');
$this->factory->create(Argument::any())->willReturn($this->route->reveal());
$this->request = new ServerRequest();
$this->response = new Response();
$this->next = new NextMock();
$this->router = $this->getMockBuilder('WellRESTed\Routing\Router')
->setMethods(["getRouteFactory"])
->disableOriginalConstructor()
->getMock();
$this->router->expects($this->any())
->method("getRouteFactory")
->will($this->returnValue($this->factory->reveal()));
$this->router->__construct(new Dispatcher());
}
// ------------------------------------------------------------------------
// Construction
public function testCreatesInstance()
{
$router = new Router(new Dispatcher());
$this->assertNotNull($router);
}
// ------------------------------------------------------------------------
// Populating
public function testCreatesRouteForTarget()
{
$this->router->register("GET", "/", "middleware");
$this->factory->create("/")->shouldHaveBeenCalled();
}
public function testDoesNotRecreateRouteForExistingTarget()
{
$this->router->register("GET", "/", "middleware");
$this->router->register("POST", "/", "middleware");
$this->factory->create("/")->shouldHaveBeenCalledTimes(1);
}
public function testPassesMethodAndMiddlewareToMethodMap()
{
$this->router->register("GET", "/", "middleware");
$this->methodMap->register("GET", "middleware")->shouldHaveBeenCalled();
}
// ------------------------------------------------------------------------
// Dispatching
public function testDispatchesStaticRoute()
{
$target = "/";
$this->request = $this->request->withRequestTarget($target);
$this->route->getTarget()->willReturn($target);
$this->route->getType()->willReturn(RouteInterface::TYPE_STATIC);
$this->router->register("GET", $target, "middleware");
$this->router->__invoke($this->request, $this->response, $this->next);
$this->route->__invoke($this->request, $this->response, $this->next)->shouldHaveBeenCalled();
}
public function testDispatchesPrefixRoute()
{
$target = "/animals/cats/*";
$this->request = $this->request->withRequestTarget("/animals/cats/molly");
$this->route->getTarget()->willReturn($target);
$this->route->getType()->willReturn(RouteInterface::TYPE_PREFIX);
$this->router->register("GET", $target, "middleware");
$this->router->__invoke($this->request, $this->response, $this->next);
$this->route->__invoke($this->request, $this->response, $this->next)->shouldHaveBeenCalled();
}
public function testDispatchesPatternRoute()
{
$target = "/";
$this->request = $this->request->withRequestTarget($target);
$this->route->getTarget()->willReturn($target);
$this->route->getType()->willReturn(RouteInterface::TYPE_PATTERN);
$this->route->matchesRequestTarget(Argument::cetera())->willReturn(true);
$this->router->register("GET", $target, "middleware");
$this->router->__invoke($this->request, $this->response, $this->next);
$this->route->__invoke($this->request, $this->response, $this->next)->shouldHaveBeenCalled();
}
/** @coversNothing */
public function testDispatchesStaticRouteBeforePrefixRoute()
{
$staticRoute = $this->prophesize('WellRESTed\Routing\Route\RouteInterface');
$staticRoute->getMethodMap()->willReturn($this->methodMap->reveal());
$staticRoute->getTarget()->willReturn("/cats/");
$staticRoute->getType()->willReturn(RouteInterface::TYPE_STATIC);
$staticRoute->__invoke(Argument::cetera())->willReturn();
$prefixRoute = $this->prophesize('WellRESTed\Routing\Route\RouteInterface');
$prefixRoute->getMethodMap()->willReturn($this->methodMap->reveal());
$prefixRoute->getTarget()->willReturn("/cats/*");
$prefixRoute->getType()->willReturn(RouteInterface::TYPE_PREFIX);
$prefixRoute->__invoke(Argument::cetera())->willReturn();
$this->request = $this->request->withRequestTarget("/cats/");
$this->factory->create("/cats/")->willReturn($staticRoute->reveal());
$this->factory->create("/cats/*")->willReturn($prefixRoute->reveal());
$this->router->register("GET", "/cats/", "middleware");
$this->router->register("GET", "/cats/*", "middleware");
$this->router->__invoke($this->request, $this->response, $this->next);
$staticRoute->__invoke($this->request, $this->response, $this->next)->shouldHaveBeenCalled();
}
public function testDispatchesLongestMatchingPrefixRoute()
{
// Note: The longest route is also good for 2 points in Settlers of Catan.
$shortRoute = $this->prophesize('WellRESTed\Routing\Route\RouteInterface');
$shortRoute->getMethodMap()->willReturn($this->methodMap->reveal());
$shortRoute->getTarget()->willReturn("/animals/*");
$shortRoute->getType()->willReturn(RouteInterface::TYPE_PREFIX);
$shortRoute->__invoke(Argument::cetera())->willReturn();
$longRoute = $this->prophesize('WellRESTed\Routing\Route\RouteInterface');
$longRoute->getMethodMap()->willReturn($this->methodMap->reveal());
$longRoute->getTarget()->willReturn("/animals/cats/*");
$longRoute->getType()->willReturn(RouteInterface::TYPE_PREFIX);
$longRoute->__invoke(Argument::cetera())->willReturn();
$this->request = $this->request->withRequestTarget("/animals/cats/molly");
$this->factory->create("/animals/*")->willReturn($shortRoute->reveal());
$this->factory->create("/animals/cats/*")->willReturn($longRoute->reveal());
$this->router->register("GET", "/animals/*", "middleware");
$this->router->register("GET", "/animals/cats/*", "middleware");
$this->router->__invoke($this->request, $this->response, $this->next);
$longRoute->__invoke($this->request, $this->response, $this->next)->shouldHaveBeenCalled();
}
public function testDispatchesPrefixRouteBeforePatternRoute()
{
$prefixRoute = $this->prophesize('WellRESTed\Routing\Route\RouteInterface');
$prefixRoute->getMethodMap()->willReturn($this->methodMap->reveal());
$prefixRoute->getTarget()->willReturn("/cats/*");
$prefixRoute->getType()->willReturn(RouteInterface::TYPE_PREFIX);
$prefixRoute->__invoke(Argument::cetera())->willReturn();
$patternRoute = $this->prophesize('WellRESTed\Routing\Route\RouteInterface');
$patternRoute->getMethodMap()->willReturn($this->methodMap->reveal());
$patternRoute->getTarget()->willReturn("/cats/{id}");
$patternRoute->getType()->willReturn(RouteInterface::TYPE_PATTERN);
$patternRoute->__invoke(Argument::cetera())->willReturn();
$this->request = $this->request->withRequestTarget("/cats/");
$this->factory->create("/cats/*")->willReturn($prefixRoute->reveal());
$this->factory->create("/cats/{id}")->willReturn($patternRoute->reveal());
$this->router->register("GET", "/cats/*", "middleware");
$this->router->register("GET", "/cats/{id}", "middleware");
$this->router->__invoke($this->request, $this->response, $this->next);
$prefixRoute->__invoke($this->request, $this->response, $this->next)->shouldHaveBeenCalled();
}
public function testDispatchesFirstMatchingPatternRoute()
{
$patternRoute1 = $this->prophesize('WellRESTed\Routing\Route\RouteInterface');
$patternRoute1->getMethodMap()->willReturn($this->methodMap->reveal());
$patternRoute1->getTarget()->willReturn("/cats/{id}");
$patternRoute1->getType()->willReturn(RouteInterface::TYPE_PATTERN);
$patternRoute1->getPathVariables()->willReturn([]);
$patternRoute1->matchesRequestTarget(Argument::any())->willReturn(true);
$patternRoute1->__invoke(Argument::cetera())->willReturn();
$patternRoute2 = $this->prophesize('WellRESTed\Routing\Route\RouteInterface');
$patternRoute2->getMethodMap()->willReturn($this->methodMap->reveal());
$patternRoute2->getTarget()->willReturn("/cats/{name}");
$patternRoute2->getType()->willReturn(RouteInterface::TYPE_PATTERN);
$patternRoute2->getPathVariables()->willReturn([]);
$patternRoute2->matchesRequestTarget(Argument::any())->willReturn(true);
$patternRoute2->__invoke(Argument::cetera())->willReturn();
$this->request = $this->request->withRequestTarget("/cats/molly");
$this->factory->create("/cats/{id}")->willReturn($patternRoute1->reveal());
$this->factory->create("/cats/{name}")->willReturn($patternRoute2->reveal());
$this->router->register("GET", "/cats/{id}", "middleware");
$this->router->register("GET", "/cats/{name}", "middleware");
$this->router->__invoke($this->request, $this->response, $this->next);
$patternRoute1->__invoke($this->request, $this->response, $this->next)->shouldHaveBeenCalled();
}
public function testStopsTestingPatternsAfterFirstSuccessfulMatch()
{
$patternRoute1 = $this->prophesize('WellRESTed\Routing\Route\RouteInterface');
$patternRoute1->getMethodMap()->willReturn($this->methodMap->reveal());
$patternRoute1->getTarget()->willReturn("/cats/{id}");
$patternRoute1->getType()->willReturn(RouteInterface::TYPE_PATTERN);
$patternRoute1->getPathVariables()->willReturn([]);
$patternRoute1->matchesRequestTarget(Argument::any())->willReturn(true);
$patternRoute1->__invoke(Argument::cetera())->willReturn();
$patternRoute2 = $this->prophesize('WellRESTed\Routing\Route\RouteInterface');
$patternRoute2->getMethodMap()->willReturn($this->methodMap->reveal());
$patternRoute2->getTarget()->willReturn("/cats/{name}");
$patternRoute2->getType()->willReturn(RouteInterface::TYPE_PATTERN);
$patternRoute2->getPathVariables()->willReturn([]);
$patternRoute2->matchesRequestTarget(Argument::any())->willReturn(true);
$patternRoute2->__invoke(Argument::cetera())->willReturn();
$this->request = $this->request->withRequestTarget("/cats/molly");
$this->factory->create("/cats/{id}")->willReturn($patternRoute1->reveal());
$this->factory->create("/cats/{name}")->willReturn($patternRoute2->reveal());
$this->router->register("GET", "/cats/{id}", "middleware");
$this->router->register("GET", "/cats/{name}", "middleware");
$this->router->__invoke($this->request, $this->response, $this->next);
$patternRoute2->matchesRequestTarget(Argument::any())->shouldNotHaveBeenCalled();
}
public function testMatchesPathAgainstRouteWithoutQuery()
{
$target = "/my/path?cat=molly&dog=bear";
$this->request = $this->request->withRequestTarget($target);
$this->route->getTarget()->willReturn($target);
$this->route->getType()->willReturn(RouteInterface::TYPE_PATTERN);
$this->route->matchesRequestTarget(Argument::cetera())->willReturn(true);
$this->router->register("GET", $target, "middleware");
$this->router->__invoke($this->request, $this->response, $this->next);
$this->route->matchesRequestTarget("/my/path")->shouldHaveBeenCalled();
}
// ------------------------------------------------------------------------
// Path Variables
/** @dataProvider pathVariableProvider */
public function testSetPathVariablesAttributeIndividually($name, $value)
{
$target = "/";
$variables = [
"id" => "1024",
"name" => "Molly"
];
$this->request = $this->request->withRequestTarget($target);
$this->route->getTarget()->willReturn($target);
$this->route->getType()->willReturn(RouteInterface::TYPE_PATTERN);
$this->route->matchesRequestTarget(Argument::cetera())->willReturn(true);
$this->route->getPathVariables()->willReturn($variables);
$this->router->register("GET", $target, "middleware");
$this->router->__invoke($this->request, $this->response, $this->next);
$isRequestWithExpectedAttribute = function ($request) use ($name, $value) {
return $request->getAttribute($name) === $value;
};
$this->route->__invoke(
Argument::that($isRequestWithExpectedAttribute),
Argument::cetera()
)->shouldHaveBeenCalled();
}
public function pathVariableProvider()
{
return [
["id", "1024"],
["name", "Molly"]
];
}
public function testSetPathVariablesAttributeAsArray()
{
$attributeName = "pathVariables";
$target = "/";
$variables = [
"id" => "1024",
"name" => "Molly"
];
$this->request = $this->request->withRequestTarget($target);
$this->route->getTarget()->willReturn($target);
$this->route->getType()->willReturn(RouteInterface::TYPE_PATTERN);
$this->route->matchesRequestTarget(Argument::cetera())->willReturn(true);
$this->route->getPathVariables()->willReturn($variables);
$this->router->__construct(new Dispatcher(), $attributeName);
$this->router->register("GET", $target, "middleware");
$this->router->__invoke($this->request, $this->response, $this->next);
$isRequestWithExpectedAttribute = function ($request) use ($attributeName, $variables) {
return $request->getAttribute($attributeName) === $variables;
};
$this->route->__invoke(
Argument::that($isRequestWithExpectedAttribute),
Argument::cetera()
)->shouldHaveBeenCalled();
}
// ------------------------------------------------------------------------
// No Matching Routes
public function testResponds404WhenNoRouteMatches()
{
$this->request = $this->request->withRequestTarget("/no/match");
$response = $this->router->__invoke($this->request, $this->response, $this->next);
$this->assertEquals(404, $response->getStatusCode());
}
public function testStopsPropagatingWhenNoRouteMatches()
{
$this->request = $this->request->withRequestTarget("/no/match");
$this->router->__invoke($this->request, $this->response, $this->next);
$this->assertFalse($this->next->called);
}
public function testRegisterIsFluid()
{
$router = $this->router
->register("GET", "/", "middleware")
->register("POST", "/", "middleware");
$this->assertSame($this->router, $router);
}
}

View File

@ -0,0 +1,168 @@
<?php
namespace WellRESTed\Test\Unit;
use Prophecy\Argument;
use WellRESTed\Message\Response;
use WellRESTed\Message\ServerRequest;
use WellRESTed\Server;
use WellRESTed\Test\Doubles\NextMock;
/** @covers WellRESTed\Server */
class ServerTest extends \PHPUnit_Framework_TestCase
{
private $dispatcher;
private $next;
private $request;
private $response;
private $transmitter;
private $server;
public function setUp()
{
parent::setUp();
$this->request = new ServerRequest();
$this->response = new Response();
$this->next = new NextMock();
$this->transmitter = $this->prophesize('WellRESTed\Transmission\TransmitterInterface');
$this->transmitter->transmit(Argument::cetera())->willReturn();
$this->dispatcher = $this->prophesize('WellRESTed\Dispatching\DispatcherInterface');
$this->dispatcher->dispatch(Argument::cetera())->will(
function ($args) {
list($middleware, $request, $response, $next) = $args;
return $next($request, $response);
}
);
$this->server = $this->getMockBuilder('WellRESTed\Server')
->setMethods(["getDefaultDispatcher", "getRequest", "getResponse", "getTransmitter"])
->disableOriginalConstructor()
->getMock();
$this->server->expects($this->any())
->method("getDefaultDispatcher")
->will($this->returnValue($this->dispatcher->reveal()));
$this->server->expects($this->any())
->method("getRequest")
->will($this->returnValue($this->request));
$this->server->expects($this->any())
->method("getResponse")
->will($this->returnValue($this->response));
$this->server->expects($this->any())
->method("getTransmitter")
->will($this->returnValue($this->transmitter->reveal()));
$this->server->__construct();
}
public function testCreatesInstances()
{
$server = new Server();
$this->assertNotNull($server);
}
public function testAddIsFluid()
{
$server = new Server();
$this->assertSame($server, $server->add("middleware"));
}
public function testReturnsDispatcher()
{
$this->assertSame($this->dispatcher->reveal(), $this->server->getDispatcher());
}
public function testDispatchesMiddlewareStack()
{
$this->server->add("first");
$this->server->add("second");
$this->server->add("third");
$this->server->dispatch($this->request, $this->response, $this->next);
$this->dispatcher->dispatch(
["first", "second", "third"],
$this->request,
$this->response,
$this->next
)->shouldHaveBeenCalled();
}
// ------------------------------------------------------------------------
// Respond
public function testRespondDispatchesRequest()
{
$this->server->respond();
$this->dispatcher->dispatch(
Argument::any(),
$this->request,
Argument::any(),
Argument::any()
)->shouldHaveBeenCalled();
}
public function testRespondDispatchesResponse()
{
$this->server->respond();
$this->dispatcher->dispatch(
Argument::any(),
Argument::any(),
$this->response,
Argument::any()
)->shouldHaveBeenCalled();
}
public function testRespondSendsResponseToResponder()
{
$this->server->respond();
$this->transmitter->transmit(
$this->request,
$this->response
)->shouldHaveBeenCalled();
}
// ------------------------------------------------------------------------
// Router
public function testCreatesRouterWithDispatcher()
{
$this->request = $this->request
->withMethod("GET")
->withRequestTarget("/");
$router = $this->server->createRouter();
$router->register("GET", "/", "middleware");
$router($this->request, $this->response, $this->next);
$this->dispatcher->dispatch(
"middleware",
$this->request,
$this->response,
$this->next
)->shouldHaveBeenCalled();
}
// ------------------------------------------------------------------------
// Attributes
public function testAddsAttributesToRequest()
{
$attributes = [
"name" => "value"
];
$this->server->__construct($attributes);
$this->server->respond();
$isRequestWithExpectedAttribute = function ($request) {
return $request->getAttribute("name") === "value";
};
$this->dispatcher->dispatch(
Argument::any(),
Argument::that($isRequestWithExpectedAttribute),
Argument::any(),
Argument::any()
)->shouldHaveBeenCalled();
}
}

View File

@ -1,31 +1,34 @@
<?php <?php
namespace WellRESTed\Transmission; namespace WellRESTed\Test\Unit\Transmission;
use Prophecy\Argument; use Prophecy\Argument;
use Prophecy\PhpUnit\ProphecyTrait;
use Psr\Http\Message\StreamInterface; use Psr\Http\Message\StreamInterface;
use RuntimeException;
use WellRESTed\Message\Response; use WellRESTed\Message\Response;
use WellRESTed\Message\ServerRequest; use WellRESTed\Message\ServerRequest;
use WellRESTed\Test\TestCase; use WellRESTed\Transmission\HeaderStack;
use WellRESTed\Transmission\Transmitter;
class TransmitterTest extends TestCase require_once __DIR__ . "/../../../src/HeaderStack.php";
/**
* @covers WellRESTed\Transmission\Transmitter
* @group transmission
*/
class TransmitterTest extends \PHPUnit_Framework_TestCase
{ {
use ProphecyTrait;
private $request; private $request;
private $response; private $response;
private $body; private $body;
protected function setUp(): void public function setUp()
{ {
HeaderStack::reset(); HeaderStack::reset();
$this->request = (new ServerRequest()) $this->request = (new ServerRequest())
->withMethod('HEAD'); ->withMethod("HEAD");
$this->body = $this->prophesize(StreamInterface::class); $this->body = $this->prophesize('\Psr\Http\Message\StreamInterface');
$this->body->isReadable()->willReturn(false); $this->body->isReadable()->willReturn(false);
$this->body->getSize()->willReturn(1024); $this->body->getSize()->willReturn(1024);
/** @var StreamInterface $stream */ /** @var StreamInterface $stream */
@ -36,55 +39,57 @@ class TransmitterTest extends TestCase
->withBody($stream); ->withBody($stream);
} }
public function testSendStatusCodeWithReasonPhrase(): void public function testCreatesInstance()
{
$transmitter = new Transmitter();
$this->assertNotNull($transmitter);
}
public function testSendStatusCodeWithReasonPhrase()
{ {
$transmitter = new Transmitter(); $transmitter = new Transmitter();
$transmitter->transmit($this->request, $this->response); $transmitter->transmit($this->request, $this->response);
$this->assertContains('HTTP/1.1 200 OK', HeaderStack::getHeaders()); $this->assertContains("HTTP/1.1 200 OK", HeaderStack::getHeaders());
} }
public function testSendStatusCodeWithoutReasonPhrase(): void public function testSendStatusCodeWithoutReasonPhrase()
{ {
$this->response = $this->response->withStatus(999); $this->response = $this->response->withStatus(999);
$transmitter = new Transmitter(); $transmitter = new Transmitter();
$transmitter->transmit($this->request, $this->response); $transmitter->transmit($this->request, $this->response);
$this->assertContains('HTTP/1.1 999', HeaderStack::getHeaders()); $this->assertContains("HTTP/1.1 999", HeaderStack::getHeaders());
} }
/** /** @dataProvider headerProvider */
* @dataProvider headerProvider public function testSendsHeaders($header)
* @param string $header
*/
public function testSendsHeaders(string $header): void
{ {
$this->response = $this->response $this->response = $this->response
->withHeader('Content-length', ['2048']) ->withHeader("Content-length", ["2048"])
->withHeader('X-foo', ['bar', 'baz']); ->withHeader("X-foo", ["bar", "baz"]);
$transmitter = new Transmitter(); $transmitter = new Transmitter();
$transmitter->transmit($this->request, $this->response); $transmitter->transmit($this->request, $this->response);
$this->assertContains($header, HeaderStack::getHeaders()); $this->assertContains($header, HeaderStack::getHeaders());
} }
public function headerProvider(): array public function headerProvider()
{ {
return [ return [
['Content-length: 2048'], ["Content-length: 2048"],
['X-foo: bar'], ["X-foo: bar"],
['X-foo: baz'] ["X-foo: baz"]
]; ];
} }
public function testOutputsBody(): void public function testOutputsBody()
{ {
$content = 'Hello, world!'; $content = "Hello, world!";
$this->body->isReadable()->willReturn(true); $this->body->isReadable()->willReturn(true);
$this->body->__toString()->willReturn($content); $this->body->__toString()->willReturn($content);
$transmitter = new Transmitter(); $transmitter = new Transmitter();
$transmitter->setChunkSize(0);
ob_start(); ob_start();
$transmitter->transmit($this->request, $this->response); $transmitter->transmit($this->request, $this->response);
@ -94,9 +99,9 @@ class TransmitterTest extends TestCase
$this->assertEquals($content, $captured); $this->assertEquals($content, $captured);
} }
public function testOutputsBodyInChunks(): void public function testOutputsBodyInChunks()
{ {
$content = 'Hello, world!'; $content = "Hello, world!";
$chunkSize = 3; $chunkSize = 3;
$position = 0; $position = 0;
@ -127,15 +132,15 @@ class TransmitterTest extends TestCase
$this->assertEquals($content, $captured); $this->assertEquals($content, $captured);
} }
public function testOutputsUnseekableStreamInChunks(): void public function testOutputsUnseekableStreamInChunks()
{ {
$content = 'Hello, world!'; $content = "Hello, world!";
$chunkSize = 3; $chunkSize = 3;
$position = 0; $position = 0;
$this->body->isSeekable()->willReturn(false); $this->body->isSeekable()->willReturn(false);
$this->body->isReadable()->willReturn(true); $this->body->isReadable()->willReturn(true);
$this->body->rewind()->willThrow(new RuntimeException()); $this->body->rewind()->willThrow(new \RuntimeException());
$this->body->eof()->willReturn(false); $this->body->eof()->willReturn(false);
$this->body->read(Argument::any())->will( $this->body->read(Argument::any())->will(
function ($args) use ($content, &$position) { function ($args) use ($content, &$position) {
@ -160,72 +165,68 @@ class TransmitterTest extends TestCase
$this->assertEquals($content, $captured); $this->assertEquals($content, $captured);
} }
// ------------------------------------------------------------------------- // ------------------------------------------------------------------------
// Preparation // Preparation
public function testAddContentLengthHeader(): void public function testAddContentLengthHeader()
{ {
$bodySize = 1024; $bodySize = 1024;
$this->body->isReadable()->willReturn(true); $this->body->isReadable()->willReturn(true);
$this->body->__toString()->willReturn(''); $this->body->__toString()->willReturn("");
$this->body->getSize()->willReturn($bodySize); $this->body->getSize()->willReturn($bodySize);
$transmitter = new Transmitter(); $transmitter = new Transmitter();
$transmitter->setChunkSize(0);
$transmitter->transmit($this->request, $this->response); $transmitter->transmit($this->request, $this->response);
$this->assertContains("Content-length: $bodySize", HeaderStack::getHeaders()); $this->assertContains("Content-length: $bodySize", HeaderStack::getHeaders());
} }
public function testDoesNotReplaceContentLengthHeaderWhenContentLengthIsAlreadySet(): void public function testDoesNotReplaceContentLengthHeaderWhenContentLenghtIsAlreadySet()
{ {
$streamSize = 1024; $streamSize = 1024;
$headerSize = 2048; $headerSize = 2048;
$this->response = $this->response->withHeader('Content-length', $headerSize); $this->response = $this->response->withHeader("Content-length", $headerSize);
$this->body->isReadable()->willReturn(true); $this->body->isReadable()->willReturn(true);
$this->body->__toString()->willReturn(''); $this->body->__toString()->willReturn("");
$this->body->getSize()->willReturn($streamSize); $this->body->getSize()->willReturn($streamSize);
$transmitter = new Transmitter(); $transmitter = new Transmitter();
$transmitter->setChunkSize(0);
$transmitter->transmit($this->request, $this->response); $transmitter->transmit($this->request, $this->response);
$this->assertContains("Content-length: $headerSize", HeaderStack::getHeaders()); $this->assertContains("Content-length: $headerSize", HeaderStack::getHeaders());
} }
public function testDoesNotAddContentLengthHeaderWhenTransferEncodingIsChunked(): void public function testDoesNotAddContentLengthHeaderWhenTransferEncodingIsChunked()
{ {
$bodySize = 1024; $bodySize = 1024;
$this->response = $this->response->withHeader('Transfer-encoding', 'CHUNKED'); $this->response = $this->response->withHeader("Transfer-encoding", "CHUNKED");
$this->body->isReadable()->willReturn(true); $this->body->isReadable()->willReturn(true);
$this->body->__toString()->willReturn(''); $this->body->__toString()->willReturn("");
$this->body->getSize()->willReturn($bodySize); $this->body->getSize()->willReturn($bodySize);
$transmitter = new Transmitter(); $transmitter = new Transmitter();
$transmitter->setChunkSize(0);
$transmitter->transmit($this->request, $this->response); $transmitter->transmit($this->request, $this->response);
$this->assertArrayDoesNotContainValueWithPrefix(HeaderStack::getHeaders(), 'Content-length:'); $this->assertArrayDoesNotContainValueWithPrefix(HeaderStack::getHeaders(), "Content-length:");
} }
public function testDoesNotAddContentLengthHeaderWhenBodySizeIsNull(): void public function testDoesNotAddContentLengthHeaderWhenBodySizeIsNull()
{ {
$this->body->isReadable()->willReturn(true); $this->body->isReadable()->willReturn(true);
$this->body->__toString()->willReturn(''); $this->body->__toString()->willReturn("");
$this->body->getSize()->willReturn(null); $this->body->getSize()->willReturn(null);
$transmitter = new Transmitter(); $transmitter = new Transmitter();
$transmitter->setChunkSize(0);
$transmitter->transmit($this->request, $this->response); $transmitter->transmit($this->request, $this->response);
$this->assertArrayDoesNotContainValueWithPrefix(HeaderStack::getHeaders(), 'Content-length:'); $this->assertArrayDoesNotContainValueWithPrefix(HeaderStack::getHeaders(), "Content-length:");
} }
private function assertArrayDoesNotContainValueWithPrefix(array $arr, string $prefix): void private function assertArrayDoesNotContainValueWithPrefix($arr, $prefix)
{ {
$normalPrefix = strtolower($prefix); $normalPrefix = strtolower($prefix);
foreach ($arr as $item) { foreach ($arr as $item) {
@ -237,33 +238,3 @@ class TransmitterTest extends TestCase
$this->assertTrue(true); $this->assertTrue(true);
} }
} }
// -----------------------------------------------------------------------------
// Declare header function in this namespace so the class under test will use
// this instead of the internal global functions during testing.
class HeaderStack
{
private static $headers;
public static function reset()
{
self::$headers = [];
}
public static function push($header)
{
self::$headers[] = $header;
}
public static function getHeaders()
{
return self::$headers;
}
}
function header($string, $dummy = true)
{
HeaderStack::push($string);
}

View File

@ -1,219 +0,0 @@
<?php
namespace WellRESTed\Dispatching;
use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\ServerRequestInterface;
use Psr\Http\Server\RequestHandlerInterface;
use WellRESTed\Message\Response;
use WellRESTed\Message\ServerRequest;
use WellRESTed\MiddlewareInterface;
use WellRESTed\Test\Doubles\NextMock;
use WellRESTed\Test\TestCase;
class DispatcherTest extends TestCase
{
/** @var ServerRequestInterface */
private $request;
/** @var ResponseInterface */
private $response;
/** @var NextMock */
private $next;
/** @var ResponseInterface */
private $stubResponse;
protected function setUp(): void
{
$this->request = new ServerRequest();
$this->response = new Response();
$this->next = new NextMock();
$this->stubResponse = new Response();
}
/**
* Dispatch the provided dispatchable using the class under test and the
* ivars $request, $response, and $next. Return the response.
* @param $dispatchable
* @return ResponseInterface
*/
private function dispatch($dispatchable): ResponseInterface
{
$dispatcher = new Dispatcher();
return $dispatcher->dispatch(
$dispatchable,
$this->request,
$this->response,
$this->next
);
}
// -------------------------------------------------------------------------
// PSR-15 Handler
public function testDispatchesPsr15Handler(): void
{
$handler = new HandlerDouble($this->stubResponse);
$response = $this->dispatch($handler);
$this->assertSame($this->stubResponse, $response);
}
public function testDispatchesPsr15HandlerFromFactory(): void
{
$factory = function () {
return new HandlerDouble($this->stubResponse);
};
$response = $this->dispatch($factory);
$this->assertSame($this->stubResponse, $response);
}
// -------------------------------------------------------------------------
// PSR-15 Middleware
public function testDispatchesPsr15MiddlewareWithDelegate(): void
{
$this->next->upstreamResponse = $this->stubResponse;
$middleware = new MiddlewareDouble();
$response = $this->dispatch($middleware);
$this->assertSame($this->stubResponse, $response);
}
public function testDispatchesPsr15MiddlewareFromFactoryWithDelegate(): void
{
$this->next->upstreamResponse = $this->stubResponse;
$factory = function () {
return new MiddlewareDouble();
};
$response = $this->dispatch($factory);
$this->assertSame($this->stubResponse, $response);
}
// -------------------------------------------------------------------------
// Double-Pass Middleware Callable
public function testDispatchesDoublePassMiddlewareCallable(): void
{
$doublePass = function ($request, $response, $next) {
return $next($request, $this->stubResponse);
};
$response = $this->dispatch($doublePass);
$this->assertSame($this->stubResponse, $response);
}
public function testDispatchesDoublePassMiddlewareCallableFromFactory(): void
{
$factory = function () {
return function ($request, $response, $next) {
return $next($request, $this->stubResponse);
};
};
$response = $this->dispatch($factory);
$this->assertSame($this->stubResponse, $response);
}
// -------------------------------------------------------------------------
// Double-Pass Middleware Instance
public function testDispatchesDoublePassMiddlewareInstance(): void
{
$doublePass = new DoublePassMiddlewareDouble();
$response = $this->dispatch($doublePass);
$this->assertEquals(200, $response->getStatusCode());
}
public function testDispatchesDoublePassMiddlewareInstanceFromFactory(): void
{
$factory = function () {
return new DoublePassMiddlewareDouble();
};
$response = $this->dispatch($factory);
$this->assertEquals(200, $response->getStatusCode());
}
// -------------------------------------------------------------------------
// String
public function testDispatchesInstanceFromStringName(): void
{
$response = $this->dispatch(DoublePassMiddlewareDouble::class);
$this->assertEquals(200, $response->getStatusCode());
}
// -------------------------------------------------------------------------
// Arrays
public function testDispatchesArrayAsDispatchStack(): void
{
$doublePass = new DoublePassMiddlewareDouble();
$response = $this->dispatch([$doublePass]);
$this->assertEquals(200, $response->getStatusCode());
}
public function testThrowsExceptionWhenUnableToDispatch(): void
{
$this->expectException(DispatchException::class);
$this->dispatch(null);
}
}
// -----------------------------------------------------------------------------
// Doubles
/**
* Double pass middleware that sends a response with a 200 status to $next
* and return the response.
*
* This class has no constructor so that we can test instantiating from string.
*/
class DoublePassMiddlewareDouble implements MiddlewareInterface
{
public function __invoke(
ServerRequestInterface $request,
ResponseInterface $response,
$next
) {
$response = $response->withStatus(200);
return $next($request, $response);
}
}
// -----------------------------------------------------------------------------
/**
* PSR-15 Handler that returns a ResponseInterface stub
*/
class HandlerDouble implements RequestHandlerInterface
{
/** @var ResponseInterface */
private $response;
public function __construct(ResponseInterface $response)
{
$this->response = $response;
}
public function handle(ServerRequestInterface $request): ResponseInterface
{
return $this->response;
}
}
// -----------------------------------------------------------------------------
/**
* PSR-15 Middleware that passes the request to the delegate and returns the
* delegate's response
*/
class MiddlewareDouble implements \Psr\Http\Server\MiddlewareInterface
{
public function process(
ServerRequestInterface $request,
RequestHandlerInterface $handler
): ResponseInterface {
return $handler->handle($request);
}
}

View File

@ -1,104 +0,0 @@
<?php
namespace WellRESTed\Message;
use WellRESTed\Test\TestCase;
class HeaderCollectionTest extends TestCase
{
public function testAddsSingleHeaderAndIndicatesCaseInsensitiveIsset(): void
{
$collection = new HeaderCollection();
$collection['Content-Type'] = 'application/json';
$this->assertTrue(isset($collection['content-type']));
}
public function testAddsMultipleHeadersAndIndicatesCaseInsensitiveIsset(): void
{
$collection = new HeaderCollection();
$collection['Set-Cookie'] = 'cat=Molly';
$collection['SET-COOKIE'] = 'dog=Bear';
$this->assertTrue(isset($collection['set-cookie']));
}
public function testReturnsHeadersWithCaseInsensitiveHeaderName(): void
{
$collection = new HeaderCollection();
$collection['Set-Cookie'] = 'cat=Molly';
$collection['SET-COOKIE'] = 'dog=Bear';
$headers = $collection['set-cookie'];
$matched = array_intersect($headers, ['cat=Molly', 'dog=Bear']);
$this->assertCount(2, $matched);
}
public function testRemovesHeadersWithCaseInsensitiveHeaderName(): void
{
$collection = new HeaderCollection();
$collection['Set-Cookie'] = 'cat=Molly';
$collection['SET-COOKIE'] = 'dog=Bear';
unset($collection['set-cookie']);
$this->assertFalse(isset($collection['set-cookie']));
}
public function testCloneMakesDeepCopyOfHeaders(): void
{
$collection = new HeaderCollection();
$collection['Set-Cookie'] = 'cat=Molly';
$clone = clone $collection;
unset($clone['Set-Cookie']);
$this->assertTrue(isset($collection['set-cookie']) && !isset($clone['set-cookie']));
}
public function testIteratesWithOriginalKeys(): void
{
$collection = new HeaderCollection();
$collection['Content-length'] = '100';
$collection['Set-Cookie'] = 'cat=Molly';
$collection['Set-Cookie'] = 'dog=Bear';
$collection['Content-type'] = 'application/json';
unset($collection['Content-length']);
$headers = [];
foreach ($collection as $key => $values) {
$headers[] = $key;
}
$expected = ['Content-type', 'Set-Cookie'];
$countUnmatched = count(array_diff($expected, $headers)) + count(array_diff($headers, $expected));
$this->assertEquals(0, $countUnmatched);
}
public function testIteratesWithOriginalKeysAndValues(): void
{
$collection = new HeaderCollection();
$collection['Content-length'] = '100';
$collection['Set-Cookie'] = 'cat=Molly';
$collection['Set-Cookie'] = 'dog=Bear';
$collection['Content-type'] = 'application/json';
unset($collection['Content-length']);
$headers = [];
foreach ($collection as $key => $values) {
foreach ($values as $value) {
if (isset($headers[$key])) {
$headers[$key][] = $value;
} else {
$headers[$key] = [$value];
}
}
}
$expected = [
'Set-Cookie' => ['cat=Molly', 'dog=Bear'],
'Content-type' => ['application/json']
];
$this->assertEquals($expected, $headers);
}
}

View File

@ -1,250 +0,0 @@
<?php
namespace WellRESTed\Message;
use InvalidArgumentException;
use WellRESTed\Test\TestCase;
class MessageTest extends TestCase
{
public function testSetsHeadersWithStringValueOnConstruction(): void
{
$headers = ['X-foo' => 'bar'];
$message = new Response(200, $headers);
$this->assertEquals(['bar'], $message->getHeader('X-foo'));
}
public function testSetsHeadersWithArrayValueOnConstruction(): void
{
$headers = ['X-foo' => ['bar', 'baz']];
$message = new Response(200, $headers);
$this->assertEquals(['bar', 'baz'], $message->getHeader('X-foo'));
}
public function testSetsBodyOnConstruction(): void
{
$body = new Stream('Hello, world');
$message = new Response(200, [], $body);
$this->assertSame($body, $message->getBody());
}
public function testCloneMakesDeepCopyOfHeaders(): void
{
$message1 = (new Response())
->withHeader('Content-type', 'text/plain');
$message2 = $message1
->withHeader('Content-type', 'application/json');
$this->assertNotEquals(
$message1->getHeader('Content-type'),
$message2->getHeader('Content-type')
);
}
// -------------------------------------------------------------------------
// Protocol Version
public function testGetProtocolVersionReturnsProtocolVersion1Point1ByDefault(): void
{
$message = new Response();
$this->assertEquals('1.1', $message->getProtocolVersion());
}
public function testGetProtocolVersionReturnsProtocolVersion(): void
{
$message = (new Response())
->withProtocolVersion('1.0');
$this->assertEquals('1.0', $message->getProtocolVersion());
}
public function testGetProtocolVersionReplacesProtocolVersion(): void
{
$message = (new Response())
->withProtocolVersion('1.0');
$this->assertEquals('1.0', $message->getProtocolVersion());
}
// -------------------------------------------------------------------------
// Headers
/**
* @dataProvider validHeaderValueProvider
* @param array $expected
* @param mixed $value
*/
public function testWithHeaderReplacesHeader(array $expected, $value): void
{
$message = (new Response())
->withHeader('X-foo', 'Original value')
->withHeader('X-foo', $value);
$this->assertEquals($expected, $message->getHeader('X-foo'));
}
public function validHeaderValueProvider(): array
{
return [
[['0'], 0],
[['molly','bear'],['molly','bear']]
];
}
/**
* @dataProvider invalidHeaderProvider
* @param mixed $name
* @param mixed $value
*/
public function testWithHeaderThrowsExceptionWithInvalidArgument($name, $value): void
{
$this->expectException(InvalidArgumentException::class);
(new Response())
->withHeader($name, $value);
}
public function invalidHeaderProvider(): array
{
return [
[0, 1024],
['Content-length', false],
['Content-length', [false]]
];
}
public function testWithAddedHeaderSetsHeader(): void
{
$message = (new Response())
->withAddedHeader('Content-type', 'application/json');
$this->assertEquals(['application/json'], $message->getHeader('Content-type'));
}
public function testWithAddedHeaderAppendsValue(): void
{
$message = (new Response())
->withAddedHeader('Set-Cookie', ['cat=Molly'])
->withAddedHeader('Set-Cookie', ['dog=Bear']);
$cookies = $message->getHeader('Set-Cookie');
$this->assertTrue(
in_array('cat=Molly', $cookies) &&
in_array('dog=Bear', $cookies)
);
}
public function testWithoutHeaderRemovesHeader(): void
{
$message = (new Response())
->withHeader('Content-type', 'application/json')
->withoutHeader('Content-type');
$this->assertFalse($message->hasHeader('Content-type'));
}
public function testGetHeaderReturnsEmptyArrayForUnsetHeader(): void
{
$message = new Response();
$this->assertEquals([], $message->getHeader('X-name'));
}
public function testGetHeaderReturnsSingleHeader(): void
{
$message = (new Response())
->withAddedHeader('Content-type', 'application/json');
$this->assertEquals(['application/json'], $message->getHeader('Content-type'));
}
public function testGetHeaderReturnsMultipleValuesForHeader(): void
{
$message = (new Response())
->withAddedHeader('X-name', 'cat=Molly')
->withAddedHeader('X-name', 'dog=Bear');
$this->assertEquals(['cat=Molly', 'dog=Bear'], $message->getHeader('X-name'));
}
public function testGetHeaderLineReturnsEmptyStringForUnsetHeader(): void
{
$message = new Response();
$this->assertSame('', $message->getHeaderLine('X-not-set'));
}
public function testGetHeaderLineReturnsMultipleHeadersJoinedByCommas(): void
{
$message = (new Response())
->withAddedHeader('X-name', 'cat=Molly')
->withAddedHeader('X-name', 'dog=Bear');
$this->assertEquals('cat=Molly, dog=Bear', $message->getHeaderLine('X-name'));
}
public function testHasHeaderReturnsTrueWhenHeaderIsSet(): void
{
$message = (new Response())
->withHeader('Content-type', 'application/json');
$this->assertTrue($message->hasHeader('Content-type'));
}
public function testHasHeaderReturnsFalseWhenHeaderIsNotSet(): void
{
$message = new Response();
$this->assertFalse($message->hasHeader('Content-type'));
}
public function testGetHeadersReturnOriginalHeaderNamesAsKeys(): void
{
$message = (new Response())
->withHeader('Set-Cookie', 'cat=Molly')
->withAddedHeader('Set-Cookie', 'dog=Bear')
->withHeader('Content-type', 'application/json');
$headers = [];
foreach ($message->getHeaders() as $key => $values) {
$headers[] = $key;
}
$expected = ['Content-type', 'Set-Cookie'];
$countUnmatched
= count(array_diff($expected, $headers))
+ count(array_diff($headers, $expected));
$this->assertEquals(0, $countUnmatched);
}
public function testGetHeadersReturnOriginalHeaderNamesAndValues(): void
{
$message = (new Response())
->withHeader('Set-Cookie', 'cat=Molly')
->withAddedHeader('Set-Cookie', 'dog=Bear')
->withHeader('Content-type', 'application/json');
$headers = [];
foreach ($message->getHeaders() as $key => $values) {
foreach ($values as $value) {
if (isset($headers[$key])) {
$headers[$key][] = $value;
} else {
$headers[$key] = [$value];
}
}
}
$expected = [
'Set-Cookie' => ['cat=Molly', 'dog=Bear'],
'Content-type' => ['application/json']
];
$this->assertEquals($expected, $headers);
}
// -------------------------------------------------------------------------
// Body
public function testGetBodyReturnsEmptyStreamByDefault(): void
{
$message = new Response();
$this->assertEquals('', (string) $message->getBody());
}
public function testGetBodyReturnsAttachedStream(): void
{
$stream = new Stream('Hello, world!');
$message = (new Response())
->withBody($stream);
$this->assertSame($stream, $message->getBody());
}
}

View File

@ -1,109 +0,0 @@
<?php
namespace WellRESTed\Message;
use RuntimeException;
use WellRESTed\Test\TestCase;
class NullStreamTest extends TestCase
{
public function testCastsToString(): void
{
$stream = new NullStream();
$this->assertEquals('', (string) $stream);
}
public function testCloseDoesNothing(): void
{
$stream = new NullStream();
$stream->close();
$this->assertTrue(true); // Asserting no exception occurred.
}
public function testDetachReturnsNull(): void
{
$stream = new NullStream();
$this->assertNull($stream->detach());
}
public function testSizeReturnsZero(): void
{
$stream = new NullStream();
$this->assertEquals(0, $stream->getSize());
}
public function testTellReturnsZero(): void
{
$stream = new NullStream();
$this->assertEquals(0, $stream->tell());
}
public function testEofReturnsTrue(): void
{
$stream = new NullStream();
$this->assertTrue($stream->eof());
}
public function testIsSeekableReturnsFalse(): void
{
$stream = new NullStream();
$this->assertFalse($stream->isSeekable());
}
public function testSeekReturnsFalse(): void
{
$this->expectException(RuntimeException::class);
$stream = new NullStream();
$stream->seek(10);
}
public function testRewindThrowsException(): void
{
$this->expectException(RuntimeException::class);
$stream = new NullStream();
$stream->rewind();
}
public function testIsWritableReturnsFalse(): void
{
$stream = new NullStream();
$this->assertFalse($stream->isWritable());
}
public function testWriteThrowsException(): void
{
$this->expectException(RuntimeException::class);
$stream = new NullStream();
$stream->write('');
}
public function testIsReadableReturnsTrue(): void
{
$stream = new NullStream();
$this->assertTrue($stream->isReadable());
}
public function testReadReturnsEmptyString(): void
{
$stream = new NullStream();
$this->assertEquals('', $stream->read(100));
}
public function testGetContentsReturnsEmptyString(): void
{
$stream = new NullStream();
$this->assertEquals('', $stream->getContents());
}
public function testGetMetadataReturnsNull(): void
{
$stream = new NullStream();
$this->assertNull($stream->getMetadata());
}
public function testGetMetadataReturnsNullWithKey(): void
{
$stream = new NullStream();
$this->assertNull($stream->getMetadata('size'));
}
}

View File

@ -1,206 +0,0 @@
<?php
namespace WellRESTed\Message;
use InvalidArgumentException;
use WellRESTed\Test\TestCase;
class RequestTest extends TestCase
{
// -------------------------------------------------------------------------
// Construction
public function testCreatesInstanceWithNoParameters(): void
{
$request = new Request();
$this->assertNotNull($request);
}
public function testCreatesInstanceWithMethod(): void
{
$method = 'POST';
$request = new Request($method);
$this->assertSame($method, $request->getMethod());
}
public function testCreatesInstanceWithUri(): void
{
$uri = new Uri();
$request = new Request('GET', $uri);
$this->assertSame($uri, $request->getUri());
}
public function testCreatesInstanceWithStringUri(): void
{
$uri = 'http://localhost:8080';
$request = new Request('GET', $uri);
$this->assertSame($uri, (string) $request->getUri());
}
public function testSetsHeadersOnConstruction(): void
{
$request = new Request('GET', '/', [
'X-foo' => ['bar', 'baz']
]);
$this->assertEquals(['bar', 'baz'], $request->getHeader('X-foo'));
}
public function testSetsBodyOnConstruction(): void
{
$body = new NullStream();
$request = new Request('GET', '/', [], $body);
$this->assertSame($body, $request->getBody());
}
// -------------------------------------------------------------------------
// Request Target
public function testGetRequestTargetPrefersExplicitRequestTarget(): void
{
$request = new Request();
$request = $request->withRequestTarget('*');
$this->assertEquals('*', $request->getRequestTarget());
}
public function testGetRequestTargetUsesOriginFormOfUri(): void
{
$uri = new Uri('/my/path?cat=Molly&dog=Bear');
$request = new Request();
$request = $request->withUri($uri);
$this->assertEquals('/my/path?cat=Molly&dog=Bear', $request->getRequestTarget());
}
public function testGetRequestTargetReturnsSlashByDefault(): void
{
$request = new Request();
$this->assertEquals('/', $request->getRequestTarget());
}
public function testWithRequestTargetCreatesNewInstance(): void
{
$request = new Request();
$request = $request->withRequestTarget('*');
$this->assertEquals('*', $request->getRequestTarget());
}
// -------------------------------------------------------------------------
// Method
public function testGetMethodReturnsGetByDefault(): void
{
$request = new Request();
$this->assertEquals('GET', $request->getMethod());
}
public function testWithMethodCreatesNewInstance(): void
{
$request = new Request();
$request = $request->withMethod('POST');
$this->assertEquals('POST', $request->getMethod());
}
/**
* @dataProvider invalidMethodProvider
* @param mixed $method
*/
public function testWithMethodThrowsExceptionOnInvalidMethod($method): void
{
$this->expectException(InvalidArgumentException::class);
$request = new Request();
$request->withMethod($method);
}
public function invalidMethodProvider(): array
{
return [
[0],
[false],
['WITH SPACE']
];
}
// -------------------------------------------------------------------------
// Request URI
public function testGetUriReturnsEmptyUriByDefault(): void
{
$request = new Request();
$uri = new Uri();
$this->assertEquals($uri, $request->getUri());
}
public function testWithUriCreatesNewInstance(): void
{
$uri = new Uri();
$request = new Request();
$request = $request->withUri($uri);
$this->assertSame($uri, $request->getUri());
}
public function testWithUriPreservesOriginalRequest(): void
{
$uri1 = new Uri();
$uri2 = new Uri();
$request1 = new Request();
$request1 = $request1->withUri($uri1);
$request1 = $request1->withHeader('Accept', 'application/json');
$request2 = $request1->withUri($uri2);
$request2 = $request2->withHeader('Accept', 'text/plain');
$this->assertNotEquals($request1->getHeader('Accept'), $request2->getHeader('Accept'));
}
public function testWithUriUpdatesHostHeader(): void
{
$hostname = 'bar.com';
$uri = new uri("http://$hostname");
$request = new Request();
$request = $request->withHeader('Host', 'foo.com');
$request = $request->withUri($uri);
$this->assertSame([$hostname], $request->getHeader('Host'));
}
public function testWithUriDoesNotUpdatesHostHeaderWhenUriHasNoHost(): void
{
$hostname = 'foo.com';
$uri = new Uri();
$request = new Request();
$request = $request->withHeader('Host', $hostname);
$request = $request->withUri($uri);
$this->assertSame([$hostname], $request->getHeader('Host'));
}
public function testPreserveHostUpdatesHostHeaderWhenHeaderIsOriginallyMissing(): void
{
$hostname = 'foo.com';
$uri = new uri("http://$hostname");
$request = new Request();
$request = $request->withUri($uri, true);
$this->assertSame([$hostname], $request->getHeader('Host'));
}
public function testPreserveHostDoesNotUpdatesWhenBothAreMissingHosts(): void
{
$uri = new Uri();
$request = new Request();
$request = $request->withUri($uri, true);
$this->assertSame([], $request->getHeader('Host'));
}
public function testPreserveHostDoesNotUpdateHostHeader(): void
{
$hostname = 'foo.com';
$uri = new uri('http://bar.com');
$request = new Request();
$request = $request->withHeader('Host', $hostname);
$request = $request->withUri($uri, true);
$this->assertSame([$hostname], $request->getHeader('Host'));
}
}

View File

@ -1,44 +0,0 @@
<?php
namespace WellRESTed\Message;
use WellRESTed\Test\TestCase;
class ResponseFactoryTest extends TestCase
{
public function testCreatesResponseWithStatusCode200ByDefault(): void
{
$statusCode = 200;
$reasonPhrase = 'OK';
$factory = new ResponseFactory();
$response = $factory->createResponse();
$this->assertEquals($statusCode, $response->getStatusCode());
$this->assertEquals($reasonPhrase, $response->getReasonPhrase());
}
public function testCreateResponseWithStatusCode(): void
{
$statusCode = 201;
$reasonPhrase = 'Created';
$factory = new ResponseFactory();
$response = $factory->createResponse($statusCode);
$this->assertEquals($statusCode, $response->getStatusCode());
$this->assertEquals($reasonPhrase, $response->getReasonPhrase());
}
public function testCreateResponseWithStatusCodeAndCustomReasonPhrase(): void
{
$statusCode = 512;
$reasonPhrase = 'Shortage of Chairs';
$factory = new ResponseFactory();
$response = $factory->createResponse($statusCode, $reasonPhrase);
$this->assertEquals($statusCode, $response->getStatusCode());
$this->assertEquals($reasonPhrase, $response->getReasonPhrase());
}
}

View File

@ -1,115 +0,0 @@
<?php
namespace WellRESTed\Message;
use WellRESTed\Test\TestCase;
class ResponseTest extends TestCase
{
// -------------------------------------------------------------------------
// Construction
public function testSetsStatusCodeOnConstruction(): void
{
$response = new Response(200);
$this->assertSame(200, $response->getStatusCode());
}
public function testSetsHeadersOnConstruction(): void
{
$response = new Response(200, [
'X-foo' => ['bar','baz']
]);
$this->assertEquals(['bar','baz'], $response->getHeader('X-foo'));
}
public function testSetsBodyOnConstruction(): void
{
$body = new NullStream();
$response = new Response(200, [], $body);
$this->assertSame($body, $response->getBody());
}
// -------------------------------------------------------------------------
// Status and Reason Phrase
public function testCreatesNewInstanceWithStatusCode(): void
{
$response = new Response();
$copy = $response->withStatus(200);
$this->assertEquals(200, $copy->getStatusCode());
}
/**
* @dataProvider statusProvider
* @param int $code
* @param string|null $reasonPhrase
* @param string $expected
*/
public function testCreatesNewInstanceWithReasonPhrase(
int $code,
?string $reasonPhrase,
string $expected
): void {
$response = new Response();
$copy = $response->withStatus($code, $reasonPhrase);
$this->assertEquals($expected, $copy->getReasonPhrase());
}
public function statusProvider(): array
{
return [
[100, null, 'Continue'],
[101, null, 'Switching Protocols'],
[200, null, 'OK'],
[201, null, 'Created'],
[202, null, 'Accepted'],
[203, null, 'Non-Authoritative Information'],
[204, null, 'No Content'],
[205, null, 'Reset Content'],
[206, null, 'Partial Content'],
[300, null, 'Multiple Choices'],
[301, null, 'Moved Permanently'],
[302, null, 'Found'],
[303, null, 'See Other'],
[304, null, 'Not Modified'],
[305, null, 'Use Proxy'],
[400, null, 'Bad Request'],
[401, null, 'Unauthorized'],
[402, null, 'Payment Required'],
[403, null, 'Forbidden'],
[404, null, 'Not Found'],
[405, null, 'Method Not Allowed'],
[406, null, 'Not Acceptable'],
[407, null, 'Proxy Authentication Required'],
[408, null, 'Request Timeout'],
[409, null, 'Conflict'],
[410, null, 'Gone'],
[411, null, 'Length Required'],
[412, null, 'Precondition Failed'],
[413, null, 'Payload Too Large'],
[414, null, 'URI Too Long'],
[415, null, 'Unsupported Media Type'],
[500, null, 'Internal Server Error'],
[501, null, 'Not Implemented'],
[502, null, 'Bad Gateway'],
[503, null, 'Service Unavailable'],
[504, null, 'Gateway Timeout'],
[505, null, 'HTTP Version Not Supported'],
[598, null, ''],
[599, 'Nonstandard', 'Nonstandard']
];
}
public function testWithStatusCodePreservesOriginalResponse(): void
{
$response1 = new Response();
$response1 = $response1->withStatus(200);
$response1 = $response1->withHeader('Content-type', 'application/json');
$response2 = $response1->withStatus(404);
$response2 = $response2->withHeader('Content-type', 'text/plain');
$this->assertNotEquals($response1->getStatusCode(), $response2->getHeader('Content-type'));
}
}

View File

@ -1,400 +0,0 @@
<?php
namespace WellRESTed\Message;
use Psr\Http\Message\UploadedFileInterface;
use Psr\Http\Message\UriInterface;
use WellRESTed\Test\TestCase;
/** @backupGlobals enabled */
class ServerRequestMarshallerTest extends TestCase
{
/** @var ServerRequestMarshaller */
private $marshaller;
protected function setUp(): void
{
parent::setUp();
$_SERVER = [
'HTTP_HOST' => 'localhost',
'HTTP_ACCEPT' => 'application/json',
'HTTP_CONTENT_TYPE' => 'application/x-www-form-urlencoded',
'QUERY_STRING' => 'cat=molly&kitten=aggie'
];
$_COOKIE = [
'dog' => 'Bear',
'hamster' => 'Dusty'
];
FopenHelper::$inputTempFile = null;
$this->marshaller = new ServerRequestMarshaller();
}
// -------------------------------------------------------------------------
// Psr\Http\Message\MessageInterface
// -------------------------------------------------------------------------
// Protocol Version
/**
* @dataProvider protocolVersionProvider
* @param $expectedProtocol
* @param $actualProtocol
*/
public function testProvidesProtocolVersion(string $expectedProtocol, ?string $actualProtocol): void
{
$_SERVER['SERVER_PROTOCOL'] = $actualProtocol;
$request = $this->marshaller->getServerRequest();
$this->assertEquals($expectedProtocol, $request->getProtocolVersion());
}
public function protocolVersionProvider(): array
{
return [
['1.1', 'HTTP/1.1'],
['1.0', 'HTTP/1.0'],
['1.1', null],
['1.1', 'INVALID']
];
}
// -------------------------------------------------------------------------
// Headers
public function testProvidesHeadersFromHttpFields(): void
{
$_SERVER = [
'HTTP_ACCEPT' => 'application/json',
'HTTP_CONTENT_TYPE' => 'application/x-www-form-urlencoded'
];
$request = $this->marshaller->getServerRequest();
$this->assertEquals(['application/json'], $request->getHeader('Accept'));
$this->assertEquals(['application/x-www-form-urlencoded'], $request->getHeader('Content-type'));
}
public function testProvidesApacheContentHeaders(): void
{
$_SERVER = [
'CONTENT_LENGTH' => '1024',
'CONTENT_TYPE' => 'application/json'
];
$request = $this->marshaller->getServerRequest();
$this->assertEquals('1024', $request->getHeaderLine('Content-length'));
$this->assertEquals('application/json', $request->getHeaderLine('Content-type'));
}
public function testDoesNotProvideEmptyApacheContentHeaders(): void
{
$_SERVER = [
'CONTENT_LENGTH' => '',
'CONTENT_TYPE' => ' '
];
$request = $this->marshaller->getServerRequest();
$this->assertFalse($request->hasHeader('Content-length'));
$this->assertFalse($request->hasHeader('Content-type'));
}
// -------------------------------------------------------------------------
// Body
public function testProvidesBodyFromInputStream(): void
{
$tempFilePath = tempnam(sys_get_temp_dir(), 'test');
$content = 'Body content';
file_put_contents($tempFilePath, $content);
FopenHelper::$inputTempFile = $tempFilePath;
$request = $this->marshaller->getServerRequest();
unlink($tempFilePath);
$this->assertEquals($content, (string) $request->getBody());
}
// -------------------------------------------------------------------------
// Psr\Http\Message\RequestInterface
// -------------------------------------------------------------------------
// Request Target
/**
* @dataProvider requestTargetProvider
* @param $expectedRequestTarget
* @param $actualRequestUri
*/
public function testProvidesRequestTarget(string $expectedRequestTarget, ?string $actualRequestUri): void
{
$_SERVER['REQUEST_URI'] = $actualRequestUri;
$request = $this->marshaller->getServerRequest();
$this->assertEquals($expectedRequestTarget, $request->getRequestTarget());
}
public function requestTargetProvider(): array
{
return [
['/', '/'],
['/hello', '/hello'],
['/my/path.txt', '/my/path.txt'],
['/', null]
];
}
// -------------------------------------------------------------------------
// Method
/**
* @dataProvider methodProvider
* @param $expectedMethod
* @param $serverMethod
*/
public function testProvidesMethod($expectedMethod, $serverMethod)
{
$_SERVER['REQUEST_METHOD'] = $serverMethod;
$request = $this->marshaller->getServerRequest();
$this->assertEquals($expectedMethod, $request->getMethod());
}
public function methodProvider()
{
return [
['GET', 'GET'],
['POST', 'POST'],
['DELETE', 'DELETE'],
['PUT', 'PUT'],
['OPTIONS', 'OPTIONS'],
['GET', null]
];
}
// -------------------------------------------------------------------------
// URI
/**
* @dataProvider uriProvider
* @param UriInterface $expected
* @param array $serverParams
*/
public function testProvidesUri(UriInterface $expected, array $serverParams): void
{
$_SERVER = $serverParams;
$request = $this->marshaller->getServerRequest();
$this->assertEquals($expected, $request->getUri());
}
public function uriProvider()
{
return [
[
new Uri('http://localhost/path'),
[
'HTTPS' => 'off',
'HTTP_HOST' => 'localhost',
'REQUEST_URI' => '/path',
'QUERY_STRING' => ''
]
],
[
new Uri('https://foo.com/path/to/stuff?cat=molly'),
[
'HTTPS' => '1',
'HTTP_HOST' => 'foo.com',
'REQUEST_URI' => '/path/to/stuff?cat=molly',
'QUERY_STRING' => 'cat=molly'
]
],
[
new Uri('http://foo.com:8080/path/to/stuff?cat=molly'),
[
'HTTP' => '1',
'HTTP_HOST' => 'foo.com:8080',
'REQUEST_URI' => '/path/to/stuff?cat=molly',
'QUERY_STRING' => 'cat=molly'
]
]
];
}
// -------------------------------------------------------------------------
// Psr\Http\Message\ServerRequestInterface
// -------------------------------------------------------------------------
// Server Params
public function testProvidesServerParams(): void
{
$request = $this->marshaller->getServerRequest();
$this->assertEquals($_SERVER, $request->getServerParams());
}
// -------------------------------------------------------------------------
// Cookies
public function testProvidesCookieParams(): void
{
$request = $this->marshaller->getServerRequest();
$this->assertEquals($_COOKIE, $request->getCookieParams());
}
// -------------------------------------------------------------------------
// Query
public function testProvidesQueryParams(): void
{
$request = $this->marshaller->getServerRequest();
$query = $request->getQueryParams();
$this->assertCount(2, $query);
$this->assertEquals('molly', $query['cat']);
$this->assertEquals('aggie', $query['kitten']);
}
// -------------------------------------------------------------------------
// Uploaded Files
/**
* @dataProvider uploadedFileProvider
* @param UploadedFileInterface $file
* @param array $path
*/
public function testGetServerRequestReadsUploadedFiles(UploadedFileInterface $file, array $path): void
{
$_FILES = [
'single' => [
'name' => 'single.txt',
'type' => 'text/plain',
'tmp_name' => '/tmp/php9hNlHe',
'error' => UPLOAD_ERR_OK,
'size' => 524
],
'nested' => [
'level2' => [
'name' => 'nested.json',
'type' => 'application/json',
'tmp_name' => '/tmp/phpadhjk',
'error' => UPLOAD_ERR_OK,
'size' => 1024
]
],
'nestedList' => [
'level2' => [
'name' => [
0 => 'nestedList0.jpg',
1 => 'nestedList1.jpg',
2 => ''
],
'type' => [
0 => 'image/jpeg',
1 => 'image/jpeg',
2 => ''
],
'tmp_name' => [
0 => '/tmp/phpjpg0',
1 => '/tmp/phpjpg1',
2 => ''
],
'error' => [
0 => UPLOAD_ERR_OK,
1 => UPLOAD_ERR_OK,
2 => UPLOAD_ERR_NO_FILE
],
'size' => [
0 => 256,
1 => 4096,
2 => 0
]
]
],
'nestedDictionary' => [
'level2' => [
'name' => [
'file0' => 'nestedDictionary0.jpg',
'file1' => 'nestedDictionary1.jpg'
],
'type' => [
'file0' => 'image/png',
'file1' => 'image/png'
],
'tmp_name' => [
'file0' => '/tmp/phppng0',
'file1' => '/tmp/phppng1'
],
'error' => [
'file0' => UPLOAD_ERR_OK,
'file1' => UPLOAD_ERR_OK
],
'size' => [
'file0' => 256,
'file1' => 4096
]
]
]
];
$request = $this->marshaller->getServerRequest();
$current = $request->getUploadedFiles();
foreach ($path as $item) {
$current = $current[$item];
}
$this->assertEquals($file, $current);
}
public function uploadedFileProvider(): array
{
return [
[new UploadedFile('single.txt', 'text/plain', 524, '/tmp/php9hNlHe', UPLOAD_ERR_OK), ['single']],
[new UploadedFile('nested.json', 'application/json', 1024, '/tmp/phpadhjk', UPLOAD_ERR_OK), ['nested', 'level2']],
[new UploadedFile('nestedList0.jpg', 'image/jpeg', 256, '/tmp/phpjpg0', UPLOAD_ERR_OK), ['nestedList', 'level2', 0]],
[new UploadedFile('nestedList1.jpg', 'image/jpeg', 4096, '/tmp/phpjpg1', UPLOAD_ERR_OK), ['nestedList', 'level2', 1]],
[new UploadedFile('', '', 0, '', UPLOAD_ERR_NO_FILE), ['nestedList', 'level2', 2]],
[new UploadedFile('nestedDictionary0.jpg', 'image/png', 256, '/tmp/phppng0', UPLOAD_ERR_OK), ['nestedDictionary', 'level2', 'file0']],
[new UploadedFile('nestedDictionary1.jpg', 'image/png', 4096, '/tmp/phppngg1', UPLOAD_ERR_OK), ['nestedDictionary', 'level2', 'file1']]
];
}
// -------------------------------------------------------------------------
// Parsed Body
/**
* @dataProvider formContentTypeProvider
* @param string $contentType
*/
public function testProvidesParsedBodyForForms(string $contentType): void
{
$_SERVER['HTTP_CONTENT_TYPE'] = $contentType;
$_POST = [
'dog' => 'Bear'
];
$request = $this->marshaller->getServerRequest();
$this->assertEquals('Bear', $request->getParsedBody()['dog']);
}
public function formContentTypeProvider(): array
{
return [
['application/x-www-form-urlencoded'],
['multipart/form-data']
];
}
}
// -----------------------------------------------------------------------------
// Declare fopen function in this namespace so the class under test will use
// this instead of the internal global functions during testing.
class FopenHelper
{
/**
* @var string Path to temp file to read in place of 'php://input'
*/
public static $inputTempFile;
}
function fopen($filename, $mode)
{
if (FopenHelper::$inputTempFile && $filename === 'php://input') {
$filename = FopenHelper::$inputTempFile;
}
return \fopen($filename, $mode);
}

View File

@ -1,315 +0,0 @@
<?php
namespace WellRESTed\Message;
use InvalidArgumentException;
use WellRESTed\Test\TestCase;
class ServerRequestTest extends TestCase
{
// -------------------------------------------------------------------------
// Server Params
public function testGetServerParamsReturnsEmptyArrayByDefault(): void
{
$request = new ServerRequest();
$this->assertEquals([], $request->getServerParams());
}
// -------------------------------------------------------------------------
// Cookies
public function testGetCookieParamsReturnsEmptyArrayByDefault(): void
{
$request = new ServerRequest();
$this->assertEquals([], $request->getCookieParams());
}
public function testWithCookieParamsCreatesNewInstanceWithCookies(): void
{
$cookies = [
'cat' => 'Oscar'
];
$request1 = new ServerRequest();
$request2 = $request1->withCookieParams($cookies);
$this->assertEquals($cookies, $request2->getCookieParams());
$this->assertNotSame($request2, $request1);
}
// -------------------------------------------------------------------------
// Query
public function testGetQueryParamsReturnsEmptyArrayByDefault(): void
{
$request = new ServerRequest();
$this->assertEquals([], $request->getQueryParams());
}
public function testWithQueryParamsCreatesNewInstance(): void
{
$query = [
'cat' => 'Aggie'
];
$request1 = new ServerRequest();
$request2 = $request1->withQueryParams($query);
$this->assertEquals($query, $request2->getQueryParams());
$this->assertNotSame($request2, $request1);
}
// -------------------------------------------------------------------------
// Uploaded Files
public function testGetUploadedFilesReturnsEmptyArrayByDefault(): void
{
$request = new ServerRequest();
$this->assertEquals([], $request->getUploadedFiles());
}
public function testWithUploadedFilesCreatesNewInstance(): void
{
$uploadedFiles = [
'file' => new UploadedFile('index.html', 'text/html', 524, '/tmp/php9hNlHe', 0)
];
$request = new ServerRequest();
$request1 = $request->withUploadedFiles([]);
$request2 = $request1->withUploadedFiles($uploadedFiles);
$this->assertNotSame($request2, $request1);
}
/**
* @dataProvider validUploadedFilesProvider
* @param array $uploadedFiles
*/
public function testWithUploadedFilesStoresPassedUploadedFiles(array $uploadedFiles): void
{
$request = new ServerRequest();
$request = $request->withUploadedFiles($uploadedFiles);
$this->assertSame($uploadedFiles, $request->getUploadedFiles());
}
public function validUploadedFilesProvider(): array
{
return [
[[]],
[['files' => new UploadedFile('index.html', 'text/html', 524, '/tmp/php9hNlHe', 0)]],
[['nested' => [
'level2' => new UploadedFile('index.html', 'text/html', 524, '/tmp/php9hNlHe', 0)
]]],
[['nestedList' => [
'level2' => [
new UploadedFile('file1.html', 'text/html', 524, '/tmp/php9hNlHe', 0),
new UploadedFile('file2.html', 'text/html', 524, '/tmp/php9hNshj', 0)
]
]]],
[['nestedDictionary' => [
'level2' => [
'file1' => new UploadedFile('file1.html', 'text/html', 524, '/tmp/php9hNlHe', 0),
'file2' => new UploadedFile('file2.html', 'text/html', 524, '/tmp/php9hNshj', 0)
]
]]]
];
}
/**
* @dataProvider invalidUploadedFilesProvider
* @param array $uploadedFiles
*/
public function testWithUploadedFilesThrowsExceptionWithInvalidTree(array $uploadedFiles): void
{
$this->expectException(InvalidArgumentException::class);
$request = new ServerRequest();
$request->withUploadedFiles($uploadedFiles);
}
public function invalidUploadedFilesProvider()
{
return [
// All keys must be strings
[[new UploadedFile('index.html', 'text/html', 524, '/tmp/php9hNlHe', 0)]],
[
[new UploadedFile('index1.html', 'text/html', 524, '/tmp/php9hNlHe', 0)],
[new UploadedFile('index2.html', 'text/html', 524, '/tmp/php9hNlHe', 0)]
],
[
'single' => [
'name' => 'single.txt',
'type' => 'text/plain',
'tmp_name' => '/tmp/php9hNlHe',
'error' => UPLOAD_ERR_OK,
'size' => 524
],
'nested' => [
'level2' => [
'name' => 'nested.json',
'type' => 'application/json',
'tmp_name' => '/tmp/phpadhjk',
'error' => UPLOAD_ERR_OK,
'size' => 1024
]
]
],
[
'nestedList' => [
'level2' => [
'name' => [
0 => 'nestedList0.jpg',
1 => 'nestedList1.jpg',
2 => ''
],
'type' => [
0 => 'image/jpeg',
1 => 'image/jpeg',
2 => ''
],
'tmp_name' => [
0 => '/tmp/phpjpg0',
1 => '/tmp/phpjpg1',
2 => ''
],
'error' => [
0 => UPLOAD_ERR_OK,
1 => UPLOAD_ERR_OK,
2 => UPLOAD_ERR_NO_FILE
],
'size' => [
0 => 256,
1 => 4096,
2 => 0
]
]
]
]
];
}
// -------------------------------------------------------------------------
// Parsed Body
public function testGetParsedBodyReturnsNullByDefault(): void
{
$request = new ServerRequest();
$this->assertNull($request->getParsedBody());
}
public function testWithParsedBodyCreatesNewInstance(): void
{
$body = [
'guinea_pig' => 'Clyde'
];
$request1 = new ServerRequest();
$request2 = $request1->withParsedBody($body);
$this->assertEquals($body, $request2->getParsedBody());
$this->assertNotSame($request2, $request1);
}
/**
* @dataProvider invalidParsedBodyProvider
* @param mixed $body
*/
public function testWithParsedBodyThrowsExceptionWithInvalidType($body): void
{
$this->expectException(InvalidArgumentException::class);
$request = new ServerRequest();
$request->withParsedBody($body);
}
public function invalidParsedBodyProvider()
{
return [
[false],
[1]
];
}
public function testCloneMakesDeepCopiesOfParsedBody(): void
{
$body = (object) [
'cat' => 'Dog'
];
$request1 = new ServerRequest();
$request1 = $request1->withParsedBody($body);
$request2 = $request1->withHeader('X-extra', 'hello world');
$this->assertTrue(
$request1->getParsedBody() == $request2->getParsedBody()
&& $request1->getParsedBody() !== $request2->getParsedBody()
);
}
// -------------------------------------------------------------------------
// Attributes
public function testGetAttributesReturnsEmptyArrayByDefault(): void
{
$request = new ServerRequest();
$this->assertEquals([], $request->getAttributes());
}
public function testGetAttributesReturnsAllAttributes(): void
{
$request = new ServerRequest();
$request = $request->withAttribute('cat', 'Molly');
$request = $request->withAttribute('dog', 'Bear');
$expected = [
'cat' => 'Molly',
'dog' => 'Bear'
];
$this->assertEquals($expected, $request->getAttributes());
}
public function testGetAttributeReturnsDefaultIfNotSet(): void
{
$request = new ServerRequest();
$this->assertEquals('Oscar', $request->getAttribute('cat', 'Oscar'));
}
public function testWithAttributeCreatesNewInstance(): void
{
$request = new ServerRequest();
$request = $request->withAttribute('cat', 'Molly');
$this->assertEquals('Molly', $request->getAttribute('cat'));
}
public function testWithAttributePreserversOtherAttributes(): void
{
$request = new ServerRequest();
$request = $request->withAttribute('cat', 'Molly');
$request = $request->withAttribute('dog', 'Bear');
$expected = [
'cat' => 'Molly',
'dog' => 'Bear'
];
$this->assertEquals($expected, $request->getAttributes());
}
public function testWithoutAttributeCreatesNewInstance(): void
{
$request = new ServerRequest();
$request = $request->withAttribute('cat', 'Molly');
$this->assertNotEquals($request, $request->withoutAttribute('cat'));
}
public function testWithoutAttributeRemovesAttribute(): void
{
$request = new ServerRequest();
$request = $request->withAttribute('cat', 'Molly');
$request = $request->withoutAttribute('cat');
$this->assertEquals('Oscar', $request->getAttribute('cat', 'Oscar'));
}
public function testWithoutAttributePreservesOtherAttributes(): void
{
$request = new ServerRequest();
$request = $request->withAttribute('cat', 'Molly');
$request = $request->withAttribute('dog', 'Bear');
$request = $request->withoutAttribute('cat');
$this->assertEquals('Bear', $request->getAttribute('dog'));
}
}

View File

@ -1,95 +0,0 @@
<?php
namespace WellRESTed\Message;
use RuntimeException;
use WellRESTed\Test\TestCase;
class StreamFactoryTest extends TestCase
{
private const CONTENT = 'Stream content';
/** @var string $tempPath */
private $tempPath;
protected function setUp(): void
{
parent::setUp();
$this->tempPath = tempnam(sys_get_temp_dir(), 'test');
file_put_contents($this->tempPath, self::CONTENT);
}
protected function tearDown(): void
{
parent::tearDown();
unlink($this->tempPath);
}
// -------------------------------------------------------------------------
public function testCreatesStreamFromString(): void
{
$factory = new StreamFactory();
$stream = $factory->createStream(self::CONTENT);
$this->assertEquals(self::CONTENT, (string) $stream);
}
public function testCreatesStreamFromFile(): void
{
$factory = new StreamFactory();
$stream = $factory->createStreamFromFile($this->tempPath);
$this->assertEquals(self::CONTENT, (string) $stream);
}
public function testCreatesStreamFromFileWithModeRByDefault(): void
{
$factory = new StreamFactory();
$stream = $factory->createStreamFromFile($this->tempPath);
$mode = $stream->getMetadata('mode');
$this->assertEquals('r', $mode);
}
/**
* @dataProvider modeProvider
* @param string $mode
*/
public function testCreatesStreamFromFileWithPassedMode(string $mode): void
{
$factory = new StreamFactory();
$stream = $factory->createStreamFromFile($this->tempPath, $mode);
$actual = $stream->getMetadata('mode');
$this->assertEquals($mode, $actual);
}
public function modeProvider(): array
{
return [
['r'],
['r+'],
['w'],
['w+']
];
}
public function testCreateStreamFromFileThrowsRuntimeExceptionWhenUnableToOpenFile(): void
{
$this->expectException(RuntimeException::class);
$factory = new StreamFactory();
@$factory->createStreamFromFile('/dev/null/not-a-file', 'w');
}
public function testCreatesStreamFromResource(): void
{
$f = fopen($this->tempPath, 'r');
$factory = new StreamFactory();
$stream = $factory->createStreamFromResource($f);
$this->assertEquals(self::CONTENT, (string) $stream);
}
}

View File

@ -1,424 +0,0 @@
<?php
namespace WellRESTed\Message;
use InvalidArgumentException;
use RuntimeException;
use WellRESTed\Test\TestCase;
class StreamTest extends TestCase
{
private $resource;
private $resourceDevNull;
private $content = 'Hello, world!';
protected function setUp(): void
{
$this->resource = fopen('php://memory', 'w+');
$this->resourceDevNull = fopen('/dev/zero', 'r');
fwrite($this->resource, $this->content);
StreamHelper::$fail = false;
}
protected function tearDown(): void
{
if (is_resource($this->resource)) {
fclose($this->resource);
}
}
public function testCreatesInstanceWithStreamResource(): void
{
$stream = new Stream($this->resource);
$this->assertNotNull($stream);
}
public function testCreatesInstanceWithString(): void
{
$stream = new Stream('Hello, world!');
$this->assertNotNull($stream);
}
/**
* @dataProvider invalidResourceProvider
* @param mixed $resource
*/
public function testThrowsExceptionWithInvalidResource($resource): void
{
$this->expectException(InvalidArgumentException::class);
new Stream($resource);
}
public function invalidResourceProvider(): array
{
return [
[null],
[true],
[4],
[[]]
];
}
public function testCastsToString(): void
{
$stream = new Stream($this->resource);
$this->assertEquals($this->content, (string) $stream);
}
public function testClosesHandle(): void
{
$stream = new Stream($this->resource);
$stream->close();
$this->assertFalse(is_resource($this->resource));
}
public function testDetachReturnsHandle(): void
{
$stream = new Stream($this->resource);
$this->assertSame($this->resource, $stream->detach());
}
public function testDetachUnsetsInstanceVariable(): void
{
$stream = new Stream($this->resource);
$stream->detach();
$this->assertNull($stream->detach());
}
public function testReturnsSize(): void
{
$stream = new Stream($this->resource);
$this->assertEquals(strlen($this->content), $stream->getSize());
}
public function testReturnsNullForSizeWhenUnableToReadFromFstat(): void
{
$stream = new Stream($this->resourceDevNull);
$this->assertNull($stream->getSize());
}
public function testTellReturnsHandlePosition(): void
{
$stream = new Stream($this->resource);
fseek($this->resource, 10);
$this->assertEquals(10, $stream->tell());
}
public function testTellThrowsRuntimeExceptionWhenUnableToReadStreamPosition(): void
{
StreamHelper::$fail = true;
$stream = new Stream($this->resource);
$this->expectException(RuntimeException::class);
$stream->tell();
}
public function testReturnsOef(): void
{
$stream = new Stream($this->resource);
$stream->rewind();
$stream->getContents();
$this->assertTrue($stream->eof());
}
public function testReadsSeekableStatusFromMetadata(): void
{
$stream = new Stream($this->resource);
$metadata = stream_get_meta_data($this->resource);
$seekable = $metadata['seekable'] == 1;
$this->assertEquals($seekable, $stream->isSeekable());
}
public function testSeeksToPosition(): void
{
$stream = new Stream($this->resource);
$stream->seek(10);
$this->assertEquals(10, ftell($this->resource));
}
public function testSeekThrowsRuntimeExceptionWhenUnableToSeek(): void
{
StreamHelper::$fail = true;
$stream = new Stream($this->resource);
$this->expectException(RuntimeException::class);
$stream->seek(10);
}
public function testRewindReturnsToBeginning(): void
{
$stream = new Stream($this->resource);
$stream->seek(10);
$stream->rewind();
$this->assertEquals(0, ftell($this->resource));
}
public function testRewindThrowsRuntimeExceptionWhenUnableToRewind(): void
{
StreamHelper::$fail = true;
$stream = new Stream($this->resource);
$this->expectException(RuntimeException::class);
$stream->rewind();
}
public function testWritesToHandle(): void
{
$message = "\nThis is a stream.";
$stream = new Stream($this->resource);
$stream->write($message);
$this->assertEquals($this->content . $message, (string) $stream);
}
public function testThrowsExceptionOnErrorWriting(): void
{
$this->expectException(RuntimeException::class);
$filename = tempnam(sys_get_temp_dir(), 'php');
$handle = fopen($filename, 'r');
$stream = new Stream($handle);
$stream->write('Hello, world!');
}
public function testThrowsExceptionOnErrorReading(): void
{
$this->expectException(RuntimeException::class);
$filename = tempnam(sys_get_temp_dir(), 'php');
$handle = fopen($filename, 'w');
$stream = new Stream($handle);
$stream->read(10);
}
public function testReadsFromStream(): void
{
$stream = new Stream($this->resource);
$stream->seek(7);
$string = $stream->read(5);
$this->assertEquals('world', $string);
}
public function testThrowsExceptionOnErrorReadingToEnd(): void
{
$this->expectException(RuntimeException::class);
$filename = tempnam(sys_get_temp_dir(), 'php');
$handle = fopen($filename, 'w');
$stream = new Stream($handle);
$stream->getContents();
}
public function testReadsToEnd(): void
{
$stream = new Stream($this->resource);
$stream->seek(7);
$string = $stream->getContents();
$this->assertEquals('world!', $string);
}
public function testReturnsMetadataArray(): void
{
$stream = new Stream($this->resource);
$this->assertEquals(stream_get_meta_data($this->resource), $stream->getMetadata());
}
public function testReturnsMetadataItem(): void
{
$stream = new Stream($this->resource);
$metadata = stream_get_meta_data($this->resource);
$this->assertEquals($metadata['mode'], $stream->getMetadata('mode'));
}
/**
* @dataProvider modeProvider
* @param string $mode Access type used to open the stream
* @param bool $readable The stream should be readable
* @param bool $writable The stream should be writeable
*/
public function testReturnsIsReadableForReadableStreams(string $mode, bool $readable, bool $writable): void
{
$tmp = tempnam(sys_get_temp_dir(), 'php');
if ($mode[0] === 'x') {
unlink($tmp);
}
$resource = fopen($tmp, $mode);
$stream = new Stream($resource);
$this->assertEquals($readable, $stream->isReadable());
}
/**
* @dataProvider modeProvider
* @param string $mode Access type used to open the stream
* @param bool $readable The stream should be readable
* @param bool $writable The stream should be writeable
*/
public function testReturnsIsWritableForWritableStreams(string $mode, bool $readable, bool $writable): void
{
$tmp = tempnam(sys_get_temp_dir(), 'php');
if ($mode[0] === 'x') {
unlink($tmp);
}
$resource = fopen($tmp, $mode);
$stream = new Stream($resource);
$this->assertEquals($writable, $stream->isWritable());
}
public function modeProvider(): array
{
return [
['r', true, false],
['r+', true, true],
['w', false, true],
['w+', true, true],
['a', false, true],
['a+', true, true],
['x', false, true],
['x+', true, true],
['c', false, true],
['c+', true, true]
];
}
// -------------------------------------------------------------------------
// After Detach
public function testAfterDetachToStringReturnsEmptyString(): void
{
$stream = new Stream($this->resource);
$stream->detach();
$this->assertEquals('', (string) $stream);
}
public function testAfterDetachCloseDoesNothing(): void
{
$stream = new Stream($this->resource);
$stream->detach();
$stream->close();
$this->assertTrue(true);
}
public function testAfterDetachDetachReturnsNull(): void
{
$stream = new Stream($this->resource);
$stream->detach();
$this->assertNull($stream->detach());
}
public function testAfterDetachGetSizeReturnsNull(): void
{
$stream = new Stream($this->resource);
$stream->detach();
$this->assertNull($stream->getSize());
}
public function testAfterDetachTellThrowsRuntimeException(): void
{
$stream = new Stream($this->resource);
$stream->detach();
$this->expectException(RuntimeException::class);
$stream->tell();
}
public function testAfterDetachEofReturnsTrue(): void
{
$stream = new Stream($this->resource);
$stream->detach();
$this->assertTrue($stream->eof());
}
public function testAfterDetachIsSeekableReturnsFalse(): void
{
$stream = new Stream($this->resource);
$stream->detach();
$this->assertFalse($stream->isSeekable());
}
public function testAfterDetachSeekThrowsRuntimeException(): void
{
$stream = new Stream($this->resource);
$stream->detach();
$this->expectException(RuntimeException::class);
$stream->seek(0);
}
public function testAfterDetachRewindThrowsRuntimeException(): void
{
$stream = new Stream($this->resource);
$stream->detach();
$this->expectException(RuntimeException::class);
$stream->rewind();
}
public function testAfterDetachIsWritableReturnsFalse(): void
{
$stream = new Stream($this->resource);
$stream->detach();
$this->assertFalse($stream->isWritable());
}
public function testAfterDetachWriteThrowsRuntimeException(): void
{
$stream = new Stream($this->resource);
$stream->detach();
$this->expectException(RuntimeException::class);
$stream->write('bork');
}
public function testAfterDetachIsReadableReturnsFalse(): void
{
$stream = new Stream($this->resource);
$stream->detach();
$this->assertFalse($stream->isReadable());
}
public function testAfterDetachReadThrowsRuntimeException(): void
{
$stream = new Stream($this->resource);
$stream->detach();
$this->expectException(RuntimeException::class);
$stream->read(10);
}
public function testAfterDetachGetContentsThrowsRuntimeException(): void
{
$stream = new Stream($this->resource);
$stream->detach();
$this->expectException(RuntimeException::class);
$stream->getContents();
}
public function testAfterDetachGetMetadataReturnsNull(): void
{
$stream = new Stream($this->resource);
$stream->detach();
$this->assertNull($stream->getMetadata());
}
}
// -----------------------------------------------------------------------------
// Declare functions in this namespace so the class under test will use these
// instead of the internal global functions during testing.
class StreamHelper
{
public static $fail = false;
}
function fseek($resource, $offset, $whence = SEEK_SET)
{
if (StreamHelper::$fail) {
return -1;
}
return \fseek($resource, $offset, $whence);
}
function ftell($resource)
{
if (StreamHelper::$fail) {
return false;
}
return \ftell($resource);
}
function rewind($resource)
{
if (StreamHelper::$fail) {
return false;
}
return \rewind($resource);
}

View File

@ -1,179 +0,0 @@
<?php
namespace WellRESTed\Message;
use Psr\Http\Message\StreamInterface;
use RuntimeException;
use WellRESTed\Test\TestCase;
class UploadedFileTest extends TestCase
{
private $tmpName;
private $movePath;
protected function setUp(): void
{
parent::setUp();
UploadedFileState::$php_sapi_name = 'cli';
$this->tmpName = tempnam(sys_get_temp_dir(), 'tst');
$this->movePath = tempnam(sys_get_temp_dir(), 'tst');
}
protected function tearDown(): void
{
parent::tearDown();
if (file_exists($this->tmpName)) {
unlink($this->tmpName);
}
if (file_exists($this->movePath)) {
unlink($this->movePath);
}
}
// -------------------------------------------------------------------------
// getStream
public function testGetStreamReturnsStreamInterface(): void
{
$file = new UploadedFile('', '', 0, $this->tmpName, 0);
$this->assertInstanceOf(StreamInterface::class, $file->getStream());
}
public function testGetStreamReturnsStreamWrappingUploadedFile(): void
{
$content = 'Hello, World!';
file_put_contents($this->tmpName, $content);
$file = new UploadedFile('', '', 0, $this->tmpName, '');
$stream = $file->getStream();
$this->assertEquals($content, (string) $stream);
}
public function testGetStreamThrowsRuntimeExceptionForNoFile(): void
{
$file = new UploadedFile('', '', 0, '', 0);
$this->expectException(RuntimeException::class);
$file->getStream();
}
public function testGetStreamThrowsExceptionAfterMoveTo(): void
{
$this->expectException(RuntimeException::class);
$content = 'Hello, World!';
file_put_contents($this->tmpName, $content);
$file = new UploadedFile('', '', 0, $this->tmpName, '');
$file->moveTo($this->movePath);
$file->getStream();
}
public function testGetStreamThrowsExceptionForNonUploadedFile(): void
{
$this->expectException(RuntimeException::class);
UploadedFileState::$php_sapi_name = 'apache';
UploadedFileState::$is_uploaded_file = false;
$file = new UploadedFile('', '', 0, $this->tmpName, 0);
$file->getStream();
}
// -------------------------------------------------------------------------
// moveTo
public function testMoveToSapiRelocatesUploadedFileToDestinationIfExists(): void
{
UploadedFileState::$php_sapi_name = 'fpm-fcgi';
$content = 'Hello, World!';
file_put_contents($this->tmpName, $content);
$originalMd5 = md5_file($this->tmpName);
$file = new UploadedFile('', '', 0, $this->tmpName, '');
$file->moveTo($this->movePath);
$this->assertEquals($originalMd5, md5_file($this->movePath));
}
public function testMoveToNonSapiRelocatesUploadedFileToDestinationIfExists(): void
{
$content = 'Hello, World!';
file_put_contents($this->tmpName, $content);
$originalMd5 = md5_file($this->tmpName);
$file = new UploadedFile('', '', 0, $this->tmpName, '');
$file->moveTo($this->movePath);
$this->assertEquals($originalMd5, md5_file($this->movePath));
}
public function testMoveToThrowsExceptionOnSubsequentCall(): void
{
$this->expectException(RuntimeException::class);
$content = 'Hello, World!';
file_put_contents($this->tmpName, $content);
$file = new UploadedFile('', '', 0, $this->tmpName, '');
$file->moveTo($this->movePath);
$file->moveTo($this->movePath);
}
// -------------------------------------------------------------------------
// getSize
public function testGetSizeReturnsSize(): void
{
$file = new UploadedFile('', '', 1024, '', 0);
$this->assertEquals(1024, $file->getSize());
}
// -------------------------------------------------------------------------
// getError
public function testGetErrorReturnsError(): void
{
$file = new UploadedFile('', '', 1024, '', UPLOAD_ERR_INI_SIZE);
$this->assertEquals(UPLOAD_ERR_INI_SIZE, $file->getError());
}
// -------------------------------------------------------------------------
// clientFilename
public function testGetClientFilenameReturnsClientFilename(): void
{
$file = new UploadedFile('clientFilename', '', 0, '', 0);
$this->assertEquals('clientFilename', $file->getClientFilename());
}
// -------------------------------------------------------------------------
// clientMediaType
public function testGetClientMediaTypeReturnsClientMediaType(): void
{
$file = new UploadedFile('', 'clientMediaType', 0, '', 0);
$this->assertEquals('clientMediaType', $file->getClientMediaType());
}
}
// -----------------------------------------------------------------------------
// Declare functions in this namespace so the class under test will use these
// instead of the internal global functions during testing.
class UploadedFileState
{
public static $php_sapi_name;
public static $is_uploaded_file;
}
function php_sapi_name()
{
return UploadedFileState::$php_sapi_name;
}
function move_uploaded_file($source, $target)
{
return rename($source, $target);
}
function is_uploaded_file($file)
{
return UploadedFileState::$is_uploaded_file;
}

View File

@ -1,638 +0,0 @@
<?php
namespace WellRESTed\Message;
use InvalidArgumentException;
use WellRESTed\Test\TestCase;
class UriTest extends TestCase
{
// -------------------------------------------------------------------------
// Scheme
public function testDefaultSchemeIsEmpty(): void
{
$uri = new Uri();
$this->assertSame('', $uri->getScheme());
}
/**
* @dataProvider schemeProvider
* @param $expected
* @param $scheme
*/
public function testSetsSchemeCaseInsensitively($expected, $scheme): void
{
$uri = new Uri();
$uri = $uri->withScheme($scheme);
$this->assertSame($expected, $uri->getScheme());
}
public function schemeProvider(): array
{
return [
['http', 'http'],
['https', 'https'],
['http', 'HTTP'],
['https', 'HTTPS'],
['', null],
['', '']
];
}
public function testInvalidSchemeThrowsException(): void
{
$this->expectException(InvalidArgumentException::class);
$uri = new Uri();
$uri->withScheme('gopher');
}
// -------------------------------------------------------------------------
// Authority
public function testDefaultAuthorityIsEmpty(): void
{
$uri = new Uri();
$this->assertSame('', $uri->getAuthority());
}
public function testRespectsMyAuthoritah(): void
{
$this->assertTrue(true);
}
/**
* @dataProvider authorityProvider
* @param string $expected
* @param array $components
*/
public function testConcatenatesAuthorityFromHostAndUserInfo(
string $expected,
array $components
): void {
$uri = new Uri();
if (isset($components['scheme'])) {
$uri = $uri->withScheme($components['scheme']);
}
if (isset($components['user'])) {
$user = $components['user'];
$password = null;
if (isset($components['password'])) {
$password = $components['password'];
}
$uri = $uri->withUserInfo($user, $password);
}
if (isset($components['host'])) {
$uri = $uri->withHost($components['host']);
}
if (isset($components['port'])) {
$uri = $uri->withPort($components['port']);
}
$this->assertEquals($expected, $uri->getAuthority());
}
public function authorityProvider()
{
return [
[
'localhost',
[
'host' => 'localhost'
]
],
[
'user@localhost',
[
'host' => 'localhost',
'user' => 'user'
]
],
[
'user:password@localhost',
[
'host' => 'localhost',
'user' => 'user',
'password' => 'password'
]
],
[
'localhost',
[
'host' => 'localhost',
'password' => 'password'
]
],
[
'localhost',
[
'scheme' => 'http',
'host' => 'localhost',
'port' => 80
]
],
[
'localhost',
[
'scheme' => 'https',
'host' => 'localhost',
'port' => 443
]
],
[
'localhost:4430',
[
'scheme' => 'https',
'host' => 'localhost',
'port' => 4430
]
],
[
'localhost:8080',
[
'scheme' => 'http',
'host' => 'localhost',
'port' => 8080
]
],
[
'user:password@localhost:4430',
[
'scheme' => 'https',
'user' => 'user',
'password' => 'password',
'host' => 'localhost',
'port' => 4430
]
],
];
}
// -------------------------------------------------------------------------
// User Info
public function testDefaultUserInfoIsEmpty(): void
{
$uri = new Uri();
$this->assertSame('', $uri->getUserInfo());
}
/**
* @dataProvider userInfoProvider
*
* @param string $expected The combined user:password value
* @param string $user The username to set
* @param string|null $password The password to set
*/
public function testSetsUserInfo(string $expected, string $user, ?string $password): void
{
$uri = new Uri();
$uri = $uri->withUserInfo($user, $password);
$this->assertSame($expected, $uri->getUserInfo());
}
public function userInfoProvider(): array
{
return [
['user:password', 'user', 'password'],
['user', 'user', ''],
['user', 'user', null],
['', '', 'password'],
['', '', '']
];
}
// -------------------------------------------------------------------------
// Host
public function testDefaultHostIsEmpty(): void
{
$uri = new Uri();
$this->assertSame('', $uri->getHost());
}
/**
* @dataProvider hostProvider
* @param string $expected
* @param string $host
*/
public function testSetsHost(string $expected, string $host): void
{
$uri = new Uri();
$uri = $uri->withHost($host);
$this->assertSame($expected, $uri->getHost());
}
public function hostProvider(): array
{
return [
['', ''],
['localhost', 'localhost'],
['localhost', 'LOCALHOST'],
['foo.com', 'FOO.com']
];
}
/**
* @dataProvider invalidHostProvider
* @param mixed $host
*/
public function testInvalidHostThrowsException($host): void
{
$this->expectException(InvalidArgumentException::class);
$uri = new Uri();
$uri->withHost($host);
}
public function invalidHostProvider(): array
{
return [
[null],
[false],
[0]
];
}
// -------------------------------------------------------------------------
// Port
public function testDefaultPortWithNoSchemeIsNull(): void
{
$uri = new Uri();
$this->assertNull($uri->getPort());
}
public function testDefaultPortForHttpSchemeIs80(): void
{
$uri = new Uri();
$this->assertSame(80, $uri->withScheme('http')->getPort());
}
public function testDefaultPortForHttpsSchemeIs443(): void
{
$uri = new Uri();
$this->assertSame(443, $uri->withScheme('https')->getPort());
}
/**
* @dataProvider portAndSchemeProvider
* @param mixed $expectedPort
* @param mixed $scheme
* @param mixed $port
*/
public function testReturnsPortWithSchemeDefaults($expectedPort, $scheme, $port): void
{
$uri = new Uri();
$uri = $uri->withScheme($scheme)->withPort($port);
$this->assertSame($expectedPort, $uri->getPort());
}
public function portAndSchemeProvider(): array
{
return [
[null, '', null],
[80, 'http', null],
[443, 'https', null],
[8080, '', 8080],
[8080, 'http', '8080'],
[8080, 'https', 8080.0]
];
}
/**
* @dataProvider invalidPortProvider
* @param mixed $port
*/
public function testInvalidPortThrowsException($port): void
{
$this->expectException(InvalidArgumentException::class);
$uri = new Uri();
$uri->withPort($port);
}
public function invalidPortProvider(): array
{
return [
[true],
[-1],
[65536],
['dog']
];
}
// -------------------------------------------------------------------------
// Path
public function testDefaultPathIsEmpty(): void
{
$uri = new Uri();
$this->assertSame('', $uri->getPath());
}
/**
* @dataProvider pathProvider
* @param string $expected
* @param string $path
*/
public function testSetsEncodedPath(string $expected, string $path): void
{
$uri = new Uri();
$uri = $uri->withPath($path);
$this->assertSame($expected, $uri->getPath());
}
/**
* @dataProvider pathProvider
* @param string $expected
* @param string $path
*/
public function testDoesNotDoubleEncodePath(string $expected, string $path): void
{
$uri = new Uri();
$uri = $uri->withPath($path);
$uri = $uri->withPath($uri->getPath());
$this->assertSame($expected, $uri->getPath());
}
public function pathProvider()
{
return [
['', ''],
['/', '/'],
['*', '*'],
['/my/path', '/my/path'],
['/encoded%2Fslash', '/encoded%2Fslash'],
['/percent/%25', '/percent/%'],
['/%C3%A1%C3%A9%C3%AD%C3%B3%C3%BA', '/áéíóú']
];
}
// -------------------------------------------------------------------------
// Query
public function testDefaultQueryIsEmpty(): void
{
$uri = new Uri();
$this->assertSame('', $uri->getQuery());
}
/**
* @dataProvider queryProvider
* @param string $expected
* @param string $query
*/
public function testSetsEncodedQuery(string $expected, string $query): void
{
$uri = new Uri();
$uri = $uri->withQuery($query);
$this->assertSame($expected, $uri->getQuery());
}
/**
* @dataProvider queryProvider
* @param string $expected
* @param string $query
*/
public function testDoesNotDoubleEncodeQuery(string $expected, string $query): void
{
$uri = new Uri();
$uri = $uri->withQuery($query);
$uri = $uri->withQuery($uri->getQuery());
$this->assertSame($expected, $uri->getQuery());
}
public function queryProvider(): array
{
return [
['cat=molly', 'cat=molly'],
['cat=molly&dog=bear', 'cat=molly&dog=bear'],
['accents=%C3%A1%C3%A9%C3%AD%C3%B3%C3%BA', 'accents=áéíóú']
];
}
/**
* @dataProvider invalidPathProvider
* @param mixed $path
*/
public function testInvalidPathThrowsException($path): void
{
$this->expectException(InvalidArgumentException::class);
$uri = new Uri();
$uri->withPath($path);
}
public function invalidPathProvider(): array
{
return [
[null],
[false],
[0]
];
}
// -------------------------------------------------------------------------
// Fragment
public function testDefaultFragmentIsEmpty(): void
{
$uri = new Uri();
$this->assertSame('', $uri->getFragment());
}
/**
* @dataProvider fragmentProvider
* @param string $expected
* @param string|null $fragment
*/
public function testSetsEncodedFragment(string $expected, ?string $fragment): void
{
$uri = new Uri();
$uri = $uri->withFragment($fragment);
$this->assertSame($expected, $uri->getFragment());
}
/**
* @dataProvider fragmentProvider
* @param string $expected
* @param string|null $fragment
*/
public function testDoesNotDoubleEncodeFragment(string $expected, ?string $fragment): void
{
$uri = new Uri();
$uri = $uri->withFragment($fragment);
$uri = $uri->withFragment($uri->getFragment());
$this->assertSame($expected, $uri->getFragment());
}
public function fragmentProvider(): array
{
return [
['', null],
['molly', 'molly'],
['%C3%A1%C3%A9%C3%AD%C3%B3%C3%BA', 'áéíóú']
];
}
// -------------------------------------------------------------------------
// Concatenation
/**
* @dataProvider componentProvider
* @param string $expected
* @param array $components
*/
public function testConcatenatesComponents(string $expected, array $components): void
{
$uri = new Uri();
if (isset($components['scheme'])) {
$uri = $uri->withScheme($components['scheme']);
}
if (isset($components['user'])) {
$user = $components['user'];
$password = null;
if (isset($components['password'])) {
$password = $components['password'];
}
$uri = $uri->withUserInfo($user, $password);
}
if (isset($components['host'])) {
$uri = $uri->withHost($components['host']);
}
if (isset($components['port'])) {
$uri = $uri->withPort($components['port']);
}
if (isset($components['path'])) {
$uri = $uri->withPath($components['path']);
}
if (isset($components['query'])) {
$uri = $uri->withQuery($components['query']);
}
if (isset($components['fragment'])) {
$uri = $uri->withFragment($components['fragment']);
}
$this->assertEquals($expected, (string) $uri);
}
public function componentProvider()
{
return [
[
'http://localhost/path',
[
'scheme' => 'http',
'host' => 'localhost',
'path' => '/path'
]
],
[
'//localhost/path',
[
'host' => 'localhost',
'path' => '/path'
]
],
[
'/path',
[
'path' => '/path'
]
],
[
'/path?cat=molly&dog=bear',
[
'path' => '/path',
'query' => 'cat=molly&dog=bear'
]
],
[
'/path?cat=molly&dog=bear#fragment',
[
'path' => '/path',
'query' => 'cat=molly&dog=bear',
'fragment' => 'fragment'
]
],
[
'https://user:password@localhost:4430/path?cat=molly&dog=bear#fragment',
[
'scheme' => 'https',
'user' => 'user',
'password' => 'password',
'host' => 'localhost',
'port' => 4430,
'path' => '/path',
'query' => 'cat=molly&dog=bear',
'fragment' => 'fragment'
]
],
// Asterisk Form
[
'*',
[
'path' => '*'
]
],
];
}
/**
* @dataProvider stringUriProvider
* @param string $expected
* @param string $input
*/
public function testUriCreatedFromStringNormalizesString(string $expected, string $input): void
{
$uri = new Uri($input);
$this->assertSame($expected, (string) $uri);
}
public function stringUriProvider(): array
{
return [
[
'http://localhost/path',
'http://localhost:80/path'
],
[
'https://localhost/path',
'https://localhost:443/path'
],
[
'https://my.sub.sub.domain.com/path',
'https://my.sub.sub.domain.com/path'
],
[
'https://user:password@localhost:4430/path?cat=molly&dog=bear#fragment',
'https://user:password@localhost:4430/path?cat=molly&dog=bear#fragment'
],
[
'/path',
'/path'
],
[
'//double/slash',
'//double/slash'
],
[
'no/slash',
'no/slash'
],
[
'*',
'*'
]
];
}
}

View File

@ -1,53 +0,0 @@
<?php
namespace WellRESTed\Routing\Route;
use Prophecy\PhpUnit\ProphecyTrait;
use WellRESTed\Test\TestCase;
class PrefixRouteTest extends TestCase
{
use ProphecyTrait;
public function testTrimsAsteriskFromEndOfTarget(): void
{
$methodMap = $this->prophesize(MethodMap::class);
$route = new PrefixRoute('/cats/*', $methodMap->reveal());
$this->assertEquals('/cats/', $route->getTarget());
}
public function testReturnsPrefixType(): void
{
$methodMap = $this->prophesize(MethodMap::class);
$route = new PrefixRoute('/*', $methodMap->reveal());
$this->assertSame(Route::TYPE_PREFIX, $route->getType());
}
public function testReturnsEmptyArrayForPathVariables(): void
{
$methodMap = $this->prophesize(MethodMap::class);
$route = new PrefixRoute('/*', $methodMap->reveal());
$this->assertSame([], $route->getPathVariables());
}
public function testMatchesExactRequestTarget(): void
{
$methodMap = $this->prophesize(MethodMap::class);
$route = new PrefixRoute('/*', $methodMap->reveal());
$this->assertTrue($route->matchesRequestTarget('/'));
}
public function testMatchesRequestTargetWithSamePrefix(): void
{
$methodMap = $this->prophesize(MethodMap::class);
$route = new PrefixRoute('/*', $methodMap->reveal());
$this->assertTrue($route->matchesRequestTarget('/cats/'));
}
public function testDoesNotMatchNonMatchingRequestTarget(): void
{
$methodMap = $this->prophesize(MethodMap::class);
$route = new PrefixRoute('/animals/cats/', $methodMap->reveal());
$this->assertFalse($route->matchesRequestTarget('/animals/dogs/'));
}
}

View File

@ -1,119 +0,0 @@
<?php
namespace WellRESTed\Routing\Route;
use Prophecy\PhpUnit\ProphecyTrait;
use RuntimeException;
use WellRESTed\Test\TestCase;
class RegexRouteTest extends TestCase
{
use ProphecyTrait;
private $methodMap;
protected function setUp(): void
{
$this->methodMap = $this->prophesize(MethodMap::class);
}
public function testReturnsPatternType(): void
{
$route = new RegexRoute('/', $this->methodMap->reveal());
$this->assertSame(Route::TYPE_PATTERN, $route->getType());
}
/**
* @dataProvider matchingRouteProvider
* @param string $pattern
* @param string $path
*/
public function testMatchesTarget(string $pattern, string $path): void
{
$route = new RegexRoute($pattern, $this->methodMap->reveal());
$this->assertTrue($route->matchesRequestTarget($path));
}
/**
* @dataProvider matchingRouteProvider
* @param string $pattern
* @param string $path
*/
public function testMatchesTargetByRegex(string $pattern, string $path): void
{
$route = new RegexRoute($pattern, $this->methodMap->reveal());
$this->assertTrue($route->matchesRequestTarget($path));
}
/**
* @dataProvider matchingRouteProvider
* @param string $pattern
* @param string $path
* @param array $expectedCaptures
*/
public function testExtractsPathVariablesByRegex(string $pattern, string $path, array $expectedCaptures): void
{
$route = new RegexRoute($pattern, $this->methodMap->reveal());
$route->matchesRequestTarget($path);
$this->assertEquals($expectedCaptures, $route->getPathVariables());
}
public function matchingRouteProvider(): array
{
return [
['~/cat/[0-9]+~', '/cat/2', [0 => '/cat/2']],
['#/dog/.*#', '/dog/his-name-is-bear', [0 => '/dog/his-name-is-bear']],
['~/cat/([0-9]+)~', '/cat/2', [
0 => '/cat/2',
1 => '2'
]],
['~/dog/(?<id>[0-9+])~', '/dog/2', [
0 => '/dog/2',
1 => '2',
'id' => '2'
]]
];
}
/**
* @dataProvider mismatchingRouteProvider
* @param string $pattern
* @param string $path
*/
public function testDoesNotMatchNonMatchingTarget(string $pattern, string $path): void
{
$route = new RegexRoute($pattern, $this->methodMap->reveal());
$this->assertFalse($route->matchesRequestTarget($path));
}
public function mismatchingRouteProvider(): array
{
return [
['~/cat/[0-9]+~', '/cat/molly'],
['~/cat/[0-9]+~', '/dog/bear'],
['#/dog/.*#', '/dog']
];
}
/**
* @dataProvider invalidRouteProvider
* @param string $pattern
*/
public function testThrowsExceptionOnInvalidPattern(string $pattern): void
{
$this->expectException(RuntimeException::class);
$route = new RegexRoute($pattern, $this->methodMap->reveal());
$level = error_reporting();
error_reporting($level & ~E_WARNING);
$route->matchesRequestTarget('/');
error_reporting($level);
}
public function invalidRouteProvider()
{
return [
['~/unterminated'],
['/nope']
];
}
}

View File

@ -1,47 +0,0 @@
<?php
namespace WellRESTed\Routing\Route;
use Prophecy\PhpUnit\ProphecyTrait;
use WellRESTed\Dispatching\DispatcherInterface;
use WellRESTed\Test\TestCase;
class RouteFactoryTest extends TestCase
{
use ProphecyTrait;
private $dispatcher;
protected function setUp(): void
{
$this->dispatcher = $this->prophesize(DispatcherInterface::class);
}
public function testCreatesStaticRoute(): void
{
$factory = new RouteFactory($this->dispatcher->reveal());
$route = $factory->create('/cats/');
$this->assertSame(Route::TYPE_STATIC, $route->getType());
}
public function testCreatesPrefixRoute(): void
{
$factory = new RouteFactory($this->dispatcher->reveal());
$route = $factory->create('/cats/*');
$this->assertSame(Route::TYPE_PREFIX, $route->getType());
}
public function testCreatesRegexRoute(): void
{
$factory = new RouteFactory($this->dispatcher->reveal());
$route = $factory->create('~/cat/[0-9]+~');
$this->assertSame(Route::TYPE_PATTERN, $route->getType());
}
public function testCreatesTemplateRoute(): void
{
$factory = new RouteFactory($this->dispatcher->reveal());
$route = $factory->create('/cat/{id}');
$this->assertSame(Route::TYPE_PATTERN, $route->getType());
}
}

View File

@ -1,60 +0,0 @@
<?php
namespace WellRESTed\Routing\Route;
use Prophecy\Argument;
use Prophecy\PhpUnit\ProphecyTrait;
use Psr\Http\Server\RequestHandlerInterface;
use WellRESTed\Message\Response;
use WellRESTed\Message\ServerRequest;
use WellRESTed\Test\TestCase;
class RouteTest extends TestCase
{
use ProphecyTrait;
private const TARGET = '/target';
private $methodMap;
private $route;
protected function setUp(): void
{
$this->methodMap = $this->prophesize(MethodMap::class);
$this->methodMap->register(Argument::cetera());
$this->methodMap->__invoke(Argument::cetera())
->willReturn(new Response());
$this->route = new StaticRoute(
self::TARGET,
$this->methodMap->reveal()
);
}
public function testReturnsTarget(): void
{
$this->assertSame(self::TARGET, $this->route->getTarget());
}
public function testRegistersDispatchableWithMethodMap(): void
{
$handler = $this->prophesize(RequestHandlerInterface::class)->reveal();
$this->route->register('GET', $handler);
$this->methodMap->register('GET', $handler)->shouldHaveBeenCalled();
}
public function testDispatchesMethodMap(): void
{
$request = new ServerRequest();
$response = new Response();
$next = function ($rqst, $resp) {
return $resp;
};
call_user_func($this->route, $request, $response, $next);
$this->methodMap->__invoke(Argument::cetera())->shouldHaveBeenCalled();
}
}

Some files were not shown because too many files have changed in this diff Show More