Service::setupRequest() - Code Metrics - Inspection of "Short circuit for disabled expose routes" - leedavis81/drest - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( e854da...db628c )

by Lee

created 2016-08-25 17:18 UTC

Service::setupRequest() C

↳ Parent: Service

Complexity

Conditions	7
Paths	5

Size

Total Lines	26
Code Lines	11

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	11
CRAP Score	7.9295

Importance

Changes	6
Bugs	0	Features	1

Metric	Value
c	6
b	0
f	1
dl	0
loc	26
ccs	11
cts	15
cp	0.7332
rs	6.7272
cc	7
eloc	11
nc	5
nop	0
crap	7.9295

<?php
/**
 * This file is part of the Drest package.
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 *
 * @author Lee Davis
 * @copyright Copyright (c) Lee Davis <@leedavis81>
 * @link https://github.com/leedavis81/drest/blob/master/LICENSE
 * @license http://opensource.org/licenses/MIT The MIT X License (MIT)
 */
namespace Drest;

use Doctrine\ORM\EntityManager;
use Drest\Mapping\RouteMetaData;
use Drest\Service\Action\AbstractAction;
use DrestCommon\Error\Handler\AbstractHandler;
use DrestCommon\Error\Response\ResponseInterface;
use DrestCommon\Representation;
use DrestCommon\Request\Request;
use DrestCommon\Response\Response;
use DrestCommon\ResultSet;

/**
 * Class Service handles all attributes of a single service call.
 * Is also injected into custom service actions
 * @package Drest
 */
class Service
{
    /**
     * Drest Manager
     * @var Manager $dm
     */
    protected $dm;

    /**
     * Service Action Registry
     * @var Service\Action\Registry
     */
    protected $service_action_registry;

    /**
     * When a route object is matched, it's injected into the service class
     * @var RouteMetaData $route
     */
    protected $matched_route;

    /**
     * Service action instance determined
     * @var AbstractAction $service_action
     */
    private $service_action;

    /**
     * A representation instance determined either from configuration or client media accept type - can be null if none matched
     * Note this will be present on both a fetch (GET) request and on a push (POST / PUT) request if using the drest client
     * @var Representation\AbstractRepresentation $representation
     */
    protected $representation;

    /**
     * The error handler instance
     * @var AbstractHandler $error_handler
     */
    protected $error_handler;

    /**
     * Initialise a new instance of a Drest service
     * @param Manager                   $dm - The Drest Manager object
     * @param Service\Action\Registry   $service_action_registry - registry use to look up service actions
     */
    public function __construct(Manager $dm, Service\Action\Registry $service_action_registry)
    {
        $this->dm = $dm;
        $this->service_action_registry = $service_action_registry;
    }


    /**
     * Set up and run the required call method
     */
    public function setUpAndRunRequest()
    {
        if ($this->setupRequest()) {
            $this->runCallMethod();
        }
    }

    /**
     * Called on successful routing of a service call
     * Prepares the service to a request to be rendered
     *
     * @return boolean $result - if false then fail fast no call to runCallMethod() should be made.
     */
    protected function setupRequest()
    {
        // Make sure we have a route matched (this should caught and an exception thrown on Manager::determineRoute())
        if (!$this->matched_route instanceof RouteMetaData) {
            return false;
        }

        // Proceed to run the service action
        if ($this->matched_route->isExposeDisabled())
        {
            return true;
        }

        // If its a GET request and no expose fields are present, fail early
        if ($this->getRequest()->getHttpMethod() == Request::METHOD_GET)
        {
            $expose = $this->matched_route->getExpose();
            if (count($expose) === 0 || (count($expose) == 1 && empty($expose[0])))
            {
                $this->renderDeterminedRepresentation($this->getActionInstance()->createResultSet(array()));
                return false;
            }
        }

        return true;
    }

    /**
     * Get an instance of the action class to be used
     * @throws DrestException
     * @return AbstractAction $action
     */
    protected function getActionInstance()
    {
        if (!isset($this->service_action))
        {
            if ($this->service_action_registry->hasServiceAction($this->matched_route))
            {
                $this->service_action = $this->service_action_registry->getServiceAction($this->matched_route);
                $this->service_action->setService($this);
            } else
            {
                $this->service_action = $this->getDefaultAction();
            }

            if (!$this->service_action instanceof AbstractAction) {
                throw DrestException::actionClassNotAnInstanceOfActionAbstract(get_class($this->service_action));
            }
        }

        return $this->service_action;
    }

    /**
     * Run the call method required on this service object
     */
    final public function runCallMethod()
    {
        // dispatch preServiceAction event
        $this->dm->triggerPreServiceActionEvent($this);

        $return = $this->getActionInstance()->execute();

        // dispatch postServiceAction event
        $this->dm->triggerPostServiceActionEvent($this);

        if ($return instanceof ResultSet) {
            $this->renderDeterminedRepresentation($return);
        }
    }

    /**
     * Gets an instance of the "default" action based of request information
     * @throws DrestException
     * @return AbstractAction $action
     */
    protected function getDefaultAction()
    {
        $httpMethod = ($this->dm->calledWithANamedRoute())
            ? array_slice($this->matched_route->getVerbs(), 0, 1)[0]
            : $this->getRequest()->getHttpMethod();

        $className = '\\Drest\\Service\\Action\\' . ucfirst(strtolower($httpMethod));
        switch ($httpMethod) {
            case Request::METHOD_GET:
            case Request::METHOD_DELETE:
                $className .= ($this->matched_route->isCollection()) ? 'Collection' : 'Element';
                break;
            default:
                $className .= 'Element';
                break;
        }
        if (!class_exists($className)) {
            throw DrestException::unknownActionClass($className);
        }

        /** @var AbstractAction $object */
        $object = new $className();
        $object->setService($this);
        return $object;
    }

    /**
     * Get the service action registry
     * @return Service\Action\Registry $service_action_registry
     */
    public function getServiceActionRegistry()
    {
        return $this->service_action_registry;
    }

    /**
     * Set the matched route object
     * @param RouteMetaData $matched_route
     */
    public function setMatchedRoute(RouteMetaData $matched_route)
    {
        $this->matched_route = $matched_route;
    }

    /**
     * Get the route object that was matched
     * @return RouteMetaData $matched_route
     */
    public function getMatchedRoute()
    {
        return $this->matched_route;
    }

    /**
     * Set any predetermined representation instance
     * @param Representation\AbstractRepresentation $representation
     */
    public function setRepresentation(Representation\AbstractRepresentation $representation)
    {
        $this->representation = $representation;
    }

    /**
     * Get the predetermined representation
     * @return Representation\AbstractRepresentation
     */
    public function getRepresentation()
    {
        return $this->representation;
    }

    /**
     * Set the error handler object
     * @param AbstractHandler $error_handler
     */
    public function setErrorHandler(AbstractHandler $error_handler)
    {
        $this->error_handler = $error_handler;
    }

    /**
     * Get the entity manager
     * This will return the default manager, to choose a specific one use getEntityManagerRegistry()
     * @return EntityManager $em
     */
    public function getEntityManager()
    {
        return $this->getEntityManagerRegistry()->getManager();
    }

    /**
     * Get the entity manager registry
     * @return EntityManagerRegistry
     */
    public function getEntityManagerRegistry()
    {
        return $this->dm->getEntityManagerRegistry();
    }

    /**
     * Get the Drest Manager
     * @return Manager $dm
     */
    public function getDrestManager()
    {
        return $this->dm;
    }

    /**
     * Get the response object
     * @return Response $response
     */
    public function getResponse()
    {
        return $this->dm->getResponse();
    }

    /**
     * Get the request object
     * @return Request $request
     */
    public function getRequest()
    {
        return $this->dm->getRequest();
    }

    /**
     * Handle an error - set the resulting error document to the response object
     * @param  \Exception        $e
     * @param  integer           $defaultResponseCode the default response code to use if no match on exception type occurs
     * @param  ResponseInterface $errorDocument
     * @return ResultSet         the error result set
     */
    public function handleError(\Exception $e, $defaultResponseCode = 500, ResponseInterface $errorDocument = null)
    {
        if (is_null($errorDocument)) {
            $errorDocument = $this->representation->getDefaultErrorResponse();
        }

        $this->error_handler->error($e, $defaultResponseCode, $errorDocument);

        $this->getResponse()->setStatusCode($this->error_handler->getResponseCode());
        $this->getResponse()->setHttpHeader('Content-Type', $errorDocument::getContentType());
        $this->getResponse()->setBody($errorDocument->render());
    }


    /**
     * Write out as result set on the representation object that was determined - if no representation has been determined - defaults to text
     * @param ResultSet $resultSet
     */
    public function renderDeterminedRepresentation(ResultSet $resultSet)
    {
        $this->getResponse()->setBody($this->representation->output($resultSet));
        $this->getResponse()->setHttpHeader('Content-Type', $this->representation->getContentType());
    }
}


1		<?php
2		/**
3		* This file is part of the Drest package.
4		*
5		* For the full copyright and license information, please view the LICENSE
6		* file that was distributed with this source code.
7		*
8		* @author Lee Davis
9		* @copyright Copyright (c) Lee Davis <@leedavis81>
10		* @link https://github.com/leedavis81/drest/blob/master/LICENSE
11		* @license http://opensource.org/licenses/MIT The MIT X License (MIT)
12		*/
13		namespace Drest;
14
15		use Doctrine\ORM\EntityManager;
16		use Drest\Mapping\RouteMetaData;
17		use Drest\Service\Action\AbstractAction;
18		use DrestCommon\Error\Handler\AbstractHandler;
19		use DrestCommon\Error\Response\ResponseInterface;
20		use DrestCommon\Representation;
21		use DrestCommon\Request\Request;
22		use DrestCommon\Response\Response;
23		use DrestCommon\ResultSet;
24
25		/**
26		* Class Service handles all attributes of a single service call.
27		* Is also injected into custom service actions
28		* @package Drest
29		*/
30		class Service
31		{
32		/**
33		* Drest Manager
34		* @var Manager $dm
35		*/
36		protected $dm;
37
38		/**
39		* Service Action Registry
40		* @var Service\Action\Registry
41		*/
42		protected $service_action_registry;
43
44		/**
45		* When a route object is matched, it's injected into the service class
46		* @var RouteMetaData $route
47		*/
48		protected $matched_route;
49
50		/**
51		* Service action instance determined
52		* @var AbstractAction $service_action
53		*/
54		private $service_action;
55
56		/**
57		* A representation instance determined either from configuration or client media accept type - can be null if none matched
58		* Note this will be present on both a fetch (GET) request and on a push (POST / PUT) request if using the drest client
59		* @var Representation\AbstractRepresentation $representation
60		*/
61		protected $representation;
62
63		/**
64		* The error handler instance
65		* @var AbstractHandler $error_handler
66		*/
67		protected $error_handler;
68
69		/**
70		* Initialise a new instance of a Drest service
71		* @param Manager $dm - The Drest Manager object
72		* @param Service\Action\Registry $service_action_registry - registry use to look up service actions
73		*/
74	31	public function __construct(Manager $dm, Service\Action\Registry $service_action_registry)
75		{
76	31	$this->dm = $dm;
77	31	$this->service_action_registry = $service_action_registry;
78	31	}
79
80
81		/**
82		* Set up and run the required call method
83		*/
84	25	public function setUpAndRunRequest()
85		{
86	25	if ($this->setupRequest()) {
87	25	$this->runCallMethod();
88	25	}
89	25	}
90
91		/**
92		* Called on successful routing of a service call
93		* Prepares the service to a request to be rendered
94		*
95		* @return boolean $result - if false then fail fast no call to runCallMethod() should be made.
96		*/
97	25	protected function setupRequest()
98		{
99		// Make sure we have a route matched (this should caught and an exception thrown on Manager::determineRoute())
100	25	if (!$this->matched_route instanceof RouteMetaData) {
101		return false;
102		}
103
104		// Proceed to run the service action
105	25	if ($this->matched_route->isExposeDisabled())
106	25	{
107		return true;
108		}
109
110		// If its a GET request and no expose fields are present, fail early
111	25	if ($this->getRequest()->getHttpMethod() == Request::METHOD_GET)
112	25	{
113	18	$expose = $this->matched_route->getExpose();
114	18	if (count($expose) === 0 \|\| (count($expose) == 1 && empty($expose[0])))
115	18	{
116		$this->renderDeterminedRepresentation($this->getActionInstance()->createResultSet(array()));
117		return false;
118		}
119	18	}
120
121	25	return true;
122		}
123
124		/**
125		* Get an instance of the action class to be used
126		* @throws DrestException
127		* @return AbstractAction $action
128		*/
129	25	protected function getActionInstance()
130		{
131	25	if (!isset($this->service_action))
132	25	{
133	25	if ($this->service_action_registry->hasServiceAction($this->matched_route))
134	25	{
135		$this->service_action = $this->service_action_registry->getServiceAction($this->matched_route);
136		$this->service_action->setService($this);
137		} else
138		{
139	25	$this->service_action = $this->getDefaultAction();
140		}
141
142	25	if (!$this->service_action instanceof AbstractAction) {
143		throw DrestException::actionClassNotAnInstanceOfActionAbstract(get_class($this->service_action));
144		}
145	25	}
146
147	25	return $this->service_action;
148		}
149
150		/**
151		* Run the call method required on this service object
152		*/
153	25	final public function runCallMethod()
154		{
155		// dispatch preServiceAction event
156	25	$this->dm->triggerPreServiceActionEvent($this);
157
158	25	$return = $this->getActionInstance()->execute();
159
160		// dispatch postServiceAction event
161	25	$this->dm->triggerPostServiceActionEvent($this);
162
163	25	if ($return instanceof ResultSet) {
164	20	$this->renderDeterminedRepresentation($return);
165	20	}
166	25	}
167
168		/**
169		* Gets an instance of the "default" action based of request information
170		* @throws DrestException
171		* @return AbstractAction $action
172		*/
173	25	protected function getDefaultAction()
174		{
175	25	$httpMethod = ($this->dm->calledWithANamedRoute())
176	25	? array_slice($this->matched_route->getVerbs(), 0, 1)[0]
177	25	: $this->getRequest()->getHttpMethod();
178
179	25	$className = '\\Drest\\Service\\Action\\' . ucfirst(strtolower($httpMethod));
180		switch ($httpMethod) {
181	25	case Request::METHOD_GET:
182	25	case Request::METHOD_DELETE:
183	22	$className .= ($this->matched_route->isCollection()) ? 'Collection' : 'Element';
184	22	break;
185	3	default:
186	3	$className .= 'Element';
187	3	break;
188	3	}
189	25	if (!class_exists($className)) {
190		throw DrestException::unknownActionClass($className);
191		}
192
193		/** @var AbstractAction $object */
194	25	$object = new $className();
195	25	$object->setService($this);
196	25	return $object;
197		}
198
199		/**
200		* Get the service action registry
201		* @return Service\Action\Registry $service_action_registry
202		*/
203		public function getServiceActionRegistry()
204		{
205		return $this->service_action_registry;
206		}
207
208		/**
209		* Set the matched route object
210		* @param RouteMetaData $matched_route
211		*/
212	25	public function setMatchedRoute(RouteMetaData $matched_route)
213		{
214	25	$this->matched_route = $matched_route;
215	25	}
216
217		/**
218		* Get the route object that was matched
219		* @return RouteMetaData $matched_route
220		*/
221	25	public function getMatchedRoute()
222		{
223	25	return $this->matched_route;
224		}
225
226		/**
227		* Set any predetermined representation instance
228		* @param Representation\AbstractRepresentation $representation
229		*/
230	25	public function setRepresentation(Representation\AbstractRepresentation $representation)
231		{
232	25	$this->representation = $representation;
233	25	}
234
235		/**
236		* Get the predetermined representation
237		* @return Representation\AbstractRepresentation
238		*/
239	3	public function getRepresentation()
240		{
241	3	return $this->representation;
242		}
243
244		/**
245		* Set the error handler object
246		* @param AbstractHandler $error_handler
247		*/
248	25	public function setErrorHandler(AbstractHandler $error_handler)
249		{
250	25	$this->error_handler = $error_handler;
251	25	}
252
253		/**
254		* Get the entity manager
255		* This will return the default manager, to choose a specific one use getEntityManagerRegistry()
256		* @return EntityManager $em
257		*/
258		public function getEntityManager()
259		{
260		return $this->getEntityManagerRegistry()->getManager();
261		}
262
263		/**
264		* Get the entity manager registry
265		* @return EntityManagerRegistry
266		*/
267	25	public function getEntityManagerRegistry()
268		{
269	25	return $this->dm->getEntityManagerRegistry();
270		}
271
272		/**
273		* Get the Drest Manager
274		* @return Manager $dm
275		*/
276		public function getDrestManager()
277		{
278		return $this->dm;
279		}
280
281		/**
282		* Get the response object
283		* @return Response $response
284		*/
285	25	public function getResponse()
286		{
287	25	return $this->dm->getResponse();
288		}
289
290		/**
291		* Get the request object
292		* @return Request $request
293		*/
294	25	public function getRequest()
295		{
296	25	return $this->dm->getRequest();
297		}
298
299		/**
300		* Handle an error - set the resulting error document to the response object
301		* @param \Exception $e
302		* @param integer $defaultResponseCode the default response code to use if no match on exception type occurs
303		* @param ResponseInterface $errorDocument
304		* @return ResultSet the error result set
305		*/
306	5	public function handleError(\Exception $e, $defaultResponseCode = 500, ResponseInterface $errorDocument = null)
307		{
308	5	if (is_null($errorDocument)) {
309	5	$errorDocument = $this->representation->getDefaultErrorResponse();
310	5	}
311
312	5	$this->error_handler->error($e, $defaultResponseCode, $errorDocument);
313
314	5	$this->getResponse()->setStatusCode($this->error_handler->getResponseCode());
315	5	$this->getResponse()->setHttpHeader('Content-Type', $errorDocument::getContentType());
316	5	$this->getResponse()->setBody($errorDocument->render());
317	5	}
318
319
320		/**
321		* Write out as result set on the representation object that was determined - if no representation has been determined - defaults to text
322		* @param ResultSet $resultSet
323		*/
324	20	public function renderDeterminedRepresentation(ResultSet $resultSet)
325		{
326	20	$this->getResponse()->setBody($this->representation->output($resultSet));
327	20	$this->getResponse()->setHttpHeader('Content-Type', $this->representation->getContentType());
328	20	}
329		}
330

leedavis81 / drest

Push — master ( e854da...db628c )

Service::setupRequest() C

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like