Merge pull request 'Version 1.3.0' (#7) from develop into main

Reviewed-on: #7

.gitattributes

@@ -0,0 +1,3 @@
+/.git           export-ignore
+/.gitignore     export-ignore
+/.gitattributes export-ignore

.gitignore

@@ -0,0 +1 @@
+/vendor

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2024 kor-elf
+Copyright (c) 2024 Leonid Nikitin (kor-elf)
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 

README.md

@@ -1,2 +1,129 @@
 # translate-laravel
 
+Библиотека для Laravel, что бы общаться с сервисом перевода от <a href="https://yandex.cloud/ru/docs/translate/" target="_blank">yandex</a>. В будущем (скорей всего в далёком будущем) планирую расширить поддержку разных сервисов перевода. Что бы можно было общаться через один интерфейс с разными сервисами.
+
+# Параметры в **.env**:
+
+### TRANSLATE_SERVICE
+По умолчанию через какой сервис обращаться за переводом. На данный момент доступен только сервисы - **yandex**, **log**.
+
+**yandex** - https://yandex.cloud/ru/services/translate<br>
+**log** - для проверки и внедрения в свой продукт.
+
+### TRANSLATE_YANDEX_FOLDER_ID
+ID folder. Код можно увидеть в адресе console.yandex.cloud/folders/**{тут будет код}**.
+
+### TRANSLATE_YANDEX_AUTHORIZED_KEY_PATH
+Абсолютный путь в рамках приложения Laravel к файлу **authorized_key.json**.
+Например: положили файл в корень Laravel. Тогда будет путь такой: **/authorized_key.json**.
+
+### TRANSLATE_YANDEX_LIMIT_MAX_REQUEST
+Максимальное количество запросов в период, который указан в TRANSLATE_YANDEX_LIMIT_RATE_SECONDS. По умолчанию 20 запросов в секунду. **На данный момент работает только перевод через систему очередей.**
+
+### TRANSLATE_YANDEX_LIMIT_RATE_SECONDS
+Период в котором считается максимальное количество запросов. По умолчанию стоит секунда. **На данный момент работает только перевод через систему очередей.**
+
+### TRANSLATE_YANDEX_LIMIT_MAX_SYMBOLS
+Максимальное количество символов за один запрос. Если превышает, то делится на две части и делает по очереди два запроса. По умолчанию стоит 9000 символов. **На данный момент работает только перевод через систему очередей.**
+
+### TRANSLATE_LOG_LIMIT_MAX_REQUEST
+Максимальное количество запросов в период, который указан в TRANSLATE_YANDEX_LIMIT_RATE_SECONDS. По умолчанию 20 запросов в секунду. **На данный момент работает только перевод через систему очередей.**
+
+### TRANSLATE_LOG_LIMIT_RATE_SECONDS
+Период в котором считается максимальное количество запросов. По умолчанию стоит секунда. **На данный момент работает только перевод через систему очередей.**
+
+### TRANSLATE_LOG_LIMIT_MAX_SYMBOLS
+Максимальное количество символов за один запрос. Если превышает, то делится на две части и делает по очереди два запроса. По умолчанию стоит 9000 символов. **На данный момент работает только перевод через систему очередей.**
+
+
+# Методы
+### Перевести обычный текст
+> \KorElf\TranslateLaravel\Facades\Translate::translateText(
+> <br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;string | array \$text, 
+> <br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;string &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\$targetLanguageCode, 
+> <br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;?string &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\$sourceLanguageCode = null
+> <br>): string | array
+
+**\$text** - текст который нужно перевести.
+<br>**\$targetLanguageCode** - язык на который надо перевести.
+<br>**\$sourceLanguageCode** - язык с которого надо перевести. Если **null**, то сервис сам пытается определить язык.
+
+<br>
+
+### Перевести текст в формате HTML
+> \KorElf\TranslateLaravel\Facades\Translate::translateHtml(
+> <br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;string | array \$text,
+> <br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;string &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\$targetLanguageCode,
+> <br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;?string &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\$sourceLanguageCode = null
+> <br>): string | array
+
+**\$text** - текст который нужно перевести.
+<br>**\$targetLanguageCode** - язык на который надо перевести.
+<br>**\$sourceLanguageCode** - язык с которого надо перевести. Если **null**, то сервис сам пытается определить язык.
+
+<br>
+
+### Получить список языков, который сервис поддерживает
+> \KorElf\TranslateLaravel\Facades\Translate::listLanguages(): \KorElf\TranslateLaravel\DTO\Languages
+
+<br>
+
+### Перевести с помощью очередей (Queues)
+> \KorElf\TranslateLaravel\Facades\Translate::runJob(
+> <br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\KorElf\TranslateLaravel\DTO\RunTranslateDto &nbsp;&nbsp;\$params,
+> <br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\KorElf\TranslateLaravel\DTO\AfterTranslateDto &nbsp;\$afterTranslateDto
+<br>): \Illuminate\Foundation\Bus\PendingDispatch
+
+**\$params** - параметры перевода.
+<br>**\$afterTranslateDto** - после завершения перевода отправляет результат в объект \$afterTranslateDto->\$className. Объект должен соблюдать контракт **\KorElf\TranslateLaravel\Contracts\TranslationCompletedListener**.
+
+**Пример:**
+> Создаём файл TranslationListener например в папке app/Services
+> 
+>       <?php declare(strict_types=1);
+>
+>       namespace App\Services;
+>
+>       use Illuminate\Support\Facades\Log;
+>       use KorElf\TranslateLaravel\Contracts\TranslationCompletedListener;
+>
+>       final class TranslationListener implements TranslationCompletedListener
+>       {
+>           /**
+>            * Объекты создаются и пробрасываются автоматически через контейнер `$application->make`,
+>            * благодаря механизму автоматического внедрения зависимостей (Dependency Injection).
+>            * Вы можете передавать свои собственные классы, поместив их в качестве параметров конструктора.
+>            * Контейнер создаст эти объекты автоматически, основываясь на разрешении типа (type-hint).
+>            */ 
+>           // public function __construct(
+>           //     private readonly SaveContentCommand $saveContentCommand
+>           // ) { }
+> 
+>           public function onTranslationCompleted(array $translatedText, array $data = []): void
+>           {
+>               Log::info($data);
+>               foreach ($translatedText as $translatedTextKey => $translatedTextValue) {
+>                   Log::info($translatedTextKey . ': ' . $translatedTextValue);
+>               }
+>               // $this->saveContentCommand->execute($data['contentId'], $translatedText);
+>           }
+>       }
+> 
+> Потом например в каком-то контроллере (а лучше конечно в сервисе) пишем такой метод
+>
+>     public function sendingForTranslation(): View
+>     {
+>          // Вначале создаём объект с параметрами
+>         $params = (new \KorElf\TranslateLaravel\DTO\RunTranslateDto)
+>            ->addParamText('title', 'Заголовок', 'en', 'ru')
+>            ->addParamHtml('content', '<p>Привет, Мир!</p>', 'en', 'ru');
+> 
+>          $translationCompletedListener = \App\Services\TranslationListener::class;
+>          $data = ['contentId' => 1];
+>          $afterTranslateDto = new \KorElf\TranslateLaravel\DTO\AfterTranslateDto($translationCompletedListener, $data);
+> 
+>         // Отправляем на очередь
+>         \KorElf\TranslateLaravel\Facades\Translate::runJob($params, $afterTranslateDto);
+>         
+>         return view('success');
+>     }

composer.json

@@ -0,0 +1,40 @@
+{
+  "name": "kor-elf/translate-laravel",
+  "description": "Translator for laravel",
+  "license": "MIT",
+  "type": "library",
+  "keywords": [
+    "Translate",
+    "Laravel",
+    "Yandex Translate"
+  ],
+  "homepage": "https://git.kor-elf.net/kor-elf/translate-laravel",
+  "authors": [
+    {
+      "name": "Leonid Nikitin",
+      "email": "i@kor-elf.net",
+      "homepage": "https://git.kor-elf.net/kor-elf",
+      "role": "Developer"
+    }
+  ],
+  "require": {
+    "php": "^8.2",
+    "illuminate/support": "^10.0|^11.0",
+    "guzzlehttp/guzzle": "^7.0.1",
+    "web-token/jwt-framework": "^3.0",
+    "ext-libxml": "*",
+    "ext-dom": "*"
+  },
+  "extra": {
+    "laravel": {
+      "providers": [
+        "KorElf\\TranslateLaravel\\TranslateLaravelProvider"
+      ]
+    }
+  },
+  "autoload": {
+    "psr-4": {
+      "KorElf\\TranslateLaravel\\": "src/"
+    }
+  }
+}

config/translate.php

@@ -0,0 +1,50 @@
+<?php declare(strict_types=1);
+
+/**
+ * Copyright (c) 2024
+ * author: Leonid Nikitin - i@kor-elf.net
+ * web: https://git.kor-elf.net/kor-elf
+ * Initial version created on: 15.09.2024
+ * MIT license: https://git.kor-elf.net/kor-elf/translate-laravel/src/branch/main/LICENSE
+ */
+
+return [
+    /*
+    |--------------------------------------------------------------------------
+    | Default Translate Service
+    |--------------------------------------------------------------------------
+    |
+    | This option controls the default translate service that will be used by the
+    | framework. This connection is utilized if another isn't explicitly
+    | specified when running a translation operation inside the application.
+    |
+    */
+
+    'default' => env('TRANSLATE_SERVICE', 'yandex'),
+
+    'services' => [
+        'yandex' => [
+            'driver' => '\KorElf\TranslateLaravel\Translate\YandexDriver',
+            'config' => [
+                'folder_id'           => env('TRANSLATE_YANDEX_FOLDER_ID'),
+                'authorized_key_path' => base_path(env('TRANSLATE_YANDEX_AUTHORIZED_KEY_PATH')),
+                'limit' => [
+                    'max_request'  => (int) env('TRANSLATE_YANDEX_LIMIT_MAX_REQUEST', 20),
+                    'rate_seconds' => (int) env('TRANSLATE_YANDEX_LIMIT_RATE_SECONDS', 1),
+                    'max_symbols' => (int) env('TRANSLATE_YANDEX_LIMIT_MAX_SYMBOLS', 9000),
+                ],
+            ],
+        ],
+
+        'log' => [
+            'driver' => '\KorElf\TranslateLaravel\Translate\LogDriver',
+            'config' => [
+                'limit' => [
+                    'max_request'  => (int) env('TRANSLATE_LOG_LIMIT_MAX_REQUEST', 20),
+                    'rate_seconds' => (int) env('TRANSLATE_LOG_LIMIT_RATE_SECONDS', 1),
+                    'max_symbols' => (int) env('TRANSLATE_LOG_LIMIT_MAX_SYMBOLS', 9000),
+                ],
+            ],
+        ],
+    ],
+];

src/Contracts/ProcessTranslateContract.php

@@ -0,0 +1,10 @@
+<?php declare(strict_types=1);
+
+namespace KorElf\TranslateLaravel\Contracts;
+
+use KorElf\TranslateLaravel\DTO\ProcessTranslateLimit;
+
+interface ProcessTranslateContract
+{
+    public function getLimited(): ProcessTranslateLimit;
+}

src/Contracts/Translate.php

@@ -0,0 +1,17 @@
+<?php declare(strict_types=1);
+
+namespace KorElf\TranslateLaravel\Contracts;
+
+use KorElf\TranslateLaravel\DTO\Languages;
+use Illuminate\Contracts\Foundation\Application;
+
+interface Translate
+{
+    public static function init(Application $app, array $config = []): self;
+
+    public function translateText(string|array $text, string $targetLanguageCode, ?string $sourceLanguageCode = null): string|array;
+
+    public function translateHtml(string|array $text, string $targetLanguageCode, ?string $sourceLanguageCode = null): string|array;
+
+    public function listLanguages(): Languages;
+}

src/Contracts/TranslationCompletedListener.php

@@ -0,0 +1,8 @@
+<?php declare(strict_types=1);
+
+namespace KorElf\TranslateLaravel\Contracts;
+
+interface TranslationCompletedListener
+{
+    public function onTranslationCompleted(array $translatedText, array $data = []): void;
+}

src/DTO/AfterTranslateDto.php

@@ -0,0 +1,32 @@
+<?php declare(strict_types=1);
+
+namespace KorElf\TranslateLaravel\DTO;
+
+final readonly class AfterTranslateDto
+{
+    /**
+     * @param string $className The fully qualified class name (FQN) of a class that implements the TranslationCompletedListener interface.
+     * @param array $data Additional data associated with the translation process.
+     */
+    public function __construct(
+        private string $className,
+        private array $data = [],
+    ) { }
+
+    /**
+     * Get the fully qualified class name (FQN) of a class that implements the TranslationCompletedListener interface.
+     *
+     * @return class-string<\KorElf\TranslateLaravel\Contracts\TranslationCompletedListener>
+     */
+    public function getClassName(): string
+    {
+        return $this->className;
+    }
+
+    public function getData(): array
+    {
+        return $this->data;
+    }
+
+
+}

src/DTO/Languages.php

@@ -0,0 +1,18 @@
+<?php declare(strict_types=1);
+
+namespace KorElf\TranslateLaravel\DTO;
+
+final class Languages
+{
+    private array $languages;
+
+    public function add(string $code, string $name): void
+    {
+        $this->languages[$code] = $name;
+    }
+
+    public function getLanguages(): array
+    {
+        return $this->languages;
+    }
+}

src/DTO/Parameter.php

@@ -0,0 +1,41 @@
+<?php declare(strict_types=1);
+
+namespace KorElf\TranslateLaravel\DTO;
+
+use KorElf\TranslateLaravel\Enums\TextType;
+
+final readonly class Parameter
+{
+    public function __construct(
+        private string   $text,
+        private TextType $textType,
+        private string   $targetLanguageCode,
+        private ?string  $sourceLanguageCode = null,
+        private ?string  $driver = null
+    ) { }
+
+    public function getText(): string
+    {
+        return $this->text;
+    }
+
+    public function getTextType(): TextType
+    {
+        return $this->textType;
+    }
+
+    public function getTargetLanguageCode(): string
+    {
+        return $this->targetLanguageCode;
+    }
+
+    public function getSourceLanguageCode(): ?string
+    {
+        return $this->sourceLanguageCode;
+    }
+
+    public function getDriver(): ?string
+    {
+        return $this->driver;
+    }
+}

src/DTO/ProcessTranslateDto.php

@@ -0,0 +1,59 @@
+<?php declare(strict_types=1);
+
+namespace KorElf\TranslateLaravel\DTO;
+
+use KorElf\TranslateLaravel\Enums\TextType;
+
+final readonly class ProcessTranslateDto
+{
+    public function __construct(
+        private string   $groupName,
+        private string   $key,
+        private int      $part,
+        private string   $text,
+        private TextType $textType,
+        private string   $targetLanguageCode,
+        private ?string  $sourceLanguageCode = null,
+        private ?string  $driver = null
+    ) { }
+
+    public function getGroupName(): string
+    {
+        return $this->groupName;
+    }
+
+    public function getKey(): string
+    {
+        return $this->key;
+    }
+
+    public function getPart(): int
+    {
+        return $this->part;
+    }
+
+    public function getText(): string
+    {
+        return $this->text;
+    }
+
+    public function getTextType(): TextType
+    {
+        return $this->textType;
+    }
+
+    public function getTargetLanguageCode(): string
+    {
+        return $this->targetLanguageCode;
+    }
+
+    public function getSourceLanguageCode(): ?string
+    {
+        return $this->sourceLanguageCode;
+    }
+
+    public function getDriver(): ?string
+    {
+        return $this->driver;
+    }
+}

src/DTO/ProcessTranslateLimit.php

@@ -0,0 +1,27 @@
+<?php declare(strict_types=1);
+
+namespace KorElf\TranslateLaravel\DTO;
+
+final readonly class ProcessTranslateLimit
+{
+    public function __construct(
+        private int    $maxRequest,
+        private int    $rateSeconds,
+        private string $driver,
+    ) { }
+
+    public function getMaxRequest(): int
+    {
+        return $this->maxRequest;
+    }
+
+    public function getRateSeconds(): int
+    {
+        return $this->rateSeconds;
+    }
+
+    public function getDriver(): string
+    {
+        return $this->driver;
+    }
+}

src/DTO/RunTranslateDto.php

@@ -0,0 +1,65 @@
+<?php declare(strict_types=1);
+
+namespace KorElf\TranslateLaravel\DTO;
+
+use KorElf\TranslateLaravel\Enums\TextType;
+use KorElf\TranslateLaravel\Exceptions\RunTranslateDtoException;
+
+final class RunTranslateDto
+{
+    /**
+     * @var array [key => \KorElf\TranslateLaravel\DTO\Parameter]
+     */
+    private array $params = [];
+
+    public function addParam(
+        string   $key,
+        string   $text,
+        TextType $textType,
+        string   $targetLanguageCode,
+        ?string  $sourceLanguageCode = null,
+        ?string  $driver = null
+    ): self
+    {
+        if (isset($this->params[$key])) {
+            throw new RunTranslateDtoException('Duplicate key: ' . $key);
+        }
+
+        $this->params[$key] = new Parameter(
+            $text,
+            $textType,
+            $targetLanguageCode,
+            $sourceLanguageCode,
+            $driver,
+        );
+
+        return $this;
+    }
+
+    public function addParamHtml(
+        string   $key,
+        string   $text,
+        string   $targetLanguageCode,
+        ?string  $sourceLanguageCode = null,
+        ?string  $driver = null
+    ): self
+    {
+        return $this->addParam($key, $text, TextType::Html, $targetLanguageCode, $sourceLanguageCode, $driver);
+    }
+
+    public function addParamText(
+        string   $key,
+        string   $text,
+        string   $targetLanguageCode,
+        ?string  $sourceLanguageCode = null,
+        ?string  $driver = null
+    ): self
+    {
+        return $this->addParam($key, $text, TextType::Text, $targetLanguageCode, $sourceLanguageCode, $driver);
+    }
+
+    public function getParams(): array
+    {
+        return $this->params;
+    }
+}

src/DTO/Translated.php

@@ -0,0 +1,20 @@
+<?php declare(strict_types=1);
+
+namespace KorElf\TranslateLaravel\DTO;
+
+final class Translated
+{
+    private array $data = [];
+
+    public function add(string $key, int $parts): self
+    {
+        $this->data[$key] = $parts;
+
+        return $this;
+    }
+
+    public function toArray(): array
+    {
+        return $this->data;
+    }
+}

src/Enums/TextType.php

@@ -0,0 +1,17 @@
+<?php declare(strict_types=1);
+
+namespace KorElf\TranslateLaravel\Enums;
+
+enum TextType: string
+{
+    case Text = 'text';
+    case Html = 'html';
+
+    public function functionName(): string
+    {
+        return match ($this) {
+            self::Text => 'translateText',
+            self::Html => 'translateHtml',
+        };
+    }
+}

src/Exceptions/AfterTranslateException.php

@@ -0,0 +1,10 @@
+<?php declare(strict_types=1);
+
+namespace KorElf\TranslateLaravel\Exceptions;
+
+use RuntimeException;
+
+final class AfterTranslateException extends RuntimeException
+{
+
+}

src/Exceptions/RunTranslateDtoException.php

@@ -0,0 +1,10 @@
+<?php declare(strict_types=1);
+
+namespace KorElf\TranslateLaravel\Exceptions;
+
+use RuntimeException;
+
+final class RunTranslateDtoException extends RuntimeException
+{
+
+}

src/Exceptions/TranslateException.php

@@ -0,0 +1,10 @@
+<?php declare(strict_types=1);
+
+namespace KorElf\TranslateLaravel\Exceptions;
+
+use RuntimeException;
+
+final class TranslateException extends RuntimeException
+{
+
+}

src/Facades/Translate.php

@@ -0,0 +1,28 @@
+<?php declare(strict_types=1);
+
+namespace KorElf\TranslateLaravel\Facades;
+
+use Illuminate\Support\Facades\Facade;
+use KorElf\TranslateLaravel\DTO\AfterTranslateDto;
+use KorElf\TranslateLaravel\DTO\RunTranslateDto;
+
+/**
+ * @method static \KorElf\TranslateLaravel\Contracts\Translate service(?string $name = null)
+ * @method static \KorElf\TranslateLaravel\Contracts\Translate resolve(string $name)
+ * @method static string|array translateText(string|array $text, string $targetLanguageCode, ?string $sourceLanguageCode = null)
+ * @method static string|array translateHtml(string|array $text, string $targetLanguageCode, ?string $sourceLanguageCode = null)
+ * @method static \Illuminate\Foundation\Bus\PendingDispatch runJob(RunTranslateDto $params, AfterTranslateDto $afterTranslateDto)
+ * @method static \KorElf\TranslateLaravel\DTO\Languages listLanguages()
+ * @method static string getDefaultDriver()
+ * @method static void setDefaultDriver(string $name)
+ * @method static void purge(?string $name)
+ * @method static array getLimit(?string $driver)
+ */
+
+final class Translate extends Facade
+{
+    protected static function getFacadeAccessor(): string
+    {
+        return 'translate';
+    }
+}

src/Jobs/AfterTranslate.php

@@ -0,0 +1,55 @@
+<?php declare(strict_types=1);
+
+namespace KorElf\TranslateLaravel\Jobs;
+
+use Illuminate\Bus\Queueable;
+use Illuminate\Contracts\Queue\ShouldBeEncrypted;
+use Illuminate\Contracts\Queue\ShouldQueue;
+use Illuminate\Foundation\Application;
+use Illuminate\Foundation\Bus\Dispatchable;
+use Illuminate\Queue\InteractsWithQueue;
+use Illuminate\Support\Facades\Cache;
+use KorElf\TranslateLaravel\DTO\AfterTranslateDto;
+use KorElf\TranslateLaravel\DTO\Translated;
+use KorElf\TranslateLaravel\Exceptions\AfterTranslateException;
+
+final class AfterTranslate implements ShouldQueue, ShouldBeEncrypted
+{
+    use Dispatchable, InteractsWithQueue, Queueable;
+
+    /**
+     * Create a new job instance.
+     */
+    public function __construct(
+        private readonly string            $groupName,
+        private readonly Translated        $translated,
+        private readonly AfterTranslateDto $afterTranslateDto
+    ) { }
+
+    public function handle(Application $application): void
+    {
+        $translated = [];
+        $data = Cache::get($this->groupName, []);
+
+        $errors = [];
+        foreach ($this->translated->toArray() as $key => $parts) {
+            if (!isset($data[$key]) || count($data[$key]) !== $parts) {
+                $errors[] = $key;
+                continue;
+            }
+
+            $translated[$key] = implode(' ', $data[$key]);
+        }
+
+        if (empty($data) || !empty($errors)) {
+            throw new AfterTranslateException('Part or all of the text has not been translated. Keys: ' . implode(', ', $errors));
+        }
+        $objectAfterTranslate = $application->make($this->afterTranslateDto->getClassName());
+        if (!$objectAfterTranslate instanceof \KorElf\TranslateLaravel\Contracts\TranslationCompletedListener) {
+            throw new AfterTranslateException('The class must implement the \KorElf\TranslateLaravel\Contracts\TranslationCompletedListener interface.');
+        }
+        $objectAfterTranslate->onTranslationCompleted($translated, $this->afterTranslateDto->getData());
+
+        Cache::forget($this->groupName);
+    }
+}

src/Jobs/ProcessTranslate.php

@@ -0,0 +1,86 @@
+<?php declare(strict_types=1);
+
+namespace KorElf\TranslateLaravel\Jobs;
+
+use Illuminate\Bus\Queueable;
+use Illuminate\Contracts\Queue\ShouldBeEncrypted;
+use Illuminate\Contracts\Queue\ShouldQueue;
+use Illuminate\Foundation\Bus\Dispatchable;
+use Illuminate\Queue\InteractsWithQueue;
+use Illuminate\Queue\Middleware\RateLimited;
+use Illuminate\Support\Facades\Cache;
+use KorElf\TranslateLaravel\Contracts\ProcessTranslateContract;
+use KorElf\TranslateLaravel\DTO\ProcessTranslateDto;
+use KorElf\TranslateLaravel\DTO\ProcessTranslateLimit;
+use KorElf\TranslateLaravel\Facades\Translate;
+
+final class ProcessTranslate implements ShouldQueue, ShouldBeEncrypted, ProcessTranslateContract
+{
+    use Dispatchable, InteractsWithQueue, Queueable;
+
+    /**
+     * Create a new job instance.
+     */
+    public function __construct(
+        private readonly ProcessTranslateDto $param
+    ) { }
+
+    /**
+     * Get the middleware the job should pass through.
+     *
+     * @return array<int, object>
+     */
+    public function middleware(): array
+    {
+        return [
+            new RateLimited('kor-elf-translate'),
+        ];
+    }
+
+    public function getLimited(): ProcessTranslateLimit
+    {
+        $driver = $this->param->getDriver();
+        if ($driver === null) {
+            $driver = Translate::getDefaultDriver();
+        }
+        $limit = Translate::getLimit($driver);
+
+        return new ProcessTranslateLimit(
+            maxRequest: $limit['max_request'] ?? 1000000000,
+            rateSeconds: $limit['rate_seconds'] ?? 1,
+            driver: $driver,
+        );
+    }
+
+    /**
+     * Execute the job.
+     */
+    public function handle(): void
+    {
+        $param = $this->param;
+        $groupName = $param->getGroupName();
+
+        $translated = Cache::get($groupName, []);
+        if (!isset($translated[$param->getKey()])) {
+            $translated[$param->getKey()] = [];
+        }
+
+        $translate = Translate::service($param->getDriver());
+        $function = $param->getTextType()->functionName();
+        $key = $param->getKey();
+        $part = $param->getPart();
+
+        $translated[$key][$part] = $param->getText();
+        if (\trim($param->getText()) !== '') {
+
+            $translated[$key][$part] = $translate->{$function}(
+                $param->getText(),
+                $param->getTargetLanguageCode(),
+                $param->getSourceLanguageCode()
+            );
+
+        }
+
+        Cache::put($groupName, $translated, 86400);
+    }
+}

src/Jobs/RunTranslate.php

@@ -0,0 +1,62 @@
+<?php declare(strict_types=1);
+
+namespace KorElf\TranslateLaravel\Jobs;
+
+use Illuminate\Bus\Queueable;
+use Illuminate\Contracts\Queue\ShouldBeEncrypted;
+use Illuminate\Contracts\Queue\ShouldQueue;
+use Illuminate\Foundation\Bus\Dispatchable;
+use Illuminate\Queue\InteractsWithQueue;
+use Illuminate\Queue\SerializesModels;
+use Illuminate\Support\Facades\Bus;
+use Illuminate\Support\Str;
+use KorElf\TranslateLaravel\DTO\AfterTranslateDto;
+use KorElf\TranslateLaravel\DTO\ProcessTranslateDto;
+use korElf\TranslateLaravel\DTO\RunTranslateDto;
+use KorElf\TranslateLaravel\DTO\Translated;
+use KorElf\TranslateLaravel\Translate\SplitTextIntoPartsCommand;
+
+final class RunTranslate implements ShouldQueue, ShouldBeEncrypted
+{
+    use Dispatchable, InteractsWithQueue, Queueable, SerializesModels;
+
+    /**
+     * Create a new job instance.
+     */
+    public function __construct(
+        private readonly RunTranslateDto    $runTranslateDto,
+        private readonly AfterTranslateDto $afterTranslateDto,
+    ) { }
+
+    /**
+     * Execute the job.
+     */
+    public function handle(SplitTextIntoPartsCommand $splitTextIntoPartsCommand): void
+    {
+        $chains = [];
+        $groupName = 'KorElf\TranslateLaravel\Jobs-' . Str::uuid()->toString();
+        $translated = new Translated();
+        foreach ($this->runTranslateDto->getParams() as $key => $param) {
+            /* @var \KorElf\TranslateLaravel\DTO\Parameter $param */
+
+            $texts = $splitTextIntoPartsCommand->execute($param->getText(), $param->getTextType(), $param->getDriver());
+            foreach ($texts as $part => $partText) {
+                $processTranslateDto = new ProcessTranslateDto(
+                    $groupName,
+                    $key,
+                    $part,
+                    $partText,
+                    $param->getTextType(),
+                    $param->getTargetLanguageCode(),
+                    $param->getSourceLanguageCode(),
+                    $param->getDriver(),
+                );
+                $chains[] = new ProcessTranslate($processTranslateDto);
+            }
+            $translated->add($key, count($texts));
+        }
+        $chains[] = new AfterTranslate($groupName, $translated, $this->afterTranslateDto);
+
+        Bus::chain($chains)->dispatch();
+    }
+}

src/Translate/LogDriver.php

@@ -0,0 +1,50 @@
+<?php declare(strict_types=1);
+
+namespace KorElf\TranslateLaravel\Translate;
+
+use Illuminate\Contracts\Container\BindingResolutionException;
+use Illuminate\Contracts\Foundation\Application;
+use Illuminate\Support\Facades\Log;
+use KorElf\TranslateLaravel\Contracts\Translate;
+use KorElf\TranslateLaravel\DTO\Languages;
+
+final class LogDriver implements Translate
+{
+    /**
+     * @throws BindingResolutionException
+     */
+    public static function init(Application $app, array $config = []): Translate
+    {
+        return new self(
+            $app->make(Log::class),
+        );
+    }
+
+    public function __construct(
+        private readonly Log $log
+    ) { }
+
+    public function translateText(array|string $text, string $targetLanguageCode, ?string $sourceLanguageCode = null): string|array
+    {
+        $this->log::info('Translate text', ['text' => $text, 'targetLanguageCode' => $targetLanguageCode, 'sourceLanguageCode' => $sourceLanguageCode]);
+
+        return $text;
+    }
+
+    public function translateHtml(array|string $text, string $targetLanguageCode, ?string $sourceLanguageCode = null): string|array
+    {
+        $this->log::info('Translate html', ['text' => $text, 'targetLanguageCode' => $targetLanguageCode, 'sourceLanguageCode' => $sourceLanguageCode]);
+
+        return $text;
+    }
+
+    public function listLanguages(): Languages
+    {
+        $languages = new Languages();
+        $languages->add('ru', 'Russian');
+        $languages->add('en', 'English');
+        $languages->add('de', 'Deutsch');
+
+        return $languages;
+    }
+}

src/Translate/SplitTextIntoPartsCommand.php

@@ -0,0 +1,115 @@
+<?php declare(strict_types=1);
+
+namespace KorElf\TranslateLaravel\Translate;
+
+use KorElf\TranslateLaravel\Enums\TextType;
+use KorElf\TranslateLaravel\Facades\Translate;
+use DOMDocument;
+
+final readonly class SplitTextIntoPartsCommand
+{
+    public function execute(string $text, TextType $textType, ?string $driver): array
+    {
+        $maxLength = Translate::getLimit($driver);
+        $maxLength = $maxLength['max_symbols'] ?? null;
+        if ($maxLength === null || $maxLength > mb_strlen($text)) {
+            return [$text];
+        }
+
+        if ($textType === TextType::Html) {
+            return $this->splitHtmlText($text, $maxLength);
+        }
+
+        return $this->splitTextBySentences($text, $maxLength);
+    }
+
+    private function splitTextBySentences(string $text, int $maxLength): array
+    {
+        // Common expression for searching for sentences.
+        $sentenceEndings = '/(?<=[.?!])\s+(?=[A-ZА-Я])/u';
+
+        //Dividing the text into sentences
+        $sentences = preg_split($sentenceEndings, $text, -1, PREG_SPLIT_NO_EMPTY);
+
+        $parts = [];
+        $currentPart = '';
+
+        foreach ($sentences as $sentence) {
+            // If adding a sentence does not exceed the limit, add it to the current part.
+            if (mb_strlen($currentPart . ' ' . $sentence) <= $maxLength) {
+                $currentPart .= (empty($currentPart) ? '' : ' ') . $sentence;
+                continue;
+            }
+
+            // Otherwise, save the current part and start a new one.
+            if (!empty($currentPart)) {
+                $parts[] = $currentPart;
+                $currentPart = '';
+            }
+            $currentPart = $sentence;
+        }
+
+        if (!empty($currentPart)) {
+            $parts[] = $currentPart;
+        }
+
+        return $parts;
+    }
+
+    private function splitHtmlText(string $html, int $maxLength): array
+    {
+        libxml_use_internal_errors(true);
+
+        $dom = new DOMDocument();
+        $dom->loadHTML(mb_convert_encoding('<body>' . $html . '</body>', 'HTML-ENTITIES', 'UTF-8'), LIBXML_HTML_NOIMPLIED | LIBXML_HTML_NODEFDTD);
+
+        $parts = [];
+        $currentPart = new DOMDocument();
+        $currentLength = 0;
+
+        // Iterate through all child nodes of the root element
+        foreach ($dom->documentElement->childNodes as $node) {
+            if ($node->nodeType === XML_TEXT_NODE || $node->nodeType === XML_CDATA_SECTION_NODE) {
+                // Dividing text nodes into sentences
+                $sentences = preg_split('/(?<=[.?!])\s+(?=[A-ZА-Я])/', $node->textContent, -1, PREG_SPLIT_NO_EMPTY);
+
+                foreach ($sentences as $sentence) {
+                    $sentenceHtml = htmlspecialchars($sentence);
+                    if ($currentLength + mb_strlen($sentenceHtml) > $maxLength) {
+                        $parts[] = $currentPart->saveHTML();
+
+                        // Start new part
+                        $currentPart = new DOMDocument();
+                        $currentLength = 0;
+                    }
+
+                    $textNode = $currentPart->createTextNode($sentence . ' ');
+                    $currentPart->appendChild($textNode);
+                    $currentLength += mb_strlen($sentenceHtml);
+                }
+                continue;
+            }
+
+            $nodeHtml = $dom->saveHTML($node);
+
+            if ($currentLength + mb_strlen($nodeHtml) > $maxLength) {
+                $parts[] = $currentPart->saveHTML();
+
+                // Start new part
+                $currentPart = new DOMDocument();
+                $currentLength = mb_strlen($nodeHtml);
+            }
+
+            $currentPart->appendChild($currentPart->importNode($node, true));
+            $currentLength += mb_strlen($nodeHtml);
+        }
+
+        if ($currentPart->hasChildNodes()) {
+            $parts[] = $currentPart->saveHTML();
+        }
+
+        libxml_clear_errors();
+
+        return $parts;
+    }
+}

src/Translate/TranslateManager.php

@@ -0,0 +1,105 @@
+<?php declare(strict_types=1);
+
+namespace KorElf\TranslateLaravel\Translate;
+
+use Illuminate\Contracts\Foundation\Application;
+use Illuminate\Foundation\Bus\PendingDispatch;
+use InvalidArgumentException;
+use KorElf\TranslateLaravel\Contracts\TranslationCompletedListener;
+use KorElf\TranslateLaravel\Contracts\Translate;
+use KorElf\TranslateLaravel\DTO\AfterTranslateDto;
+use KorElf\TranslateLaravel\DTO\RunTranslateDto;
+use KorElf\TranslateLaravel\Jobs\RunTranslate;
+
+final class TranslateManager
+{
+    /**
+     * The array of resolved translation services.
+     */
+    private array $translates = [];
+
+    public function __construct(
+        private Application $app,
+    ) { }
+
+    public function service(?string $name = null): Translate
+    {
+        $name = $name ?: $this->getDefaultDriver();
+
+        return $this->translates[$name] ??= $this->resolve($name);
+    }
+
+    public function getDefaultDriver(): string
+    {
+        return $this->app['config']['translate.default'];
+    }
+
+    public function setDefaultDriver(string $name): void
+    {
+        $this->app['config']['translate.default'] = $name;
+    }
+
+    /**
+     * Resolve the given translate service.
+     *
+     * @throws InvalidArgumentException
+     */
+    public function resolve(string $name): Translate
+    {
+        $config = $this->getConfig($name);
+
+        if (\is_null($config)) {
+            throw new InvalidArgumentException('Translate service [' . $name . '] is not defined.');
+        }
+
+        return $config['driver']::init($this->app, $config['config']);
+    }
+
+    /**
+     * Disconnect the given driver and remove from local cache.
+     */
+    public function purge(?string $name = null): void
+    {
+        $name ??= $this->getDefaultDriver();
+
+        unset($this->translates[$name]);
+    }
+
+    /**
+     * Run through queues.
+     */
+    public function runJob(RunTranslateDto $params, AfterTranslateDto $afterTranslateDto): PendingDispatch
+    {
+        $className = $afterTranslateDto->getClassName();
+        if (!is_subclass_of($className, TranslationCompletedListener::class)) {
+            throw new InvalidArgumentException('The class ' . $className . ' must implement the \KorElf\TranslateLaravel\Contracts\Translate\TranslationCompletedListener interface.');
+        }
+        unset($className);
+
+        return RunTranslate::dispatch($params, $afterTranslateDto);
+    }
+
+    public function getLimit(?string $driver = null): array
+    {
+        if ($driver === null) {
+            $driver = $this->getDefaultDriver();
+        }
+
+        $config = $this->getConfig($driver);
+
+        return $config['config']['limit'] ?? [];
+    }
+
+    /**
+     * Dynamically call the default driver instance.
+     */
+    public function __call(string $method, mixed $parameters): mixed
+    {
+        return $this->service()->$method(...$parameters);
+    }
+
+    private function getConfig(string $name): ?array
+    {
+        return $this->app['config']["translate.services.{$name}"] ?? null;
+    }
+}

src/Translate/Yandex/Connection.php

@@ -0,0 +1,113 @@
+<?php declare(strict_types=1);
+
+namespace KorElf\TranslateLaravel\Translate\Yandex;
+
+use Illuminate\Support\Facades\Http;
+use Illuminate\Support\Facades\Cache;
+use Illuminate\Support\Carbon;
+use Jose\Component\Core\AlgorithmManager;
+use Jose\Component\KeyManagement\JWKFactory;
+use Jose\Component\Signature\Algorithm\PS256;
+use Jose\Component\Signature\JWSBuilder;
+use Jose\Component\Signature\Serializer\CompactSerializer;
+use KorElf\TranslateLaravel\Exceptions\TranslateException;
+
+final class Connection
+{
+    private string $path;
+    private string $folderId;
+    private string $privateKey;
+    private string $keyId;
+    private string $serviceAccountId;
+
+    public function __construct(string $path, string $folderId, string $privateKey, string $keyId, string $serviceAccountId)
+    {
+        $this->path = $path;
+        $this->folderId = $folderId;
+
+        // Need to remove header/metadata from private key
+        if (\strpos($privateKey, "PLEASE DO NOT REMOVE THIS LINE!") === 0) {
+            $privateKey = \substr($privateKey, \strpos($privateKey, "\n") + 1);
+        }
+        $this->privateKey = $privateKey;
+
+        $this->keyId = $keyId;
+        $this->serviceAccountId = $serviceAccountId;
+    }
+
+    public function post(string $path, array $post): array
+    {
+        $token = $this->getToken();
+        $path = $this->path . $path;
+        $post['folderId'] = $this->folderId;
+
+        $response = Http::withToken($token)
+            ->timeout(30)
+            ->post($path, $post);
+
+        $data = $response->json();
+
+        if ($data !== null && $response->status() === 200) {
+            return $data;
+        }
+        $message = $data['message'] ?? 'Error in request';
+
+        throw new TranslateException($message, $response->status());
+    }
+
+    private function getToken(): string
+    {
+        $cacheName = self::class . '_token';
+        $token = Cache::get($cacheName);
+        if ($token !== null) {
+            return $token;
+        }
+
+        $token = $this->createNewToken();
+        Cache::put($cacheName, $token['iamToken'], Carbon::createFromDate($token['expiresAt']));
+
+        return $token['iamToken'];
+    }
+
+    private function getJWTToken(): string
+    {
+        $jwk = JWKFactory::createFromKey(
+            $this->privateKey,
+            null,
+            [
+                'alg' => 'PS256',
+                'use' => 'sig',
+                'kid' => $this->keyId,
+            ]
+        );
+
+        $algorithmManager = new AlgorithmManager([new PS256()]);
+        $jwsBuilder = new JWSBuilder($algorithmManager);
+
+        $payload = \json_encode([
+            'iss' => $this->serviceAccountId,
+            'aud' => "https://iam.api.cloud.yandex.net/iam/v1/tokens",
+            'iat' => time(),
+            'nbf' => time(),
+            'exp' => time() + 600,
+        ]);
+
+        $jws = $jwsBuilder
+            ->create()
+            ->withPayload($payload)
+            ->addSignature($jwk, ['alg' => 'PS256', 'typ'=>'JWT', 'kid' => $this->keyId])
+            ->build();
+
+        $serializer = new CompactSerializer();
+        return $serializer->serialize($jws, 0);
+    }
+
+    private function createNewToken(): array
+    {
+        $jwtToken = $this->getJWTToken();
+        $token = Http::timeout(30)
+            ->post('https://iam.api.cloud.yandex.net/iam/v1/tokens', ['jwt' => $jwtToken]);
+
+        return $token->json();
+    }
+}

src/Translate/YandexDriver.php

@@ -0,0 +1,113 @@
+<?php declare(strict_types=1);
+
+namespace KorElf\TranslateLaravel\Translate;
+
+use KorElf\TranslateLaravel\Contracts\Translate;
+use KorElf\TranslateLaravel\DTO\Languages;
+use KorElf\TranslateLaravel\Exceptions\TranslateException;
+use KorElf\TranslateLaravel\Translate\Yandex\Connection;
+use Illuminate\Contracts\Foundation\Application;
+
+final class YandexDriver implements Translate
+{
+    public static function init(Application $app, array $config = []): self
+    {
+        $keyData = json_decode(file_get_contents($config['authorized_key_path']), true);
+        $path    = 'https://translate.api.cloud.yandex.net/translate/v2/';
+
+        return new self(
+            $app->make(Connection::class, [
+                'path'             => $path,
+                'folderId'         => $config['folder_id'],
+                'privateKey'       => $keyData['private_key'],
+                'keyId'            => $keyData['id'],
+                'serviceAccountId' => $keyData['service_account_id'],
+            ]),
+        );
+    }
+
+    public function __construct(
+        private readonly Connection $connection
+    ) { }
+
+    public function translateText(string|array $text, string $targetLanguageCode, ?string $sourceLanguageCode = null): string|array
+    {
+        $format = 'PLAIN_TEXT';
+        $result = $this->translate($text, $format, $targetLanguageCode, $sourceLanguageCode);
+
+        if (\is_string($text)) {
+            return array_shift($result);
+        }
+
+        return $result;
+    }
+
+    public function translateHtml(string|array $text, string $targetLanguageCode, ?string $sourceLanguageCode = null): string|array
+    {
+        $format = 'HTML';
+        $result = $this->translate($text, $format, $targetLanguageCode, $sourceLanguageCode);
+
+        if (\is_string($text)) {
+            return array_shift($result);
+        }
+
+        return $result;
+    }
+
+    public function listLanguages(): Languages
+    {
+        $params = [];
+        try {
+            $result = $this->connection->post('languages', $params);
+            if (! isset($result['languages'])) {
+                $message = $result['message'] ?? 'Missing value languages in array';
+                throw new TranslateException($message);
+            }
+
+            $languages = new Languages();
+            foreach ($result['languages'] as $language) {
+                $languages->add($language['code'], $language['name'] ?? $language['code']);
+            }
+            return $languages;
+        } catch (TranslateException $e) {
+            throw $e;
+        } catch (\Throwable $exception) {
+            throw new TranslateException($exception->getMessage());
+        }
+    }
+
+    private function translate(string|array $text, string $format, string $targetLanguageCode, ?string $sourceLanguageCode = null): array
+    {
+        if (\is_string($text)) {
+            $text = [$text];
+        }
+
+        $params = [
+            'targetLanguageCode' => $targetLanguageCode,
+            'format'             => $format,
+            'texts'              => $text,
+            'speller'            => true,
+        ];
+        if ($sourceLanguageCode) {
+            $params['sourceLanguageCode'] = $sourceLanguageCode;
+        }
+
+        try {
+            $result = $this->connection->post('translate', $params);
+            if (! isset($result['translations'])) {
+                $message = $result['message'] ?? 'Missing value translations in array';
+                throw new TranslateException($message);
+            }
+
+            $translations = [];
+            foreach ($result['translations'] as $translation) {
+                $translations[] = $translation['text'];
+            }
+            return $translations;
+        } catch (TranslateException $e) {
+            throw $e;
+        } catch (\Throwable $exception) {
+            throw new TranslateException($exception->getMessage());
+        }
+    }
+}

src/TranslateLaravelProvider.php

@@ -0,0 +1,46 @@
+<?php declare(strict_types=1);
+
+namespace KorElf\TranslateLaravel;
+
+use Illuminate\Cache\RateLimiting\Limit;
+use Illuminate\Support\Facades\RateLimiter;
+use Illuminate\Support\ServiceProvider;
+use Illuminate\Contracts\Foundation\Application;
+use KorElf\TranslateLaravel\Contracts\ProcessTranslateContract;
+use KorElf\TranslateLaravel\Translate\TranslateManager;
+
+final class TranslateLaravelProvider extends ServiceProvider
+{
+    public function boot(): Void
+    {
+        $this->publishes([
+            __DIR__ . '/../config/translate.php' => config_path('translate.php'),
+        ], 'config');
+
+        RateLimiter::for('kor-elf-translate', function (ProcessTranslateContract $job) {
+            $limited = $job->getLimited();
+
+            return Limit::perSecond(
+                $limited->getMaxRequest(),
+                $limited->getRateSeconds()
+            )->by($limited->getDriver());
+        });
+    }
+
+    /**
+     * Register the service provider.
+     *
+     * @return void
+     */
+    public function register(): Void
+    {
+        $this->mergeConfigFrom(
+            __DIR__ . '/../config/translate.php',
+            'translate'
+        );
+        $this->app->singleton('translate', function (Application $app) {
+            return new TranslateManager($app);
+        });
+    }
+
+}