mirrors/wallabag
1
0
Fork 0
mirror of https://github.com/wallabag/wallabag.git synced 2024-11-26 11:01:04 +00:00
Code Issues Projects Releases Wiki Activity

Avoid BC on exists endpoint

Browse source
This commit is contained in:
Jeremy Benoist 2017-06-23 08:30:23 +02:00
parent 29714661b1
commit 18696f77fd
No known key found for this signature in database
GPG key ID: BCA73962457ACC3C
2 changed files with 43 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
src/Wallabag/ApiBundle/Controller/EntryRestController.php
View file

@ -18,9 +18,12 @@ class EntryRestController extends WallabagRestController
{ {
/** /**
* Check if an entry exist by url. * Check if an entry exist by url.
* Return ID if entry(ies) exist (and if you give the return_id parameter).
* Otherwise it returns false.
* *
* @ApiDoc( * @ApiDoc(
* parameters={ * parameters={
* {"name"="return_id", "dataType"="string", "required"=false, "format"="1 or 0", "description"="Set 1 if you want to retrieve ID in case entry(ies) exists, 0 by default"},
* {"name"="url", "dataType"="string", "required"=true, "format"="An url", "description"="Url to check if it exists"}, * {"name"="url", "dataType"="string", "required"=true, "format"="An url", "description"="Url to check if it exists"},
* {"name"="urls", "dataType"="string", "required"=false, "format"="An array of urls (?urls[]=http...&urls[]=http...)", "description"="Urls (as an array) to check if it exists"} * {"name"="urls", "dataType"="string", "required"=false, "format"="An array of urls (?urls[]=http...&urls[]=http...)", "description"="Urls (as an array) to check if it exists"}
* } * }
@ -32,6 +35,7 @@ class EntryRestController extends WallabagRestController
{ {
$this->validateAuthentication(); $this->validateAuthentication();
$returnId = (null === $request->query->get('return_id')) ? 0 : (bool) $request->query->get('return_id');
$urls = $request->query->get('urls', []); $urls = $request->query->get('urls', []);
// handle multiple urls first // handle multiple urls first
@ -42,7 +46,7 @@ class EntryRestController extends WallabagRestController
->getRepository('WallabagCoreBundle:Entry') ->getRepository('WallabagCoreBundle:Entry')
->findByUrlAndUserId($url, $this->getUser()->getId()); ->findByUrlAndUserId($url, $this->getUser()->getId());
$results[$url] = $res instanceof Entry ? $res->getId() : false; $results[$url] = $res instanceof Entry ? ($returnId ? $res->getId() : true) : false;
} }
return $this->sendResponse($results); return $this->sendResponse($results);
@ -59,7 +63,7 @@ class EntryRestController extends WallabagRestController
->getRepository('WallabagCoreBundle:Entry') ->getRepository('WallabagCoreBundle:Entry')
->findByUrlAndUserId($url, $this->getUser()->getId()); ->findByUrlAndUserId($url, $this->getUser()->getId());
$exists = $res instanceof Entry ? $res->getId() : false; $exists = $res instanceof Entry ? ($returnId ? $res->getId() : true) : false;
return $this->sendResponse(['exists' => $exists]); return $this->sendResponse(['exists' => $exists]);
} }

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

@ -759,18 +759,51 @@ class EntryRestControllerTest extends WallabagApiTestCase
$this->assertEquals(true, $content['is_starred']); $this->assertEquals(true, $content['is_starred']);
} }
public function testGetEntriesExists() public function dataForEntriesExistWithUrl()
{ {
$this->client->request('GET', '/api/entries/exists?url=http://0.0.0.0/entry2'); return [
'with_id' => [
'url' => '/api/entries/exists?url=http://0.0.0.0/entry2&return_id=1',
'expectedValue' => 2,
],
'without_id' => [
'url' => '/api/entries/exists?url=http://0.0.0.0/entry2',
'expectedValue' => true,
],
];
}
/**
* @dataProvider dataForEntriesExistWithUrl
*/
public function testGetEntriesExists($url, $expectedValue)
{
$this->client->request('GET', $url);
$this->assertEquals(200, $this->client->getResponse()->getStatusCode()); $this->assertEquals(200, $this->client->getResponse()->getStatusCode());
$content = json_decode($this->client->getResponse()->getContent(), true); $content = json_decode($this->client->getResponse()->getContent(), true);
$this->assertEquals(2, $content['exists']); $this->assertSame($expectedValue, $content['exists']);
} }
public function testGetEntriesExistsWithManyUrls() public function testGetEntriesExistsWithManyUrls()
{
$url1 = 'http://0.0.0.0/entry2';
$url2 = 'http://0.0.0.0/entry10';
$this->client->request('GET', '/api/entries/exists?urls[]='.$url1.'&urls[]='.$url2.'&return_id=1');
$this->assertEquals(200, $this->client->getResponse()->getStatusCode());
$content = json_decode($this->client->getResponse()->getContent(), true);
$this->assertArrayHasKey($url1, $content);
$this->assertArrayHasKey($url2, $content);
$this->assertSame(2, $content[$url1]);
$this->assertSame(false, $content[$url2]);
}
public function testGetEntriesExistsWithManyUrlsReturnBool()
{ {
$url1 = 'http://0.0.0.0/entry2'; $url1 = 'http://0.0.0.0/entry2';
$url2 = 'http://0.0.0.0/entry10'; $url2 = 'http://0.0.0.0/entry10';
@ -782,7 +815,7 @@ class EntryRestControllerTest extends WallabagApiTestCase
$this->assertArrayHasKey($url1, $content); $this->assertArrayHasKey($url1, $content);
$this->assertArrayHasKey($url2, $content); $this->assertArrayHasKey($url2, $content);
$this->assertEquals(2, $content[$url1]); $this->assertEquals(true, $content[$url1]);
$this->assertEquals(false, $content[$url2]); $this->assertEquals(false, $content[$url2]);
} }