TTK-26716 Add api platform (#601)

pumukit · Nov 29, 2023 · c0762d3 · c0762d3
1 parent 3eb9e48
commit c0762d3
Show file tree

Hide file tree

Showing 18 changed files with 951 additions and 413 deletions.
diff --git a/composer.json b/composer.json
@@ -5,14 +5,15 @@
     "type": "project",
     "description": "Media Portal",
     "require": {
-        "php": "^7.4 || ^8.2",
+        "php": "^8.2",
         "ext-curl": "*",
         "ext-fileinfo": "*",
         "ext-gd": "*",
         "ext-json": "*",
         "ext-mongodb": "*",
         "ext-sysvsem": "*",
         "ankitpokhrel/tus-php": "^2.0",
+        "api-platform/core": "^2.7",
         "babdev/pagerfanta-bundle": "^2.11",
         "doctrine/mongodb-odm-bundle": "^4.5",
         "gedmo/doctrine-extensions": "^3.10",

diff --git a/composer.lock b/composer.lock
diff --git a/config/bundles.php b/config/bundles.php
@@ -30,4 +30,5 @@
     Symfony\Bundle\SecurityBundle\SecurityBundle::class => ['all' => true],
     Pumukit\PaellaPlayerBundle\PumukitPaellaPlayerBundle::class => ['all' => true],
     Symfony\Bundle\SwiftmailerBundle\SwiftmailerBundle::class => ['all' => true],
+    ApiPlatform\Core\Bridge\Symfony\Bundle\ApiPlatformBundle::class => ['all' => true],
 ];
diff --git a/config/packages/api_platform.yaml b/config/packages/api_platform.yaml
@@ -0,0 +1,73 @@
+api_platform:
+    title: 'PuMuKIT API'
+    description: 'Powerful API'
+    version: '0.0.0'
+    show_webby: false
+    mapping:
+      paths: [
+        '%kernel.project_dir%/src/Pumukit/SchemaBundle/Document',
+        '%kernel.project_dir%/src/Pumukit/EncoderBundle/Document'
+      ]
+    patch_formats:
+        json: ['application/merge-patch+json']
+    swagger:
+        versions: [3]
+    doctrine:
+      enabled: false
+    doctrine_mongodb_odm:
+      enabled: true
+  # Enable ReDoc.
+    enable_re_doc: true
+
+  # Enable the entrypoint.
+    enable_entrypoint: true
+
+  # Enable the docs.
+    enable_docs: true
+
+  # Enable the data collector and the WebProfilerBundle integration.
+    enable_profiler: true
+    collection:
+      # The name of the query parameter to filter nullable results (with the ExistsFilter).
+      exists_parameter_name: 'exists'
+
+      # The default order of results.
+      order: 'ASC'
+
+      # The name of the query parameter to order results (with the OrderFilter).
+      order_parameter_name: 'order'
+
+      pagination:
+        # To enable or disable pagination for all resource collections by default.
+        enabled: true
+
+        # To allow partial pagination for all resource collections.
+        # This improves performances by skipping the `COUNT` query.
+        partial: false
+
+        # To allow the client to enable or disable the pagination.
+        client_enabled: false
+
+        # To allow the client to set the number of items per page.
+        client_items_per_page: false
+
+        # To allow the client to enable or disable the partial pagination.
+        client_partial: false
+
+        # The default number of items per page.
+        items_per_page: 25
+
+        # The maximum number of items per page.
+        maximum_items_per_page: 50
+
+        # The default name of the parameter handling the page number.
+        page_parameter_name: 'page'
+
+        # The name of the query parameter to enable or disable pagination.
+        enabled_parameter_name: 'pagination'
+
+        # The name of the query parameter to set the number of items per page.
+        items_per_page_parameter_name: 'itemsPerPage'
+
+        # The name of the query parameter to enable or disable the partial pagination.
+        partial_parameter_name: 'partial'
diff --git a/config/routes/api_platform.yaml b/config/routes/api_platform.yaml
@@ -0,0 +1,4 @@
+api_platform:
+    resource: .
+    type: api_platform
+    prefix: /api
diff --git a/src/Pumukit/EncoderBundle/Document/CpuStatus.php b/src/Pumukit/EncoderBundle/Document/CpuStatus.php
@@ -4,12 +4,18 @@
 
 namespace Pumukit\EncoderBundle\Document;
 
+use ApiPlatform\Core\Annotation\ApiResource;
 use Doctrine\ODM\MongoDB\Mapping\Annotations as MongoDB;
 
 /**
  * Pumukit\EncoderBundle\Document\CpuStatus.
  *
  * @MongoDB\Document(repositoryClass="Pumukit\EncoderBundle\Repository\CpuStatusRepository")
+ *
+ * @ApiResource(
+ *           collectionOperations={"get"={"method"="GET", "access_control"="is_granted('ROLE_ACCESS_API')"}},
+ *           itemOperations={"get"={"method"="GET", "access_control"="is_granted('ROLE_ACCESS_API')"}}
+ *       )
  */
 class CpuStatus
 {

diff --git a/src/Pumukit/EncoderBundle/Document/Job.php b/src/Pumukit/EncoderBundle/Document/Job.php
@@ -4,13 +4,19 @@
 
 namespace Pumukit\EncoderBundle\Document;
 
+use ApiPlatform\Core\Annotation\ApiResource;
 use Doctrine\ODM\MongoDB\Mapping\Annotations as MongoDB;
 use Symfony\Component\Validator\Constraints as Assert;
 
 /**
  * Pumukit\EncoderBundle\Document\Job.
  *
  * @MongoDB\Document(repositoryClass="Pumukit\EncoderBundle\Repository\JobRepository")
+ *
+ * @ApiResource(
+ *          collectionOperations={"get"={"method"="GET", "access_control"="is_granted('ROLE_ACCESS_API')"}},
+ *          itemOperations={"get"={"method"="GET", "access_control"="is_granted('ROLE_ACCESS_API')"}}
+ *      )
  */
 class Job
 {

diff --git a/src/Pumukit/NewAdminBundle/Services/TagCatalogueService.php b/src/Pumukit/NewAdminBundle/Services/TagCatalogueService.php
@@ -187,8 +187,7 @@ public function addSessionCriteria(Request $request, SessionInterface $session)
         if (count($tag) > 0) {
             if ('all' === $tag[0]) {
                 array_shift($tag);
-            }
-            if (!empty($tag)) {
+            } else {
                 $newCriteria['tags.cod'] = ['$all' => $tag];
             }
         }

diff --git a/src/Pumukit/SchemaBundle/Document/Annotation.php b/src/Pumukit/SchemaBundle/Document/Annotation.php
@@ -4,10 +4,16 @@
 
 namespace Pumukit\SchemaBundle\Document;
 
+use ApiPlatform\Core\Annotation\ApiResource;
 use Doctrine\ODM\MongoDB\Mapping\Annotations as MongoDB;
 
 /**
  * @MongoDB\Document(repositoryClass="Pumukit\SchemaBundle\Repository\AnnotationRepository")
+ *
+ * @ApiResource(
+ *        collectionOperations={"get"={"method"="GET", "access_control"="is_granted('ROLE_ACCESS_API')"}},
+ *        itemOperations={"get"={"method"="GET", "access_control"="is_granted('ROLE_ACCESS_API')"}}
+ *    )
  */
 class Annotation
 {

diff --git a/src/Pumukit/SchemaBundle/Document/Group.php b/src/Pumukit/SchemaBundle/Document/Group.php
@@ -4,11 +4,17 @@
 
 namespace Pumukit\SchemaBundle\Document;
 
+use ApiPlatform\Core\Annotation\ApiResource;
 use Doctrine\ODM\MongoDB\Mapping\Annotations as MongoDB;
 use Symfony\Component\Validator\Constraints as Assert;
 
 /**
  * @MongoDB\Document(repositoryClass="Pumukit\SchemaBundle\Repository\GroupRepository")
+ *
+ * @ApiResource(
+ *         collectionOperations={"get"={"method"="GET", "access_control"="is_granted('ROLE_ACCESS_API')"}},
+ *         itemOperations={"get"={"method"="GET", "access_control"="is_granted('ROLE_ACCESS_API')"}}
+ *     )
  */
 class Group implements GroupInterface
 {

diff --git a/src/Pumukit/SchemaBundle/Document/MultimediaObject.php b/src/Pumukit/SchemaBundle/Document/MultimediaObject.php
@@ -4,6 +4,7 @@
 
 namespace Pumukit\SchemaBundle\Document;
 
+use ApiPlatform\Core\Annotation\ApiResource;
 use Doctrine\Common\Collections\ArrayCollection;
 use Doctrine\ODM\MongoDB\Mapping\Annotations as MongoDB;
 use Gedmo\Mapping\Annotation as Gedmo;
@@ -13,6 +14,11 @@
  * @MongoDB\Document(repositoryClass="Pumukit\SchemaBundle\Repository\MultimediaObjectRepository")
  *
  * @MongoDB\Index(name="text_index", keys={"textindex.text"="text", "secondarytextindex.text"="text"}, options={"language_override"="indexlanguage", "default_language"="none", "weights"={"textindex.text"=10, "secondarytextindex.text"=1}})
+ *
+ * @ApiResource(
+ *       collectionOperations={"get"={"method"="GET", "access_control"="is_granted('ROLE_ACCESS_API')"}},
+ *       itemOperations={"get"={"method"="GET", "access_control"="is_granted('ROLE_ACCESS_API')"}}
+ *   )
  */
 class MultimediaObject
 {

diff --git a/src/Pumukit/SchemaBundle/Document/PermissionProfile.php b/src/Pumukit/SchemaBundle/Document/PermissionProfile.php
@@ -4,11 +4,17 @@
 
 namespace Pumukit\SchemaBundle\Document;
 
+use ApiPlatform\Core\Annotation\ApiResource;
 use Doctrine\ODM\MongoDB\Mapping\Annotations as MongoDB;
 use Gedmo\Mapping\Annotation as Gedmo;
 
 /**
  * @MongoDB\Document(repositoryClass="Pumukit\SchemaBundle\Repository\PermissionProfileRepository")
+ *
+ * @ApiResource(
+ *       collectionOperations={"get"={"method"="GET", "access_control"="is_granted('ROLE_ACCESS_API')"}},
+ *       itemOperations={"get"={"method"="GET", "access_control"="is_granted('ROLE_ACCESS_API')"}}
+ *   )
  */
 class PermissionProfile
 {

diff --git a/src/Pumukit/SchemaBundle/Document/Person.php b/src/Pumukit/SchemaBundle/Document/Person.php
@@ -4,11 +4,17 @@
 
 namespace Pumukit\SchemaBundle\Document;
 
+use ApiPlatform\Core\Annotation\ApiResource;
 use Doctrine\ODM\MongoDB\Mapping\Annotations as MongoDB;
 use Symfony\Component\Validator\Constraints as Assert;
 
 /**
  * @MongoDB\Document(repositoryClass="Pumukit\SchemaBundle\Repository\PersonRepository")
+ *
+ * @ApiResource(
+ *           collectionOperations={"get"={"method"="GET", "access_control"="is_granted('ROLE_ACCESS_API')"}},
+ *           itemOperations={"get"={"method"="GET", "access_control"="is_granted('ROLE_ACCESS_API')"}}
+ *       )
  */
 class Person implements PersonInterface
 {

diff --git a/src/Pumukit/SchemaBundle/Document/Role.php b/src/Pumukit/SchemaBundle/Document/Role.php
@@ -4,11 +4,17 @@
 
 namespace Pumukit\SchemaBundle\Document;
 
+use ApiPlatform\Core\Annotation\ApiResource;
 use Doctrine\ODM\MongoDB\Mapping\Annotations as MongoDB;
 use Gedmo\Mapping\Annotation as Gedmo;
 
 /**
  * @MongoDB\Document(repositoryClass="Pumukit\SchemaBundle\Repository\RoleRepository")
+ *
+ * @ApiResource(
+ *            collectionOperations={"get"={"method"="GET", "access_control"="is_granted('ROLE_ACCESS_API')"}},
+ *            itemOperations={"get"={"method"="GET", "access_control"="is_granted('ROLE_ACCESS_API')"}}
+ *        )
  */
 class Role implements RoleInterface
 {

diff --git a/src/Pumukit/SchemaBundle/Document/Series.php b/src/Pumukit/SchemaBundle/Document/Series.php
@@ -4,13 +4,19 @@
 
 namespace Pumukit\SchemaBundle\Document;
 
+use ApiPlatform\Core\Annotation\ApiResource;
 use Doctrine\ODM\MongoDB\Mapping\Annotations as MongoDB;
 use JMS\Serializer\Annotation as Serializer;
 
 /**
  * @MongoDB\Document(repositoryClass="Pumukit\SchemaBundle\Repository\SeriesRepository")
  *
  * @MongoDB\Index(name="text_index", keys={"textindex.text"="text", "secondarytextindex.text"="text"}, options={"language_override"="indexlanguage", "default_language"="none", "weights"={"textindex.text"=10, "secondarytextindex.text"=1}})
+ *
+ * @ApiResource(
+ *       collectionOperations={"get"={"method"="GET", "access_control"="is_granted('ROLE_ACCESS_API')"}},
+ *       itemOperations={"get"={"method"="GET", "access_control"="is_granted('ROLE_ACCESS_API')"}}
+ *   )
  */
 class Series
 {

diff --git a/src/Pumukit/SchemaBundle/Document/Tag.php b/src/Pumukit/SchemaBundle/Document/Tag.php
@@ -4,6 +4,7 @@
 
 namespace Pumukit\SchemaBundle\Document;
 
+use ApiPlatform\Core\Annotation\ApiResource;
 use Doctrine\ODM\MongoDB\Mapping\Annotations as MongoDB;
 use Gedmo\Mapping\Annotation as Gedmo;
 use Symfony\Component\Validator\Constraints as Assert;
@@ -12,6 +13,11 @@
  * @MongoDB\Document(repositoryClass="Gedmo\Tree\Document\MongoDB\Repository\MaterializedPathRepository")
  *
  * @Gedmo\Tree(type="materializedPath", activateLocking=false)
+ *
+ * @ApiResource(
+ *      collectionOperations={"get"={"method"="GET", "access_control"="is_granted('ROLE_ACCESS_API')"}},
+ *      itemOperations={"get"={"method"="GET", "access_control"="is_granted('ROLE_ACCESS_API')"}}
+ *  )
  */
 class Tag implements TagInterface
 {

diff --git a/src/Pumukit/SchemaBundle/Document/User.php b/src/Pumukit/SchemaBundle/Document/User.php
@@ -4,13 +4,20 @@
 
 namespace Pumukit\SchemaBundle\Document;
 
+use ApiPlatform\Core\Annotation\ApiResource;
 use Doctrine\Common\Collections\ArrayCollection;
 use Doctrine\ODM\MongoDB\Mapping\Annotations as MongoDB;
 use MongoDB\BSON\ObjectId;
 use Symfony\Component\Security\Core\User\UserInterface;
+use Symfony\Component\Serializer\Annotation\Ignore;
 
 /**
  * @MongoDB\Document(repositoryClass="Pumukit\SchemaBundle\Repository\UserRepository")
+ *
+ * @ApiResource(
+ *     collectionOperations={"get"={"method"="GET", "access_control"="is_granted('ROLE_ACCESS_API')"}},
+ *     itemOperations={"get"={"method"="GET", "access_control"="is_granted('ROLE_ACCESS_API')"}}
+ * )
  */
 class User implements UserInterface
 {
@@ -65,11 +72,13 @@ class User implements UserInterface
     /**
      * @MongoDB\Field(type="string")
      */
+    #[Ignore]
     protected $salt;
 
     /**
      * @MongoDB\Field(type="string")
      */
+    #[Ignore]
     protected $password;
 
     /**
@@ -80,6 +89,7 @@ class User implements UserInterface
     /**
      * @MongoDB\Field(type="string")
      */
+    #[Ignore]
     protected $plainPassword;
 
     /**
@@ -90,11 +100,13 @@ class User implements UserInterface
     /**
      * @MongoDB\Field(type="string")
      */
+    #[Ignore]
     protected $confirmationToken;
 
     /**
      * @MongoDB\Field(type="date")
      */
+    #[Ignore]
     protected $passwordRequestedAt;
 
     /**

diff --git a/symfony.lock b/symfony.lock
@@ -1,4 +1,18 @@
 {
+    "api-platform/core": {
+        "version": "2.7",
+        "recipe": {
+            "repo": "github.com/symfony/recipes",
+            "branch": "main",
+            "version": "2.5",
+            "ref": "b86557ce5677fa855b1b2608f4a4bc4a8fed8be7"
+        },
+        "files": [
+            "config/packages/api_platform.yaml",
+            "config/routes/api_platform.yaml",
+            "src/Entity/.gitignore"
+        ]
+    },
     "babdev/pagerfanta-bundle": {
         "version": "v2.11.0"
     },