Merge pull request #281 from takeit/swp-678

Filter articles by route id

Author: Paweł Mikołajczuk

CHANGELOG.md

@@ -8,6 +8,7 @@ in 0.1 minor versions.
 To get the diff for a specific change, go to https://github.com/superdesk/web-publisher/commit/XXX where XXX is the change hash
 
 * 0.5.0
+ * feature [#281] Allow to filter articles by route id in API
  * feature [#280] Add correct Content-Type header to routes with extensions
  * feature [#279] Allow to filter articles by status in API
  * bug [#270] Rely on "evelovedfrom" property instead of a slug

src/SWP/Bundle/ContentBundle/Controller/ArticleController.php

@@ -41,7 +41,8 @@ class ArticleController extends Controller
      *         200="Returned on success.",
      *     },
      *     filters={
-     *         {"name"="status", "dataType"="string", "pattern"="new|published|unpublished|canceled"}
+     *         {"name"="status", "dataType"="string", "pattern"="new|published|unpublished|canceled"},
+     *         {"name"="route", "dataType"="integer"}
      *     }
      * )
      * @Route("/api/{version}/content/articles/", options={"expose"=true}, defaults={"version"="v1"}, name="swp_api_content_list_articles")
@@ -58,6 +59,7 @@ public function listAction(Request $request)
         $articles = $this->get('swp.repository.article')
             ->getPaginatedByCriteria(new Criteria([
                 'status' => $request->query->get('status', ''),
+                'route' => $request->query->get('route', ''),
             ]), [], new PaginationData($request));
 
         return new ResourcesListResponse($articles);

src/SWP/Bundle/ContentBundle/Tests/Functional/Controller/ArticleControllerTest.php

@@ -232,4 +232,56 @@ private function getArticlesByStatus($status)
 
         return json_decode($client->getResponse()->getContent(), true);
     }
+
+    public function testFilterArticlesByRoute()
+    {
+        $content = $this->getArticlesByRouteId(1);
+        self::assertEquals(5, $content['total']);
+
+        $content = $this->getArticlesByRouteId(2);
+        self::assertEquals(1, $content['total']);
+        self::assertEquals(2, $content['_embedded']['_items'][0]['route']['id']);
+        self::assertEquals('Article 3', $content['_embedded']['_items'][0]['title']);
+
+        $content = $this->getArticlesByRouteId(3);
+        self::assertEquals(1, $content['total']);
+        self::assertEquals(3, $content['_embedded']['_items'][0]['route']['id']);
+        self::assertEquals('Features client1', $content['_embedded']['_items'][0]['title']);
+    }
+
+    public function testFilterArticlesByRouteAndStatus()
+    {
+        $client = static::createClient();
+        $client->request('GET', $this->router->generate('swp_api_content_list_articles', [
+            'route' => 2,
+            'status' => 'canceled',
+        ]));
+        self::assertEquals(200, $client->getResponse()->getStatusCode());
+
+        $content = json_decode($client->getResponse()->getContent(), true);
+
+        self::assertEquals(1, $content['total']);
+        self::assertEquals(2, $content['_embedded']['_items'][0]['route']['id']);
+        self::assertEquals('Article 3', $content['_embedded']['_items'][0]['title']);
+        self::assertEquals('canceled', $content['_embedded']['_items'][0]['status']);
+
+        $client->request('GET', $this->router->generate('swp_api_content_list_articles', [
+            'route' => 2,
+            'status' => 'fake',
+        ]));
+        self::assertEquals(200, $client->getResponse()->getStatusCode());
+
+        $content = json_decode($client->getResponse()->getContent(), true);
+
+        self::assertEquals(0, $content['total']);
+    }
+
+    private function getArticlesByRouteId($routeId)
+    {
+        $client = static::createClient();
+        $client->request('GET', $this->router->generate('swp_api_content_list_articles', ['route' => $routeId]));
+        self::assertEquals(200, $client->getResponse()->getStatusCode());
+
+        return json_decode($client->getResponse()->getContent(), true);
+    }
 }

src/SWP/Bundle/ContentBundle/Tests/Functional/app/Resources/fixtures/LoadArticlesData.php

@@ -139,7 +139,7 @@ public function loadArticles(ObjectManager $manager)
             [
                 'title' => 'Article 3',
                 'content' => 'article 3 content',
-                'route' => 'news',
+                'route' => 'articles',
                 'locale' => 'en',
                 'status' => ArticleInterface::STATUS_CANCELED,
             ],