mirrors/wallabag
1
0
Fork 0
mirror of https://github.com/wallabag/wallabag.git synced 2024-12-17 13:16:28 +00:00
Code Issues Projects Releases Wiki Activity

Merge pull request #3245 from wallabag/fix-bc

Browse source 
Avoid BC on exists endpoint
This commit is contained in:
Jérémy Benoist 2017-06-29 11:17:58 +02:00 committed by GitHub
commit 822c877949
2 changed files with 69 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -4,6 +4,7 @@ namespace Wallabag\ApiBundle\Controller;
use Hateoas\Configuration\Route;
use Hateoas\Representation\Factory\PagerfantaFactory;
use JMS\Serializer\SerializationContext;
use Nelmio\ApiDocBundle\Annotation\ApiDoc;
use Symfony\Component\HttpKernel\Exception\HttpException;
use Symfony\Component\HttpFoundation\Request;
@ -18,9 +19,14 @@ class EntryRestController extends WallabagRestController
{
/**
* 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.
*
* @todo Remove that `return_id` in the next major release
*
* @ApiDoc(
* 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"="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 +38,7 @@ class EntryRestController extends WallabagRestController
{
$this->validateAuthentication();
$returnId = (null === $request->query->get('return_id')) ? false : (bool) $request->query->get('return_id');
$urls = $request->query->get('urls', []);
// handle multiple urls first
@ -42,7 +49,7 @@ class EntryRestController extends WallabagRestController
->getRepository('WallabagCoreBundle:Entry')
->findByUrlAndUserId($url, $this->getUser()->getId());
$results[$url] = $res instanceof Entry ? $res->getId() : false;
$results[$url] = $this->returnExistInformation($res, $returnId);
}
return $this->sendResponse($results);
@ -59,7 +66,7 @@ class EntryRestController extends WallabagRestController
->getRepository('WallabagCoreBundle:Entry')
->findByUrlAndUserId($url, $this->getUser()->getId());
$exists = $res instanceof Entry ? $res->getId() : false;
$exists = $this->returnExistInformation($res, $returnId);
return $this->sendResponse(['exists' => $exists]);
}
@ -617,7 +624,11 @@ class EntryRestController extends WallabagRestController
*/
private function sendResponse($data)
{
$json = $this->get('serializer')->serialize($data, 'json');
// https://github.com/schmittjoh/JMSSerializerBundle/issues/293
$context = new SerializationContext();
$context->setSerializeNull(true);
$json = $this->get('serializer')->serialize($data, 'json', $context);
return (new JsonResponse())->setJson($json);
}
@ -694,4 +705,21 @@ class EntryRestController extends WallabagRestController
// entry saved, dispatch event about it!
$this->get('event_dispatcher')->dispatch(EntrySavedEvent::NAME, new EntrySavedEvent($entry));
}
/**
* Return information about the entry if it exist and depending on the id or not.
*
* @param Entry|null $entry
* @param bool $returnId
*
* @return bool|int
*/
private function returnExistInformation($entry, $returnId)
{
if ($returnId) {
return $entry instanceof Entry ? $entry->getId() : null;
}
return $entry instanceof Entry;
}
}

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

@ -759,18 +759,51 @@ class EntryRestControllerTest extends WallabagApiTestCase
$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());
$content = json_decode($this->client->getResponse()->getContent(), true);
$this->assertEquals(2, $content['exists']);
$this->assertSame($expectedValue, $content['exists']);
}
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->assertNull($content[$url2]);
}
public function testGetEntriesExistsWithManyUrlsReturnBool()
{
$url1 = 'http://0.0.0.0/entry2';
$url2 = 'http://0.0.0.0/entry10';
@ -782,8 +815,8 @@ class EntryRestControllerTest extends WallabagApiTestCase
$this->assertArrayHasKey($url1, $content);
$this->assertArrayHasKey($url2, $content);
$this->assertEquals(2, $content[$url1]);
$this->assertEquals(false, $content[$url2]);
$this->assertTrue($content[$url1]);
$this->assertFalse($content[$url2]);
}
public function testGetEntriesExistsWhichDoesNotExists()