devol
/
wallabag
mirror of https://github.com/wallabag/wallabag.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

EntryRestController: add support of expect parameter to delete action 

The expect parameter enables an application to request the whole entry
or only the id when requesting its deletion.

`expects` defaults to `entry` to prevent any API breakage.

Fixes #3711

Signed-off-by: Kevin Decherf <kevin@kdecherf.com>
This commit is contained in:
Kevin Decherf 2019-02-17 15:30:42 +01:00
parent 4e0ed3368d
commit 508302042f
2 changed files with 33 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
src/Wallabag/ApiBundle/Controller/EntryRestController.php
View File

@ -570,18 +570,31 @@ class EntryRestController extends WallabagRestController
* @ApiDoc( * @ApiDoc(
* requirements={ * requirements={
* {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"} * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
* },
* parameters={
* {"name"="expect", "dataType"="string", "required"=false, "format"="id or entry", "description"="Only returns the id instead of the deleted entry's full entity if 'id' is specified. Default to entry"},
* } * }
* ) * )
* *
* @return JsonResponse * @return JsonResponse
*/ */
public function deleteEntriesAction(Entry $entry) public function deleteEntriesAction(Entry $entry, Request $request)
{ {
$expect = $request->query->get('expect', 'entry');
if (!\in_array($expect, ['id', 'entry'], true)) {
throw new BadRequestHttpException(sprintf("expect: 'id' or 'entry' expected, %s given", $expect));
}
$this->validateAuthentication(); $this->validateAuthentication();
$this->validateUserAccess($entry->getUser()->getId()); $this->validateUserAccess($entry->getUser()->getId());
// We copy $entry to keep id in returned object $response = $this->sendResponse([
$e = $entry; 'id' => $entry->getId(),
]);
// We clone $entry to keep id in returned object
if ('entry' === $expect) {
$e = clone $entry;
$response = $this->sendResponse($e);
}
$em = $this->getDoctrine()->getManager(); $em = $this->getDoctrine()->getManager();
$em->remove($entry); $em->remove($entry);
@ -590,7 +603,7 @@ class EntryRestController extends WallabagRestController
// entry deleted, dispatch event about it! // entry deleted, dispatch event about it!
$this->get('event_dispatcher')->dispatch(EntryDeletedEvent::NAME, new EntryDeletedEvent($entry)); $this->get('event_dispatcher')->dispatch(EntryDeletedEvent::NAME, new EntryDeletedEvent($entry));
return $this->sendResponse($e); return $response;
} }
/** /**

21
tests/Wallabag/ApiBundle/Controller/EntryRestControllerTest.php
View File

@ -431,18 +431,29 @@ class EntryRestControllerTest extends WallabagApiTestCase
$this->assertSame(404, $this->client->getResponse()->getStatusCode()); $this->assertSame(404, $this->client->getResponse()->getStatusCode());
} }
$this->client->request('DELETE', '/api/entries/' . $entry->getId() . '.json'); public function testDeleteEntryExpectId()
{
$em = $this->client->getContainer()->get('doctrine.orm.entity_manager');
$entry = new Entry($em->getReference(User::class, 1));
$entry->setUrl('http://0.0.0.0/test-delete-entry-id');
$em->persist($entry);
$em->flush();
$em->clear();
$id = $entry->getId();
$this->client->request('DELETE', '/api/entries/' . $id . '.json?expect=id');
$this->assertSame(200, $this->client->getResponse()->getStatusCode()); $this->assertSame(200, $this->client->getResponse()->getStatusCode());
$content = json_decode($this->client->getResponse()->getContent(), true); $content = json_decode($this->client->getResponse()->getContent(), true);
$this->assertSame($entry->getTitle(), $content['title']); $this->assertSame($id, $content['id']);
$this->assertSame($entry->getUrl(), $content['url']); $this->assertArrayNotHasKey('url', $content);
$this->assertSame($entry->getId(), $content['id']);
// We'll try to delete this entry again // We'll try to delete this entry again
$this->client->request('DELETE', '/api/entries/' . $entry->getId() . '.json'); $this->client->request('DELETE', '/api/entries/' . $id . '.json');
$this->assertSame(404, $this->client->getResponse()->getStatusCode()); $this->assertSame(404, $this->client->getResponse()->getStatusCode());
} }