/**
* Handle REST request.
*
* @return Mage_Webapi_Controller_Dispatcher_Rest
*/
public function dispatch()
{
try {
$this->_authentication->authenticate();
$route = $this->_router->match($this->_request);
$operation = $this->_request->getOperationName();
$resourceVersion = $this->_request->getResourceVersion();
$this->_apiConfig->validateVersionNumber($resourceVersion, $this->_request->getResourceName());
$method = $this->_apiConfig->getMethodNameByOperation($operation, $resourceVersion);
$controllerClassName = $this->_apiConfig->getControllerClassByOperationName($operation);
$controllerInstance = $this->_controllerFactory->createActionController($controllerClassName, $this->_request);
$versionAfterFallback = $this->_apiConfig->identifyVersionSuffix($operation, $resourceVersion, $controllerInstance);
/**
* Route check has two stages:
* The first is performed against full list of routes that is merged from all resources.
* The second stage of route check can be performed only when actual version to be executed is known.
*/
$this->_router->checkRoute($this->_request, $method, $versionAfterFallback);
$this->_apiConfig->checkDeprecationPolicy($route->getResourceName(), $method, $versionAfterFallback);
$action = $method . $versionAfterFallback;
$this->_authorization->checkResourceAcl($route->getResourceName(), $method);
$inputData = $this->_restPresentation->fetchRequestData($controllerInstance, $action);
$outputData = call_user_func_array(array($controllerInstance, $action), $inputData);
$this->_restPresentation->prepareResponse($method, $outputData);
} catch (Exception $e) {
$this->_response->setException($e);
}
$this->_response->sendResponse();
return $this;
}
/**
* Test dispatch method.
*/
public function testDispatch()
{
$this->_authenticationMock->expects($this->once())->method('authenticate');
/** Init route mock. */
$routeMock = $this->getMockBuilder('Mage_Webapi_Controller_Router_Route_Rest')->disableOriginalConstructor()->getMock();
$routeMock->expects($this->any())->method('getResourceName');
$this->_routerMock->expects($this->once())->method('match')->will($this->returnValue($routeMock));
/** Mock Api Config getMethodNameByOperation method to return isDeleted method of Varien_Onject. */
$this->_apiConfigMock->expects($this->once())->method('getMethodNameByOperation')->will($this->returnValue('isDeleted'));
/** Mock Api config identifyVersionSuffix method to return empty string. */
$this->_apiConfigMock->expects($this->once())->method('identifyVersionSuffix')->will($this->returnValue(''));
$this->_apiConfigMock->expects($this->once())->method('checkDeprecationPolicy');
$this->_authorizationMock->expects($this->once())->method('checkResourceAcl');
/** Create fake controller mock, e. g. Varien_Object object. */
$controllerMock = $this->getMockBuilder('Varien_Object')->disableOriginalConstructor()->getMock();
/** Assert isDeleted method will be executed once. */
$controllerMock->expects($this->once())->method('isDeleted');
/** Mock factory mock to return fake action controller. */
$this->_controllerFactory->expects($this->once())->method('createActionController')->will($this->returnValue($controllerMock));
/** Mock Rest presentation fetchRequestData method to return empty array. */
$this->_restPresentation->expects($this->once())->method('fetchRequestData')->will($this->returnValue(array()));
/** Assert response sendResponse method will be executed once. */
$this->_responseMock->expects($this->once())->method('sendResponse');
$this->_restDispatcher->dispatch();
}
/**
* Test sendResponse method with exception rendering.
*
* @dataProvider dataProviderForSendResponseWithExceptionInDeveloperMode
*/
public function testSendResponseWithExceptionInDeveloperMode($exception, $expectedResult, $assertMessage)
{
/** Mock all required objects. */
$this->_rendererMock->expects($this->any())->method('getMimeType')->will($this->returnValue('application/json'));
$this->_rendererMock->expects($this->any())->method('render')->will($this->returnCallback(array($this, 'callbackForSendResponseTest'), $this->returnArgument(0)));
$this->_appMock->expects($this->any())->method('isDeveloperMode')->will($this->returnValue(true));
$this->_responseRest->setException($exception);
/** Start output buffering. */
ob_start();
$this->_responseRest->sendResponse();
/** Clear output buffering. */
ob_end_clean();
$actualResponse = $this->_responseRest->getBody();
$this->assertStringStartsWith($expectedResult, $actualResponse, $assertMessage);
}
/**
* Render data using registered Renderer.
*
* @param mixed $data
*/
protected function _render($data)
{
$mimeType = $this->_renderer->getMimeType();
$body = $this->_renderer->render($data);
$this->_response->setMimeType($mimeType)->setBody($body);
}