version 3

Author: ddrv

.gitattributes

@@ -4,6 +4,5 @@
 *.yml   text eol=lf
 *.dist  text eol=lf
 LICENCE text eol=lf
-stuff/  export-ignore
 tests/  export-ignore
 *.dist  export-ignore

.github/ISSUE_TEMPLATE/bug_report.md

@@ -15,8 +15,8 @@ assignees: ddrv
 
 ### Additional info
 
-| Q                | A
-| ---------------- | ---
-| Library version  | 1.?
-| PHP version      | ?
-| Operating system | ?
+| Q                | A   |
+|------------------|-----|
+| Library version  | 3.? |
+| PHP version      | ?   |
+| Operating system | ?   |

.github/workflows/ci.yml

@@ -39,5 +39,8 @@ jobs:
       - name: Check code style
         run: vendor/bin/phpcs
 
+      - name: Stat Analise
+        run: vendor/bin/psalm
+
       - name: Run test suite
         run: vendor/bin/phpunit

.gitignore

@@ -2,3 +2,4 @@ vendor/
 composer.lock
 phpcs.xml
 phpunit.xml
+psalm.xml

README.md

@@ -12,7 +12,7 @@ Mock for PSR-18 HTTP client
 Add package to project
 
 ```bash
-composer require --dev webclient/fake-http-client:^2.0
+composer require --dev webclient/fake-http-client:^3.0
 ```
 
 Set autoload
@@ -40,16 +40,56 @@ $client = new FakeHttpClient($handler);
 
 $response = $client->sendRequest($request);
 ```
+# Handlers
 
-# Routing
+## SpecHandler
+
+This package provides universal handler `\Webclient\Fake\Handler\SpecHandler\SpecHandler` 
+and builder `\Webclient\Fake\Handler\SpecHandler\SpecHandlerBuilder`. 
+With it, you can customize the client for almost any need.
+
+```php
+<?php
+
+use Psr\Http\Message\ResponseInterface;
+use Webclient\Fake\FakeHttpClient;
+use Webclient\Fake\Handler\SpecHandler\SpecHandlerBuilder;
+use Webclient\Fake\Handler\SpecHandler\Rule;
+
+$builder = SpecHandlerBuilder::create();
+
+$builder
+    ->route(function (Rule $rule) {
+        $rule->notEqual('header.authorization', 'bearer xxx');
+        $rule->oneOf(function (Rule $rule) {
+            $rule->allOf(function (Rule $rule) {
+                $rule->equal('uri.path', '/api/v1/posts');
+                $rule->equal('method', 'POST');
+            });
+            $rule->allOf(function (Rule $rule) {
+                $rule->match('uri.path', '^/api/v1/posts/([a-zA-Z0-9\-]+)$');
+                $rule->match('method', '^(PUT|DELETE)$');
+            });
+        });
+    })
+    ->response(function (ResponseInterface $response): ResponseInterface {
+        return $response->withStatus(403);
+    });
+
+$handler = $builder->build();
+
+$client = new FakeHttpClient($handler);
+```
+
+## SimpleRoutingHandler
 
 This package provides simple routing.
 
 ```php
 <?php
 
 use Webclient\Fake\FakeHttpClient;
-use Webclient\Fake\Handler\SimpleRoutingHandler;
+use Webclient\Fake\Handler\SimpleRoutingHandler\SimpleRoutingHandler;
 use Psr\Http\Message\RequestInterface;
 use Psr\Http\Server\RequestHandlerInterface;
 

composer.json

@@ -17,13 +17,14 @@
     "ext-mbstring": "*",
     "psr/http-client": "^1.0",
     "psr/http-message": "^1.0",
+    "psr/http-factory": "^1.0",
     "psr/http-server-handler": "^1.0"
   },
   "require-dev": {
-    "psr/http-factory": "^1.0",
     "nyholm/psr7": "^1.5",
     "phpunit/phpunit": "^6.5 || ^7.5 || 8.5 || 9.5",
-    "squizlabs/php_codesniffer": "^3.5"
+    "squizlabs/php_codesniffer": "^3.5",
+    "vimeo/psalm": "^4.30"
   },
   "provide": {
     "psr/http-client-implementation": "1.0"
@@ -35,14 +36,19 @@
   },
   "autoload-dev": {
     "psr-4": {
-      "Webclient\\Stuff\\Fake\\": "stuff/",
-      "Webclient\\Tests\\Fake\\": "tests/"
+      "Tests\\Webclient\\Fake\\Tools\\": "tests/src",
+      "Tests\\Webclient\\Fake\\Unit\\": "tests/unit"
     }
   },
   "funding": [
     {
       "type": "other",
       "url": "https://www.paypal.me/ddrv"
     }
-  ]
+  ],
+  "config": {
+    "allow-plugins": {
+      "composer/package-versions-deprecated": true
+    }
+  }
 }

phpcs.xml.dist

@@ -12,6 +12,5 @@
 
     <!-- Paths to check -->
     <file>src</file>
-    <file>stuff</file>
     <file>tests</file>
 </ruleset>

phpunit.xml.dist

@@ -2,7 +2,7 @@
 <phpunit bootstrap="vendor/autoload.php" colors="true" cacheResult="false">
     <testsuites>
         <testsuite name="all">
-            <directory>tests</directory>
+            <directory>tests/unit</directory>
         </testsuite>
     </testsuites>
 </phpunit>

psalm.xml.dist

@@ -0,0 +1,15 @@
+<?xml version="1.0"?>
+<psalm
+    errorLevel="1"
+    resolveFromConfigFile="true"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xmlns="https://getpsalm.org/schema/config"
+    xsi:schemaLocation="https://getpsalm.org/schema/config vendor/vimeo/psalm/config.xsd"
+>
+    <projectFiles>
+        <directory name="src" />
+        <ignoreFiles>
+            <directory name="vendor" />
+        </ignoreFiles>
+    </projectFiles>
+</psalm>

src/Exception/NetworkError.php

@@ -9,7 +9,7 @@
 use Psr\Http\Message\RequestInterface;
 use Throwable;
 
-class NetworkError extends Exception implements NetworkExceptionInterface
+final class NetworkError extends Exception implements NetworkExceptionInterface
 {
     private RequestInterface $request;
 

src/FakeHttpClient.php

@@ -19,12 +19,12 @@ final class FakeHttpClient implements ClientInterface
     public const NO_REPLACE_ATTRIBUTE = 'webclient-fake-http-client-request-no-replace';
 
     private RequestHandlerInterface $handler;
-    private array $server;
+    private array $serverParams;
 
-    public function __construct(RequestHandlerInterface $handler, array $server = [])
+    public function __construct(RequestHandlerInterface $handler, array $serverParams = [])
     {
         $this->handler = $handler;
-        $this->server = $server;
+        $this->serverParams = $serverParams;
     }
 
     /**
@@ -36,13 +36,8 @@ public function sendRequest(RequestInterface $request): ResponseInterface
             $serverRequest = $request;
         } else {
             $serverRequest = new ServerRequest(
-                $request->getUri(),
-                $request->getBody(),
-                $request->getProtocolVersion(),
-                $request->getMethod(),
-                $request->getRequestTarget(),
-                $request->getHeaders(),
-                $this->server
+                $request,
+                $this->serverParams
             );
         }
         $serverRequest->getBody()->rewind();

src/Handler/SimpleRoutingHandler.php renamed to src/Handler/SimpleRoutingHandler/SimpleRoutingHandler.php

@@ -2,13 +2,13 @@
 
 declare(strict_types=1);
 
-namespace Webclient\Fake\Handler;
+namespace Webclient\Fake\Handler\SimpleRoutingHandler;
 
 use Psr\Http\Message\ResponseInterface;
 use Psr\Http\Message\ServerRequestInterface;
 use Psr\Http\Server\RequestHandlerInterface;
 
-class SimpleRoutingHandler implements RequestHandlerInterface
+final class SimpleRoutingHandler implements RequestHandlerInterface
 {
     /** @var RequestHandlerInterface[] */
     private array $handlers = [];

src/Handler/SpecHandler/Comparer/ComparerInterface.php

@@ -0,0 +1,10 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Webclient\Fake\Handler\SpecHandler\Comparer;
+
+interface ComparerInterface
+{
+    public function compare(?string $pattern, ?string $actual): bool;
+}

src/Handler/SpecHandler/Comparer/ContainsComparer.php

@@ -0,0 +1,19 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Webclient\Fake\Handler\SpecHandler\Comparer;
+
+final class ContainsComparer implements ComparerInterface
+{
+    public function compare(?string $pattern, ?string $actual): bool
+    {
+        if (is_null($pattern) && is_null($actual)) {
+            return true;
+        }
+        if (is_null($pattern) || is_null($actual)) {
+            return false;
+        }
+        return strpos($actual, $pattern) !== false;
+    }
+}

src/Handler/SpecHandler/Comparer/EqualComparer.php

@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Webclient\Fake\Handler\SpecHandler\Comparer;
+
+final class EqualComparer implements ComparerInterface
+{
+    public function compare(?string $pattern, ?string $actual): bool
+    {
+        return $pattern === $actual;
+    }
+}

src/Handler/SpecHandler/Comparer/MatchComparer.php

@@ -0,0 +1,21 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Webclient\Fake\Handler\SpecHandler\Comparer;
+
+final class MatchComparer implements ComparerInterface
+{
+    public function compare(?string $pattern, ?string $actual): bool
+    {
+        if (is_null($pattern)) {
+            return true;
+        }
+        $pattern = trim($pattern);
+        if ($pattern === '') {
+            return true;
+        }
+        preg_match('#' . $pattern . '#u', (string)$actual, $matches);
+        return !empty($matches);
+    }
+}

src/Handler/SpecHandler/Condition/AndCondition.php

@@ -0,0 +1,30 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Webclient\Fake\Handler\SpecHandler\Condition;
+
+use Psr\Http\Message\ServerRequestInterface;
+
+final class AndCondition implements ConditionInterface
+{
+    /**
+     * @var ConditionInterface[]
+     */
+    private array $conditions;
+
+    public function __construct(ConditionInterface ...$conditions)
+    {
+        $this->conditions = $conditions;
+    }
+
+    public function check(ServerRequestInterface $request): bool
+    {
+        foreach ($this->conditions as $condition) {
+            if (!$condition->check($request)) {
+                return false;
+            }
+        }
+        return true;
+    }
+}

src/Handler/SpecHandler/Condition/ConditionInterface.php

@@ -0,0 +1,10 @@
+<?php
+
+namespace Webclient\Fake\Handler\SpecHandler\Condition;
+
+use Psr\Http\Message\ServerRequestInterface;
+
+interface ConditionInterface
+{
+    public function check(ServerRequestInterface $request): bool;
+}

src/Handler/SpecHandler/Condition/NotCondition.php

@@ -0,0 +1,22 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Webclient\Fake\Handler\SpecHandler\Condition;
+
+use Psr\Http\Message\ServerRequestInterface;
+
+final class NotCondition implements ConditionInterface
+{
+    private ConditionInterface $condition;
+
+    public function __construct(ConditionInterface $condition)
+    {
+        $this->condition = $condition;
+    }
+
+    public function check(ServerRequestInterface $request): bool
+    {
+        return !$this->condition->check($request);
+    }
+}