Refactored code after first test

.php-cs-fixer.php

@@ -3,7 +3,7 @@
 return (new PhpCsFixer\Config())
     ->setRiskyAllowed(false)
     ->setRules([
-        '@PSR2' => true,
+        '@PSR12' => true,
     ])
     ->setUsingCache(true)
     ->setFinder(

composer.json

@@ -2,7 +2,7 @@
   "name": "korridor/symfony-scaleway-tem-mailer",
   "type": "symfony-mailer-bridge",
   "description": "Symfony Scaleway transaction email (TEM) Mailer Bridge",
-  "keywords": [],
+  "keywords": ["symfony", "scaleway", "symfony-mailer", "scaleway-api"],
   "homepage": "https://github.com/korridor/symfony-scaleway-tem-mailer",
   "license": "MIT",
   "authors": [
@@ -29,12 +29,12 @@
   },
   "autoload": {
     "psr-4": {
-      "Symfony\\Component\\Mailer\\Bridge\\Scaleway\\": "src/"
+      "Korridor\\SymfonyScalewayTemMailer\\": "src/"
     }
   },
   "autoload-dev": {
     "psr-4": {
-      "Symfony\\Component\\Mailer\\Bridge\\Scaleway\\Tests\\": "tests/"
+      "Korridor\\SymfonyScalewayTemMailer\\Tests\\": "tests/"
     }
   },
   "minimum-stability": "dev"

readme.md

@@ -1,5 +1,9 @@
 # Symfony Scaleway TEM mailer
 
+[![Latest Version on Packagist](https://img.shields.io/packagist/v/korridor/symfony-scaleway-tem-mailer?style=flat-square)](https://packagist.org/packages/korridor/symfony-scaleway-tem-mailer)
+[![License](https://img.shields.io/packagist/l/korridor/symfony-scaleway-tem-mailer?style=flat-square)](license.md)
+[![Supported PHP versions](https://img.shields.io/packagist/php-v/korridor/symfony-scaleway-tem-mailer?style=flat-square)](https://packagist.org/packages/korridor/symfony-scaleway-tem-mailer)
+
 ## Installation
 
 You can install the package via composer with following command:
@@ -8,11 +12,63 @@ You can install the package via composer with following command:
 composer require korridor/symfony-scaleway-tem-mailer
 ```
 
+### Requirements
+
+This package is tested for the following Laravel and PHP versions:
+
+- 9.* (PHP 8.1)
+
 ## Usage examples
 
 ### Laravel
 
-TODO
+Add the following code to the `AppServiceProvider`:
+
+```php
+use Korridor\SymfonyScalewayTemMailer\Transport\ScalewayApiTransport;
+use Korridor\SymfonyScalewayTemMailer\Transport\ScalewaySmtpTransport;
+
+    // ..
+
+    /**
+     * Bootstrap any application services.
+     *
+     * @return void
+     */
+    public function boot(): void
+    {
+        // ...
+        Mail::extend('scaleway-api', function (array $config = []) {
+            return new ScalewayApiTransport($config['token'], $config['region'], $config['project_id']);
+        });
+        Mail::extend('scaleway-smtp', function (array $config = []) {
+            return new ScalewaySmtpTransport($config['token'], $config['region'], $config['project_id']);
+        }); 
+    }
+
+```
+
+Now add the following lines to the `config/mail.php` file in the `mailers` array:
+
+```php
+'scaleway' => [
+    'transport' => 'scaleway-api',
+    'region' => env('MAIL_SCALEWAY_REGION', 'fr-par'),
+    'token' => env('MAIL_SCALEWAY_TOKEN'),
+    'project_id' => env('MAIL_SCALEWAY_PROJECT_ID'),
+],
+```
+
+If you want to use the SMTP integration instead use following lines:
+
+```php
+'scaleway' => [
+    'transport' => 'scaleway-smtp',
+    'region' => env('MAIL_SCALEWAY_REGION', 'fr-par'),
+    'token' => env('MAIL_SCALEWAY_TOKEN'),
+    'project_id' => env('MAIL_SCALEWAY_PROJECT_ID'),
+],
+```
 
 ## Contributing
 
@@ -30,13 +86,18 @@ docker-compose run workspace bash
 ### Testing
 
 The `composer test` command runs all tests with [phpunit](https://phpunit.de/).
-The `composer test-coverage` command runs all tests with phpunit and creates a coverage report into the `coverage` folder.
+The `composer test-coverage` command runs all tests with phpunit and creates a coverage report into the `coverage`
+folder.
 
 ### Codeformatting/Linting
 
 The `composer fix` command formats the code with [php-cs-fixer](https://github.com/FriendsOfPHP/PHP-CS-Fixer).
 The `composer lint` command checks the code with [phpcs](https://github.com/squizlabs/PHP_CodeSniffer).
 
+## Credits
+
+The structure of the repository is inspired by the project [symfony/postmark-mailer](https://github.com/symfony/postmark-mailer).
+
 ## License
 
 This package is licensed under the MIT License (MIT). Please see [license file](license.md) for more information.

src/Transport/ScalewayApiTransport.php

@@ -1,14 +1,11 @@
 <?php
 
-namespace Symfony\Component\Mailer\Bridge\Scaleway\Transport;
+namespace Korridor\SymfonyScalewayTemMailer\Transport;
 
 use Psr\EventDispatcher\EventDispatcherInterface;
 use Psr\Log\LoggerInterface;
 use Symfony\Component\Mailer\Envelope;
 use Symfony\Component\Mailer\Exception\HttpTransportException;
-use Symfony\Component\Mailer\Exception\TransportException;
-use Symfony\Component\Mailer\Header\MetadataHeader;
-use Symfony\Component\Mailer\Header\TagHeader;
 use Symfony\Component\Mailer\SentMessage;
 use Symfony\Component\Mailer\Transport\AbstractApiTransport;
 use Symfony\Component\Mime\Address;
@@ -18,9 +15,6 @@
 use Symfony\Contracts\HttpClient\HttpClientInterface;
 use Symfony\Contracts\HttpClient\ResponseInterface;
 
-/**
- * @author Kevin Verschaeve
- */
 class ScalewayApiTransport extends AbstractApiTransport
 {
     private const HOST = 'api.scaleway.com';
@@ -29,18 +23,19 @@ class ScalewayApiTransport extends AbstractApiTransport
 
     private string $region;
 
-    private $messageStream;
+    private string $projectId;
 
-    public function __construct(string $token, string $region, HttpClientInterface $client = null, EventDispatcherInterface $dispatcher = null, LoggerInterface $logger = null)
+    public function __construct(string $token, string $region, string $projectId, HttpClientInterface $client = null, EventDispatcherInterface $dispatcher = null, LoggerInterface $logger = null)
     {
         $this->token = $token;
         $this->region = $region;
+        $this->projectId = $projectId;
         parent::__construct($client, $dispatcher, $logger);
     }
 
     public function __toString(): string
     {
-        return sprintf('scaleway+api://%s', $this->getEndpoint()).($this->messageStream ? '?message_stream='.$this->messageStream : '');
+        return sprintf('scaleway+api://%s', $this->getEndpoint());
     }
 
     protected function doSendApi(SentMessage $sentMessage, Email $email, Envelope $envelope): ResponseInterface
@@ -63,10 +58,10 @@ protected function doSendApi(SentMessage $sentMessage, Email $email, Envelope $e
         }
 
         if (200 !== $statusCode) {
-            throw new HttpTransportException('Unable to send an email: '.$result['Message'].sprintf(' (code %d).', $result['ErrorCode']), $response);
+            throw new HttpTransportException('Unable to send an email: '.$result['message'].' Details: '.print_r($result, true), $response);
         }
 
-        $sentMessage->setMessageId($result['MessageID']);
+        $sentMessage->setMessageId($result['id']); // TODO: what is message_id
 
         return $response;
     }
@@ -81,6 +76,7 @@ private function getPayload(Email $email, Envelope $envelope): array
             'subject' => $email->getSubject(),
             'text' => $email->getTextBody(),
             'html' => $email->getHtmlBody(),
+            'project_id' => $this->projectId,
             'attachments' => $this->getAttachments($email),
         ];
 
@@ -90,36 +86,7 @@ private function getPayload(Email $email, Envelope $envelope): array
                 continue;
             }
 
-            if ($header instanceof TagHeader) {
-                if (isset($payload['Tag'])) {
-                    throw new TransportException('Scaleway only allows a single tag per email.');
-                }
-
-                $payload['Tag'] = $header->getValue();
-
-                continue;
-            }
-
-            if ($header instanceof MetadataHeader) {
-                $payload['Metadata'][$header->getKey()] = $header->getValue();
-
-                continue;
-            }
-
-            if ($header instanceof MessageStreamHeader) {
-                $payload['MessageStream'] = $header->getValue();
-
-                continue;
-            }
-
-            $payload['Headers'][] = [
-                'Name' => $header->getName(),
-                'Value' => $header->getBodyAsString(),
-            ];
-        }
-
-        if (null !== $this->messageStream && !isset($payload['MessageStream'])) {
-            $payload['MessageStream'] = $this->messageStream;
+            // TODO: ?
         }
 
         return $payload;
@@ -171,23 +138,27 @@ private function getAttachments(Email $email): array
         return $attachments;
     }
 
+    /**
+     * @return string|null
+     */
     private function getEndpoint(): ?string
     {
         return ($this->host ?: self::HOST).($this->port ? ':'.$this->port : '');
     }
 
+    /**
+     * @return string
+     */
     private function getRegion(): string
     {
         return $this->region;
     }
 
     /**
-     * @return $this
+     * @return string
      */
-    public function setMessageStream(string $messageStream): static
+    public function getProjectId(): string
     {
-        $this->messageStream = $messageStream;
-
-        return $this;
+        return $this->projectId;
     }
 }

src/Transport/ScalewaySmtpTransport.php

@@ -1,33 +1,34 @@
 <?php
 
-namespace Symfony\Component\Mailer\Bridge\Scaleway\Transport;
+namespace Korridor\SymfonyScalewayTemMailer\Transport;
 
 use Psr\EventDispatcher\EventDispatcherInterface;
 use Psr\Log\LoggerInterface;
 use Symfony\Component\Mailer\Envelope;
-use Symfony\Component\Mailer\Exception\TransportException;
-use Symfony\Component\Mailer\Header\MetadataHeader;
-use Symfony\Component\Mailer\Header\TagHeader;
 use Symfony\Component\Mailer\SentMessage;
 use Symfony\Component\Mailer\Transport\Smtp\EsmtpTransport;
 use Symfony\Component\Mime\Message;
 use Symfony\Component\Mime\RawMessage;
 
-/**
- * @author Kevin Verschaeve
- */
 class ScalewaySmtpTransport extends EsmtpTransport
 {
-    private $messageStream;
-
     private const HOSTNAME = 'smtp.tem.scw.cloud';
 
-    public function __construct(string $id, EventDispatcherInterface $dispatcher = null, LoggerInterface $logger = null)
+    private string $token;
+
+    private string $region;
+
+    private string $projectId;
+
+    public function __construct(string $token, string $region, string $projectId, EventDispatcherInterface $dispatcher = null, LoggerInterface $logger = null)
     {
+        $this->token = $token;
+        $this->region = $region;
+        $this->projectId = $projectId;
         parent::__construct(self::HOSTNAME, 587, false, $dispatcher, $logger);
 
-        $this->setUsername($id);
-        $this->setPassword($id);
+        $this->setUsername($projectId);
+        $this->setPassword($token);
     }
 
     public function send(RawMessage $message, Envelope $envelope = null): ?SentMessage
@@ -47,12 +48,26 @@ private function addScalewayHeaders(Message $message): void
     }
 
     /**
-     * @return $this
+     * @return string
      */
-    public function setMessageStream(string $messageStream): static
+    public function getToken(): string
     {
-        $this->messageStream = $messageStream;
+        return $this->token;
+    }
 
-        return $this;
+    /**
+     * @return string
+     */
+    public function getRegion(): string
+    {
+        return $this->region;
+    }
+
+    /**
+     * @return string
+     */
+    public function getProjectId(): string
+    {
+        return $this->projectId;
     }
 }