IBX-4123: [Backport] Added /languages and /languages/{code} endpo…

…ints
ezsystems · Dec 5, 2023 · d289068 · d289068
1 parent eacb8b8
commit d289068
Show file tree

Hide file tree

Showing 18 changed files with 456 additions and 6 deletions.
diff --git a/composer.json b/composer.json
@@ -54,7 +54,8 @@
         "phpstan/phpstan": "^1.10",
         "phpstan/phpstan-symfony": "^1.3",
         "phpstan/phpstan-phpunit": "^1.3",
-        "phpstan/phpstan-webmozart-assert": "^1.2"
+        "phpstan/phpstan-webmozart-assert": "^1.2",
+        "justinrainbow/json-schema": "^5.2"
     },
     "config": {
         "allow-plugins": {

diff --git a/phpstan-baseline.neon b/phpstan-baseline.neon
@@ -437,7 +437,7 @@ parameters:
 
 		-
 			message: "#^Cannot access offset mixed on EzSystems\\\\EzPlatformRest\\\\Input\\\\Parser\\.$#"
-			count: 2
+			count: 1
 			path: src/lib/Input/ParsingDispatcher.php
 
 		-

diff --git a/phpunit-integration-rest.xml b/phpunit-integration-rest.xml
@@ -11,6 +11,7 @@
   <php>
     <env name="EZP_TEST_REST_HOST" value="localhost"/>
     <env name="EZP_TEST_REST_AUTH" value="admin:publish"/>
+    <env name="IBEXA_REST_GENERATE_SNAPSHOTS" value="0"/>
   </php>
   <testsuites>
     <testsuite name="eZ Publish REST Functional Tests">

diff --git a/src/bundle/Resources/config/routing.yml b/src/bundle/Resources/config/routing.yml
@@ -383,6 +383,17 @@ ezpublish_rest_setObjectStatesForContent:
         contentId: \d+
 
 
+# Languages
+ibexa.rest.languages.list:
+    path: /languages
+    methods: [GET]
+    controller: Ibexa\Rest\Server\Controller\Language::listLanguages
+
+ibexa.rest.languages.view:
+    path: /languages/{languageCode}
+    methods: [GET]
+    controller: Ibexa\Rest\Server\Controller\Language::loadLanguage
+
 # Locations
 
 
@@ -583,7 +594,7 @@ ezpublish_rest_loadContentTypeFieldDefinition:
     requirements:
         contentTypeId: \d+
         fieldDefinitionId: \d+
-        
+
 ibexa.rest.load_content_type_field_definition_by_identifier:
     path: /content/types/{contentTypeId}/fieldDefinition/{fieldDefinitionIdentifier}
     controller: ezpublish_rest.controller.content_type:loadContentTypeFieldDefinitionByIdentifier

diff --git a/src/bundle/Resources/config/services.yml b/src/bundle/Resources/config/services.yml
@@ -177,6 +177,10 @@ services:
             - "@ezpublish.api.service.location"
         tags: [controller.service_arguments]
 
+    Ibexa\Rest\Server\Controller\Language:
+        autowire: true
+        tags: [ controller.service_arguments ]
+
     ezpublish_rest.controller.location:
         class: "%ezpublish_rest.controller.location.class%"
         parent: ezpublish_rest.controller.base

diff --git a/src/bundle/Resources/config/value_object_visitors.yml b/src/bundle/Resources/config/value_object_visitors.yml
@@ -206,6 +206,11 @@ services:
             - { name: ezpublish_rest.output.value_object_visitor, type: Symfony\Component\HttpKernel\Exception\HttpException }
 
     # Language
+    Ibexa\Rest\Server\Output\ValueObjectVisitor\LanguageList:
+        parent: ezpublish_rest.output.value_object_visitor.base
+        tags:
+            - { name: ezpublish_rest.output.value_object_visitor, type: Ibexa\Rest\Server\Values\LanguageList }
+
     ezpublish_rest.output.value_object_visitor.Language:
         parent: ezpublish_rest.output.value_object_visitor.base
         class: EzSystems\EzPlatformRest\Server\Output\ValueObjectVisitor\Language

diff --git a/src/lib/Server/Controller/Language.php b/src/lib/Server/Controller/Language.php
@@ -0,0 +1,42 @@
+<?php
+
+/**
+ * @copyright Copyright (C) eZ Systems AS. All rights reserved.
+ * @license For full copyright and license information view LICENSE file distributed with this source code.
+ */
+declare(strict_types=1);
+
+namespace Ibexa\Rest\Server\Controller;
+
+use eZ\Publish\API\Repository\LanguageService;
+use eZ\Publish\API\Repository\Values\Content\Language as ApiLanguage;
+use EzSystems\EzPlatformRest\Server\Controller as RestController;
+use Ibexa\Rest\Server\Values\LanguageList;
+use Traversable;
+
+final class Language extends RestController
+{
+    /** @var \eZ\Publish\API\Repository\LanguageService */
+    private $languageService;
+
+    public function __construct(LanguageService $languageService)
+    {
+        $this->languageService = $languageService;
+    }
+
+    public function listLanguages(): LanguageList
+    {
+        $languages = $this->languageService->loadLanguages();
+
+        if ($languages instanceof Traversable) {
+            $languages = iterator_to_array($languages);
+        }
+
+        return new LanguageList($languages);
+    }
+
+    public function loadLanguage(string $languageCode): ApiLanguage
+    {
+        return $this->languageService->loadLanguage($languageCode);
+    }
+}
diff --git a/src/lib/Server/Output/ValueObjectVisitor/Language.php b/src/lib/Server/Output/ValueObjectVisitor/Language.php
@@ -28,8 +28,15 @@ public function visit(Visitor $visitor, Generator $generator, $data): void
 
     private function visitLanguageAttributes(Visitor $visitor, Generator $generator, LanguageValue $language): void
     {
-        $generator->valueElement('languageId', $language->id);
-        $generator->valueElement('languageCode', $language->languageCode);
-        $generator->valueElement('name', $language->name);
+        $generator->attribute(
+            'href',
+            $this->router->generate(
+                'ibexa.rest.languages.view',
+                ['languageCode' => $language->getLanguageCode()],
+            ),
+        );
+        $generator->valueElement('languageId', $language->getId());
+        $generator->valueElement('languageCode', $language->getLanguageCode());
+        $generator->valueElement('name', $language->getName());
     }
 }
diff --git a/src/lib/Server/Output/ValueObjectVisitor/LanguageList.php b/src/lib/Server/Output/ValueObjectVisitor/LanguageList.php
@@ -0,0 +1,35 @@
+<?php
+
+/**
+ * @copyright Copyright (C) eZ Systems AS. All rights reserved.
+ * @license For full copyright and license information view LICENSE file distributed with this source code.
+ */
+declare(strict_types=1);
+
+namespace Ibexa\Rest\Server\Output\ValueObjectVisitor;
+
+use EzSystems\EzPlatformRest\Output\Generator;
+use EzSystems\EzPlatformRest\Output\ValueObjectVisitor;
+use EzSystems\EzPlatformRest\Output\Visitor;
+
+final class LanguageList extends ValueObjectVisitor
+{
+    /**
+     * @param \Ibexa\Rest\Server\Values\LanguageList $data
+     */
+    public function visit(Visitor $visitor, Generator $generator, $data): void
+    {
+        $generator->startObjectElement('LanguageList');
+        $visitor->setHeader('Content-Type', $generator->getMediaType('LanguageList'));
+
+        $generator->attribute('href', $this->router->generate('ibexa.rest.languages.list'));
+
+        $generator->startList('Language');
+        foreach ($data->languages as $language) {
+            $visitor->visitValueObject($language);
+        }
+        $generator->endList('Language');
+
+        $generator->endObjectElement('LanguageList');
+    }
+}
diff --git a/src/lib/Server/Values/LanguageList.php b/src/lib/Server/Values/LanguageList.php
@@ -0,0 +1,25 @@
+<?php
+
+/**
+ * @copyright Copyright (C) eZ Systems AS. All rights reserved.
+ * @license For full copyright and license information view LICENSE file distributed with this source code.
+ */
+declare(strict_types=1);
+
+namespace Ibexa\Rest\Server\Values;
+
+use EzSystems\EzPlatformRest\Value as RestValue;
+
+final class LanguageList extends RestValue
+{
+    /** @var \eZ\Publish\API\Repository\Values\Content\Language[] */
+    public $languages;
+
+    /**
+     * @param array<\eZ\Publish\API\Repository\Values\Content\Language> $languages
+     */
+    public function __construct(array $languages)
+    {
+        $this->languages = $languages;
+    }
+}
diff --git a/tests/bundle/Functional/JsonSchema/Language.json b/tests/bundle/Functional/JsonSchema/Language.json
@@ -0,0 +1,38 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "type": "object",
+  "properties": {
+    "Language": {
+      "type": "object",
+      "properties": {
+        "_media-type": {
+          "type": "string"
+        },
+        "_href": {
+          "type": "string"
+        },
+        "languageId": {
+          "type": "integer"
+        },
+        "languageCode": {
+          "type": "string",
+          "minLength": 1,
+          "pattern": "^[[:alnum:]_]+"
+        },
+        "name": {
+          "type": "string"
+        }
+      },
+      "required": [
+        "_media-type",
+        "_href",
+        "languageId",
+        "languageCode",
+        "name"
+      ]
+    }
+  },
+  "required": [
+    "Language"
+  ]
+}
diff --git a/tests/bundle/Functional/JsonSchema/LanguageList.json b/tests/bundle/Functional/JsonSchema/LanguageList.json
@@ -0,0 +1,56 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "type": "object",
+  "properties": {
+    "LanguageList": {
+      "type": "object",
+      "properties": {
+        "_media-type": {
+          "type": "string"
+        },
+        "_href": {
+          "type": "string"
+        },
+        "Language": {
+          "type":"array",
+          "items": {
+            "properties": {
+              "_media-type": {
+                "type": "string"
+              },
+              "_href": {
+                "type": "string"
+              },
+              "languageId": {
+                "type": "integer"
+              },
+              "languageCode": {
+                "type": "string",
+                "minLength": 1,
+                "pattern": "^[[:alnum:]_]+"
+              },
+              "name": {
+                "type": "string"
+              }
+            },
+            "required": [
+              "_media-type",
+              "_href",
+              "languageId",
+              "languageCode",
+              "name"
+            ]
+          }
+        }
+      },
+      "required": [
+        "_media-type",
+        "_href",
+        "Language"
+      ]
+    }
+  },
+  "required": [
+    "LanguageList"
+  ]
+}
diff --git a/tests/bundle/Functional/LanguageTest.php b/tests/bundle/Functional/LanguageTest.php
@@ -0,0 +1,64 @@
+<?php
+
+/**
+ * @copyright Copyright (C) eZ Systems AS. All rights reserved.
+ * @license For full copyright and license information view LICENSE file distributed with this source code.
+ */
+declare(strict_types=1);
+
+namespace EzSystems\EzPlatformRestBundle\Tests\Functional;
+
+use EzSystems\EzPlatformRestBundle\Tests\Functional\TestCase as RESTFunctionalTestCase;
+
+final class LanguageTest extends RESTFunctionalTestCase
+{
+    use ResourceAssertionsTrait;
+
+    private const SNAPSHOT_DIR = __DIR__ . '/_snapshot';
+
+    public function testLanguageListJson(): void
+    {
+        $request = $this->createHttpRequest('GET', '/api/ezp/v2/languages', '', 'LanguageList+json');
+        $response = $this->sendHttpRequest($request);
+
+        self::assertHttpResponseCodeEquals($response, 200);
+        $content = $response->getBody()->getContents();
+        self::assertJson($content);
+
+        self::assertJsonResponseIsValid($content, 'LanguageList');
+        self::assertResponseMatchesJsonSnapshot($content, self::SNAPSHOT_DIR . '/LanguageList.json');
+    }
+
+    public function testLanguageListXml(): void
+    {
+        $request = $this->createHttpRequest('GET', '/api/ezp/v2/languages');
+        $response = $this->sendHttpRequest($request);
+
+        self::assertHttpResponseCodeEquals($response, 200);
+        $content = $response->getBody()->getContents();
+        self::assertResponseMatchesXmlSnapshot($content, self::SNAPSHOT_DIR . '/LanguageList.xml');
+    }
+
+    public function testLanguageViewJson(): void
+    {
+        $request = $this->createHttpRequest('GET', '/api/ezp/v2/languages/eng-GB', '', 'LanguageList+json');
+        $response = $this->sendHttpRequest($request);
+
+        self::assertHttpResponseCodeEquals($response, 200);
+        $content = $response->getBody()->getContents();
+        self::assertJson($content);
+
+        self::assertJsonResponseIsValid($content, 'Language');
+        self::assertResponseMatchesJsonSnapshot($content, self::SNAPSHOT_DIR . '/Language.json');
+    }
+
+    public function testLanguageViewXml(): void
+    {
+        $request = $this->createHttpRequest('GET', '/api/ezp/v2/languages/eng-GB');
+        $response = $this->sendHttpRequest($request);
+
+        self::assertHttpResponseCodeEquals($response, 200);
+        $content = $response->getBody()->getContents();
+        self::assertResponseMatchesXmlSnapshot($content, self::SNAPSHOT_DIR . '/Language.xml');
+    }
+}