From 18696f77fdc76f7055d84460d459051a6bb7253a Mon Sep 17 00:00:00 2001
From: Jeremy Benoist <jeremy.benoist@gmail.com>
Date: Fri, 23 Jun 2017 08:30:23 +0200
Subject: [PATCH] Avoid BC on exists endpoint

---
 .../Controller/EntryRestController.php        |  8 +++-
 .../Controller/EntryRestControllerTest.php    | 41 +++++++++++++++++--
 2 files changed, 43 insertions(+), 6 deletions(-)

diff --git a/src/Wallabag/ApiBundle/Controller/EntryRestController.php b/src/Wallabag/ApiBundle/Controller/EntryRestController.php
index 768c4fdc..793b91ba 100644
--- a/src/Wallabag/ApiBundle/Controller/EntryRestController.php
+++ b/src/Wallabag/ApiBundle/Controller/EntryRestController.php
@@ -18,9 +18,12 @@ 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.
      *
      * @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 +35,7 @@ class EntryRestController extends WallabagRestController
     {
         $this->validateAuthentication();
 
+        $returnId = (null === $request->query->get('return_id')) ? 0 : (bool) $request->query->get('return_id');
         $urls = $request->query->get('urls', []);
 
         // handle multiple urls first
@@ -42,7 +46,7 @@ class EntryRestController extends WallabagRestController
                     ->getRepository('WallabagCoreBundle:Entry')
                     ->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);
@@ -59,7 +63,7 @@ class EntryRestController extends WallabagRestController
             ->getRepository('WallabagCoreBundle:Entry')
             ->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]);
     }
diff --git a/tests/Wallabag/ApiBundle/Controller/EntryRestControllerTest.php b/tests/Wallabag/ApiBundle/Controller/EntryRestControllerTest.php
index 067aed2c..dc21bd32 100644
--- a/tests/Wallabag/ApiBundle/Controller/EntryRestControllerTest.php
+++ b/tests/Wallabag/ApiBundle/Controller/EntryRestControllerTest.php
@@ -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->assertSame(false, $content[$url2]);
+    }
+
+    public function testGetEntriesExistsWithManyUrlsReturnBool()
     {
         $url1 = 'http://0.0.0.0/entry2';
         $url2 = 'http://0.0.0.0/entry10';
@@ -782,7 +815,7 @@ class EntryRestControllerTest extends WallabagApiTestCase
 
         $this->assertArrayHasKey($url1, $content);
         $this->assertArrayHasKey($url2, $content);
-        $this->assertEquals(2, $content[$url1]);
+        $this->assertEquals(true, $content[$url1]);
         $this->assertEquals(false, $content[$url2]);
     }
 
-- 
2.41.0