Merge branch 'conditional-responses'

Author: dbu

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Change Log
 
+## 1.2.1 - 2019-02-21
+
+### Added
+
+- Conditional mock functionality
+
 ## 1.2.0 - 2019-01-19
 
 ### Added

spec/ClientSpec.php

@@ -4,6 +4,7 @@
 
 use Http\Client\HttpAsyncClient;
 use Http\Client\HttpClient;
+use Http\Message\RequestMatcher;
 use Http\Message\ResponseFactory;
 use Http\Mock\Client;
 use Psr\Http\Message\RequestInterface;
@@ -106,4 +107,51 @@ function it_reset(
 
         $this->getRequests()->shouldReturn([]);
     }
+    function it_returns_response_if_request_matcher_matches(
+        RequestMatcher $matcher,
+        RequestInterface $request,
+        ResponseInterface $response
+    ) {
+        $matcher->matches($request)->willReturn(true);
+        $this->on($matcher, $response);
+        $this->sendRequest($request)->shouldReturn($response);
+    }
+
+    function it_throws_exception_if_request_matcher_matches(
+        RequestMatcher $matcher,
+        RequestInterface $request
+    ) {
+        $matcher->matches($request)->willReturn(true);
+        $this->on($matcher, new \Exception());
+        $this->shouldThrow('Exception')->duringSendRequest($request);
+    }
+
+    function it_skips_conditional_response_if_matcher_returns_false(
+        RequestMatcher $matcher,
+        RequestInterface $request,
+        ResponseInterface $expectedResponse,
+        ResponseInterface $skippedResponse
+    ) {
+        $matcher->matches($request)->willReturn(false);
+        $this->on($matcher, $skippedResponse);
+        $this->addResponse($expectedResponse);
+        $this->sendRequest($request)->shouldReturn($expectedResponse);
+    }
+
+    function it_calls_callable_with_request_as_argument_when_matcher_returns_true(
+        RequestMatcher $matcher,
+        RequestInterface $request,
+        ResponseInterface $response
+    ) {
+        $matcher->matches($request)->willReturn(true);
+
+        $this->on(
+            $matcher,
+            function(RequestInterface $request) use ($response) {
+                return $response->getWrappedObject();
+            }
+        );
+
+        $this->sendRequest($request)->shouldReturn($response);
+    }
 }

src/Client.php

@@ -8,7 +8,9 @@
 use Http\Client\HttpAsyncClient;
 use Http\Client\HttpClient;
 use Http\Discovery\MessageFactoryDiscovery;
+use Http\Message\RequestMatcher;
 use Http\Message\ResponseFactory;
+use Psr\Http\Client\ClientExceptionInterface;
 use Psr\Http\Message\RequestInterface;
 use Psr\Http\Message\ResponseInterface;
 
@@ -30,6 +32,11 @@ class Client implements HttpClient, HttpAsyncClient
      */
     private $responseFactory;
 
+    /**
+     * @var array
+     */
+    private $conditionalResults = [];
+
     /**
      * @var RequestInterface[]
      */
@@ -67,6 +74,22 @@ public function doSendRequest(RequestInterface $request)
     {
         $this->requests[] = $request;
 
+        foreach ($this->conditionalResults as $result) {
+            /**
+             * @var RequestMatcher
+             */
+            $matcher = $result['matcher'];
+
+            /**
+             * @var callable
+             */
+            $callable = $result['callable'];
+
+            if ($matcher->matches($request)) {
+                return $callable($request);
+            }
+        }
+
         if (count($this->exceptions) > 0) {
             throw array_shift($this->exceptions);
         }
@@ -87,6 +110,46 @@ public function doSendRequest(RequestInterface $request)
         return $this->responseFactory->createResponse();
     }
 
+    /**
+     * Adds an exception to be thrown or response to be returned if the request
+     * matcher matches.
+     *
+     * For more complex logic, pass a callable as $result. The method is given
+     * the request and MUST either return a ResponseInterface or throw an
+     * exception that implements the PSR-18 / HTTPlug exception interface.
+     *
+     * @param ResponseInterface|Exception|ClientExceptionInterface|callable $result
+     */
+    public function on(RequestMatcher $requestMatcher, $result)
+    {
+        $callable = null;
+
+        switch (true) {
+            case is_callable($result):
+                $callable = $result;
+
+                break;
+            case $result instanceof ResponseInterface:
+                $callable = function () use ($result) {
+                    return $result;
+                };
+
+                break;
+            case $result instanceof \Exception:
+                $callable = function () use ($result) {
+                    throw $result;
+                };
+
+                break;
+            default:
+                throw new \InvalidArgumentException('Result must be either a response, an exception, or a callable');
+        }
+        $this->conditionalResults[] = [
+            'matcher' => $requestMatcher,
+            'callable' => $callable,
+        ];
+    }
+
     /**
      * Adds an exception that will be thrown.
      */