symfony · fabpot · Dec 2, 2022 · Nov 29, 2022
diff --git a/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php b/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php
@@ -127,6 +127,7 @@
 use Symfony\Component\Mime\MimeTypes;
 use Symfony\Component\Notifier\Bridge\AllMySms\AllMySmsTransportFactory;
 use Symfony\Component\Notifier\Bridge\AmazonSns\AmazonSnsTransportFactory;
+use Symfony\Component\Notifier\Bridge\Bandwidth\BandwidthTransportFactory;
 use Symfony\Component\Notifier\Bridge\Chatwork\ChatworkTransportFactory;
 use Symfony\Component\Notifier\Bridge\Clickatell\ClickatellTransportFactory;
 use Symfony\Component\Notifier\Bridge\ContactEveryone\ContactEveryoneTransportFactory;
@@ -2548,6 +2549,7 @@ private function registerNotifierConfiguration(array $config, ContainerBuilder $
         $classToServices = [
             AllMySmsTransportFactory::class => 'notifier.transport_factory.all-my-sms',
             AmazonSnsTransportFactory::class => 'notifier.transport_factory.amazon-sns',
+            BandwidthTransportFactory::class => 'notifier.transport_factory.bandwidth',
             ChatworkTransportFactory::class => 'notifier.transport_factory.chatwork',
             ClickatellTransportFactory::class => 'notifier.transport_factory.clickatell',
             ContactEveryoneTransportFactory::class => 'notifier.transport_factory.contact-everyone',

diff --git a/src/Symfony/Bundle/FrameworkBundle/Resources/config/notifier_transports.php b/src/Symfony/Bundle/FrameworkBundle/Resources/config/notifier_transports.php
@@ -13,6 +13,7 @@
 
 use Symfony\Component\Notifier\Bridge\AllMySms\AllMySmsTransportFactory;
 use Symfony\Component\Notifier\Bridge\AmazonSns\AmazonSnsTransportFactory;
+use Symfony\Component\Notifier\Bridge\Bandwidth\BandwidthTransportFactory;
 use Symfony\Component\Notifier\Bridge\Chatwork\Chat
10000
workTransportFactory;
 use Symfony\Component\Notifier\Bridge\Clickatell\ClickatellTransportFactory;
 use Symfony\Component\Notifier\Bridge\ContactEveryone\ContactEveryoneTransportFactory;
@@ -287,5 +288,9 @@
         ->parent('notifier.transport_factory.abstract')
         ->tag('chatter.transport_factory')
 
+        ->set('notifier.transport_factory.bandwidth', BandwidthTransportFactory::class)
+            ->parent('notifier.transport_factory.abstract')
+            ->tag('texter.transport_factory')
+
     ;
 };
@@ -0,0 +1,4 @@
+/Tests export-ignore
+/phpunit.xml.dist export-ignore
+/.gitattributes export-ignore
+/.gitignore export-ignore
@@ -0,0 +1,3 @@
+vendor/
+composer.lock
+phpunit.xml
@@ -0,0 +1,140 @@
+<?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\Bandwidth;
+
+use Symfony\Component\Notifier\Message\MessageOptionsInterface;
+
+/**
+ * @author gnito-org <https://github.com/gnito-org>
+ */
+final class BandwidthOptions implements MessageOptionsInterface
+{
+    private array $options;
+
+    public function __construct(array $options = [])
+    {
+            $this->options = $options;
+    }
+
+    public function getAccountId(): ?string
+    {
+        return $this->options['account_id'] ?? null;
+    }
+
+    public function getApplicationId(): ?string
+    {
+        return $this->options['application_id'] ?? null;
+    }
+
+    public function getExpiration(): ?string
+    {
+        return $this->options['expiration'] ?? null;
+    }
+
+    public function getFrom(): ?string
+    {
+        return $this->options['from'] ?? null;
+    }
+
+    public function getMedia(): ?array
+    {
+        return $this->options['media'] ?? null;
+    }
+
+    public function getPriority(): ?string
+    {
+        return $this->options['priority'] ?? null;
+    }
+
+    public function getRecipientId(): ?string
+    {
+        return $this->options['recipient_id'] ?? null;
+    }
+
+    public function getTag(): ?string
+    {
+        return $this->options['tag'] ?? null;
+    }
+
+    public function getTo(): ?array
+    {
+        return $this->options['to'] ?? null;
+    }
+
+    public function setAccountId(string $accountId): self
+    {
+        $this->options['account_id'] = $accountId;
+
+        return $this;
+    }
+
+    public function setApplicationId(string $applicationId): self
+    {
+        $this->options['application_id'] = $applicationId;
+
+        return $this;
+    }
+
+    public function setExpiration(string $expiration): self
+    {
+        $this->options['expiration'] = $expiration;
+
+        return $this;
+    }
+
+    public function setFrom(string $from): self
+    {
+        $this->options['from'] = $from;
+
+        return $this;
+    }
+
+    public function setMedia(array $media): self
+    {
+        $this->options['media'] = $media;
+
+        return $this;
+    }
+
+    public function setPriority(string $priority): self
+    {
+        $this->options['priority'] = $priority;
+
+        return $this;
+    }
+
+    public function setRecipientId(string $id): self
+    {
+        $this->options['recipient_id'] = $id;
+
+        return $this;
+    }
+
+    public function setTag(string $tag): self
+    {
+        $this->options['tag'] = $tag;
+
+        return $this;
+    }
+
+    public function setTo(array $to): self
+    {
+        $this->options['to'] = $to;
+
+        return $this;
+    }
+
+    public function toArray(): array
+    {
+        return $this->options;
+    }
+}
@@ -0,0 +1,108 @@
+<?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\Bandwidth;
+
+use Symfony\Component\Notifier\Exception\InvalidArgumentException;
+use Symfony\Component\Notifier\Exception\TransportException;
+use Symfony\Component\Notifier\Exception\UnsupportedMessageTypeException;
+use Symfony\Component\Notifier\Message\MessageInterface;
+use Symfony\Component\Notifier\Message\SentMessage;
+use Symfony\Component\Notifier\Message\SmsMessage;
+use Symfony\Component\Notifier\Transport\AbstractTransport;
+use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
+use Symfony\Contracts\HttpClient\Exception\TransportExceptionInterface;
+use Symfony\Contracts\HttpClient\HttpClientInterface;
+
+/**
+ * @author gnito-org <https://github.com/gnito-org>
+ */
+final class BandwidthTransport extends AbstractTransport
+{
+    protected const HOST = 'messaging.bandwidth.com';
+
+    public function __construct(
+        private readonly string $username,
+        #[\SensitiveParameter] private readonly string $password,
+        private readonly string $from,
+        private readonly string $accountId,
+        private readonly string $applicationId,
+        private readonly ?string $priority,
+        HttpClientInterface $client = null,
+        EventDispatcherInterface $dispatcher = null
+    ) {
+        parent::__construct($client, $dispatcher);
+    }
+
+    public function __toString(): string
+    {
+        return sprintf('bandwidth://%s?from=%s&account_id=%s&application_id=%s', $this->getEndpoint(), $this->from, $this->accountId, $this->applicationId).($this->priority ? sprintf('&priority=%s', $this->priority) : null);
+    }
+
+    public function supports(MessageInterface $message): bool
+    {
+        return $message instanceof SmsMessage;
+    }
+
+    /**
+     * https://dev.bandwidth.com/apis/messaging/#tag/Messages/operation/createMessage.
+     */
+    protected function doSend(MessageInterface $message): SentMessage
+    {
+        if (!$message instanceof SmsMessage) {
+            throw new UnsupportedMessageTypeException(__CLASS__, SmsMessage::class, $message);
+        }
+        $opts = $message->getOptions();
+        $options = $opts ? $opts->toArray() : [];
+        $options['text'] = $message->getSubject();
+        $options['from'] = $options['from'] ?? $this->from;
+        $options['to'] = $options['to'] ?? [$message->getPhone()];
+        $options['account_id'] = $options['account_id'] ?? $this->accountId;
+        $options['applicationId'] = $options['application_id'] ?? $this->applicationId;
+        unset($options['application_id']);
+
+        if (!isset($options['priority']) && $this->priority) {
+            $options['priority'] = $this->priority;
+        }
+
+        if (!preg_match('/^\+[1-9]\d{1,14}$/', $this->from)) {
+            throw new InvalidArgumentException(sprintf('The "From" number "%s" is not a valid phone number. The number must be in E.164 format.', $this->from));
+        }
+
+        if (!preg_match('/^\+[1-9]\d{1,14}$/', $message->getPhone())) {
+            throw new InvalidArgumentException(sprintf('The "To" number "%s" is not a valid phone number. The number must be in E.164 format.', $message->getPhone()));
+        }
+        $endpoint = sprintf('https://%s/api/v2/users/%s/messages', $this->getEndpoint(), $options['account_id']);
+        unset($options['accountId']);
+
+        $response = $this->client->request('POST', $endpoint, [
+            'auth_basic' => $this->username.':'.$this->password,
+            'json' => array_filter($options),
+        ]);
+
+        try {
+            $statusCode = $response->getStatusCode();
+        } catch (TransportExceptionInterface $e) {
+            throw new TransportException('Could not reach the remote Bandwidth server.', $response, 0, $e);
+        }
+
+        if (202 !== $statusCode) {
+            $error = $response->toArray(false);
+            throw new TransportException(sprintf('Unable to send the SMS - "%s" - "%s".', $error['type'], $error['description']), $response);
+        }
+
+        $success = $response->toArray(false);
+        $sentMessage = new SentMessage($message, (string) $this);
+        $sentMessage->setMessageId($success['id']);
+
+        return $sentMessage;
+    }
+}
@@ -0,0 +1,49 @@
+<?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\Bandwidth;
+
+use Symfony\Component\Notifier\Exception\UnsupportedSchemeException;
+use Symfony\Component\Notifier\Transport\AbstractTransportFactory;
+use Symfony\Component\Notifier\Transport\Dsn;
+
+/**
+ * @author gnito-org <https://github.com/gnito-org>
+ */
+final class BandwidthTransportFactory extends AbstractTransportFactory
+{
+    private const TRANSPORT_SCHEME = 'bandwidth';
+
+    public function create(Dsn $dsn): BandwidthTransport
+    {
+        $scheme = $dsn->getScheme();
+
+        if (self::TRANSPORT_SCHEME !== $scheme) {
+            throw new UnsupportedSchemeException($dsn, self::TRANSPORT_SCHEME, $this->getSupportedSchemes());
+        }
+
+        $username = $this->getUser($dsn);
+        $password = $this->getPassword($dsn);
+        $from = $dsn->getRequiredOption('from');
+        $accountId = $dsn->getRequiredOption('account_id');
+        $applicationId = $dsn->getRequiredOption('application_id');
+        $priority = $dsn->getOption('priority');
+        $host = 'default' === $dsn->getHost() ? null : $dsn->getHost();
+        $port = $dsn->getPort();
+
+        return (new BandwidthTransport($username, $password, $from, $accountId, $applicationId, $priority, $this->client, $this->dispatcher))->setHost($host)->setPort($port);
+    }
+
+    protected function getSupportedSchemes(): array
+    {
+        return [self::TRANSPORT_SCHEME];
+    }
+}
@@ -0,0 +1,7 @@
+CHANGELOG
+=========
+
+6.3
+---
+
+* Add the bridge
@@ -0,0 +1,19 @@
+Copyright (c) 2022 Fabien Potencier
+
+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:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
@@ -0,0 +1,28 @@
+Bandwidth Notifier
+==================
+
+Provides [Bandwidth](https://www.bandwidth.com) integration for Symfony Notifier.
+
+DSN example
+-----------
+
+```
+BANDWIDTH_DSN=bandwidth://USERNAME:PASSWORD@default?from=FROM&account_id=ACCOUNT_ID&application_id=APPLICATION_ID&priority=PRIORITY
+```
+
+where:
+
+- `USERNAME` is your Bandwidth username
+- `PASSWORD` is your Bandwidth password
+- `FROM` is your sender
+- `ACCOUNT_ID` is your account ID
+- `APPLICATION_ID` is your application ID
+- `PRIORITY` is your priority (optional)
+
+Resources
+---------
+
+* [Contributing](https://symfony.com/doc/current/contributing/index.html)
+* [Report issues](https://github.com/symfony/symfony/issues) and
+  [send Pull Requests](https://github.com/symfony/symfony/pulls)
+  in the [main Symfony repository](https://github.com/symfony/symfony)