first draft of hypermedia implementation

[github/wallabag/wallabag.git] / src / Wallabag / CoreBundle / Controller / WallabagRestController.php

diff --git a/src/Wallabag/CoreBundle/Controller/WallabagRestController.php b/src/Wallabag/CoreBundle/Controller/WallabagRestController.php
index abbf54373da203a21186bb41ec76947b3e2141a0..cadd7e755cabf4a815fbe6f03127e37dae84543d 100644 (file)
--- a/src/Wallabag/CoreBundle/Controller/WallabagRestController.php
+++ b/src/Wallabag/CoreBundle/Controller/WallabagRestController.php
@@ -5,21 +5,46 @@ namespace Wallabag\CoreBundle\Controller;
 use Nelmio\ApiDocBundle\Annotation\ApiDoc;
 use Symfony\Bundle\FrameworkBundle\Controller\Controller;
 use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpFoundation\Response;
 use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
-use Wallabag\CoreBundle\Entity\Entries;
-use Wallabag\CoreBundle\Entity\Tags;
+use Wallabag\CoreBundle\Entity\Entry;
+use Wallabag\CoreBundle\Entity\Tag;
 use Wallabag\CoreBundle\Service\Extractor;
+use Hateoas\HateoasBuilder;
 
 class WallabagRestController extends Controller
 {
+    /**
+     * Retrieve salt for a giver user.
+     *
+     * @ApiDoc(
+     *       parameters={
+     *          {"name"="username", "dataType"="string", "required"=true, "description"="username"}
+     *       }
+     * )
+     * @return array
+     */
+    public function getSaltAction($username)
+    {
+        $user = $this
+            ->getDoctrine()
+            ->getRepository('WallabagCoreBundle:User')
+            ->findOneByUsername($username);
+
+        if (is_null($user)) {
+            throw $this->createNotFoundException();
+        }
+
+        return array($user->getSalt() ?: null);
+    }
     /**
      * Retrieve all entries. It could be filtered by many options.
      *
      * @ApiDoc(
      *       parameters={
-     *          {"name"="archive", "dataType"="integer", "required"=false, "format"="'0' or '1', all entries by default", "description"="filter by archived status."},
-     *          {"name"="star", "dataType"="integer", "required"=false, "format"="'0' or '1', all entries by default", "description"="filter by starred status."},
-     *          {"name"="delete", "dataType"="integer", "required"=false, "format"="'0' or '1', default '0'", "description"="filter by deleted status."},
+     *          {"name"="archive", "dataType"="boolean", "required"=false, "format"="true or false, all entries by default", "description"="filter by archived status."},
+     *          {"name"="star", "dataType"="boolean", "required"=false, "format"="true or false, all entries by default", "description"="filter by starred status."},
+     *          {"name"="delete", "dataType"="boolean", "required"=false, "format"="true or false, default '0'", "description"="filter by deleted status."},
      *          {"name"="sort", "dataType"="string", "required"=false, "format"="'created' or 'updated', default 'created'", "description"="sort entries by date."},
      *          {"name"="order", "dataType"="string", "required"=false, "format"="'asc' or 'desc', default 'desc'", "description"="order of sort."},
      *          {"name"="page", "dataType"="integer", "required"=false, "format"="default '1'", "description"="what page you want."},
@@ -27,7 +52,7 @@ class WallabagRestController extends Controller
      *          {"name"="tags", "dataType"="string", "required"=false, "format"="api%2Crest", "description"="a list of tags url encoded. Will returns entries that matches ALL tags."},
      *       }
      * )
-     * @return Entries
+     * @return Entry
      */
     public function getEntriesAction(Request $request)
     {
@@ -42,13 +67,16 @@ class WallabagRestController extends Controller
 
         $entries = $this
             ->getDoctrine()
-            ->getRepository('WallabagCoreBundle:Entries')
-            ->findEntries(1, $isArchived, $isStarred, $isDeleted, $sort, $order);
+            ->getRepository('WallabagCoreBundle:Entry')
+            ->findEntries($this->getUser()->getId(), $isArchived, $isStarred, $isDeleted, $sort, $order);
 
-        if (!is_array($entries)) {
+        if (!($entries)) {
             throw $this->createNotFoundException();
         }
 
+        $hateoas = HateoasBuilder::create()->build();
+        $json = $hateoas->serialize($entries, 'json');
+
         return $entries;
     }
 
@@ -60,11 +88,14 @@ class WallabagRestController extends Controller
      *          {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
      *      }
      * )
-     * @return Entries
+     * @return Entry
      */
-    public function getEntryAction(Entries $entry)
+    public function getEntryAction(Entry $entry)
     {
-        return $entry;
+        $hateoas = HateoasBuilder::create()->build();
+        $json = $hateoas->serialize($entry, 'json');
+
+        return new Response($json, 200, array('application/json'));
     }
 
     /**
@@ -77,6 +108,7 @@ class WallabagRestController extends Controller
      *          {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."},
      *       }
      * )
+     * @return Entry
      */
     public function postEntriesAction(Request $request)
     {
@@ -84,8 +116,7 @@ class WallabagRestController extends Controller
         $url = $request->request->get('url');
 
         $content = Extractor::extract($url);
-        $entry = new Entries();
-        $entry->setUserId(1);
+        $entry = new Entry($this->getUser());
         $entry->setUrl($url);
         $entry->setTitle($request->request->get('title') ?: $content->getTitle());
         $entry->setContent($content->getBody());
@@ -106,14 +137,41 @@ class WallabagRestController extends Controller
      *      parameters={
      *          {"name"="title", "dataType"="string", "required"=false},
      *          {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."},
-     *          {"name"="archive", "dataType"="integer", "required"=false, "format"="'0' or '1', default '0'", "description"="archived the entry."},
-     *          {"name"="star", "dataType"="integer", "required"=false, "format"="'0' or '1', default '0'", "description"="starred the entry."},
-     *          {"name"="delete", "dataType"="integer", "required"=false, "format"="'0' or '1', default '0'", "description"="flag as deleted. Default false. In case that you don't want to *really* remove it.."},
+     *          {"name"="archive", "dataType"="boolean", "required"=false, "format"="true or false", "description"="archived the entry."},
+     *          {"name"="star", "dataType"="boolean", "required"=false, "format"="true or false", "description"="starred the entry."},
+     *          {"name"="delete", "dataType"="boolean", "required"=false, "format"="true or false", "description"="flag as deleted. Default false. In case that you don't want to *really* remove it.."},
      *       }
      * )
+     * @return Entry
      */
-    public function patchEntriesAction(Entries $entry)
+    public function patchEntriesAction(Entry $entry, Request $request)
     {
+        $title      = $request->request->get("title");
+        $tags       = $request->request->get("tags", array());
+        $isArchived = $request->request->get("archive");
+        $isDeleted  = $request->request->get("delete");
+        $isStarred  = $request->request->get("star");
+
+        if (!is_null($title)) {
+            $entry->setTitle($title);
+        }
+
+        if (!is_null($isArchived)) {
+            $entry->setArchived($isArchived);
+        }
+
+        if (!is_null($isDeleted)) {
+            $entry->setDeleted($isDeleted);
+        }
+
+        if (!is_null($isStarred)) {
+            $entry->setStarred($isStarred);
+        }
+
+        $em = $this->getDoctrine()->getManager();
+        $em->flush();
+
+        return $entry;
     }
 
     /**
@@ -124,8 +182,9 @@ class WallabagRestController extends Controller
      *          {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
      *      }
      * )
+     * @return Entry
      */
-    public function deleteEntriesAction(Entries $entry)
+    public function deleteEntriesAction(Entry $entry)
     {
         if ($entry->isDeleted()) {
             throw new NotFoundHttpException('This entry is already deleted');
@@ -133,7 +192,6 @@ class WallabagRestController extends Controller
 
         $em = $this->getDoctrine()->getManager();
         $entry->setDeleted(1);
-        $em->persist($entry);
         $em->flush();
 
         return $entry;
@@ -148,7 +206,7 @@ class WallabagRestController extends Controller
      *      }
      * )
      */
-    public function getEntriesTagsAction(Entries $entry)
+    public function getEntriesTagsAction(Entry $entry)
     {
     }
 
@@ -164,7 +222,7 @@ class WallabagRestController extends Controller
      *       }
      * )
      */
-    public function postEntriesTagsAction(Entries $entry)
+    public function postEntriesTagsAction(Entry $entry)
     {
     }
 
@@ -178,7 +236,7 @@ class WallabagRestController extends Controller
      *      }
      * )
      */
-    public function deleteEntriesTagsAction(Entries $entry, Tags $tag)
+    public function deleteEntriesTagsAction(Entry $entry, Tag $tag)
     {
     }
 
@@ -201,7 +259,7 @@ class WallabagRestController extends Controller
      *       }
      * )
      */
-    public function getTagAction(Tags $tag)
+    public function getTagAction(Tag $tag)
     {
     }
 
@@ -214,7 +272,7 @@ class WallabagRestController extends Controller
      *      }
      * )
      */
-    public function deleteTagAction(Tags $tag)
+    public function deleteTagAction(Tag $tag)
     {
     }
 }