feature #48573 [Notifier] Add SMS options to Clickatell notifier (gnito-org)

This PR was merged into the 6.3 branch.

Discussion
----------

[Notifier] Add SMS options to Clickatell notifier

| Q             | A
| ------------- | ---
| Branch?       | 6.3
| Bug fix?      | no
| New feature?  | yes
| Deprecations? | no <!-- please update UPGRADE-*.md and src/**/CHANGELOG.md files -->
| Tickets       |
| License       | MIT
| Doc PR        | N/A
<!--
Replace this notice by a short README for your feature/bugfix.
This will help reviewers and should be a good start for the documentation.

Additionally (see https://symfony.com/releases):
 - Always add tests and ensure they pass.
 - Bug fixes must be submitted against the lowest maintained branch where they apply
   (lowest branches are regularly merged to upper ones so they get the fixes too).
 - Features and deprecations must be submitted against the latest branch.
 - For new features, provide some code snippets to help understand usage.
 - Changelog entry should follow https://symfony.com/doc/current/contributing/code/conventions.html#writing-a-changelog-entry
 - Never break backward compatibility (see https://symfony.com/bc).
-->

Commits
-------

1dc0bc4328 [Notifier] Add SMS options to Clickatell notifier

Author: nicolas-grekas

CHANGELOG.md

@@ -1,6 +1,11 @@
 CHANGELOG
 =========
 
+6.3
+---
+
+ * Add `ClickatellOptions` class
+
 6.2
 ---
 

ClickatellOptions.php

@@ -0,0 +1,61 @@
+<?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\Notifier\Bridge\Clickatell;
+
+use Symfony\Component\Notifier\Message\MessageOptionsInterface;
+
+/**
+ * @author gnito-org <https://github.com/gnito-org>
+ */
+final class ClickatellOptions implements MessageOptionsInterface
+{
+    private array $options;
+
+    public function __construct(array $options = [])
+    {
+        $this->options = $options;
+    }
+
+    public function getFrom(): ?string
+    {
+        return $this->options['from'] ?? null;
+    }
+
+    public function getRecipientId(): ?string
+    {
+        return $this->options['recipient_id'] ?? null;
+    }
+
+    public function setFrom(string $from): self
+    {
+        $this->options['from'] = $from;
+
+        return $this;
+    }
+
+    public function setRecipientId(string $id): self
+    {
+        $this->options['recipient_id'] = $id;
+
+        return $this;
+    }
+
+    public function toArray(): array
+    {
+        $options = $this->options;
+        if (isset($options['recipient_id'])) {
+            unset($options['recipient_id']);
+        }
+
+        return $options;
+    }
+}

ClickatellTransport.php

@@ -50,7 +50,7 @@ public function __toString(): string
 
     public function supports(MessageInterface $message): bool
     {
-        return $message instanceof SmsMessage;
+        return $message instanceof SmsMessage && (null === $message->getOptions() || $message->getOptions() instanceof ClickatellOptions);
     }
 
     protected function doSend(MessageInterface $message): SentMessage
@@ -61,7 +61,13 @@ protected function doSend(MessageInterface $message): SentMessage
 
         $endpoint = sprintf('https://%s/rest/message', $this->getEndpoint());
 
-        $from = $message->getFrom() ?: $this->from;
+        $from = $message->getFrom() ?: $this->from ?: '';
+
+        $opts = $message->getOptions();
+        $options = $opts ? $opts->toArray() : [];
+        $options['from'] = $options['from'] ?? $from;
+        $options['to'] = $message->getPhone();
+        $options['text'] = $message->getSubject();
 
         $response = $this->client->request('POST', $endpoint, [
             'headers' => [
@@ -70,11 +76,7 @@ protected function doSend(MessageInterface $message): SentMessage
                 'Content-Type' => 'application/json',
                 'X-Version' => 1,
             ],
-            'json' => [
-                'from' => $from ?? '',
-                'to' => [$message->getPhone()],
-                'text' => $message->getSubject(),
-            ],
+            'json' => array_filter($options),
         ]);
 
         try {

Tests/ClickatellOptionsTest.php

@@ -0,0 +1,25 @@
+<?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\Notifier\Bridge\Clickatell\Tests;
+
+use PHPUnit\Framework\TestCase;
+use Symfony\Component\Notifier\Bridge\Clickatell\ClickatellOptions;
+
+class ClickatellOptionsTest extends TestCase
+{
+    public function testClickatellOptions()
+    {
+        $clickatellOptions = (new ClickatellOptions())->setFrom('test_from')->setRecipientId('test_recipient');
+
+        self::assertSame(['from' => 'test_from'], $clickatellOptions->toArray());
+    }
+}

Tests/ClickatellTransportTest.php

@@ -12,6 +12,7 @@
 namespace Symfony\Component\Notifier\Bridge\Clickatell\Tests;
 
 use Symfony\Component\HttpClient\MockHttpClient;
+use Symfony\Component\Notifier\Bridge\Clickatell\ClickatellOptions;
 use Symfony\Component\Notifier\Bridge\Clickatell\ClickatellTransport;
 use Symfony\Component\Notifier\Exception\LogicException;
 use Symfony\Component\Notifier\Exception\TransportException;
@@ -39,6 +40,7 @@ public static function toStringProvider(): iterable
     public static function supportedMessagesProvider(): iterable
     {
         yield [new SmsMessage('+33612345678', 'Hello!')];
+        yield [new SmsMessage('+33612345678', 'Hello!', 'from', new ClickatellOptions(['from' => 'foo']))];
     }
 
     public static function unsupportedMessagesProvider(): iterable