Compare commits
No commits in common. "master" and "v4.0.3" have entirely different histories.
|
|
@ -1,15 +1,8 @@
|
|||
/.env export-ignore
|
||||
/.gitattributes export-ignore
|
||||
/.gitignore export-ignore
|
||||
/.php_cs* export-ignore
|
||||
/.travis.yml export-ignore
|
||||
/composer.lock export-ignore
|
||||
/coverage export-ignore
|
||||
/docker export-ignore
|
||||
/docker-compose* export-ignore
|
||||
/docs export-ignore
|
||||
/tests export-ignore
|
||||
/phpunit.xml* export-ignore
|
||||
/psalm.xml export-ignore
|
||||
/public export-ignore
|
||||
/vendor export-ignore
|
||||
/test export-ignore
|
||||
/phpunit.xml.dist export-ignore
|
||||
/Vagrantfile export-ignore
|
||||
/vagrant export-ignore
|
||||
|
|
|
|||
|
|
@ -8,9 +8,6 @@ phpdoc/
|
|||
coverage/
|
||||
report/
|
||||
|
||||
# Cache
|
||||
.php_cs.cache
|
||||
|
||||
# Sphinx Documentation
|
||||
docs/build
|
||||
|
||||
|
|
@ -21,10 +18,9 @@ preview
|
|||
# PhpStorm
|
||||
workspace.xml
|
||||
|
||||
# Local scratch files
|
||||
notes
|
||||
# Vagrant
|
||||
.vagrant/
|
||||
|
||||
# Local overrides
|
||||
.env
|
||||
docker-compose.override.yml
|
||||
phpunit.xml
|
||||
# Vagrant sandbox site files.
|
||||
/htdocs/
|
||||
/autoload/
|
||||
|
|
|
|||
|
|
@ -0,0 +1,12 @@
|
|||
language: php
|
||||
php:
|
||||
- "7.2"
|
||||
- "7.3"
|
||||
- "7.4"
|
||||
|
||||
before_script:
|
||||
- composer selfupdate
|
||||
- composer install --prefer-source
|
||||
|
||||
script:
|
||||
- vendor/bin/phpunit
|
||||
40
README.md
40
README.md
|
|
@ -1,20 +1,12 @@
|
|||
WellRESTed
|
||||
==========
|
||||
|
||||
[](https://php.net/)
|
||||
[](https://php.net/)
|
||||
[](https://travis-ci.org/wellrestedphp/wellrested)
|
||||
[](http://wellrested.readthedocs.org/en/latest/)
|
||||
[](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.
|
||||
|
||||
This fork (basemaster/wellrested) is back to php 7.2 release.
|
||||
|
||||
### Features
|
||||
|
||||
- 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.
|
||||
WellRESTed is a library for creating RESTful Web services and websites in PHP.
|
||||
|
||||
Install
|
||||
-------
|
||||
|
|
@ -24,7 +16,7 @@ Add an entry for "wellrested/wellrested" to your composer.json file's `require`
|
|||
```json
|
||||
{
|
||||
"require": {
|
||||
"wellrested/wellrested": "^5"
|
||||
"wellrested/wellrested": "^4"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
|
@ -63,14 +55,14 @@ class HomePageHandler implements RequestHandlerInterface
|
|||
|
||||
// -----------------------------------------------------------------------------
|
||||
|
||||
// Create a new Server instance.
|
||||
// Create a new server.
|
||||
$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.
|
||||
$router->register('GET', '/', new HomePageHandler());
|
||||
$server->add($router);
|
||||
|
||||
// Read the request from the client, dispatch a handler, and output.
|
||||
$server->respond();
|
||||
```
|
||||
|
|
@ -93,18 +85,6 @@ To run PHPUnit tests, use the `php` service:
|
|||
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
|
||||
|
|
@ -124,5 +104,5 @@ The runs a site you can access at [http://localhost:8080](http://localhost:8080)
|
|||
|
||||
Copyright and License
|
||||
---------------------
|
||||
Copyright © 2020 by PJ Dietz
|
||||
Copyright © 2018 by PJ Dietz
|
||||
Licensed under the [MIT license](http://opensource.org/licenses/MIT)
|
||||
|
|
|
|||
|
|
@ -1,7 +1,8 @@
|
|||
{
|
||||
"name": "basemaster/wellrested",
|
||||
"description": "Clone for Simple PHP Library for RESTful APIs (wellrested.org)",
|
||||
"keywords": ["rest", "restful", "api", "http", "psr7", "psr-7", "psr15", "psr-15", "psr17", "psr-17"],
|
||||
"name": "wellrested/wellrested",
|
||||
"description": "Simple PHP Library for RESTful APIs",
|
||||
"keywords": ["rest", "restful", "api", "http", "psr7", "psr-7", "psr15", "psr-15"],
|
||||
"homepage": "https://www.wellrested.org",
|
||||
"license": "MIT",
|
||||
"type": "library",
|
||||
"authors": [
|
||||
|
|
@ -11,15 +12,13 @@
|
|||
}
|
||||
],
|
||||
"require": {
|
||||
"php": ">=7.2",
|
||||
"psr/http-factory": "~1.0",
|
||||
"php": ">=7.0",
|
||||
"psr/http-message": "~1.0",
|
||||
"psr/http-server-handler": "~1.0",
|
||||
"psr/http-server-middleware": "~1.0"
|
||||
},
|
||||
"provide": {
|
||||
"psr/http-message-implementation": "1.0",
|
||||
"psr/http-factory-implementation": "1.0"
|
||||
"require-dev": {
|
||||
"phpunit/phpunit": "^8"
|
||||
},
|
||||
"autoload": {
|
||||
"psr-4": {
|
||||
|
|
|
|||
File diff suppressed because it is too large
Load Diff
|
|
@ -0,0 +1,32 @@
|
|||
version: '3.7'
|
||||
services:
|
||||
|
||||
# PHPUnit and Composer
|
||||
php:
|
||||
build:
|
||||
context: .
|
||||
dockerfile: ./docker/php/Dockerfile
|
||||
volumes:
|
||||
- .:/usr/local/src/wellrested
|
||||
|
||||
# Documentation generator
|
||||
docs:
|
||||
build:
|
||||
context: .
|
||||
dockerfile: ./docker/docs/Dockerfile
|
||||
volumes:
|
||||
- .:/usr/local/src/wellrested
|
||||
|
||||
# Local development site
|
||||
nginx:
|
||||
image: nginx:1.15
|
||||
ports:
|
||||
- ${PORT}:80
|
||||
volumes:
|
||||
- .:/usr/local/src/wellrested
|
||||
- ./docker/nginx/site.conf:/etc/nginx/conf.d/default.conf
|
||||
|
||||
php-fpm:
|
||||
image: php:7.4-fpm
|
||||
volumes:
|
||||
- .:/usr/local/src/wellrested
|
||||
|
|
@ -0,0 +1,7 @@
|
|||
FROM python:3-jessie
|
||||
|
||||
RUN pip install sphinx sphinx_rtd_theme
|
||||
|
||||
WORKDIR /usr/local/src/wellrested
|
||||
|
||||
CMD ["make", "html", "-C", "docs"]
|
||||
|
|
@ -0,0 +1,31 @@
|
|||
server {
|
||||
listen 80;
|
||||
|
||||
root /usr/local/src/wellrested/public;
|
||||
index index.php index.html;
|
||||
charset utf-8;
|
||||
|
||||
access_log /var/log/nginx/access.log;
|
||||
error_log /var/log/nginx/error.log;
|
||||
|
||||
# Front Controller
|
||||
location / {
|
||||
try_files $uri $uri/ /index.php?$args;
|
||||
}
|
||||
|
||||
# Generated Documentation
|
||||
location /docs {
|
||||
alias /usr/local/src/wellrested/docs/build/html;
|
||||
}
|
||||
|
||||
# PHP
|
||||
location ~ \.php$ {
|
||||
include fastcgi_params;
|
||||
fastcgi_pass php-fpm:9000;
|
||||
fastcgi_index index.php;
|
||||
fastcgi_buffers 8 8k;
|
||||
fastcgi_buffer_size 16k;
|
||||
fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name;
|
||||
fastcgi_param SCRIPT_NAME index.php;
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,44 @@
|
|||
FROM php:7.4-cli
|
||||
|
||||
RUN DEBIAN_FRONTEND=noninteractive \
|
||||
apt-get update && \
|
||||
apt-get -y install \
|
||||
gettext \
|
||||
libssl-dev \
|
||||
unzip \
|
||||
wget \
|
||||
zip \
|
||||
&& rm -rf /var/lib/apt/lists/*
|
||||
|
||||
# Install Xdebug
|
||||
RUN yes | pecl install xdebug \
|
||||
&& echo "zend_extension=$(find /usr/local/lib/php/extensions/ -name xdebug.so)" > /usr/local/etc/php/conf.d/xdebug.ini
|
||||
|
||||
# Install Composer.
|
||||
RUN curl -sS https://getcomposer.org/installer | php -- \
|
||||
--filename=composer --install-dir=/usr/local/bin
|
||||
|
||||
# Install dumb-init.
|
||||
RUN wget -O /usr/local/bin/dumb-init https://github.com/Yelp/dumb-init/releases/download/v1.2.1/dumb-init_1.2.1_amd64
|
||||
RUN chmod +x /usr/local/bin/dumb-init
|
||||
|
||||
# Create a directory for project sources and user's home directory
|
||||
RUN mkdir /usr/local/src/wellrested && \
|
||||
chown -R www-data:www-data /usr/local/src/wellrested && \
|
||||
chown -R www-data:www-data /var/www
|
||||
|
||||
COPY ./src /usr/local/src/wellrested/src
|
||||
COPY ./test /usr/local/src/wellrested/test
|
||||
COPY ./composer.* /usr/local/src/wellrested/
|
||||
COPY ./phpunit.xml.dist /usr/local/src/wellrested/
|
||||
|
||||
# Add symlink for phpunit for easier running
|
||||
RUN ln -s /usr/local/src/wellrested/vendor/bin/phpunit /usr/local/bin/phpunit
|
||||
|
||||
WORKDIR /usr/local/src/wellrested
|
||||
|
||||
USER www-data
|
||||
|
||||
ENTRYPOINT ["dumb-init", "--"]
|
||||
|
||||
RUN composer install
|
||||
|
|
@ -0,0 +1,16 @@
|
|||
#!/usr/bin/env bash
|
||||
|
||||
EXPECTED_SIGNATURE=$(wget https://composer.github.io/installer.sig -O - -q)
|
||||
php -r "copy('https://getcomposer.org/installer', 'composer-setup.php');"
|
||||
ACTUAL_SIGNATURE=$(php -r "echo hash_file('SHA384', 'composer-setup.php');")
|
||||
|
||||
if [ "$EXPECTED_SIGNATURE" != "$ACTUAL_SIGNATURE" ]; then
|
||||
>&2 echo 'ERROR: Invalid installer signature'
|
||||
rm composer-setup.php
|
||||
exit 1
|
||||
fi
|
||||
|
||||
php composer-setup.php --quiet --filename=composer --install-dir=/usr/local/bin
|
||||
RESULT=$?
|
||||
rm composer-setup.php
|
||||
exit $RESULT
|
||||
|
|
@ -0,0 +1,16 @@
|
|||
Changes from Version 3
|
||||
======================
|
||||
|
||||
If your project uses WellRESTed version 3, you can most likely upgrade to to version 4 without making any changes to your code. However, there are a few changes that may affect some users, particularly users who have subclassed ``WellRESTed\Server`` or used custom implementations of other ``WellRESTed`` classes.
|
||||
|
||||
Server Configuration
|
||||
^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
Version 4 allows for easier customization of the server than version 3. Previously, to customize the Server, you would need to subclass Server and override protected methods that provided a default request, response, transmitter, etc. The Server in version 4 now provides the following setters for providing custom behavior:
|
||||
|
||||
- ``setAttributes(array $attributes)``
|
||||
- ``setDispatcher(DispatcherInterface $dispatcher)``
|
||||
- ``setPathVariablesAttributeName(string $name)``
|
||||
- ``setRequest(ServerRequestInterface $request)``
|
||||
- ``setResponse(ResponseInterface $response)``
|
||||
- ``setTransmitter(TransmitterInterface $transmitter)``
|
||||
|
|
@ -25,9 +25,9 @@ master_doc = 'index'
|
|||
|
||||
# General information about the project.
|
||||
project = u'WellRESTed'
|
||||
copyright = u'2021, PJ Dietz'
|
||||
version = '5.0.0'
|
||||
release = '5.0.0'
|
||||
copyright = u'2018, PJ Dietz'
|
||||
version = '4.0.0'
|
||||
release = '4.0.0'
|
||||
|
||||
# List of patterns, relative to source directory, that match files and
|
||||
# directories to ignore when looking for source files.
|
||||
|
|
|
|||
|
|
@ -93,9 +93,18 @@ To use this dispatcher, create an instance implementing ``WellRESTed\Dispatching
|
|||
$server = new WellRESTed\Server();
|
||||
$server->setDispatcher(new MyApi\CustomDispatcher());
|
||||
|
||||
.. warning::
|
||||
Message Customization
|
||||
---------------------
|
||||
|
||||
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``.
|
||||
In the example above, we passed a custom dispatcher to the server. You can also customize your server in other ways. For example, when the server reaches these end of its stack of middleware and has not had the response handled, it returns a blank 404 error response. You can customize this by passing a response to the server's ``setUnhandledResponse`` method.
|
||||
|
||||
.. code-block:: php
|
||||
|
||||
$unhandled = (new Response(404))
|
||||
->withHeader('text/html')
|
||||
->withBody($fancy404message);
|
||||
|
||||
$server->setUnhandledResponse($unhandled);
|
||||
|
||||
.. _PSR-7: https://www.php-fig.org/psr/psr-7/
|
||||
.. _Handlers and Middleware: handlers-and-middleware.html
|
||||
|
|
|
|||
|
|
@ -138,6 +138,7 @@ Contents
|
|||
dependency-injection
|
||||
additional
|
||||
web-server-configuration
|
||||
changes-from-version-3
|
||||
|
||||
.. _PSR-7: https://www.php-fig.org/psr/psr-7/
|
||||
.. _PSR-15: https://www.php-fig.org/psr/psr-15/
|
||||
|
|
|
|||
|
|
@ -10,14 +10,14 @@ The recommended method for installing WellRESTed is to use Composer_. Add an ent
|
|||
|
||||
{
|
||||
"require": {
|
||||
"wellrested/wellrested": "^5"
|
||||
"wellrested/wellrested": "^4"
|
||||
}
|
||||
}
|
||||
|
||||
Requirements
|
||||
^^^^^^^^^^^^
|
||||
|
||||
- PHP 7.3
|
||||
- PHP 7.0
|
||||
|
||||
License
|
||||
^^^^^^^
|
||||
|
|
@ -26,7 +26,7 @@ Licensed using the `MIT license <http://opensource.org/licenses/MIT>`_.
|
|||
|
||||
The MIT License (MIT)
|
||||
|
||||
Copyright (c) 2021 PJ Dietz
|
||||
Copyright (c) 2018 PJ Dietz
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
|
|
|
|||
|
|
@ -0,0 +1,28 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<phpunit
|
||||
bootstrap="test/bootstrap.php"
|
||||
colors="true"
|
||||
convertErrorsToExceptions="true"
|
||||
convertNoticesToExceptions="true"
|
||||
convertWarningsToExceptions="true"
|
||||
processIsolation="false"
|
||||
stopOnFailure="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="./public/coverage" />
|
||||
</logging>
|
||||
</phpunit>
|
||||
|
|
@ -47,13 +47,36 @@ HTML;
|
|||
|
||||
// -----------------------------------------------------------------------------
|
||||
|
||||
// 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.
|
||||
$router->register("GET", "/", new HomePageHandler());
|
||||
$server->add($router);
|
||||
|
||||
|
||||
$server->add($server->createRouter()
|
||||
->register('GET, POST', '/cat', function ($rqst, $resp, $next) {
|
||||
|
||||
$resp = $resp
|
||||
->withStatus(200)
|
||||
->withHeader('Content-type', 'text/html')
|
||||
->withBody(new Stream('Molly'));
|
||||
return $next($rqst, $resp);
|
||||
})
|
||||
);
|
||||
|
||||
$server->add($server->createRouter()
|
||||
->register('GET', '/cat', function ($rqst, $resp) {
|
||||
|
||||
$body = (string) $resp->getBody();
|
||||
|
||||
|
||||
return (new Response(200))
|
||||
->withHeader('Content-type', 'text/html')
|
||||
->withBody(new Stream($body . ' Oscar'));
|
||||
})
|
||||
);
|
||||
|
||||
// Read the request from the client, dispatch a handler, and output.
|
||||
$server->respond();
|
||||
|
|
|
|||
|
|
@ -2,8 +2,6 @@
|
|||
|
||||
namespace WellRESTed\Dispatching;
|
||||
|
||||
use InvalidArgumentException;
|
||||
|
||||
class DispatchException extends InvalidArgumentException
|
||||
class DispatchException extends \InvalidArgumentException
|
||||
{
|
||||
}
|
||||
|
|
|
|||
|
|
@ -10,11 +10,12 @@ use Psr\Http\Message\ServerRequestInterface;
|
|||
*/
|
||||
class DispatchStack implements DispatchStackInterface
|
||||
{
|
||||
/** @var mixed[] */
|
||||
private $stack;
|
||||
/** @var DispatcherInterface */
|
||||
private $dispatcher;
|
||||
|
||||
/**
|
||||
* @param DispatcherInterface $dispatcher
|
||||
*/
|
||||
public function __construct(DispatcherInterface $dispatcher)
|
||||
{
|
||||
$this->dispatcher = $dispatcher;
|
||||
|
|
@ -25,7 +26,7 @@ class DispatchStack implements DispatchStackInterface
|
|||
* Push a new middleware onto the stack.
|
||||
*
|
||||
* @param mixed $middleware Middleware to dispatch in sequence
|
||||
* @return static
|
||||
* @return self
|
||||
*/
|
||||
public function add($middleware)
|
||||
{
|
||||
|
|
@ -39,7 +40,7 @@ class DispatchStack implements DispatchStackInterface
|
|||
* The first middleware that was added is dispatched first.
|
||||
*
|
||||
* 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
|
||||
* call the $next argument they were passed, this method will call the
|
||||
|
|
@ -65,10 +66,7 @@ class DispatchStack implements DispatchStackInterface
|
|||
|
||||
// The final middleware's $next returns $response unchanged and sets
|
||||
// the $stackCompleted flag to indicate the stack has completed.
|
||||
$chain = function (
|
||||
ServerRequestInterface $request,
|
||||
ResponseInterface $response
|
||||
) use (&$stackCompleted): ResponseInterface {
|
||||
$chain = function ($request, $response) use (&$stackCompleted) {
|
||||
$stackCompleted = true;
|
||||
return $response;
|
||||
};
|
||||
|
|
@ -79,16 +77,8 @@ class DispatchStack implements DispatchStackInterface
|
|||
// contain a dispatcher, the associated middleware, and a $next function
|
||||
// that serves as the link to the next middleware in the chain.
|
||||
foreach (array_reverse($this->stack) as $middleware) {
|
||||
$chain = function (
|
||||
ServerRequestInterface $request,
|
||||
ResponseInterface $response
|
||||
) use ($dispatcher, $middleware, $chain): ResponseInterface {
|
||||
return $dispatcher->dispatch(
|
||||
$middleware,
|
||||
$request,
|
||||
$response,
|
||||
$chain
|
||||
);
|
||||
$chain = function ($request, $response) use ($dispatcher, $middleware, $chain) {
|
||||
return $dispatcher->dispatch($middleware, $request, $response, $chain);
|
||||
};
|
||||
}
|
||||
|
||||
|
|
|
|||
|
|
@ -8,12 +8,12 @@ use Psr\Http\Server\MiddlewareInterface;
|
|||
use Psr\Http\Server\RequestHandlerInterface;
|
||||
|
||||
/**
|
||||
* Runs a handler or middleware with a request and return the response.
|
||||
* Dispatches handlers and middleware
|
||||
*/
|
||||
class Dispatcher implements DispatcherInterface
|
||||
{
|
||||
/**
|
||||
* Run a handler or middleware with a request and return the response.
|
||||
* Dispatch a handler or middleware and return the response.
|
||||
*
|
||||
* Dispatcher can dispatch any of the following:
|
||||
* - An instance implementing one of these interfaces:
|
||||
|
|
@ -63,15 +63,11 @@ class Dispatcher implements DispatcherInterface
|
|||
} elseif ($dispatchable instanceof ResponseInterface) {
|
||||
return $dispatchable;
|
||||
} else {
|
||||
throw new DispatchException('Unable to dispatch handler.');
|
||||
throw new DispatchException('Unable to dispatch middleware.');
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @param mixed[] $dispatchables
|
||||
* @return DispatchStack
|
||||
*/
|
||||
private function getDispatchStack($dispatchables)
|
||||
protected function getDispatchStack($dispatchables)
|
||||
{
|
||||
$stack = new DispatchStack($this);
|
||||
foreach ($dispatchables as $dispatchable) {
|
||||
|
|
|
|||
|
|
@ -6,12 +6,12 @@ use Psr\Http\Message\ResponseInterface;
|
|||
use Psr\Http\Message\ServerRequestInterface;
|
||||
|
||||
/**
|
||||
* Runs a handler or middleware with a request and return the response.
|
||||
* Dispatches handlers and middleware
|
||||
*/
|
||||
interface DispatcherInterface
|
||||
{
|
||||
/**
|
||||
* Run a handler or middleware with a request and return the response.
|
||||
* Dispatch a handler or middleware and return the response.
|
||||
*
|
||||
* Dispatchables (middleware and handlers) comes in a number of varieties
|
||||
* (e.g., instance, string, callable). DispatcherInterface interface unpacks
|
||||
|
|
|
|||
|
|
@ -8,50 +8,57 @@ use Iterator;
|
|||
/**
|
||||
* 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
|
||||
* access case insensitively.
|
||||
*
|
||||
* 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
|
||||
* 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
|
||||
{
|
||||
/**
|
||||
* @var array
|
||||
*
|
||||
* 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[]
|
||||
*
|
||||
* @var array<string, string[]>
|
||||
*/
|
||||
private $values = [];
|
||||
private $values;
|
||||
|
||||
/**
|
||||
* List array of lowercase header names.
|
||||
*
|
||||
* @var string[]
|
||||
*
|
||||
* List array of lowercase header names.
|
||||
*/
|
||||
private $keys = [];
|
||||
private $keys;
|
||||
|
||||
/** @var int */
|
||||
private $position = 0;
|
||||
|
||||
// -------------------------------------------------------------------------
|
||||
public function __construct()
|
||||
{
|
||||
$this->keys = [];
|
||||
$this->fields = [];
|
||||
$this->values = [];
|
||||
}
|
||||
|
||||
// ------------------------------------------------------------------------
|
||||
// ArrayAccess
|
||||
|
||||
/**
|
||||
* @param string $offset
|
||||
* @return bool
|
||||
*/
|
||||
public function offsetExists($offset): bool
|
||||
public function offsetExists($offset)
|
||||
{
|
||||
return isset($this->values[strtolower($offset)]);
|
||||
}
|
||||
|
|
@ -60,7 +67,7 @@ class HeaderCollection implements ArrayAccess, Iterator
|
|||
* @param mixed $offset
|
||||
* @return string[]
|
||||
*/
|
||||
public function offsetGet($offset): array
|
||||
public function offsetGet($offset)
|
||||
{
|
||||
return $this->values[strtolower($offset)];
|
||||
}
|
||||
|
|
@ -69,7 +76,7 @@ class HeaderCollection implements ArrayAccess, Iterator
|
|||
* @param string $offset
|
||||
* @param string $value
|
||||
*/
|
||||
public function offsetSet($offset, $value): void
|
||||
public function offsetSet($offset, $value)
|
||||
{
|
||||
$normalized = strtolower($offset);
|
||||
|
||||
|
|
@ -92,7 +99,7 @@ class HeaderCollection implements ArrayAccess, Iterator
|
|||
/**
|
||||
* @param string $offset
|
||||
*/
|
||||
public function offsetUnset($offset): void
|
||||
public function offsetUnset($offset)
|
||||
{
|
||||
$normalized = strtolower($offset);
|
||||
unset($this->fields[$normalized]);
|
||||
|
|
@ -104,33 +111,30 @@ class HeaderCollection implements ArrayAccess, Iterator
|
|||
}
|
||||
}
|
||||
|
||||
// -------------------------------------------------------------------------
|
||||
// ------------------------------------------------------------------------
|
||||
// Iterator
|
||||
|
||||
/**
|
||||
* @return string[]
|
||||
*/
|
||||
public function current(): array
|
||||
public function current()
|
||||
{
|
||||
return $this->values[$this->keys[$this->position]];
|
||||
}
|
||||
|
||||
public function next(): void
|
||||
public function next()
|
||||
{
|
||||
++$this->position;
|
||||
}
|
||||
|
||||
public function key(): string
|
||||
public function key()
|
||||
{
|
||||
return $this->fields[$this->keys[$this->position]];
|
||||
}
|
||||
|
||||
public function valid(): bool
|
||||
public function valid()
|
||||
{
|
||||
return isset($this->keys[$this->position]);
|
||||
}
|
||||
|
||||
public function rewind(): void
|
||||
public function rewind()
|
||||
{
|
||||
$this->position = 0;
|
||||
}
|
||||
|
|
|
|||
|
|
@ -2,7 +2,6 @@
|
|||
|
||||
namespace WellRESTed\Message;
|
||||
|
||||
use InvalidArgumentException;
|
||||
use Psr\Http\Message\MessageInterface;
|
||||
use Psr\Http\Message\StreamInterface;
|
||||
|
||||
|
|
@ -22,32 +21,32 @@ abstract class Message implements MessageInterface
|
|||
* Create a new Message, optionally with headers and a body.
|
||||
*
|
||||
* $headers is an optional associative array with header field names as
|
||||
* string keys and values as either string or string[].
|
||||
* (string) keys and lists of header field values (string[]) as values.
|
||||
*
|
||||
* If no StreamInterface is provided for $body, the instance will create
|
||||
* a NullStream instance for the message body.
|
||||
*
|
||||
* @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
|
||||
* (string) keys and lists of header field values (string[]) as values.
|
||||
* @param StreamInterface $body A stream representation of the message
|
||||
* entity body
|
||||
*/
|
||||
public function __construct(
|
||||
array $headers = [],
|
||||
?StreamInterface $body = null
|
||||
) {
|
||||
public function __construct(array $headers = null, StreamInterface $body = null)
|
||||
{
|
||||
$this->headers = new HeaderCollection();
|
||||
|
||||
foreach ($headers as $name => $values) {
|
||||
if (is_string($values)) {
|
||||
$values = [$values];
|
||||
}
|
||||
foreach ($values as $value) {
|
||||
$this->headers[$name] = $value;
|
||||
if ($headers) {
|
||||
foreach ($headers as $name => $values) {
|
||||
foreach ($values as $value) {
|
||||
$this->headers[$name] = $value;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
$this->body = $body ?? new Stream('');
|
||||
if ($body !== null) {
|
||||
$this->body = $body;
|
||||
} else {
|
||||
$this->body = new Stream('');
|
||||
}
|
||||
}
|
||||
|
||||
public function __clone()
|
||||
|
|
@ -55,7 +54,7 @@ abstract class Message implements MessageInterface
|
|||
$this->headers = clone $this->headers;
|
||||
}
|
||||
|
||||
// -------------------------------------------------------------------------
|
||||
// ------------------------------------------------------------------------
|
||||
// Psr\Http\Message\MessageInterface
|
||||
|
||||
/**
|
||||
|
|
@ -102,7 +101,7 @@ abstract class Message implements MessageInterface
|
|||
* While header names are not case-sensitive, getHeaders() will preserve the
|
||||
* 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()
|
||||
{
|
||||
|
|
@ -188,7 +187,7 @@ abstract class Message implements MessageInterface
|
|||
* @param string $name Case-insensitive header field name.
|
||||
* @param string|string[] $value Header value(s).
|
||||
* @return static
|
||||
* @throws InvalidArgumentException for invalid header names or values.
|
||||
* @throws \InvalidArgumentException for invalid header names or values.
|
||||
*/
|
||||
public function withHeader($name, $value)
|
||||
{
|
||||
|
|
@ -212,7 +211,7 @@ abstract class Message implements MessageInterface
|
|||
* @param string $name Case-insensitive header field name to add.
|
||||
* @param string|string[] $value Header value(s).
|
||||
* @return static
|
||||
* @throws InvalidArgumentException for invalid header names or values.
|
||||
* @throws \InvalidArgumentException for invalid header names or values.
|
||||
*/
|
||||
public function withAddedHeader($name, $value)
|
||||
{
|
||||
|
|
@ -255,7 +254,7 @@ abstract class Message implements MessageInterface
|
|||
*
|
||||
* @param StreamInterface $body Body.
|
||||
* @return static
|
||||
* @throws InvalidArgumentException When the body is not valid.
|
||||
* @throws \InvalidArgumentException When the body is not valid.
|
||||
*/
|
||||
public function withBody(StreamInterface $body)
|
||||
{
|
||||
|
|
@ -264,34 +263,24 @@ abstract class Message implements MessageInterface
|
|||
return $message;
|
||||
}
|
||||
|
||||
// -------------------------------------------------------------------------
|
||||
// ------------------------------------------------------------------------
|
||||
|
||||
/**
|
||||
* @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)
|
||||
private function getValidatedHeaders($name, $value)
|
||||
{
|
||||
if (!is_string($name)) {
|
||||
throw new InvalidArgumentException('Header name must be a string');
|
||||
}
|
||||
|
||||
if (!is_array($values)) {
|
||||
$values = [$values];
|
||||
}
|
||||
|
||||
$isNotStringOrNumber = function ($item): bool {
|
||||
return !(is_string($item) || is_numeric($item));
|
||||
$is_allowed = function ($item) {
|
||||
return is_string($item) || is_numeric($item);
|
||||
};
|
||||
|
||||
$invalid = array_filter($values, $isNotStringOrNumber);
|
||||
if ($invalid) {
|
||||
throw new InvalidArgumentException('Header values must be a string or string[]');
|
||||
if (!is_string($name)) {
|
||||
throw new \InvalidArgumentException('Header name must be a 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[]');
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -3,7 +3,6 @@
|
|||
namespace WellRESTed\Message;
|
||||
|
||||
use Psr\Http\Message\StreamInterface;
|
||||
use RuntimeException;
|
||||
|
||||
/**
|
||||
* NullStream is a minimal, always-empty, non-writable stream.
|
||||
|
|
@ -19,7 +18,7 @@ class NullStream implements StreamInterface
|
|||
*/
|
||||
public function __toString()
|
||||
{
|
||||
return '';
|
||||
return "";
|
||||
}
|
||||
|
||||
/**
|
||||
|
|
@ -52,10 +51,9 @@ class NullStream implements StreamInterface
|
|||
}
|
||||
|
||||
/**
|
||||
* Returns the current position of the file read/write pointer
|
||||
* Returns 0
|
||||
*
|
||||
* @return int Position of the file pointer
|
||||
* @throws RuntimeException on error.
|
||||
* @return int|bool Position of the file pointer or false on error.
|
||||
*/
|
||||
public function tell()
|
||||
{
|
||||
|
|
@ -92,12 +90,11 @@ class NullStream implements StreamInterface
|
|||
* PHP $whence values for `fseek()`. SEEK_SET: Set position equal to
|
||||
* offset bytes SEEK_CUR: Set position to current location 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)
|
||||
{
|
||||
throw new RuntimeException('Unable to seek to position.');
|
||||
throw new \RuntimeException("Unable to seek to position.");
|
||||
}
|
||||
|
||||
/**
|
||||
|
|
@ -105,12 +102,11 @@ class NullStream implements StreamInterface
|
|||
*
|
||||
* @see seek()
|
||||
* @link http://www.php.net/manual/en/function.fseek.php
|
||||
* @return void
|
||||
* @throws RuntimeException on failure.
|
||||
* @throws \RuntimeException on failure.
|
||||
*/
|
||||
public function rewind()
|
||||
{
|
||||
throw new RuntimeException('Unable to rewind stream.');
|
||||
throw new \RuntimeException("Unable to rewind stream.");
|
||||
}
|
||||
|
||||
/**
|
||||
|
|
@ -128,11 +124,11 @@ class NullStream implements StreamInterface
|
|||
*
|
||||
* @param string $string The string that is to be written.
|
||||
* @return int Returns the number of bytes written to the stream.
|
||||
* @throws RuntimeException on failure.
|
||||
* @throws \RuntimeException on failure.
|
||||
*/
|
||||
public function write($string)
|
||||
{
|
||||
throw new RuntimeException('Unable to write to stream.');
|
||||
throw new \RuntimeException("Unable to write to stream.");
|
||||
}
|
||||
|
||||
/**
|
||||
|
|
@ -153,23 +149,23 @@ class NullStream implements StreamInterface
|
|||
* call returns fewer bytes.
|
||||
* @return string Returns the data read from the stream, or an empty string
|
||||
* if no bytes are available.
|
||||
* @throws RuntimeException if an error occurs.
|
||||
* @throws \RuntimeException if an error occurs.
|
||||
*/
|
||||
public function read($length)
|
||||
{
|
||||
return '';
|
||||
return "";
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the remaining contents in a 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.
|
||||
*/
|
||||
public function getContents()
|
||||
{
|
||||
return '';
|
||||
return "";
|
||||
}
|
||||
|
||||
/**
|
||||
|
|
|
|||
|
|
@ -2,7 +2,6 @@
|
|||
|
||||
namespace WellRESTed\Message;
|
||||
|
||||
use InvalidArgumentException;
|
||||
use Psr\Http\Message\RequestInterface;
|
||||
use Psr\Http\Message\StreamInterface;
|
||||
use Psr\Http\Message\UriInterface;
|
||||
|
|
@ -23,42 +22,37 @@ class Request extends Message implements RequestInterface
|
|||
{
|
||||
/** @var string */
|
||||
protected $method;
|
||||
/** @var string|null */
|
||||
/** @var string */
|
||||
protected $requestTarget;
|
||||
/** @var UriInterface */
|
||||
protected $uri;
|
||||
|
||||
// -------------------------------------------------------------------------
|
||||
// ------------------------------------------------------------------------
|
||||
|
||||
/**
|
||||
* Create a new Request.
|
||||
*
|
||||
* $headers is an optional associative array with header field names as
|
||||
* string keys and values as either string or string[].
|
||||
*
|
||||
* If no StreamInterface is provided for $body, the instance will create
|
||||
* a NullStream instance for the message body.
|
||||
*
|
||||
* @see \WellRESTed\Message\Message
|
||||
* @param UriInterface $uri
|
||||
* @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 $headers
|
||||
* @param StreamInterface $body
|
||||
*/
|
||||
public function __construct(
|
||||
string $method = 'GET',
|
||||
$uri = '',
|
||||
array $headers = [],
|
||||
?StreamInterface $body = null
|
||||
UriInterface $uri = null,
|
||||
$method = "GET",
|
||||
array $headers = null,
|
||||
StreamInterface $body = null
|
||||
) {
|
||||
parent::__construct($headers, $body);
|
||||
$this->method = $method;
|
||||
if (!($uri instanceof UriInterface)) {
|
||||
$uri = new Uri($uri);
|
||||
|
||||
if ($uri !== null) {
|
||||
$this->uri = $uri;
|
||||
} else {
|
||||
$this->uri = new Uri();
|
||||
}
|
||||
$this->uri = $uri;
|
||||
$this->requestTarget = null;
|
||||
|
||||
$this->method = $method;
|
||||
}
|
||||
|
||||
public function __clone()
|
||||
|
|
@ -67,7 +61,7 @@ class Request extends Message implements RequestInterface
|
|||
parent::__clone();
|
||||
}
|
||||
|
||||
// -------------------------------------------------------------------------
|
||||
// ------------------------------------------------------------------------
|
||||
// Psr\Http\Message\RequestInterface
|
||||
|
||||
/**
|
||||
|
|
@ -89,7 +83,7 @@ class Request extends Message implements RequestInterface
|
|||
public function getRequestTarget()
|
||||
{
|
||||
// Use the explicitly set request target first.
|
||||
if ($this->requestTarget !== null) {
|
||||
if (isset($this->requestTarget)) {
|
||||
return $this->requestTarget;
|
||||
}
|
||||
|
||||
|
|
@ -97,11 +91,11 @@ class Request extends Message implements RequestInterface
|
|||
$target = $this->uri->getPath();
|
||||
$query = $this->uri->getQuery();
|
||||
if ($query) {
|
||||
$target .= '?' . $query;
|
||||
$target .= "?" . $query;
|
||||
}
|
||||
|
||||
// Return "/" if the origin form is empty.
|
||||
return $target ?: '/';
|
||||
return $target ?: "/";
|
||||
}
|
||||
|
||||
/**
|
||||
|
|
@ -143,7 +137,7 @@ class Request extends Message implements RequestInterface
|
|||
*
|
||||
* @param string $method Case-insensitive method.
|
||||
* @return static
|
||||
* @throws InvalidArgumentException for invalid HTTP methods.
|
||||
* @throws \InvalidArgumentException for invalid HTTP methods.
|
||||
*/
|
||||
public function withMethod($method)
|
||||
{
|
||||
|
|
@ -195,18 +189,18 @@ class Request extends Message implements RequestInterface
|
|||
$request = clone $this;
|
||||
|
||||
$newHost = $uri->getHost();
|
||||
$oldHost = $request->headers['Host'] ?? '';
|
||||
$oldHost = isset($request->headers["Host"]) ? $request->headers["Host"] : "";
|
||||
|
||||
if ($preserveHost === false) {
|
||||
// Update Host
|
||||
if ($newHost && $newHost !== $oldHost) {
|
||||
unset($request->headers['Host']);
|
||||
$request->headers['Host'] = $newHost;
|
||||
unset($request->headers["Host"]);
|
||||
$request->headers["Host"] = $newHost;
|
||||
}
|
||||
} else {
|
||||
// Preserve Host
|
||||
if (!$oldHost && $newHost) {
|
||||
$request->headers['Host'] = $newHost;
|
||||
$request->headers["Host"] = $newHost;
|
||||
}
|
||||
}
|
||||
|
||||
|
|
@ -214,21 +208,21 @@ class Request extends Message implements RequestInterface
|
|||
return $request;
|
||||
}
|
||||
|
||||
// -------------------------------------------------------------------------
|
||||
// ------------------------------------------------------------------------
|
||||
|
||||
/**
|
||||
* @param mixed $method
|
||||
* @return string
|
||||
* @throws InvalidArgumentException
|
||||
* @param string $method
|
||||
* @return static
|
||||
* @throws \InvalidArgumentException
|
||||
*/
|
||||
private function getValidatedMethod($method)
|
||||
{
|
||||
if (!is_string($method)) {
|
||||
throw new InvalidArgumentException('Method must be a string.');
|
||||
throw new \InvalidArgumentException("Method must be a string.");
|
||||
}
|
||||
$method = trim($method);
|
||||
if (strpos($method, ' ') !== false) {
|
||||
throw new InvalidArgumentException('Method cannot contain spaces.');
|
||||
if (strpos($method, " ") !== false) {
|
||||
throw new \InvalidArgumentException("Method cannot contain spaces.");
|
||||
}
|
||||
return $method;
|
||||
}
|
||||
|
|
|
|||
|
|
@ -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);
|
||||
}
|
||||
}
|
||||
|
|
@ -2,7 +2,6 @@
|
|||
|
||||
namespace WellRESTed\Message;
|
||||
|
||||
use InvalidArgumentException;
|
||||
use Psr\Http\Message\ResponseInterface;
|
||||
use Psr\Http\Message\StreamInterface;
|
||||
|
||||
|
|
@ -21,7 +20,7 @@ class Response extends Message implements ResponseInterface
|
|||
{
|
||||
/** @var string Text explanation of the HTTP Status Code. */
|
||||
private $reasonPhrase;
|
||||
/** @var int HTTP status code */
|
||||
/** @var int HTTP status code */
|
||||
private $statusCode;
|
||||
|
||||
/**
|
||||
|
|
@ -35,22 +34,18 @@ class Response extends Message implements ResponseInterface
|
|||
* a NullStream instance for the message body.
|
||||
*
|
||||
* @see \WellRESTed\Message\Message
|
||||
*
|
||||
* @param int $statusCode
|
||||
* @param array $headers
|
||||
* @param StreamInterface|null $body
|
||||
* @param StreamInterface $body
|
||||
*/
|
||||
public function __construct(
|
||||
int $statusCode = 500,
|
||||
array $headers = [],
|
||||
?StreamInterface $body = null
|
||||
) {
|
||||
public function __construct($statusCode = 500, array $headers = null, StreamInterface $body = null)
|
||||
{
|
||||
parent::__construct($headers, $body);
|
||||
$this->statusCode = $statusCode;
|
||||
$this->reasonPhrase = $this->getDefaultReasonPhraseForStatusCode($statusCode);
|
||||
}
|
||||
|
||||
// -------------------------------------------------------------------------
|
||||
// ------------------------------------------------------------------------
|
||||
// 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
|
||||
* to understand and satisfy the request.
|
||||
*
|
||||
* @return int Status code.
|
||||
* @return integer Status code.
|
||||
*/
|
||||
public function getStatusCode()
|
||||
{
|
||||
|
|
@ -79,9 +74,9 @@ class Response extends Message implements ResponseInterface
|
|||
* provided status code; if none is provided, implementations MAY
|
||||
* use the defaults as suggested in the HTTP specification.
|
||||
* @return static
|
||||
* @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->statusCode = $code;
|
||||
|
|
@ -108,70 +103,73 @@ class Response extends Message implements ResponseInterface
|
|||
|
||||
/**
|
||||
* @param int $statusCode
|
||||
* @return string
|
||||
* @return string|null
|
||||
*/
|
||||
private function getDefaultReasonPhraseForStatusCode($statusCode)
|
||||
{
|
||||
$reasonPhraseLookup = [
|
||||
100 => 'Continue',
|
||||
101 => 'Switching Protocols',
|
||||
102 => 'Processing',
|
||||
200 => 'OK',
|
||||
201 => 'Created',
|
||||
202 => 'Accepted',
|
||||
203 => 'Non-Authoritative Information',
|
||||
204 => 'No Content',
|
||||
205 => 'Reset Content',
|
||||
206 => 'Partial Content',
|
||||
207 => 'Multi-Status',
|
||||
208 => 'Already Reported',
|
||||
226 => 'IM Used',
|
||||
300 => 'Multiple Choices',
|
||||
301 => 'Moved Permanently',
|
||||
302 => 'Found',
|
||||
303 => 'See Other',
|
||||
304 => 'Not Modified',
|
||||
305 => 'Use Proxy',
|
||||
307 => 'Temporary Redirect',
|
||||
308 => 'Permanent Redirect',
|
||||
400 => 'Bad Request',
|
||||
401 => 'Unauthorized',
|
||||
402 => 'Payment Required',
|
||||
403 => 'Forbidden',
|
||||
404 => 'Not Found',
|
||||
405 => 'Method Not Allowed',
|
||||
406 => 'Not Acceptable',
|
||||
407 => 'Proxy Authentication Required',
|
||||
408 => 'Request Timeout',
|
||||
409 => 'Conflict',
|
||||
410 => 'Gone',
|
||||
411 => 'Length Required',
|
||||
412 => 'Precondition Failed',
|
||||
413 => 'Payload Too Large',
|
||||
414 => 'URI Too Long',
|
||||
415 => 'Unsupported Media Type',
|
||||
416 => 'Range Not Satisfiable',
|
||||
417 => 'Expectation Failed',
|
||||
421 => 'Misdirected Request',
|
||||
422 => 'Unprocessable Entity',
|
||||
423 => 'Locked',
|
||||
424 => 'Failed Dependency',
|
||||
426 => 'Upgrade Required',
|
||||
428 => 'Precondition Required',
|
||||
429 => 'Too Many Requests',
|
||||
431 => 'Request Header Fields Too Large',
|
||||
500 => 'Internal Server Error',
|
||||
501 => 'Not Implemented',
|
||||
502 => 'Bad Gateway',
|
||||
503 => 'Service Unavailable',
|
||||
504 => 'Gateway Timeout',
|
||||
505 => 'HTTP Version Not Supported',
|
||||
506 => 'Variant Also Negotiates',
|
||||
507 => 'Insufficient Storage',
|
||||
508 => 'Loop Detected',
|
||||
510 => 'Not Extended',
|
||||
511 => 'Network Authentication Required'
|
||||
100 => "Continue",
|
||||
101 => "Switching Protocols",
|
||||
102 => "Processing",
|
||||
200 => "OK",
|
||||
201 => "Created",
|
||||
202 => "Accepted",
|
||||
203 => "Non-Authoritative Information",
|
||||
204 => "No Content",
|
||||
205 => "Reset Content",
|
||||
206 => "Partial Content",
|
||||
207 => "Multi-Status",
|
||||
208 => "Already Reported",
|
||||
226 => "IM Used",
|
||||
300 => "Multiple Choices",
|
||||
301 => "Moved Permanently",
|
||||
302 => "Found",
|
||||
303 => "See Other",
|
||||
304 => "Not Modified",
|
||||
305 => "Use Proxy",
|
||||
307 => "Temporary Redirect",
|
||||
308 => "Permanent Redirect",
|
||||
400 => "Bad Request",
|
||||
401 => "Unauthorized",
|
||||
402 => "Payment Required",
|
||||
403 => "Forbidden",
|
||||
404 => "Not Found",
|
||||
405 => "Method Not Allowed",
|
||||
406 => "Not Acceptable",
|
||||
407 => "Proxy Authentication Required",
|
||||
408 => "Request Timeout",
|
||||
409 => "Conflict",
|
||||
410 => "Gone",
|
||||
411 => "Length Required",
|
||||
412 => "Precondition Failed",
|
||||
413 => "Payload Too Large",
|
||||
414 => "URI Too Long",
|
||||
415 => "Unsupported Media Type",
|
||||
416 => "Range Not Satisfiable",
|
||||
417 => "Expectation Failed",
|
||||
421 => "Misdirected Request",
|
||||
422 => "Unprocessable Entity",
|
||||
423 => "Locked",
|
||||
424 => "Failed Dependency",
|
||||
426 => "Upgrade Required",
|
||||
428 => "Precondition Required",
|
||||
429 => "Too Many Requests",
|
||||
431 => "Request Header Fields Too Large",
|
||||
500 => "Internal Server Error",
|
||||
501 => "Not Implemented",
|
||||
502 => "Bad Gateway",
|
||||
503 => "Service Unavailable",
|
||||
504 => "Gateway Timeout",
|
||||
505 => "HTTP Version Not Supported",
|
||||
506 => "Variant Also Negotiates",
|
||||
507 => "Insufficient Storage",
|
||||
508 => "Loop Detected",
|
||||
510 => "Not Extended",
|
||||
511 => "Network Authentication Required"
|
||||
];
|
||||
return $reasonPhraseLookup[$statusCode] ?? '';
|
||||
if (isset($reasonPhraseLookup[$statusCode])) {
|
||||
return $reasonPhraseLookup[$statusCode];
|
||||
}
|
||||
return null;
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -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);
|
||||
}
|
||||
}
|
||||
|
|
@ -2,11 +2,9 @@
|
|||
|
||||
namespace WellRESTed\Message;
|
||||
|
||||
use InvalidArgumentException;
|
||||
use Psr\Http\Message\ServerRequestInterface;
|
||||
use Psr\Http\Message\StreamInterface;
|
||||
use Psr\Http\Message\UploadedFileInterface;
|
||||
use Psr\Http\Message\UriInterface;
|
||||
|
||||
/**
|
||||
* Representation of an incoming, server-side HTTP request.
|
||||
|
|
@ -51,37 +49,24 @@ class ServerRequest extends Request implements ServerRequestInterface
|
|||
/** @var array */
|
||||
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
|
||||
* string keys and values as either string or string[].
|
||||
* To obtain a ServerRequest representing the request sent to the server
|
||||
* instantiating the request, use the factory method
|
||||
* ServerRequest::getServerRequest
|
||||
*
|
||||
* If no StreamInterface is provided for $body, the instance will create
|
||||
* 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
|
||||
* @see ServerRequest::getServerRequest
|
||||
*/
|
||||
public function __construct(
|
||||
string $method = 'GET',
|
||||
$uri = '',
|
||||
array $headers = [],
|
||||
?StreamInterface $body = null,
|
||||
array $serverParams = []
|
||||
) {
|
||||
parent::__construct($method, $uri, $headers, $body);
|
||||
$this->serverParams = $serverParams;
|
||||
public function __construct()
|
||||
{
|
||||
parent::__construct();
|
||||
$this->attributes = [];
|
||||
$this->cookieParams = [];
|
||||
$this->queryParams = [];
|
||||
$this->attributes = [];
|
||||
$this->serverParams = [];
|
||||
$this->uploadedFiles = [];
|
||||
}
|
||||
|
||||
|
|
@ -93,7 +78,7 @@ class ServerRequest extends Request implements ServerRequestInterface
|
|||
parent::__clone();
|
||||
}
|
||||
|
||||
// -------------------------------------------------------------------------
|
||||
// ------------------------------------------------------------------------
|
||||
// Psr\Http\Message\ServerRequestInterface
|
||||
|
||||
/**
|
||||
|
|
@ -203,14 +188,13 @@ class ServerRequest extends Request implements ServerRequestInterface
|
|||
*
|
||||
* @param array $uploadedFiles An array tree of UploadedFileInterface instances.
|
||||
* @return static
|
||||
* @throws InvalidArgumentException if an invalid structure is provided.
|
||||
* @throws \InvalidArgumentException if an invalid structure is provided.
|
||||
*/
|
||||
public function withUploadedFiles(array $uploadedFiles)
|
||||
{
|
||||
if (!$this->isValidUploadedFilesTree($uploadedFiles)) {
|
||||
throw new InvalidArgumentException(
|
||||
'withUploadedFiles expects an array tree with UploadedFileInterface leaves.'
|
||||
);
|
||||
throw new \InvalidArgumentException(
|
||||
"withUploadedFiles expects an array tree with UploadedFileInterface leaves.");
|
||||
}
|
||||
|
||||
$request = clone $this;
|
||||
|
|
@ -263,7 +247,7 @@ class ServerRequest extends Request implements ServerRequestInterface
|
|||
public function withParsedBody($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;
|
||||
|
|
@ -350,7 +334,185 @@ class ServerRequest extends Request implements ServerRequestInterface
|
|||
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 static
|
||||
* @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()
|
||||
{
|
||||
$input = fopen("php://input", "rb");
|
||||
$temp = fopen("php://temp", "wb+");
|
||||
stream_copy_to_stream($input, $temp);
|
||||
rewind($temp);
|
||||
return new Stream($temp);
|
||||
}
|
||||
|
||||
/**
|
||||
* 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_") {
|
||||
$name = $this->normalizeHeaderName(substr($name, 5));
|
||||
$headers[$name] = $value;
|
||||
} elseif ($this->isContentHeader($name, $value)) {
|
||||
$name = $this->normalizeHeaderName($name);
|
||||
$headers[$name] = $value;
|
||||
}
|
||||
}
|
||||
return $headers;
|
||||
}
|
||||
|
||||
/**
|
||||
* @param $name
|
||||
* @param $value
|
||||
* @return bool
|
||||
*/
|
||||
private function isContentHeader($name, $value)
|
||||
{
|
||||
return ($name === "CONTENT_LENGTH" || $name === "CONTENT_TYPE")
|
||||
&& trim($value);
|
||||
}
|
||||
|
||||
/**
|
||||
* @param string $name
|
||||
* @return string
|
||||
*/
|
||||
private function normalizeHeaderName($name)
|
||||
{
|
||||
$name = ucwords(strtolower(str_replace("_", " ", $name)));
|
||||
return str_replace(" ", "-", $name);
|
||||
}
|
||||
|
||||
/**
|
||||
* @param array $root
|
||||
|
|
@ -365,7 +527,7 @@ class ServerRequest extends Request implements ServerRequestInterface
|
|||
|
||||
// If not empty, the array MUST have all string keys.
|
||||
$keys = array_keys($root);
|
||||
if (count($keys) !== count(array_filter($keys, 'is_string'))) {
|
||||
if (count($keys) !== count(array_filter($keys, "is_string"))) {
|
||||
return false;
|
||||
}
|
||||
|
||||
|
|
@ -378,11 +540,7 @@ class ServerRequest extends Request implements ServerRequestInterface
|
|||
return true;
|
||||
}
|
||||
|
||||
/**
|
||||
* @param UploadedFileInterface|array $branch
|
||||
* @return bool
|
||||
*/
|
||||
private function isValidUploadedFilesBranch($branch): bool
|
||||
private function isValidUploadedFilesBranch($branch)
|
||||
{
|
||||
if (is_array($branch)) {
|
||||
// Branch.
|
||||
|
|
|
|||
|
|
@ -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']);
|
||||
}
|
||||
}
|
||||
|
|
@ -2,21 +2,15 @@
|
|||
|
||||
namespace WellRESTed\Message;
|
||||
|
||||
use Exception;
|
||||
use InvalidArgumentException;
|
||||
use Psr\Http\Message\StreamInterface;
|
||||
use RuntimeException;
|
||||
|
||||
class Stream implements StreamInterface
|
||||
{
|
||||
private const READABLE_MODES = ['r', 'r+', 'w+', 'a+', 'x+', 'c+'];
|
||||
private const WRITABLE_MODES = ['r+', 'w', 'w+', 'a', 'a+', 'x', 'x+', 'c', 'c+'];
|
||||
|
||||
/** @var resource|null */
|
||||
/** @var 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.
|
||||
*
|
||||
* 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
|
||||
* 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;
|
||||
} elseif (is_string($resource)) {
|
||||
$this->resource = fopen('php://temp', 'wb+');
|
||||
if ($resource !== '') {
|
||||
$this->resource = fopen("php://temp", "wb+");
|
||||
if ($resource !== "") {
|
||||
$this->write($resource);
|
||||
}
|
||||
} else {
|
||||
throw new InvalidArgumentException('Expected resource or string.');
|
||||
throw new \InvalidArgumentException("Expected a resource handler.");
|
||||
}
|
||||
}
|
||||
|
||||
|
|
@ -52,16 +46,18 @@ class Stream implements StreamInterface
|
|||
*/
|
||||
public function __toString()
|
||||
{
|
||||
$string = "";
|
||||
try {
|
||||
if ($this->isSeekable()) {
|
||||
$this->rewind();
|
||||
rewind($this->resource);
|
||||
}
|
||||
return $this->getContents();
|
||||
} catch (Exception $e) {
|
||||
// Silence exceptions in order to conform with PHP's string casting
|
||||
// operations.
|
||||
return '';
|
||||
$string = $this->getContents();
|
||||
// @codeCoverageIgnoreStart
|
||||
} catch (\Exception $e) {
|
||||
// @codeCoverageIgnoreEnd
|
||||
// Silence exceptions in order to conform with PHP's string casting operations.
|
||||
}
|
||||
return $string;
|
||||
}
|
||||
|
||||
/**
|
||||
|
|
@ -71,13 +67,7 @@ class Stream implements StreamInterface
|
|||
*/
|
||||
public function close()
|
||||
{
|
||||
if ($this->resource === null) {
|
||||
return;
|
||||
}
|
||||
|
||||
$resource = $this->resource;
|
||||
fclose($resource);
|
||||
$this->resource = null;
|
||||
fclose($this->resource);
|
||||
}
|
||||
|
||||
/**
|
||||
|
|
@ -89,9 +79,9 @@ class Stream implements StreamInterface
|
|||
*/
|
||||
public function detach()
|
||||
{
|
||||
$resource = $this->resource;
|
||||
$stream = $this->resource;
|
||||
$this->resource = null;
|
||||
return $resource;
|
||||
return $stream;
|
||||
}
|
||||
|
||||
/**
|
||||
|
|
@ -101,32 +91,23 @@ class Stream implements StreamInterface
|
|||
*/
|
||||
public function getSize()
|
||||
{
|
||||
if ($this->resource === null) {
|
||||
return null;
|
||||
}
|
||||
|
||||
$statistics = fstat($this->resource);
|
||||
if ($statistics && $statistics['size']) {
|
||||
return $statistics['size'];
|
||||
}
|
||||
return null;
|
||||
return $statistics["size"] ?: null;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the current position of the file read/write pointer
|
||||
*
|
||||
* @return int Position of the file pointer
|
||||
* @throws RuntimeException on error.
|
||||
* @throws \RuntimeException on error.
|
||||
*/
|
||||
public function tell()
|
||||
{
|
||||
if ($this->resource === null) {
|
||||
throw new RuntimeException('Unable to retrieve current position of detached stream.');
|
||||
}
|
||||
|
||||
$position = ftell($this->resource);
|
||||
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;
|
||||
}
|
||||
|
|
@ -138,10 +119,6 @@ class Stream implements StreamInterface
|
|||
*/
|
||||
public function eof()
|
||||
{
|
||||
if ($this->resource === null) {
|
||||
return true;
|
||||
}
|
||||
|
||||
return feof($this->resource);
|
||||
}
|
||||
|
||||
|
|
@ -152,11 +129,7 @@ class Stream implements StreamInterface
|
|||
*/
|
||||
public function isSeekable()
|
||||
{
|
||||
if ($this->resource === null) {
|
||||
return false;
|
||||
}
|
||||
|
||||
return $this->getMetadata('seekable') == 1;
|
||||
return $this->getMetadata("seekable") == 1;
|
||||
}
|
||||
|
||||
/**
|
||||
|
|
@ -169,21 +142,18 @@ class Stream implements StreamInterface
|
|||
* PHP $whence values for `fseek()`. SEEK_SET: Set position equal to
|
||||
* offset bytes SEEK_CUR: Set position to current location 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)
|
||||
{
|
||||
if ($this->resource === null) {
|
||||
throw new RuntimeException('Unable to seek detached stream.');
|
||||
}
|
||||
|
||||
$result = -1;
|
||||
if ($this->isSeekable()) {
|
||||
$result = fseek($this->resource, $offset, $whence);
|
||||
}
|
||||
if ($result === -1) {
|
||||
throw new RuntimeException('Unable to seek to position.');
|
||||
// @codeCoverageIgnoreStart
|
||||
throw new \RuntimeException("Unable to seek to position.");
|
||||
// @codeCoverageIgnoreEnd
|
||||
}
|
||||
}
|
||||
|
||||
|
|
@ -195,21 +165,18 @@ class Stream implements StreamInterface
|
|||
*
|
||||
* @see seek()
|
||||
* @link http://www.php.net/manual/en/function.fseek.php
|
||||
* @return void
|
||||
* @throws RuntimeException on failure.
|
||||
* @throws \RuntimeException on failure.
|
||||
*/
|
||||
public function rewind()
|
||||
{
|
||||
if ($this->resource === null) {
|
||||
throw new RuntimeException('Unable to seek detached stream.');
|
||||
}
|
||||
|
||||
$result = false;
|
||||
if ($this->isSeekable()) {
|
||||
$result = rewind($this->resource);
|
||||
}
|
||||
if ($result === false) {
|
||||
throw new RuntimeException('Unable to rewind.');
|
||||
// @codeCoverageIgnoreStart
|
||||
throw new \RuntimeException("Unable to seek to position.");
|
||||
// @codeCoverageIgnoreEnd
|
||||
}
|
||||
}
|
||||
|
||||
|
|
@ -220,12 +187,8 @@ class Stream implements StreamInterface
|
|||
*/
|
||||
public function isWritable()
|
||||
{
|
||||
if ($this->resource === null) {
|
||||
return false;
|
||||
}
|
||||
|
||||
$mode = $this->getBasicMode();
|
||||
return in_array($mode, self::WRITABLE_MODES);
|
||||
$mode = $this->getMetadata("mode");
|
||||
return $mode[0] !== "r" || strpos($mode, "+") !== false;
|
||||
}
|
||||
|
||||
/**
|
||||
|
|
@ -233,20 +196,16 @@ class Stream implements StreamInterface
|
|||
*
|
||||
* @param string $string The string that is to be written.
|
||||
* @return int Returns the number of bytes written to the stream.
|
||||
* @throws RuntimeException on failure.
|
||||
* @throws \RuntimeException on failure.
|
||||
*/
|
||||
public function write($string)
|
||||
{
|
||||
if ($this->resource === null) {
|
||||
throw new RuntimeException('Unable to write to detached stream.');
|
||||
}
|
||||
|
||||
$result = false;
|
||||
if ($this->isWritable()) {
|
||||
$result = fwrite($this->resource, $string);
|
||||
}
|
||||
if ($result === false) {
|
||||
throw new RuntimeException('Unable to write to stream.');
|
||||
throw new \RuntimeException("Unable to write to stream.");
|
||||
}
|
||||
return $result;
|
||||
}
|
||||
|
|
@ -258,12 +217,8 @@ class Stream implements StreamInterface
|
|||
*/
|
||||
public function isReadable()
|
||||
{
|
||||
if ($this->resource === null) {
|
||||
return false;
|
||||
}
|
||||
|
||||
$mode = $this->getBasicMode();
|
||||
return in_array($mode, self::READABLE_MODES);
|
||||
$mode = $this->getMetadata("mode");
|
||||
return strpos($mode, "r") !== false || strpos($mode, "+") !== false;
|
||||
}
|
||||
|
||||
/**
|
||||
|
|
@ -274,20 +229,16 @@ class Stream implements StreamInterface
|
|||
* call returns fewer bytes.
|
||||
* @return string Returns the data read from the stream, or an empty string
|
||||
* if no bytes are available.
|
||||
* @throws RuntimeException if an error occurs.
|
||||
* @throws \RuntimeException if an error occurs.
|
||||
*/
|
||||
public function read($length)
|
||||
{
|
||||
if ($this->resource === null) {
|
||||
throw new RuntimeException('Unable to read to detached stream.');
|
||||
}
|
||||
|
||||
$result = false;
|
||||
if ($this->isReadable()) {
|
||||
$result = fread($this->resource, $length);
|
||||
}
|
||||
if ($result === false) {
|
||||
throw new RuntimeException('Unable to read from stream.');
|
||||
throw new \RuntimeException("Unable to read from stream.");
|
||||
}
|
||||
return $result;
|
||||
}
|
||||
|
|
@ -296,21 +247,17 @@ class Stream implements StreamInterface
|
|||
* Returns the remaining contents in a 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.
|
||||
*/
|
||||
public function getContents()
|
||||
{
|
||||
if ($this->resource === null) {
|
||||
throw new RuntimeException('Unable to read to detached stream.');
|
||||
}
|
||||
|
||||
$result = false;
|
||||
if ($this->isReadable()) {
|
||||
$result = stream_get_contents($this->resource);
|
||||
}
|
||||
if ($result === false) {
|
||||
throw new RuntimeException('Unable to read from stream.');
|
||||
throw new \RuntimeException("Unable to read from stream.");
|
||||
}
|
||||
return $result;
|
||||
}
|
||||
|
|
@ -322,17 +269,13 @@ class Stream implements StreamInterface
|
|||
* stream_get_meta_data() function.
|
||||
*
|
||||
* @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
|
||||
* provided. Returns a specific key value if a key is provided and the
|
||||
* value is found, or null if the key is not found.
|
||||
*/
|
||||
public function getMetadata($key = null)
|
||||
{
|
||||
if ($this->resource === null) {
|
||||
return null;
|
||||
}
|
||||
|
||||
$metadata = stream_get_meta_data($this->resource);
|
||||
if ($key === null) {
|
||||
return $metadata;
|
||||
|
|
@ -340,14 +283,4 @@ class Stream implements StreamInterface
|
|||
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);
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -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);
|
||||
}
|
||||
}
|
||||
|
|
@ -2,33 +2,24 @@
|
|||
|
||||
namespace WellRESTed\Message;
|
||||
|
||||
use InvalidArgumentException;
|
||||
use Psr\Http\Message\StreamInterface;
|
||||
use Psr\Http\Message\UploadedFileInterface;
|
||||
use RuntimeException;
|
||||
|
||||
/**
|
||||
* Value object representing a file uploaded through an HTTP request.
|
||||
*/
|
||||
class UploadedFile implements UploadedFileInterface
|
||||
{
|
||||
/** @var string */
|
||||
private $clientFilename;
|
||||
/** @var string */
|
||||
private $clientMediaType;
|
||||
/** @var int */
|
||||
private $error;
|
||||
/** @var bool */
|
||||
private $moved = false;
|
||||
/** @var int */
|
||||
private $size;
|
||||
/** @var StreamInterface */
|
||||
private $stream;
|
||||
/** @var string|null */
|
||||
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:
|
||||
*
|
||||
* array(
|
||||
|
|
@ -66,11 +57,10 @@ class UploadedFile implements UploadedFileInterface
|
|||
$this->size = $size;
|
||||
|
||||
if (file_exists($tmpName)) {
|
||||
$this->stream = new Stream(fopen($tmpName, 'rb'));
|
||||
$this->tmpName = $tmpName;
|
||||
$this->stream = new Stream(fopen($tmpName, "r"));
|
||||
} else {
|
||||
$this->stream = new NullStream();
|
||||
$this->tmpName = null;
|
||||
}
|
||||
}
|
||||
|
||||
|
|
@ -87,19 +77,16 @@ class UploadedFile implements UploadedFileInterface
|
|||
* raise an exception.
|
||||
*
|
||||
* @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.
|
||||
*/
|
||||
public function getStream()
|
||||
{
|
||||
if ($this->tmpName === null) {
|
||||
throw new RuntimeException('Unable to read uploaded file.');
|
||||
}
|
||||
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)) {
|
||||
throw new RuntimeException('File is not an uploaded file.');
|
||||
if (php_sapi_name() !== "cli" && !is_uploaded_file($this->tmpName)) {
|
||||
throw new \RuntimeException("File is not an uploaded file.");
|
||||
}
|
||||
return $this->stream;
|
||||
}
|
||||
|
|
@ -117,21 +104,20 @@ class UploadedFile implements UploadedFileInterface
|
|||
*
|
||||
* @see http://php.net/is_uploaded_file
|
||||
* @see http://php.net/move_uploaded_file
|
||||
* @param string $targetPath Path to which to move the uploaded file.
|
||||
* @return void
|
||||
* @throws InvalidArgumentException if the $path specified is invalid.
|
||||
* @throws RuntimeException on any error during the move operation, or on
|
||||
* @param string $path Path to which to move the uploaded file.
|
||||
* @throws \InvalidArgumentException if the $path specified is invalid.
|
||||
* @throws \RuntimeException on any error during the move operation, or on
|
||||
* the second or subsequent call to the method.
|
||||
*/
|
||||
public function moveTo($targetPath)
|
||||
public function moveTo($path)
|
||||
{
|
||||
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') {
|
||||
rename($this->tmpName, $targetPath);
|
||||
if (php_sapi_name() === "cli") {
|
||||
rename($this->tmpName, $path);
|
||||
} else {
|
||||
move_uploaded_file($this->tmpName, $targetPath);
|
||||
move_uploaded_file($this->tmpName, $path);
|
||||
}
|
||||
$this->moved = true;
|
||||
}
|
||||
|
|
|
|||
|
|
@ -2,7 +2,6 @@
|
|||
|
||||
namespace WellRESTed\Message;
|
||||
|
||||
use InvalidArgumentException;
|
||||
use Psr\Http\Message\UriInterface;
|
||||
|
||||
/**
|
||||
|
|
@ -18,41 +17,60 @@ use Psr\Http\Message\UriInterface;
|
|||
*/
|
||||
class Uri implements UriInterface
|
||||
{
|
||||
private const MIN_PORT = 0;
|
||||
private const MAX_PORT = 65535;
|
||||
const MIN_PORT = 0;
|
||||
const MAX_PORT = 65535;
|
||||
|
||||
/** @var string */
|
||||
private $scheme;
|
||||
private $scheme = "";
|
||||
/** @var string */
|
||||
private $user;
|
||||
/** @var string */
|
||||
private $user = "";
|
||||
/** @var string|null */
|
||||
private $password;
|
||||
/** @var string */
|
||||
private $host;
|
||||
/** @var string */
|
||||
private $host = "";
|
||||
/** @var int|null */
|
||||
private $port;
|
||||
/** @var string */
|
||||
private $path;
|
||||
/** @var string */
|
||||
private $query;
|
||||
/** @var string */
|
||||
private $fragment;
|
||||
/** @var string */
|
||||
private $path = "";
|
||||
/** @var string */
|
||||
private $query = "";
|
||||
/** @var string */
|
||||
private $fragment = "";
|
||||
|
||||
/**
|
||||
* @param string $uri A string representation of a URI.
|
||||
*/
|
||||
public function __construct(string $uri = '')
|
||||
public function __construct($uri = "")
|
||||
{
|
||||
$parsed = parse_url($uri);
|
||||
|
||||
$this->scheme = $parsed['scheme'] ?? '';
|
||||
$this->user = $parsed['user'] ?? '';
|
||||
$this->password = $parsed['pass'] ?? '';
|
||||
$this->host = strtolower($parsed['host'] ?? '');
|
||||
$this->port = $parsed['port'] ?? null;
|
||||
$this->path = $parsed['path'] ?? '';
|
||||
$this->query = $parsed['query'] ?? '';
|
||||
$this->fragment = $parsed['fragment'] ?? '';
|
||||
if (is_string($uri) && $uri !== "") {
|
||||
$parsed = parse_url($uri);
|
||||
if ($parsed !== false) {
|
||||
if (isset($parsed["scheme"])) {
|
||||
$this->scheme = $parsed["scheme"];
|
||||
}
|
||||
if (isset($parsed["host"])) {
|
||||
$this->host = strtolower($parsed["host"]);
|
||||
}
|
||||
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()
|
||||
{
|
||||
$authority = "";
|
||||
|
||||
$host = $this->getHost();
|
||||
if (!$host) {
|
||||
return '';
|
||||
}
|
||||
if ($host !== "") {
|
||||
|
||||
$authority = '';
|
||||
// User Info
|
||||
$userInfo = $this->getUserInfo();
|
||||
if ($userInfo !== "") {
|
||||
$authority .= $userInfo . "@";
|
||||
}
|
||||
|
||||
// User Info
|
||||
$userInfo = $this->getUserInfo();
|
||||
if ($userInfo) {
|
||||
$authority .= $userInfo . '@';
|
||||
}
|
||||
// Host
|
||||
$authority .= $host;
|
||||
|
||||
// Host
|
||||
$authority .= $host;
|
||||
|
||||
// Port: Include only if non-standard
|
||||
if ($this->nonStandardPort()) {
|
||||
$authority .= ':' . $this->getPort();
|
||||
// Port: Include only if set AND non-standard.
|
||||
$port = $this->getPort();
|
||||
if ($port !== null) {
|
||||
$scheme = $this->getScheme();
|
||||
if (($scheme === "http" && $port !== 80 ) || ($scheme === "https" && $port !== 443)) {
|
||||
$authority .= ":" . $port;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
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.
|
||||
*
|
||||
|
|
@ -145,7 +158,7 @@ class Uri implements UriInterface
|
|||
{
|
||||
$userInfo = $this->user;
|
||||
if ($userInfo && $this->password) {
|
||||
$userInfo .= ':' . $this->password;
|
||||
$userInfo .= ":" . $this->password;
|
||||
}
|
||||
return $userInfo;
|
||||
}
|
||||
|
|
@ -185,9 +198,9 @@ class Uri implements UriInterface
|
|||
{
|
||||
if ($this->port === null) {
|
||||
switch ($this->scheme) {
|
||||
case 'http':
|
||||
case "http":
|
||||
return 80;
|
||||
case 'https':
|
||||
case "https":
|
||||
return 443;
|
||||
default:
|
||||
return null;
|
||||
|
|
@ -223,7 +236,7 @@ class Uri implements UriInterface
|
|||
*/
|
||||
public function getPath()
|
||||
{
|
||||
if ($this->path === '*') {
|
||||
if ($this->path === "*") {
|
||||
return $this->path;
|
||||
}
|
||||
return $this->percentEncode($this->path);
|
||||
|
|
@ -288,13 +301,13 @@ class Uri implements UriInterface
|
|||
*
|
||||
* @param string $scheme The scheme to use with the new instance.
|
||||
* @return static 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)
|
||||
{
|
||||
$scheme = strtolower($scheme ?? '');
|
||||
if (!in_array($scheme, ['', 'http', 'https'])) {
|
||||
throw new InvalidArgumentException('Scheme must be http, https, or empty.');
|
||||
$scheme = $scheme ? strtolower($scheme) : "";
|
||||
if (!in_array($scheme, ["", "http", "https"])) {
|
||||
throw new \InvalidArgumentException("Scheme must be http, https, or empty.");
|
||||
}
|
||||
$uri = clone $this;
|
||||
$uri->scheme = $scheme;
|
||||
|
|
@ -319,7 +332,7 @@ class Uri implements UriInterface
|
|||
{
|
||||
$uri = clone $this;
|
||||
$uri->user = $user;
|
||||
$uri->password = $password ?? '';
|
||||
$uri->password = $password;
|
||||
return $uri;
|
||||
}
|
||||
|
||||
|
|
@ -333,12 +346,12 @@ class Uri implements UriInterface
|
|||
*
|
||||
* @param string $host The hostname to use with the new instance.
|
||||
* @return static A new instance with the specified host.
|
||||
* @throws InvalidArgumentException for invalid hostnames.
|
||||
* @throws \InvalidArgumentException for invalid hostnames.
|
||||
*/
|
||||
public function withHost($host)
|
||||
{
|
||||
if (!is_string($host)) {
|
||||
throw new InvalidArgumentException('Host must be a string.');
|
||||
throw new \InvalidArgumentException("Host must be a string.");
|
||||
}
|
||||
|
||||
$uri = clone $this;
|
||||
|
|
@ -361,18 +374,18 @@ class Uri implements UriInterface
|
|||
* @param null|int $port The port to use with the new instance; a null value
|
||||
* removes the port information.
|
||||
* @return static A new instance with the specified port.
|
||||
* @throws InvalidArgumentException for invalid ports.
|
||||
* @throws \InvalidArgumentException for invalid ports.
|
||||
*/
|
||||
public function withPort($port)
|
||||
{
|
||||
if (is_numeric($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);
|
||||
throw new InvalidArgumentException($message);
|
||||
$message = sprintf("Port must be between %s and %s.", self::MIN_PORT, self::MAX_PORT);
|
||||
throw new \InvalidArgumentException($message);
|
||||
}
|
||||
$port = (int) $port;
|
||||
} 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;
|
||||
|
|
@ -395,12 +408,12 @@ class Uri implements UriInterface
|
|||
*
|
||||
* @param string $path The path to use with the new instance.
|
||||
* @return static A new instance with the specified path.
|
||||
* @throws InvalidArgumentException for invalid paths.
|
||||
* @throws \InvalidArgumentException for invalid paths.
|
||||
*/
|
||||
public function withPath($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->path = $path;
|
||||
|
|
@ -420,7 +433,7 @@ class Uri implements UriInterface
|
|||
*
|
||||
* @param string $query The query string to use with the new instance.
|
||||
* @return static A new instance with the specified query string.
|
||||
* @throws InvalidArgumentException for invalid query strings.
|
||||
* @throws \InvalidArgumentException for invalid query strings.
|
||||
*/
|
||||
public function withQuery($query)
|
||||
{
|
||||
|
|
@ -446,7 +459,7 @@ class Uri implements UriInterface
|
|||
public function withFragment($fragment)
|
||||
{
|
||||
$uri = clone $this;
|
||||
$uri->fragment = $fragment ?? '';
|
||||
$uri->fragment = $fragment;
|
||||
return $uri;
|
||||
}
|
||||
|
||||
|
|
@ -475,29 +488,29 @@ class Uri implements UriInterface
|
|||
*/
|
||||
public function __toString()
|
||||
{
|
||||
$string = '';
|
||||
$string = "";
|
||||
|
||||
$authority = $this->getAuthority();
|
||||
if ($authority !== '') {
|
||||
if ($authority !== "") {
|
||||
$scheme = $this->getScheme();
|
||||
if ($scheme !== '') {
|
||||
$string = $scheme . ':';
|
||||
if ($scheme !== "") {
|
||||
$string = $scheme . ":";
|
||||
}
|
||||
$string .= "//$authority";
|
||||
}
|
||||
|
||||
$path = $this->getPath();
|
||||
if ($path !== '') {
|
||||
if ($path !== "") {
|
||||
$string .= $path;
|
||||
}
|
||||
|
||||
$query = $this->getQuery();
|
||||
if ($query !== '') {
|
||||
if ($query !== "") {
|
||||
$string .= "?$query";
|
||||
}
|
||||
|
||||
$fragment = $this->getFragment();
|
||||
if ($fragment !== '') {
|
||||
if ($fragment !== "") {
|
||||
$string .= "#$fragment";
|
||||
}
|
||||
|
||||
|
|
@ -520,12 +533,12 @@ class Uri implements UriInterface
|
|||
* @param string $subject
|
||||
* @return string
|
||||
*/
|
||||
private function percentEncode(string $subject)
|
||||
private function percentEncode($subject)
|
||||
{
|
||||
$reserved = ':/?#[]@!$&\'()*+,;=';
|
||||
$reserved = preg_quote($reserved);
|
||||
$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 preg_replace_callback($pattern, $callback, $subject);
|
||||
|
|
|
|||
|
|
@ -5,19 +5,13 @@ namespace WellRESTed\Routing\Route;
|
|||
use Psr\Http\Message\ResponseInterface;
|
||||
use Psr\Http\Message\ServerRequestInterface;
|
||||
use WellRESTed\Dispatching\DispatcherInterface;
|
||||
use WellRESTed\MiddlewareInterface;
|
||||
|
||||
/**
|
||||
* @internal
|
||||
*/
|
||||
class MethodMap implements MiddlewareInterface
|
||||
class MethodMap
|
||||
{
|
||||
/** @var DispatcherInterface */
|
||||
private $dispatcher;
|
||||
/** @var array */
|
||||
private $map;
|
||||
|
||||
// -------------------------------------------------------------------------
|
||||
// ------------------------------------------------------------------------
|
||||
|
||||
public function __construct(DispatcherInterface $dispatcher)
|
||||
{
|
||||
|
|
@ -25,8 +19,11 @@ class MethodMap implements MiddlewareInterface
|
|||
$this->dispatcher = $dispatcher;
|
||||
}
|
||||
|
||||
// ------------------------------------------------------------------------
|
||||
// MethodMapInterface
|
||||
|
||||
/**
|
||||
* Register a dispatchable (e.g.m handler or middleware) with a method.
|
||||
* Register a dispatchable (handler or middleware) with a method.
|
||||
*
|
||||
* $method may be:
|
||||
* - A single verb ("GET"),
|
||||
|
|
@ -42,16 +39,16 @@ class MethodMap implements MiddlewareInterface
|
|||
* @param string $method
|
||||
* @param mixed $dispatchable
|
||||
*/
|
||||
public function register(string $method, $dispatchable): void
|
||||
public function register($method, $dispatchable)
|
||||
{
|
||||
$methods = explode(',', $method);
|
||||
$methods = array_map('trim', $methods);
|
||||
$methods = explode(",", $method);
|
||||
$methods = array_map("trim", $methods);
|
||||
foreach ($methods as $method) {
|
||||
$this->map[$method] = $dispatchable;
|
||||
}
|
||||
}
|
||||
|
||||
// -------------------------------------------------------------------------
|
||||
// ------------------------------------------------------------------------
|
||||
// MiddlewareInterface
|
||||
|
||||
/**
|
||||
|
|
@ -72,18 +69,18 @@ class MethodMap implements MiddlewareInterface
|
|||
return $this->dispatchMiddleware($middleware, $request, $response, $next);
|
||||
}
|
||||
// For HEAD, dispatch GET by default.
|
||||
if ($method === 'HEAD' && isset($this->map['GET'])) {
|
||||
$middleware = $this->map['GET'];
|
||||
if ($method === "HEAD" && isset($this->map["GET"])) {
|
||||
$middleware = $this->map["GET"];
|
||||
return $this->dispatchMiddleware($middleware, $request, $response, $next);
|
||||
}
|
||||
// Dispatch * middleware, if registered.
|
||||
if (isset($this->map['*'])) {
|
||||
$middleware = $this->map['*'];
|
||||
if (isset($this->map["*"])) {
|
||||
$middleware = $this->map["*"];
|
||||
return $this->dispatchMiddleware($middleware, $request, $response, $next);
|
||||
}
|
||||
// Respond describing the allowed methods, either as a 405 response or
|
||||
// in response to an OPTIONS request.
|
||||
if ($method === 'OPTIONS') {
|
||||
if ($method === "OPTIONS") {
|
||||
$response = $response->withStatus(200);
|
||||
} else {
|
||||
$response = $response->withStatus(405);
|
||||
|
|
@ -91,42 +88,39 @@ class MethodMap implements MiddlewareInterface
|
|||
return $this->addAllowHeader($response);
|
||||
}
|
||||
|
||||
// -------------------------------------------------------------------------
|
||||
// ------------------------------------------------------------------------
|
||||
|
||||
private function addAllowHeader(ResponseInterface $response): ResponseInterface
|
||||
private function addAllowHeader(ResponseInterface $response)
|
||||
{
|
||||
$methods = join(',', $this->getAllowedMethods());
|
||||
return $response->withHeader('Allow', $methods);
|
||||
$methods = join(",", $this->getAllowedMethods());
|
||||
return $response->withHeader("Allow", $methods);
|
||||
}
|
||||
|
||||
/**
|
||||
* @return string[]
|
||||
*/
|
||||
private function getAllowedMethods(): array
|
||||
private function getAllowedMethods()
|
||||
{
|
||||
$methods = array_keys($this->map);
|
||||
// Add HEAD if GET is allowed and HEAD is not present.
|
||||
if (in_array('GET', $methods) && !in_array('HEAD', $methods)) {
|
||||
$methods[] = 'HEAD';
|
||||
if (in_array("GET", $methods) && !in_array("HEAD", $methods)) {
|
||||
$methods[] = "HEAD";
|
||||
}
|
||||
// Add OPTIONS if not already present.
|
||||
if (!in_array('OPTIONS', $methods)) {
|
||||
$methods[] = 'OPTIONS';
|
||||
if (!in_array("OPTIONS", $methods)) {
|
||||
$methods[] = "OPTIONS";
|
||||
}
|
||||
return $methods;
|
||||
}
|
||||
|
||||
/**
|
||||
* @param mixed $middleware
|
||||
* @param $middleware
|
||||
* @param ServerRequestInterface $request
|
||||
* @param ResponseInterface $response
|
||||
* @param callable $next
|
||||
* @param $next
|
||||
* @return ResponseInterface
|
||||
*/
|
||||
private function dispatchMiddleware(
|
||||
$middleware,
|
||||
ServerRequestInterface $request,
|
||||
ResponseInterface $response,
|
||||
ResponseInterface &$response,
|
||||
$next
|
||||
) {
|
||||
return $this->dispatcher->dispatch($middleware, $request, $response, $next);
|
||||
|
|
|
|||
|
|
@ -2,28 +2,25 @@
|
|||
|
||||
namespace WellRESTed\Routing\Route;
|
||||
|
||||
/**
|
||||
* @internal
|
||||
*/
|
||||
class PrefixRoute extends Route
|
||||
{
|
||||
public function __construct(string $target, MethodMap $methodMap)
|
||||
public function __construct($target, $methodMap)
|
||||
{
|
||||
parent::__construct(rtrim($target, '*'), $methodMap);
|
||||
parent::__construct(rtrim($target, "*"), $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.
|
||||
*
|
||||
* @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;
|
||||
}
|
||||
|
|
@ -31,7 +28,7 @@ class PrefixRoute extends Route
|
|||
/**
|
||||
* Always returns an empty array.
|
||||
*/
|
||||
public function getPathVariables(): array
|
||||
public function getPathVariables()
|
||||
{
|
||||
return [];
|
||||
}
|
||||
|
|
|
|||
|
|
@ -2,28 +2,22 @@
|
|||
|
||||
namespace WellRESTed\Routing\Route;
|
||||
|
||||
use RuntimeException;
|
||||
|
||||
/**
|
||||
* @internal
|
||||
*/
|
||||
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.
|
||||
*
|
||||
* @param string $requestTarget
|
||||
* @return bool
|
||||
* @return boolean
|
||||
*/
|
||||
public function matchesRequestTarget(string $requestTarget): bool
|
||||
public function matchesRequestTarget($requestTarget)
|
||||
{
|
||||
$this->captures = [];
|
||||
$matched = preg_match($this->getTarget(), $requestTarget, $captures);
|
||||
|
|
@ -31,7 +25,7 @@ class RegexRoute extends Route
|
|||
$this->captures = $captures;
|
||||
return true;
|
||||
} elseif ($matched === false) {
|
||||
throw new RuntimeException('Invalid regular expression: ' . $this->getTarget());
|
||||
throw new \RuntimeException("Invalid regular expression: " . $this->getTarget());
|
||||
}
|
||||
return false;
|
||||
}
|
||||
|
|
@ -42,7 +36,7 @@ class RegexRoute extends Route
|
|||
* @see \preg_match
|
||||
* @return array
|
||||
*/
|
||||
public function getPathVariables(): array
|
||||
public function getPathVariables()
|
||||
{
|
||||
return $this->captures;
|
||||
}
|
||||
|
|
|
|||
|
|
@ -4,77 +4,24 @@ namespace WellRESTed\Routing\Route;
|
|||
|
||||
use Psr\Http\Message\ResponseInterface;
|
||||
use Psr\Http\Message\ServerRequestInterface;
|
||||
use RuntimeException;
|
||||
use WellRESTed\MiddlewareInterface;
|
||||
|
||||
/**
|
||||
* @internal
|
||||
*/
|
||||
abstract class Route implements MiddlewareInterface
|
||||
abstract class Route implements RouteInterface
|
||||
{
|
||||
/** 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 */
|
||||
protected $target;
|
||||
/** @var MethodMap */
|
||||
protected $methodMap;
|
||||
|
||||
public function __construct(string $target, MethodMap $methodMap)
|
||||
public function __construct($target, $methodMap)
|
||||
{
|
||||
$this->target = $target;
|
||||
$this->methodMap = $methodMap;
|
||||
}
|
||||
|
||||
/**
|
||||
* Return the Route::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 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;
|
||||
|
||||
/**
|
||||
* 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
|
||||
*/
|
||||
public function getTarget(): string
|
||||
public function getTarget()
|
||||
{
|
||||
return $this->target;
|
||||
}
|
||||
|
|
@ -93,17 +40,11 @@ abstract class Route implements MiddlewareInterface
|
|||
* @param string $method
|
||||
* @param mixed $dispatchable
|
||||
*/
|
||||
public function register(string $method, $dispatchable): void
|
||||
public function register($method, $dispatchable)
|
||||
{
|
||||
$this->methodMap->register($method, $dispatchable);
|
||||
}
|
||||
|
||||
/**
|
||||
* @param ServerRequestInterface $request
|
||||
* @param ResponseInterface $response
|
||||
* @param callable $next
|
||||
* @return ResponseInterface
|
||||
*/
|
||||
public function __invoke(ServerRequestInterface $request, ResponseInterface $response, $next)
|
||||
{
|
||||
$map = $this->methodMap;
|
||||
|
|
|
|||
|
|
@ -5,9 +5,9 @@ namespace WellRESTed\Routing\Route;
|
|||
use WellRESTed\Dispatching\DispatcherInterface;
|
||||
|
||||
/**
|
||||
* @internal
|
||||
* Class for creating routes
|
||||
*/
|
||||
class RouteFactory
|
||||
class RouteFactory implements RouteFactoryInterface
|
||||
{
|
||||
private $dispatcher;
|
||||
|
||||
|
|
@ -25,16 +25,16 @@ class RouteFactory
|
|||
* - Regular expressions will create RegexRoutes
|
||||
*
|
||||
* @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
|
||||
|
||||
// PrefixRoutes end with *
|
||||
if (substr($target, -1) === '*') {
|
||||
if (substr($target, -1) === "*") {
|
||||
return new PrefixRoute($target, new MethodMap($this->dispatcher));
|
||||
}
|
||||
|
||||
|
|
|
|||
|
|
@ -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);
|
||||
}
|
||||
|
|
@ -0,0 +1,75 @@
|
|||
<?php
|
||||
|
||||
namespace WellRESTed\Routing\Route;
|
||||
|
||||
use WellRESTed\MiddlewareInterface;
|
||||
|
||||
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();
|
||||
|
||||
/**
|
||||
* 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);
|
||||
|
||||
/**
|
||||
* 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($method, $dispatchable);
|
||||
}
|
||||
|
|
@ -2,23 +2,20 @@
|
|||
|
||||
namespace WellRESTed\Routing\Route;
|
||||
|
||||
/**
|
||||
* @internal
|
||||
*/
|
||||
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.
|
||||
*
|
||||
* @param string $requestTarget
|
||||
* @return bool
|
||||
* @return boolean
|
||||
*/
|
||||
public function matchesRequestTarget(string $requestTarget): bool
|
||||
public function matchesRequestTarget($requestTarget)
|
||||
{
|
||||
return $requestTarget === $this->getTarget();
|
||||
}
|
||||
|
|
@ -26,7 +23,7 @@ class StaticRoute extends Route
|
|||
/**
|
||||
* Always returns an empty array.
|
||||
*/
|
||||
public function getPathVariables(): array
|
||||
public function getPathVariables()
|
||||
{
|
||||
return [];
|
||||
}
|
||||
|
|
|
|||
|
|
@ -2,41 +2,36 @@
|
|||
|
||||
namespace WellRESTed\Routing\Route;
|
||||
|
||||
/**
|
||||
* @internal
|
||||
*/
|
||||
class TemplateRoute extends Route
|
||||
{
|
||||
/** Regular expression matching a URI template variable (e.g., {id}) */
|
||||
public const URI_TEMPLATE_EXPRESSION_RE = '/{([+.\/]?[a-zA-Z0-9_,]+\*?)}/';
|
||||
private $pathVariables;
|
||||
private $explosions;
|
||||
|
||||
/**
|
||||
* Regular expression matching 1 or more unreserved characters.
|
||||
* 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 */
|
||||
private $pathVariables = [];
|
||||
/** @var array */
|
||||
private $explosions = [];
|
||||
|
||||
public function getType(): int
|
||||
public function getType()
|
||||
{
|
||||
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.
|
||||
*
|
||||
* @param string $requestTarget
|
||||
* @return bool
|
||||
* @return boolean
|
||||
*/
|
||||
public function matchesRequestTarget(string $requestTarget): bool
|
||||
public function matchesRequestTarget($requestTarget)
|
||||
{
|
||||
$this->pathVariables = [];
|
||||
$this->explosions = [];
|
||||
|
|
@ -54,55 +49,54 @@ class TemplateRoute extends Route
|
|||
return false;
|
||||
}
|
||||
|
||||
private function matchesStartOfRequestTarget(string $requestTarget): bool
|
||||
private function matchesStartOfRequestTarget($requestTarget)
|
||||
{
|
||||
$firstVarPos = strpos($this->target, '{');
|
||||
if ($firstVarPos === false) {
|
||||
return $requestTarget === $this->target;
|
||||
}
|
||||
return substr($requestTarget, 0, $firstVarPos) === substr($this->target, 0, $firstVarPos);
|
||||
$firstVarPos = strpos($this->target, "{");
|
||||
return (substr($requestTarget, 0, $firstVarPos) === substr($this->target, 0, $firstVarPos));
|
||||
}
|
||||
|
||||
private function processMatches(array $matches): array
|
||||
private function processMatches($matches)
|
||||
{
|
||||
$variables = [];
|
||||
|
||||
// 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.
|
||||
foreach ($keys as $key) {
|
||||
|
||||
$value = $matches[$key];
|
||||
|
||||
if (isset($this->explosions[$key])) {
|
||||
$values = explode($this->explosions[$key], $value);
|
||||
$variables[$key] = array_map('urldecode', $values);
|
||||
$variables[$key] = array_map("urldecode", $values);
|
||||
} else {
|
||||
$value = urldecode($value);
|
||||
$variables[$key] = $value;
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
return $variables;
|
||||
}
|
||||
|
||||
private function getMatchingPattern(): string
|
||||
private function getMatchingPattern()
|
||||
{
|
||||
// Convert the template into the pattern
|
||||
$pattern = $this->target;
|
||||
|
||||
// Escape allowable characters with regex meaning.
|
||||
$escape = [
|
||||
'.' => '\\.',
|
||||
'-' => '\\-',
|
||||
'+' => '\\+',
|
||||
'*' => '\\*'
|
||||
"." => "\\.",
|
||||
"-" => "\\-",
|
||||
"+" => "\\+",
|
||||
"*" => "\\*"
|
||||
];
|
||||
$pattern = str_replace(array_keys($escape), array_values($escape), $pattern);
|
||||
$unescape = [
|
||||
'{\\+' => '{+',
|
||||
'{\\.' => '{.',
|
||||
'\\*}' => '*}'
|
||||
"{\\+" => "{+",
|
||||
"{\\." => "{.",
|
||||
"\\*}" => "*}"
|
||||
];
|
||||
$pattern = str_replace(array_keys($unescape), array_values($unescape), $pattern);
|
||||
|
||||
|
|
@ -111,47 +105,47 @@ class TemplateRoute extends Route
|
|||
|
||||
$pattern = preg_replace_callback(
|
||||
self::URI_TEMPLATE_EXPRESSION_RE,
|
||||
[$this, 'uriVariableReplacementCallback'],
|
||||
[$this, "uriVariableReplacementCallback"],
|
||||
$pattern
|
||||
);
|
||||
|
||||
return $pattern;
|
||||
}
|
||||
|
||||
private function uriVariableReplacementCallback(array $matches): string
|
||||
private function uriVariableReplacementCallback($matches)
|
||||
{
|
||||
$name = $matches[1];
|
||||
$pattern = self::RE_UNRESERVED;
|
||||
|
||||
$prefix = '';
|
||||
$delimiter = ',';
|
||||
$explodeDelimiter = ',';
|
||||
$prefix = "";
|
||||
$delimiter = ",";
|
||||
$explodeDelimiter = ",";
|
||||
|
||||
// Read the first character as an operator. This determines which
|
||||
// characters to allow in the match.
|
||||
$operator = $name[0];
|
||||
|
||||
// Read the last character as the modifier.
|
||||
$explosion = (substr($name, -1, 1) === '*');
|
||||
$explosion = (substr($name, -1, 1) === "*");
|
||||
|
||||
switch ($operator) {
|
||||
case '+':
|
||||
case "+":
|
||||
$name = substr($name, 1);
|
||||
$pattern = '.*';
|
||||
$pattern = ".*";
|
||||
break;
|
||||
case '.':
|
||||
case ".":
|
||||
$name = substr($name, 1);
|
||||
$prefix = '\\.';
|
||||
$delimiter = '\\.';
|
||||
$explodeDelimiter = '.';
|
||||
$prefix = "\\.";
|
||||
$delimiter = "\\.";
|
||||
$explodeDelimiter = ".";
|
||||
break;
|
||||
case '/':
|
||||
case "/":
|
||||
$name = substr($name, 1);
|
||||
$prefix = '\\/';
|
||||
$delimiter = '\\/';
|
||||
$prefix = "\\/";
|
||||
$delimiter = "\\/";
|
||||
if ($explosion) {
|
||||
$pattern = '[0-9a-zA-Z\-._\~%,\/]*'; // Unreserved + "," and "/"
|
||||
$explodeDelimiter = '/';
|
||||
$explodeDelimiter = "/";
|
||||
}
|
||||
break;
|
||||
}
|
||||
|
|
@ -165,7 +159,7 @@ class TemplateRoute extends Route
|
|||
$this->explosions[$name] = $explodeDelimiter;
|
||||
}
|
||||
|
||||
$names = explode(',', $name);
|
||||
$names = explode(",", $name);
|
||||
$results = [];
|
||||
foreach ($names as $name) {
|
||||
$results[] = "(?<{$name}>{$pattern})";
|
||||
|
|
|
|||
|
|
@ -6,25 +6,25 @@ use Psr\Http\Message\ResponseInterface;
|
|||
use Psr\Http\Message\ServerRequestInterface;
|
||||
use WellRESTed\Dispatching\Dispatcher;
|
||||
use WellRESTed\Dispatching\DispatcherInterface;
|
||||
use WellRESTed\MiddlewareInterface;
|
||||
use WellRESTed\Routing\Route\Route;
|
||||
use WellRESTed\Routing\Route\RouteFactory;
|
||||
use WellRESTed\Routing\Route\RouteFactoryInterface;
|
||||
use WellRESTed\Routing\Route\RouteInterface;
|
||||
|
||||
class Router implements MiddlewareInterface
|
||||
class Router
|
||||
{
|
||||
/** @var string|null Attribute name for matched path variables */
|
||||
/** @var string attribute name for matched path variables */
|
||||
private $pathVariablesAttributeName;
|
||||
/** @var DispatcherInterface */
|
||||
private $dispatcher;
|
||||
/** @var RouteFactory */
|
||||
/** @var RouteFactoryInterface */
|
||||
private $factory;
|
||||
/** @var Route[] Array of Route objects */
|
||||
/** @var RouteInterface[] Array of Route objects */
|
||||
private $routes;
|
||||
/** @var Route[] Hash array mapping exact paths to routes */
|
||||
/** @var RouteInterface[] Hash array mapping exact paths to routes */
|
||||
private $staticRoutes;
|
||||
/** @var Route[] Hash array mapping path prefixes to routes */
|
||||
/** @var RouteInterface[] Hash array mapping path prefixes to routes */
|
||||
private $prefixRoutes;
|
||||
/** @var Route[] Hash array mapping path prefixes to routes */
|
||||
/** @var RouteInterface[] Hash array mapping path prefixes to routes */
|
||||
private $patternRoutes;
|
||||
/** @var mixed[] List array of middleware */
|
||||
private $stack;
|
||||
|
|
@ -42,24 +42,17 @@ class Router implements MiddlewareInterface
|
|||
* stored with the name. The value will be an array containing all of the
|
||||
* path variables.
|
||||
*
|
||||
* Use Server->createRouter to instantiate a new Router rather than calling
|
||||
* this constructor manually.
|
||||
*
|
||||
* @param DispatcherInterface $dispatcher
|
||||
* Instance to use for dispatching middleware and handlers.
|
||||
* @param string|null $pathVariablesAttributeName
|
||||
* 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(
|
||||
?string $pathVariablesAttributeName = null,
|
||||
?DispatcherInterface $dispatcher = null,
|
||||
?RouteFactory $routeFactory = null
|
||||
) {
|
||||
public function __construct($dispatcher = null, $pathVariablesAttributeName = null)
|
||||
{
|
||||
$this->dispatcher = $dispatcher ?: $this->getDefaultDispatcher();
|
||||
$this->pathVariablesAttributeName = $pathVariablesAttributeName;
|
||||
$this->dispatcher = $dispatcher ?? new Dispatcher();
|
||||
$this->factory = $routeFactory ?? new RouteFactory($this->dispatcher);
|
||||
$this->factory = $this->getRouteFactory($this->dispatcher);
|
||||
$this->routes = [];
|
||||
$this->staticRoutes = [];
|
||||
$this->prefixRoutes = [];
|
||||
|
|
@ -67,32 +60,27 @@ class Router implements MiddlewareInterface
|
|||
$this->stack = [];
|
||||
}
|
||||
|
||||
/**
|
||||
* @param ServerRequestInterface $request
|
||||
* @param ResponseInterface $response
|
||||
* @param callable $next
|
||||
* @return ResponseInterface
|
||||
*/
|
||||
public function __invoke(
|
||||
ServerRequestInterface $request,
|
||||
ResponseInterface $response,
|
||||
$next
|
||||
): ResponseInterface {
|
||||
$path = $this->getPath($request->getRequestTarget());
|
||||
) {
|
||||
// Use only the path for routing.
|
||||
$requestTarget = parse_url($request->getRequestTarget(), PHP_URL_PATH);
|
||||
|
||||
$route = $this->getStaticRoute($path);
|
||||
$route = $this->getStaticRoute($requestTarget);
|
||||
if ($route) {
|
||||
return $this->dispatch($route, $request, $response, $next);
|
||||
}
|
||||
|
||||
$route = $this->getPrefixRoute($path);
|
||||
$route = $this->getPrefixRoute($requestTarget);
|
||||
if ($route) {
|
||||
return $this->dispatch($route, $request, $response, $next);
|
||||
}
|
||||
|
||||
// Try each of the routes.
|
||||
foreach ($this->patternRoutes as $route) {
|
||||
if ($route->matchesRequestTarget($path)) {
|
||||
if ($route->matchesRequestTarget($requestTarget)) {
|
||||
$pathVariables = $route->getPathVariables();
|
||||
if ($this->pathVariablesAttributeName) {
|
||||
$request = $request->withAttribute($this->pathVariablesAttributeName, $pathVariables);
|
||||
|
|
@ -112,30 +100,18 @@ class Router implements MiddlewareInterface
|
|||
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,
|
||||
$route,
|
||||
ServerRequestInterface $request,
|
||||
ResponseInterface $response,
|
||||
callable $next
|
||||
): ResponseInterface {
|
||||
$next
|
||||
) {
|
||||
if (!$this->stack) {
|
||||
return $route($request, $response, $next);
|
||||
}
|
||||
$stack = array_merge($this->stack, [$route]);
|
||||
return $this->dispatcher->dispatch(
|
||||
$stack,
|
||||
$request,
|
||||
$response,
|
||||
$next
|
||||
$stack, $request, $response, $next
|
||||
);
|
||||
}
|
||||
|
||||
|
|
@ -169,12 +145,12 @@ class Router implements MiddlewareInterface
|
|||
* - 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 string $method HTTP method(s) to match
|
||||
* @param mixed $dispatchable Handler or middleware to dispatch
|
||||
* @return static
|
||||
*/
|
||||
public function register(string $method, string $target, $dispatchable): Router
|
||||
public function register($method, $target, $dispatchable)
|
||||
{
|
||||
$route = $this->getRouteForTarget($target);
|
||||
$route->register($method, $dispatchable);
|
||||
|
|
@ -198,7 +174,7 @@ class Router implements MiddlewareInterface
|
|||
* @param mixed $middleware Middleware to dispatch in sequence
|
||||
* @return static
|
||||
*/
|
||||
public function add($middleware): Router
|
||||
public function add($middleware)
|
||||
{
|
||||
$this->stack[] = $middleware;
|
||||
return $this;
|
||||
|
|
@ -210,13 +186,38 @@ class Router implements MiddlewareInterface
|
|||
*
|
||||
* @return static
|
||||
*/
|
||||
public function continueOnNotFound(): Router
|
||||
public function continueOnNotFound()
|
||||
{
|
||||
$this->continueOnNotFound = true;
|
||||
return $this;
|
||||
}
|
||||
|
||||
private function getRouteForTarget(string $target): Route
|
||||
/**
|
||||
* Return an instance to dispatch middleware.
|
||||
*
|
||||
* @return DispatcherInterface
|
||||
*/
|
||||
protected function getDefaultDispatcher()
|
||||
{
|
||||
return new Dispatcher();
|
||||
}
|
||||
|
||||
/**
|
||||
* @param DispatcherInterface
|
||||
* @return RouteFactoryInterface
|
||||
*/
|
||||
protected function getRouteFactory($dispatcher)
|
||||
{
|
||||
return new RouteFactory($dispatcher);
|
||||
}
|
||||
|
||||
/**
|
||||
* Return the route for a given target.
|
||||
*
|
||||
* @param $target
|
||||
* @return RouteInterface
|
||||
*/
|
||||
private function getRouteForTarget($target)
|
||||
{
|
||||
if (isset($this->routes[$target])) {
|
||||
$route = $this->routes[$target];
|
||||
|
|
@ -227,26 +228,26 @@ class Router implements MiddlewareInterface
|
|||
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.
|
||||
$this->routes[$target] = $route;
|
||||
|
||||
// Store the route to the array of routes for its type.
|
||||
switch ($route->getType()) {
|
||||
case Route::TYPE_STATIC:
|
||||
case RouteInterface::TYPE_STATIC:
|
||||
$this->staticRoutes[$route->getTarget()] = $route;
|
||||
break;
|
||||
case Route::TYPE_PREFIX:
|
||||
$this->prefixRoutes[rtrim($route->getTarget(), '*')] = $route;
|
||||
case RouteInterface::TYPE_PREFIX:
|
||||
$this->prefixRoutes[rtrim($route->getTarget(), "*")] = $route;
|
||||
break;
|
||||
case Route::TYPE_PATTERN:
|
||||
case RouteInterface::TYPE_PATTERN:
|
||||
$this->patternRoutes[] = $route;
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
private function getStaticRoute(string $requestTarget): ?Route
|
||||
private function getStaticRoute($requestTarget)
|
||||
{
|
||||
if (isset($this->staticRoutes[$requestTarget])) {
|
||||
return $this->staticRoutes[$requestTarget];
|
||||
|
|
@ -254,7 +255,7 @@ class Router implements MiddlewareInterface
|
|||
return null;
|
||||
}
|
||||
|
||||
private function getPrefixRoute(string $requestTarget): ?Route
|
||||
private function getPrefixRoute($requestTarget)
|
||||
{
|
||||
// Find all prefixes that match the start of this path.
|
||||
$prefixes = array_keys($this->prefixRoutes);
|
||||
|
|
@ -265,26 +266,26 @@ class Router implements MiddlewareInterface
|
|||
}
|
||||
);
|
||||
|
||||
if (!$matches) {
|
||||
return null;
|
||||
if ($matches) {
|
||||
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);
|
||||
}
|
||||
/** @var string $bestMatch */
|
||||
$bestMatch = $matches[0];
|
||||
$route = $this->prefixRoutes[$bestMatch];
|
||||
return $route;
|
||||
}
|
||||
|
||||
// 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];
|
||||
return null;
|
||||
}
|
||||
|
||||
private function startsWith(string $haystack, string $needle): bool
|
||||
private function startsWith($haystack, $needle)
|
||||
{
|
||||
$length = strlen($needle);
|
||||
return substr($haystack, 0, $length) === $needle;
|
||||
return (substr($haystack, 0, $length) === $needle);
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -7,21 +7,21 @@ use Psr\Http\Message\ServerRequestInterface;
|
|||
use WellRESTed\Dispatching\Dispatcher;
|
||||
use WellRESTed\Dispatching\DispatcherInterface;
|
||||
use WellRESTed\Message\Response;
|
||||
use WellRESTed\Message\ServerRequestMarshaller;
|
||||
use WellRESTed\Message\ServerRequest;
|
||||
use WellRESTed\Routing\Router;
|
||||
use WellRESTed\Transmission\Transmitter;
|
||||
use WellRESTed\Transmission\TransmitterInterface;
|
||||
|
||||
class Server
|
||||
{
|
||||
/** @var mixed[] */
|
||||
private $attributes = [];
|
||||
/** @var array */
|
||||
protected $attributes;
|
||||
/** @var DispatcherInterface */
|
||||
private $dispatcher;
|
||||
/** @var string|null attribute name for matched path variables */
|
||||
private $pathVariablesAttributeName = null;
|
||||
/** @var ServerRequestInterface|null */
|
||||
private $request = null;
|
||||
/** @var string ServerRequestInterface attribute name for matched path variables */
|
||||
private $pathVariablesAttributeName;
|
||||
/** @var ServerRequestInterface */
|
||||
private $request;
|
||||
/** @var ResponseInterface */
|
||||
private $response;
|
||||
/** @var TransmitterInterface */
|
||||
|
|
@ -29,12 +29,8 @@ class Server
|
|||
/** @var mixed[] List array of middleware */
|
||||
private $stack;
|
||||
|
||||
public function __construct()
|
||||
{
|
||||
public function __construct() {
|
||||
$this->stack = [];
|
||||
$this->response = new Response();
|
||||
$this->dispatcher = new Dispatcher();
|
||||
$this->transmitter = new Transmitter();
|
||||
}
|
||||
|
||||
/**
|
||||
|
|
@ -43,22 +39,22 @@ class Server
|
|||
* @param mixed $middleware Middleware to dispatch in sequence
|
||||
* @return Server
|
||||
*/
|
||||
public function add($middleware): Server
|
||||
public function add($middleware)
|
||||
{
|
||||
$this->stack[] = $middleware;
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Return a new Router that uses the server's configuration.
|
||||
* Return a new Router that uses the server's dispatcher.
|
||||
*
|
||||
* @return Router
|
||||
*/
|
||||
public function createRouter(): Router
|
||||
public function createRouter()
|
||||
{
|
||||
return new Router(
|
||||
$this->pathVariablesAttributeName,
|
||||
$this->dispatcher
|
||||
$this->getDispatcher(),
|
||||
$this->pathVariablesAttributeName
|
||||
);
|
||||
}
|
||||
|
||||
|
|
@ -68,30 +64,25 @@ class Server
|
|||
* This method reads a server request, dispatches the request through the
|
||||
* server's stack of middleware, and outputs the response via a Transmitter.
|
||||
*/
|
||||
public function respond(): void
|
||||
public function respond()
|
||||
{
|
||||
$request = $this->getRequest();
|
||||
foreach ($this->attributes as $name => $value) {
|
||||
foreach ($this->getAttributes() as $name => $value) {
|
||||
$request = $request->withAttribute($name, $value);
|
||||
}
|
||||
|
||||
$next = function (
|
||||
ServerRequestInterface $rqst,
|
||||
ResponseInterface $resp
|
||||
): ResponseInterface {
|
||||
$response = $this->getResponse();
|
||||
|
||||
$next = function ($rqst, $resp) {
|
||||
return $resp;
|
||||
};
|
||||
|
||||
$response = $this->response;
|
||||
$dispatcher = $this->getDispatcher();
|
||||
$response = $dispatcher->dispatch(
|
||||
$this->stack, $request, $response, $next);
|
||||
|
||||
$response = $this->dispatcher->dispatch(
|
||||
$this->stack,
|
||||
$request,
|
||||
$response,
|
||||
$next
|
||||
);
|
||||
|
||||
$this->transmitter->transmit($request, $response);
|
||||
$transmitter = $this->getTransmitter();
|
||||
$transmitter->transmit($request, $response);
|
||||
}
|
||||
|
||||
// -------------------------------------------------------------------------
|
||||
|
|
@ -121,8 +112,7 @@ class Server
|
|||
* @param string $name
|
||||
* @return Server
|
||||
*/
|
||||
public function setPathVariablesAttributeName(string $name): Server
|
||||
{
|
||||
public function setPathVariablesAttributeName(string $name): Server {
|
||||
$this->pathVariablesAttributeName = $name;
|
||||
return $this;
|
||||
}
|
||||
|
|
@ -160,12 +150,43 @@ class Server
|
|||
// -------------------------------------------------------------------------
|
||||
/* Defaults */
|
||||
|
||||
private function getRequest(): ServerRequestInterface
|
||||
private function getAttributes()
|
||||
{
|
||||
if (!$this->attributes) {
|
||||
$this->attributes = [];
|
||||
}
|
||||
return $this->attributes;
|
||||
}
|
||||
|
||||
private function getDispatcher()
|
||||
{
|
||||
if (!$this->dispatcher) {
|
||||
$this->dispatcher = new Dispatcher();
|
||||
}
|
||||
return $this->dispatcher;
|
||||
}
|
||||
|
||||
private function getRequest()
|
||||
{
|
||||
if (!$this->request) {
|
||||
$marshaller = new ServerRequestMarshaller();
|
||||
return $marshaller->getServerRequest();
|
||||
$this->request = ServerRequest::getServerRequest();
|
||||
}
|
||||
return $this->request;
|
||||
}
|
||||
|
||||
private function getResponse()
|
||||
{
|
||||
if (!$this->response) {
|
||||
$this->response = new Response();
|
||||
}
|
||||
return $this->response;
|
||||
}
|
||||
|
||||
private function getTransmitter()
|
||||
{
|
||||
if (!$this->transmitter) {
|
||||
$this->transmitter = new Transmitter();
|
||||
}
|
||||
return $this->transmitter;
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -27,7 +27,7 @@ class Transmitter implements TransmitterInterface
|
|||
public function transmit(
|
||||
ServerRequestInterface $request,
|
||||
ResponseInterface $response
|
||||
): void {
|
||||
) {
|
||||
// Prepare the response for output.
|
||||
$response = $this->prepareResponse($request, $response);
|
||||
|
||||
|
|
@ -48,35 +48,36 @@ class Transmitter implements TransmitterInterface
|
|||
}
|
||||
}
|
||||
|
||||
public function setChunkSize(int $chunkSize): void
|
||||
/**
|
||||
* @param int $chunkSize
|
||||
*/
|
||||
public function setChunkSize($chunkSize)
|
||||
{
|
||||
$this->chunkSize = $chunkSize;
|
||||
}
|
||||
|
||||
private function prepareResponse(
|
||||
protected function prepareResponse(
|
||||
ServerRequestInterface $request,
|
||||
ResponseInterface $response
|
||||
): ResponseInterface {
|
||||
|
||||
// Add Content-length header to the response when all of these are true:
|
||||
) {
|
||||
// Add a 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 Transfer-encoding: chunked header
|
||||
// - Response body stream is readable and reports a non-null size
|
||||
//
|
||||
$contentLengthMissing = !$response->hasHeader('Content-length');
|
||||
$notChunked = strtolower($response->getHeaderLine('Transfer-encoding'))
|
||||
!== 'chunked';
|
||||
$size = $response->getBody()->getSize();
|
||||
|
||||
if ($contentLengthMissing && $notChunked && $size !== null) {
|
||||
$response = $response->withHeader('Content-length', (string) $size);
|
||||
if (!$response->hasHeader("Content-length")
|
||||
&& !(strtolower($response->getHeaderLine("Transfer-encoding")) === "chunked")
|
||||
) {
|
||||
$size = $response->getBody()->getSize();
|
||||
if ($size !== null) {
|
||||
$response = $response->withHeader("Content-length", (string) $size);
|
||||
}
|
||||
}
|
||||
|
||||
return $response;
|
||||
}
|
||||
|
||||
private function getStatusLine(ResponseInterface $response): string
|
||||
private function getStatusLine(ResponseInterface $response)
|
||||
{
|
||||
$protocol = $response->getProtocolVersion();
|
||||
$statusCode = $response->getStatusCode();
|
||||
|
|
@ -88,7 +89,7 @@ class Transmitter implements TransmitterInterface
|
|||
}
|
||||
}
|
||||
|
||||
private function outputBody(StreamInterface $body): void
|
||||
private function outputBody(StreamInterface $body)
|
||||
{
|
||||
if ($this->chunkSize > 0) {
|
||||
if ($body->isSeekable()) {
|
||||
|
|
|
|||
|
|
@ -18,5 +18,5 @@ interface TransmitterInterface
|
|||
* @param ServerRequestInterface $request
|
||||
* @param ResponseInterface $response Response to output
|
||||
*/
|
||||
public function transmit(ServerRequestInterface $request, ResponseInterface $response): void;
|
||||
public function transmit(ServerRequestInterface $request, ResponseInterface $response);
|
||||
}
|
||||
|
|
|
|||
|
|
@ -0,0 +1,6 @@
|
|||
<?php
|
||||
|
||||
error_reporting(E_ALL);
|
||||
|
||||
$loader = require __DIR__ . '/../vendor/autoload.php';
|
||||
$loader->addPsr4('WellRESTed\\Test\\', __DIR__ . '/src');
|
||||
|
|
@ -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);
|
||||
}
|
||||
|
|
@ -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;
|
||||
}
|
||||
|
|
@ -1,6 +1,6 @@
|
|||
<?php
|
||||
|
||||
namespace WellRESTed\Routing;
|
||||
namespace WellRESTed\Test\Integration;
|
||||
|
||||
use Psr\Http\Message\ResponseInterface;
|
||||
use Psr\Http\Message\ServerRequestInterface;
|
||||
|
|
@ -13,10 +13,7 @@ use WellRESTed\Server;
|
|||
use WellRESTed\Test\TestCase;
|
||||
use WellRESTed\Transmission\TransmitterInterface;
|
||||
|
||||
/**
|
||||
* Integration test for Routing components
|
||||
* @coversNothing
|
||||
*/
|
||||
/** @coversNothing */
|
||||
class RoutingTest extends TestCase
|
||||
{
|
||||
/** @var Server */
|
||||
|
|
@ -28,7 +25,7 @@ class RoutingTest extends TestCase
|
|||
/** @var ResponseInterface */
|
||||
private $response;
|
||||
|
||||
protected function setUp(): void
|
||||
public function setUp(): void
|
||||
{
|
||||
parent::setUp();
|
||||
|
||||
|
|
@ -111,9 +108,7 @@ class RoutingTest extends TestCase
|
|||
->register('GET', '/oscar', new StringHandler('Oscar'));
|
||||
|
||||
$this->server->add(new HeaderAdderMiddleware(
|
||||
'Content-type',
|
||||
'application/cat'
|
||||
));
|
||||
'Content-type', 'application/cat'));
|
||||
$this->server->add($router);
|
||||
|
||||
$this->request = $this->request
|
||||
|
|
@ -123,19 +118,15 @@ class RoutingTest extends TestCase
|
|||
$response = $this->respond();
|
||||
|
||||
$this->assertEquals('Molly', (string) $response->getBody());
|
||||
$this->assertEquals(
|
||||
'application/cat',
|
||||
$response->getHeaderLine('Content-type')
|
||||
);
|
||||
$this->assertEquals('application/cat',
|
||||
$response->getHeaderLine('Content-type'));
|
||||
}
|
||||
|
||||
public function testDispatchesMiddlewareSpecificToRouter()
|
||||
{
|
||||
$catRouter = $this->server->createRouter()
|
||||
->add(new HeaderAdderMiddleware(
|
||||
'Content-type',
|
||||
'application/cat'
|
||||
))
|
||||
'Content-type', 'application/cat'))
|
||||
->register('GET', '/molly', new StringHandler('Molly'))
|
||||
->register('GET', '/oscar', new StringHandler('Oscar'))
|
||||
->continueOnNotFound();
|
||||
|
|
@ -143,9 +134,7 @@ class RoutingTest extends TestCase
|
|||
|
||||
$dogRouter = $this->server->createRouter()
|
||||
->add(new HeaderAdderMiddleware(
|
||||
'Content-type',
|
||||
'application/dog'
|
||||
))
|
||||
'Content-type', 'application/dog'))
|
||||
->register('GET', '/bear', new StringHandler('Bear'));
|
||||
$this->server->add($dogRouter);
|
||||
|
||||
|
|
@ -156,19 +145,15 @@ class RoutingTest extends TestCase
|
|||
$response = $this->respond();
|
||||
|
||||
$this->assertEquals('Bear', (string) $response->getBody());
|
||||
$this->assertEquals(
|
||||
'application/dog',
|
||||
$response->getHeaderLine('Content-type')
|
||||
);
|
||||
$this->assertEquals('application/dog',
|
||||
$response->getHeaderLine('Content-type'));
|
||||
}
|
||||
|
||||
public function testResponds404WhenNoRouteMatched()
|
||||
{
|
||||
$catRouter = $this->server->createRouter()
|
||||
->add(new HeaderAdderMiddleware(
|
||||
'Content-type',
|
||||
'application/cat'
|
||||
))
|
||||
'Content-type', 'application/cat'))
|
||||
->register('GET', '/molly', new StringHandler('Molly'))
|
||||
->register('GET', '/oscar', new StringHandler('Oscar'))
|
||||
->continueOnNotFound();
|
||||
|
|
@ -176,9 +161,7 @@ class RoutingTest extends TestCase
|
|||
|
||||
$dogRouter = $this->server->createRouter()
|
||||
->add(new HeaderAdderMiddleware(
|
||||
'Content-type',
|
||||
'application/dog'
|
||||
))
|
||||
'Content-type', 'application/dog'))
|
||||
->register('GET', '/bear', new StringHandler('Bear'));
|
||||
$this->server->add($dogRouter);
|
||||
|
||||
|
|
@ -202,7 +185,7 @@ class TransmitterMock implements TransmitterInterface
|
|||
public function transmit(
|
||||
ServerRequestInterface $request,
|
||||
ResponseInterface $response
|
||||
): void {
|
||||
) {
|
||||
$this->response = $response;
|
||||
}
|
||||
}
|
||||
|
|
@ -1,7 +1,9 @@
|
|||
<?php
|
||||
|
||||
namespace WellRESTed\Dispatching;
|
||||
namespace WellRESTed\Test\Unit\Dispatching;
|
||||
|
||||
use WellRESTed\Dispatching\Dispatcher;
|
||||
use WellRESTed\Dispatching\DispatchStack;
|
||||
use WellRESTed\Message\Response;
|
||||
use WellRESTed\Message\ServerRequest;
|
||||
use WellRESTed\Test\Doubles\NextMock;
|
||||
|
|
@ -13,7 +15,7 @@ class DispatchStackTest extends TestCase
|
|||
private $response;
|
||||
private $next;
|
||||
|
||||
protected function setUp(): void
|
||||
public function setUp(): void
|
||||
{
|
||||
parent::setUp();
|
||||
$this->request = new ServerRequest();
|
||||
|
|
@ -21,35 +23,35 @@ class DispatchStackTest extends TestCase
|
|||
$this->next = new NextMock();
|
||||
}
|
||||
|
||||
public function testDispatchesMiddlewareInOrderAdded(): void
|
||||
public function testDispatchesMiddlewareInOrderAdded()
|
||||
{
|
||||
// Each middleware will add its "name" to this array.
|
||||
$callOrder = [];
|
||||
$stack = new DispatchStack(new Dispatcher());
|
||||
$stack->add(function ($request, $response, $next) use (&$callOrder) {
|
||||
$callOrder[] = 'first';
|
||||
$callOrder[] = "first";
|
||||
return $next($request, $response);
|
||||
});
|
||||
$stack->add(function ($request, $response, $next) use (&$callOrder) {
|
||||
$callOrder[] = 'second';
|
||||
$callOrder[] = "second";
|
||||
return $next($request, $response);
|
||||
});
|
||||
$stack->add(function ($request, $response, $next) use (&$callOrder) {
|
||||
$callOrder[] = 'third';
|
||||
$callOrder[] = "third";
|
||||
return $next($request, $response);
|
||||
});
|
||||
$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($this->request, $this->response, $this->next);
|
||||
$this->assertTrue($this->next->called);
|
||||
}
|
||||
|
||||
public function testCallsNextAfterDispatchingStack(): void
|
||||
public function testCallsNextAfterDispatchingStack()
|
||||
{
|
||||
$middleware = function ($request, $response, $next) use (&$callOrder) {
|
||||
return $next($request, $response);
|
||||
|
|
@ -64,7 +66,7 @@ class DispatchStackTest extends TestCase
|
|||
$this->assertTrue($this->next->called);
|
||||
}
|
||||
|
||||
public function testDoesNotCallNextWhenStackStopsEarly(): void
|
||||
public function testDoesNotCallNextWhenStackStopsEarly()
|
||||
{
|
||||
$middlewareGo = function ($request, $response, $next) use (&$callOrder) {
|
||||
return $next($request, $response);
|
||||
|
|
@ -1,10 +1,12 @@
|
|||
<?php
|
||||
|
||||
namespace WellRESTed\Dispatching;
|
||||
namespace WellRESTed\Test\Unit\Dispatching;
|
||||
|
||||
use Psr\Http\Message\ResponseInterface;
|
||||
use Psr\Http\Message\ServerRequestInterface;
|
||||
use Psr\Http\Server\RequestHandlerInterface;
|
||||
use WellRESTed\Dispatching\Dispatcher;
|
||||
use WellRESTed\Dispatching\DispatchException;
|
||||
use WellRESTed\Message\Response;
|
||||
use WellRESTed\Message\ServerRequest;
|
||||
use WellRESTed\MiddlewareInterface;
|
||||
|
|
@ -22,7 +24,7 @@ class DispatcherTest extends TestCase
|
|||
/** @var ResponseInterface */
|
||||
private $stubResponse;
|
||||
|
||||
protected function setUp(): void
|
||||
public function setUp(): void
|
||||
{
|
||||
$this->request = new ServerRequest();
|
||||
$this->response = new Response();
|
||||
|
|
@ -33,8 +35,6 @@ class DispatcherTest extends TestCase
|
|||
/**
|
||||
* 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
|
||||
{
|
||||
|
|
@ -50,14 +50,14 @@ class DispatcherTest extends TestCase
|
|||
// -------------------------------------------------------------------------
|
||||
// PSR-15 Handler
|
||||
|
||||
public function testDispatchesPsr15Handler(): void
|
||||
public function testDispatchesPsr15Handler()
|
||||
{
|
||||
$handler = new HandlerDouble($this->stubResponse);
|
||||
$response = $this->dispatch($handler);
|
||||
$this->assertSame($this->stubResponse, $response);
|
||||
}
|
||||
|
||||
public function testDispatchesPsr15HandlerFromFactory(): void
|
||||
public function testDispatchesPsr15HandlerFromFactory()
|
||||
{
|
||||
$factory = function () {
|
||||
return new HandlerDouble($this->stubResponse);
|
||||
|
|
@ -70,8 +70,7 @@ class DispatcherTest extends TestCase
|
|||
// -------------------------------------------------------------------------
|
||||
// PSR-15 Middleware
|
||||
|
||||
public function testDispatchesPsr15MiddlewareWithDelegate(): void
|
||||
{
|
||||
public function testDispatchesPsr15MiddlewareWithDelegate() {
|
||||
$this->next->upstreamResponse = $this->stubResponse;
|
||||
$middleware = new MiddlewareDouble();
|
||||
|
||||
|
|
@ -79,8 +78,7 @@ class DispatcherTest extends TestCase
|
|||
$this->assertSame($this->stubResponse, $response);
|
||||
}
|
||||
|
||||
public function testDispatchesPsr15MiddlewareFromFactoryWithDelegate(): void
|
||||
{
|
||||
public function testDispatchesPsr15MiddlewareFromFactoryWithDelegate() {
|
||||
$this->next->upstreamResponse = $this->stubResponse;
|
||||
$factory = function () {
|
||||
return new MiddlewareDouble();
|
||||
|
|
@ -93,7 +91,7 @@ class DispatcherTest extends TestCase
|
|||
// -------------------------------------------------------------------------
|
||||
// Double-Pass Middleware Callable
|
||||
|
||||
public function testDispatchesDoublePassMiddlewareCallable(): void
|
||||
public function testDispatchesDoublePassMiddlewareCallable()
|
||||
{
|
||||
$doublePass = function ($request, $response, $next) {
|
||||
return $next($request, $this->stubResponse);
|
||||
|
|
@ -103,7 +101,7 @@ class DispatcherTest extends TestCase
|
|||
$this->assertSame($this->stubResponse, $response);
|
||||
}
|
||||
|
||||
public function testDispatchesDoublePassMiddlewareCallableFromFactory(): void
|
||||
public function testDispatchesDoublePassMiddlewareCallableFromFactory()
|
||||
{
|
||||
$factory = function () {
|
||||
return function ($request, $response, $next) {
|
||||
|
|
@ -118,14 +116,14 @@ class DispatcherTest extends TestCase
|
|||
// -------------------------------------------------------------------------
|
||||
// Double-Pass Middleware Instance
|
||||
|
||||
public function testDispatchesDoublePassMiddlewareInstance(): void
|
||||
public function testDispatchesDoublePassMiddlewareInstance()
|
||||
{
|
||||
$doublePass = new DoublePassMiddlewareDouble();
|
||||
$response = $this->dispatch($doublePass);
|
||||
$this->assertEquals(200, $response->getStatusCode());
|
||||
}
|
||||
|
||||
public function testDispatchesDoublePassMiddlewareInstanceFromFactory(): void
|
||||
public function testDispatchesDoublePassMiddlewareInstanceFromFactory()
|
||||
{
|
||||
$factory = function () {
|
||||
return new DoublePassMiddlewareDouble();
|
||||
|
|
@ -137,7 +135,7 @@ class DispatcherTest extends TestCase
|
|||
// -------------------------------------------------------------------------
|
||||
// String
|
||||
|
||||
public function testDispatchesInstanceFromStringName(): void
|
||||
public function testDispatchesInstanceFromStringName()
|
||||
{
|
||||
$response = $this->dispatch(DoublePassMiddlewareDouble::class);
|
||||
$this->assertEquals(200, $response->getStatusCode());
|
||||
|
|
@ -146,14 +144,14 @@ class DispatcherTest extends TestCase
|
|||
// -------------------------------------------------------------------------
|
||||
// Arrays
|
||||
|
||||
public function testDispatchesArrayAsDispatchStack(): void
|
||||
public function testDispatchesArrayAsDispatchStack()
|
||||
{
|
||||
$doublePass = new DoublePassMiddlewareDouble();
|
||||
$response = $this->dispatch([$doublePass]);
|
||||
$this->assertEquals(200, $response->getStatusCode());
|
||||
}
|
||||
|
||||
public function testThrowsExceptionWhenUnableToDispatch(): void
|
||||
public function testThrowsExceptionWhenUnableToDispatch()
|
||||
{
|
||||
$this->expectException(DispatchException::class);
|
||||
$this->dispatch(null);
|
||||
|
|
@ -190,7 +188,6 @@ class HandlerDouble implements RequestHandlerInterface
|
|||
{
|
||||
/** @var ResponseInterface */
|
||||
private $response;
|
||||
|
||||
public function __construct(ResponseInterface $response)
|
||||
{
|
||||
$this->response = $response;
|
||||
|
|
@ -0,0 +1,105 @@
|
|||
<?php
|
||||
|
||||
namespace WellRESTed\Test\Unit\Message;
|
||||
|
||||
use WellRESTed\Message\HeaderCollection;
|
||||
use WellRESTed\Test\TestCase;
|
||||
|
||||
class HeaderCollectionTest extends 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);
|
||||
}
|
||||
}
|
||||
|
|
@ -1,34 +1,38 @@
|
|||
<?php
|
||||
|
||||
namespace WellRESTed\Message;
|
||||
namespace WellRESTed\Test\Unit\Message;
|
||||
|
||||
use InvalidArgumentException;
|
||||
use WellRESTed\Message\Message;
|
||||
use WellRESTed\Message\Response;
|
||||
use WellRESTed\Message\Stream;
|
||||
use WellRESTed\Test\TestCase;
|
||||
|
||||
class MessageTest extends TestCase
|
||||
{
|
||||
public function testSetsHeadersWithStringValueOnConstruction(): void
|
||||
/** @var Message */
|
||||
private $message;
|
||||
|
||||
public function setUp(): void
|
||||
{
|
||||
$headers = ['X-foo' => 'bar'];
|
||||
$message = new Response(200, $headers);
|
||||
$this->assertEquals(['bar'], $message->getHeader('X-foo'));
|
||||
$this->message = new Response();
|
||||
}
|
||||
|
||||
public function testSetsHeadersWithArrayValueOnConstruction(): void
|
||||
public function testSetsHeadersOnConstruction()
|
||||
{
|
||||
$headers = ['X-foo' => ['bar', 'baz']];
|
||||
$message = new Response(200, $headers);
|
||||
$this->assertEquals(['bar', 'baz'], $message->getHeader('X-foo'));
|
||||
}
|
||||
|
||||
public function testSetsBodyOnConstruction(): void
|
||||
public function testSetsBodyOnConstruction()
|
||||
{
|
||||
$body = new Stream('Hello, world');
|
||||
$message = new Response(200, [], $body);
|
||||
$this->assertSame($body, $message->getBody());
|
||||
}
|
||||
|
||||
public function testCloneMakesDeepCopyOfHeaders(): void
|
||||
public function testCloneMakesDeepCopyOfHeaders()
|
||||
{
|
||||
$message1 = (new Response())
|
||||
->withHeader('Content-type', 'text/plain');
|
||||
|
|
@ -37,42 +41,37 @@ class MessageTest extends TestCase
|
|||
|
||||
$this->assertNotEquals(
|
||||
$message1->getHeader('Content-type'),
|
||||
$message2->getHeader('Content-type')
|
||||
);
|
||||
$message2->getHeader('Content-type'));
|
||||
}
|
||||
|
||||
// -------------------------------------------------------------------------
|
||||
// ------------------------------------------------------------------------
|
||||
// Protocol Version
|
||||
|
||||
public function testGetProtocolVersionReturnsProtocolVersion1Point1ByDefault(): void
|
||||
public function testGetProtocolVersionReturnsProtocolVersion1Point1ByDefault()
|
||||
{
|
||||
$message = new Response();
|
||||
$this->assertEquals('1.1', $message->getProtocolVersion());
|
||||
}
|
||||
|
||||
public function testGetProtocolVersionReturnsProtocolVersion(): void
|
||||
public function testGetProtocolVersionReturnsProtocolVersion()
|
||||
{
|
||||
$message = (new Response())
|
||||
->withProtocolVersion('1.0');
|
||||
$this->assertEquals('1.0', $message->getProtocolVersion());
|
||||
}
|
||||
|
||||
public function testGetProtocolVersionReplacesProtocolVersion(): void
|
||||
public function testGetProtocolVersionReplacesProtocolVersion()
|
||||
{
|
||||
$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
|
||||
/** @dataProvider validHeaderValueProvider */
|
||||
public function testWithHeaderReplacesHeader($expected, $value)
|
||||
{
|
||||
$message = (new Response())
|
||||
->withHeader('X-foo', 'Original value')
|
||||
|
|
@ -80,7 +79,7 @@ class MessageTest extends TestCase
|
|||
$this->assertEquals($expected, $message->getHeader('X-foo'));
|
||||
}
|
||||
|
||||
public function validHeaderValueProvider(): array
|
||||
public function validHeaderValueProvider()
|
||||
{
|
||||
return [
|
||||
[['0'], 0],
|
||||
|
|
@ -90,17 +89,15 @@ class MessageTest extends TestCase
|
|||
|
||||
/**
|
||||
* @dataProvider invalidHeaderProvider
|
||||
* @param mixed $name
|
||||
* @param mixed $value
|
||||
*/
|
||||
public function testWithHeaderThrowsExceptionWithInvalidArgument($name, $value): void
|
||||
public function testWithHeaderThrowsExceptionWithInvalidArgument($name, $value)
|
||||
{
|
||||
$this->expectException(InvalidArgumentException::class);
|
||||
(new Response())
|
||||
$message = (new Response())
|
||||
->withHeader($name, $value);
|
||||
}
|
||||
|
||||
public function invalidHeaderProvider(): array
|
||||
public function invalidHeaderProvider()
|
||||
{
|
||||
return [
|
||||
[0, 1024],
|
||||
|
|
@ -109,14 +106,14 @@ class MessageTest extends TestCase
|
|||
];
|
||||
}
|
||||
|
||||
public function testWithAddedHeaderSetsHeader(): void
|
||||
public function testWithAddedHeaderSetsHeader()
|
||||
{
|
||||
$message = (new Response())
|
||||
->withAddedHeader('Content-type', 'application/json');
|
||||
$this->assertEquals(['application/json'], $message->getHeader('Content-type'));
|
||||
}
|
||||
|
||||
public function testWithAddedHeaderAppendsValue(): void
|
||||
public function testWithAddedHeaderAppendsValue()
|
||||
{
|
||||
$message = (new Response())
|
||||
->withAddedHeader('Set-Cookie', ['cat=Molly'])
|
||||
|
|
@ -124,11 +121,10 @@ class MessageTest extends TestCase
|
|||
$cookies = $message->getHeader('Set-Cookie');
|
||||
$this->assertTrue(
|
||||
in_array('cat=Molly', $cookies) &&
|
||||
in_array('dog=Bear', $cookies)
|
||||
);
|
||||
in_array('dog=Bear', $cookies));
|
||||
}
|
||||
|
||||
public function testWithoutHeaderRemovesHeader(): void
|
||||
public function testWithoutHeaderRemovesHeader()
|
||||
{
|
||||
$message = (new Response())
|
||||
->withHeader('Content-type', 'application/json')
|
||||
|
|
@ -136,20 +132,20 @@ class MessageTest extends TestCase
|
|||
$this->assertFalse($message->hasHeader('Content-type'));
|
||||
}
|
||||
|
||||
public function testGetHeaderReturnsEmptyArrayForUnsetHeader(): void
|
||||
public function testGetHeaderReturnsEmptyArrayForUnsetHeader()
|
||||
{
|
||||
$message = new Response();
|
||||
$this->assertEquals([], $message->getHeader('X-name'));
|
||||
}
|
||||
|
||||
public function testGetHeaderReturnsSingleHeader(): void
|
||||
public function testGetHeaderReturnsSingleHeader()
|
||||
{
|
||||
$message = (new Response())
|
||||
->withAddedHeader('Content-type', 'application/json');
|
||||
$this->assertEquals(['application/json'], $message->getHeader('Content-type'));
|
||||
}
|
||||
|
||||
public function testGetHeaderReturnsMultipleValuesForHeader(): void
|
||||
public function testGetHeaderReturnsMultipleValuesForHeader()
|
||||
{
|
||||
$message = (new Response())
|
||||
->withAddedHeader('X-name', 'cat=Molly')
|
||||
|
|
@ -157,13 +153,13 @@ class MessageTest extends TestCase
|
|||
$this->assertEquals(['cat=Molly', 'dog=Bear'], $message->getHeader('X-name'));
|
||||
}
|
||||
|
||||
public function testGetHeaderLineReturnsEmptyStringForUnsetHeader(): void
|
||||
public function testGetHeaderLineReturnsEmptyStringForUnsetHeader()
|
||||
{
|
||||
$message = new Response();
|
||||
$this->assertSame('', $message->getHeaderLine('X-not-set'));
|
||||
}
|
||||
|
||||
public function testGetHeaderLineReturnsMultipleHeadersJoinedByCommas(): void
|
||||
public function testGetHeaderLineReturnsMultipleHeadersJoinedByCommas()
|
||||
{
|
||||
$message = (new Response())
|
||||
->withAddedHeader('X-name', 'cat=Molly')
|
||||
|
|
@ -171,20 +167,20 @@ class MessageTest extends TestCase
|
|||
$this->assertEquals('cat=Molly, dog=Bear', $message->getHeaderLine('X-name'));
|
||||
}
|
||||
|
||||
public function testHasHeaderReturnsTrueWhenHeaderIsSet(): void
|
||||
public function testHasHeaderReturnsTrueWhenHeaderIsSet()
|
||||
{
|
||||
$message = (new Response())
|
||||
->withHeader('Content-type', 'application/json');
|
||||
$this->assertTrue($message->hasHeader('Content-type'));
|
||||
}
|
||||
|
||||
public function testHasHeaderReturnsFalseWhenHeaderIsNotSet(): void
|
||||
public function testHasHeaderReturnsFalseWhenHeaderIsNotSet()
|
||||
{
|
||||
$message = new Response();
|
||||
$this->assertFalse($message->hasHeader('Content-type'));
|
||||
}
|
||||
|
||||
public function testGetHeadersReturnOriginalHeaderNamesAsKeys(): void
|
||||
public function testGetHeadersReturnOriginalHeaderNamesAsKeys()
|
||||
{
|
||||
$message = (new Response())
|
||||
->withHeader('Set-Cookie', 'cat=Molly')
|
||||
|
|
@ -203,7 +199,7 @@ class MessageTest extends TestCase
|
|||
$this->assertEquals(0, $countUnmatched);
|
||||
}
|
||||
|
||||
public function testGetHeadersReturnOriginalHeaderNamesAndValues(): void
|
||||
public function testGetHeadersReturnOriginalHeaderNamesAndValues()
|
||||
{
|
||||
$message = (new Response())
|
||||
->withHeader('Set-Cookie', 'cat=Molly')
|
||||
|
|
@ -230,16 +226,16 @@ class MessageTest extends TestCase
|
|||
$this->assertEquals($expected, $headers);
|
||||
}
|
||||
|
||||
// -------------------------------------------------------------------------
|
||||
// ------------------------------------------------------------------------
|
||||
// Body
|
||||
|
||||
public function testGetBodyReturnsEmptyStreamByDefault(): void
|
||||
public function testGetBodyReturnsEmptyStreamByDefault()
|
||||
{
|
||||
$message = new Response();
|
||||
$this->assertEquals('', (string) $message->getBody());
|
||||
}
|
||||
|
||||
public function testGetBodyReturnsAttachedStream(): void
|
||||
public function testGetBodyReturnsAttachedStream()
|
||||
{
|
||||
$stream = new Stream('Hello, world!');
|
||||
|
||||
|
|
@ -1,109 +1,110 @@
|
|||
<?php
|
||||
|
||||
namespace WellRESTed\Message;
|
||||
namespace WellRESTed\Test\Unit\Message;
|
||||
|
||||
use RuntimeException;
|
||||
use WellRESTed\Message\NullStream;
|
||||
use WellRESTed\Test\TestCase;
|
||||
|
||||
class NullStreamTest extends TestCase
|
||||
{
|
||||
public function testCastsToString(): void
|
||||
public function testCastsToString()
|
||||
{
|
||||
$stream = new NullStream();
|
||||
$this->assertEquals('', (string) $stream);
|
||||
$this->assertEquals("", (string) $stream);
|
||||
}
|
||||
|
||||
public function testCloseDoesNothing(): void
|
||||
public function testCloseDoesNothing()
|
||||
{
|
||||
$stream = new NullStream();
|
||||
$stream->close();
|
||||
$this->assertTrue(true); // Asserting no exception occurred.
|
||||
}
|
||||
|
||||
public function testDetachReturnsNull(): void
|
||||
public function testDetachReturnsNull()
|
||||
{
|
||||
$stream = new NullStream();
|
||||
$this->assertNull($stream->detach());
|
||||
}
|
||||
|
||||
public function testSizeReturnsZero(): void
|
||||
public function testSizeReturnsZero()
|
||||
{
|
||||
$stream = new NullStream();
|
||||
$this->assertEquals(0, $stream->getSize());
|
||||
}
|
||||
|
||||
public function testTellReturnsZero(): void
|
||||
public function testTellReturnsZero()
|
||||
{
|
||||
$stream = new NullStream();
|
||||
$this->assertEquals(0, $stream->tell());
|
||||
}
|
||||
|
||||
public function testEofReturnsTrue(): void
|
||||
public function testEofReturnsTrue()
|
||||
{
|
||||
$stream = new NullStream();
|
||||
$this->assertTrue($stream->eof());
|
||||
}
|
||||
|
||||
public function testIsSeekableReturnsFalse(): void
|
||||
public function testIsSeekableReturnsFalse()
|
||||
{
|
||||
$stream = new NullStream();
|
||||
$this->assertFalse($stream->isSeekable());
|
||||
}
|
||||
|
||||
public function testSeekReturnsFalse(): void
|
||||
public function testSeekReturnsFalse()
|
||||
{
|
||||
$this->expectException(RuntimeException::class);
|
||||
$stream = new NullStream();
|
||||
$stream->seek(10);
|
||||
}
|
||||
|
||||
public function testRewindThrowsException(): void
|
||||
public function testRewindThrowsException()
|
||||
{
|
||||
$this->expectException(RuntimeException::class);
|
||||
$stream = new NullStream();
|
||||
$stream->rewind();
|
||||
}
|
||||
|
||||
public function testIsWritableReturnsFalse(): void
|
||||
public function testIsWritableReturnsFalse()
|
||||
{
|
||||
$stream = new NullStream();
|
||||
$this->assertFalse($stream->isWritable());
|
||||
}
|
||||
|
||||
public function testWriteThrowsException(): void
|
||||
public function testWriteThrowsException()
|
||||
{
|
||||
$this->expectException(RuntimeException::class);
|
||||
$stream = new NullStream();
|
||||
$stream->write('');
|
||||
$stream->write("");
|
||||
}
|
||||
|
||||
public function testIsReadableReturnsTrue(): void
|
||||
public function testIsReadableReturnsTrue()
|
||||
{
|
||||
$stream = new NullStream();
|
||||
$this->assertTrue($stream->isReadable());
|
||||
}
|
||||
|
||||
public function testReadReturnsEmptyString(): void
|
||||
public function testReadReturnsEmptyString()
|
||||
{
|
||||
$stream = new NullStream();
|
||||
$this->assertEquals('', $stream->read(100));
|
||||
$this->assertEquals("", $stream->read(100));
|
||||
}
|
||||
|
||||
public function testGetContentsReturnsEmptyString(): void
|
||||
public function testGetContentsReturnsEmptyString()
|
||||
{
|
||||
$stream = new NullStream();
|
||||
$this->assertEquals('', $stream->getContents());
|
||||
$this->assertEquals("", $stream->getContents());
|
||||
}
|
||||
|
||||
public function testGetMetadataReturnsNull(): void
|
||||
public function testGetMetadataReturnsNull()
|
||||
{
|
||||
$stream = new NullStream();
|
||||
$this->assertNull($stream->getMetadata());
|
||||
}
|
||||
|
||||
public function testGetMetadataReturnsNullWithKey(): void
|
||||
public function testGetMetadataReturnsNullWithKey()
|
||||
{
|
||||
$stream = new NullStream();
|
||||
$this->assertNull($stream->getMetadata('size'));
|
||||
$this->assertNull($stream->getMetadata("size"));
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,201 @@
|
|||
<?php
|
||||
|
||||
namespace WellRESTed\Test\Unit\Message;
|
||||
|
||||
use InvalidArgumentException;
|
||||
use WellRESTed\Message\NullStream;
|
||||
use WellRESTed\Message\Request;
|
||||
use WellRESTed\Message\Uri;
|
||||
use WellRESTed\Test\TestCase;
|
||||
|
||||
class RequestTest extends 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
|
||||
*/
|
||||
public function testWithMethodThrowsExceptionOnInvalidMethod($method)
|
||||
{
|
||||
$this->expectException(InvalidArgumentException::class);
|
||||
$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"));
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,109 @@
|
|||
<?php
|
||||
|
||||
namespace WellRESTed\Test\Unit\Message;
|
||||
|
||||
use WellRESTed\Message\NullStream;
|
||||
use WellRESTed\Message\Response;
|
||||
use WellRESTed\Test\TestCase;
|
||||
|
||||
class ResponseTest extends 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"));
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,686 @@
|
|||
<?php
|
||||
|
||||
namespace WellRESTed\Test\Unit\Message;
|
||||
|
||||
use InvalidArgumentException;
|
||||
use WellRESTed\Message\NullStream;
|
||||
use WellRESTed\Message\ServerRequest;
|
||||
use WellRESTed\Message\UploadedFile;
|
||||
use WellRESTed\Message\Uri;
|
||||
use WellRESTed\Test\TestCase;
|
||||
|
||||
class ServerRequestTest extends TestCase
|
||||
{
|
||||
// ------------------------------------------------------------------------
|
||||
// Construction and Marshalling
|
||||
|
||||
/** @backupGlobals enabled */
|
||||
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
|
||||
|
||||
/**
|
||||
* @backupGlobals enabled
|
||||
* @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"]
|
||||
];
|
||||
}
|
||||
|
||||
/**
|
||||
* @backupGlobals enabled
|
||||
* @dataProvider methodProvider
|
||||
*/
|
||||
public function testGetServerRequestReadsMethod($expectedMethod, $serverMethod)
|
||||
{
|
||||
$_SERVER = [
|
||||
"HTTP_HOST" => "localhost",
|
||||
"REQUEST_METHOD" => $serverMethod
|
||||
];
|
||||
$request = ServerRequest::getServerRequest();
|
||||
$this->assertEquals($expectedMethod, $request->getMethod());
|
||||
}
|
||||
|
||||
public function methodProvider()
|
||||
{
|
||||
return [
|
||||
["GET", "GET"],
|
||||
["POST", "POST"],
|
||||
["DELETE", "DELETE"],
|
||||
["PUT", "PUT"],
|
||||
["OPTIONS", "OPTIONS"],
|
||||
["GET", null]
|
||||
];
|
||||
}
|
||||
|
||||
/**
|
||||
* @backupGlobals enabled
|
||||
* @dataProvider requestTargetProvider
|
||||
*/
|
||||
public function testGetServerRequestReadsRequestTargetFromRequest($expectedRequestTarget, $serverRequestUri)
|
||||
{
|
||||
$_SERVER = [
|
||||
"HTTP_HOST" => "localhost",
|
||||
"REQUEST_URI" => $serverRequestUri
|
||||
];
|
||||
$request = ServerRequest::getServerRequest();
|
||||
$this->assertEquals($expectedRequestTarget, $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"));
|
||||
}
|
||||
|
||||
/**
|
||||
* @backupGlobals enabled
|
||||
*/
|
||||
public function testGetServerRequestReadsContentHeaders()
|
||||
{
|
||||
$_SERVER = [
|
||||
"CONTENT_LENGTH" => "1024",
|
||||
"CONTENT_TYPE" => "application/json"
|
||||
];
|
||||
$request = ServerRequest::getServerRequest();
|
||||
$this->assertEquals("1024", $request->getHeaderLine("Content-length"));
|
||||
$this->assertEquals("application/json", $request->getHeaderLine("Content-type"));
|
||||
}
|
||||
|
||||
/**
|
||||
* @backupGlobals enabled
|
||||
*/
|
||||
public function testGetServerRequestDoesNotReadEmptyContentHeaders()
|
||||
{
|
||||
$_SERVER = [
|
||||
"CONTENT_LENGTH" => "",
|
||||
"CONTENT_TYPE" => " "
|
||||
];
|
||||
$request = ServerRequest::getServerRequest();
|
||||
$this->assertFalse($request->hasHeader("Content-length"));
|
||||
$this->assertFalse($request->hasHeader("Content-type"));
|
||||
}
|
||||
|
||||
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());
|
||||
}
|
||||
|
||||
/**
|
||||
* @backupGlobals enabled
|
||||
* @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"]);
|
||||
}
|
||||
|
||||
/**
|
||||
* @backupGlobals enabled
|
||||
* @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"]]
|
||||
];
|
||||
}
|
||||
|
||||
/**
|
||||
* @backupGlobals enabled
|
||||
* @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());
|
||||
}
|
||||
|
||||
/** @backupGlobals enabled */
|
||||
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)
|
||||
]
|
||||
]]]
|
||||
];
|
||||
}
|
||||
|
||||
/**
|
||||
* @dataProvider invalidUploadedFilesProvider
|
||||
*/
|
||||
public function testWithUploadedFilesThrowsExceptionWithInvalidTree($uploadedFiles)
|
||||
{
|
||||
$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()
|
||||
{
|
||||
$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);
|
||||
}
|
||||
|
||||
/**
|
||||
* @dataProvider invalidParsedBodyProvider
|
||||
*/
|
||||
public function testWithParsedBodyThrowsExceptionWithInvalidType($body)
|
||||
{
|
||||
$this->expectException(InvalidArgumentException::class);
|
||||
$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"));
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,232 @@
|
|||
<?php
|
||||
|
||||
namespace WellRESTed\Test\Unit\Message;
|
||||
|
||||
use InvalidArgumentException;
|
||||
use RuntimeException;
|
||||
use WellRESTed\Message\Stream;
|
||||
use WellRESTed\Test\TestCase;
|
||||
|
||||
class StreamTest extends TestCase
|
||||
{
|
||||
private $resource;
|
||||
private $content = "Hello, world!";
|
||||
|
||||
public function setUp(): void
|
||||
{
|
||||
$this->resource = fopen("php://memory", "w+");
|
||||
fwrite($this->resource, $this->content);
|
||||
}
|
||||
|
||||
public function tearDown(): void
|
||||
{
|
||||
if (is_resource($this->resource)) {
|
||||
fclose($this->resource);
|
||||
}
|
||||
}
|
||||
|
||||
public function testCreatesInstanceWithStreamResource()
|
||||
{
|
||||
$stream = new Stream($this->resource);
|
||||
$this->assertNotNull($stream);
|
||||
}
|
||||
|
||||
public function testCreatesInstanceWithString()
|
||||
{
|
||||
$stream = new Stream("Hello, world!");
|
||||
$this->assertNotNull($stream);
|
||||
}
|
||||
|
||||
/**
|
||||
* @dataProvider invalidResourceProvider
|
||||
*/
|
||||
public function testThrowsExceptionWithInvalidResource($resource)
|
||||
{
|
||||
$this->expectException(InvalidArgumentException::class);
|
||||
new Stream($resource);
|
||||
}
|
||||
|
||||
public function invalidResourceProvider()
|
||||
{
|
||||
return [
|
||||
[null],
|
||||
[true],
|
||||
[4],
|
||||
[[]]
|
||||
];
|
||||
}
|
||||
|
||||
public function testCastsToString()
|
||||
{
|
||||
$stream = new 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 Stream($this->resource);
|
||||
$stream->detach();
|
||||
$this->assertNull($stream->detach());
|
||||
}
|
||||
|
||||
public function testReturnsSize()
|
||||
{
|
||||
$stream = new Stream($this->resource);
|
||||
$this->assertEquals(strlen($this->content), $stream->getSize());
|
||||
}
|
||||
|
||||
public function testTellReturnsHandlePosition()
|
||||
{
|
||||
$stream = new 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 Stream($this->resource);
|
||||
$metadata = stream_get_meta_data($this->resource);
|
||||
$seekable = $metadata["seekable"] == 1;
|
||||
$this->assertEquals($seekable, $stream->isSeekable());
|
||||
}
|
||||
|
||||
public function testSeeksToPosition()
|
||||
{
|
||||
$stream = new 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 Stream($this->resource);
|
||||
$stream->write($message);
|
||||
$this->assertEquals($this->content . $message, (string) $stream);
|
||||
}
|
||||
|
||||
public function testThrowsExceptionOnErrorWriting()
|
||||
{
|
||||
$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()
|
||||
{
|
||||
$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()
|
||||
{
|
||||
$stream = new Stream($this->resource);
|
||||
$stream->seek(7);
|
||||
$string = $stream->read(5);
|
||||
$this->assertEquals("world", $string);
|
||||
}
|
||||
|
||||
public function testThrowsExceptionOnErrorReadingToEnd()
|
||||
{
|
||||
$this->expectException(RuntimeException::class);
|
||||
$filename = tempnam(sys_get_temp_dir(), "php");
|
||||
$handle = fopen($filename, "w");
|
||||
$stream = new 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 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, $writable)
|
||||
{
|
||||
$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, $writable)
|
||||
{
|
||||
$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()
|
||||
{
|
||||
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]
|
||||
];
|
||||
}
|
||||
}
|
||||
|
|
@ -1,25 +1,30 @@
|
|||
<?php
|
||||
|
||||
namespace WellRESTed\Message;
|
||||
namespace WellRESTed\Test\Unit\Message;
|
||||
|
||||
use Psr\Http\Message\StreamInterface;
|
||||
use RuntimeException;
|
||||
use WellRESTed\Message\UploadedFile;
|
||||
use WellRESTed\Message\UploadedFileState;
|
||||
use WellRESTed\Test\TestCase;
|
||||
|
||||
// Hides several php core functions for testing.
|
||||
require_once __DIR__ . "/../../../src/UploadedFileState.php";
|
||||
|
||||
class UploadedFileTest extends TestCase
|
||||
{
|
||||
private $tmpName;
|
||||
private $movePath;
|
||||
|
||||
protected function setUp(): void
|
||||
public 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');
|
||||
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
|
||||
public function tearDown(): void
|
||||
{
|
||||
parent::tearDown();
|
||||
if (file_exists($this->tmpName)) {
|
||||
|
|
@ -30,150 +35,123 @@ class UploadedFileTest extends TestCase
|
|||
}
|
||||
}
|
||||
|
||||
// -------------------------------------------------------------------------
|
||||
// ------------------------------------------------------------------------
|
||||
// getStream
|
||||
|
||||
public function testGetStreamReturnsStreamInterface(): void
|
||||
public function testGetStreamReturnsStreamInterface()
|
||||
{
|
||||
$file = new UploadedFile('', '', 0, $this->tmpName, 0);
|
||||
$file = new UploadedFile("", "", 0, "", 0);
|
||||
$this->assertInstanceOf(StreamInterface::class, $file->getStream());
|
||||
}
|
||||
|
||||
public function testGetStreamReturnsStreamWrappingUploadedFile(): void
|
||||
public function testGetStreamReturnsStreamWrappingUploadedFile()
|
||||
{
|
||||
$content = 'Hello, World!';
|
||||
$content = "Hello, World!";
|
||||
file_put_contents($this->tmpName, $content);
|
||||
$file = new UploadedFile('', '', 0, $this->tmpName, '');
|
||||
$file = new UploadedFile("", "", 0, $this->tmpName, "");
|
||||
$stream = $file->getStream();
|
||||
$this->assertEquals($content, (string) $stream);
|
||||
}
|
||||
|
||||
public function testGetStreamThrowsRuntimeExceptionForNoFile(): void
|
||||
public function testGetStreamReturnsEmptyStreamForNoFile()
|
||||
{
|
||||
$file = new UploadedFile('', '', 0, '', 0);
|
||||
$this->expectException(RuntimeException::class);
|
||||
$file->getStream();
|
||||
$file = new UploadedFile("", "", 0, "", 0);
|
||||
$this->assertTrue($file->getStream()->eof());
|
||||
}
|
||||
|
||||
public function testGetStreamThrowsExceptionAfterMoveTo(): void
|
||||
public function testGetStreamThrowsExceptionAfterMoveTo()
|
||||
{
|
||||
$this->expectException(RuntimeException::class);
|
||||
$content = 'Hello, World!';
|
||||
$content = "Hello, World!";
|
||||
file_put_contents($this->tmpName, $content);
|
||||
$file = new UploadedFile('', '', 0, $this->tmpName, '');
|
||||
$file = new UploadedFile("", "", 0, $this->tmpName, "");
|
||||
$file->moveTo($this->movePath);
|
||||
$file->getStream();
|
||||
}
|
||||
|
||||
public function testGetStreamThrowsExceptionForNonUploadedFile(): void
|
||||
public function testGetStreamThrowsExceptionForNonUploadedFile()
|
||||
{
|
||||
$this->expectException(RuntimeException::class);
|
||||
UploadedFileState::$php_sapi_name = 'apache';
|
||||
UploadedFileState::$php_sapi_name = "apache";
|
||||
UploadedFileState::$is_uploaded_file = false;
|
||||
$file = new UploadedFile('', '', 0, $this->tmpName, 0);
|
||||
$file = new UploadedFile("", "", 0, "", 0);
|
||||
$file->getStream();
|
||||
}
|
||||
|
||||
// -------------------------------------------------------------------------
|
||||
// ------------------------------------------------------------------------
|
||||
// moveTo
|
||||
|
||||
public function testMoveToSapiRelocatesUploadedFileToDestinationIfExists(): void
|
||||
public function testMoveToSapiRelocatesUploadedFileToDestinationIfExists()
|
||||
{
|
||||
UploadedFileState::$php_sapi_name = 'fpm-fcgi';
|
||||
UploadedFileState::$php_sapi_name = "fpm-fcgi";
|
||||
|
||||
$content = 'Hello, World!';
|
||||
$content = "Hello, World!";
|
||||
file_put_contents($this->tmpName, $content);
|
||||
$originalMd5 = md5_file($this->tmpName);
|
||||
|
||||
$file = new UploadedFile('', '', 0, $this->tmpName, '');
|
||||
$file = new UploadedFile("", "", 0, $this->tmpName, "");
|
||||
$file->moveTo($this->movePath);
|
||||
|
||||
$this->assertEquals($originalMd5, md5_file($this->movePath));
|
||||
}
|
||||
|
||||
public function testMoveToNonSapiRelocatesUploadedFileToDestinationIfExists(): void
|
||||
public function testMoveToNonSapiRelocatesUploadedFileToDestinationIfExists()
|
||||
{
|
||||
$content = 'Hello, World!';
|
||||
$content = "Hello, World!";
|
||||
file_put_contents($this->tmpName, $content);
|
||||
$originalMd5 = md5_file($this->tmpName);
|
||||
|
||||
$file = new UploadedFile('', '', 0, $this->tmpName, '');
|
||||
$file = new UploadedFile("", "", 0, $this->tmpName, "");
|
||||
$file->moveTo($this->movePath);
|
||||
|
||||
$this->assertEquals($originalMd5, md5_file($this->movePath));
|
||||
}
|
||||
|
||||
public function testMoveToThrowsExceptionOnSubsequentCall(): void
|
||||
public function testMoveToThrowsExceptionOnSubsequentCall()
|
||||
{
|
||||
$this->expectException(RuntimeException::class);
|
||||
|
||||
$content = 'Hello, World!';
|
||||
$content = "Hello, World!";
|
||||
file_put_contents($this->tmpName, $content);
|
||||
|
||||
$file = new UploadedFile('', '', 0, $this->tmpName, '');
|
||||
$file = new UploadedFile("", "", 0, $this->tmpName, "");
|
||||
$file->moveTo($this->movePath);
|
||||
$file->moveTo($this->movePath);
|
||||
}
|
||||
|
||||
// -------------------------------------------------------------------------
|
||||
// ------------------------------------------------------------------------
|
||||
// getSize
|
||||
|
||||
public function testGetSizeReturnsSize(): void
|
||||
public function testGetSizeReturnsSize()
|
||||
{
|
||||
$file = new UploadedFile('', '', 1024, '', 0);
|
||||
$file = new UploadedFile("", "", 1024, "", 0);
|
||||
$this->assertEquals(1024, $file->getSize());
|
||||
}
|
||||
|
||||
// -------------------------------------------------------------------------
|
||||
// ------------------------------------------------------------------------
|
||||
// getError
|
||||
|
||||
public function testGetErrorReturnsError(): void
|
||||
public function testGetErrorReturnsError()
|
||||
{
|
||||
$file = new UploadedFile('', '', 1024, '', UPLOAD_ERR_INI_SIZE);
|
||||
$file = new UploadedFile("", "", 1024, "", UPLOAD_ERR_INI_SIZE);
|
||||
$this->assertEquals(UPLOAD_ERR_INI_SIZE, $file->getError());
|
||||
}
|
||||
|
||||
// -------------------------------------------------------------------------
|
||||
// ------------------------------------------------------------------------
|
||||
// clientFilename
|
||||
|
||||
public function testGetClientFilenameReturnsClientFilename(): void
|
||||
public function testGetClientFilenameReturnsClientFilename()
|
||||
{
|
||||
$file = new UploadedFile('clientFilename', '', 0, '', 0);
|
||||
$this->assertEquals('clientFilename', $file->getClientFilename());
|
||||
$file = new UploadedFile("clientFilename", "", 0, "", 0);
|
||||
$this->assertEquals("clientFilename", $file->getClientFilename());
|
||||
}
|
||||
|
||||
// -------------------------------------------------------------------------
|
||||
// ------------------------------------------------------------------------
|
||||
// clientMediaType
|
||||
|
||||
public function testGetClientMediaTypeReturnsClientMediaType(): void
|
||||
public function testGetClientMediaTypeReturnsClientMediaType()
|
||||
{
|
||||
$file = new UploadedFile('', 'clientMediaType', 0, '', 0);
|
||||
$this->assertEquals('clientMediaType', $file->getClientMediaType());
|
||||
$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;
|
||||
}
|
||||
|
|
@ -0,0 +1,585 @@
|
|||
<?php
|
||||
|
||||
namespace WellRESTed\Test\Unit\Message;
|
||||
|
||||
use InvalidArgumentException;
|
||||
use WellRESTed\Message\Uri;
|
||||
use WellRESTed\Test\TestCase;
|
||||
|
||||
class UriTest extends 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],
|
||||
["", ""]
|
||||
];
|
||||
}
|
||||
|
||||
public function testInvalidSchemeThrowsException()
|
||||
{
|
||||
$this->expectException(InvalidArgumentException::class);
|
||||
$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"]
|
||||
];
|
||||
}
|
||||
|
||||
/**
|
||||
* @dataProvider invalidHostProvider
|
||||
*/
|
||||
public function testInvalidHostThrowsException($host)
|
||||
{
|
||||
$this->expectException(InvalidArgumentException::class);
|
||||
$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]
|
||||
];
|
||||
}
|
||||
|
||||
/**
|
||||
* @dataProvider invalidPortProvider
|
||||
*/
|
||||
public function testInvalidPortThrowsException($port)
|
||||
{
|
||||
$this->expectException(InvalidArgumentException::class);
|
||||
$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());
|
||||
$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=áéíóú"]
|
||||
];
|
||||
}
|
||||
|
||||
/**
|
||||
* @dataProvider invalidPathProvider
|
||||
*/
|
||||
public function testInvalidPathThrowsException($path)
|
||||
{
|
||||
$this->expectException(InvalidArgumentException::class);
|
||||
$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());
|
||||
$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"
|
||||
],
|
||||
[
|
||||
"*",
|
||||
"*"
|
||||
]
|
||||
];
|
||||
}
|
||||
}
|
||||
|
|
@ -1,10 +1,11 @@
|
|||
<?php
|
||||
|
||||
namespace WellRESTed\Routing\Route;
|
||||
namespace WellRESTed\Test\Unit\Routing\Route;
|
||||
|
||||
use WellRESTed\Dispatching\Dispatcher;
|
||||
use WellRESTed\Message\Response;
|
||||
use WellRESTed\Message\ServerRequest;
|
||||
use WellRESTed\Routing\Route\MethodMap;
|
||||
use WellRESTed\Test\Doubles\MiddlewareMock;
|
||||
use WellRESTed\Test\Doubles\NextMock;
|
||||
use WellRESTed\Test\TestCase;
|
||||
|
|
@ -17,7 +18,7 @@ class MethodMapTest extends TestCase
|
|||
private $next;
|
||||
private $middleware;
|
||||
|
||||
protected function setUp(): void
|
||||
public function setUp(): void
|
||||
{
|
||||
$this->request = new ServerRequest();
|
||||
$this->response = new Response();
|
||||
|
|
@ -26,117 +27,112 @@ class MethodMapTest extends TestCase
|
|||
$this->dispatcher = new Dispatcher();
|
||||
}
|
||||
|
||||
private function getMethodMap(): MethodMap
|
||||
{
|
||||
private function getMethodMap() {
|
||||
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->register('GET', $this->middleware);
|
||||
$map->register("GET", $this->middleware);
|
||||
$map($this->request, $this->response, $this->next);
|
||||
|
||||
$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();
|
||||
$middlewareLower = new MiddlewareMock();
|
||||
|
||||
$map = $this->getMethodMap();
|
||||
$map->register('GET', $middlewareUpper);
|
||||
$map->register('get', $middlewareLower);
|
||||
$map->register("GET", $middlewareUpper);
|
||||
$map->register("get", $middlewareLower);
|
||||
$map($this->request, $this->response, $this->next);
|
||||
|
||||
$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->register('*', $this->middleware);
|
||||
$map->register("*", $this->middleware);
|
||||
$map($this->request, $this->response, $this->next);
|
||||
|
||||
$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->register('GET', $this->middleware);
|
||||
$map->register("GET", $this->middleware);
|
||||
$map($this->request, $this->response, $this->next);
|
||||
|
||||
$this->assertTrue($this->middleware->called);
|
||||
}
|
||||
|
||||
public function testRegistersMiddlewareForMultipleMethods(): void
|
||||
public function testRegistersMiddlewareForMultipleMethods()
|
||||
{
|
||||
$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);
|
||||
|
||||
$this->request = $this->request->withMethod('POST');
|
||||
$this->request = $this->request->withMethod("POST");
|
||||
$map($this->request, $this->response, $this->next);
|
||||
|
||||
$this->assertEquals(2, $this->middleware->callCount);
|
||||
}
|
||||
|
||||
public function testSettingNullUnregistersMiddleware(): void
|
||||
public function testSettingNullDeregistersMiddleware()
|
||||
{
|
||||
$this->request = $this->request->withMethod('POST');
|
||||
$this->request = $this->request->withMethod("POST");
|
||||
|
||||
$map = $this->getMethodMap();
|
||||
$map->register('POST', $this->middleware);
|
||||
$map->register('POST', null);
|
||||
$map->register("POST", $this->middleware);
|
||||
$map->register("POST", null);
|
||||
$response = $map($this->request, $this->response, $this->next);
|
||||
|
||||
$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->register('GET', $this->middleware);
|
||||
$map->register("GET", $this->middleware);
|
||||
$response = $map($this->request, $this->response, $this->next);
|
||||
|
||||
$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->register('GET', $this->middleware);
|
||||
$map->register("GET", $this->middleware);
|
||||
$map($this->request, $this->response, $this->next);
|
||||
|
||||
$this->assertFalse($this->next->called);
|
||||
}
|
||||
|
||||
/**
|
||||
* @dataProvider allowedMethodProvider
|
||||
* @param string[] $methodsDeclared
|
||||
* @param string[] $methodsAllowed
|
||||
*/
|
||||
public function testSetsAllowHeaderForOptions(array $methodsDeclared, array $methodsAllowed): void
|
||||
/** @dataProvider allowedMethodProvider */
|
||||
public function testSetsAllowHeaderForOptions($methodsDeclared, $methodsAllowed)
|
||||
{
|
||||
$this->request = $this->request->withMethod('OPTIONS');
|
||||
$this->request = $this->request->withMethod("OPTIONS");
|
||||
|
||||
$map = $this->getMethodMap();
|
||||
foreach ($methodsDeclared as $method) {
|
||||
|
|
@ -144,38 +140,39 @@ class MethodMapTest extends TestCase
|
|||
}
|
||||
$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->register('GET', $this->middleware);
|
||||
$map->register("GET", $this->middleware);
|
||||
$response = $map($this->request, $this->response, $this->next);
|
||||
|
||||
$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->register('GET', $this->middleware);
|
||||
$map->register("GET", $this->middleware);
|
||||
$map($this->request, $this->response, $this->next);
|
||||
$this->assertFalse($this->next->called);
|
||||
}
|
||||
|
||||
/**
|
||||
* @dataProvider allowedMethodProvider
|
||||
* @param string[] $methodsDeclared
|
||||
* @param string[] $methodsAllowed
|
||||
*/
|
||||
public function testSetsAllowHeaderForBadMethod(array $methodsDeclared, array $methodsAllowed): void
|
||||
/** @dataProvider allowedMethodProvider */
|
||||
public function testSetsAllowHeaderForBadMethod($methodsDeclared, $methodsAllowed)
|
||||
{
|
||||
$this->request = $this->request->withMethod('BAD');
|
||||
$this->request = $this->request->withMethod("BAD");
|
||||
|
||||
$map = $this->getMethodMap();
|
||||
foreach ($methodsDeclared as $method) {
|
||||
|
|
@ -183,22 +180,21 @@ class MethodMapTest extends TestCase
|
|||
}
|
||||
$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 [
|
||||
[['GET'], ['GET', 'HEAD', 'OPTIONS']],
|
||||
[['GET', 'POST'], ['GET', 'POST', 'HEAD', 'OPTIONS']],
|
||||
[['POST'], ['POST', 'OPTIONS']],
|
||||
[['POST'], ['POST', 'OPTIONS']],
|
||||
[['GET', 'PUT,DELETE'], ['GET', 'PUT', 'DELETE', 'HEAD', 'OPTIONS']],
|
||||
[["GET"], ["GET", "HEAD", "OPTIONS"]],
|
||||
[["GET", "POST"], ["GET", "POST", "HEAD", "OPTIONS"]],
|
||||
[["POST"], ["POST", "OPTIONS"]],
|
||||
[["POST"], ["POST", "OPTIONS"]],
|
||||
[["GET", "PUT,DELETE"], ["GET", "PUT", "DELETE", "HEAD", "OPTIONS"]],
|
||||
];
|
||||
}
|
||||
|
||||
private function assertContainsEach($expectedList, $actual): void
|
||||
{
|
||||
private function assertContainsEach($expectedList, $actual) {
|
||||
foreach ($expectedList as $expected) {
|
||||
if (strpos($actual, $expected) === false) {
|
||||
$this->assertTrue(false, "'$actual' does not contain expected '$expected'");
|
||||
|
|
@ -1,50 +1,50 @@
|
|||
<?php
|
||||
|
||||
namespace WellRESTed\Routing\Route;
|
||||
namespace WellRESTed\Test\Unit\Routing\Route;
|
||||
|
||||
use Prophecy\PhpUnit\ProphecyTrait;
|
||||
use WellRESTed\Routing\Route\MethodMap;
|
||||
use WellRESTed\Routing\Route\PrefixRoute;
|
||||
use WellRESTed\Routing\Route\RouteInterface;
|
||||
use WellRESTed\Test\TestCase;
|
||||
|
||||
class PrefixRouteTest extends TestCase
|
||||
{
|
||||
use ProphecyTrait;
|
||||
|
||||
public function testTrimsAsteriskFromEndOfTarget(): void
|
||||
public function testTrimsAsteriskFromEndOfTarget()
|
||||
{
|
||||
$methodMap = $this->prophesize(MethodMap::class);
|
||||
$route = new PrefixRoute('/cats/*', $methodMap->reveal());
|
||||
$this->assertEquals('/cats/', $route->getTarget());
|
||||
}
|
||||
|
||||
public function testReturnsPrefixType(): void
|
||||
public function testReturnsPrefixType()
|
||||
{
|
||||
$methodMap = $this->prophesize(MethodMap::class);
|
||||
$route = new PrefixRoute('/*', $methodMap->reveal());
|
||||
$this->assertSame(Route::TYPE_PREFIX, $route->getType());
|
||||
$this->assertSame(RouteInterface::TYPE_PREFIX, $route->getType());
|
||||
}
|
||||
|
||||
public function testReturnsEmptyArrayForPathVariables(): void
|
||||
public function testReturnsEmptyArrayForPathVariables()
|
||||
{
|
||||
$methodMap = $this->prophesize(MethodMap::class);
|
||||
$route = new PrefixRoute('/*', $methodMap->reveal());
|
||||
$this->assertSame([], $route->getPathVariables());
|
||||
}
|
||||
|
||||
public function testMatchesExactRequestTarget(): void
|
||||
public function testMatchesExactRequestTarget()
|
||||
{
|
||||
$methodMap = $this->prophesize(MethodMap::class);
|
||||
$route = new PrefixRoute('/*', $methodMap->reveal());
|
||||
$this->assertTrue($route->matchesRequestTarget('/'));
|
||||
}
|
||||
|
||||
public function testMatchesRequestTargetWithSamePrefix(): void
|
||||
public function testMatchesRequestTargetWithSamePrefix()
|
||||
{
|
||||
$methodMap = $this->prophesize(MethodMap::class);
|
||||
$route = new PrefixRoute('/*', $methodMap->reveal());
|
||||
$this->assertTrue($route->matchesRequestTarget('/cats/'));
|
||||
}
|
||||
|
||||
public function testDoesNotMatchNonMatchingRequestTarget(): void
|
||||
public function testDoesNotMatchNonmatchingRequestTarget()
|
||||
{
|
||||
$methodMap = $this->prophesize(MethodMap::class);
|
||||
$route = new PrefixRoute('/animals/cats/', $methodMap->reveal());
|
||||
|
|
@ -1,64 +1,53 @@
|
|||
<?php
|
||||
|
||||
namespace WellRESTed\Routing\Route;
|
||||
namespace WellRESTed\Test\Unit\Routing\Route;
|
||||
|
||||
use Prophecy\PhpUnit\ProphecyTrait;
|
||||
use PHPUnit\Framework\Error\Notice;
|
||||
use PHPUnit\Framework\Error\Warning;
|
||||
use RuntimeException;
|
||||
use WellRESTed\Routing\Route\MethodMap;
|
||||
use WellRESTed\Routing\Route\RegexRoute;
|
||||
use WellRESTed\Routing\Route\RouteInterface;
|
||||
use WellRESTed\Test\TestCase;
|
||||
|
||||
class RegexRouteTest extends TestCase
|
||||
{
|
||||
use ProphecyTrait;
|
||||
|
||||
private $methodMap;
|
||||
|
||||
protected function setUp(): void
|
||||
public function setUp(): void
|
||||
{
|
||||
$this->methodMap = $this->prophesize(MethodMap::class);
|
||||
}
|
||||
|
||||
public function testReturnsPatternType(): void
|
||||
public function testReturnsPatternType()
|
||||
{
|
||||
$route = new RegexRoute('/', $this->methodMap->reveal());
|
||||
$this->assertSame(Route::TYPE_PATTERN, $route->getType());
|
||||
$this->assertSame(RouteInterface::TYPE_PATTERN, $route->getType());
|
||||
}
|
||||
|
||||
/**
|
||||
* @dataProvider matchingRouteProvider
|
||||
* @param string $pattern
|
||||
* @param string $path
|
||||
*/
|
||||
public function testMatchesTarget(string $pattern, string $path): void
|
||||
/** @dataProvider matchingRouteProvider */
|
||||
public function testMatchesTarget($pattern, $path)
|
||||
{
|
||||
$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
|
||||
/** @dataProvider matchingRouteProvider */
|
||||
public function testMatchesTargetByRegex($pattern, $target)
|
||||
{
|
||||
$route = new RegexRoute($pattern, $this->methodMap->reveal());
|
||||
$this->assertTrue($route->matchesRequestTarget($path));
|
||||
$this->assertTrue($route->matchesRequestTarget($target));
|
||||
}
|
||||
|
||||
/**
|
||||
* @dataProvider matchingRouteProvider
|
||||
* @param string $pattern
|
||||
* @param string $path
|
||||
* @param array $expectedCaptures
|
||||
*/
|
||||
public function testExtractsPathVariablesByRegex(string $pattern, string $path, array $expectedCaptures): void
|
||||
/** @dataProvider matchingRouteProvider */
|
||||
public function testExtractsPathVariablesByRegex($pattern, $target, $expectedCaptures)
|
||||
{
|
||||
$route = new RegexRoute($pattern, $this->methodMap->reveal());
|
||||
$route->matchesRequestTarget($path);
|
||||
$route->matchesRequestTarget($target);
|
||||
$this->assertEquals($expectedCaptures, $route->getPathVariables());
|
||||
}
|
||||
|
||||
public function matchingRouteProvider(): array
|
||||
public function matchingRouteProvider()
|
||||
{
|
||||
return [
|
||||
['~/cat/[0-9]+~', '/cat/2', [0 => '/cat/2']],
|
||||
|
|
@ -75,18 +64,14 @@ class RegexRouteTest extends TestCase
|
|||
];
|
||||
}
|
||||
|
||||
/**
|
||||
* @dataProvider mismatchingRouteProvider
|
||||
* @param string $pattern
|
||||
* @param string $path
|
||||
*/
|
||||
public function testDoesNotMatchNonMatchingTarget(string $pattern, string $path): void
|
||||
/** @dataProvider mismatchingRouteProvider */
|
||||
public function testDoesNotMatchNonmatchingTarget($pattern, $path)
|
||||
{
|
||||
$route = new RegexRoute($pattern, $this->methodMap->reveal());
|
||||
$this->assertFalse($route->matchesRequestTarget($path));
|
||||
}
|
||||
|
||||
public function mismatchingRouteProvider(): array
|
||||
public function mismatchingRouteProvider()
|
||||
{
|
||||
return [
|
||||
['~/cat/[0-9]+~', '/cat/molly'],
|
||||
|
|
@ -97,9 +82,8 @@ class RegexRouteTest extends TestCase
|
|||
|
||||
/**
|
||||
* @dataProvider invalidRouteProvider
|
||||
* @param string $pattern
|
||||
*/
|
||||
public function testThrowsExceptionOnInvalidPattern(string $pattern): void
|
||||
public function testThrowsExceptionOnInvalidPattern($pattern)
|
||||
{
|
||||
$this->expectException(RuntimeException::class);
|
||||
$route = new RegexRoute($pattern, $this->methodMap->reveal());
|
||||
|
|
@ -1,47 +1,46 @@
|
|||
<?php
|
||||
|
||||
namespace WellRESTed\Routing\Route;
|
||||
namespace WellRESTed\Test\Unit\Routing\Route;
|
||||
|
||||
use Prophecy\PhpUnit\ProphecyTrait;
|
||||
use WellRESTed\Dispatching\DispatcherInterface;
|
||||
use WellRESTed\Routing\Route\RouteFactory;
|
||||
use WellRESTed\Routing\Route\RouteInterface;
|
||||
use WellRESTed\Test\TestCase;
|
||||
|
||||
class RouteFactoryTest extends TestCase
|
||||
{
|
||||
use ProphecyTrait;
|
||||
|
||||
private $dispatcher;
|
||||
|
||||
protected function setUp(): void
|
||||
public function setUp(): void
|
||||
{
|
||||
$this->dispatcher = $this->prophesize(DispatcherInterface::class);
|
||||
}
|
||||
|
||||
public function testCreatesStaticRoute(): void
|
||||
public function testCreatesStaticRoute()
|
||||
{
|
||||
$factory = new RouteFactory($this->dispatcher->reveal());
|
||||
$route = $factory->create('/cats/');
|
||||
$this->assertSame(Route::TYPE_STATIC, $route->getType());
|
||||
$this->assertSame(RouteInterface::TYPE_STATIC, $route->getType());
|
||||
}
|
||||
|
||||
public function testCreatesPrefixRoute(): void
|
||||
public function testCreatesPrefixRoute()
|
||||
{
|
||||
$factory = new RouteFactory($this->dispatcher->reveal());
|
||||
$route = $factory->create('/cats/*');
|
||||
$this->assertSame(Route::TYPE_PREFIX, $route->getType());
|
||||
$this->assertSame(RouteInterface::TYPE_PREFIX, $route->getType());
|
||||
}
|
||||
|
||||
public function testCreatesRegexRoute(): void
|
||||
public function testCreatesRegexRoute()
|
||||
{
|
||||
$factory = new RouteFactory($this->dispatcher->reveal());
|
||||
$route = $factory->create('~/cat/[0-9]+~');
|
||||
$this->assertSame(Route::TYPE_PATTERN, $route->getType());
|
||||
$this->assertSame(RouteInterface::TYPE_PATTERN, $route->getType());
|
||||
}
|
||||
|
||||
public function testCreatesTemplateRoute(): void
|
||||
public function testCreatesTemplateRoute()
|
||||
{
|
||||
$factory = new RouteFactory($this->dispatcher->reveal());
|
||||
$route = $factory->create('/cat/{id}');
|
||||
$this->assertSame(Route::TYPE_PATTERN, $route->getType());
|
||||
$this->assertSame(RouteInterface::TYPE_PATTERN, $route->getType());
|
||||
}
|
||||
}
|
||||
|
|
@ -1,42 +1,40 @@
|
|||
<?php
|
||||
|
||||
namespace WellRESTed\Routing\Route;
|
||||
namespace WellRESTed\Test\Unit\Routing\Route;
|
||||
|
||||
use Prophecy\Argument;
|
||||
use Prophecy\PhpUnit\ProphecyTrait;
|
||||
use Psr\Http\Server\RequestHandlerInterface;
|
||||
use WellRESTed\Message\Response;
|
||||
use WellRESTed\Message\ServerRequest;
|
||||
use WellRESTed\Routing\Route\MethodMap;
|
||||
use WellRESTed\Routing\Route\StaticRoute;
|
||||
use WellRESTed\Test\TestCase;
|
||||
|
||||
class RouteTest extends TestCase
|
||||
{
|
||||
use ProphecyTrait;
|
||||
|
||||
private const TARGET = '/target';
|
||||
const TARGET = '/target';
|
||||
|
||||
private $methodMap;
|
||||
private $route;
|
||||
|
||||
protected function setUp(): void
|
||||
public function setUp(): void
|
||||
{
|
||||
$this->methodMap = $this->prophesize(MethodMap::class);
|
||||
$this->methodMap->register(Argument::cetera());
|
||||
$this->methodMap->register(Argument::cetera())
|
||||
->willReturn();
|
||||
$this->methodMap->__invoke(Argument::cetera())
|
||||
->willReturn(new Response());
|
||||
|
||||
$this->route = new StaticRoute(
|
||||
self::TARGET,
|
||||
$this->methodMap->reveal()
|
||||
);
|
||||
self::TARGET, $this->methodMap->reveal());
|
||||
}
|
||||
|
||||
public function testReturnsTarget(): void
|
||||
public function testReturnsTarget()
|
||||
{
|
||||
$this->assertSame(self::TARGET, $this->route->getTarget());
|
||||
}
|
||||
|
||||
public function testRegistersDispatchableWithMethodMap(): void
|
||||
public function testRegistersDispatchableWithMethodMap()
|
||||
{
|
||||
$handler = $this->prophesize(RequestHandlerInterface::class)->reveal();
|
||||
|
||||
|
|
@ -45,7 +43,7 @@ class RouteTest extends TestCase
|
|||
$this->methodMap->register('GET', $handler)->shouldHaveBeenCalled();
|
||||
}
|
||||
|
||||
public function testDispatchesMethodMap(): void
|
||||
public function testDispatchesMethodMap()
|
||||
{
|
||||
$request = new ServerRequest();
|
||||
$response = new Response();
|
||||
|
|
@ -53,7 +51,7 @@ class RouteTest extends TestCase
|
|||
return $resp;
|
||||
};
|
||||
|
||||
call_user_func($this->route, $request, $response, $next);
|
||||
$this->route->__invoke($request, $response, $next);
|
||||
|
||||
$this->methodMap->__invoke(Argument::cetera())->shouldHaveBeenCalled();
|
||||
}
|
||||
|
|
@ -1,36 +1,36 @@
|
|||
<?php
|
||||
|
||||
namespace WellRESTed\Routing\Route;
|
||||
namespace WellRESTed\Test\Unit\Routing\Route;
|
||||
|
||||
use Prophecy\PhpUnit\ProphecyTrait;
|
||||
use WellRESTed\Routing\Route\MethodMap;
|
||||
use WellRESTed\Routing\Route\RouteInterface;
|
||||
use WellRESTed\Routing\Route\StaticRoute;
|
||||
use WellRESTed\Test\TestCase;
|
||||
|
||||
class StaticRouteTest extends TestCase
|
||||
{
|
||||
use ProphecyTrait;
|
||||
|
||||
public function testReturnsStaticType(): void
|
||||
public function testReturnsStaticType()
|
||||
{
|
||||
$methodMap = $this->prophesize(MethodMap::class);
|
||||
$route = new StaticRoute('/', $methodMap->reveal());
|
||||
$this->assertSame(Route::TYPE_STATIC, $route->getType());
|
||||
$this->assertSame(RouteInterface::TYPE_STATIC, $route->getType());
|
||||
}
|
||||
|
||||
public function testMatchesExactRequestTarget(): void
|
||||
public function testMatchesExactRequestTarget()
|
||||
{
|
||||
$methodMap = $this->prophesize(MethodMap::class);
|
||||
$route = new StaticRoute('/', $methodMap->reveal());
|
||||
$this->assertTrue($route->matchesRequestTarget('/'));
|
||||
}
|
||||
|
||||
public function testReturnsEmptyArrayForPathVariables(): void
|
||||
public function testReturnsEmptyArrayForPathVariables()
|
||||
{
|
||||
$methodMap = $this->prophesize(MethodMap::class);
|
||||
$route = new StaticRoute('/', $methodMap->reveal());
|
||||
$this->assertSame([], $route->getPathVariables());
|
||||
}
|
||||
|
||||
public function testDoesNotMatchNonMatchingRequestTarget(): void
|
||||
public function testDoesNotMatchNonmatchingRequestTarget()
|
||||
{
|
||||
$methodMap = $this->prophesize(MethodMap::class);
|
||||
$route = new StaticRoute('/', $methodMap->reveal());
|
||||
|
|
@ -1,22 +1,22 @@
|
|||
<?php
|
||||
|
||||
namespace WellRESTed\Routing\Route;
|
||||
namespace WellRESTed\Test\Unit\Routing\Route;
|
||||
|
||||
use Prophecy\PhpUnit\ProphecyTrait;
|
||||
use WellRESTed\Routing\Route\MethodMap;
|
||||
use WellRESTed\Routing\Route\RouteInterface;
|
||||
use WellRESTed\Routing\Route\TemplateRoute;
|
||||
use WellRESTed\Test\TestCase;
|
||||
|
||||
class TemplateRouteTest extends TestCase
|
||||
{
|
||||
use ProphecyTrait;
|
||||
|
||||
private $methodMap;
|
||||
|
||||
protected function setUp(): void
|
||||
public function setUp(): void
|
||||
{
|
||||
$this->methodMap = $this->prophesize(MethodMap::class);
|
||||
}
|
||||
|
||||
private function getExpectedValues(array $keys): array
|
||||
private function getExpectedValues($keys)
|
||||
{
|
||||
$expectedValues = [
|
||||
'var' => 'value',
|
||||
|
|
@ -33,32 +33,28 @@ class TemplateRouteTest extends TestCase
|
|||
return array_intersect_key($expectedValues, array_flip($keys));
|
||||
}
|
||||
|
||||
private function assertArrayHasSameContents($expected, $actual): void
|
||||
private function assertArrayHasSameContents($expected, $actual)
|
||||
{
|
||||
ksort($expected);
|
||||
ksort($actual);
|
||||
$this->assertEquals($expected, $actual);
|
||||
}
|
||||
|
||||
// -------------------------------------------------------------------------
|
||||
// ------------------------------------------------------------------------
|
||||
|
||||
public function testReturnsPatternType(): void
|
||||
public function testReturnsPatternType()
|
||||
{
|
||||
$route = new TemplateRoute('/', $this->methodMap->reveal());
|
||||
$this->assertSame(Route::TYPE_PATTERN, $route->getType());
|
||||
$this->assertSame(RouteInterface::TYPE_PATTERN, $route->getType());
|
||||
}
|
||||
|
||||
// -------------------------------------------------------------------------
|
||||
// ------------------------------------------------------------------------
|
||||
// Matching
|
||||
|
||||
/**
|
||||
* @dataProvider nonMatchingTargetProvider
|
||||
* @param string $template
|
||||
* @param string $target
|
||||
*/
|
||||
public function testFailsToMatchNonMatchingTarget(string $template, string $target): void
|
||||
/** @dataProvider nonMatchingTargetProvider */
|
||||
public function testFailsToMatchNonMatchingTarget($template, $target)
|
||||
{
|
||||
$route = new TemplateRoute($template, $this->methodMap->reveal());
|
||||
$route = new TemplateRoute($template, $this->methodMap);
|
||||
$this->assertFalse($route->matchesRequestTarget($target));
|
||||
}
|
||||
|
||||
|
|
@ -72,34 +68,25 @@ class TemplateRouteTest extends TestCase
|
|||
];
|
||||
}
|
||||
|
||||
// -------------------------------------------------------------------------
|
||||
// ------------------------------------------------------------------------
|
||||
// Matching :: Simple Strings
|
||||
|
||||
/**
|
||||
* @dataProvider simpleStringProvider
|
||||
* @param string $template
|
||||
* @param string $target
|
||||
*/
|
||||
public function testMatchesSimpleStrings(string $template, string $target): void
|
||||
/** @dataProvider simpleStringProvider */
|
||||
public function testMatchesSimpleStrings($template, $target)
|
||||
{
|
||||
$route = new TemplateRoute($template, $this->methodMap->reveal());
|
||||
$route = new TemplateRoute($template, $this->methodMap);
|
||||
$this->assertTrue($route->matchesRequestTarget($target));
|
||||
}
|
||||
|
||||
/**
|
||||
* @dataProvider simpleStringProvider
|
||||
* @param string $template
|
||||
* @param string $target
|
||||
* @param string[] $variables
|
||||
*/
|
||||
public function testCapturesFromSimpleStrings(string $template, string $target, array $variables): void
|
||||
/** @dataProvider simpleStringProvider */
|
||||
public function testCapturesFromSimpleStrings($template, $target, $variables)
|
||||
{
|
||||
$route = new TemplateRoute($template, $this->methodMap->reveal());
|
||||
$route = new TemplateRoute($template, $this->methodMap);
|
||||
$route->matchesRequestTarget($target);
|
||||
$this->assertArrayHasSameContents($this->getExpectedValues($variables), $route->getPathVariables());
|
||||
}
|
||||
|
||||
public function simpleStringProvider(): array
|
||||
public function simpleStringProvider()
|
||||
{
|
||||
return [
|
||||
['/foo', '/foo', []],
|
||||
|
|
@ -110,34 +97,25 @@ class TemplateRouteTest extends TestCase
|
|||
];
|
||||
}
|
||||
|
||||
// -------------------------------------------------------------------------
|
||||
// ------------------------------------------------------------------------
|
||||
// Matching :: Reserved
|
||||
|
||||
/**
|
||||
* @dataProvider reservedStringProvider
|
||||
* @param string $template
|
||||
* @param string $target
|
||||
*/
|
||||
public function testMatchesReservedStrings(string $template, string $target): void
|
||||
/** @dataProvider reservedStringProvider */
|
||||
public function testMatchesReservedStrings($template, $target)
|
||||
{
|
||||
$route = new TemplateRoute($template, $this->methodMap->reveal());
|
||||
$route = new TemplateRoute($template, $this->methodMap);
|
||||
$this->assertTrue($route->matchesRequestTarget($target));
|
||||
}
|
||||
|
||||
/**
|
||||
* @dataProvider reservedStringProvider
|
||||
* @param string $template
|
||||
* @param string $target
|
||||
* @param array $variables
|
||||
*/
|
||||
public function testCapturesFromReservedStrings(string $template, string $target, array $variables): void
|
||||
/** @dataProvider reservedStringProvider */
|
||||
public function testCapturesFromReservedStrings($template, $target, $variables)
|
||||
{
|
||||
$route = new TemplateRoute($template, $this->methodMap->reveal());
|
||||
$route = new TemplateRoute($template, $this->methodMap);
|
||||
$route->matchesRequestTarget($target);
|
||||
$this->assertSame($this->getExpectedValues($variables), $route->getPathVariables());
|
||||
}
|
||||
|
||||
public function reservedStringProvider(): array
|
||||
public function reservedStringProvider()
|
||||
{
|
||||
return [
|
||||
['/{+var}', '/value', ['var']],
|
||||
|
|
@ -146,34 +124,25 @@ class TemplateRouteTest extends TestCase
|
|||
];
|
||||
}
|
||||
|
||||
// -------------------------------------------------------------------------
|
||||
// ------------------------------------------------------------------------
|
||||
// Matching :: Label Expansion
|
||||
|
||||
/**
|
||||
* @dataProvider labelWithDotPrefixProvider
|
||||
* @param string $template
|
||||
* @param string $target
|
||||
*/
|
||||
public function testMatchesLabelWithDotPrefix(string $template, string $target): void
|
||||
/** @dataProvider labelWithDotPrefixProvider */
|
||||
public function testMatchesLabelWithDotPrefix($template, $target)
|
||||
{
|
||||
$route = new TemplateRoute($template, $this->methodMap->reveal());
|
||||
$route = new TemplateRoute($template, $this->methodMap);
|
||||
$this->assertTrue($route->matchesRequestTarget($target));
|
||||
}
|
||||
|
||||
/**
|
||||
* @dataProvider labelWithDotPrefixProvider
|
||||
* @param string $template
|
||||
* @param string $target
|
||||
* @param array $variables
|
||||
*/
|
||||
public function testCapturesFromLabelWithDotPrefix(string $template, string $target, array $variables): void
|
||||
/** @dataProvider labelWithDotPrefixProvider */
|
||||
public function testCapturesFromLabelWithDotPrefix($template, $target, $variables)
|
||||
{
|
||||
$route = new TemplateRoute($template, $this->methodMap->reveal());
|
||||
$route = new TemplateRoute($template, $this->methodMap);
|
||||
$route->matchesRequestTarget($target);
|
||||
$this->assertArrayHasSameContents($this->getExpectedValues($variables), $route->getPathVariables());
|
||||
}
|
||||
|
||||
public function labelWithDotPrefixProvider(): array
|
||||
public function labelWithDotPrefixProvider()
|
||||
{
|
||||
return [
|
||||
['/{.who}', '/.fred', ['who']],
|
||||
|
|
@ -182,34 +151,25 @@ class TemplateRouteTest extends TestCase
|
|||
];
|
||||
}
|
||||
|
||||
// -------------------------------------------------------------------------
|
||||
// ------------------------------------------------------------------------
|
||||
// Matching :: Path Segments
|
||||
|
||||
/**
|
||||
* @dataProvider pathSegmentProvider
|
||||
* @param string $template
|
||||
* @param string $target
|
||||
*/
|
||||
public function testMatchesPathSegments(string $template, string $target): void
|
||||
/** @dataProvider pathSegmentProvider */
|
||||
public function testMatchesPathSegments($template, $target)
|
||||
{
|
||||
$route = new TemplateRoute($template, $this->methodMap->reveal());
|
||||
$route = new TemplateRoute($template, $this->methodMap);
|
||||
$this->assertTrue($route->matchesRequestTarget($target));
|
||||
}
|
||||
|
||||
/**
|
||||
* @dataProvider pathSegmentProvider
|
||||
* @param string $template
|
||||
* @param string $target
|
||||
* @param array $variables
|
||||
*/
|
||||
public function testCapturesFromPathSegments(string $template, string $target, array $variables): void
|
||||
/** @dataProvider pathSegmentProvider */
|
||||
public function testCapturesFromPathSegments($template, $target, $variables)
|
||||
{
|
||||
$route = new TemplateRoute($template, $this->methodMap->reveal());
|
||||
$route = new TemplateRoute($template, $this->methodMap);
|
||||
$route->matchesRequestTarget($target);
|
||||
$this->assertArrayHasSameContents($this->getExpectedValues($variables), $route->getPathVariables());
|
||||
}
|
||||
|
||||
public function pathSegmentProvider(): array
|
||||
public function pathSegmentProvider()
|
||||
{
|
||||
return [
|
||||
['{/who}', '/fred', ['who']],
|
||||
|
|
@ -218,34 +178,25 @@ class TemplateRouteTest extends TestCase
|
|||
];
|
||||
}
|
||||
|
||||
// -------------------------------------------------------------------------
|
||||
// ------------------------------------------------------------------------
|
||||
// Matching :: Explosion
|
||||
|
||||
/**
|
||||
* @dataProvider pathExplosionProvider
|
||||
* @param string $template
|
||||
* @param string $target
|
||||
*/
|
||||
public function testMatchesExplosion(string $template, string $target): void
|
||||
/** @dataProvider pathExplosionProvider */
|
||||
public function testMatchesExplosion($template, $target)
|
||||
{
|
||||
$route = new TemplateRoute($template, $this->methodMap->reveal());
|
||||
$route = new TemplateRoute($template, $this->methodMap);
|
||||
$this->assertTrue($route->matchesRequestTarget($target));
|
||||
}
|
||||
|
||||
/**
|
||||
* @dataProvider pathExplosionProvider
|
||||
* @param string $template
|
||||
* @param string $target
|
||||
* @param array $variables
|
||||
*/
|
||||
public function testCapturesFromExplosion(string $template, string $target, array $variables): void
|
||||
/** @dataProvider pathExplosionProvider */
|
||||
public function testCapturesFromExplosion($template, $target, $variables)
|
||||
{
|
||||
$route = new TemplateRoute($template, $this->methodMap->reveal());
|
||||
$route = new TemplateRoute($template, $this->methodMap);
|
||||
$route->matchesRequestTarget($target);
|
||||
$this->assertArrayHasSameContents($this->getExpectedValues($variables), $route->getPathVariables());
|
||||
}
|
||||
|
||||
public function pathExplosionProvider(): array
|
||||
public function pathExplosionProvider()
|
||||
{
|
||||
return [
|
||||
['/{count*}', '/one,two,three', ['count']],
|
||||
|
|
@ -0,0 +1,451 @@
|
|||
<?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\RouteFactory;
|
||||
use WellRESTed\Routing\Route\RouteInterface;
|
||||
use WellRESTed\Routing\Router;
|
||||
use WellRESTed\Test\Doubles\NextMock;
|
||||
use WellRESTed\Test\TestCase;
|
||||
|
||||
class RouterTest extends TestCase
|
||||
{
|
||||
private $factory;
|
||||
private $request;
|
||||
private $response;
|
||||
private $route;
|
||||
private $router;
|
||||
private $next;
|
||||
|
||||
public function setUp(): void
|
||||
{
|
||||
parent::setUp();
|
||||
|
||||
$this->route = $this->prophesize(RouteInterface::class);
|
||||
$this->route->__invoke(Argument::cetera())->willReturn(new Response());
|
||||
$this->route->register(Argument::cetera())->willReturn();
|
||||
$this->route->getType()->willReturn(RouteInterface::TYPE_STATIC);
|
||||
$this->route->getTarget()->willReturn("/");
|
||||
$this->route->getPathVariables()->willReturn([]);
|
||||
|
||||
$this->factory = $this->prophesize(RouteFactory::class);
|
||||
$this->factory->create(Argument::any())
|
||||
->willReturn($this->route->reveal());
|
||||
|
||||
RouterWithFactory::$routeFactory = $this->factory->reveal();
|
||||
|
||||
$this->router = new RouterWithFactory();
|
||||
|
||||
$this->request = new ServerRequest();
|
||||
$this->response = new Response();
|
||||
$this->next = new NextMock();
|
||||
}
|
||||
|
||||
// ------------------------------------------------------------------------
|
||||
// Construction
|
||||
|
||||
public function testCreatesInstance()
|
||||
{
|
||||
$router = new Router();
|
||||
$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 testPassesMethodAndMiddlewareToRoute()
|
||||
{
|
||||
$this->router->register("GET", "/", "middleware");
|
||||
|
||||
$this->route->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(Argument::cetera())
|
||||
->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(Argument::cetera())
|
||||
->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(Argument::cetera())
|
||||
->shouldHaveBeenCalled();
|
||||
}
|
||||
|
||||
public function testDispatchesStaticRouteBeforePrefixRoute()
|
||||
{
|
||||
$staticRoute = $this->prophesize(RouteInterface::class);
|
||||
$staticRoute->register(Argument::cetera())->willReturn();
|
||||
$staticRoute->getTarget()->willReturn("/cats/");
|
||||
$staticRoute->getType()->willReturn(RouteInterface::TYPE_STATIC);
|
||||
$staticRoute->__invoke(Argument::cetera())->willReturn(new Response());
|
||||
|
||||
$prefixRoute = $this->prophesize(RouteInterface::class);
|
||||
$prefixRoute->register(Argument::cetera())->willReturn();
|
||||
$prefixRoute->getTarget()->willReturn("/cats/*");
|
||||
$prefixRoute->getType()->willReturn(RouteInterface::TYPE_PREFIX);
|
||||
$prefixRoute->__invoke(Argument::cetera())->willReturn(new Response());
|
||||
|
||||
$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(Argument::cetera())
|
||||
->shouldHaveBeenCalled();
|
||||
}
|
||||
|
||||
public function testDispatchesLongestMatchingPrefixRoute()
|
||||
{
|
||||
// Note: The longest route is also good for 2 points in Settlers of Catan.
|
||||
|
||||
$shortRoute = $this->prophesize(RouteInterface::class);
|
||||
$shortRoute->register(Argument::cetera())->willReturn();
|
||||
$shortRoute->getTarget()->willReturn("/animals/*");
|
||||
$shortRoute->getType()->willReturn(RouteInterface::TYPE_PREFIX);
|
||||
$shortRoute->__invoke(Argument::cetera())->willReturn(new Response());
|
||||
|
||||
$longRoute = $this->prophesize(RouteInterface::class);
|
||||
$longRoute->register(Argument::cetera())->willReturn();
|
||||
$longRoute->getTarget()->willReturn("/animals/cats/*");
|
||||
$longRoute->getType()->willReturn(RouteInterface::TYPE_PREFIX);
|
||||
$longRoute->__invoke(Argument::cetera())->willReturn(new Response());
|
||||
|
||||
$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(Argument::cetera())
|
||||
->shouldHaveBeenCalled();
|
||||
}
|
||||
|
||||
public function testDispatchesPrefixRouteBeforePatternRoute()
|
||||
{
|
||||
$prefixRoute = $this->prophesize(RouteInterface::class);
|
||||
$prefixRoute->register(Argument::cetera())->willReturn();
|
||||
$prefixRoute->getTarget()->willReturn("/cats/*");
|
||||
$prefixRoute->getType()->willReturn(RouteInterface::TYPE_PREFIX);
|
||||
$prefixRoute->__invoke(Argument::cetera())->willReturn(new Response());
|
||||
|
||||
$patternRoute = $this->prophesize(RouteInterface::class);
|
||||
$patternRoute->register(Argument::cetera())->willReturn();
|
||||
$patternRoute->getTarget()->willReturn("/cats/{id}");
|
||||
$patternRoute->getType()->willReturn(RouteInterface::TYPE_PATTERN);
|
||||
$patternRoute->__invoke(Argument::cetera())->willReturn(new Response());
|
||||
|
||||
$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(Argument::cetera())
|
||||
->shouldHaveBeenCalled();
|
||||
}
|
||||
|
||||
public function testDispatchesFirstMatchingPatternRoute()
|
||||
{
|
||||
$patternRoute1 = $this->prophesize(RouteInterface::class);
|
||||
$patternRoute1->register(Argument::cetera())->willReturn();
|
||||
$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(new Response());
|
||||
|
||||
$patternRoute2 = $this->prophesize(RouteInterface::class);
|
||||
$patternRoute2->register(Argument::cetera())->willReturn();
|
||||
$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(new Response());
|
||||
|
||||
$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(Argument::cetera())
|
||||
->shouldHaveBeenCalled();
|
||||
}
|
||||
|
||||
public function testStopsTestingPatternsAfterFirstSuccessfulMatch()
|
||||
{
|
||||
$patternRoute1 = $this->prophesize(RouteInterface::class);
|
||||
$patternRoute1->register(Argument::cetera())->willReturn();
|
||||
$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(new Response());
|
||||
|
||||
$patternRoute2 = $this->prophesize(RouteInterface::class);
|
||||
$patternRoute2->register(Argument::cetera())->willReturn();
|
||||
$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(new Response());
|
||||
|
||||
$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 Match
|
||||
|
||||
public function testWhenNoRouteMatchesByDefaultResponds404()
|
||||
{
|
||||
$this->request = $this->request->withRequestTarget("/no/match");
|
||||
$response = $this->router->__invoke($this->request, $this->response, $this->next);
|
||||
$this->assertEquals(404, $response->getStatusCode());
|
||||
}
|
||||
|
||||
public function testWhenNoRouteMatchesByDefaultDoesNotPropagatesToNextMiddleware()
|
||||
{
|
||||
$this->request = $this->request->withRequestTarget("/no/match");
|
||||
$this->router->__invoke($this->request, $this->response, $this->next);
|
||||
$this->assertFalse($this->next->called);
|
||||
}
|
||||
|
||||
public function testWhenNoRouteMatchesAndContinueModePropagatesToNextMiddleware()
|
||||
{
|
||||
$this->request = $this->request->withRequestTarget("/no/match");
|
||||
$this->router->continueOnNotFound();
|
||||
$this->router->__invoke($this->request, $this->response, $this->next);
|
||||
$this->assertTrue($this->next->called);
|
||||
}
|
||||
|
||||
// ------------------------------------------------------------------------
|
||||
// Middleware for Routes
|
||||
|
||||
public function testCallsRouterMiddlewareBeforeRouteMiddleware()
|
||||
{
|
||||
$middlewareRequest = new ServerRequest();
|
||||
$middlewareResponse = new Response();
|
||||
|
||||
$middleware = function ($rqst, $resp, $next) use (
|
||||
$middlewareRequest,
|
||||
$middlewareResponse
|
||||
) {
|
||||
return $next($middlewareRequest, $middlewareResponse);
|
||||
};
|
||||
|
||||
$this->router->add($middleware);
|
||||
$this->router->register("GET", "/", "Handler");
|
||||
|
||||
$this->router->__invoke($this->request, $this->response, $this->next);
|
||||
|
||||
$this->route->__invoke(
|
||||
$middlewareRequest,
|
||||
$middlewareResponse,
|
||||
Argument::any())->shouldHaveBeenCalled();
|
||||
}
|
||||
|
||||
public function testDoesNotCallRouterMiddlewareWhenNoRouteMatches()
|
||||
{
|
||||
$middlewareCalled = false;
|
||||
$middlewareRequest = new ServerRequest();
|
||||
$middlewareResponse = new Response();
|
||||
|
||||
$middleware = function ($rqst, $resp, $next) use (
|
||||
$middlewareRequest,
|
||||
$middlewareResponse,
|
||||
&$middlewareCalled
|
||||
) {
|
||||
$middlewareCalled = true;
|
||||
return $next($middlewareRequest, $middlewareResponse);
|
||||
};
|
||||
|
||||
$this->request = $this->request->withRequestTarget("/no/match");
|
||||
|
||||
$this->router->add($middleware);
|
||||
$this->router->register("GET", "/", "Handler");
|
||||
|
||||
$this->router->__invoke($this->request, $this->response, $this->next);
|
||||
|
||||
$this->assertFalse($middlewareCalled);
|
||||
}
|
||||
}
|
||||
|
||||
// -----------------------------------------------------------------------------
|
||||
|
||||
class RouterWithFactory extends Router
|
||||
{
|
||||
static $routeFactory;
|
||||
|
||||
protected function getRouteFactory($dispatcher)
|
||||
{
|
||||
return self::$routeFactory;
|
||||
}
|
||||
}
|
||||
|
|
@ -1,29 +1,30 @@
|
|||
<?php
|
||||
|
||||
namespace WellRESTed;
|
||||
namespace WellRESTed\Test\Unit;
|
||||
|
||||
use Prophecy\Argument;
|
||||
use Prophecy\PhpUnit\ProphecyTrait;
|
||||
use WellRESTed\Dispatching\DispatcherInterface;
|
||||
use WellRESTed\Message\Response;
|
||||
use WellRESTed\Message\ServerRequest;
|
||||
use WellRESTed\Message\Stream;
|
||||
use WellRESTed\Server;
|
||||
use WellRESTed\Test\TestCase;
|
||||
use WellRESTed\Transmission\TransmitterInterface;
|
||||
|
||||
require_once __DIR__ . '/../../src/HeaderStack.php';
|
||||
|
||||
class ServerTest extends TestCase
|
||||
{
|
||||
use ProphecyTrait;
|
||||
|
||||
private $transmitter;
|
||||
/** @var Server */
|
||||
private $server;
|
||||
|
||||
protected function setUp(): void
|
||||
public function setUp(): void
|
||||
{
|
||||
parent::setUp();
|
||||
|
||||
$this->transmitter = $this->prophesize(TransmitterInterface::class);
|
||||
$this->transmitter->transmit(Argument::cetera());
|
||||
$this->transmitter->transmit(Argument::cetera())->willReturn();
|
||||
|
||||
$this->server = new Server();
|
||||
$this->server->setTransmitter($this->transmitter->reveal());
|
||||
|
|
@ -31,7 +32,7 @@ class ServerTest extends TestCase
|
|||
|
||||
// -------------------------------------------------------------------------
|
||||
|
||||
public function testDispatchesMiddlewareStack(): void
|
||||
public function testDispatchesMiddlewareStack()
|
||||
{
|
||||
// This test will add a string to this array from each middleware.
|
||||
|
||||
|
|
@ -63,7 +64,7 @@ class ServerTest extends TestCase
|
|||
$this->assertEquals(['first', 'second', 'third'], $steps);
|
||||
}
|
||||
|
||||
public function testDispatchedRequest(): void
|
||||
public function testDispatchedRequest()
|
||||
{
|
||||
$request = new ServerRequest();
|
||||
$capturedRequest = null;
|
||||
|
|
@ -78,7 +79,7 @@ class ServerTest extends TestCase
|
|||
$this->assertSame($request, $capturedRequest);
|
||||
}
|
||||
|
||||
public function testDispatchedResponse(): void
|
||||
public function testDispatchedResponse()
|
||||
{
|
||||
$response = new Response();
|
||||
$capturedResponse = null;
|
||||
|
|
@ -96,7 +97,7 @@ class ServerTest extends TestCase
|
|||
// -------------------------------------------------------------------------
|
||||
// Respond
|
||||
|
||||
public function testRespondSendsResponseToTransmitter(): void
|
||||
public function testRespondSendsResponseToTransmitter()
|
||||
{
|
||||
$expectedResponse = new Response(200);
|
||||
|
||||
|
|
@ -129,7 +130,7 @@ class ServerTest extends TestCase
|
|||
// -------------------------------------------------------------------------
|
||||
// Router
|
||||
|
||||
public function testCreatesRouterWithDispatcher(): void
|
||||
public function testCreatesRouterWithDispatcher()
|
||||
{
|
||||
$dispatcher = $this->prophesize(DispatcherInterface::class);
|
||||
$dispatcher->dispatch(Argument::cetera())->will(
|
||||
|
|
@ -143,15 +144,15 @@ class ServerTest extends TestCase
|
|||
$this->server->setPathVariablesAttributeName('pathVariables');
|
||||
|
||||
$request = (new ServerRequest())
|
||||
->withMethod('GET')
|
||||
->withRequestTarget('/');
|
||||
->withMethod("GET")
|
||||
->withRequestTarget("/");
|
||||
$response = new Response();
|
||||
$next = function ($rqst, $resp) {
|
||||
return $resp;
|
||||
};
|
||||
|
||||
$router = $this->server->createRouter();
|
||||
$router->register('GET', '/', 'middleware');
|
||||
$router->register("GET", "/", "middleware");
|
||||
$router($request, $response, $next);
|
||||
|
||||
$dispatcher->dispatch(Argument::cetera())
|
||||
|
|
@ -161,7 +162,7 @@ class ServerTest extends TestCase
|
|||
// -------------------------------------------------------------------------
|
||||
// Attributes
|
||||
|
||||
public function testAddsAttributesToRequest(): void
|
||||
public function testAddsAttributesToRequest()
|
||||
{
|
||||
$this->server->setAttributes([
|
||||
'name' => 'value'
|
||||
|
|
@ -181,7 +182,7 @@ class ServerTest extends TestCase
|
|||
// -------------------------------------------------------------------------
|
||||
// End of Stack
|
||||
|
||||
public function testReturnsLastDoublePassResponseAtEndOfStack(): void
|
||||
public function testReturnsLastDoublePassResponseAtEndOfStack()
|
||||
{
|
||||
$defaultResponse = new Response(404);
|
||||
|
||||
|
|
@ -200,4 +201,26 @@ class ServerTest extends TestCase
|
|||
$defaultResponse
|
||||
)->shouldHaveBeenCalled();
|
||||
}
|
||||
|
||||
// -------------------------------------------------------------------------
|
||||
|
||||
public function testCreatesStockTransmitterByDefault()
|
||||
{
|
||||
$content = "Hello, world!";
|
||||
|
||||
$response = (new Response())
|
||||
->withBody(new Stream($content));
|
||||
|
||||
$server = new Server();
|
||||
$server->add(function () use ($response) {
|
||||
return $response;
|
||||
});
|
||||
|
||||
ob_start();
|
||||
$server->respond();
|
||||
$captured = ob_get_contents();
|
||||
ob_end_clean();
|
||||
|
||||
$this->assertEquals($content, $captured);
|
||||
}
|
||||
}
|
||||
|
|
@ -1,29 +1,29 @@
|
|||
<?php
|
||||
|
||||
namespace WellRESTed\Transmission;
|
||||
namespace WellRESTed\Test\Unit\Transmission;
|
||||
|
||||
use Prophecy\Argument;
|
||||
use Prophecy\PhpUnit\ProphecyTrait;
|
||||
use Psr\Http\Message\StreamInterface;
|
||||
use RuntimeException;
|
||||
use WellRESTed\Message\Response;
|
||||
use WellRESTed\Message\ServerRequest;
|
||||
use WellRESTed\Test\TestCase;
|
||||
use WellRESTed\Transmission\HeaderStack;
|
||||
use WellRESTed\Transmission\Transmitter;
|
||||
|
||||
require_once __DIR__ . "/../../../src/HeaderStack.php";
|
||||
|
||||
class TransmitterTest extends TestCase
|
||||
{
|
||||
use ProphecyTrait;
|
||||
|
||||
private $request;
|
||||
private $response;
|
||||
private $body;
|
||||
|
||||
protected function setUp(): void
|
||||
public function setUp(): void
|
||||
{
|
||||
HeaderStack::reset();
|
||||
|
||||
$this->request = (new ServerRequest())
|
||||
->withMethod('HEAD');
|
||||
->withMethod("HEAD");
|
||||
|
||||
$this->body = $this->prophesize(StreamInterface::class);
|
||||
$this->body->isReadable()->willReturn(false);
|
||||
|
|
@ -36,49 +36,46 @@ class TransmitterTest extends TestCase
|
|||
->withBody($stream);
|
||||
}
|
||||
|
||||
public function testSendStatusCodeWithReasonPhrase(): void
|
||||
public function testSendStatusCodeWithReasonPhrase()
|
||||
{
|
||||
$transmitter = new Transmitter();
|
||||
$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);
|
||||
|
||||
$transmitter = new Transmitter();
|
||||
$transmitter->transmit($this->request, $this->response);
|
||||
$this->assertContains('HTTP/1.1 999', HeaderStack::getHeaders());
|
||||
$this->assertContains("HTTP/1.1 999", HeaderStack::getHeaders());
|
||||
}
|
||||
|
||||
/**
|
||||
* @dataProvider headerProvider
|
||||
* @param string $header
|
||||
*/
|
||||
public function testSendsHeaders(string $header): void
|
||||
/** @dataProvider headerProvider */
|
||||
public function testSendsHeaders($header)
|
||||
{
|
||||
$this->response = $this->response
|
||||
->withHeader('Content-length', ['2048'])
|
||||
->withHeader('X-foo', ['bar', 'baz']);
|
||||
->withHeader("Content-length", ["2048"])
|
||||
->withHeader("X-foo", ["bar", "baz"]);
|
||||
|
||||
$transmitter = new Transmitter();
|
||||
$transmitter->transmit($this->request, $this->response);
|
||||
$this->assertContains($header, HeaderStack::getHeaders());
|
||||
}
|
||||
|
||||
public function headerProvider(): array
|
||||
public function headerProvider()
|
||||
{
|
||||
return [
|
||||
['Content-length: 2048'],
|
||||
['X-foo: bar'],
|
||||
['X-foo: baz']
|
||||
["Content-length: 2048"],
|
||||
["X-foo: bar"],
|
||||
["X-foo: baz"]
|
||||
];
|
||||
}
|
||||
|
||||
public function testOutputsBody(): void
|
||||
public function testOutputsBody()
|
||||
{
|
||||
$content = 'Hello, world!';
|
||||
$content = "Hello, world!";
|
||||
|
||||
$this->body->isReadable()->willReturn(true);
|
||||
$this->body->__toString()->willReturn($content);
|
||||
|
|
@ -94,9 +91,9 @@ class TransmitterTest extends TestCase
|
|||
$this->assertEquals($content, $captured);
|
||||
}
|
||||
|
||||
public function testOutputsBodyInChunks(): void
|
||||
public function testOutputsBodyInChunks()
|
||||
{
|
||||
$content = 'Hello, world!';
|
||||
$content = "Hello, world!";
|
||||
$chunkSize = 3;
|
||||
$position = 0;
|
||||
|
||||
|
|
@ -127,15 +124,15 @@ class TransmitterTest extends TestCase
|
|||
$this->assertEquals($content, $captured);
|
||||
}
|
||||
|
||||
public function testOutputsUnseekableStreamInChunks(): void
|
||||
public function testOutputsUnseekableStreamInChunks()
|
||||
{
|
||||
$content = 'Hello, world!';
|
||||
$content = "Hello, world!";
|
||||
$chunkSize = 3;
|
||||
$position = 0;
|
||||
|
||||
$this->body->isSeekable()->willReturn(false);
|
||||
$this->body->isReadable()->willReturn(true);
|
||||
$this->body->rewind()->willThrow(new RuntimeException());
|
||||
$this->body->rewind()->willThrow(new \RuntimeException());
|
||||
$this->body->eof()->willReturn(false);
|
||||
$this->body->read(Argument::any())->will(
|
||||
function ($args) use ($content, &$position) {
|
||||
|
|
@ -160,14 +157,14 @@ class TransmitterTest extends TestCase
|
|||
$this->assertEquals($content, $captured);
|
||||
}
|
||||
|
||||
// -------------------------------------------------------------------------
|
||||
// ------------------------------------------------------------------------
|
||||
// Preparation
|
||||
|
||||
public function testAddContentLengthHeader(): void
|
||||
public function testAddContentLengthHeader()
|
||||
{
|
||||
$bodySize = 1024;
|
||||
$this->body->isReadable()->willReturn(true);
|
||||
$this->body->__toString()->willReturn('');
|
||||
$this->body->__toString()->willReturn("");
|
||||
$this->body->getSize()->willReturn($bodySize);
|
||||
|
||||
$transmitter = new Transmitter();
|
||||
|
|
@ -177,15 +174,15 @@ class TransmitterTest extends TestCase
|
|||
$this->assertContains("Content-length: $bodySize", HeaderStack::getHeaders());
|
||||
}
|
||||
|
||||
public function testDoesNotReplaceContentLengthHeaderWhenContentLengthIsAlreadySet(): void
|
||||
public function testDoesNotReplaceContentLengthHeaderWhenContentLengthIsAlreadySet()
|
||||
{
|
||||
$streamSize = 1024;
|
||||
$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->__toString()->willReturn('');
|
||||
$this->body->__toString()->willReturn("");
|
||||
$this->body->getSize()->willReturn($streamSize);
|
||||
|
||||
$transmitter = new Transmitter();
|
||||
|
|
@ -195,37 +192,37 @@ class TransmitterTest extends TestCase
|
|||
$this->assertContains("Content-length: $headerSize", HeaderStack::getHeaders());
|
||||
}
|
||||
|
||||
public function testDoesNotAddContentLengthHeaderWhenTransferEncodingIsChunked(): void
|
||||
public function testDoesNotAddContentLengthHeaderWhenTransferEncodingIsChunked()
|
||||
{
|
||||
$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->__toString()->willReturn('');
|
||||
$this->body->__toString()->willReturn("");
|
||||
$this->body->getSize()->willReturn($bodySize);
|
||||
|
||||
$transmitter = new Transmitter();
|
||||
$transmitter->setChunkSize(0);
|
||||
$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->__toString()->willReturn('');
|
||||
$this->body->__toString()->willReturn("");
|
||||
$this->body->getSize()->willReturn(null);
|
||||
|
||||
$transmitter = new Transmitter();
|
||||
$transmitter->setChunkSize(0);
|
||||
$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);
|
||||
foreach ($arr as $item) {
|
||||
|
|
@ -237,33 +234,3 @@ class TransmitterTest extends TestCase
|
|||
$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);
|
||||
}
|
||||
|
|
@ -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);
|
||||
}
|
||||
}
|
||||
|
|
@ -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'));
|
||||
}
|
||||
}
|
||||
|
|
@ -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());
|
||||
}
|
||||
}
|
||||
|
|
@ -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'));
|
||||
}
|
||||
}
|
||||
|
|
@ -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);
|
||||
}
|
||||
|
|
@ -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'));
|
||||
}
|
||||
}
|
||||
|
|
@ -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);
|
||||
}
|
||||
}
|
||||
|
|
@ -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);
|
||||
}
|
||||
|
|
@ -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'
|
||||
],
|
||||
[
|
||||
'*',
|
||||
'*'
|
||||
]
|
||||
];
|
||||
}
|
||||
}
|
||||
|
|
@ -1,491 +0,0 @@
|
|||
<?php
|
||||
|
||||
namespace WellRESTed\Routing;
|
||||
|
||||
use Prophecy\Argument;
|
||||
use Prophecy\PhpUnit\ProphecyTrait;
|
||||
use Psr\Http\Message\ResponseInterface;
|
||||
use WellRESTed\Dispatching\Dispatcher;
|
||||
use WellRESTed\Message\Response;
|
||||
use WellRESTed\Message\ServerRequest;
|
||||
use WellRESTed\Routing\Route\Route;
|
||||
use WellRESTed\Routing\Route\RouteFactory;
|
||||
use WellRESTed\Test\Doubles\NextMock;
|
||||
use WellRESTed\Test\TestCase;
|
||||
|
||||
class RouterTest extends TestCase
|
||||
{
|
||||
use ProphecyTrait;
|
||||
|
||||
private $factory;
|
||||
private $request;
|
||||
private $response;
|
||||
private $route;
|
||||
private $router;
|
||||
private $next;
|
||||
|
||||
protected function setUp(): void
|
||||
{
|
||||
parent::setUp();
|
||||
|
||||
$this->route = $this->prophesize(Route::class);
|
||||
$this->route->__invoke(Argument::cetera())->willReturn(new Response());
|
||||
$this->route->register(Argument::cetera());
|
||||
$this->route->getType()->willReturn(Route::TYPE_STATIC);
|
||||
$this->route->getTarget()->willReturn('/');
|
||||
$this->route->getPathVariables()->willReturn([]);
|
||||
|
||||
$this->factory = $this->prophesize(RouteFactory::class);
|
||||
$this->factory->create(Argument::any())
|
||||
->willReturn($this->route->reveal());
|
||||
|
||||
$this->router = new Router(null, null, $this->factory->reveal());
|
||||
|
||||
$this->request = new ServerRequest();
|
||||
$this->response = new Response();
|
||||
$this->next = new NextMock();
|
||||
}
|
||||
|
||||
/**
|
||||
* Run a request through the class under test and return the response.
|
||||
*
|
||||
* @return ResponseInterface
|
||||
*/
|
||||
private function dispatch(): ResponseInterface
|
||||
{
|
||||
return call_user_func(
|
||||
$this->router,
|
||||
$this->request,
|
||||
$this->response,
|
||||
$this->next
|
||||
);
|
||||
}
|
||||
|
||||
// -------------------------------------------------------------------------
|
||||
// Populating
|
||||
|
||||
public function testCreatesRouteForTarget(): void
|
||||
{
|
||||
$this->router->register('GET', '/', 'middleware');
|
||||
|
||||
$this->factory->create('/')->shouldHaveBeenCalled();
|
||||
}
|
||||
|
||||
public function testDoesNotRecreateRouteForExistingTarget(): void
|
||||
{
|
||||
$this->router->register('GET', '/', 'middleware');
|
||||
$this->router->register('POST', '/', 'middleware');
|
||||
|
||||
$this->factory->create('/')->shouldHaveBeenCalledTimes(1);
|
||||
}
|
||||
|
||||
public function testPassesMethodAndMiddlewareToRoute(): void
|
||||
{
|
||||
$this->router->register('GET', '/', 'middleware');
|
||||
|
||||
$this->route->register('GET', 'middleware')->shouldHaveBeenCalled();
|
||||
}
|
||||
|
||||
// -------------------------------------------------------------------------
|
||||
// Dispatching
|
||||
|
||||
public function testDispatchesStaticRoute(): void
|
||||
{
|
||||
$target = '/';
|
||||
$this->request = $this->request->withRequestTarget($target);
|
||||
|
||||
$this->route->getTarget()->willReturn($target);
|
||||
$this->route->getType()->willReturn(Route::TYPE_STATIC);
|
||||
|
||||
$this->router->register('GET', $target, 'middleware');
|
||||
|
||||
$this->dispatch();
|
||||
|
||||
$this->route->__invoke(Argument::cetera())
|
||||
->shouldHaveBeenCalled();
|
||||
}
|
||||
|
||||
public function testDispatchesPrefixRoute(): void
|
||||
{
|
||||
$target = '/animals/cats/*';
|
||||
$this->request = $this->request->withRequestTarget('/animals/cats/molly');
|
||||
|
||||
$this->route->getTarget()->willReturn($target);
|
||||
$this->route->getType()->willReturn(Route::TYPE_PREFIX);
|
||||
|
||||
$this->router->register('GET', $target, 'middleware');
|
||||
|
||||
$this->dispatch();
|
||||
|
||||
$this->route->__invoke(Argument::cetera())
|
||||
->shouldHaveBeenCalled();
|
||||
}
|
||||
|
||||
public function testDispatchesPatternRoute(): void
|
||||
{
|
||||
$target = '/';
|
||||
$this->request = $this->request->withRequestTarget($target);
|
||||
|
||||
$this->route->getTarget()->willReturn($target);
|
||||
$this->route->getType()->willReturn(Route::TYPE_PATTERN);
|
||||
$this->route->matchesRequestTarget(Argument::cetera())->willReturn(true);
|
||||
|
||||
$this->router->register('GET', $target, 'middleware');
|
||||
|
||||
$this->dispatch();
|
||||
|
||||
$this->route->__invoke(Argument::cetera())
|
||||
->shouldHaveBeenCalled();
|
||||
}
|
||||
|
||||
public function testDispatchesStaticRouteBeforePrefixRoute(): void
|
||||
{
|
||||
$staticRoute = $this->prophesize(Route::class);
|
||||
$staticRoute->register(Argument::cetera());
|
||||
$staticRoute->getTarget()->willReturn('/cats/');
|
||||
$staticRoute->getType()->willReturn(Route::TYPE_STATIC);
|
||||
$staticRoute->__invoke(Argument::cetera())->willReturn(new Response());
|
||||
|
||||
$prefixRoute = $this->prophesize(Route::class);
|
||||
$prefixRoute->register(Argument::cetera());
|
||||
$prefixRoute->getTarget()->willReturn('/cats/*');
|
||||
$prefixRoute->getType()->willReturn(Route::TYPE_PREFIX);
|
||||
$prefixRoute->__invoke(Argument::cetera())->willReturn(new Response());
|
||||
|
||||
$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->dispatch();
|
||||
|
||||
$staticRoute->__invoke(Argument::cetera())
|
||||
->shouldHaveBeenCalled();
|
||||
}
|
||||
|
||||
public function testDispatchesLongestMatchingPrefixRoute(): void
|
||||
{
|
||||
// Note: The longest route is also good for 2 points in Settlers of Catan.
|
||||
|
||||
$shortRoute = $this->prophesize(Route::class);
|
||||
$shortRoute->register(Argument::cetera());
|
||||
$shortRoute->getTarget()->willReturn('/animals/*');
|
||||
$shortRoute->getType()->willReturn(Route::TYPE_PREFIX);
|
||||
$shortRoute->__invoke(Argument::cetera())->willReturn(new Response());
|
||||
|
||||
$longRoute = $this->prophesize(Route::class);
|
||||
$longRoute->register(Argument::cetera());
|
||||
$longRoute->getTarget()->willReturn('/animals/cats/*');
|
||||
$longRoute->getType()->willReturn(Route::TYPE_PREFIX);
|
||||
$longRoute->__invoke(Argument::cetera())->willReturn(new Response());
|
||||
|
||||
$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->dispatch();
|
||||
|
||||
$longRoute->__invoke(Argument::cetera())
|
||||
->shouldHaveBeenCalled();
|
||||
}
|
||||
|
||||
public function testDispatchesPrefixRouteBeforePatternRoute(): void
|
||||
{
|
||||
$prefixRoute = $this->prophesize(Route::class);
|
||||
$prefixRoute->register(Argument::cetera());
|
||||
$prefixRoute->getTarget()->willReturn('/cats/*');
|
||||
$prefixRoute->getType()->willReturn(Route::TYPE_PREFIX);
|
||||
$prefixRoute->__invoke(Argument::cetera())->willReturn(new Response());
|
||||
|
||||
$patternRoute = $this->prophesize(Route::class);
|
||||
$patternRoute->register(Argument::cetera());
|
||||
$patternRoute->getTarget()->willReturn('/cats/{id}');
|
||||
$patternRoute->getType()->willReturn(Route::TYPE_PATTERN);
|
||||
$patternRoute->__invoke(Argument::cetera())->willReturn(new Response());
|
||||
|
||||
$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->dispatch();
|
||||
|
||||
$prefixRoute->__invoke(Argument::cetera())
|
||||
->shouldHaveBeenCalled();
|
||||
}
|
||||
|
||||
public function testDispatchesFirstMatchingPatternRoute(): void
|
||||
{
|
||||
$patternRoute1 = $this->prophesize(Route::class);
|
||||
$patternRoute1->register(Argument::cetera());
|
||||
$patternRoute1->getTarget()->willReturn('/cats/{id}');
|
||||
$patternRoute1->getType()->willReturn(Route::TYPE_PATTERN);
|
||||
$patternRoute1->getPathVariables()->willReturn([]);
|
||||
$patternRoute1->matchesRequestTarget(Argument::any())->willReturn(true);
|
||||
$patternRoute1->__invoke(Argument::cetera())->willReturn(new Response());
|
||||
|
||||
$patternRoute2 = $this->prophesize(Route::class);
|
||||
$patternRoute2->register(Argument::cetera());
|
||||
$patternRoute2->getTarget()->willReturn('/cats/{name}');
|
||||
$patternRoute2->getType()->willReturn(Route::TYPE_PATTERN);
|
||||
$patternRoute2->getPathVariables()->willReturn([]);
|
||||
$patternRoute2->matchesRequestTarget(Argument::any())->willReturn(true);
|
||||
$patternRoute2->__invoke(Argument::cetera())->willReturn(new Response());
|
||||
|
||||
$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->dispatch();
|
||||
|
||||
$patternRoute1->__invoke(Argument::cetera())
|
||||
->shouldHaveBeenCalled();
|
||||
}
|
||||
|
||||
public function testStopsTestingPatternsAfterFirstSuccessfulMatch(): void
|
||||
{
|
||||
$patternRoute1 = $this->prophesize(Route::class);
|
||||
$patternRoute1->register(Argument::cetera());
|
||||
$patternRoute1->getTarget()->willReturn('/cats/{id}');
|
||||
$patternRoute1->getType()->willReturn(Route::TYPE_PATTERN);
|
||||
$patternRoute1->getPathVariables()->willReturn([]);
|
||||
$patternRoute1->matchesRequestTarget(Argument::any())->willReturn(true);
|
||||
$patternRoute1->__invoke(Argument::cetera())->willReturn(new Response());
|
||||
|
||||
$patternRoute2 = $this->prophesize(Route::class);
|
||||
$patternRoute2->register(Argument::cetera());
|
||||
$patternRoute2->getTarget()->willReturn('/cats/{name}');
|
||||
$patternRoute2->getType()->willReturn(Route::TYPE_PATTERN);
|
||||
$patternRoute2->getPathVariables()->willReturn([]);
|
||||
$patternRoute2->matchesRequestTarget(Argument::any())->willReturn(true);
|
||||
$patternRoute2->__invoke(Argument::cetera())->willReturn(new Response());
|
||||
|
||||
$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->dispatch();
|
||||
|
||||
$patternRoute2->matchesRequestTarget(Argument::any())
|
||||
->shouldNotHaveBeenCalled();
|
||||
}
|
||||
|
||||
public function testMatchesPathAgainstRouteWithoutQuery(): void
|
||||
{
|
||||
$path = '/my/path';
|
||||
$target = $path . '?cat=molly&dog=bear';
|
||||
|
||||
$this->request = $this->request->withRequestTarget($target);
|
||||
|
||||
$this->route->getTarget()->willReturn($target);
|
||||
$this->route->getType()->willReturn(Route::TYPE_PATTERN);
|
||||
$this->route->matchesRequestTarget(Argument::cetera())->willReturn(true);
|
||||
|
||||
$this->router->register('GET', $path, 'middleware');
|
||||
|
||||
$this->dispatch();
|
||||
|
||||
$this->route->matchesRequestTarget($path)->shouldHaveBeenCalled();
|
||||
}
|
||||
|
||||
public function testMatchesPathWithDuplicateLeadingSlashes(): void
|
||||
{
|
||||
$path = '//my/path';
|
||||
|
||||
$this->request = $this->request->withRequestTarget($path);
|
||||
|
||||
$this->route->getTarget()->willReturn($path);
|
||||
$this->route->getType()->willReturn(Route::TYPE_PATTERN);
|
||||
$this->route->matchesRequestTarget(Argument::cetera())->willReturn(true);
|
||||
|
||||
$this->router->register('GET', $path, 'middleware');
|
||||
|
||||
$this->dispatch();
|
||||
|
||||
$this->route->matchesRequestTarget($path)->shouldHaveBeenCalled();
|
||||
}
|
||||
|
||||
// -------------------------------------------------------------------------
|
||||
// Path Variables
|
||||
|
||||
/**
|
||||
* @dataProvider pathVariableProvider
|
||||
* @param string $name
|
||||
* @param string $value
|
||||
*/
|
||||
public function testSetPathVariablesAttributeIndividually(string $name, string $value): void
|
||||
{
|
||||
$target = '/';
|
||||
$variables = [
|
||||
'id' => '1024',
|
||||
'name' => 'Molly'
|
||||
];
|
||||
|
||||
$this->request = $this->request->withRequestTarget($target);
|
||||
|
||||
$this->route->getTarget()->willReturn($target);
|
||||
$this->route->getType()->willReturn(Route::TYPE_PATTERN);
|
||||
$this->route->matchesRequestTarget(Argument::cetera())->willReturn(true);
|
||||
$this->route->getPathVariables()->willReturn($variables);
|
||||
|
||||
$this->router->register('GET', $target, 'middleware');
|
||||
|
||||
$this->dispatch();
|
||||
|
||||
$isRequestWithExpectedAttribute = function ($request) use ($name, $value) {
|
||||
return $request->getAttribute($name) === $value;
|
||||
};
|
||||
|
||||
$this->route->__invoke(
|
||||
Argument::that($isRequestWithExpectedAttribute),
|
||||
Argument::cetera()
|
||||
)->shouldHaveBeenCalled();
|
||||
}
|
||||
|
||||
public function pathVariableProvider(): array
|
||||
{
|
||||
return [
|
||||
['id', '1024'],
|
||||
['name', 'Molly']
|
||||
];
|
||||
}
|
||||
|
||||
public function testSetPathVariablesAttributeAsArray(): void
|
||||
{
|
||||
$attributeName = 'pathVariables';
|
||||
|
||||
$target = '/';
|
||||
$variables = [
|
||||
'id' => '1024',
|
||||
'name' => 'Molly'
|
||||
];
|
||||
|
||||
$this->request = $this->request->withRequestTarget($target);
|
||||
|
||||
$this->route->getTarget()->willReturn($target);
|
||||
$this->route->getType()->willReturn(Route::TYPE_PATTERN);
|
||||
$this->route->matchesRequestTarget(Argument::cetera())->willReturn(true);
|
||||
$this->route->getPathVariables()->willReturn($variables);
|
||||
|
||||
$this->router = new Router(
|
||||
$attributeName,
|
||||
new Dispatcher(),
|
||||
$this->factory->reveal()
|
||||
);
|
||||
|
||||
$this->router->register('GET', $target, 'middleware');
|
||||
|
||||
$this->dispatch();
|
||||
|
||||
$isRequestWithExpectedAttribute = function ($request) use ($attributeName, $variables) {
|
||||
return $request->getAttribute($attributeName) === $variables;
|
||||
};
|
||||
|
||||
$this->route->__invoke(
|
||||
Argument::that($isRequestWithExpectedAttribute),
|
||||
Argument::cetera()
|
||||
)->shouldHaveBeenCalled();
|
||||
}
|
||||
|
||||
// -------------------------------------------------------------------------
|
||||
// No Match
|
||||
|
||||
public function testWhenNoRouteMatchesByDefaultResponds404(): void
|
||||
{
|
||||
$this->request = $this->request->withRequestTarget('/no/match');
|
||||
|
||||
$response = $this->dispatch();
|
||||
|
||||
$this->assertEquals(404, $response->getStatusCode());
|
||||
}
|
||||
|
||||
public function testWhenNoRouteMatchesByDefaultDoesNotPropagatesToNextMiddleware(): void
|
||||
{
|
||||
$this->request = $this->request->withRequestTarget('/no/match');
|
||||
|
||||
$this->dispatch();
|
||||
|
||||
$this->assertFalse($this->next->called);
|
||||
}
|
||||
|
||||
public function testWhenNoRouteMatchesAndContinueModePropagatesToNextMiddleware(): void
|
||||
{
|
||||
$this->request = $this->request->withRequestTarget('/no/match');
|
||||
$this->router->continueOnNotFound();
|
||||
|
||||
$this->dispatch();
|
||||
|
||||
$this->assertTrue($this->next->called);
|
||||
}
|
||||
|
||||
// -------------------------------------------------------------------------
|
||||
// Middleware for Routes
|
||||
|
||||
public function testCallsRouterMiddlewareBeforeRouteMiddleware(): void
|
||||
{
|
||||
$middlewareRequest = new ServerRequest();
|
||||
$middlewareResponse = new Response();
|
||||
|
||||
$middleware = function ($rqst, $resp, $next) use (
|
||||
$middlewareRequest,
|
||||
$middlewareResponse
|
||||
) {
|
||||
return $next($middlewareRequest, $middlewareResponse);
|
||||
};
|
||||
|
||||
$this->router->add($middleware);
|
||||
$this->router->register('GET', '/', 'Handler');
|
||||
|
||||
$this->dispatch();
|
||||
|
||||
$this->route->__invoke(
|
||||
$middlewareRequest,
|
||||
$middlewareResponse,
|
||||
Argument::any()
|
||||
)->shouldHaveBeenCalled();
|
||||
}
|
||||
|
||||
public function testDoesNotCallRouterMiddlewareWhenNoRouteMatches(): void
|
||||
{
|
||||
$middlewareCalled = false;
|
||||
$middlewareRequest = new ServerRequest();
|
||||
$middlewareResponse = new Response();
|
||||
|
||||
$middleware = function ($rqst, $resp, $next) use (
|
||||
$middlewareRequest,
|
||||
$middlewareResponse,
|
||||
&$middlewareCalled
|
||||
) {
|
||||
$middlewareCalled = true;
|
||||
return $next($middlewareRequest, $middlewareResponse);
|
||||
};
|
||||
|
||||
$this->request = $this->request->withRequestTarget('/no/match');
|
||||
|
||||
$this->router->add($middleware);
|
||||
$this->router->register('GET', '/', 'Handler');
|
||||
|
||||
$this->dispatch();
|
||||
|
||||
$this->assertFalse($middlewareCalled);
|
||||
}
|
||||
}
|
||||
Loading…
Reference in New Issue