Implements removeByForeignId API method

spira · Aug 19, 2015 · 3310fff · 3310fff
1 parent ced54b8
commit 3310fff
Show file tree

Hide file tree

Showing 7 changed files with 76 additions and 10 deletions.
diff --git a/api/app/Models/ArticleDiscussion.php b/api/app/Models/ArticleDiscussion.php
@@ -57,12 +57,8 @@ public function create()
      */
     public function delete()
     {
-        $discussion = $this->client->api('discussions')->findByForeignId(
+        $this->client->api('discussions')->removeByForeignId(
             $this->article->article_id
         );
-
-        $this->client->api('discussions')->remove(
-            $discussion['Discussion']['DiscussionID']
-        );
     }
 }
diff --git a/api/app/Services/Api/Vanilla/Api/Discussion.php b/api/app/Services/Api/Vanilla/Api/Discussion.php
@@ -105,4 +105,16 @@ public function remove($id)
     {
         return $this->delete('discussions/'.$id);
     }
+
+    /**
+     * Remove a discussion by foreign id.
+     *
+     * @param  string $id
+     *
+     * @return array
+     */
+    public function removeByForeignId($id)
+    {
+        return $this->delete('discussions/foreign/'.$id);
+    }
 }
diff --git a/api/tests/Services/Api/VanillaApiTest.php b/api/tests/Services/Api/VanillaApiTest.php
@@ -160,6 +160,20 @@ public function shouldRemoveDiscussion()
         $api->remove(123);
     }
 
+    /**
+     * @test
+     */
+    public function shouldRemoveDiscussionByForeignId()
+    {
+        $api = $this->getApiMock(Discussion::class);
+
+        $api->expects($this->once())
+            ->method('delete')
+            ->with('discussions/foreign/123');
+
+        $api->removeByForeignId(123);
+    }
+
 
     // Comments
 

diff --git a/api/tests/Services/Api/VanillaIntegrationTest.php b/api/tests/Services/Api/VanillaIntegrationTest.php
@@ -1,5 +1,6 @@
 <?php
 
+use Rhumsaa\Uuid\Uuid;
 use App\Services\Api\Vanilla\Client;
 
 class VanillaIntegrationTest extends TestCase
@@ -252,6 +253,21 @@ public function shouldDeleteDiscussion()
         $this->client->api('discussions')->find($id);
     }
 
+    /**
+     * @test
+     *
+     * @expectedException Symfony\Component\HttpKernel\Exception\NotFoundHttpException
+     */
+    public function shouldDeleteDiscussionByForeignId()
+    {
+        $id = (string) Uuid::uuid4();
+        $discussion = $this->client->api('discussions')->create('Foo', 'Bar', 1, ['ForeignID' => $id]);
+
+        $this->client->api('discussions')->removeByForeignId($id);
+
+        $this->client->api('discussions')->find($discussion['Discussion']['DiscussionID']);
+    }
+
 
     // Comments
 

diff --git a/forum/src/apiextended/controllers/class.apidiscussioncontroller.php b/forum/src/apiextended/controllers/class.apidiscussioncontroller.php
@@ -5,7 +5,7 @@ class ApiDiscussionController extends DiscussionController
     /**
      * Get a single discussion.
      *
-     * @param  int    $foreignId
+     * @param  string $foreignId
      * @param  string $page
      *
      * @throws Gdn_UserException
@@ -29,6 +29,30 @@ public function getByForeignId($foreignId = '', $page = '')
         $this->index($this->Discussion->DiscussionID, '', $page);
     }
 
+    /**
+     * Delete a single discussion.
+     *
+     * @param  string $foreignId
+     *
+     * @throws Gdn_UserException
+     *
+     * @return void
+     */
+    public function deleteByForeignId($foreignId = '')
+    {
+        if (!$this->isValidUuid($foreignId)) {
+            throw new Gdn_UserException('Bad Request', 400);
+        }
+
+        $discussion = $this->DiscussionModel->getForeignID($foreignId);
+
+        if (!is_object($discussion)) {
+            throw notFoundException('Discussion');
+        }
+
+        $this->delete($discussion->DiscussionID);
+    }
+
     /**
      * Checks that a string appears to be in the format of a UUID.
      *

diff --git a/forum/src/apiextended/settings/bootstrap.php b/forum/src/apiextended/settings/bootstrap.php
@@ -4,10 +4,9 @@
 }
 
 // If running the forum on PHP cli server, the content type server variable
-// is not set as CONTENT_TYPE like the API application expects, but as
-// HTTP_CONTENT_TYPE.
-// To remedy this, so we can handle API requests via the CLI server, we copy the
-// value to CONTENT_TYPE when needed.
+// is not set as CONTENT_TYPE like the API expects, but as HTTP_CONTENT_TYPE.
+// To rememdy this so we can handle API requests via the CLI server we copy the
+// value in this case
 $apiExtendedRequest = Gdn::request();
 $apiExtendedContentType = $apiExtendedRequest->getValueFrom('server', 'HTTP_CONTENT_TYPE');
 

diff --git a/forum/src/apiextended/settings/class.hooks.php b/forum/src/apiextended/settings/class.hooks.php
@@ -18,6 +18,11 @@ public function DiscussionsAPI_register_handler($sender)
                 'Page' => val('Page', $data)
             ]
         ]);
+
+        $sender::delete('/foreign/[*:foreignID]', [
+            'controller' => 'ApiDiscussion',
+            'method' => 'deletebyforeignid'
+        ]);
     }
 
     /**