Skip to content

Commit 671d9d7

Browse files
dbusagikazarmark
dbu
authored and
sagikazarmark
committed
Add Symfony port RequestMatcher, deprecate RegexRequestMatcher
1 parent fe9938e commit 671d9d7

File tree

6 files changed

+193
-2
lines changed

6 files changed

+193
-2
lines changed

‎CHANGELOG.md

+3
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@
44

55
### Added
66

7+
- The RequestMatcher is built after the Symfony RequestMatcher and separates
8+
scheme, host and path expressions and provides an option to filter on the
9+
method. The RegexRequestMatcher is deprecated and will be removed in 2.0.
710
- New RequestConditional authentication method using request matchers (deprecates Matching auth method)
811

912

‎composer.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@
4848
},
4949
"extra": {
5050
"branch-alias": {
51-
"dev-master": "1.1-dev"
51+
"dev-master": "1.2-dev"
5252
}
5353
}
5454
}

‎spec/RequestMatcher/RequestMatcherSpec.php

+101
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,101 @@
1+
<?php
2+
3+
namespace spec\Http\Message\RequestMatcher;
4+
5+
use Http\Message\RequestMatcher;
6+
use Psr\Http\Message\RequestInterface;
7+
use Psr\Http\Message\UriInterface;
8+
use PhpSpec\ObjectBehavior;
9+
10+
class RequestMatcherSpec extends ObjectBehavior
11+
{
12+
function it_is_initializable()
13+
{
14+
$this->shouldHaveType('Http\Message\RequestMatcher\RequestMatcher');
15+
}
16+
17+
function it_is_a_request_matcher()
18+
{
19+
$this->shouldImplement('Http\Message\RequestMatcher');
20+
}
21+
22+
function it_matches_a_path(RequestInterface $request, UriInterface $uri)
23+
{
24+
$this->beConstructedWith('^/tes?');
25+
26+
$request->getUri()->willReturn($uri);
27+
$uri->getPath()->willReturn('/test/foo');
28+
29+
$this->matches($request)->shouldReturn(true);
30+
}
31+
32+
function it_does_not_match_a_path(RequestInterface $request, UriInterface $uri)
33+
{
34+
$this->beConstructedWith('#^/tes?#');
35+
36+
$request->getUri()->willReturn($uri);
37+
$uri->getPath()->willReturn('/ttttt');
38+
39+
$this->matches($request)->shouldReturn(false);
40+
}
41+
42+
43+
function it_matches_a_host(RequestInterface $request, UriInterface $uri)
44+
{
45+
$this->beConstructedWith(null, 'php-htt?');
46+
47+
$request->getUri()->willReturn($uri);
48+
$uri->getHost()->willReturn('php-http.org');
49+
50+
$this->matches($request)->shouldReturn(true);
51+
}
52+
53+
function it_does_not_match_a_host(RequestInterface $request, UriInterface $uri)
54+
{
55+
$this->beConstructedWith(null, 'php-htt?');
56+
57+
$request->getUri()->willReturn($uri);
58+
$uri->getHost()->willReturn('httplug.io');
59+
60+
$this->matches($request)->shouldReturn(false);
61+
}
62+
63+
function it_matches_a_method(RequestInterface $request)
64+
{
65+
$this->beConstructedWith(null, null, 'get');
66+
67+
$request->getMethod()->willReturn('GET');
68+
69+
$this->matches($request)->shouldReturn(true);
70+
}
71+
72+
function it_does_not_match_a_method(RequestInterface $request)
73+
{
74+
$this->beConstructedWith(null, null, 'get');
75+
76+
$request->getMethod()->willReturn('post');
77+
78+
$this->matches($request)->shouldReturn(false);
79+
}
80+
81+
82+
function it_matches_a_scheme(RequestInterface $request, UriInterface $uri)
83+
{
84+
$this->beConstructedWith(null, null, null, 'http');
85+
86+
$request->getUri()->willReturn($uri);
87+
$uri->getScheme()->willReturn('http');
88+
89+
$this->matches($request)->shouldReturn(true);
90+
}
91+
92+
function it_does_not_match_a_scheme(RequestInterface $request, UriInterface $uri)
93+
{
94+
$this->beConstructedWith(null, null, null, 'http');
95+
96+
$request->getUri()->willReturn($uri);
97+
$uri->getScheme()->willReturn('https');
98+
99+
$this->matches($request)->shouldReturn(false);
100+
}
101+
}

‎src/Authentication/Matching.php

+3-1
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,14 @@
66
use Http\Message\RequestMatcher\CallbackRequestMatcher;
77
use Psr\Http\Message\RequestInterface;
88

9+
@trigger_error('The '.__NAMESPACE__.'\Matching class is deprecated since version 1.2 and will be removed in 2.0. Use Http\Message\Authentication\RequestConditional instead.', E_USER_DEPRECATED);
10+
911
/**
1012
* Authenticate a PSR-7 Request if the request is matching.
1113
*
1214
* @author Márk Sági-Kazár <[email protected]>
1315
*
14-
* @deprecated since since version 1.1, to be removed in 2.0. Use {@link RequestConditional} instead.
16+
* @deprecated since since version 1.2, and will be removed in 2.0. Use {@link RequestConditional} instead.
1517
*/
1618
final class Matching implements Authentication
1719
{

‎src/RequestMatcher/RegexRequestMatcher.php

+7
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,14 @@
55
use Http\Message\RequestMatcher;
66
use Psr\Http\Message\RequestInterface;
77

8+
@trigger_error('The '.__NAMESPACE__.'\RegexRequestMatcher class is deprecated since version 1.2 and will be removed in 2.0. Use Http\Message\RequestMatcher\RequestMatcher instead.', E_USER_DEPRECATED);
9+
810
/**
911
* Match a request with a regex on the uri.
1012
*
1113
* @author Joel Wurtz <[email protected]>
14+
*
15+
* @deprecated since version 1.2 and will be removed in 2.0. Use {@link RequestMatcher} instead.
1216
*/
1317
final class RegexRequestMatcher implements RequestMatcher
1418
{
@@ -19,6 +23,9 @@ final class RegexRequestMatcher implements RequestMatcher
1923
*/
2024
private $regex;
2125

26+
/**
27+
* @param string $regex
28+
*/
2229
public function __construct($regex)
2330
{
2431
$this->regex = $regex;

‎src/RequestMatcher/RequestMatcher.php

+78
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
<?php
2+
3+
namespace Http\Message\RequestMatcher;
4+
5+
use Http\Message\RequestMatcher as RequestMatcherInterface;
6+
use Psr\Http\Message\RequestInterface;
7+
8+
/**
9+
* A port of the Symfony RequestMatcher for PSR-7.
10+
*
11+
* @author Fabien Potencier <[email protected]>
12+
* @author Joel Wurtz <[email protected]>
13+
*/
14+
final class RequestMatcher implements RequestMatcherInterface
15+
{
16+
/**
17+
* @var string
18+
*/
19+
private $path;
20+
21+
/**
22+
* @var string
23+
*/
24+
private $host;
25+
26+
/**
27+
* @var array
28+
*/
29+
private $methods = [];
30+
31+
/**
32+
* @var string[]
33+
*/
34+
private $schemes = [];
35+
36+
/**
37+
* The regular expressions used for path or host must be specified without delimiter.
38+
* You do not need to escape the forward slash / to match it.
39+
*
40+
* @param string|null $path Regular expression for the path
41+
* @param string|null $host Regular expression for the hostname
42+
* @param string|string[]|null $methods Method or list of methods to match
43+
* @param string|string[]|null $schemes Scheme or list of schemes to match (e.g. http or https)
44+
*/
45+
public function __construct($path = null, $host = null, $methods = [], $schemes = [])
46+
{
47+
$this->path = $path;
48+
$this->host = $host;
49+
$this->methods = array_map('strtoupper', (array) $methods);
50+
$this->schemes = array_map('strtolower', (array) $schemes);
51+
}
52+
53+
/**
54+
* {@inheritdoc}
55+
*
56+
* @api
57+
*/
58+
public function matches(RequestInterface $request)
59+
{
60+
if ($this->schemes && !in_array($request->getUri()->getScheme(), $this->schemes)) {
61+
return false;
62+
}
63+
64+
if ($this->methods && !in_array($request->getMethod(), $this->methods)) {
65+
return false;
66+
}
67+
68+
if (null !== $this->path && !preg_match('{'.$this->path.'}', rawurldecode($request->getUri()->getPath()))) {
69+
return false;
70+
}
71+
72+
if (null !== $this->host && !preg_match('{'.$this->host.'}i', $request->getUri()->getHost())) {
73+
return false;
74+
}
75+
76+
return true;
77+
}
78+
}

0 commit comments

Comments
 (0)