Controller class

src/Controller.php

@@ -0,0 +1,135 @@
+<?php
+
+namespace Jasny;
+
+use Psr\Http\Message\ServerRequestInterface;
+use Psr\Http\Message\ResponseInterface;
+
+/**
+ * Controller
+ */
+abstract class Controller
+{
+    /**
+     * Server request
+     * @var ServerRequestInterface
+     **/
+    protected $request = null;
+
+    /**
+     * Response
+     * @var ResponseInterface
+     **/
+    protected $response = null;
+
+    /**
+     * Run the controller
+     *
+     * @return ResponseInterface
+     */
+    abstract public function run();
+
+    /**
+     * Get request, set for controller
+     *
+     * @return ServerRequestInterface
+     */
+    public function getRequest()
+    {
+        return $this->request;
+    }
+
+    /**
+     * Get response. set for controller
+     *
+     * @return ResponseInterface
+     */
+    public function getResponse()
+    {
+        return $this->response;
+    }
+
+    /**
+     * Run the controller as function
+     *
+     * @param ServerRequestInterface $request
+     * @param ResponseInterface      $response
+     * @return ResponseInterface
+     */
+    public function __invoke(ServerRequestInterface $request, ResponseInterface $response)
+    {
+        $this->request = $request;
+        $this->response = $response;
+
+        return $this->run();
+    }
+
+    /**
+     * Check if response is 2xx succesful, or empty
+     * 
+     * @return boolean
+     */
+    public function isSuccessful()
+    {
+        $code = $this->getResponseStatusCode();
+
+        return !$code || ($code >= 200 && $code < 300);
+    }
+
+    /**
+     * Check if response is a 3xx redirect
+     * 
+     * @return boolean
+     */
+    public function isRedirection()
+    {
+        $code = $this->getResponseStatusCode();
+
+        return $code >= 300 && $code < 400;
+    }
+
+    /**
+     * Check if response is a 4xx client error
+     * 
+     * @return boolean
+     */
+    public function isClientError()
+    {
+        $code = $this->getResponseStatusCode();
+
+        return $code >= 400 && $code < 500;
+    }
+
+    /**
+     * Check if response is a 5xx redirect
+     * 
+     * @return boolean
+     */
+    public function isServerError()
+    {
+        return $this->getResponseStatusCode() >= 500;
+    }   
+
+    /**
+      * Check if response is 4xx or 5xx error
+      *
+      * @return boolean
+      */
+     public function isError()
+     {
+         return $this->isClientError() || $this->isServerError();
+     } 
+
+     /**
+      * Get status code of response
+      *
+      * @return int
+      */
+     protected function getResponseStatusCode()
+     {
+        $response = $this->getResponse();
+
+        return $response ? $response->getStatusCode() : 0;
+     }
+}
+

tests/ControllerTest.php

@@ -0,0 +1,106 @@
+<?php
+
+use Jasny\Controller;
+use Psr\Http\Message\ServerRequestInterface;
+use Psr\Http\Message\ResponseInterface;
+
+class ControllerTest extends PHPUnit_Framework_TestCase
+{
+    /**
+     * Test running controller
+     */
+    public function testInvoke()
+    {
+        $controller = $this->getMockBuilder(Controller::class)->disableOriginalConstructor()->getMockForAbstractClass();
+        list($request, $response) = $this->getRequests();
+
+        $controller->expects($this->once())->method('run')->will($this->returnValue($response));
+
+        $result = $controller($request, $response);
+
+        $this->assertEquals($response, $result, "Invoking controller should return 'ResponseInterface' instance");
+        $this->assertEquals($response, $controller->getResponse(), "Can not get 'ResponseInterface' instance from controller");
+        $this->assertEquals($request, $controller->getRequest(), "Can not get 'ServerRequestInterface' instance from controller");
+    }
+
+    /**
+     * Test response status functions if response object is not set
+     */
+    public function testResponseStatusEmptyResponse()
+    {
+        $controller = $this->getMockBuilder(Controller::class)->disableOriginalConstructor()->getMockForAbstractClass();   
+        $data = $this->getStatusCodesMap(null);
+
+        foreach ($data as $func => $value) {
+            $this->assertEquals($value, $controller->$func(), "Method '$func' returns incorrect value");
+        }
+    }
+
+    /**
+     * Test functions that check response status code
+     *
+     * @dataProvider responseStatusProvider
+     * @param int $statusCode
+     */
+    public function testResponseStatus($code)
+    {
+        $controller = $this->getMockBuilder(Controller::class)->disableOriginalConstructor()->getMockForAbstractClass();
+        list($request, $response) = $this->getRequests();
+        $response->method('getStatusCode')->will($this->returnValue($code));
+
+        $controller($request, $response);                
+
+        $data = $this->getStatusCodesMap($code);
+
+        foreach ($data as $func => $value) {
+            $this->assertEquals($value, $controller->$func(), "Method '$func' returns incorrect value");
+        }
+
+        $this->assertEquals($data['isClientError'] || $data['isServerError'], $controller->isError(), "Method 'isError' returns incorrect value");
+    }
+
+    /**
+     * Provide data for testing status methods
+     *
+     * @return array
+     */
+    public function responseStatusProvider()
+    {
+        return [
+            [null], [199],
+            [200], [201], [299],
+            [300], [304], [399],
+            [400], [403], [499],
+            [500], [503]
+        ];
+    }
+
+    /**
+     * Get map of status codes to states
+     *
+     * @param int $code
+     * @return []
+     */
+    public function getStatusCodesMap($code)
+    {
+        return [
+            'isSuccessful' => !$code || ($code >= 200 && $code < 300),
+            'isRedirection' => $code >= 300 && $code < 400,
+            'isClientError' => $code >= 400 && $code < 500,
+            'isServerError' => $code >= 500            
+        ];
+    }
+
+    /**
+     * Get request and response instances
+     *
+     * @return array
+     */
+    public function getRequests()
+    {
+        return [
+            $this->createMock(ServerRequestInterface::class),
+            $this->createMock(ResponseInterface::class)            
+        ];
+    }
+}