oss/wallabag
oss/wallabag
1
0
Fork 0
mirror of https://github.com/wallabag/wallabag.git synced 2025-07-27 17:28:39 +00:00
Code Wiki Activity

Merge pull request #3887 from wallabag/issue-3711

Browse source 
Add support of expect parameter to change return object when deleting entry
This commit is contained in:
Jérémy Benoist 2019-02-25 10:56:07 +01:00 • committed by GitHub
commit 4de99d1ab1
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 72 additions and 17 deletions
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;
} }
/** /**

68
tests/Wallabag/ApiBundle/Controller/EntryRestControllerTest.php
View file

@ -400,29 +400,71 @@ class EntryRestControllerTest extends WallabagApiTestCase
public function testDeleteEntry() public function testDeleteEntry()
{ {
$entry = $this->client->getContainer() $em = $this->client->getContainer()->get('doctrine.orm.entity_manager');
->get('doctrine.orm.entity_manager') $entry = new Entry($em->getReference(User::class, 1));
->getRepository('WallabagCoreBundle:Entry') $entry->setUrl('http://0.0.0.0/test-delete-entry');
->findOneByUser(1, ['id' => 'asc']); $entry->setTitle('Test delete entry');
$em->persist($entry);
$em->flush();
if (!$entry) { $em->clear();
$this->markTestSkipped('No content found in db.');
}
$this->client->request('DELETE', '/api/entries/' . $entry->getId() . '.json'); $e = [
'title' => $entry->getTitle(),
'url' => $entry->getUrl(),
'id' => $entry->getId(),
];
$this->client->request('DELETE', '/api/entries/' . $e['id'] . '.json');
$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($e['title'], $content['title']);
$this->assertSame($entry->getUrl(), $content['url']); $this->assertSame($e['url'], $content['url']);
$this->assertSame($entry->getId(), $content['id']); $this->assertSame($e['id'], $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'); $client = $this->createAuthorizedClient();
$client->request('DELETE', '/api/entries/' . $e['id'] . '.json');
$this->assertSame(404, $this->client->getResponse()->getStatusCode()); $this->assertSame(404, $client->getResponse()->getStatusCode());
}
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());
$content = json_decode($this->client->getResponse()->getContent(), true);
$this->assertSame($id, $content['id']);
$this->assertArrayNotHasKey('url', $content);
// We'll try to delete this entry again
$client = $this->createAuthorizedClient();
$client->request('DELETE', '/api/entries/' . $id . '.json');
$this->assertSame(404, $client->getResponse()->getStatusCode());
}
public function testDeleteEntryExpectBadRequest()
{
$this->client->request('DELETE', '/api/entries/1.json?expect=badrequest');
$this->assertSame(400, $this->client->getResponse()->getStatusCode());
} }
public function testPostEntry() public function testPostEntry()