Compare commits

...

105 Commits

Author SHA1 Message Date
Andrei V. Goryunov ca3bb2cb0a upgrade to wellrested v5.1.1, fix 2022-07-29 09:51:37 +03:00
Andrei V. Goryunov c5f49214b5 upgrade to wellrested 5.1.1 2022-07-27 11:32:47 +03:00
Basemaster c153bc0028
provide interfaces prs/http-*-implementation 2021-04-11 14:04:34 +03:00
Andy Green e22d5889b0 back to php 7.2 - remove CI environment 2021-04-11 11:56:55 +03:00
Basemaster fb2b2ab527
Update composer.json 2021-04-11 11:47:52 +03:00
Andy Green 00ea49ded6 remove require-dev dependency 2021-04-11 11:45:07 +03:00
Basemaster 4c4b6104e4
Update README.md 2021-04-11 11:36:14 +03:00
Basemaster 6b31620314
Update README.md 2021-04-11 11:34:37 +03:00
Andy Green e6bb814a76 back to php 7.2 2021-04-11 11:30:03 +03:00
PJ Dietz 19c03b9b8b
Merge pull request #22 from wellrestedphp/fix-travis
Add xdebug.ini for Travis
2021-01-24 14:46:29 -05:00
PJ Dietz b94b01453a Add xdebug.ini for Travis 2021-01-24 14:09:01 -05:00
PJ Dietz 9db267c427 Update XDebug configuration 2021-01-22 15:56:32 -05:00
PJ Dietz 8379dd69a0 Fix copyright date in docs 2021-01-22 14:06:56 -05:00
PJ Dietz 9a4b78b84a
Merge pull request #21 from wellrestedphp/fix-extra-leading-slash-in-path
Fix issue in Router with paths beginning with multiple slashes
2020-08-27 12:41:51 -04:00
PJ Dietz 2c80da2f79 Fix issue in Router with paths beginning with multiple slashes 2020-08-27 12:29:25 -04:00
PJ Dietz a15b5396e9 Fix php-cs-fixer instructions in README 2020-08-16 18:33:26 -04:00
PJ Dietz aeb9d733cc
Merge pull request #20 from wellrestedphp/v5
V5
2020-08-16 18:31:10 -04:00
PJ Dietz c74a468f3e Update documentation for v5 2020-08-16 18:03:17 -04:00
PJ Dietz 84b4bce04f Merge branch 'master' into v5 2020-08-16 17:48:13 -04:00
PJ Dietz 337baa2e26
Merge pull request #19 from wellrestedphp/archive
Archive
2020-08-16 17:41:05 -04:00
PJ Dietz bba0602122 Update README for v5 2020-08-16 17:39:41 -04:00
PJ Dietz 66ff6d2fc1
Merge pull request #18 from wellrestedphp/fix-tests
Fix broken test for Stream
2020-08-16 12:11:56 -04:00
PJ Dietz 198ebb60f7 Fix broken test for Stream 2020-08-16 12:08:57 -04:00
PJ Dietz 8f2206a65f Set min verision for Travis to 7.3 2020-08-16 11:55:00 -04:00
PJ Dietz 8b467193d7 Set minimum version to PHP 7.3 2020-08-16 11:54:28 -04:00
PJ Dietz 95c3be85c9 Create implementations for PSR-17 Response- and StreamFactoryInterface 2020-08-16 10:48:42 -04:00
PJ Dietz 9243dd7663 Refactor ServerRequestMarshaller and ServerRequest 2020-08-16 08:52:33 -04:00
PJ Dietz 20012dc671 Message constructor accepts $headers values as string or string[] 2020-08-16 08:49:47 -04:00
PJ Dietz 79d23e37a4 Reorganize Tests 2020-08-15 10:11:06 -04:00
PJ Dietz 5ba8771e93 Ensure all constants have visibility 2020-08-15 07:54:08 -04:00
PJ Dietz fe0f1ff8f9 Ensure typehints for bool are bool and not boolean 2020-08-15 07:53:03 -04:00
PJ Dietz 36df1f33c1 Refactor URI; fix coverage on UploadedFile 2020-08-15 07:51:30 -04:00
PJ Dietz c137a2066a Minor change to Server docblock 2020-08-15 07:24:57 -04:00
PJ Dietz 1d71f06e71 Router accepts custom RouteFactory through constructor; removes protected methods 2020-08-15 07:18:54 -04:00
PJ Dietz 997582f8d7 Router implements MiddlewareInterface; cleanup Router test 2020-08-14 07:49:33 -04:00
PJ Dietz 56503da35e Remove RouteFactoryInterface 2020-08-14 07:44:00 -04:00
PJ Dietz 79c4799a7b Clean up tests for routes 2020-08-14 07:38:38 -04:00
PJ Dietz fec5a4d405 Remove RouteInterface 2020-08-14 07:24:00 -04:00
PJ Dietz 4eec56b582 Mark Routing\Route classes as @internal 2020-08-14 07:00:50 -04:00
PJ Dietz c75168afae Stop tracking .env and set default in docker-compose.yml 2020-08-14 06:57:13 -04:00
PJ Dietz 288705b77a Edit comments for Dispatch namespace and clean up tests 2020-08-14 06:31:09 -04:00
PJ Dietz f542aaf3a9 Normalize length of dividers 2020-08-13 07:38:00 -04:00
PJ Dietz 2d7db1ed83 Change visibility from protected to private where possible 2020-08-13 07:36:30 -04:00
PJ Dietz 4796e1d5c5 Refactor Transmitter 2020-08-13 07:26:19 -04:00
PJ Dietz 8649090774 Fix visibility for setUp, tearDown to match PHPUnit base class 2020-08-13 07:13:14 -04:00
PJ Dietz d8294d3ac3 Refactor Uri 2020-08-13 07:08:41 -04:00
PJ Dietz 899ebb2492 Move UploadedFileState test components into test file 2020-08-13 06:37:51 -04:00
PJ Dietz 83c2290a2f Refactor streams 2020-08-13 06:21:19 -04:00
PJ Dietz 4a3545cd3c Refactor Message classes 2020-08-12 07:42:33 -04:00
PJ Dietz 2e3475b882 Refactor HeaderCollection 2020-08-12 07:12:42 -04:00
PJ Dietz 168867206e Extract server request marshalling to own class. 2020-08-12 06:49:10 -04:00
PJ Dietz cd2e4448e2 Update CS rules 2020-08-11 06:41:48 -04:00
PJ Dietz e6d1398bb1 Normalize imports for global namespace 2020-08-10 07:31:06 -04:00
PJ Dietz ff28f3c6eb Update CS rules 2020-08-10 07:30:04 -04:00
PJ Dietz 002bdb7541 Convert simple string literals to single quotes 2020-08-10 07:13:50 -04:00
PJ Dietz fb18d2ee1e Code style fixes 2020-08-10 07:09:48 -04:00
PJ Dietz a73ad17ddd Add php-cs-fixer as dev dependency 2020-08-10 06:48:32 -04:00
PJ Dietz d98789ebfd Fix test broken by Transmitter change 2020-08-09 14:54:26 -04:00
PJ Dietz 09dd1d7a32 Add type hints to Server; construct defaults for most dependencies 2020-08-09 14:51:43 -04:00
PJ Dietz 98014d8c59 Add type hints to Transmitter 2020-08-09 14:30:19 -04:00
PJ Dietz ca204a07e7 Add type hints to Router 2020-08-09 14:27:29 -04:00
PJ Dietz 967b6ac2a4 Add type hints for Routes 2020-08-09 13:58:24 -04:00
PJ Dietz c339512f01 Add type hints to Stream, UploadedFile, and Uri 2020-08-09 13:29:05 -04:00
PJ Dietz 7ade042b4b Change Request constructor signature
Various updates to Message classes
2020-08-09 13:10:14 -04:00
PJ Dietz bdc5ac40d9 Add notes to .gitignore 2020-08-09 13:08:50 -04:00
PJ Dietz ecc077a1be Add type hints to Dispatch classes 2020-08-09 11:45:41 -04:00
PJ Dietz e9fb474eb7 Fix minor issues found by Psalm 2020-08-09 11:08:33 -04:00
PJ Dietz a7b08ad8a3 Stream detects read/write more accurately; fix issues after detach() 2020-08-09 10:55:37 -04:00
PJ Dietz fe780e6b92 Set Psalm error level to 3; fix possibly null reason phrase in Response 2020-08-09 10:54:26 -04:00
PJ Dietz 29cfa34f17 Set minimum PHP version to 7.2 2020-08-09 10:52:47 -04:00
PJ Dietz 08ddb0aa2f Fix issues detected by Psalm 2020-08-08 12:05:33 -04:00
PJ Dietz 2cf65def5c Configure Psalm 2020-08-08 12:05:18 -04:00
PJ Dietz 4485675c11 Use ProphecyTrait in tests with Prophecy mocks 2020-08-08 10:59:46 -04:00
PJ Dietz fbd1c10ebe Upgrade PHPUnit to v9 2020-08-08 10:59:18 -04:00
PJ Dietz e320e7e6c3 Do not include composer.lock in archive 2020-08-08 10:27:19 -04:00
PJ Dietz c7b2c335a6 Update .gitattributes to reduce archive size 2020-08-08 10:17:56 -04:00
PJ Dietz 0bea30f434 Fix issue when reading Stream size and fstat fails 2020-05-01 10:45:10 -04:00
PJ Dietz d1c7076929 ServerRequest does not include empty Content-type and -length headers 2020-03-17 12:10:20 -04:00
PJ Dietz d78537809b
Merge pull request #16 from gintechsystems/master
Content Headers Bug Fix / PHP Unit 8.5
2020-02-06 10:31:10 -05:00
Joe Ginley a1a0dc0f45 Added server request test against content headers.
Updated getServerRequestHeaders to be more efficient and accurate.
Wrong variable used in dependency injection documentation.
2020-02-05 18:43:06 -05:00
Joe Ginley 17c58ae362 Added php minimum version badge and removed the requirements text.
Updated composer libraries, fixed phpunit errors after updating.
Updated docker-compose version.
Updated docker to use php 7.4.
2020-02-04 00:05:42 -05:00
Joe Ginley f6a273dbb5 Updated apache request headers to return if available, when false return empty array so nothing breaks. 2020-02-03 22:48:26 -05:00
Joe Ginley 2eaa8c8697 Added 7.4 to travis.yml.
Fixed a bug where not all request headers were available when running under apache server.
2020-02-03 22:44:09 -05:00
PJ Dietz 645bcf227c Upgrade PHPUnit to v8 2019-06-17 16:04:55 -04:00
PJ Dietz e4cc02dc8a Fix link in documentation; fix version in README 2019-06-17 15:01:42 -04:00
PJ Dietz e558d613ab Documentation edits 2018-08-02 16:27:51 -04:00
PJ Dietz e676a17cac Rename Router->addMiddleware to Router->add 2018-06-29 16:29:46 -04:00
PJ Dietz 677cdb4d7d Change Router::continue to Router::continueOnNotFound; update docs 2018-06-28 16:52:36 -04:00
PJ Dietz 0a0d3c3bc9 Router responds 404 by default for non-matched routes 2018-06-28 09:46:59 -04:00
PJ Dietz 36b03b6ca2 Update documentation for version 4.0 2018-06-26 16:51:33 -04:00
PJ Dietz de46c8e089 Rework Server to be configured with setters 2018-06-25 15:46:37 -04:00
PJ Dietz be3d007961 Set a default chunk size for Transmitter 2018-06-25 09:11:58 -04:00
PJ Dietz 64628c4065 Move MethodMap to Route namespace 2018-06-22 15:54:01 -04:00
PJ Dietz ac8bdce037 Remove MethodMapInterface 2018-06-22 15:10:50 -04:00
PJ Dietz 73b6e4ab83 Router registers handlers directly with routes 2018-06-22 14:53:03 -04:00
PJ Dietz 9b29f2a09e Add Route::register method to delegate to MethodMap 2018-06-22 14:44:43 -04:00
PJ Dietz 72d5df244d Clean up MessageTest and documentation for Message classes 2018-06-22 13:43:44 -04:00
PJ Dietz b82ebf6d95 Update comments and documentation for Dispatcher and related classes 2018-06-22 12:17:30 -04:00
PJ Dietz 5e9e7f154b Update Routing integration test 2018-06-21 16:53:17 -04:00
PJ Dietz 9aab0d780e Router can provide middleware called only for matched routes. 2018-06-21 16:00:11 -04:00
PJ Dietz 29cad3687e Router delegates on failure and does not return 404 2018-06-21 12:48:11 -04:00
PJ Dietz f016b74c38 Server responds with a default 404 response when request is unhandled 2018-06-21 12:48:11 -04:00
PJ Dietz 6f247bccfa Make local dev site port configurable 2018-06-21 12:48:11 -04:00
PJ Dietz 9ce784c897 Update Docker images and add dumb-init 2018-06-21 12:48:11 -04:00
PJ Dietz 04c7b100db Upgrade PHPUnit to v7 2018-06-21 10:20:33 -04:00
105 changed files with 6061 additions and 6630 deletions

15
.gitattributes vendored
View File

@ -1,8 +1,15 @@
/.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
/test export-ignore
/phpunit.xml.dist export-ignore
/Vagrantfile export-ignore
/vagrant export-ignore
/tests export-ignore
/phpunit.xml* export-ignore
/psalm.xml export-ignore
/public export-ignore
/vendor export-ignore

14
.gitignore vendored
View File

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

View File

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

View File

@ -1,16 +1,20 @@
WellRESTed
==========
[![Build Status](https://travis-ci.org/wellrestedphp/wellrested.svg?branch=master)](https://travis-ci.org/wellrestedphp/wellrested)
[![Minimum PHP Version](https://img.shields.io/badge/php-%3E%3D7.2-blue)](https://php.net/)
[![Documentation Status](https://readthedocs.org/projects/wellrested/badge/?version=latest)](http://wellrested.readthedocs.org/en/latest/)
[![SensioLabsInsight](https://insight.sensiolabs.com/projects/b0a2efcb-49f8-4a90-a5bd-0c14e409f59e/mini.png)](https://insight.sensiolabs.com/projects/b0a2efcb-49f8-4a90-a5bd-0c14e409f59e)
WellRESTed is a library for creating RESTful Web services and websites in PHP.
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.
Requirements
------------
This fork (basemaster/wellrested) is back to php 7.2 release.
- PHP 7.0
### 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.
Install
-------
@ -20,7 +24,7 @@ Add an entry for "wellrested/wellrested" to your composer.json file's `require`
```json
{
"require": {
"wellrested/wellrested": "~3.1"
"wellrested/wellrested": "^5"
}
}
```
@ -59,14 +63,14 @@ class HomePageHandler implements RequestHandlerInterface
// -----------------------------------------------------------------------------
// Create a new server.
// Create a new Server instance.
$server = new Server();
// Add a router to the server to map methods and endpoints to handlers.
$router = $server->createRouter();
$router->register('GET', '/', new HomePageHandler());
// Register the route GET / with an anonymous function that provides a handler.
$router->register("GET", "/", function () { return new HomePageHandler(); });
// Add the router to the server.
$server->add($router);
// Read the request from the client, dispatch a handler, and output.
$server->respond();
```
@ -89,6 +93,18 @@ 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
@ -108,5 +124,5 @@ The runs a site you can access at [http://localhost:8080](http://localhost:8080)
Copyright and License
---------------------
Copyright © 2018 by PJ Dietz
Copyright © 2020 by PJ Dietz
Licensed under the [MIT license](http://opensource.org/licenses/MIT)

View File

@ -1,8 +1,7 @@
{
"name": "wellrested/wellrested",
"description": "Simple PHP Library for RESTful APIs",
"keywords": ["rest", "restful", "api", "http", "psr7", "psr-7"],
"homepage": "https://www.wellrested.org",
"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"],
"license": "MIT",
"type": "library",
"authors": [
@ -12,13 +11,15 @@
}
],
"require": {
"php": ">=7.0",
"php": ">=7.2",
"psr/http-factory": "~1.0",
"psr/http-message": "~1.0",
"psr/http-server-handler": "~1.0",
"psr/http-server-middleware": "~1.0"
},
"require-dev": {
"phpunit/phpunit": "^6"
"provide": {
"psr/http-message-implementation": "1.0",
"psr/http-factory-implementation": "1.0"
},
"autoload": {
"psr-4": {

1555
composer.lock generated

File diff suppressed because it is too large Load Diff

View File

@ -1,32 +0,0 @@
version: '2'
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.13
ports:
- 8080:80
volumes:
- .:/usr/local/src/wellrested
- ./docker/nginx/site.conf:/etc/nginx/conf.d/default.conf
php-fpm:
image: php:7.1-fpm
volumes:
- .:/usr/local/src/wellrested

View File

@ -1,7 +0,0 @@
FROM python:3-jessie
RUN pip install sphinx sphinx_rtd_theme
WORKDIR /usr/local/src/wellrested
CMD ["make", "html", "-C", "docs"]

View File

@ -1,31 +0,0 @@
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;
}
}

View File

@ -1,42 +0,0 @@
FROM php:7.1-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
# Download and install Composer
COPY ./docker/php/install-composer.sh /tmp/install-composer.sh
RUN chmod +x /tmp/install-composer.sh; sync && \
/tmp/install-composer.sh && \
rm /tmp/install-composer.sh
# 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 && \
mkdir /var/www && \
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
# Install Composer dependencies
RUN composer install

View File

@ -1,16 +0,0 @@
#!/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

View File

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

View File

@ -25,9 +25,9 @@ master_doc = 'index'
# General information about the project.
project = u'WellRESTed'
copyright = u'2018, PJ Dietz'
version = '3.1.0'
release = '3.1.0'
copyright = u'2021, PJ Dietz'
version = '5.0.0'
release = '5.0.0'
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.

View File

@ -14,7 +14,7 @@ Imaging we have a ``FooHandler`` that depends on a ``BarInterface``, and ``BazIn
private $bar;
private $baz;
public function __construct(BarInterface $bar, BazInterface $bar)
public function __construct(BarInterface $bar, BazInterface $baz)
{
$this->bar = $bar;
$this->baz = $baz;
@ -52,6 +52,12 @@ We can register the handler and these dependencies in a Pimple_ service provider
}
}
To register this handler with a router, we can pass the service:
.. code-block:: php
$router->register('GET', '/foo', $c['fooHandler']);
By "protecting" the ``fooHandler`` service, we are delaying the instantiation of the ``FooHandler``, the ``Bar``, and the ``Baz`` until the handler needs to be dispatched. This works because we're not passing instance of ``FooHandler`` when we register this with a router, we're passing a function to it that does the instantiation on demand.
.. _Pimple: https://pimple.symfony.com/

View File

@ -51,7 +51,7 @@ Custom Dispatcher
Wrapping works well when you have one or two handlers implementing a third-party interface. If you want to integrate a lot of classes that implement a given third-party interface, you're might consider customizing the dispatcher.
The dispatcher is an instance that unpacks your handlers and middleware and sends the request and response through it. A default dispatcher is created for you when you instantiate your ``WellRESTed\Server`` (without passing the second argument). The server instantiates a ``WellRESTed\Dispatching\Dispatcher`` which is capable of running handlers and middleware as described in the `Handlers and Middleware`_.
The dispatcher is an instance that unpacks your handlers and middleware and sends the request and response through it. A default dispatcher is created for you when you use your ``WellRESTed\Server``.
If you need the ability to dispatch other types of middleware, you can create your own by implementing ``WellRESTed\Dispatching\DispatcherInterface``. The easiest way to do this is to subclass ``WellRESTed\Dispatching\Dispatcher``. Here's an example that extends ``Dispatcher`` and adds support for ``OtherHandlerInterface``:
@ -73,7 +73,7 @@ If you need the ability to dispatch other types of middleware, you can create yo
$response = parent::dispatch($dispatchable, $request, $response, $next);
} catch (\WellRESTed\Dispatching\DispatchException $e) {
// If there's a problem, check if the handler or middleware
// (the "dispatchable") implements OtherHandlerInterface.
// (the "dispatchable") implements OtherHandlerInterface.
// Dispatch it if it does.
if ($dispatchable instanceof OtherHandlerInterface) {
$response = $dispatchable->run($request);
@ -86,59 +86,16 @@ If you need the ability to dispatch other types of middleware, you can create yo
}
}
To use this dispatcher, pass it to the constructor of ``WellRESTed\Server`` as the second argument. (The first argument is a hash array to use as `request attributes`_.)
To use this dispatcher, create an instance implementing ``WellRESTed\Dispatching\DispatcherInterface`` and pass it to the server's ``setDispatcher`` method.
.. code-block:: php
// Create an instance of your custom dispatcher.
$dispatcher = new MyApi\CustomDispatcher;
// Pass this dispatcher to the server.
$server = new WellRESTed\Server(null, $dispatcher);
// Now, you can add any handlers implementing OtherHandlerInterface
$other = new OtherHandler();
$server->add($other);
Message Customization
---------------------
In the example above, we passed a custom dispatcher to the server. You can also customize your server in other ways. For example, if you have a different implementation of PSR-7_ messages that you prefer, you can pass them into the ``Server::respond`` method:
.. code-block:: php
// Represents the request submitted by the client.
$request = new ThirdParty\Request();
// A "blank" response.
$response = new ThirdParty\Response();
$server = new WellRESTed\Server();
// ...add middleware and handlers...
$server->setDispatcher(new MyApi\CustomDispatcher());
// Pass your request and response to Server::respond
$server->response($request, $response);
.. warning::
Even if you don't want to use a different implementation, you may still find a reason to provide you're own messages. For example, the default response status code for a ``WellRESTed\Message\Response`` is 500. If you wanted to make the default 200 instead, you could do something like this:
.. code-block:: php
// The first argument is the status code.
$response = new \WellRESTed\Message\Response(200);
$server = new \WellRESTed\Server();
// ...add middleware...
// Pass the response to respond()
$server->respond(null, $response);
Server Customization
--------------------
As an alternative to passing you preferred request and response instances into ``Server::respond``, you can extend ``Server`` to obtain default values from a different source.
Classes such as ``Server`` that create dependencies as defaults keep the instantiation isolated in easy-to-override methods. For example, ``Server`` has a protected method ``getResponse`` that instantiates and returns a new response. You can easily replace this method with your own that returns the default response of your choice.
In addition to the messages, you can do similar customization for other ``Server`` dependencies such as the dispatcher (see above), the transmitter (which writes the response out to the client), and the routers that are created with ``Server::createRouter``. These dependencies are instantiated in isolated methods as with the request and response to make this sort of customization easy, and other classes such as ``Router`` use this pattern as well.
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``.
.. _PSR-7: https://www.php-fig.org/psr/psr-7/
.. _Handlers and Middleware: handlers-and-middleware.html

View File

@ -3,12 +3,12 @@ Getting Started
This page provides a brief introduction to WellRESTed. We'll take a tour of some of the features of WellRESTed without getting into too much depth.
To start, we'll make a "`Hello, world!`_" to demonstrate the concepts of handlers and routing and show how to read variables from the request path.
To start, we'll make a "Hello, world!" to demonstrate the concepts of handlers and routing and show how to read variables from the request path.
Hello, World!
^^^^^^^^^^^^^
Let's start with a very basic "Hello, world!". Here, we will create a server. A ``WellRESTed\Server`` reads the incoming request from the client, dispatches a handler, and transmits a response back to the client.
Let's start with a very basic "Hello, world!" Here, we will create a server. A ``WellRESTed\Server`` reads the incoming request from the client, dispatches a handler, and transmits a response back to the client.
Our handler will create and return a response with the status code set to ``200`` and the body set to "Hello, world!".
@ -58,7 +58,7 @@ Routing by Path
This is a good start, but it provides the same response to every request. Let's provide this response only when a client sends a request to ``/hello``.
For this, we need a router_. A router_ examines the request and sends the request through to the handler that mataches the request's HTTP method and path.
For this, we need a router_. A router_ examines the request and sends the request through to the handler that matches the request's HTTP method and path.
.. _`Example 2`:
.. rubric:: Example 2: Routed "Hello, world!"
@ -119,7 +119,9 @@ Routes can be static (like the one above that matches only ``/hello``), or they
Middleware
^^^^^^^^^^
In addition to handlers, WellRESTed also supports middlware. Middleware allows you to compose your application in multiple pieces. In the example, we'll use middleware to add a header to every responce, regardless of which handler is called.
In addition to handlers, which provide responses directly, WellRESTed also supports middleware to act on the requests and then pass them on for other middleware or handlers to work with.
Middleware allows you to compose your application in multiple pieces. In the example, we'll use middleware to add a header to every response, regardless of which handler is called.
.. code-block:: php
@ -145,7 +147,7 @@ In addition to handlers, WellRESTed also supports middlware. Middleware allows y
// Create a server
$server = new Server();
// Add the header adding middleware to the server first so that it will
// Add the header-adding middleware to the server first so that it will
// forward requests on to the router.
$server->add(new CustomHeaderMiddleware());

View File

@ -9,7 +9,7 @@ Defining Handlers and Middleware
PSR-15 Interfaces
-----------------
The prefered method is to use the interfaces standardized by PSR-15_. This standard includes two interfaces, ``Psr\Http\Server\RequestHandlerInterface`` and ``Psr\Http\Server\MiddlewareInterface``.
The preferred method is to use the interfaces standardized by PSR-15_. This standard includes two interfaces, ``Psr\Http\Server\RequestHandlerInterface`` and ``Psr\Http\Server\MiddlewareInterface``.
Use ``RequestHandlerInterface`` for individual components that generate and return responses.
@ -42,7 +42,7 @@ Use ``MiddlewareInterface`` for classes that interact with other middleware and
public function process(
ServerRequestInterface $request,
RequestHandlerInterface $handler
): ResponseInterface
): ResponseInterface
{
// Inspect the request to see if there is a representation on hand.
@ -87,7 +87,7 @@ This interface serves for both handlers and middleware. It differs from the ``Ps
.. code-block:: php
function next($request, $resposnse): ResponseInterface
function next($request, $response): ResponseInterface
Call ``$next`` and pass ``$request`` and ``$response`` to forward the request to the next handler. ``$next`` will return the response from the handler. Here's the cache example above as a ``WellRESTed\MiddlewareInterface``.
@ -96,11 +96,11 @@ Call ``$next`` and pass ``$request`` and ``$response`` to forward the request to
class CacheMiddleware implements WellRESTed\MiddlewareInterface
{
public function __invoke(
ServerRequestInterface $request,
ResponseInterface $response,
ServerRequestInterface $request,
ResponseInterface $response,
$next
) {
// Inspect the request to see if there is a representation on hand.
$representation = $this->getCachedRepresentation($request);
if ($representation !== null) {
@ -154,7 +154,7 @@ You may also use a ``callable`` similar to the legacy ``WellRESTed\MiddlewareInt
Using Handlers and Middleware
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Methods that accept handlers and middleware (e.g., ``Server::add``, ``Router::register``) allow you to provide them in a number of ways. For example, you can provide an instance, a ``callable`` that provides an instance, or an ``array`` of handlers to use in sequence. The following examples will demonstrate all of the ways you can register handlers and middleware.
Methods that accept handlers and middleware (e.g., ``Server::add``, ``Router::register``) allow you to provide them in a number of ways. For example, you can provide an instance, a ``callable`` that returns an instance, or an ``array`` of middleware to use in sequence. The following examples will demonstrate all of the ways you can register handlers and middleware.
Factory Functions
-----------------
@ -163,7 +163,7 @@ The best method is to use a function that returns an instance of your handler. T
.. code-block:: php
$router->register("GET,PUT,DELETE", "/widgets/{id}",
$router->register("GET,PUT,DELETE", "/widgets/{id}",
function () { return new App\WidgetHandler() }
);
@ -183,7 +183,7 @@ If you're using ``Pimple``, a popular `dependency injection`_ container for PHP,
Instance
--------
WellRESTed also allows you to pass an instance of a handler directly. This may be useful for smaller handlers that don't require many dependencies, although it is generally better to use the factory callable approach.
WellRESTed also allows you to pass an instance of a handler directly. This may be useful for smaller handlers that don't require many dependencies, although the factory function approach is better in most cases.
.. code-block:: php
@ -202,11 +202,11 @@ For handlers that do not require any arguments passed to the constructor, you ma
.. code-block:: php
$router->register("GET,PUT,DELETE", "/widgets/{id}", App\WidgetHandler::class);
$router->register('GET,PUT,DELETE', '/widgets/{id}', App\WidgetHandler::class);
// ... or ...
$router->register("GET,PUT,DELETE", "/widgets/{id}", 'App\\WidgetHandler');
The class is not loaded, and no instances are created, until the route is matched and dispatched. However, the drawback to this approach is the there is no way to pass any arguments to the contructor.
$router->register('GET,PUT,DELETE', '/widgets/{id}', 'App\\WidgetHandler');
The class is not loaded, and no instances are created, until the route is matched and dispatched. However, the drawback to this approach is the there is no way to pass any arguments to the constructor.
Array
-----
@ -218,7 +218,7 @@ For example, imagine if we had a Pimple_ container with these services:
.. code-block:: php
$c['authMiddleware'] // Ensures the user is logged in
$c['cacheMiddlware'] // Provides a cached response if able
$c['cacheMiddleware'] // Provides a cached response if able
$c['widgetHandler'] // Provides a widget representation
We could provide these as a sequence by using an ``array``.
@ -227,7 +227,7 @@ We could provide these as a sequence by using an ``array``.
$router->register('GET', '/widgets/{id}', [
$c['authMiddleware'],
$c['cacheMiddlware'],
$c['cacheMiddleware'],
$c['widgetHandler']
]);

View File

@ -33,12 +33,12 @@ The middleware_ system allows you to build your Web service out of discrete, mod
Lazy Loading
^^^^^^^^^^^^
Handlers and middleware can be registered using `factory functions`_ so that they are only instantiated if needed. This way, a Web service with hundreds of handlers and middleware still only creates instances required for the current request-response cycle.
Handlers and middleware can be registered using `factory functions`_ so that they are only instantiated if needed. This way, a Web service with hundreds of handlers and middleware only creates instances required for the current request-response cycle.
Extensible
^^^^^^^^^^
All classes are coded to interfaces to allow you to provide your own implementations and use them in place of the built-in classes. For example, if your Web service needs to be able to dispatch middleware that implements a different interface, you can provide your own custom ``DispatcherInterface`` implementation.
Most classes are coded to interfaces to allow you to provide your own implementations and use them in place of the built-in classes. For example, if your Web service needs to be able to dispatch middleware that implements a third-party interface, you can provide your own custom ``DispatcherInterface`` implementation.
Example
-------
@ -61,7 +61,7 @@ The site will also provide an ``X-example: hello world`` using dedicated middlew
require_once 'vendor/autoload.php';
// Create a handler that will construct and return a response. We'll
// Create a handler that will construct and return a response. We'll
// register this handler with a server and router below.
class HelloHandler implements RequestHandlerInterface
{
@ -142,6 +142,6 @@ Contents
.. _PSR-7: https://www.php-fig.org/psr/psr-7/
.. _PSR-15: https://www.php-fig.org/psr/psr-15/
.. _factory functions: handlers-and-middleware.html#factory-functions
.. _middleware: handles-and-middleware.html
.. _middleware: handlers-and-middleware.html
.. _router: router.html
.. _URI Templates: uri-templates.html

View File

@ -1,7 +1,7 @@
Messages and PSR-7
==================
WellRESTed uses PSR-7_ as the interfaces for HTTP messages. This section provides an introduction to working with these interfaces and the implementations provided with WellRESTed. For more information, please read about PSR-7_.
WellRESTed uses the PSR-7_ interfaces for HTTP messages. This section provides an introduction to working with these interfaces and the implementations provided with WellRESTed. For more information, please read about PSR-7_.
Requests
--------
@ -12,7 +12,7 @@ Let's start with a very simple GET request to the path ``/cats/?color=orange``.
.. code-block:: http
GET /cats/ HTTP/1.1
GET /cats/?color=orange HTTP/1.1
Host: example.com
Cache-control: no-cache
@ -46,8 +46,6 @@ This example shows that you can use:
- ``getMethod()`` to read the HTTP verb (e.g., GET, POST, OPTIONS, DELETE)
- ``getQueryParams()`` to read the query as an associative array
Let's move on to some more interesting features.
Headers
^^^^^^^
@ -73,7 +71,7 @@ Call ``getHeaderLine($name)`` and pass the case-insensitive name of a header. Th
.. note::
All methods relating to headers treat header field name case insensitively.
All methods relating to headers treat header field names case insensitively.
Because HTTP messages may contain multiple headers with the same field name, ``getHeaderLine($name)`` has one other feature: If multiple headers with the same field name are present in the message, ``getHeaderLine($name)`` returns a string containing all of the values for that field, concatenated by commas. This is more common with responses, particularly with the ``Set-cookie`` header, but is still possible for requests.
@ -89,7 +87,7 @@ PSR-7_ provides access to the body of the request as a stream and—when possibl
Parsed Body
~~~~~~~~~~~
When the request contains form fields (i.e., the ``Content-type`` header is either ``application/x-www-form-urlencoded`` or ``multipart/form-data``), the request makes the form fields available via the ``getParsedBody`` method. This provides access to the fields without needing to rely on the ``$_POST`` superglobal.
For POST requests for forms (i.e., the ``Content-type`` header is either ``application/x-www-form-urlencoded`` or ``multipart/form-data``), the request makes the form fields available via the ``getParsedBody`` method. This provides access to the fields without needing to rely on the ``$_POST`` superglobal.
Given this request:
@ -168,7 +166,7 @@ We can read and parse the JSON body, and even provide it as the parsedBody for l
}
Because the entity body of a request or response can be very large, PSR-7_ represents bodies as streams using the ``Psr\Htt\Message\StreamInterface`` (see PSR-7_ Section 1.3).
Because the entity body of a request or response can be very large, PSR-7_ represents bodies as streams using the ``Psr\Http\Message\StreamInterface`` (see `PSR-7 Section 1.3`_).
The JSON example casts the stream to a string, but we can also do things like copy the stream to a local file:
@ -187,7 +185,7 @@ The JSON example casts the stream to a string, but we can also do things like co
Parameters
^^^^^^^^^^
PSR-7_ eliminates the need to read from many of the superglobals. We already saw how ``getParsedBody`` takes the place of reading directly from ``$_POST`` and ``getQueryParams`` replaces reading from ``$_GET``. Here are some other ``ServerRequestInterface`` methods with **brief** descriptions. Please see PSR-7_ for full details, particularly for ``getUploadedFiles``.
PSR-7_ eliminates the need to read from many of the superglobals. We already saw how ``getParsedBody`` takes the place of reading directly from ``$_POST`` and ``getQueryParams`` replaces reading from ``$_GET``. Here are some other ``ServerRequestInterface`` methods with brief descriptions. Please see PSR-7_ for full details, particularly for ``getUploadedFiles``.
.. list-table::
:header-rows: 1
@ -247,7 +245,7 @@ Middleware can also use attributes as a way to provide extra information to subs
): ResponseInterface
try {
$user = readUserFromCredentials($request);
$user = $this->readUserFromCredentials($request);
} catch (NoCredentialsSupplied $e) {
return $response->withStatus(401);
} catch (UserNotAllowedHere $e) {
@ -257,8 +255,7 @@ Middleware can also use attributes as a way to provide extra information to subs
// Store this as an attribute.
$request = $request->withAttribute("user", $user);
// Call the next handler, passing the request with the added attribute.
// Send the request to the next handler.
// Delegate to the handler, passing the request with the "user" attribute.
return $handler->handle($request);
}
};
@ -318,8 +315,7 @@ Provide the status code for your response with the ``withStatus`` method. When y
The "reason phrase" is the text description of the status that appears in the status line of the response. The "status line" is the very first line in the response that appears before the first header.
Although the PSR-7_ ``ResponseInterface::withStatus`` method accepts the reason phrase as an optional second parameter, you generally shouldn't pass anything unless you are using a non-standard status code. (And you probably shouldn't be using a non-standard status code.)
Although the PSR-7_ ``ResponseInterface::withStatus`` method accepts the reason phrase as an optional second parameter, you generally shouldn't pass anything unless you are using a non-standard status code. (And you probably shouldn't be using a non-standard status code.)
.. code-block:: php
@ -336,19 +332,19 @@ Although the PSR-7_ ``ResponseInterface::withStatus`` method accepts the reason
Headers
^^^^^^^
Use the ``withHeader`` method to add a header to a response. ``withHeader`` will add the header if not already set, or replace the value of an existing header with that name.
Use the ``withHeader`` method to add a header to a response. ``withHeader`` will add the header if not already set, or replace the value of an existing header with the same name.
.. code-block:: php
// Add a "Content-type" header.
$response = $response->withHeader("Content-type", "text/plain");
$response->getHeaderLine("Content-type");
// text/plain
// "text/plain"
// Calling withHeader a second time updates the value.
$response = $response->withHeader("Content-type", "text/html");
$response->getHeaderLine("Content-type");
// text/html
// "text/html"
To set multiple values for a given header field name (e.g., for ``Set-cookie`` headers), call ``withAddedHeader``. ``withAddedHeader`` adds the new header without altering existing headers with the same name.
@ -438,6 +434,7 @@ Each PSR-7_ message MUST have a body, so there's no ``withoutBody`` method. You
.. _HTTP Status Code Registry: https://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml
.. _PSR-7: http://www.php-fig.org/psr/psr-7/
.. _PSR-7 Section 1.3: https://www.php-fig.org/psr/psr-7/#13-streams
.. _Getting Started: getting-started.html
.. _Middleware: middleware.html
.. _template routes: router.html#template-routes

View File

@ -10,14 +10,14 @@ The recommended method for installing WellRESTed is to use Composer_. Add an ent
{
"require": {
"wellrested/wellrested": "~3.1"
"wellrested/wellrested": "^5"
}
}
Requirements
^^^^^^^^^^^^
- PHP 7.0
- PHP 7.3
License
^^^^^^^
@ -26,7 +26,7 @@ Licensed using the `MIT license <http://opensource.org/licenses/MIT>`_.
The MIT License (MIT)
Copyright (c) 2018 PJ Dietz
Copyright (c) 2021 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

View File

@ -1,7 +1,7 @@
Router
======
A router is a type of handler that organizes the components of a site by associating HTTP methods and paths with other handler and middleware. When the router receives a request, it examines the path components of the request's URI, determines which "route" matches, and dispatches the associated handler. The dispatched handler is then responsible for reacting to the request and providing a response.
A router is a type of middleware that organizes the components of a site by associating HTTP methods and paths with handlers and middleware. When the router receives a request, it examines the path components of the request's URI, determines which "route" matches, and dispatches the associated handler. The dispatched handler is then responsible for reacting to the request and providing a response.
Basic Usage
^^^^^^^^^^^
@ -13,7 +13,7 @@ Typically, you will want to use the ``WellRESTed\Server::createRouter`` method t
$server = new WellRESTed\Server();
$router = $server->createRouter();
Suppose ``$catHandler`` is a middleware that you want to dispatch whenever a client makes a ``GET`` request to the path ``/cats/``. Use the ``register`` method map it to that path and method.
Suppose ``$catHandler`` is a handler that you want to dispatch whenever a client makes a ``GET`` request to the path ``/cats/``. Use the ``register`` method map it to that path and method.
.. code-block:: php
@ -111,7 +111,6 @@ For a request to ``/cats/molly-90``:
[1] => molly
[number] => 12
[2] => 12
... Plus any other attributes that were set ...
)
*/
@ -124,7 +123,7 @@ A router will often contain many routes, and sometimes more than one route will
#. If one prefix route matches the beginning of the path, dispatch it.
#. If multiple prefix routes match, dispatch the longest matching prefix route.
#. Inspect each pattern route (template and regular expression) in the order in which they were added to the router. Dispatch the first route that matches.
#. If no pattern routes match, return a response with a ``404 Not Found`` status.
#. If no pattern routes match, return a response with a ``404 Not Found`` status. (**Note:** This is the default behavior. To configure a router to delegate to the next middleware when no route matches, call the router's ``continueOnNotFound()`` method.)
Static vs. Prefix
~~~~~~~~~~~~~~~~~
@ -167,7 +166,7 @@ Given these routes:
->register("GET", "/dogs/*", $prefix);
->register("GET", "/dogs/{group}/{breed}", $pattern);
``$pattern`` will never be dispatched because any route that matches ``/dogs/{group}/{breed}`` also matches ``/dogs/*``, and prefix routes have priority over pattern routes.
``$pattern`` will **never** be dispatched because any route that matches ``/dogs/{group}/{breed}`` also matches ``/dogs/*``, and prefix routes have priority over pattern routes.
Pattern vs. Pattern
~~~~~~~~~~~~~~~~~~~
@ -192,7 +191,7 @@ This will **NOT** work:
// Matches only when the variables are digits.
$router->register("GET", "~/dogs/([0-9]+)/([0-9]+)", $numbers);
This is because ``/dogs/{group}/{breed}`` will match both ``/dogs/102/132`` and ``/dogs/herding/australian-shepherd``. If it is added to the router before the route for ``$numbers``, it will be dispatched before the route for ``$numbers`` is ever evaluated.
This is because ``/dogs/{group}/{breed}`` will match both ``/dogs/102/132`` **and** ``/dogs/herding/australian-shepherd``. If it is added to the router before the route for ``$numbers``, it will be dispatched before the route for ``$numbers`` is ever evaluated.
Methods
^^^^^^^
@ -284,38 +283,51 @@ A ``POST`` request to ``/cats/12`` will provide:
HTTP/1.1 405 Method Not Allowed
Allow: GET,PUT,DELETE,HEAD,OPTIONS
Error Responses
^^^^^^^^^^^^^^^
When a router is unable to dispatch a route because either the path or method does not match a defined route, it will provide an appropriate error response code—either ``404 Not Found`` or ``405 Method Not Allowed``.
Then a router is able to locate a route that matches the path, but that route doesn't support the request's method, the router will respond ``405 Method Not Allowed``.
The router always checks the path first. If route for that path matches, the router responds ``404 Not Found``.
When a router is unable to match the route, it will delegate to the next middleware.
If the router is able to locate a route that matches the path, but that route doesn't support the request's method, the router will respond ``405 Method Not Allowed``.
.. note::
Given this router:
When no route matches, the Router will delegate to the next middleware in the server. This is a change from previous versions of WellRESTed where there Router would return a 404 Not Found response. This new behaviour allows a servers to have multiple routers.
Router-specific Middleware
^^^^^^^^^^^^^^^^^^^^^^^^^^
WellRESTed allows a Router to have a set of middleware to dispatch whenever it finds a route that matches. This middleware runs before the handler for the matched route, and only when a route matches.
This feature allows you to build a site where some sections use certain middleware and other do not. For example, suppose your site has a public section that does not require authentication and a private section that does. We can use a different router for each section, and provide authentication middleware on only the router for the private area.
.. code-block:: php
$router
->register("GET", "/cats/", $catReader)
->register("POST", "/cats/", $catWriter)
->register("GET", "/dogs/", $catItemReader)
$server = new Server();
The following requests wil provide these responses:
// Add the "public" router.
$public = $server->createRouter();
$public->register('GET', '/', $homeHandler);
$public->register('GET', '/about', $homeHandler);
// Set the router call the next middleware when no route matches.
$public->continueOnNotFound();
$server->add($public);
====== ========== ========
Method Path Response
====== ========== ========
GET /hamsters/ 404 Not Found
PUT /cats/ 405 Method Not Allowed
====== ========== ========
// Add the "private" router.
$private = $server->createRouter();
// Authorization middleware checks for an Authorization header and
// responds 401 when the header is missing or invalid.
$private->add($authorizationMiddleware);
$private->register('GET', '/secret', $secretHandler);
$private->register('GET', '/members-only', $otherHandler);
$server->add($private);
$server->respond();
Nested Routers
^^^^^^^^^^^^^^
For large Web services with large numbers of endpoints, a single, monolithic router may not to optimal. To avoid having each request test every pattern-based route, you can break up a router into sub-routers.
For large Web services with large numbers of endpoints, a single, monolithic router may not to optimal. To avoid having each request test every pattern-based route, you can break up a router into a hierarchy of routers.
Here's an example where all of the traffic beginning with ``/cats/`` is sent to one router, and all the traffic for endpoints beginning with ``/dogs/`` is sent to another.

View File

@ -23,11 +23,11 @@ To read a path variable, router inspects the request attribute named ``"id"``, s
// For a request to /widgets/12
$id = $request->getAttribute("id");
// 12
// "12"
// For a request to /widgets/mega-widget
$id = $request->getAttribute("id");
// mega-widget
// "mega-widget"
.. note::
@ -36,7 +36,7 @@ To read a path variable, router inspects the request attribute named ``"id"``, s
Multiple Variables
------------------
The example above included one variable, but URI Templates may include multiple variables. Each variable will be provided as a request attribute, so be sure to give your variables unique names.
The example above included one variable, but URI Templates may include multiple. Each variable will be provided as a request attribute, so be sure to give your variables unique names.
Here's an example with a handful of variables. Suppose we have a template describing the path for a user's avatar image. The image is identified by a username and the image dimensions.

View File

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

View File

@ -25,15 +25,15 @@ class HomePageHandler implements RequestHandlerInterface
<meta charset="utf-8">
<title>WellRESTed Development Site</title>
</head>
<body>
<body>
<h1>WellRESTed Development Site</h1>
<p>To run unit tests, run:</p>
<code>docker-compose run --rm php phpunit</code>
<p>View the <a href="/coverage/">code coverage report</a>.</p>
<p>To generate documentation, run:</p>
<code>docker-compose run --rm docs</code>
<code>docker-compose run --rm docs</code>
<p>View <a href="/docs/"> documentation</a>.</p>
</body>
</html>
@ -47,12 +47,13 @@ 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();
$router->register("GET", "/", new HomePageHandler());
// Register the route GET / with an anonymous function that provides a handler.
$router->register("GET", "/", function () { return new HomePageHandler(); });
// Add the router to the server.
$server->add($router);
// Read the request from the client, dispatch a handler, and output.
$server->respond();

View File

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

View File

@ -10,12 +10,11 @@ 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;
@ -26,7 +25,7 @@ class DispatchStack implements DispatchStackInterface
* Push a new middleware onto the stack.
*
* @param mixed $middleware Middleware to dispatch in sequence
* @return self
* @return static
*/
public function add($middleware)
{
@ -40,7 +39,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 next middleware in the sequence.
* called, will dispatch the following 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
@ -54,8 +53,11 @@ class DispatchStack implements DispatchStackInterface
* @param callable $next
* @return ResponseInterface
*/
public function __invoke(ServerRequestInterface $request, ResponseInterface $response, $next)
{
public function __invoke(
ServerRequestInterface $request,
ResponseInterface $response,
$next
) {
$dispatcher = $this->dispatcher;
// This flag will be set to true when the last middleware calls $next.
@ -63,19 +65,30 @@ 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 ($request, $response) use (&$stackCompleted) {
$chain = function (
ServerRequestInterface $request,
ResponseInterface $response
) use (&$stackCompleted): ResponseInterface {
$stackCompleted = true;
return $response;
};
// Create a chain of callables.
//
// Each callable wil take $request and $response parameters, and will
// contain a dispatcher, the associated middleware, and a $next
// that is the links to the next middleware in the chain.
// Each callable will take $request and $response parameters, and will
// 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 ($request, $response) use ($dispatcher, $middleware, $chain) {
return $dispatcher->dispatch($middleware, $request, $response, $chain);
$chain = function (
ServerRequestInterface $request,
ResponseInterface $response
) use ($dispatcher, $middleware, $chain): ResponseInterface {
return $dispatcher->dispatch(
$middleware,
$request,
$response,
$chain
);
};
}

View File

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

View File

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

View File

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

View File

@ -8,57 +8,50 @@ 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 = [];
/**
* @var string[]
*
* List array of lowercase header names.
*
* @var string[]
*/
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)
public function offsetExists($offset): bool
{
return isset($this->values[strtolower($offset)]);
}
@ -67,7 +60,7 @@ class HeaderCollection implements ArrayAccess, Iterator
* @param mixed $offset
* @return string[]
*/
public function offsetGet($offset)
public function offsetGet($offset): array
{
return $this->values[strtolower($offset)];
}
@ -76,7 +69,7 @@ class HeaderCollection implements ArrayAccess, Iterator
* @param string $offset
* @param string $value
*/
public function offsetSet($offset, $value)
public function offsetSet($offset, $value): void
{
$normalized = strtolower($offset);
@ -99,7 +92,7 @@ class HeaderCollection implements ArrayAccess, Iterator
/**
* @param string $offset
*/
public function offsetUnset($offset)
public function offsetUnset($offset): void
{
$normalized = strtolower($offset);
unset($this->fields[$normalized]);
@ -111,30 +104,33 @@ class HeaderCollection implements ArrayAccess, Iterator
}
}
// ------------------------------------------------------------------------
// -------------------------------------------------------------------------
// Iterator
public function current()
/**
* @return string[]
*/
public function current(): array
{
return $this->values[$this->keys[$this->position]];
}
public function next()
public function next(): void
{
++$this->position;
}
public function key()
public function key(): string
{
return $this->fields[$this->keys[$this->position]];
}
public function valid()
public function valid(): bool
{
return isset($this->keys[$this->position]);
}
public function rewind()
public function rewind(): void
{
$this->position = 0;
}

View File

@ -2,6 +2,7 @@
namespace WellRESTed\Message;
use InvalidArgumentException;
use Psr\Http\Message\MessageInterface;
use Psr\Http\Message\StreamInterface;
@ -15,39 +16,38 @@ abstract class Message implements MessageInterface
/** @var StreamInterface */
protected $body;
/** @var string */
protected $protocolVersion = "1.1";
protected $protocolVersion = '1.1';
/**
* Create a new Message, optionally with headers and a body.
*
* If provided, $headers MUST by an associative array with header field
* names as (string) keys and lists of header field values (string[])
* as values.
* $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.
*
* @param array $headers Associative array of headers fields with header
* field names as keys and list arrays of field values as values
* @param StreamInterface $body A stream representation of the message
* @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
*/
public function __construct(array $headers = null, StreamInterface $body = null)
{
public function __construct(
array $headers = [],
?StreamInterface $body = null
) {
$this->headers = new HeaderCollection();
if ($headers) {
foreach ($headers as $name => $values) {
foreach ($values as $value) {
$this->headers[$name] = $value;
}
foreach ($headers as $name => $values) {
if (is_string($values)) {
$values = [$values];
}
foreach ($values as $value) {
$this->headers[$name] = $value;
}
}
if ($body !== null) {
$this->body = $body;
} else {
$this->body = new Stream('');
}
$this->body = $body ?? new Stream('');
}
public function __clone()
@ -55,14 +55,12 @@ abstract class Message implements MessageInterface
$this->headers = clone $this->headers;
}
// ------------------------------------------------------------------------
// -------------------------------------------------------------------------
// Psr\Http\Message\MessageInterface
/**
* Retrieves the HTTP protocol version as a string.
*
* The string MUST contain only the HTTP version number (e.g., "1.1", "1.0").
*
* @return string HTTP protocol version.
*/
public function getProtocolVersion()
@ -73,9 +71,6 @@ abstract class Message implements MessageInterface
/**
* Create a new instance with the specified HTTP protocol version.
*
* The version string MUST contain only the HTTP version number (e.g.,
* "1.1", "1.0").
*
* @param string $version HTTP protocol version
* @return static
*/
@ -94,7 +89,7 @@ abstract class Message implements MessageInterface
*
* // Represent the headers as a string
* foreach ($message->getHeaders() as $name => $values) {
* echo $name . ": " . implode(", ", $values);
* echo $name . ': ' . implode(', ', $values);
* }
*
* // Emit headers iteratively:
@ -107,7 +102,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 array Returns an associative array of the message's headers.
* @return string[][] Returns an associative array of the message's headers.
*/
public function getHeaders()
{
@ -177,9 +172,9 @@ abstract class Message implements MessageInterface
public function getHeaderLine($name)
{
if (isset($this->headers[$name])) {
return join(", ", $this->headers[$name]);
return join(', ', $this->headers[$name]);
} else {
return "";
return '';
}
}
@ -193,7 +188,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)
{
@ -217,7 +212,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)
{
@ -260,7 +255,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)
{
@ -269,24 +264,34 @@ abstract class Message implements MessageInterface
return $message;
}
// ------------------------------------------------------------------------
// -------------------------------------------------------------------------
private function getValidatedHeaders($name, $value)
/**
* @param mixed $name
* @param mixed|mixed[] $values
* @return string[]
* @throws InvalidArgumentException Name is not a string or value is not
* a string or array of strings
*/
private function getValidatedHeaders($name, $values)
{
$is_allowed = function ($item) {
return is_string($item) || is_numeric($item);
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));
};
if (!is_string($name)) {
throw new \InvalidArgumentException("Header name must be a string");
$invalid = array_filter($values, $isNotStringOrNumber);
if ($invalid) {
throw new InvalidArgumentException('Header values must be a string or string[]');
}
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[]");
}
return array_map('strval', $values);
}
}

View File

@ -3,6 +3,7 @@
namespace WellRESTed\Message;
use Psr\Http\Message\StreamInterface;
use RuntimeException;
/**
* NullStream is a minimal, always-empty, non-writable stream.
@ -18,7 +19,7 @@ class NullStream implements StreamInterface
*/
public function __toString()
{
return "";
return '';
}
/**
@ -51,9 +52,10 @@ class NullStream implements StreamInterface
}
/**
* Returns 0
* Returns the current position of the file read/write pointer
*
* @return int|bool Position of the file pointer or false on error.
* @return int Position of the file pointer
* @throws RuntimeException on error.
*/
public function tell()
{
@ -90,11 +92,12 @@ 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.
* @throws \RuntimeException on failure.
* @return void
* @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.');
}
/**
@ -102,11 +105,12 @@ class NullStream implements StreamInterface
*
* @see seek()
* @link http://www.php.net/manual/en/function.fseek.php
* @throws \RuntimeException on failure.
* @return void
* @throws RuntimeException on failure.
*/
public function rewind()
{
throw new \RuntimeException("Unable to rewind stream.");
throw new RuntimeException('Unable to rewind stream.');
}
/**
@ -124,11 +128,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.');
}
/**
@ -149,23 +153,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 '';
}
/**

View File

@ -2,6 +2,7 @@
namespace WellRESTed\Message;
use InvalidArgumentException;
use Psr\Http\Message\RequestInterface;
use Psr\Http\Message\StreamInterface;
use Psr\Http\Message\UriInterface;
@ -22,37 +23,42 @@ class Request extends Message implements RequestInterface
{
/** @var string */
protected $method;
/** @var string */
/** @var string|null */
protected $requestTarget;
/** @var UriInterface */
protected $uri;
// ------------------------------------------------------------------------
// -------------------------------------------------------------------------
/**
* Create a new Request.
*
* @see \WellRESTed\Message\Message
* @param UriInterface $uri
* $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.
*
* @param string $method
* @param array $headers
* @param StreamInterface $body
* @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
*/
public function __construct(
UriInterface $uri = null,
$method = "GET",
array $headers = null,
StreamInterface $body = null
string $method = 'GET',
$uri = '',
array $headers = [],
?StreamInterface $body = null
) {
parent::__construct($headers, $body);
if ($uri !== null) {
$this->uri = $uri;
} else {
$this->uri = new Uri();
}
$this->method = $method;
if (!($uri instanceof UriInterface)) {
$uri = new Uri($uri);
}
$this->uri = $uri;
$this->requestTarget = null;
}
public function __clone()
@ -61,7 +67,7 @@ class Request extends Message implements RequestInterface
parent::__clone();
}
// ------------------------------------------------------------------------
// -------------------------------------------------------------------------
// Psr\Http\Message\RequestInterface
/**
@ -83,7 +89,7 @@ class Request extends Message implements RequestInterface
public function getRequestTarget()
{
// Use the explicitly set request target first.
if (isset($this->requestTarget)) {
if ($this->requestTarget !== null) {
return $this->requestTarget;
}
@ -91,11 +97,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 ?: '/';
}
/**
@ -137,7 +143,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)
{
@ -189,18 +195,18 @@ class Request extends Message implements RequestInterface
$request = clone $this;
$newHost = $uri->getHost();
$oldHost = isset($request->headers["Host"]) ? $request->headers["Host"] : "";
$oldHost = $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;
}
}
@ -208,21 +214,21 @@ class Request extends Message implements RequestInterface
return $request;
}
// ------------------------------------------------------------------------
// -------------------------------------------------------------------------
/**
* @param string $method
* @return static
* @throws \InvalidArgumentException
* @param mixed $method
* @return string
* @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;
}

View File

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

View File

@ -2,6 +2,7 @@
namespace WellRESTed\Message;
use InvalidArgumentException;
use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\StreamInterface;
@ -20,7 +21,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;
/**
@ -34,18 +35,22 @@ 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 $body
* @param StreamInterface|null $body
*/
public function __construct($statusCode = 500, array $headers = null, StreamInterface $body = null)
{
public function __construct(
int $statusCode = 500,
array $headers = [],
?StreamInterface $body = null
) {
parent::__construct($headers, $body);
$this->statusCode = $statusCode;
$this->reasonPhrase = $this->getDefaultReasonPhraseForStatusCode($statusCode);
}
// ------------------------------------------------------------------------
// -------------------------------------------------------------------------
// Psr\Http\Message\ResponseInterface
/**
@ -54,7 +59,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 integer Status code.
* @return int Status code.
*/
public function getStatusCode()
{
@ -74,9 +79,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;
@ -103,73 +108,70 @@ class Response extends Message implements ResponseInterface
/**
* @param int $statusCode
* @return string|null
* @return string
*/
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'
];
if (isset($reasonPhraseLookup[$statusCode])) {
return $reasonPhraseLookup[$statusCode];
}
return null;
return $reasonPhraseLookup[$statusCode] ?? '';
}
}

View File

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

View File

@ -2,9 +2,11 @@
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.
@ -49,24 +51,37 @@ class ServerRequest extends Request implements ServerRequestInterface
/** @var array */
private $uploadedFiles;
// ------------------------------------------------------------------------
// -------------------------------------------------------------------------
/**
* Creates a new, empty representation of a server-side HTTP request.
* Create a new ServerRequest.
*
* To obtain a ServerRequest representing the request sent to the server
* instantiating the request, use the factory method
* ServerRequest::getServerRequest
* $headers is an optional associative array with header field names as
* string keys and values as either string or string[].
*
* @see 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
*/
public function __construct()
{
parent::__construct();
$this->attributes = [];
public function __construct(
string $method = 'GET',
$uri = '',
array $headers = [],
?StreamInterface $body = null,
array $serverParams = []
) {
parent::__construct($method, $uri, $headers, $body);
$this->serverParams = $serverParams;
$this->cookieParams = [];
$this->queryParams = [];
$this->serverParams = [];
$this->attributes = [];
$this->uploadedFiles = [];
}
@ -78,7 +93,7 @@ class ServerRequest extends Request implements ServerRequestInterface
parent::__clone();
}
// ------------------------------------------------------------------------
// -------------------------------------------------------------------------
// Psr\Http\Message\ServerRequestInterface
/**
@ -188,13 +203,14 @@ 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;
@ -247,7 +263,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;
@ -334,160 +350,7 @@ 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_") {
$headers[str_replace(" ", "-", ucwords(strtolower(str_replace("_", " ", substr($name, 5)))))] = $value;
}
}
return $headers;
}
// -------------------------------------------------------------------------
/**
* @param array $root
@ -502,7 +365,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;
}
@ -515,7 +378,11 @@ class ServerRequest extends Request implements ServerRequestInterface
return true;
}
private function isValidUploadedFilesBranch($branch)
/**
* @param UploadedFileInterface|array $branch
* @return bool
*/
private function isValidUploadedFilesBranch($branch): bool
{
if (is_array($branch)) {
// Branch.

View File

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

View File

@ -2,15 +2,21 @@
namespace WellRESTed\Message;
use Exception;
use InvalidArgumentException;
use Psr\Http\Message\StreamInterface;
use RuntimeException;
class Stream implements StreamInterface
{
/** @var resource */
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 */
private $resource;
/**
* Create a new Stream passing either a stream resource handle (e.g.,
* Create a new Stream by 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,
@ -19,17 +25,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 a resource handler.");
throw new InvalidArgumentException('Expected resource or string.');
}
}
@ -46,18 +52,16 @@ class Stream implements StreamInterface
*/
public function __toString()
{
$string = "";
try {
if ($this->isSeekable()) {
rewind($this->resource);
$this->rewind();
}
$string = $this->getContents();
// @codeCoverageIgnoreStart
} catch (\Exception $e) {
// @codeCoverageIgnoreEnd
// Silence exceptions in order to conform with PHP's string casting operations.
return $this->getContents();
} catch (Exception $e) {
// Silence exceptions in order to conform with PHP's string casting
// operations.
return '';
}
return $string;
}
/**
@ -67,7 +71,13 @@ class Stream implements StreamInterface
*/
public function close()
{
fclose($this->resource);
if ($this->resource === null) {
return;
}
$resource = $this->resource;
fclose($resource);
$this->resource = null;
}
/**
@ -79,9 +89,9 @@ class Stream implements StreamInterface
*/
public function detach()
{
$stream = $this->resource;
$resource = $this->resource;
$this->resource = null;
return $stream;
return $resource;
}
/**
@ -91,23 +101,32 @@ class Stream implements StreamInterface
*/
public function getSize()
{
if ($this->resource === null) {
return null;
}
$statistics = fstat($this->resource);
return $statistics["size"] ?: null;
if ($statistics && $statistics['size']) {
return $statistics['size'];
}
return 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) {
// @codeCoverageIgnoreStart
throw new \RuntimeException("Unable to retrieve current position of file pointer.");
// @codeCoverageIgnoreEnd
throw new RuntimeException('Unable to retrieve current position of file pointer.');
}
return $position;
}
@ -119,6 +138,10 @@ class Stream implements StreamInterface
*/
public function eof()
{
if ($this->resource === null) {
return true;
}
return feof($this->resource);
}
@ -129,7 +152,11 @@ class Stream implements StreamInterface
*/
public function isSeekable()
{
return $this->getMetadata("seekable") == 1;
if ($this->resource === null) {
return false;
}
return $this->getMetadata('seekable') == 1;
}
/**
@ -142,18 +169,21 @@ 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.
* @throws \RuntimeException on failure.
* @return void
* @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) {
// @codeCoverageIgnoreStart
throw new \RuntimeException("Unable to seek to position.");
// @codeCoverageIgnoreEnd
throw new RuntimeException('Unable to seek to position.');
}
}
@ -165,18 +195,21 @@ class Stream implements StreamInterface
*
* @see seek()
* @link http://www.php.net/manual/en/function.fseek.php
* @throws \RuntimeException on failure.
* @return void
* @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) {
// @codeCoverageIgnoreStart
throw new \RuntimeException("Unable to seek to position.");
// @codeCoverageIgnoreEnd
throw new RuntimeException('Unable to rewind.');
}
}
@ -187,8 +220,12 @@ class Stream implements StreamInterface
*/
public function isWritable()
{
$mode = $this->getMetadata("mode");
return $mode[0] !== "r" || strpos($mode, "+") !== false;
if ($this->resource === null) {
return false;
}
$mode = $this->getBasicMode();
return in_array($mode, self::WRITABLE_MODES);
}
/**
@ -196,16 +233,20 @@ 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;
}
@ -217,8 +258,12 @@ class Stream implements StreamInterface
*/
public function isReadable()
{
$mode = $this->getMetadata("mode");
return strpos($mode, "r") !== false || strpos($mode, "+") !== false;
if ($this->resource === null) {
return false;
}
$mode = $this->getBasicMode();
return in_array($mode, self::READABLE_MODES);
}
/**
@ -229,16 +274,20 @@ 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;
}
@ -247,17 +296,21 @@ 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;
}
@ -269,13 +322,17 @@ class Stream implements StreamInterface
* stream_get_meta_data() function.
*
* @link http://php.net/manual/en/function.stream-get-meta-data.php
* @param string $key Specific metadata to retrieve.
* @param string|null $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;
@ -283,4 +340,14 @@ 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);
}
}

View File

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

View File

@ -2,24 +2,33 @@
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 Uri. The arguments correspond with keys from arrays
* Create a new UploadedFile. The arguments correspond with keys from arrays
* provided by $_FILES. For example, given this structure for $_FILES:
*
* array(
@ -57,10 +66,11 @@ 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;
}
}
@ -77,16 +87,19 @@ 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->moved) {
throw new \RuntimeException("File has already been moved");
if ($this->tmpName === null) {
throw new RuntimeException('Unable to read uploaded file.');
}
if (php_sapi_name() !== "cli" && !is_uploaded_file($this->tmpName)) {
throw new \RuntimeException("File is not an uploaded file.");
if ($this->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.');
}
return $this->stream;
}
@ -104,20 +117,21 @@ class UploadedFile implements UploadedFileInterface
*
* @see http://php.net/is_uploaded_file
* @see http://php.net/move_uploaded_file
* @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
* @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
* the second or subsequent call to the method.
*/
public function moveTo($path)
public function moveTo($targetPath)
{
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, $path);
if (php_sapi_name() === 'cli') {
rename($this->tmpName, $targetPath);
} else {
move_uploaded_file($this->tmpName, $path);
move_uploaded_file($this->tmpName, $targetPath);
}
$this->moved = true;
}

View File

@ -2,6 +2,7 @@
namespace WellRESTed\Message;
use InvalidArgumentException;
use Psr\Http\Message\UriInterface;
/**
@ -17,60 +18,41 @@ use Psr\Http\Message\UriInterface;
*/
class Uri implements UriInterface
{
const MIN_PORT = 0;
const MAX_PORT = 65535;
private const MIN_PORT = 0;
private const MAX_PORT = 65535;
/** @var string */
private $scheme = "";
private $scheme;
/** @var string */
private $user = "";
/** @var string|null */
private $user;
/** @var string */
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($uri = "")
public function __construct(string $uri = '')
{
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"];
}
}
}
$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'] ?? '';
}
/**
@ -112,33 +94,38 @@ class Uri implements UriInterface
*/
public function getAuthority()
{
$authority = "";
$host = $this->getHost();
if ($host !== "") {
if (!$host) {
return '';
}
// User Info
$userInfo = $this->getUserInfo();
if ($userInfo !== "") {
$authority .= $userInfo . "@";
}
$authority = '';
// Host
$authority .= $host;
// User Info
$userInfo = $this->getUserInfo();
if ($userInfo) {
$authority .= $userInfo . '@';
}
// 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;
}
}
// Host
$authority .= $host;
// Port: Include only if non-standard
if ($this->nonStandardPort()) {
$authority .= ':' . $this->getPort();
}
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.
*
@ -158,7 +145,7 @@ class Uri implements UriInterface
{
$userInfo = $this->user;
if ($userInfo && $this->password) {
$userInfo .= ":" . $this->password;
$userInfo .= ':' . $this->password;
}
return $userInfo;
}
@ -198,9 +185,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;
@ -236,7 +223,7 @@ class Uri implements UriInterface
*/
public function getPath()
{
if ($this->path === "*") {
if ($this->path === '*') {
return $this->path;
}
return $this->percentEncode($this->path);
@ -301,13 +288,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 = $scheme ? strtolower($scheme) : "";
if (!in_array($scheme, ["", "http", "https"])) {
throw new \InvalidArgumentException("Scheme must be http, https, or empty.");
$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;
@ -332,7 +319,7 @@ class Uri implements UriInterface
{
$uri = clone $this;
$uri->user = $user;
$uri->password = $password;
$uri->password = $password ?? '';
return $uri;
}
@ -346,12 +333,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;
@ -374,18 +361,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;
@ -408,12 +395,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;
@ -433,7 +420,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)
{
@ -459,7 +446,7 @@ class Uri implements UriInterface
public function withFragment($fragment)
{
$uri = clone $this;
$uri->fragment = $fragment;
$uri->fragment = $fragment ?? '';
return $uri;
}
@ -488,29 +475,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";
}
@ -533,12 +520,12 @@ class Uri implements UriInterface
* @param string $subject
* @return string
*/
private function percentEncode($subject)
private function percentEncode(string $subject)
{
$reserved = ':/?#[]@!$&\'()*+,;=';
$reserved = preg_quote($reserved);
$pattern = '~(?:%(?![a-fA-F0-9]{2}))|(?:[^%a-zA-Z0-9\-\.\_\~' . $reserved . ']{1})~';
$callback = function ($matches) {
$callback = function (array $matches): string {
return urlencode($matches[0]);
};
return preg_replace_callback($pattern, $callback, $subject);

View File

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

View File

@ -1,17 +1,23 @@
<?php
namespace WellRESTed\Routing;
namespace WellRESTed\Routing\Route;
use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\ServerRequestInterface;
use WellRESTed\Dispatching\DispatcherInterface;
use WellRESTed\MiddlewareInterface;
class MethodMap implements MethodMapInterface
/**
* @internal
*/
class MethodMap implements MiddlewareInterface
{
/** @var DispatcherInterface */
private $dispatcher;
/** @var array */
private $map;
// ------------------------------------------------------------------------
// -------------------------------------------------------------------------
public function __construct(DispatcherInterface $dispatcher)
{
@ -19,41 +25,33 @@ class MethodMap implements MethodMapInterface
$this->dispatcher = $dispatcher;
}
// ------------------------------------------------------------------------
// MethodMapInterface
/**
* Register middleware with a method.
* Register a dispatchable (e.g.m 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.
*
* $middleware may be:
* - An instance implementing MiddlewareInterface
* - A string containing the fully qualified class name of a class
* implementing MiddlewareInterface
* - A callable that returns an instance implementing MiddleInterface
* - A callable matching the signature of MiddlewareInterface::dispatch
* @see DispatchedInterface::dispatch
* $dispatchable may be anything a Dispatcher can dispatch.
* @see DispatcherInterface::dispatch
*
* $middleware may also be null, in which case any previously set
* middleware for that method or methods will be unset.
* $dispatchable may also be null, in which case any previously set
* handlers and middle for that method or methods will be unset.
*
* @param string $method
* @param mixed $middleware
* @param mixed $dispatchable
*/
public function register($method, $middleware)
public function register(string $method, $dispatchable): void
{
$methods = explode(",", $method);
$methods = array_map("trim", $methods);
$methods = explode(',', $method);
$methods = array_map('trim', $methods);
foreach ($methods as $method) {
$this->map[$method] = $middleware;
$this->map[$method] = $dispatchable;
}
}
// ------------------------------------------------------------------------
// -------------------------------------------------------------------------
// MiddlewareInterface
/**
@ -62,8 +60,11 @@ class MethodMap implements MethodMapInterface
* @param callable $next
* @return ResponseInterface
*/
public function __invoke(ServerRequestInterface $request, ResponseInterface $response, $next)
{
public function __invoke(
ServerRequestInterface $request,
ResponseInterface $response,
$next
) {
$method = $request->getMethod();
// Dispatch middleware registered with the explicitly matching method.
if (isset($this->map[$method])) {
@ -71,18 +72,18 @@ class MethodMap implements MethodMapInterface
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);
@ -90,37 +91,44 @@ class MethodMap implements MethodMapInterface
return $this->addAllowHeader($response);
}
// ------------------------------------------------------------------------
// -------------------------------------------------------------------------
private function addAllowHeader(ResponseInterface $response)
private function addAllowHeader(ResponseInterface $response): ResponseInterface
{
$methods = join(",", $this->getAllowedMethods());
return $response->withHeader("Allow", $methods);
$methods = join(',', $this->getAllowedMethods());
return $response->withHeader('Allow', $methods);
}
private function getAllowedMethods()
/**
* @return string[]
*/
private function getAllowedMethods(): array
{
$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 $middleware
* @param mixed $middleware
* @param ServerRequestInterface $request
* @param ResponseInterface $response
* @param $next
* @param callable $next
* @return ResponseInterface
*/
private function dispatchMiddleware($middleware, ServerRequestInterface $request, ResponseInterface &$response, $next)
{
private function dispatchMiddleware(
$middleware,
ServerRequestInterface $request,
ResponseInterface $response,
$next
) {
return $this->dispatcher->dispatch($middleware, $request, $response, $next);
}
}

View File

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

View File

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

View File

@ -4,39 +4,106 @@ namespace WellRESTed\Routing\Route;
use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\ServerRequestInterface;
use WellRESTed\Routing\MethodMapInterface;
use RuntimeException;
use WellRESTed\MiddlewareInterface;
abstract class Route implements RouteInterface
/**
* @internal
*/
abstract class Route implements MiddlewareInterface
{
/** Matches when request path is an exact match to entire target */
public const TYPE_STATIC = 0;
/** Matches when request path is an exact match to start of target */
public const TYPE_PREFIX = 1;
/** Matches by request path by pattern and may extract matched varialbes */
public const TYPE_PATTERN = 2;
/** @var string */
protected $target;
/** @var MethodMapInterface */
/** @var MethodMap */
protected $methodMap;
public function __construct($target, $methodMap)
public function __construct(string $target, MethodMap $methodMap)
{
$this->target = $target;
$this->methodMap = $methodMap;
}
/**
* Return the instance mapping methods to middleware for this route.
* Return the Route::TYPE_ constants that identifies the type.
*
* @return MethodMapInterface
* 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.
*/
public function getMethodMap()
{
return $this->methodMap;
}
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()
public function getTarget(): string
{
return $this->target;
}
/**
* Register a dispatchable (handler or middleware) with a method.
*
* $method may be:
* - A single verb ("GET"),
* - A comma-separated list of verbs ("GET,PUT,DELETE")
* - "*" to indicate any method.
*
* $dispatchable may be anything a Dispatcher can dispatch.
* @see DispatcherInterface::dispatch
*
* @param string $method
* @param mixed $dispatchable
*/
public function register(string $method, $dispatchable): void
{
$this->methodMap->register($method, $dispatchable);
}
/**
* @param ServerRequestInterface $request
* @param ResponseInterface $response
* @param callable $next
* @return ResponseInterface
*/
public function __invoke(ServerRequestInterface $request, ResponseInterface $response, $next)
{
$map = $this->methodMap;

View File

@ -3,12 +3,11 @@
namespace WellRESTed\Routing\Route;
use WellRESTed\Dispatching\DispatcherInterface;
use WellRESTed\Routing\MethodMap;
/**
* Class for creating routes
* @internal
*/
class RouteFactory implements RouteFactoryInterface
class RouteFactory
{
private $dispatcher;
@ -26,16 +25,16 @@ class RouteFactory implements RouteFactoryInterface
* - Regular expressions will create RegexRoutes
*
* @param string $target Route target or target pattern
* @return RouteInterface
* @return Route
*/
public function create($target)
public function create(string $target): Route
{
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));
}

View File

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

View File

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

View File

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

View File

@ -2,36 +2,41 @@
namespace WellRESTed\Routing\Route;
/**
* @internal
*/
class TemplateRoute extends Route
{
private $pathVariables;
private $explosions;
/** Regular expression matching a URI template variable (e.g., {id}) */
public const URI_TEMPLATE_EXPRESSION_RE = '/{([+.\/]?[a-zA-Z0-9_,]+\*?)}/';
/**
* Regular expression matching 1 or more unreserved characters.
* ALPHA / DIGIT / "-" / "." / "_" / "~"
*/
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_,]+\*?)}/';
private const RE_UNRESERVED = '[0-9a-zA-Z\-._\~%]*';
public function getType()
/** @var array */
private $pathVariables = [];
/** @var array */
private $explosions = [];
public function getType(): int
{
return RouteInterface::TYPE_PATTERN;
return Route::TYPE_PATTERN;
}
public function getPathVariables()
public function getPathVariables(): array
{
return $this->pathVariables ?: [];
return $this->pathVariables;
}
/**
* Examines a request target to see if it is a match for the route.
*
* @param string $requestTarget
* @return boolean
* @return bool
*/
public function matchesRequestTarget($requestTarget)
public function matchesRequestTarget(string $requestTarget): bool
{
$this->pathVariables = [];
$this->explosions = [];
@ -49,54 +54,55 @@ class TemplateRoute extends Route
return false;
}
private function matchesStartOfRequestTarget($requestTarget)
private function matchesStartOfRequestTarget(string $requestTarget): bool
{
$firstVarPos = strpos($this->target, "{");
return (substr($requestTarget, 0, $firstVarPos) === substr($this->target, 0, $firstVarPos));
$firstVarPos = strpos($this->target, '{');
if ($firstVarPos === false) {
return $requestTarget === $this->target;
}
return substr($requestTarget, 0, $firstVarPos) === substr($this->target, 0, $firstVarPos);
}
private function processMatches($matches)
private function processMatches(array $matches): array
{
$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()
private function getMatchingPattern(): string
{
// 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);
@ -105,47 +111,47 @@ class TemplateRoute extends Route
$pattern = preg_replace_callback(
self::URI_TEMPLATE_EXPRESSION_RE,
[$this, "uriVariableReplacementCallback"],
[$this, 'uriVariableReplacementCallback'],
$pattern
);
return $pattern;
}
private function uriVariableReplacementCallback($matches)
private function uriVariableReplacementCallback(array $matches): string
{
$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;
}
@ -159,7 +165,7 @@ class TemplateRoute extends Route
$this->explosions[$name] = $explodeDelimiter;
}
$names = explode(",", $name);
$names = explode(',', $name);
$results = [];
foreach ($names as $name) {
$results[] = "(?<{$name}>{$pattern})";

View File

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

View File

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

View File

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

View File

@ -9,7 +9,7 @@ use Psr\Http\Message\StreamInterface;
class Transmitter implements TransmitterInterface
{
/** @var int */
private $chunkSize = 0;
private $chunkSize = 8192;
/**
* Outputs a response to the client.
@ -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,36 +48,35 @@ class Transmitter implements TransmitterInterface
}
}
/**
* @param int $chunkSize
*/
public function setChunkSize($chunkSize)
public function setChunkSize(int $chunkSize): void
{
$this->chunkSize = $chunkSize;
}
protected function prepareResponse(
private function prepareResponse(
ServerRequestInterface $request,
ResponseInterface $response
) {
// Add a Content-length header to the response when all of these are true:
): ResponseInterface {
// Add Content-length header to the response when all of these are true:
//
// - Response does not have a Content-length header
// - Response does not have a Transfer-encoding: chunked header
// - Response body stream is readable and reports a non-null 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);
}
$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);
}
return $response;
}
private function getStatusLine(ResponseInterface $response)
private function getStatusLine(ResponseInterface $response): string
{
$protocol = $response->getProtocolVersion();
$statusCode = $response->getStatusCode();
@ -89,7 +88,7 @@ class Transmitter implements TransmitterInterface
}
}
private function outputBody(StreamInterface $body)
private function outputBody(StreamInterface $body): void
{
if ($this->chunkSize > 0) {
if ($body->isSeekable()) {

View File

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

View File

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

View File

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

View File

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

View File

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

View File

@ -1,105 +0,0 @@
<?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);
}
}

View File

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

View File

@ -1,200 +0,0 @@
<?php
namespace WellRESTed\Test\Unit\Message;
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
* @expectedException \InvalidArgumentException
*/
public function testWithMethodThrowsExceptionOnInvalidMethod($method)
{
$request = new Request();
$request->withMethod($method);
}
public function invalidMethodProvider()
{
return [
[0],
[false],
["WITH SPACE"]
];
}
// ------------------------------------------------------------------------
// Request URI
public function testGetUriReturnsEmptyUriByDefault()
{
$request = new Request();
$uri = new Uri();
$this->assertEquals($uri, $request->getUri());
}
public function testWithUriCreatesNewInstance()
{
$uri = new Uri();
$request = new Request();
$request = $request->withUri($uri);
$this->assertSame($uri, $request->getUri());
}
public function testWithUriPreservesOriginalRequest()
{
$uri1 = new Uri();
$uri2 = new Uri();
$request1 = new Request();
$request1 = $request1->withUri($uri1);
$request1 = $request1->withHeader("Accept", "application/json");
$request2 = $request1->withUri($uri2);
$request2 = $request2->withHeader("Accept", "text/plain");
$this->assertNotEquals($request1->getHeader("Accept"), $request2->getHeader("Accept"));
}
public function testWithUriUpdatesHostHeader()
{
$hostname = "bar.com";
$uri = new uri("http://$hostname");
$request = new Request();
$request = $request->withHeader("Host", "foo.com");
$request = $request->withUri($uri);
$this->assertSame([$hostname], $request->getHeader("Host"));
}
public function testWithUriDoesNotUpdatesHostHeaderWhenUriHasNoHost()
{
$hostname = "foo.com";
$uri = new Uri();
$request = new Request();
$request = $request->withHeader("Host", $hostname);
$request = $request->withUri($uri);
$this->assertSame([$hostname], $request->getHeader("Host"));
}
public function testPreserveHostUpdatesHostHeaderWhenHeaderIsOriginallyMissing()
{
$hostname = "foo.com";
$uri = new uri("http://$hostname");
$request = new Request();
$request = $request->withUri($uri, true);
$this->assertSame([$hostname], $request->getHeader("Host"));
}
public function testPreserveHostDoesNotUpdatesWhenBothAreMissingHosts()
{
$uri = new Uri();
$request = new Request();
$request = $request->withUri($uri, true);
$this->assertSame([], $request->getHeader("Host"));
}
public function testPreserveHostDoesNotUpdateHostHeader()
{
$hostname = "foo.com";
$uri = new uri("http://bar.com");
$request = new Request();
$request = $request->withHeader("Host", $hostname);
$request = $request->withUri($uri, true);
$this->assertSame([$hostname], $request->getHeader("Host"));
}
}

View File

@ -1,109 +0,0 @@
<?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"));
}
}

View File

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

View File

@ -1,230 +0,0 @@
<?php
namespace WellRESTed\Test\Unit\Message;
use WellRESTed\Message\Stream;
use WellRESTed\Test\TestCase;
class StreamTest extends TestCase
{
private $resource;
private $content = "Hello, world!";
public function setUp()
{
$this->resource = fopen("php://memory", "w+");
fwrite($this->resource, $this->content);
}
public function tearDown()
{
if (is_resource($this->resource)) {
fclose($this->resource);
}
}
public function testCreatesInstanceWithStreamResource()
{
$stream = new Stream($this->resource);
$this->assertNotNull($stream);
}
public function testCreatesInstanceWithString()
{
$stream = new Stream("Hello, world!");
$this->assertNotNull($stream);
}
/**
* @expectedException \InvalidArgumentException
* @dataProvider invalidResourceProvider
*/
public function testThrowsExceptionWithInvalidResource($resource)
{
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);
}
/** @expectedException \RuntimeException */
public function testThrowsExceptionOnErrorWriting()
{
$filename = tempnam(sys_get_temp_dir(), "php");
$handle = fopen($filename, "r");
$stream = new Stream($handle);
$stream->write("Hello, world!");
}
/** @expectedException \RuntimeException */
public function testThrowsExceptionOnErrorReading()
{
$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);
}
/** @expectedException \RuntimeException */
public function testThrowsExceptionOnErrorReadingToEnd()
{
$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]
];
}
}

View File

@ -1,154 +0,0 @@
<?php
namespace WellRESTed\Test\Unit\Message;
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;
public function setUp()
{
parent::setUp();
UploadedFileState::$php_sapi_name = "cli";
$this->tmpName = tempnam(sys_get_temp_dir(), "tst");
$this->movePath = tempnam(sys_get_temp_dir(), "tst");
}
public function tearDown()
{
parent::tearDown();
if (file_exists($this->tmpName)) {
unlink($this->tmpName);
}
if (file_exists($this->movePath)) {
unlink($this->movePath);
}
}
// ------------------------------------------------------------------------
// getStream
public function testGetStreamReturnsStreamInterface()
{
$file = new UploadedFile("", "", 0, "", 0);
$this->assertInstanceOf('\Psr\Http\Message\StreamInterface', $file->getStream());
}
public function testGetStreamReturnsStreamWrappingUploadedFile()
{
$content = "Hello, World!";
file_put_contents($this->tmpName, $content);
$file = new UploadedFile("", "", 0, $this->tmpName, "");
$stream = $file->getStream();
$this->assertEquals($content, (string) $stream);
}
public function testGetStreamReturnsEmptyStreamForNoFile()
{
$file = new UploadedFile("", "", 0, "", 0);
$this->assertTrue($file->getStream()->eof());
}
/** @expectedException \RuntimeException */
public function testGetStreamThrowsExceptionAfterMoveTo()
{
$content = "Hello, World!";
file_put_contents($this->tmpName, $content);
$file = new UploadedFile("", "", 0, $this->tmpName, "");
$file->moveTo($this->movePath);
$file->getStream();
}
/** @expectedException \RuntimeException */
public function testGetStreamThrowsExceptionForNonUploadedFile()
{
UploadedFileState::$php_sapi_name = "apache";
UploadedFileState::$is_uploaded_file = false;
$file = new UploadedFile("", "", 0, "", 0);
$file->getStream();
}
// ------------------------------------------------------------------------
// moveTo
public function testMoveToSapiRelocatesUploadedFileToDestinationIfExists()
{
UploadedFileState::$php_sapi_name = "fpm-fcgi";
$content = "Hello, World!";
file_put_contents($this->tmpName, $content);
$originalMd5 = md5_file($this->tmpName);
$file = new UploadedFile("", "", 0, $this->tmpName, "");
$file->moveTo($this->movePath);
$this->assertEquals($originalMd5, md5_file($this->movePath));
}
public function testMoveToNonSapiRelocatesUploadedFileToDestinationIfExists()
{
$content = "Hello, World!";
file_put_contents($this->tmpName, $content);
$originalMd5 = md5_file($this->tmpName);
$file = new UploadedFile("", "", 0, $this->tmpName, "");
$file->moveTo($this->movePath);
$this->assertEquals($originalMd5, md5_file($this->movePath));
}
/** @expectedException \RuntimeException */
public function testMoveToThrowsExceptionOnSubsequentCall()
{
$content = "Hello, World!";
file_put_contents($this->tmpName, $content);
$file = new UploadedFile("", "", 0, $this->tmpName, "");
$file->moveTo($this->movePath);
$file->moveTo($this->movePath);
}
// ------------------------------------------------------------------------
// getSize
public function testGetSizeReturnsSize()
{
$file = new UploadedFile("", "", 1024, "", 0);
$this->assertEquals(1024, $file->getSize());
}
// ------------------------------------------------------------------------
// getError
public function testGetErrorReturnsError()
{
$file = new UploadedFile("", "", 1024, "", UPLOAD_ERR_INI_SIZE);
$this->assertEquals(UPLOAD_ERR_INI_SIZE, $file->getError());
}
// ------------------------------------------------------------------------
// clientFilename
public function testGetClientFilenameReturnsClientFilename()
{
$file = new UploadedFile("clientFilename", "", 0, "", 0);
$this->assertEquals("clientFilename", $file->getClientFilename());
}
// ------------------------------------------------------------------------
// clientMediaType
public function testGetClientMediaTypeReturnsClientMediaType()
{
$file = new UploadedFile("", "clientMediaType", 0, "", 0);
$this->assertEquals("clientMediaType", $file->getClientMediaType());
}
}

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

@ -1,9 +1,7 @@
<?php
namespace WellRESTed\Test\Unit\Dispatching;
namespace WellRESTed\Dispatching;
use WellRESTed\Dispatching\Dispatcher;
use WellRESTed\Dispatching\DispatchStack;
use WellRESTed\Message\Response;
use WellRESTed\Message\ServerRequest;
use WellRESTed\Test\Doubles\NextMock;
@ -15,7 +13,7 @@ class DispatchStackTest extends TestCase
private $response;
private $next;
public function setUp()
protected function setUp(): void
{
parent::setUp();
$this->request = new ServerRequest();
@ -23,35 +21,35 @@ class DispatchStackTest extends TestCase
$this->next = new NextMock();
}
public function testDispatchesMiddlewareInOrderAdded()
public function testDispatchesMiddlewareInOrderAdded(): void
{
// 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()
public function testCallsNextAfterDispatchingEmptyStack(): void
{
$stack = new DispatchStack(new Dispatcher());
$stack($this->request, $this->response, $this->next);
$this->assertTrue($this->next->called);
}
public function testCallsNextAfterDispatchingStack()
public function testCallsNextAfterDispatchingStack(): void
{
$middleware = function ($request, $response, $next) use (&$callOrder) {
return $next($request, $response);
@ -66,7 +64,7 @@ class DispatchStackTest extends TestCase
$this->assertTrue($this->next->called);
}
public function testDoesNotCallNextWhenStackStopsEarly()
public function testDoesNotCallNextWhenStackStopsEarly(): void
{
$middlewareGo = function ($request, $response, $next) use (&$callOrder) {
return $next($request, $response);

View File

@ -1,11 +1,10 @@
<?php
namespace WellRESTed\Test\Unit\Dispatching;
namespace WellRESTed\Dispatching;
use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\ServerRequestInterface;
use Psr\Http\Server\RequestHandlerInterface;
use WellRESTed\Dispatching\Dispatcher;
use WellRESTed\Message\Response;
use WellRESTed\Message\ServerRequest;
use WellRESTed\MiddlewareInterface;
@ -23,7 +22,7 @@ class DispatcherTest extends TestCase
/** @var ResponseInterface */
private $stubResponse;
public function setUp()
protected function setUp(): void
{
$this->request = new ServerRequest();
$this->response = new Response();
@ -34,6 +33,8 @@ 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
{
@ -49,14 +50,14 @@ class DispatcherTest extends TestCase
// -------------------------------------------------------------------------
// PSR-15 Handler
public function testDispatchesPsr15Handler()
public function testDispatchesPsr15Handler(): void
{
$handler = new HandlerDouble($this->stubResponse);
$response = $this->dispatch($handler);
$this->assertSame($this->stubResponse, $response);
}
public function testDispatchesPsr15HandlerFromFactory()
public function testDispatchesPsr15HandlerFromFactory(): void
{
$factory = function () {
return new HandlerDouble($this->stubResponse);
@ -69,7 +70,8 @@ class DispatcherTest extends TestCase
// -------------------------------------------------------------------------
// PSR-15 Middleware
public function testDispatchesPsr15MiddlewareWithDelegate() {
public function testDispatchesPsr15MiddlewareWithDelegate(): void
{
$this->next->upstreamResponse = $this->stubResponse;
$middleware = new MiddlewareDouble();
@ -77,7 +79,8 @@ class DispatcherTest extends TestCase
$this->assertSame($this->stubResponse, $response);
}
public function testDispatchesPsr15MiddlewareFromFactoryWithDelegate() {
public function testDispatchesPsr15MiddlewareFromFactoryWithDelegate(): void
{
$this->next->upstreamResponse = $this->stubResponse;
$factory = function () {
return new MiddlewareDouble();
@ -90,7 +93,7 @@ class DispatcherTest extends TestCase
// -------------------------------------------------------------------------
// Double-Pass Middleware Callable
public function testDispatchesDoublePassMiddlewareCallable()
public function testDispatchesDoublePassMiddlewareCallable(): void
{
$doublePass = function ($request, $response, $next) {
return $next($request, $this->stubResponse);
@ -100,7 +103,7 @@ class DispatcherTest extends TestCase
$this->assertSame($this->stubResponse, $response);
}
public function testDispatchesDoublePassMiddlewareCallableFromFactory()
public function testDispatchesDoublePassMiddlewareCallableFromFactory(): void
{
$factory = function () {
return function ($request, $response, $next) {
@ -115,14 +118,14 @@ class DispatcherTest extends TestCase
// -------------------------------------------------------------------------
// Double-Pass Middleware Instance
public function testDispatchesDoublePassMiddlewareInstance()
public function testDispatchesDoublePassMiddlewareInstance(): void
{
$doublePass = new DoublePassMiddlewareDouble();
$response = $this->dispatch($doublePass);
$this->assertEquals(200, $response->getStatusCode());
}
public function testDispatchesDoublePassMiddlewareInstanceFromFactory()
public function testDispatchesDoublePassMiddlewareInstanceFromFactory(): void
{
$factory = function () {
return new DoublePassMiddlewareDouble();
@ -134,7 +137,7 @@ class DispatcherTest extends TestCase
// -------------------------------------------------------------------------
// String
public function testDispatchesInstanceFromStringName()
public function testDispatchesInstanceFromStringName(): void
{
$response = $this->dispatch(DoublePassMiddlewareDouble::class);
$this->assertEquals(200, $response->getStatusCode());
@ -143,16 +146,16 @@ class DispatcherTest extends TestCase
// -------------------------------------------------------------------------
// Arrays
public function testDispatchesArrayAsDispatchStack()
public function testDispatchesArrayAsDispatchStack(): void
{
$doublePass = new DoublePassMiddlewareDouble();
$response = $this->dispatch([$doublePass]);
$this->assertEquals(200, $response->getStatusCode());
}
/** @expectedException \WellRESTed\Dispatching\DispatchException */
public function testThrowsExceptionWhenUnableToDispatch()
public function testThrowsExceptionWhenUnableToDispatch(): void
{
$this->expectException(DispatchException::class);
$this->dispatch(null);
}
}
@ -187,6 +190,7 @@ class HandlerDouble implements RequestHandlerInterface
{
/** @var ResponseInterface */
private $response;
public function __construct(ResponseInterface $response)
{
$this->response = $response;

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

638
tests/Message/UriTest.php Normal file
View File

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

View File

@ -1,11 +1,10 @@
<?php
namespace WellRESTed\Test\Unit\Routing;
namespace WellRESTed\Routing\Route;
use WellRESTed\Dispatching\Dispatcher;
use WellRESTed\Message\Response;
use WellRESTed\Message\ServerRequest;
use WellRESTed\Routing\MethodMap;
use WellRESTed\Test\Doubles\MiddlewareMock;
use WellRESTed\Test\Doubles\NextMock;
use WellRESTed\Test\TestCase;
@ -18,7 +17,7 @@ class MethodMapTest extends TestCase
private $next;
private $middleware;
public function setUp()
protected function setUp(): void
{
$this->request = new ServerRequest();
$this->response = new Response();
@ -27,112 +26,117 @@ class MethodMapTest extends TestCase
$this->dispatcher = new Dispatcher();
}
private function getMethodMap() {
private function getMethodMap(): MethodMap
{
return new MethodMap($this->dispatcher);
}
// -------------------------------------------------------------------------
public function testDispatchesMiddlewareWithMatchingMethod()
public function testDispatchesMiddlewareWithMatchingMethod(): void
{
$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()
public function testTreatsMethodNamesCaseSensitively(): void
{
$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()
public function testDispatchesWildcardMiddlewareWithNonMatchingMethod(): void
{
$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()
public function testDispatchesGetMiddlewareForHeadByDefault(): void
{
$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()
public function testRegistersMiddlewareForMultipleMethods(): void
{
$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 testSettingNullDeregistersMiddleware()
public function testSettingNullUnregistersMiddleware(): void
{
$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()
public function testSetsStatusTo200ForOptions(): void
{
$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()
public function testStopsPropagatingAfterOptions(): void
{
$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 */
public function testSetsAllowHeaderForOptions($methodsDeclared, $methodsAllowed)
/**
* @dataProvider allowedMethodProvider
* @param string[] $methodsDeclared
* @param string[] $methodsAllowed
*/
public function testSetsAllowHeaderForOptions(array $methodsDeclared, array $methodsAllowed): void
{
$this->request = $this->request->withMethod("OPTIONS");
$this->request = $this->request->withMethod('OPTIONS');
$map = $this->getMethodMap();
foreach ($methodsDeclared as $method) {
@ -140,39 +144,38 @@ class MethodMapTest extends TestCase
}
$response = $map($this->request, $this->response, $this->next);
$this->assertContainsEach($methodsAllowed, $response->getHeaderLine("Allow"));
$this->assertContainsEach($methodsAllowed, $response->getHeaderLine('Allow'));
}
/** @dataProvider allowedMethodProvider */
public function testSetsStatusTo405ForBadMethod()
public function testSetsStatusTo405ForBadMethod(): void
{
$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());
}
/**
* @coversNothing
* @dataProvider allowedMethodProvider
*/
public function testStopsPropagatingAfterBadMethod()
public function testStopsPropagatingAfterBadMethod(): void
{
$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 */
public function testSetsAllowHeaderForBadMethod($methodsDeclared, $methodsAllowed)
/**
* @dataProvider allowedMethodProvider
* @param string[] $methodsDeclared
* @param string[] $methodsAllowed
*/
public function testSetsAllowHeaderForBadMethod(array $methodsDeclared, array $methodsAllowed): void
{
$this->request = $this->request->withMethod("BAD");
$this->request = $this->request->withMethod('BAD');
$map = $this->getMethodMap();
foreach ($methodsDeclared as $method) {
@ -180,21 +183,22 @@ 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()
public function allowedMethodProvider(): array
{
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) {
private function assertContainsEach($expectedList, $actual): void
{
foreach ($expectedList as $expected) {
if (strpos($actual, $expected) === false) {
$this->assertTrue(false, "'$actual' does not contain expected '$expected'");

View File

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

View File

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

View File

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

View File

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

View File

@ -0,0 +1,39 @@
<?php
namespace WellRESTed\Routing\Route;
use Prophecy\PhpUnit\ProphecyTrait;
use WellRESTed\Test\TestCase;
class StaticRouteTest extends TestCase
{
use ProphecyTrait;
public function testReturnsStaticType(): void
{
$methodMap = $this->prophesize(MethodMap::class);
$route = new StaticRoute('/', $methodMap->reveal());
$this->assertSame(Route::TYPE_STATIC, $route->getType());
}
public function testMatchesExactRequestTarget(): void
{
$methodMap = $this->prophesize(MethodMap::class);
$route = new StaticRoute('/', $methodMap->reveal());
$this->assertTrue($route->matchesRequestTarget('/'));
}
public function testReturnsEmptyArrayForPathVariables(): void
{
$methodMap = $this->prophesize(MethodMap::class);
$route = new StaticRoute('/', $methodMap->reveal());
$this->assertSame([], $route->getPathVariables());
}
public function testDoesNotMatchNonMatchingRequestTarget(): void
{
$methodMap = $this->prophesize(MethodMap::class);
$route = new StaticRoute('/', $methodMap->reveal());
$this->assertFalse($route->matchesRequestTarget('/cats/'));
}
}

View File

@ -0,0 +1,256 @@
<?php
namespace WellRESTed\Routing\Route;
use Prophecy\PhpUnit\ProphecyTrait;
use WellRESTed\Test\TestCase;
class TemplateRouteTest extends TestCase
{
use ProphecyTrait;
private $methodMap;
protected function setUp(): void
{
$this->methodMap = $this->prophesize(MethodMap::class);
}
private function getExpectedValues(array $keys): array
{
$expectedValues = [
'var' => 'value',
'hello' => 'Hello World!',
'x' => '1024',
'y' => '768',
'path' => '/foo/bar',
'who' => 'fred',
'half' => '50%',
'empty' => '',
'count' => ['one', 'two', 'three'],
'list' => ['red', 'green', 'blue']
];
return array_intersect_key($expectedValues, array_flip($keys));
}
private function assertArrayHasSameContents($expected, $actual): void
{
ksort($expected);
ksort($actual);
$this->assertEquals($expected, $actual);
}
// -------------------------------------------------------------------------
public function testReturnsPatternType(): void
{
$route = new TemplateRoute('/', $this->methodMap->reveal());
$this->assertSame(Route::TYPE_PATTERN, $route->getType());
}
// -------------------------------------------------------------------------
// Matching
/**
* @dataProvider nonMatchingTargetProvider
* @param string $template
* @param string $target
*/
public function testFailsToMatchNonMatchingTarget(string $template, string $target): void
{
$route = new TemplateRoute($template, $this->methodMap->reveal());
$this->assertFalse($route->matchesRequestTarget($target));
}
public function nonMatchingTargetProvider()
{
return [
['/foo/{var}', '/bar/12', 'Mismatch before first template expression'],
['/foo/{foo}/bar/{bar}', '/foo/12/13', 'Mismatch after first template expression'],
['/hello/{hello}', '/hello/Hello%20World!', 'Requires + operator to match reserved characters'],
['{/var}', '/bar/12', 'Path contains more segments than template'],
];
}
// -------------------------------------------------------------------------
// Matching :: Simple Strings
/**
* @dataProvider simpleStringProvider
* @param string $template
* @param string $target
*/
public function testMatchesSimpleStrings(string $template, string $target): void
{
$route = new TemplateRoute($template, $this->methodMap->reveal());
$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
{
$route = new TemplateRoute($template, $this->methodMap->reveal());
$route->matchesRequestTarget($target);
$this->assertArrayHasSameContents($this->getExpectedValues($variables), $route->getPathVariables());
}
public function simpleStringProvider(): array
{
return [
['/foo', '/foo', []],
['/{var}', '/value', ['var']],
['/{hello}', '/Hello%20World%21', ['hello']],
['/{x,hello,y}', '/1024,Hello%20World%21,768', ['x', 'hello', 'y']],
['/{x,hello,y}', '/1024,Hello%20World%21,768', ['x', 'hello', 'y']],
];
}
// -------------------------------------------------------------------------
// Matching :: Reserved
/**
* @dataProvider reservedStringProvider
* @param string $template
* @param string $target
*/
public function testMatchesReservedStrings(string $template, string $target): void
{
$route = new TemplateRoute($template, $this->methodMap->reveal());
$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
{
$route = new TemplateRoute($template, $this->methodMap->reveal());
$route->matchesRequestTarget($target);
$this->assertSame($this->getExpectedValues($variables), $route->getPathVariables());
}
public function reservedStringProvider(): array
{
return [
['/{+var}', '/value', ['var']],
['/{+hello}', '/Hello%20World!', ['hello']],
['{+path}/here', '/foo/bar/here', ['path']],
];
}
// -------------------------------------------------------------------------
// Matching :: Label Expansion
/**
* @dataProvider labelWithDotPrefixProvider
* @param string $template
* @param string $target
*/
public function testMatchesLabelWithDotPrefix(string $template, string $target): void
{
$route = new TemplateRoute($template, $this->methodMap->reveal());
$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
{
$route = new TemplateRoute($template, $this->methodMap->reveal());
$route->matchesRequestTarget($target);
$this->assertArrayHasSameContents($this->getExpectedValues($variables), $route->getPathVariables());
}
public function labelWithDotPrefixProvider(): array
{
return [
['/{.who}', '/.fred', ['who']],
['/{.half,who}', '/.50%25.fred', ['half', 'who']],
['/X{.empty}', '/X.', ['empty']]
];
}
// -------------------------------------------------------------------------
// Matching :: Path Segments
/**
* @dataProvider pathSegmentProvider
* @param string $template
* @param string $target
*/
public function testMatchesPathSegments(string $template, string $target): void
{
$route = new TemplateRoute($template, $this->methodMap->reveal());
$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
{
$route = new TemplateRoute($template, $this->methodMap->reveal());
$route->matchesRequestTarget($target);
$this->assertArrayHasSameContents($this->getExpectedValues($variables), $route->getPathVariables());
}
public function pathSegmentProvider(): array
{
return [
['{/who}', '/fred', ['who']],
['{/half,who}', '/50%25/fred', ['half', 'who']],
['{/var,empty}', '/value/', ['var', 'empty']]
];
}
// -------------------------------------------------------------------------
// Matching :: Explosion
/**
* @dataProvider pathExplosionProvider
* @param string $template
* @param string $target
*/
public function testMatchesExplosion(string $template, string $target): void
{
$route = new TemplateRoute($template, $this->methodMap->reveal());
$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
{
$route = new TemplateRoute($template, $this->methodMap->reveal());
$route->matchesRequestTarget($target);
$this->assertArrayHasSameContents($this->getExpectedValues($variables), $route->getPathVariables());
}
public function pathExplosionProvider(): array
{
return [
['/{count*}', '/one,two,three', ['count']],
['{/count*}', '/one/two/three', ['count']],
['X{.list*}', 'X.red.green.blue', ['list']]
];
}
}

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