RouteTest.php 37 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972
  1. <?php
  2. /**
  3. * Zend Framework
  4. *
  5. * LICENSE
  6. *
  7. * This source file is subject to the new BSD license that is bundled
  8. * with this package in the file LICENSE.txt.
  9. * It is also available through the world-wide-web at this URL:
  10. * http://framework.zend.com/license/new-bsd
  11. * If you did not receive a copy of the license and are unable to
  12. * obtain it through the world-wide-web, please send an email
  13. * to license@zend.com so we can send you a copy immediately.
  14. *
  15. * @category Zend
  16. * @package Zend_Rest
  17. * @subpackage UnitTests
  18. * @copyright Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
  19. * @license http://framework.zend.com/license/new-bsd New BSD License
  20. * @version $Id$
  21. */
  22. /** Zend_Rest_Route */
  23. require_once 'Zend/Rest/Route.php';
  24. /** Zend_Controller_Front */
  25. require_once 'Zend/Controller/Front.php';
  26. /** Zend_Controller_Request_HttpTestCase */
  27. require_once 'Zend/Controller/Request/HttpTestCase.php';
  28. // Call Zend_Rest_RouteTest::main() if this source file is executed directly.
  29. if (!defined("PHPUnit_MAIN_METHOD")) {
  30. define("PHPUnit_MAIN_METHOD", "Zend_Rest_RouteTest::main");
  31. }
  32. /**
  33. * @category Zend
  34. * @package Zend_Rest
  35. * @subpackage UnitTests
  36. * @copyright Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
  37. * @license http://framework.zend.com/license/new-bsd New BSD License
  38. * @group Zend_Rest
  39. */
  40. class Zend_Rest_RouteTest extends PHPUnit_Framework_TestCase
  41. {
  42. protected $_front;
  43. protected $_request;
  44. protected $_dispatcher;
  45. /**
  46. * Runs the test methods of this class.
  47. *
  48. * @access public
  49. * @static
  50. */
  51. public static function main()
  52. {
  53. $suite = new PHPUnit_Framework_TestSuite("Zend_Rest_RouteTest");
  54. $result = PHPUnit_TextUI_TestRunner::run($suite);
  55. }
  56. public function setUp()
  57. {
  58. $this->_front = Zend_Controller_Front::getInstance();
  59. $this->_front->resetInstance();
  60. $this->_front->setParam('noErrorHandler', true)
  61. ->setParam('noViewRenderer', true);
  62. $this->_dispatcher = $this->_front->getDispatcher();
  63. $this->_dispatcher->setControllerDirectory(array(
  64. 'default' => dirname(__FILE__) . DIRECTORY_SEPARATOR .
  65. '..' . DIRECTORY_SEPARATOR .
  66. 'Controller' . DIRECTORY_SEPARATOR .
  67. '_files',
  68. 'mod' => dirname(__FILE__) . DIRECTORY_SEPARATOR .
  69. '..' . DIRECTORY_SEPARATOR .
  70. 'Controller' . DIRECTORY_SEPARATOR .
  71. '_files' . DIRECTORY_SEPARATOR .
  72. 'Admin',
  73. ));
  74. }
  75. public function test_getVersion()
  76. {
  77. $route = new Zend_Rest_Route($this->_front);
  78. $this->assertEquals(2, $route->getVersion());
  79. }
  80. public function test_getInstance_fromINIConfig()
  81. {
  82. require_once('Zend/Config/Ini.php');
  83. $config = new Zend_Config_Ini(dirname(__FILE__) . '/../Controller/_files/routes.ini', 'testing');
  84. require_once('Zend/Controller/Router/Rewrite.php');
  85. $router = new Zend_Controller_Router_Rewrite();
  86. $router->addConfig($config, 'routes');
  87. $route = $router->getRoute('rest');
  88. $this->assertTrue($route instanceof Zend_Rest_Route);
  89. $this->assertEquals('object', $route->getDefault('controller'));
  90. $request = $this->_buildRequest('GET', '/mod/project');
  91. $values = $this->_invokeRouteMatch($request, array(), $route);
  92. $this->assertEquals('mod', $values['module']);
  93. $this->assertEquals('project', $values['controller']);
  94. $this->assertEquals('index', $values['action']);
  95. $request = $this->_buildRequest('POST', '/mod/user');
  96. $values = $this->_invokeRouteMatch($request, array(), $route);
  97. $this->assertEquals('mod', $values['module']);
  98. $this->assertEquals('user', $values['controller']);
  99. $this->assertEquals('post', $values['action']);
  100. $request = $this->_buildRequest('GET', '/other');
  101. $values = $this->_invokeRouteMatch($request, array(), $route);
  102. $this->assertFalse($values);
  103. }
  104. public function test_RESTfulApp_defaults()
  105. {
  106. $request = $this->_buildRequest('GET', '/');
  107. $values = $this->_invokeRouteMatch($request);
  108. $this->assertTrue(is_array($values));
  109. $this->assertTrue(isset($values['module']));
  110. $this->assertEquals('default', $values['module']);
  111. $this->assertEquals('index', $values['controller']);
  112. $this->assertEquals('index', $values['action']);
  113. }
  114. /*
  115. * @group ZF-7437
  116. */
  117. public function test_RESTfulApp_GET_user_defaults()
  118. {
  119. $request = $this->_buildRequest('GET', '/user');
  120. $values = $this->_invokeRouteMatch($request);
  121. $this->assertTrue(is_array($values));
  122. $this->assertTrue(isset($values['module']));
  123. $this->assertEquals('default', $values['module']);
  124. $this->assertEquals('user', $values['controller']);
  125. $this->assertEquals('index', $values['action']);
  126. }
  127. public function test_RESTfulApp_GET_user_index()
  128. {
  129. $request = $this->_buildRequest('GET', '/user/index');
  130. $values = $this->_invokeRouteMatch($request);
  131. $this->assertTrue(is_array($values));
  132. $this->assertTrue(isset($values['module']));
  133. $this->assertEquals('default', $values['module']);
  134. $this->assertEquals('user', $values['controller']);
  135. $this->assertEquals('index', $values['action']);
  136. }
  137. public function test_RESTfulApp_GET_user_index_withParams()
  138. {
  139. $request = $this->_buildRequest('GET', '/user/index/changedSince/123456789/status/active');
  140. $values = $this->_invokeRouteMatch($request);
  141. $this->assertTrue(is_array($values));
  142. $this->assertTrue(isset($values['module']));
  143. $this->assertEquals('default', $values['module']);
  144. $this->assertEquals('user', $values['controller']);
  145. $this->assertEquals('index', $values['action']);
  146. $this->assertEquals(123456789, $values['changedSince']);
  147. $this->assertEquals('active', $values['status']);
  148. }
  149. public function test_RESTfulApp_GET_user_index_withQueryParams()
  150. {
  151. $request = $this->_buildRequest('GET', '/user/?changedSince=123456789&status=active');
  152. $values = $this->_invokeRouteMatch($request);
  153. $this->assertTrue(is_array($values));
  154. $this->assertTrue(isset($values['module']));
  155. $this->assertEquals('default', $values['module']);
  156. $this->assertEquals('user', $values['controller']);
  157. $this->assertEquals('index', $values['action']);
  158. $this->assertEquals(123456789, $values['changedSince']);
  159. $this->assertEquals('active', $values['status']);
  160. }
  161. /**
  162. * @group ZF-10964
  163. */
  164. public function test_RESTfulApp_GET_user_index_withParam_urlencodedWithPlusSymbol()
  165. {
  166. $request = $this->_buildRequest('GET', '/user/index/the%2Bemail%40address/email%2Btest%40example.com');
  167. $values = $this->_invokeRouteMatch($request);
  168. $this->assertTrue(is_array($values));
  169. $this->assertTrue(isset($values['module']));
  170. $this->assertEquals('default', $values['module']);
  171. $this->assertEquals('user', $values['controller']);
  172. $this->assertEquals('index', $values['action']);
  173. $this->assertEquals('email+test@example.com', $values['the+email@address']);
  174. }
  175. public function test_RESTfulApp_GET_project_byIdentifier()
  176. {
  177. $request = $this->_buildRequest('GET', '/project/zendframework');
  178. $values = $this->_invokeRouteMatch($request);
  179. $this->assertTrue(is_array($values));
  180. $this->assertTrue(isset($values['module']));
  181. $this->assertEquals('default', $values['module']);
  182. $this->assertEquals('project', $values['controller']);
  183. $this->assertEquals('get', $values['action']);
  184. $this->assertEquals('zendframework', $values['id']);
  185. }
  186. public function test_RESTfulApp_GET_project_byIdQueryParam()
  187. {
  188. $request = $this->_buildRequest('GET', '/project/?id=zendframework');
  189. $values = $this->_invokeRouteMatch($request);
  190. $this->assertTrue(is_array($values));
  191. $this->assertTrue(isset($values['module']));
  192. $this->assertEquals('default', $values['module']);
  193. $this->assertEquals('project', $values['controller']);
  194. $this->assertEquals('get', $values['action']);
  195. $this->assertEquals('zendframework', $values['id']);
  196. }
  197. public function test_RESTfulApp_GET_project_byIdentifier_urlencoded()
  198. {
  199. $request = $this->_buildRequest('GET', '/project/zend+framework');
  200. $values = $this->_invokeRouteMatch($request);
  201. $this->assertTrue(is_array($values));
  202. $this->assertTrue(isset($values['module']));
  203. $this->assertEquals('default', $values['module']);
  204. $this->assertEquals('project', $values['controller']);
  205. $this->assertEquals('get', $values['action']);
  206. $this->assertEquals('zend framework', $values['id']);
  207. }
  208. /**
  209. * @group ZF-10964
  210. */
  211. public function test_RESTfulApp_GET_project_byIdentifier_urlencodedWithPlusSymbol()
  212. {
  213. $request = $this->_buildRequest('GET', '/project/email%2Btest%40example.com');
  214. $values = $this->_invokeRouteMatch($request);
  215. $this->assertTrue(is_array($values));
  216. $this->assertTrue(isset($values['module']));
  217. $this->assertEquals('default', $values['module']);
  218. $this->assertEquals('project', $values['controller']);
  219. $this->assertEquals('get', $values['action']);
  220. $this->assertEquals('email+test@example.com', $values['id']);
  221. }
  222. public function test_RESTfulApp_HEAD_project_byIdentifier()
  223. {
  224. $request = $this->_buildRequest('HEAD', '/project/lcrouch');
  225. $values = $this->_invokeRouteMatch($request);
  226. $this->assertTrue(is_array($values));
  227. $this->assertTrue(isset($values['module']));
  228. $this->assertEquals('default', $values['module']);
  229. $this->assertEquals('project', $values['controller']);
  230. $this->assertEquals('head', $values['action']);
  231. }
  232. /**
  233. * @group ZF-10964
  234. */
  235. public function test_RESTfulApp_HEAD_project_byIdentifier_urlencodedWithPlusSymbol()
  236. {
  237. $request = $this->_buildRequest('HEAD', '/project/email%2Btest%40example.com');
  238. $values = $this->_invokeRouteMatch($request);
  239. $this->assertTrue(is_array($values));
  240. $this->assertTrue(isset($values['module']));
  241. $this->assertEquals('default', $values['module']);
  242. $this->assertEquals('project', $values['controller']);
  243. $this->assertEquals('head', $values['action']);
  244. $this->assertEquals('email+test@example.com', $values['id']);
  245. }
  246. public function test_RESTfulApp_GET_project_edit()
  247. {
  248. $request = $this->_buildRequest('GET', '/project/zendframework/edit');
  249. $values = $this->_invokeRouteMatch($request);
  250. $this->assertTrue(is_array($values));
  251. $this->assertTrue(isset($values['module']));
  252. $this->assertEquals('default', $values['module']);
  253. $this->assertEquals('project', $values['controller']);
  254. $this->assertEquals('edit', $values['action']);
  255. $this->assertEquals('zendframework', $values['id']);
  256. }
  257. /**
  258. * @group ZF-10964
  259. */
  260. public function test_RESTfulApp_GET_project_edit_urlencodedWithPlusSymbol()
  261. {
  262. $request = $this->_buildRequest('GET', '/project/email%2Btest%40example.com/edit');
  263. $values = $this->_invokeRouteMatch($request);
  264. $this->assertTrue(is_array($values));
  265. $this->assertTrue(isset($values['module']));
  266. $this->assertEquals('default', $values['module']);
  267. $this->assertEquals('project', $values['controller']);
  268. $this->assertEquals('edit', $values['action']);
  269. $this->assertEquals('email+test@example.com', $values['id']);
  270. }
  271. public function test_RESTfulApp_PUT_user_byIdentifier()
  272. {
  273. $request = $this->_buildRequest('PUT', '/mod/user/lcrouch');
  274. $values = $this->_invokeRouteMatch($request);
  275. $this->assertTrue(is_array($values));
  276. $this->assertTrue(isset($values['module']));
  277. $this->assertEquals('mod', $values['module']);
  278. $this->assertEquals('user', $values['controller']);
  279. $this->assertEquals('put', $values['action']);
  280. $this->assertEquals('lcrouch', $values['id']);
  281. }
  282. /**
  283. * @group ZF-10964
  284. */
  285. public function test_RESTfulApp_PUT_user_byIdentifier_urlencodedWithPlusSymbol()
  286. {
  287. $request = $this->_buildRequest('PUT', '/mod/user/email%2Btest%40example.com');
  288. $values = $this->_invokeRouteMatch($request);
  289. $this->assertTrue(is_array($values));
  290. $this->assertTrue(isset($values['module']));
  291. $this->assertEquals('mod', $values['module']);
  292. $this->assertEquals('user', $values['controller']);
  293. $this->assertEquals('put', $values['action']);
  294. $this->assertEquals('email+test@example.com', $values['id']);
  295. }
  296. public function test_RESTfulApp_POST_user()
  297. {
  298. $request = $this->_buildRequest('POST', '/mod/user');
  299. $values = $this->_invokeRouteMatch($request);
  300. $this->assertTrue(is_array($values));
  301. $this->assertTrue(isset($values['module']));
  302. $this->assertEquals('mod', $values['module']);
  303. $this->assertEquals('user', $values['controller']);
  304. $this->assertEquals('post', $values['action']);
  305. }
  306. public function test_RESTfulApp_DELETE_user_byIdentifier()
  307. {
  308. $request = $this->_buildRequest('DELETE', '/mod/user/lcrouch');
  309. $values = $this->_invokeRouteMatch($request);
  310. $this->assertTrue(is_array($values));
  311. $this->assertTrue(isset($values['module']));
  312. $this->assertEquals('mod', $values['module']);
  313. $this->assertEquals('user', $values['controller']);
  314. $this->assertEquals('delete', $values['action']);
  315. $this->assertEquals('lcrouch', $values['id']);
  316. }
  317. /**
  318. * @group ZF-10964
  319. */
  320. public function test_RESTfulApp_DELETE_user_byIdentifier_urlencodedWithPlusSymbol()
  321. {
  322. $request = $this->_buildRequest('DELETE', '/mod/user/email%2Btest%40example.com');
  323. $values = $this->_invokeRouteMatch($request);
  324. $this->assertTrue(is_array($values));
  325. $this->assertTrue(isset($values['module']));
  326. $this->assertEquals('mod', $values['module']);
  327. $this->assertEquals('user', $values['controller']);
  328. $this->assertEquals('delete', $values['action']);
  329. $this->assertEquals('email+test@example.com', $values['id']);
  330. }
  331. public function test_RESTfulApp_POST_user_with_identifier_doesPUT()
  332. {
  333. $request = $this->_buildRequest('POST', '/mod/user/lcrouch');
  334. $values = $this->_invokeRouteMatch($request);
  335. $this->assertTrue(is_array($values));
  336. $this->assertTrue(isset($values['module']));
  337. $this->assertEquals('mod', $values['module']);
  338. $this->assertEquals('user', $values['controller']);
  339. $this->assertEquals('put', $values['action']);
  340. $this->assertEquals('lcrouch', $values['id']);
  341. }
  342. /**
  343. * @group ZF-10964
  344. */
  345. public function test_RESTfulApp_POST_user_with_identifier_urlencodedWithPlusSymbol_doesPUT()
  346. {
  347. $request = $this->_buildRequest('POST', '/mod/user/email%2Btest%40example.com');
  348. $values = $this->_invokeRouteMatch($request);
  349. $this->assertTrue(is_array($values));
  350. $this->assertTrue(isset($values['module']));
  351. $this->assertEquals('mod', $values['module']);
  352. $this->assertEquals('user', $values['controller']);
  353. $this->assertEquals('put', $values['action']);
  354. $this->assertEquals('email+test@example.com', $values['id']);
  355. }
  356. public function test_RESTfulApp_overload_POST_with_method_param_PUT()
  357. {
  358. $request = $this->_buildRequest('POST', '/mod/user');
  359. $request->setParam('_method', 'PUT');
  360. $values = $this->_invokeRouteMatch($request);
  361. $this->assertTrue(is_array($values));
  362. $this->assertTrue(isset($values['module']));
  363. $this->assertEquals('mod', $values['module']);
  364. $this->assertEquals('user', $values['controller']);
  365. $this->assertEquals('put', $values['action']);
  366. }
  367. public function test_RESTfulApp_overload_POST_with_http_header_DELETE()
  368. {
  369. $request = $this->_buildRequest('POST', '/mod/user/lcrouch');
  370. $request->setHeader('X-HTTP-Method-Override', 'DELETE');
  371. $values = $this->_invokeRouteMatch($request);
  372. $this->assertTrue(is_array($values));
  373. $this->assertTrue(isset($values['module']));
  374. $this->assertEquals('mod', $values['module']);
  375. $this->assertEquals('user', $values['controller']);
  376. $this->assertEquals('delete', $values['action']);
  377. $this->assertEquals('lcrouch', $values['id']);
  378. }
  379. /**
  380. * @group ZF-10964
  381. */
  382. public function test_RESTfulApp_overload_POST_with_http_header_DELETE_urlencodedWithPlusSymbol()
  383. {
  384. $request = $this->_buildRequest('POST', '/mod/user/email%2Btest%40example.com');
  385. $request->setHeader('X-HTTP-Method-Override', 'DELETE');
  386. $values = $this->_invokeRouteMatch($request);
  387. $this->assertTrue(is_array($values));
  388. $this->assertTrue(isset($values['module']));
  389. $this->assertEquals('mod', $values['module']);
  390. $this->assertEquals('user', $values['controller']);
  391. $this->assertEquals('delete', $values['action']);
  392. $this->assertEquals('email+test@example.com', $values['id']);
  393. }
  394. public function test_RESTfulApp_route_chaining()
  395. {
  396. $request = $this->_buildRequest('GET', '/api/user/lcrouch');
  397. $this->_front->setRequest($request);
  398. $router = $this->_front->getRouter();
  399. $router->removeDefaultRoutes();
  400. $nonRESTRoute = new Zend_Controller_Router_Route('api');
  401. $RESTRoute = new Zend_Rest_Route($this->_front);
  402. $router->addRoute("api", $nonRESTRoute->chain($RESTRoute));
  403. $routedRequest = $router->route($request);
  404. $this->assertEquals("default", $routedRequest->getParam("module"));
  405. $this->assertEquals("user", $routedRequest->getParam("controller"));
  406. $this->assertEquals("get", $routedRequest->getParam("action"));
  407. $this->assertEquals("lcrouch", $routedRequest->getParam("id"));
  408. }
  409. /**
  410. * @group ZF-10964
  411. */
  412. public function test_RESTfulApp_route_chaining_urlencodedWithPlusSymbol()
  413. {
  414. $request = $this->_buildRequest('GET', '/api/user/email%2Btest%40example.com');
  415. $this->_front->setRequest($request);
  416. $router = $this->_front->getRouter();
  417. $router->removeDefaultRoutes();
  418. $nonRESTRoute = new Zend_Controller_Router_Route('api');
  419. $RESTRoute = new Zend_Rest_Route($this->_front);
  420. $router->addRoute("api", $nonRESTRoute->chain($RESTRoute));
  421. $routedRequest = $router->route($request);
  422. $this->assertEquals("default", $routedRequest->getParam("module"));
  423. $this->assertEquals("user", $routedRequest->getParam("controller"));
  424. $this->assertEquals("get", $routedRequest->getParam("action"));
  425. $this->assertEquals("email+test@example.com", $routedRequest->getParam("id"));
  426. }
  427. public function test_RESTfulModule_GET_user_index()
  428. {
  429. $request = $this->_buildRequest('GET', '/mod/user/index');
  430. $config = array('mod');
  431. $values = $this->_invokeRouteMatch($request, $config);
  432. $this->assertTrue(is_array($values));
  433. $this->assertTrue(isset($values['module']));
  434. $this->assertEquals('mod', $values['module']);
  435. $this->assertEquals('user', $values['controller']);
  436. $this->assertEquals('index', $values['action']);
  437. }
  438. /**
  439. * @group ZF-10964
  440. */
  441. public function test_RESTfulModule_GET_user_index_withParam_urlencodedWithPlusSymbol()
  442. {
  443. $request = $this->_buildRequest('GET', '/mod/user/index/the%2Bemail%40address/email%2Btest%40example.com');
  444. $config = array('mod');
  445. $values = $this->_invokeRouteMatch($request, $config);
  446. $this->assertTrue(is_array($values));
  447. $this->assertTrue(isset($values['module']));
  448. $this->assertEquals('mod', $values['module']);
  449. $this->assertEquals('user', $values['controller']);
  450. $this->assertEquals('index', $values['action']);
  451. $this->assertEquals('email+test@example.com', $values['the+email@address']);
  452. }
  453. public function test_RESTfulModule_GET_user()
  454. {
  455. $request = $this->_buildRequest('GET', '/mod/user/1234');
  456. $config = array('mod');
  457. $values = $this->_invokeRouteMatch($request, $config);
  458. $this->assertTrue(is_array($values));
  459. $this->assertTrue(isset($values['module']));
  460. $this->assertEquals('mod', $values['module']);
  461. $this->assertEquals('user', $values['controller']);
  462. $this->assertEquals('get', $values['action']);
  463. }
  464. /**
  465. * @group ZF-10964
  466. */
  467. public function test_RESTfulModule_GET_user_urlencodedWithPlusSymbol()
  468. {
  469. $request = $this->_buildRequest('GET', '/mod/user/email%2Btest%40example.com');
  470. $config = array('mod');
  471. $values = $this->_invokeRouteMatch($request, $config);
  472. $this->assertTrue(is_array($values));
  473. $this->assertTrue(isset($values['module']));
  474. $this->assertEquals('mod', $values['module']);
  475. $this->assertEquals('user', $values['controller']);
  476. $this->assertEquals('get', $values['action']);
  477. $this->assertEquals('email+test@example.com', $values['id']);
  478. }
  479. public function test_RESTfulModule_POST_user()
  480. {
  481. $request = $this->_buildRequest('POST', '/mod/user');
  482. $config = array('mod');
  483. $values = $this->_invokeRouteMatch($request, $config);
  484. $this->assertTrue(is_array($values));
  485. $this->assertTrue(isset($values['module']));
  486. $this->assertEquals('mod', $values['module']);
  487. $this->assertEquals('user', $values['controller']);
  488. $this->assertEquals('post', $values['action']);
  489. }
  490. public function test_RESTfulModule_POST_user_inNonRESTModule_returnsFalse()
  491. {
  492. $request = $this->_buildRequest('POST', '/default/user');
  493. $config = array('mod');
  494. $values = $this->_invokeRouteMatch($request, $config);
  495. $this->assertFalse($values);
  496. }
  497. public function test_RESTfulModule_PUT_user_byIdentifier()
  498. {
  499. $request = $this->_buildRequest('PUT', '/mod/user/lcrouch');
  500. $config = array('mod');
  501. $values = $this->_invokeRouteMatch($request, $config);
  502. $this->assertTrue(is_array($values));
  503. $this->assertTrue(isset($values['module']));
  504. $this->assertEquals('mod', $values['module']);
  505. $this->assertEquals('user', $values['controller']);
  506. $this->assertEquals('put', $values['action']);
  507. $this->assertEquals('lcrouch', $values['id']);
  508. }
  509. /**
  510. * @group ZF-10964
  511. */
  512. public function test_RESTfulModule_PUT_user_byIdentifier_urlencodedWithPlusSymbol()
  513. {
  514. $request = $this->_buildRequest('PUT', '/mod/user/email%2Btest%40example.com');
  515. $config = array('mod');
  516. $values = $this->_invokeRouteMatch($request, $config);
  517. $this->assertTrue(is_array($values));
  518. $this->assertTrue(isset($values['module']));
  519. $this->assertEquals('mod', $values['module']);
  520. $this->assertEquals('user', $values['controller']);
  521. $this->assertEquals('put', $values['action']);
  522. $this->assertEquals('email+test@example.com', $values['id']);
  523. }
  524. public function test_RESTfulModule_DELETE_user_byIdentifier()
  525. {
  526. $request = $this->_buildRequest('DELETE', '/mod/user/lcrouch');
  527. $config = array('mod');
  528. $values = $this->_invokeRouteMatch($request, $config);
  529. $this->assertTrue(is_array($values));
  530. $this->assertTrue(isset($values['module']));
  531. $this->assertEquals('mod', $values['module']);
  532. $this->assertEquals('user', $values['controller']);
  533. $this->assertEquals('delete', $values['action']);
  534. $this->assertEquals('lcrouch', $values['id']);
  535. }
  536. /**
  537. * @group ZF-10964
  538. */
  539. public function test_RESTfulModule_DELETE_user_byIdentifier_urlencodedWithPlusSymbol()
  540. {
  541. $request = $this->_buildRequest('DELETE', '/mod/user/email%2Btest%40example.com');
  542. $config = array('mod');
  543. $values = $this->_invokeRouteMatch($request, $config);
  544. $this->assertTrue(is_array($values));
  545. $this->assertTrue(isset($values['module']));
  546. $this->assertEquals('mod', $values['module']);
  547. $this->assertEquals('user', $values['controller']);
  548. $this->assertEquals('delete', $values['action']);
  549. $this->assertEquals('email+test@example.com', $values['id']);
  550. }
  551. public function test_RESTfulController_GET_user_index()
  552. {
  553. $request = $this->_buildRequest('GET', '/mod/user/index');
  554. $config = array('mod'=>array('user'));
  555. $values = $this->_invokeRouteMatch($request, $config);
  556. $this->assertTrue(is_array($values));
  557. $this->assertTrue(isset($values['module']));
  558. $this->assertEquals('mod', $values['module']);
  559. $this->assertEquals('user', $values['controller']);
  560. $this->assertEquals('index', $values['action']);
  561. }
  562. public function test_RESTfulController_GET_default_controller_returns_false()
  563. {
  564. $request = $this->_buildRequest('GET', '/mod/index/index');
  565. $config = array('mod'=>array('user'));
  566. $values = $this->_invokeRouteMatch($request, $config);
  567. $this->assertFalse($values);
  568. }
  569. public function test_RESTfulController_GET_other_index_returns_false()
  570. {
  571. $request = $this->_buildRequest('GET', '/mod/project/index');
  572. $config = array('mod'=>array('user'));
  573. $values = $this->_invokeRouteMatch($request, $config);
  574. $this->assertFalse($values);
  575. }
  576. public function test_RESTfulController_GET_user()
  577. {
  578. $request = $this->_buildRequest('GET', '/mod/user/1234');
  579. $config = array('mod'=>array('user'));
  580. $values = $this->_invokeRouteMatch($request, $config);
  581. $this->assertTrue(is_array($values));
  582. $this->assertTrue(isset($values['module']));
  583. $this->assertEquals('mod', $values['module']);
  584. $this->assertEquals('user', $values['controller']);
  585. $this->assertEquals('get', $values['action']);
  586. }
  587. /**
  588. * @group ZF-10964
  589. */
  590. public function test_RESTfulController_GET_user_urlencodedWithPlusSymbol()
  591. {
  592. $request = $this->_buildRequest('GET', '/mod/user/email%2Btest%40example.com');
  593. $config = array('mod'=>array('user'));
  594. $values = $this->_invokeRouteMatch($request, $config);
  595. $this->assertTrue(is_array($values));
  596. $this->assertTrue(isset($values['module']));
  597. $this->assertEquals('mod', $values['module']);
  598. $this->assertEquals('user', $values['controller']);
  599. $this->assertEquals('get', $values['action']);
  600. $this->assertEquals('email+test@example.com', $values['id']);
  601. }
  602. public function test_RESTfulController_POST_user()
  603. {
  604. $request = $this->_buildRequest('POST', '/mod/user');
  605. $config = array('mod'=>array('user'));
  606. $values = $this->_invokeRouteMatch($request, $config);
  607. $this->assertTrue(is_array($values));
  608. $this->assertTrue(isset($values['module']));
  609. $this->assertEquals('mod', $values['module']);
  610. $this->assertEquals('user', $values['controller']);
  611. $this->assertEquals('post', $values['action']);
  612. }
  613. public function test_RESTfulController_POST_user_inNonRESTModule_returnsFalse()
  614. {
  615. $request = $this->_buildRequest('POST', '/default/user');
  616. $config = array('mod'=>array('user'));
  617. $values = $this->_invokeRouteMatch($request, $config);
  618. $this->assertFalse($values);
  619. }
  620. public function test_postToNonRESTfulDefaultController_moduleHasAnotherRESTfulController_defaultControllerInURL_returnsFalse()
  621. {
  622. $request = $this->_buildRequest('POST', '/mod/index');
  623. $config = array('mod'=>array('user'));
  624. $values = $this->_invokeRouteMatch($request, $config);
  625. $this->assertFalse($values);
  626. }
  627. public function test_postToNonRESTfulDefaultController_moduleHasAnotherRESTfulController_noDefaultControllerInURL_returnsFalse()
  628. {
  629. $request = $this->_buildRequest('POST', '/mod');
  630. $config = array('mod'=>array('user'));
  631. $values = $this->_invokeRouteMatch($request, $config);
  632. $this->assertFalse($values);
  633. }
  634. public function test_RESTfulController_PUT_user_byIdentifier()
  635. {
  636. $request = $this->_buildRequest('PUT', '/mod/user/lcrouch');
  637. $config = array('mod'=>array('user'));
  638. $values = $this->_invokeRouteMatch($request, $config);
  639. $this->assertTrue(is_array($values));
  640. $this->assertTrue(isset($values['module']));
  641. $this->assertEquals('mod', $values['module']);
  642. $this->assertEquals('user', $values['controller']);
  643. $this->assertEquals('put', $values['action']);
  644. $this->assertEquals('lcrouch', $values['id']);
  645. }
  646. /**
  647. * @group ZF-10964
  648. */
  649. public function test_RESTfulController_PUT_user_byIdentifier_urlencodedWithPlusSymbol()
  650. {
  651. $request = $this->_buildRequest('PUT', '/mod/user/email%2Btest%40example.com');
  652. $config = array('mod'=>array('user'));
  653. $values = $this->_invokeRouteMatch($request, $config);
  654. $this->assertTrue(is_array($values));
  655. $this->assertTrue(isset($values['module']));
  656. $this->assertEquals('mod', $values['module']);
  657. $this->assertEquals('user', $values['controller']);
  658. $this->assertEquals('put', $values['action']);
  659. $this->assertEquals('email+test@example.com', $values['id']);
  660. }
  661. public function test_RESTfulController_DELETE_user_byIdentifier()
  662. {
  663. $request = $this->_buildRequest('DELETE', '/mod/user/lcrouch');
  664. $config = array('mod');
  665. $values = $this->_invokeRouteMatch($request, $config);
  666. $this->assertTrue(is_array($values));
  667. $this->assertTrue(isset($values['module']));
  668. $this->assertEquals('mod', $values['module']);
  669. $this->assertEquals('user', $values['controller']);
  670. $this->assertEquals('delete', $values['action']);
  671. $this->assertEquals('lcrouch', $values['id']);
  672. }
  673. /**
  674. * @group ZF-10964
  675. */
  676. public function test_RESTfulController_DELETE_user_byIdentifier_urlencodedWithPlusSymbol()
  677. {
  678. $request = $this->_buildRequest('DELETE', '/mod/user/email%2Btest%40example.com');
  679. $config = array('mod');
  680. $values = $this->_invokeRouteMatch($request, $config);
  681. $this->assertTrue(is_array($values));
  682. $this->assertTrue(isset($values['module']));
  683. $this->assertEquals('mod', $values['module']);
  684. $this->assertEquals('user', $values['controller']);
  685. $this->assertEquals('delete', $values['action']);
  686. $this->assertEquals('email+test@example.com', $values['id']);
  687. }
  688. public function test_assemble_plain_ignores_action()
  689. {
  690. $route = new Zend_Rest_Route($this->_front, array(), array());
  691. $params = array('module'=>'mod', 'controller'=>'user', 'action'=>'get');
  692. $url = $route->assemble($params);
  693. $this->assertEquals('mod/user', $url);
  694. }
  695. public function test_assemble_id_after_controller()
  696. {
  697. $route = new Zend_Rest_Route($this->_front, array(), array());
  698. $params = array('module'=>'mod', 'controller'=>'user', 'id'=>'lcrouch');
  699. $url = $route->assemble($params);
  700. $this->assertEquals('mod/user/lcrouch', $url);
  701. }
  702. public function test_assemble_index_after_controller_with_params()
  703. {
  704. $route = new Zend_Rest_Route($this->_front, array(), array());
  705. $params = array('module'=>'mod', 'controller'=>'user', 'index'=>true, 'foo'=>'bar');
  706. $url = $route->assemble($params);
  707. $this->assertEquals('mod/user/index/foo/bar', $url);
  708. }
  709. public function test_assemble_encode_param_values()
  710. {
  711. $route = new Zend_Rest_Route($this->_front, array(), array());
  712. $params = array('module'=>'mod', 'controller'=>'user', 'index'=>true, 'foo'=>'bar is n!ice');
  713. $url = $route->assemble($params);
  714. $this->assertEquals('mod/user/index/foo/bar+is+n%21ice', $url);
  715. }
  716. public function test_assemble_does_NOT_encode_param_values()
  717. {
  718. $route = new Zend_Rest_Route($this->_front, array(), array());
  719. $params = array('module'=>'mod', 'controller'=>'user', 'index'=>true, 'foo'=>'bar is n!ice');
  720. $url = $route->assemble($params, false, false);
  721. $this->assertEquals('mod/user/index/foo/bar is n!ice', $url);
  722. }
  723. /**
  724. * @group ZF-9823
  725. */
  726. public function test_assemble_edit_with_module_appends_action_after_id()
  727. {
  728. $route = new Zend_Rest_Route($this->_front, array(), array());
  729. $params = array('module'=>'mod', 'controller'=>'users', 'action'=>'edit', 'id'=>1);
  730. $url = $route->assemble($params);
  731. $this->assertEquals('mod/users/1/edit', $url);
  732. }
  733. /**
  734. * @group ZF-9823
  735. */
  736. public function test_assemble_edit_without_module_appends_action_after_id()
  737. {
  738. $route = new Zend_Rest_Route($this->_front, array(), array());
  739. $params = array('controller'=>'users', 'action'=>'edit', 'id'=>1);
  740. $url = $route->assemble($params);
  741. $this->assertEquals('users/1/edit', $url);
  742. }
  743. /**
  744. * @group ZF-9823
  745. */
  746. public function test_assemble_new_with_module_appends_action()
  747. {
  748. $route = new Zend_Rest_Route($this->_front, array(), array());
  749. $params = array('module'=>'mod', 'controller'=>'users', 'action'=>'new');
  750. $url = $route->assemble($params);
  751. $this->assertEquals('mod/users/new', $url);
  752. }
  753. /**
  754. * @group ZF-9823
  755. */
  756. public function test_assemble_new_without_module_appends_action()
  757. {
  758. $route = new Zend_Rest_Route($this->_front, array(), array());
  759. $params = array('controller'=>'users', 'action'=>'new');
  760. $url = $route->assemble($params);
  761. $this->assertEquals('users/new', $url);
  762. }
  763. /**
  764. * @group ZF-9823
  765. */
  766. public function test_assemble_random_action_with_module_removes_action()
  767. {
  768. $route = new Zend_Rest_Route($this->_front, array(), array());
  769. $params = array('module'=>'mod', 'controller'=>'users', 'action'=>'newbar');
  770. $url = $route->assemble($params);
  771. $this->assertNotEquals('mod/users/newbar', $url);
  772. }
  773. /**
  774. * @group ZF-9823
  775. */
  776. public function test_assemble_random_action_without_module_removes_action()
  777. {
  778. $route = new Zend_Rest_Route($this->_front, array(), array());
  779. $params = array('controller'=>'users', 'action'=>'newbar');
  780. $url = $route->assemble($params);
  781. $this->assertNotEquals('users/newbar', $url);
  782. }
  783. /**
  784. * @group ZF-9823
  785. */
  786. public function test_assemble_with_module_honors_index_parameter_with_resource_id_and_extra_parameters()
  787. {
  788. $route = new Zend_Rest_Route($this->_front, array(), array());
  789. $params = array('module'=>'mod', 'controller'=>'users', 'id' => 1, 'extra'=>'parameter', 'another' => 'parameter', 'index' => true);
  790. $url = $route->assemble($params, false, false);
  791. $this->assertEquals('mod/users/index/1/extra/parameter/another/parameter', $url);
  792. }
  793. /**
  794. * @group ZF-9823
  795. */
  796. public function test_assemble_without_module_honors_index_parameter_with_resource_id_and_extra_parameters()
  797. {
  798. $route = new Zend_Rest_Route($this->_front, array(), array());
  799. $params = array('controller'=>'users', 'id' => 1, 'extra'=>'parameter', 'another' => 'parameter', 'index' => true);
  800. $url = $route->assemble($params, false, false);
  801. $this->assertEquals('users/index/1/extra/parameter/another/parameter', $url);
  802. }
  803. /**
  804. * @group ZF-9115
  805. */
  806. public function test_request_get_user_params()
  807. {
  808. $uri = Zend_Uri::factory('http://localhost.com/user/index?a=1&b=2');
  809. $request = new Zend_Controller_Request_Http($uri);
  810. $request->setParam('test', 5);
  811. $config = array('mod'=>array('user'));
  812. $this->_invokeRouteMatch($request, $config);
  813. $this->assertEquals(array("test"=>5), $request->getUserParams());
  814. $this->assertEquals(array("test"=>5,"a"=>1,"b"=>2), $request->getParams());
  815. }
  816. private function _buildRequest($method, $uri)
  817. {
  818. $request = new Zend_Controller_Request_HttpTestCase();
  819. $request->setMethod($method)->setRequestUri($uri);
  820. return $request;
  821. }
  822. private function _invokeRouteMatch($request, $config = array(), $route = null)
  823. {
  824. $this->_front->setRequest($request);
  825. if ($route == null) {
  826. $route = new Zend_Rest_Route($this->_front, array(), $config);
  827. }
  828. $values = $route->match($request);
  829. return $values;
  830. }
  831. }
  832. // Call Zend_Rest_RouteTest::main() if this source file is executed directly.
  833. if (PHPUnit_MAIN_METHOD == "Zend_Rest_RouteTest::main") {
  834. Zend_Rest_RouteTest::main();
  835. }