feat(middleware): Interceptor of Request

It's possible now to set a request interceptor to modify the existing request.

Author: Antoine Aflalo

src/Client/IOAuthClient.php

@@ -10,6 +10,7 @@
 
 use League\OAuth2\Client\Token\AccessToken;
 use ZEROSPAM\Framework\SDK\Client\Middleware\IMiddleware;
+use ZEROSPAM\Framework\SDK\Client\Middleware\IPreRequestMiddleware;
 use ZEROSPAM\Framework\SDK\Request\Api\IRequest;
 use ZEROSPAM\Framework\SDK\Response\Api\IResponse;
 
@@ -62,4 +63,22 @@ public function getToken(): AccessToken;
      * @return IResponse
      */
     public function processRequest(IRequest $request): IResponse;
+
+    /**
+     * Register a pre request middleware
+     *
+     * @param IPreRequestMiddleware $middleware
+     *
+     * @return IOAuthClient
+     */
+    public function registerPreRequestMiddleware(IPreRequestMiddleware $middleware): IOAuthClient;
+
+    /**
+     * UnRegister a pre request middleware
+     *
+     * @param IPreRequestMiddleware $middleware
+     *
+     * @return IOAuthClient
+     */
+    public function unregisterPreRequestMiddleware(IPreRequestMiddleware $middleware): IOAuthClient;
 }

src/Client/Middleware/IPreRequestMiddleware.php

@@ -0,0 +1,30 @@
+<?php
+/**
+ * Created by PhpStorm.
+ * User: aaflalo
+ * Date: 18-06-11
+ * Time: 15:42
+ */
+
+namespace ZEROSPAM\Framework\SDK\Client\Middleware;
+
+use ZEROSPAM\Framework\SDK\Request\Api\IRequest;
+
+/**
+ * Interface IPreRequestMiddleware
+ *
+ * Change the request before processing it
+ *
+ * @package ZEROSPAM\Framework\SDK\Client\Middleware
+ */
+interface IPreRequestMiddleware
+{
+
+    /**
+     * Handle the request before processing
+     *
+     * @param IRequest $request
+     *
+     */
+    public function handle(IRequest $request): void;
+}

src/Client/OAuthClient.php

@@ -18,6 +18,7 @@
 use ZEROSPAM\Framework\SDK\Client\Exception\SDKException;
 use ZEROSPAM\Framework\SDK\Client\Exception\TooManyRetriesException;
 use ZEROSPAM\Framework\SDK\Client\Middleware\IMiddleware;
+use ZEROSPAM\Framework\SDK\Client\Middleware\IPreRequestMiddleware;
 use ZEROSPAM\Framework\SDK\Config\IOAuthConfiguration;
 use ZEROSPAM\Framework\SDK\Request\Api\IRequest;
 use ZEROSPAM\Framework\SDK\Request\Type\RequestType;
@@ -56,7 +57,11 @@ class OAuthClient implements IOAuthClient
     /**
      * @var \ZEROSPAM\Framework\SDK\Client\Middleware\IMiddleware[][]
      */
-    private $middlewares;
+    private $postRequestMiddlewares = [];
+    /**
+     * @var IPreRequestMiddleware[]
+     */
+    private $preRequestMiddlewares = [];
 
     /**
      * OauthClient constructor.
@@ -87,12 +92,26 @@ public function registerMiddleware(IMiddleware $middleware): IOAuthClient
     {
         $middleware->setClient($this);
         foreach ($middleware::statusCode() as $statusCode) {
-            $this->middlewares[$statusCode][] = $middleware;
+            $this->postRequestMiddlewares[$statusCode][] = $middleware;
         }
 
         return $this;
     }
 
+    /**
+     * Register a pre request middleware
+     *
+     * @param IPreRequestMiddleware $middleware
+     *
+     * @return IOAuthClient
+     */
+    public function registerPreRequestMiddleware(IPreRequestMiddleware $middleware): IOAuthClient
+    {
+        $this->preRequestMiddlewares[get_class($middleware)] = $middleware;
+
+        return $this;
+    }
+
     /**
      * Unregister the middleware.
      *
@@ -106,26 +125,40 @@ public function unregisterMiddleware(IMiddleware $middleware): IOAuthClient
     {
         $middlewareClass = get_class($middleware);
         foreach ($middleware::statusCode() as $statusCode) {
-            if (!isset($this->middlewares[$statusCode])) {
+            if (!isset($this->postRequestMiddlewares[$statusCode])) {
                 continue;
             }
             $result = array_filter(
-                $this->middlewares[$statusCode],
+                $this->postRequestMiddlewares[$statusCode],
                 function (IMiddleware $currMiddleware) use ($middlewareClass) {
                     return get_class($currMiddleware) != $middlewareClass;
                 }
             );
 
             if (empty($result)) {
-                unset($this->middlewares[$statusCode]);
+                unset($this->postRequestMiddlewares[$statusCode]);
             } else {
-                $this->middlewares[$statusCode] = $result;
+                $this->postRequestMiddlewares[$statusCode] = $result;
             }
         }
 
         return $this;
     }
 
+    /**
+     * UnRegister a pre request middleware
+     *
+     * @param IPreRequestMiddleware $middleware
+     *
+     * @return IOAuthClient
+     */
+    public function unregisterPreRequestMiddleware(IPreRequestMiddleware $middleware): IOAuthClient
+    {
+        unset($this->preRequestMiddlewares[get_class($middleware)]);
+
+        return $this;
+    }
+
     /**
      * Refresh token.
      */
@@ -153,6 +186,9 @@ public function getToken(): AccessToken
      */
     public function processRequest(IRequest $request): IResponse
     {
+        foreach ($this->preRequestMiddlewares as $middleware) {
+            $middleware->handle($request);
+        }
         $request->incrementTries();
 
         $headers = $this->configuration->getProvider()->getHeaders($this->token);
@@ -168,8 +204,8 @@ public function processRequest(IRequest $request): IResponse
             $response   = $this->guzzleClient->request($request->httpType()->getValue(), $request->toUri(), $options);
             $parsedData = JSONParsing::responseToJson($response);
 
-            if (isset($this->middlewares[$response->getStatusCode()])) {
-                foreach ($this->middlewares[$response->getStatusCode()] as $middleware) {
+            if (isset($this->postRequestMiddlewares[$response->getStatusCode()])) {
+                foreach ($this->postRequestMiddlewares[$response->getStatusCode()] as $middleware) {
                     $parsedData = $middleware->handle($request, $response, $parsedData);
                 }
             }
@@ -180,12 +216,12 @@ public function processRequest(IRequest $request): IResponse
             $response = $e->getResponse();
             $this->processThrottleData($response);
 
-            if (!isset($this->middlewares[$response->getStatusCode()])) {
+            if (!isset($this->postRequestMiddlewares[$response->getStatusCode()])) {
                 throw new SDKException($e->getMessage(), $e->getCode(), $e);
             }
             $parsedData = JSONParsing::responseToJson($response);
 
-            foreach ($this->middlewares[$response->getStatusCode()] as $middleware) {
+            foreach ($this->postRequestMiddlewares[$response->getStatusCode()] as $middleware) {
                 $parsedData = $middleware->handle($request, $response, $parsedData);
             }
         } catch (RequestException $e) {
@@ -200,7 +236,7 @@ public function processRequest(IRequest $request): IResponse
         }
 
         /**
-         * @var BaseResponse
+         * @var $data BaseResponse
          */
         $data = $request->processResponse($parsedData);
 

…/Tests/Middleware/AuthMiddlewareTest.php …src/Tests/Middleware/MiddlewareTests.phptests/src/Tests/Middleware/AuthMiddlewareTest.php renamed to tests/src/Tests/Middleware/MiddlewareTests.php tests/src/Tests/Middleware/AuthMiddlewareTest.php renamed to tests/src/Tests/Middleware/MiddlewareTests.php

@@ -11,12 +11,13 @@
 use GuzzleHttp\Psr7\Response;
 use ZEROSPAM\Framework\SDK\Client\IOAuthClient;
 use ZEROSPAM\Framework\SDK\Client\Middleware\Error\AuthenticationMiddleware;
+use ZEROSPAM\Framework\SDK\Client\Middleware\IPreRequestMiddleware;
 use ZEROSPAM\Framework\SDK\Test\Base\Data\TestRequest;
 use ZEROSPAM\Framework\SDK\Test\Base\Data\TestResponse;
 use ZEROSPAM\Framework\SDK\Test\Base\TestCase;
 use ZEROSPAM\Framework\SDK\Test\Base\Util\AccessTokenGenerator;
 
-class AuthMiddlewareTest extends TestCase
+class MiddlewareTests extends TestCase
 {
     public function testAuthMiddlewareRefreshToken(): void
     {
@@ -65,4 +66,21 @@ public function testAuthMiddlewareGiveUpAfterTooManyRetries(): void
             ->registerMiddleware(new AuthenticationMiddleware())
             ->processRequest(new TestRequest());
     }
+
+    public function testPreRequestMiddleware(): void
+    {
+        $client  = $this->preSuccess([]);
+        $request = new TestRequest();
+
+        $mock = \Mockery::mock(IPreRequestMiddleware::class)
+                        ->shouldReceive('handle')
+                        ->once()
+                        ->andReturnUndefined();
+
+        $client->getOAuthTestClient()
+               ->registerPreRequestMiddleware($mock->getMock())
+               ->processRequest($request);
+
+        $this->assertInstanceOf(TestRequest::class, $request);
+    }
 }