(chore) fix CS. Fix failed tests

Author: skie

composer.json

@@ -34,10 +34,10 @@
         "firebase/php-jwt": "^5.0"
     },
     "require-dev": {
-        "phpunit/phpunit": "^8.0",
+        "cakephp/cakephp-codesniffer": "dev-next",
         "league/flysystem-vfs": "^1.0",
-        "vlucas/phpdotenv": "^3.3",
-        "cakephp/cakephp-codesniffer": "dev-next"
+        "phpunit/phpunit": "^8.0",
+        "vlucas/phpdotenv": "^3.3"
     },
     "autoload": {
         "psr-4": {
@@ -68,6 +68,7 @@
         "stan": "phpstan analyse src/ && psalm --show-info=false",
         "psalm": "psalm --show-info=false",
         "stan-setup": "cp composer.json composer.backup && composer require --dev phpstan/phpstan:^0.11 vimeo/psalm:^3.0 && mv composer.backup composer.json", 
+        "rector": "rector process src/",
         "rector-setup": "cp composer.json composer.backup && composer require --dev rector/rector:^0.4.11 && mv composer.backup composer.json", 
         "coverage-test": "phpunit --stderr --coverage-clover=clover.xml"
     }

src/Controller/ApiController.php

@@ -57,9 +57,9 @@ public function process()
      *
      * @return void
      */
-    public function listing()
+    public function listing(): void
     {
-        $this->setRequest( $this->getRequest()->withParam('service', 'listing'));
+        $this->setRequest($this->getRequest()->withParam('service', 'listing'));
         $options = [
             'className' => 'CakeDC/Api.Listing',
         ];
@@ -71,9 +71,9 @@ public function listing()
      *
      * @return void
      */
-    public function describe()
+    public function describe(): void
     {
-        $this->setRequest( $this->getRequest()->withParam('service', 'describe'));
+        $this->setRequest($this->getRequest()->withParam('service', 'describe'));
         $options = [
             'className' => 'CakeDC/Api.Describe',
         ];
@@ -86,7 +86,7 @@ public function describe()
      * @param array $options Options
      * @return \Cake\Http\Client\Response|\Cake\Http\Response|null
      */
-    protected function _process($options = [])
+    protected function _process(array $options = []): \Cake\Http\Response
     {
         $routesInflectorMethod = Configure::read('Api.routesInflectorMethod', 'underscore');
 

src/Controller/AppController.php

@@ -14,6 +14,8 @@
 namespace CakeDC\Api\Controller;
 
 //use App\Controller\AppController as BaseController;
+
+
 use Cake\Controller\Controller as BaseController;
 
 /**

src/Exception/MethodNotAllowedException.php

@@ -44,7 +44,7 @@ public function __construct($message = null, $code = 405, $previous = null)
      * @param string $file file name
      * @return void
      */
-    public function setFile($file = '')
+    public function setFile(string $file = ''): void
     {
         $this->file = $file;
     }
@@ -55,7 +55,7 @@ public function setFile($file = '')
      * @param int $line set the line of the code
      * @return void
      */
-    public function setLine($line = 0)
+    public function setLine(int $line = 0): void
     {
         $this->line = $line;
     }

src/Exception/ServiceException.php

@@ -44,7 +44,7 @@ public function __construct($message = null, $code = 500, $previous = null)
      * @param string $file set the file
      * @return void
      */
-    public function setFile($file = '')
+    public function setFile(string $file = ''): void
     {
         $this->file = $file;
     }
@@ -55,7 +55,7 @@ public function setFile($file = '')
      * @param int $line set the line
      * @return void
      */
-    public function setLine($line = 0)
+    public function setLine(int $line = 0): void
     {
         $this->line = $line;
     }

src/Exception/UnauthenticatedException.php

@@ -44,7 +44,7 @@ public function __construct($message = null, $code = 401, $previous = null)
      * @param string $file set file name
      * @return void
      */
-    public function setFile($file = '')
+    public function setFile(string $file = ''): void
     {
         $this->file = $file;
     }
@@ -55,7 +55,7 @@ public function setFile($file = '')
      * @param int $line set the line of the code
      * @return void
      */
-    public function setLine($line = 0)
+    public function setLine(int $line = 0): void
     {
         $this->line = $line;
     }

src/Exception/UnauthorizedException.php

@@ -43,7 +43,7 @@ public function __construct($message = null, $code = 403, $previous = null)
      * @param string $file file name
      * @return void
      */
-    public function setFile($file = '')
+    public function setFile(string $file = ''): void
     {
         $this->file = $file;
     }
@@ -54,7 +54,7 @@ public function setFile($file = '')
      * @param int $line line of the code
      * @return void
      */
-    public function setLine($line = 0)
+    public function setLine(int $line = 0): void
     {
         $this->line = $line;
     }

src/Exception/ValidationException.php

@@ -39,7 +39,7 @@ public function __construct(
         $message = 'Validation errors',
         $code = 0,
         $previous = null,
-        $validationErrors = []
+        array $validationErrors = []
     ) {
         if ($code === 0) {
             $code = $this->_defaultCode;
@@ -54,7 +54,7 @@ public function __construct(
      * @param array $validationErrors the array with the validations
      * @return void
      */
-    public function setValidationErrors($validationErrors = [])
+    public function setValidationErrors(array $validationErrors = []): void
     {
         $this->_validationErrors = $validationErrors;
     }
@@ -64,7 +64,7 @@ public function setValidationErrors($validationErrors = [])
      *
      * @return array
      */
-    public function getValidationErrors()
+    public function getValidationErrors(): array
     {
         return $this->_validationErrors;
     }

src/Middleware/ApiMiddleware.php

@@ -15,25 +15,33 @@
 
 use Cake\Core\Configure;
 use Cake\Http\CallbackStream;
+use Cake\Http\Response;
 use CakeDC\Api\Service\ConfigReader;
 use CakeDC\Api\Service\ServiceRegistry;
 use Exception;
 use Psr\Http\Message\ResponseInterface;
 use Psr\Http\Message\ServerRequestInterface;
+use Psr\Http\Server\MiddlewareInterface;
+use Psr\Http\Server\RequestHandlerInterface;
 
 /**
  * Applies routing rules to the request and creates the controller
  * instance if possible.
  */
-class ApiMiddleware
+class ApiMiddleware implements MiddlewareInterface
 {
     /**
+     * Process an incoming server request.
+     *
+     * Processes an incoming server request in order to produce a response.
+     * If unable to produce the response itself, it may delegate to the provided
+     * request handler to do so.
+     *
      * @param \Psr\Http\Message\ServerRequestInterface $request The request.
-     * @param \Psr\Http\Message\ResponseInterface $response The response.
-     * @param callable $next The next middleware to call.
+     * @param \Psr\Http\Server\RequestHandlerInterface $handler The request handler.
      * @return \Psr\Http\Message\ResponseInterface A response.
      */
-    public function __invoke(ServerRequestInterface $request, ResponseInterface $response, $next)
+    public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface
     {
         $prefix = Configure::read('Api.prefix');
         if (empty($prefix)) {
@@ -42,7 +50,8 @@ public function __invoke(ServerRequestInterface $request, ResponseInterface $res
         $useVersioning = Configure::read('Api.useVersioning');
         if ($useVersioning) {
             $versionPrefix = Configure::read('Api.versionPrefix');
-            $expr = '#/' . $prefix . '/(?<version>' . $versionPrefix . '\d+)' . '/' . '(?<service>[^/?]+)' . '(?<base>/?.*)#';
+            $expr = '#/' . $prefix . '/(?<version>' . $versionPrefix . '\d+)' . '/' .
+                '(?<service>[^/?]+)' . '(?<base>/?.*)#';
         } else {
             $expr = '#/' . $prefix . '/' . '(?<service>[^/?]+)' . '(?<base>/?.*)#';
         }
@@ -60,7 +69,6 @@ public function __invoke(ServerRequestInterface $request, ResponseInterface $res
                 'service' => $service,
                 'version' => $version,
                 'request' => $request,
-                'response' => $response,
                 'baseUrl' => $url,
             ];
 
@@ -71,15 +79,16 @@ public function __invoke(ServerRequestInterface $request, ResponseInterface $res
 
                 $response = $Service->respond($result);
             } catch (Exception $e) {
+                $response = new Response();
                 $response->withStatus(400);
                 $response = $response->withBody(new CallbackStream(function () use ($e) {
-                        echo $e->getMessage();
+                    echo $e->getMessage();
                 }));
             }
 
             return $response;
         }
 
-        return $next($request, $response);
+        return $handler->handle($request);
     }
 }

src/Middleware/RequestHandlerMiddleware.php

@@ -13,115 +13,13 @@
 
 namespace CakeDC\Api\Middleware;
 
-use Cake\Utility\Exception\XmlException;
-use Cake\Utility\Xml;
-use Psr\Http\Message\ResponseInterface;
-use Psr\Http\Message\ServerRequestInterface;
-use RuntimeException;
+use Cake\Http\Middleware\BodyParserMiddleware;
 
 /**
  * Applies routing rules to the request and creates the controller
  * instance if possible.
+ * @deprecated
  */
-class RequestHandlerMiddleware
+class RequestHandlerMiddleware extends BodyParserMiddleware
 {
-    /**
-     * Request object
-     *
-     * @var \Cake\Http\ServerRequest
-     */
-    public $request;
-
-    /**
-     * Response object
-     *
-     * @var \Cake\Http\Response
-     */
-    public $response;
-
-    /**
-     * @param \Psr\Http\Message\ServerRequestInterface $request The request.
-     * @param \Psr\Http\Message\ResponseInterface $response The response.
-     * @param callable $next The next middleware to call.
-     * @return \Psr\Http\Message\ResponseInterface A response.
-     */
-    public function __invoke(ServerRequestInterface $request, ResponseInterface $response, $next)
-    {
-        $inputTypeMap = [
-            'json' => ['json_decode', true],
-            'xml' => [[$this, 'convertXml']],
-        ];
-
-        $this->request = $request;
-        $this->response = $response;
-        $parsedBody = $request->getParsedBody();
-
-        foreach ($inputTypeMap as $type => $handler) {
-            if (!is_callable($handler[0])) {
-                throw new RuntimeException(sprintf("Invalid callable for '%s' type.", $type));
-            }
-            if (empty($parsedBody) && $this->requestedWith($type)) {
-                $input = call_user_func_array([$this->request, 'input'], $handler);
-
-                return $next($request->withParsedBody($input), $response);
-            }
-        }
-
-        return $next($request, $response);
-    }
-
-    /**
-     * Determines the content type of the data the client has sent (i.e. in a POST request)
-     *
-     * @param string|array|null $type Can be null (or no parameter), a string type name, or an array of types
-     * @return mixed If a single type is supplied a boolean will be returned. If no type is provided
-     *   The mapped value of CONTENT_TYPE will be returned. If an array is supplied the first type
-     *   in the request content type will be returned.
-     */
-    public function requestedWith($type = null)
-    {
-        $request = $this->request;
-        if (!$request->is('post') && !$request->is('put') && !$request->is('patch') && !$request->is('delete')) {
-            return null;
-        }
-        if (is_array($type)) {
-            foreach ($type as $t) {
-                if ($this->requestedWith($t)) {
-                    return $t;
-                }
-            }
-
-            return false;
-        }
-
-        [$contentType] = explode(';', $request->contentType());
-        $response = $this->response;
-        if ($type === null) {
-            return $response->mapType($contentType);
-        }
-        if (is_string($type)) {
-            return $type === $response->mapType($contentType);
-        }
-    }
-
-    /**
-     * Helper method to parse xml input data, due to lack of anonymous functions
-     * this lives here.
-     *
-     * @param string $xml XML string.
-     * @return array Xml array data
-     */
-    public function convertXml($xml)
-    {
-        try {
-            $xml = Xml::build($xml, ['readFile' => false]);
-            if (isset($xml->data)) {
-                return Xml::toArray($xml->data);
-            }
-
-            return Xml::toArray($xml);
-        } catch (XmlException $e) {
-            return [];
-        }
-    }
 }