WIP Crowdin API Client

symfony · welcoMattic · Apr 26, 2020 · May 10, 2020 · Jun 29, 2020 · Jun 30, 2020
commit 5f866c5862c296a207a0bdb97abaa802813d354f
diff --git a/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php b/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php
@@ -141,7 +141,9 @@
 use Symfony\Component\Stopwatch\Stopwatch;
 use Symfony\Component\String\LazyString;
 use Symfony\Component\S
8000
tring\Slugger\SluggerInterface;
+use Symfony\Component\Translation\Bridge\Crowdin\CrowdinProviderFactory;
 use Symfony\Component\Translation\Bridge\Loco\LocoProviderFactory;
+use Symfony\Component\Translation\Bridge\Phrase\PhraseProviderFactory;
 use Symfony\Component\Translation\Command\XliffLintCommand as BaseXliffLintCommand;
 use Symfony\Component\Translation\PseudoLocalizationTranslator;
 use Symfony\Component\Translation\Translator;
@@ -1324,10 +1326,12 @@ private function registerTranslatorConfiguration(array $config, ContainerBuilder
                 ->replaceArgument(1, $config['enabled_locales'])
             ;
 
-            $container->getDefinition('TranslationProviders')->setArgument(0, $config['providers']);
+            $container->getDefinition('translation.providers')->setArgument(0, $config['providers']);
 
             $classToServices = [
                 LocoProviderFactory::class => 'translation.provider_factory.loco',
+                CrowdinProviderFactory::class => 'translation.provider_factory.crowdin',
+                PhraseProviderFactory::class => 'translation.provider_factory.phrase',
             ];
 
             foreach ($classToServices as $class => $service) {

diff --git a/src/Symfony/Bundle/FrameworkBundle/Resources/config/console.php b/src/Symfony/Bundle/FrameworkBundle/Resources/config/console.php
@@ -236,7 +236,7 @@
 
         ->set('console.command.translation_pull', TranslationPullCommand::class)
             ->args([
-                service('TranslationProviders'),
+                service('translation.providers'),
                 service('translation.writer'),
                 service('translation.reader'),
                 param('kernel.default_locale'),
@@ -248,7 +248,7 @@
 
         ->set('console.command.translation_push', TranslationPushCommand::class)
             ->args([
-                service('TranslationProviders'),
+                service('translation.providers'),
                 service('translation.reader'),
                 param('translator.default_path'),
                 [], // Translator paths

diff --git a/src/Symfony/Bundle/FrameworkBundle/Resources/config/translation_providers.php b/src/Symfony/Bundle/FrameworkBundle/Resources/config/translation_providers.php
@@ -12,6 +12,7 @@
 namespace Symfony\Component\DependencyInjection\Loader\Configurator;
 
 use Symfony\Component\Translation\Bridge\Crowdin\CrowdinProviderFactory;
+use Symfony\Component\Translation\Bridge\Phrase\PhraseProviderFactory;
 use Symfony\Component\Translation\Bridge\Loco\LocoProviderFactory;
 use Symfony\Component\Translation\Provider\AbstractProviderFactory;
 
@@ -39,5 +40,12 @@
             ])
             ->parent('translation.provider_factory.abstract')
             ->tag('translation.provider_factory')
+
+        ->set('translation.provider_factory.phrase', PhraseProviderFactory::class)
+            ->args([
+                service('translator.data_collector')->nullOnInvalid(),
+            ])
+            ->parent('translation.provider_factory.abstract')
+            ->tag('translation.provider_factory')
     ;
 };
diff --git a/src/Symfony/Component/Translation/Bridge/Crowdin/CrowdinProvider.php b/src/Symfony/Component/Translation/Bridge/Crowdin/CrowdinProvider.php
@@ -25,19 +25,22 @@
  * @experimental in 5.2
  *
  * In Crowdin:
+ * Source strings refers 
D7AF
to Symfony's translation keys
  */
 final class CrowdinProvider extends AbstractProvider
 {
-    protected const HOST = 'api.crowdin.com';
+    protected const HOST = 'crowdin.com/api/v2';
 
-    private $apiKey;
+    private $projectId;
+    private $token;
     private $loader;
     private $logger;
     private $defaultLocale;
 
-    public function __construct(string $apiKey, HttpClientInterface $client = null, LoaderInterface $loader = null, LoggerInterface $logger = null, string $defaultLocale = null)
+    public function __construct(string $projectId, string $token, HttpClientInterface $client = null, LoaderInterface $loader = null, LoggerInterface $logger = null, string $defaultLocale = null)
     {
-        $this->apiKey = $apiKey;
+        $this->projectId = $projectId;
+        $this->token = $token;
         $this->loader = $loader;
         $this->logger = $logger;
         $this->defaultLocale = $defaultLocale;
@@ -52,18 +55,30 @@ public function __toString(): string
 
     public function write(TranslatorBag $translations, bool $override = false): void
     {
-        // TODO: Implement write() method.
+        foreach ($translations->getCatalogues() as $catalogue) {
+            foreach ($catalogue->all() as $domain => $messages) {
+                $locale = $catalogue->getLocale();
+
+                // check if domain exists, if not, create it
+
+                foreach ($messages as $id => $message) {
+                    $this->addString($id);
+                    $this->addTranslation($id, $message, $locale);
+                }
+            }
+        }
     }
 
+    /**
+     * @see https://support.crowdin.com/api/v2/#operation/api.projects.translations.exports.post
+     */
     public function read(array $domains, array $locales): TranslatorBag
     {
         $filter = $domains ? implode(',', $domains) : '*';
         $translatorBag = new TranslatorBag();
 
         foreach ($locales as $locale) {
-            $response = $this->client->request('GET', sprintf('https://%s/api/export/locale/%s.xlf?filter=%s', $this->getEndpoint(), $locale, $filter), [
-                'headers' => $this->getDefaultHeaders(),
-            ]);
+            $fileId = $this->getFileId();
 
             $responseContent = $response->getContent(false);
 
@@ -83,4 +98,69 @@ public function delete(TranslatorBag $translations): void
     {
         // TODO: Implement delete() method.
     }
+
+    protected function getDefaultHeaders(): array
+    {
+        return [
+            'Authorization' => 'Bearer ' . $this->token,
+        ];
+    }
+
+    /**
+     * This function allows creation of a new translation key.
+     *
+     * @see https://support.crowdin.com/api/v2/#operation/api.projects.strings.post
+     */
+    private function addString(string $id): void
+    {
+        $response = $this->client->request('POST', sprintf('https://%s/projects/%s/strings', $this->getEndpoint(), $this->projectId), [
+            'headers' => $this->getDefaultHeaders(),
+            'body' => [
+                'text' => $id,
+                'identifier' => $id,
+            ],
+        ]);
+
+        if (Response::HTTP_CONFLICT === $response->getStatusCode()) {
+            $this->logger->warning(sprintf('Translation key (%s) already exists in Crowdin.', $id), [
+                'id' => $id,
+            ]);
+        } elseif (Response::HTTP_CREATED !== $response->getStatusCode()) {
+            throw new TransportException(sprintf('Unable to add new translation key (%s) to Crowdin: (status code: "%s") "%s".', $id, $response->getStatusCode(), $response->getContent(false)), $response);
+        }
+    }
+
+    /**
+     * This function allows translation of a message.
+     *
+     * @see https://support.crowdin.com/api/v2/#operation/api.projects.translations.post
+     */
+    private function addTranslation(string $id, string $message, string $locale): void
+    {
+        $response = $this->client->request('POST', sprintf('https://%s/projects/%s/translations', $this->getEndpoint(), $this->projectId), [
+            'headers' => $this->getDefaultHeaders(),
+            'body' => [
+                'stringId' => $id,
+                'languageId' => $locale,
+                'text' => $message,
+            ],
+        ]);
+
+        if (Response::HTTP_CREATED !== $response->getStatusCode()) {
+            throw new TransportException(sprintf('Unable to add new translation message "%s" (for key: "%s") to Crowdin: (status code: "%s") "%s".', $message, $id, $response->getStatusCode(), $response->getContent(false)), $response);
+        }
+    }
+
+    /**
+     * @todo: Not sure at all of this
+     */
+    private function getFileId(): int
+    {
+        $response = $this->client->request('GET', sprintf('https://%s/projects/%s/files', $this->getEndpoint(), $this->projectId), [
+            'headers' => $this->getDefaultHeaders(),
+        ]);
+        $files = json_decode($response->getContent());
+
+        return $files->data[0]->data->id;
+    }
 }
diff --git a/src/Symfony/Component/Translation/Bridge/Crowdin/CrowdinProviderFactory.php b/src/Symfony/Component/Translation/Bridge/Crowdin/CrowdinProviderFactory.php
@@ -24,7 +24,7 @@ final class CrowdinProviderFactory extends AbstractProviderFactory
     public function create(Dsn $dsn): ProviderInterface
     {
         if ('crowdin' === $dsn->getScheme()) {
-            return (new CrowdinProvider($this->getUser($dsn), $this->client, $this->loader, $this->logger, $this->defaultLocale))
+            return (new CrowdinProvider($this->getUser($dsn), $this->getPassword($dsn), $this->client, $this->loader, $this->logger, $this->defaultLocale))
                 ->setHost('default' === $dsn->getHost() ? null : $dsn->getHost())
                 ->setPort($dsn->getPort())
             ;

diff --git a/src/Symfony/Component/Translation/Bridge/Loco/LocoProvider.php b/src/Symfony/Component/Translation/Bridge/Loco/LocoProvider.php
@@ -27,11 +27,11 @@
  * In Loco:
  * tags refers to Symfony's translation domains
  * assets refers to Symfony's translation keys
- * translations refers to Symfony's translation messages
+ * translations refers to Symfony's translated messages
  */
 final class LocoProvider extends AbstractProvider
 {
-    protected const HOST = 'localise.biz';
+    protected const HOST = 'localise.biz/api';
 
     /** @var string */
     private $apiKey;
@@ -92,7 +92,7 @@ public function read(array $domains, array $locales): TranslatorBag
         $translatorBag = new TranslatorBag();
 
         foreach ($locales as $local
10000
e) {
-            $response = $this->client->request('GET', sprintf('https://%s/api/export/locale/%s.xlf?filter=%s', $this->getEndpoint(), $locale, $filter), [
+            $response = $this->client->request('GET', sprintf('https://%s/export/locale/%s.xlf?filter=%s', $this->getEndpoint(), $locale, $filter), [
                 'headers' => $this->getDefaultHeaders(),
             ]);
 
@@ -135,13 +135,16 @@ public function delete(TranslatorBag $translations): void
     protected function getDefaultHeaders(): array
     {
         return [
-            'Authorization' => 'Loco '.$this->apiKey,
+            'Authorization' => 'Loco ' . $this->apiKey,
         ];
     }
 
+    /**
+     * This function allows creation of a new translation key.
+     */
     private function createAsset(string $id): void
     {
-        $response = $this->client->request('POST', sprintf('https://%s/api/assets', $this->getEndpoint()), [
+        $response = $this->client->request('POST', sprintf('https://%s/assets', $this->getEndpoint()), [
             'headers' => $this->getDefaultHeaders(),
             'body' => [
                 'name' => $id,
@@ -162,13 +165,13 @@ private function createAsset(string $id): void
 
     private function translateAsset(string $id, string $message, string $locale): void
     {
-        $response = $this->client->request('POST', sprintf('https://%s/api/translations/%s/%s', $this->getEndpoint(), $id, $locale), [
+        $response = $this->client->request('POST', sprintf('https://%s/translations/%s/%s', $this->getEndpoint(), $id, $locale), [
             'headers' => $this->getDefaultHeaders(),
             'body' => $message,
         ]);
 
         if (Response::HTTP_OK !== $response->getStatusCode()) {
-            throw new TransportException(sprintf('Unable to add translation message (for key: "%s") to Loco: "%s".', $id, $response->getContent(false)), $response);
+            throw new TransportException(sprintf('Unable to add translation message "%s" (for key: "%s") to Loco: "%s".', $message, $id, $response->getContent(false)), $response);
         }
     }
 
@@ -180,7 +183,7 @@ private function tagsAssets(array $ids, string $tag): void
             $this->createTag($tag);
         }
 
-        $response = $this->client->request('POST', sprintf('https://%s/api/tags/%s.json', $this->getEndpoint(), $tag), [
+        $response = $this->client->request('POST', sprintf('https://%s/tags/%s.json', $this->getEndpoint(), $tag), [
             'headers' => $this->getDefaultHeaders(),
             'body' => $idsAsString,
         ]);
@@ -192,7 +195,7 @@ private function tagsAssets(array $ids, string $tag): void
 
     private function createTag(string $tag): void
     {
-        $response = $this->client->request('POST', sprintf('https://%s/api/tags.json', $this->getEndpoint()), [
+        $response = $this->client->request('POST', sprintf('https://%s/tags.json', $this->getEndpoint()), [
             'headers' => $this->getDefaultHeaders(),
             'body' => [
                 'name' => $tag,
@@ -206,7 +209,7 @@ private function createTag(string $tag): void
 
     private function getTags(): array
     {
-        $response = $this->client->request('GET', sprintf('https://%s/api/tags.json', $this->getEndpoint()), [
+        $response = $this->client->request('GET', sprintf('https://%s/tags.json', $this->getEndpoint()), [
             'headers' => $this->getDefaultHeaders(),
         ]);
 
@@ -221,7 +224,7 @@ private function getTags(): array
 
     private function deleteAsset(string $id): void
     {
-        $response = $this->client->request('DELETE', sprintf('https://%s/api/assets/%s.json', $this->getEndpoint(), $id), [
+        $response = $this->client->request('DELETE', sprintf('https://%s/assets/%s.json', $this->getEndpoint(), $id), [
             'headers' => $this->getDefaultHeaders(),
         ]);
 

diff --git a/src/Symfony/Component/Translation/Bridge/Phrase/PhraseProvider.php b/src/Symfony/Component/Translation/Bridge/Phrase/PhraseProvider.php
@@ -0,0 +1,67 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Translation\Bridge\Phrase;
+
+use Psr\Log\LoggerInterface;
+use Symfony\Component\HttpFoundation\Response;
+use Symfony\Component\Translation\Exception\TransportException;
+use Symfony\Component\Translation\Loader\LoaderInterface;
+use Symfony\Component\Translation\Provider\AbstractProvider;
+use Symfony\Component\Translation\TranslatorBag;
+use Symfony\Contracts\HttpClient\HttpClientInterface;
+
+/**
+ * @author Fabien Potencier <fabien@symfony.com>
+ *
+ * @experimental in 5.2
+ *
+ * In Phrase:
+ */
+final class PhraseProvider extends AbstractProvider
+{
+    protected const HOST = 'api.phrase.com/v2';
+
+    private $apiKey;
+    private $loader;
+    private $logger;
+    private $defaultLocale;
+
+    public function __construct(string $apiKey, HttpClientInterface $client = null, LoaderInterface $loader = null, LoggerInterface $logger = null, string $defaultLocale = null)
+    {
+        $this->apiKey = $apiKey;
+        $this->loader = $loader;
+        $this->logger = $logger;
+        $this->defaultLocale = $defaultLocale;
+
+        parent::__construct($client);
+    }
+
+    public function __toString(): string
+    {
+        return sprintf('phrase://%s', $this->getEndpoint());
+    }
+
+    public function write(TranslatorBag $translations, bool $override = false): void
+    {
+        // TODO: Implement write() method.
+    }
+
+    public function read(array $domains, array $locales): TranslatorBag
+    {
+        // TODO: Implement read() method.
+    }
+
+    public function delete(TranslatorBag $translations): void
+    {
+        // TODO: Implement delete() method.
+    }
+}