Merge pull request #708 from stopfstedt/restrictions_api

Adds (experimental) endpoint for restricted lists.

composer.json

@@ -11,6 +11,7 @@
     "ext-json": "*",
     "ext-mbstring": "*",
     "ext-pdo": "*",
+    "doctrine/annotations": "^1.0",
     "doctrine/doctrine-bundle": "^2.2",
     "doctrine/doctrine-fixtures-bundle": "^3.3",
     "doctrine/doctrine-migrations-bundle": "^2.0",
@@ -25,6 +26,7 @@
     "jms/i18n-routing-bundle": "@stable",
     "nelmio/api-doc-bundle": "^3.6",
     "nelmio/cors-bundle": "^2.1",
+    "phpdocumentor/reflection-docblock": "^5.2",
     "ramsey/uuid-doctrine": "^1.5",
     "sensio/framework-extra-bundle": "^5.0.0",
     "sensiolabs/security-checker": "^6.0",
@@ -37,6 +39,9 @@
     "symfony/monolog-bundle": "3.6.*",
     "symfony/polyfill-apcu": "^1.0",
     "symfony/polyfill-mbstring": "^1.14.0",
+    "symfony/property-access": "4.4.*",
+    "symfony/property-info": "4.4.*",
+    "symfony/serializer": "4.4.*",
     "symfony/swiftmailer-bundle": "^3.3.1",
     "symfony/templating": "^4",
     "symfony/yaml": "^5.1",

src/Controller/ApiController.php

@@ -9,12 +9,15 @@
 use App\Entity\DecklistInterface;
 use App\Entity\Pack;
 use App\Entity\PackInterface;
+use App\Entity\Restriction;
 use App\Services\CardsData;
 use DateInterval;
 use DateTime;
 use Doctrine\Common\Collections\Criteria;
 use Exception;
 use Nelmio\ApiDocBundle\Annotation\Operation;
+use Psr\Http\Message\RequestInterface;
+use Psr\Http\Message\ResponseInterface;
 use Swagger\Annotations as SWG;
 use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
 use Symfony\Component\HttpFoundation\Request;
@@ -23,6 +26,7 @@
 use Symfony\Component\Routing\Annotation\Route;
 use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
 use Symfony\Component\Routing\RouterInterface;
+use Symfony\Component\Serializer\SerializerInterface;
 
 /**
  * @package App\Controller
@@ -601,4 +605,41 @@ public function listDecklistsByDateAction($date, Request $request, int $cacheExp
         $response->setContent($content);
         return $response;
     }
+
+    /**
+     * @Route("/api/public/restrictions/", name="api_restrictions", methods={"GET"}, options={"i18n" = false})
+     *
+     * Get the description of all the restricted lists as an array of JSON objects.
+     *
+     * @Operation(
+     *     tags={"Public"},
+     *     summary="EXPERIMENTAL - DO NOT USE IN PRODUCTION. All the restricted lists.",
+     *     @SWG\Response(
+     *         response="200",
+     *         description="Returned when successful"
+     *     )
+     * )
+     *
+     * @param Request $request
+     * @param int $cacheExpiration
+     * @param SerializerInterface $serializer
+     * @return Response
+     */
+    public function listRestrictions(Request $request, int $cacheExpiration, SerializerInterface $serializer): Response
+    {
+        $response = new Response();
+        $response->setPublic();
+        $response->setMaxAge($cacheExpiration);
+        $response->headers->add(array(
+            'Access-Control-Allow-Origin' => '*',
+            'Content-Language' => $request->getLocale()
+        ));
+
+        $repo = $this->getDoctrine()->getRepository(Restriction::class);
+        $restrictions = $repo->findAll();
+        $json = $serializer->serialize($restrictions, 'json');
+        $response->headers->set('Content-Type', 'application/json');
+        $response->setContent($json);
+        return $response;
+    }
 }

symfony.lock

@@ -268,6 +268,9 @@
             "config/packages/security.yaml"
         ]
     },
+    "symfony/serializer-pack": {
+        "version": "v1.0.4"
+    },
     "symfony/string": {
         "version": "v5.1.8"
     },