Merge pull request #224 from os2display/feature/2829-add-feedsource-p…

…ost-put-delete-functionality2 2829: Adjustment
os2display · Nov 20, 2024 · 7346b55 · 7346b55
2 parents 936bb02 + ab60308
commit 7346b55
Show file tree

Hide file tree

Showing 7 changed files with 25 additions and 81 deletions.
diff --git a/public/api-spec-v2.json b/public/api-spec-v2.json
@@ -8144,12 +8144,6 @@
                     "feedType": {
                         "type": "string"
                     },
-                    "secrets": {
-                        "type": "array",
-                        "items": {
-                            "type": "string"
-                        }
-                    },
                     "feeds": {
                         "type": "array",
                         "items": {
@@ -8207,12 +8201,6 @@
                     "feedType": {
                         "type": "string"
                     },
-                    "secrets": {
-                        "type": "array",
-                        "items": {
-                            "type": "string"
-                        }
-                    },
                     "feeds": {
                         "type": "array",
                         "items": {
@@ -8305,12 +8293,6 @@
                     "feedType": {
                         "type": "string"
                     },
-                    "secrets": {
-                        "type": "array",
-                        "items": {
-                            "type": "string"
-                        }
-                    },
                     "feeds": {
                         "type": "array",
                         "items": {
@@ -8481,12 +8463,6 @@
                     "feedType": {
                         "type": "string"
                     },
-                    "secrets": {
-                        "type": "array",
-                        "items": {
-                            "type": "string"
-                        }
-                    },
                     "feeds": {
                         "type": "array",
                         "items": {

diff --git a/public/api-spec-v2.yaml b/public/api-spec-v2.yaml
@@ -5766,10 +5766,6 @@ components:
           type: string
         feedType:
           type: string
-        secrets:
-          type: array
-          items:
-            type: string
         feeds:
           type: array
           items:
@@ -5810,10 +5806,6 @@ components:
           type: string
         feedType:
           type: string
-        secrets:
-          type: array
-          items:
-            type: string
         feeds:
           type: array
           items:
@@ -5877,10 +5869,6 @@ components:
           type: string
         feedType:
           type: string
-        secrets:
-          type: array
-          items:
-            type: string
         feeds:
           type: array
           items:
@@ -5997,10 +5985,6 @@ components:
           type: string
         feedType:
           type: string
-        secrets:
-          type: array
-          items:
-            type: string
         feeds:
           type: array
           items:

diff --git a/src/Dto/FeedSource.php b/src/Dto/FeedSource.php
@@ -18,7 +18,6 @@ class FeedSource
     public string $description = '';
     public string $outputType = '';
     public string $feedType = '';
-    public array $secrets = [];
     public array $feeds = [];
     public array $admin = [];
     public string $supportedFeedOutputType = '';

diff --git a/src/Entity/Tenant/FeedSource.php b/src/Entity/Tenant/FeedSource.php
@@ -111,7 +111,7 @@ public function setSupportedFeedOutputType(string $supportedFeedOutputType): sel
      *
      * @return array The JSON schema definition
      */
-    public function getSchema(): array
+    public static function getSchema(): array
     {
         return [
             '$schema' => 'https://json-schema.org/draft/2020-12/schema',

diff --git a/src/Feed/EventDatabaseApiFeedType.php b/src/Feed/EventDatabaseApiFeedType.php
@@ -316,8 +316,7 @@ public function getSchema(): array
             'properties' => [
                 'host' => [
                     'type' => 'string',
-                    'format' => 'url',
-                    'pattern' => 'https?:\\/\\/(www\\.)?[-a-zA-Z0-9@:%._\\+~#=]{2,256}\\.[a-zA-Z0-9()]{2,6}\\b([-a-zA-Z0-9()@:%_\\+~#?&//=]*)',
+                    'format' => 'uri',
                 ],
             ],
             'required' => ['host'],

diff --git a/src/State/FeedSourceProcessor.php b/src/State/FeedSourceProcessor.php
@@ -9,7 +9,6 @@
 use ApiPlatform\Metadata\Operation;
 use ApiPlatform\Metadata\Put;
 use ApiPlatform\State\ProcessorInterface;
-use App\Dto\FeedSourceInput;
 use App\Entity\Interfaces\TenantScopedUserInterface;
 use App\Entity\Tenant\FeedSource;
 use App\Exceptions\UnknownFeedTypeException;
@@ -50,7 +49,6 @@ public function process($data, Operation $operation, array $uriVariables = [], a
 
     /**
      * @throws UnknownFeedTypeException
-     * @throws \JsonException
      */
     protected function fromInput(mixed $object, Operation $operation, array $uriVariables, array $context): FeedSource
     {
@@ -61,6 +59,10 @@ protected function fromInput(mixed $object, Operation $operation, array $uriVari
             throw new InvalidArgumentException('object must by of type FeedSource');
         }
 
+        // Validate feed source
+        $this->validateFeedSource($object, $operation);
+
+        // Update properties.
         $this->updateFeedSourceProperties($feedSource, $object);
 
         // Set tenant
@@ -70,48 +72,35 @@ protected function fromInput(mixed $object, Operation $operation, array $uriVari
         }
         $feedSource->setTenant($user->getActiveTenant());
 
-        // Validate feed source
-        $this->validateFeedSource($object, $operation);
-
         return $feedSource;
     }
 
-    protected function updateFeedSourceProperties(FeedSource $feedSource, FeedSourceInput $object): void
+    /**
+     * @throws UnknownFeedTypeException
+     */
+    protected function updateFeedSourceProperties(FeedSource $feedSource, object $object): void
     {
-        if (!empty($object->title)) {
-            $feedSource->setTitle($object->title);
-        }
-        if (!empty($object->description)) {
-            $feedSource->setDescription($object->description);
-        }
-        if (!empty($object->createdBy)) {
-            $feedSource->setCreatedBy($object->createdBy);
-        }
-        if (!empty($object->modifiedBy)) {
-            $feedSource->setModifiedBy($object->modifiedBy);
-        }
+        $feedSource->setTitle($object->title);
+        $feedSource->setDescription($object->description);
+
         if (!empty($object->secrets)) {
             $feedSource->setSecrets($object->secrets);
         }
-        if (!empty($object->feedType)) {
-            $feedSource->setFeedType($object->feedType);
-        }
-        $supportedFeedOutputType = $feedSource->getSupportedFeedOutputType();
-        if (null !== $supportedFeedOutputType) {
-            $feedSource->setSupportedFeedOutputType($supportedFeedOutputType);
-        }
+
+        $feedSource->setFeedType($object->feedType);
+        $feedType = $this->feedService->getFeedType($object->feedType);
+        $feedSource->setSupportedFeedOutputType($feedType->getSupportedFeedOutputType());
     }
 
     /**
-     * @throws \JsonException
      * @throws UnknownFeedTypeException
      */
     private function validateFeedSource(object $object, Operation $operation): void
     {
         $validator = $this->prepareValidator();
 
         // Prepare base feed source validation schema
-        $feedSourceValidationSchema = (new FeedSource())->getSchema();
+        $feedSourceValidationSchema = FeedSource::getSchema();
 
         // Validate base feed source
         $this->executeValidation($object, $validator, $feedSourceValidationSchema);
@@ -135,18 +124,15 @@ private function validateFeedSource(object $object, Operation $operation): void
     private function prepareValidator(): Validator
     {
         $schemaStorage = new SchemaStorage();
-        $feedSourceValidationSchema = (object) (new FeedSource())->getSchema();
+        $feedSourceValidationSchema = (object) FeedSource::getSchema();
         $schemaStorage->addSchema('file://contentSchema', $feedSourceValidationSchema);
 
         return new Validator(new Factory($schemaStorage));
     }
 
-    /**
-     * @throws \JsonException
-     */
     private function executeValidation(mixed $object, Validator $validator, ?array $schema = null): void
     {
-        $validator->validate($object, $schema ?? (new FeedSource())->getSchema());
+        $validator->validate($object, $schema ?? FeedSource::getSchema());
         if (!$validator->isValid()) {
             throw new InvalidArgumentException($this->getErrorMessage($validator));
         }

diff --git a/tests/Api/FeedSourceTest.php b/tests/Api/FeedSourceTest.php
@@ -60,7 +60,7 @@ public function testCreateFeedSource(): void
             'json' => [
                 'title' => 'Test feed source',
                 'description' => 'This is a test feed source',
-                'feedType' => 'App\Feed\EventDatabaseApiFeedType',
+                'feedType' => \App\Feed\EventDatabaseApiFeedType::class,
                 'secrets' => [
                     'host' => 'https://www.test.dk',
                 ],
@@ -77,7 +77,7 @@ public function testCreateFeedSource(): void
             '@type' => 'FeedSource',
             'title' => 'Test feed source',
             'description' => 'This is a test feed source',
-            'feedType' => 'App\Feed\EventDatabaseApiFeedType',
+            'feedType' => \App\Feed\EventDatabaseApiFeedType::class,
             'secrets' => [
                 'host' => 'https://www.test.dk',
             ],
@@ -146,7 +146,7 @@ public function testCreateFeedSourceWithEventDatabaseFeedTypeWithoutRequiredSecr
             'json' => [
                 'title' => 'Test feed source',
                 'outputType' => 'This is a test output type',
-                'feedType' => 'App\\Feed\\EventDatabaseApiFeedType',
+                'feedType' => \App\Feed\EventDatabaseApiFeedType::class,
                 'secrets' => [
                     'test secret',
                 ],
@@ -171,7 +171,7 @@ public function testUpdateFeedSource(): void
                 'title' => 'Updated title',
                 'description' => 'Updated description',
                 'outputType' => 'This is a test output type',
-                'feedType' => 'App\Feed\EventDatabaseApiFeedType',
+                'feedType' => \App\Feed\EventDatabaseApiFeedType::class,
                 'secrets' => [
                 ],
             ],
@@ -198,7 +198,7 @@ public function testDeleteFeedSource(): void
                 'title' => 'Test feed source',
                 'description' => 'This is a test feed source',
                 'outputType' => 'This is a test output type',
-                'feedType' => 'App\Feed\EventDatabaseApiFeedType',
+                'feedType' => \App\Feed\EventDatabaseApiFeedType::class,
                 'secrets' => [
                     'host' => 'https://www.test.dk',
                 ],