[Notifier] add Vonage bridge to replace the Nexmo one

nicolas-grekas · nicolas-grekas · commit 24d09dba5578 · 2021-11-25T12:29:30.000+01:00
diff --git a/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php b/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php
@@ -157,6 +157,7 @@
 use Symfony\Component\Notifier\Bridge\Telnyx\TelnyxTransportFactory;
 use Symfony\Component\Notifier\Bridge\TurboSms\TurboSmsTransport;
 use Symfony\Component\Notifier\Bridge\Twilio\TwilioTransportFactory;
+use Symfony\Component\Notifier\Bridge\Vonage\VonageTransportFactory;
 use Symfony\Component\Notifier\Bridge\Yunpian\YunpianTransportFactory;
 use Symfony\Component\Notifier\Bridge\Zulip\ZulipTransportFactory;
 use Symfony\Component\Notifier\Notifier;
@@ -2540,6 +2541,7 @@ private function registerNotifierConfiguration(array $config, ContainerBuilder $
             TelnyxTransportFactory::class => 'notifier.transport_factory.telnyx',
             TurboSmsTransport::class => 'notifier.transport_factory.turbo-sms',
             TwilioTransportFactory::class => 'notifier.transport_factory.twilio',
+            VonageTransportFactory::class => 'notifier.transport_factory.vonage',
             YunpianTransportFactory::class => 'notifier.transport_factory.yunpian',
             ZulipTransportFactory::class => 'notifier.transport_factory.zulip',
         ];
diff --git a/src/Symfony/Bundle/FrameworkBundle/Resources/config/notifier_transports.php b/src/Symfony/Bundle/FrameworkBundle/Resources/config/notifier_transports.php
@@ -52,6 +52,7 @@
 use Symfony\Component\Notifier\Bridge\Telnyx\TelnyxTransportFactory;
 use Symfony\Component\Notifier\Bridge\TurboSms\TurboSmsTransportFactory;
 use Symfony\Component\Notifier\Bridge\Twilio\TwilioTransportFactory;
+use Symfony\Component\Notifier\Bridge\Vonage\VonageTransportFactory;
 use Symfony\Component\Notifier\Bridge\Yunpian\YunpianTransportFactory;
 use Symfony\Component\Notifier\Bridge\Zulip\ZulipTransportFactory;
 use Symfony\Component\Notifier\Transport\AbstractTransportFactory;
@@ -109,6 +110,11 @@
         ->set('notifier.transport_factory.nexmo', NexmoTransportFactory::class)
             ->parent('notifier.transport_factory.abstract')
             ->tag('texter.transport_factory')
+            ->deprecate('symfony/framework-bundle', '5.4', 'The "%service_id% service is deprecated, use "notifier.transport_factory.vonage" instead.')
+
+        ->set('notifier.transport_factory.vonage', VonageTransportFactory::class)
+            ->parent('notifier.transport_factory.abstract')
+            ->tag('texter.transport_factory')
 
         ->set('notifier.transport_factory.rocket-chat', RocketChatTransportFactory::class)
             ->parent('notifier.transport_factory.abstract')
diff --git a/src/Symfony/Component/Notifier/Bridge/Nexmo/NexmoTransport.php b/src/Symfony/Component/Notifier/Bridge/Nexmo/NexmoTransport.php
@@ -11,6 +11,8 @@
 
 namespace Symfony\Component\Notifier\Bridge\Nexmo;
 
+trigger_deprecation('symfony/nexmo-notifier', '5.4', 'The "symfony/nexmo-notifier" package is deprecated, use "symfony/vonage-notifier" instead.');
+
 use Symfony\Component\Notifier\Exception\TransportException;
 use Symfony\Component\Notifier\Exception\UnsupportedMessageTypeException;
 use Symfony\Component\Notifier\Message\MessageInterface;
@@ -23,6 +25,8 @@
 
 /**
  * @author Fabien Potencier <fabien@symfony.com>
+ *
+ * @deprecated since Symfony 5.4, use the Vonage bridge instead.
  */
 final class NexmoTransport extends AbstractTransport
 {
diff --git a/src/Symfony/Component/Notifier/Bridge/Nexmo/NexmoTransportFactory.php b/src/Symfony/Component/Notifier/Bridge/Nexmo/NexmoTransportFactory.php
@@ -18,6 +18,8 @@
 
 /**
  * @author Fabien Potencier <fabien@symfony.com>
+ *
+ * @deprecated since Symfony 5.4, use the Vonage bridge instead.
  */
 final class NexmoTransportFactory extends AbstractTransportFactory
 {
diff --git a/src/Symfony/Component/Notifier/Bridge/Nexmo/README.md b/src/Symfony/Component/Notifier/Bridge/Nexmo/README.md
@@ -1,19 +1,7 @@
 Nexmo Notifier
 ==============
 
-Provides [Nexmo](https://nexmo.com) integration for Symfony Notifier.
-
-DSN example
------------
-
-```
-NEXMO_DSN=nexmo://KEY:SECRET@default?from=FROM
-```
-
-where:
- - `KEY` is your Nexmo key
- - `SECRET` is your Nexmo secret
- - `FROM` is your sender
+The Nexmo is deprecated, use the Vonage bridge instead.
 
 Resources
 ---------
diff --git a/src/Symfony/Component/Notifier/Bridge/Nexmo/Tests/NexmoTransportFactoryTest.php b/src/Symfony/Component/Notifier/Bridge/Nexmo/Tests/NexmoTransportFactoryTest.php
@@ -15,6 +15,9 @@
 use Symfony\Component\Notifier\Test\TransportFactoryTestCase;
 use Symfony\Component\Notifier\Transport\TransportFactoryInterface;
 
+/**
+ * @group legacy
+ */
 final class NexmoTransportFactoryTest extends TransportFactoryTestCase
 {
     /**
diff --git a/src/Symfony/Component/Notifier/Bridge/Nexmo/Tests/NexmoTransportTest.php b/src/Symfony/Component/Notifier/Bridge/Nexmo/Tests/NexmoTransportTest.php
@@ -19,6 +19,9 @@
 use Symfony\Component\Notifier\Transport\TransportInterface;
 use Symfony\Contracts\HttpClient\HttpClientInterface;
 
+/**
+ * @group legacy
+ */
 final class NexmoTransportTest extends TransportTestCase
 {
     /**
diff --git a/src/Symfony/Component/Notifier/Bridge/Nexmo/composer.json b/src/Symfony/Component/Notifier/Bridge/Nexmo/composer.json
@@ -17,6 +17,7 @@
     ],
     "require": {
         "php": ">=7.2.5",
+        "symfony/deprecation-contracts": "^2.1|^3",
         "symfony/http-client": "^4.3|^5.0|^6.0",
         "symfony/notifier": "^5.3|^6.0"
     },
diff --git a/src/Symfony/Component/Notifier/Bridge/Vonage/.gitattributes b/src/Symfony/Component/Notifier/Bridge/Vonage/.gitattributes
@@ -0,0 +1,4 @@
+/Tests export-ignore
+/phpunit.xml.dist export-ignore
+/.gitattributes export-ignore
+/.gitignore export-ignore
diff --git a/src/Symfony/Component/Notifier/Bridge/Vonage/.gitignore b/src/Symfony/Component/Notifier/Bridge/Vonage/.gitignore
@@ -0,0 +1,3 @@
+vendor/
+composer.lock
+phpunit.xml
diff --git a/src/Symfony/Component/Notifier/Bridge/Vonage/CHANGELOG.md b/src/Symfony/Component/Notifier/Bridge/Vonage/CHANGELOG.md
@@ -0,0 +1,7 @@
+CHANGELOG
+=========
+
+5.4
+---
+
+ * Add the bridge
diff --git a/src/Symfony/Component/Notifier/Bridge/Vonage/LICENSE b/src/Symfony/Component/Notifier/Bridge/Vonage/LICENSE
@@ -0,0 +1,19 @@
+Copyright (c) 2021 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.
diff --git a/src/Symfony/Component/Notifier/Bridge/Vonage/README.md b/src/Symfony/Component/Notifier/Bridge/Vonage/README.md
@@ -0,0 +1,24 @@
+Vonage Notifier
+===============
+
+Provides [Vonage](https://vonage.com) integration for Symfony Notifier.
+
+DSN example
+-----------
+
+```
+VONAGE_DSN=vonage://KEY:SECRET@default?from=FROM
+```
+
+where:
+ - `KEY` is your Vonage key
+ - `SECRET` is your Vonage secret
+ - `FROM` is your sender
+
+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)
diff --git a/src/Symfony/Component/Notifier/Bridge/Vonage/Tests/VonageTransportFactoryTest.php b/src/Symfony/Component/Notifier/Bridge/Vonage/Tests/VonageTransportFactoryTest.php
@@ -0,0 +1,52 @@
+<?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\Vonage\Tests;
+
+use Symfony\Component\Notifier\Bridge\Vonage\VonageTransportFactory;
+use Symfony\Component\Notifier\Test\TransportFactoryTestCase;
+use Symfony\Component\Notifier\Transport\TransportFactoryInterface;
+
+final class VonageTransportFactoryTest extends TransportFactoryTestCase
+{
+    /**
+     * @return VonageTransportFactory
+     */
+    public function createFactory(): TransportFactoryInterface
+    {
+        return new VonageTransportFactory();
+    }
+
+    public function createProvider(): iterable
+    {
+        yield [
+            'vonage://host.test?from=0611223344',
+            'vonage://apiKey:apiSecret@host.test?from=0611223344',
+        ];
+    }
+
+    public function supportsProvider(): iterable
+    {
+        yield [true, 'vonage://apiKey:apiSecret@default?from=0611223344'];
+        yield [false, 'somethingElse://apiKey:apiSecret@default?from=0611223344'];
+    }
+
+    public function missingRequiredOptionProvider(): iterable
+    {
+        yield 'missing option: from' => ['vonage://apiKey:apiSecret@default'];
+    }
+
+    public function unsupportedSchemeProvider(): iterable
+    {
+        yield ['somethingElse://apiKey:apiSecret@default?from=0611223344'];
+        yield ['somethingElse://apiKey:apiSecret@default']; // missing "from" option
+    }
+}
diff --git a/src/Symfony/Component/Notifier/Bridge/Vonage/Tests/VonageTransportTest.php b/src/Symfony/Component/Notifier/Bridge/Vonage/Tests/VonageTransportTest.php
@@ -0,0 +1,47 @@
+<?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\Vonage\Tests;
+
+use Symfony\Component\Notifier\Bridge\Vonage\VonageTransport;
+use Symfony\Component\Notifier\Message\ChatMessage;
+use Symfony\Component\Notifier\Message\MessageInterface;
+use Symfony\Component\Notifier\Message\SmsMessage;
+use Symfony\Component\Notifier\Test\TransportTestCase;
+use Symfony\Component\Notifier\Transport\TransportInterface;
+use Symfony\Contracts\HttpClient\HttpClientInterface;
+
+final class VonageTransportTest extends TransportTestCase
+{
+    /**
+     * @return VonageTransport
+     */
+    public function createTransport(HttpClientInterface $client = null): TransportInterface
+    {
+        return new VonageTransport('apiKey', 'apiSecret', 'sender', $client ?? $this->createMock(HttpClientInterface::class));
+    }
+
+    public function toStringProvider(): iterable
+    {
+        yield ['vonage://rest.nexmo.com?from=sender', $this->createTransport()];
+    }
+
+    public function supportedMessagesProvider(): iterable
+    {
+        yield [new SmsMessage('0611223344', 'Hello!')];
+    }
+
+    public function unsupportedMessagesProvider(): iterable
+    {
+        yield [new ChatMessage('Hello!')];
+        yield [$this->createMock(MessageInterface::class)];
+    }
+}
diff --git a/src/Symfony/Component/Notifier/Bridge/Vonage/VonageTransport.php b/src/Symfony/Component/Notifier/Bridge/Vonage/VonageTransport.php
@@ -0,0 +1,89 @@
+<?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\Vonage;
+
+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 Fabien Potencier <fabien@symfony.com>
+ */
+final class VonageTransport extends AbstractTransport
+{
+    protected const HOST = 'rest.nexmo.com';
+
+    private $apiKey;
+    private $apiSecret;
+    private $from;
+
+    public function __construct(string $apiKey, string $apiSecret, string $from, HttpClientInterface $client = null, EventDispatcherInterface $dispatcher = null)
+    {
+        $this->apiKey = $apiKey;
+        $this->apiSecret = $apiSecret;
+        $this->from = $from;
+
+        parent::__construct($client, $dispatcher);
+    }
+
+    public function __toString(): string
+    {
+        return sprintf('vonage://%s?from=%s', $this->getEndpoint(), $this->from);
+    }
+
+    public function supports(MessageInterface $message): bool
+    {
+        return $message instanceof SmsMessage;
+    }
+
+    protected function doSend(MessageInterface $message): SentMessage
+    {
+        if (!$message instanceof SmsMessage) {
+            throw new UnsupportedMessageTypeException(__CLASS__, SmsMessage::class, $message);
+        }
+
+        $response = $this->client->request('POST', 'https://'.$this->getEndpoint().'/sms/json', [
+            'body' => [
+                'from' => $this->from,
+                'to' => $message->getPhone(),
+                'text' => $message->getSubject(),
+                'api_key' => $this->apiKey,
+                'api_secret' => $this->apiSecret,
+            ],
+        ]);
+
+        try {
+            $result = $response->toArray(false);
+        } catch (TransportExceptionInterface $e) {
+            throw new TransportException('Could not reach the remote Vonage server.', $response, 0, $e);
+        }
+
+        foreach ($result['messages'] as $msg) {
+            if ($msg['status'] ?? false) {
+                throw new TransportException('Unable to send the SMS: '.$msg['error-text'].sprintf(' (code %s).', $msg['status']), $response);
+            }
+        }
+
+        $success = $response->toArray(false);
+
+        $sentMessage = new SentMessage($message, (string) $this);
+        $sentMessage->setMessageId($success['messages'][0]['message-id']);
+
+        return $sentMessage;
+    }
+}
diff --git a/src/Symfony/Component/Notifier/Bridge/Vonage/VonageTransportFactory.php b/src/Symfony/Component/Notifier/Bridge/Vonage/VonageTransportFactory.php
diff --git a/src/Symfony/Component/Notifier/Bridge/Vonage/composer.json b/src/Symfony/Component/Notifier/Bridge/Vonage/composer.json
diff --git a/src/Symfony/Component/Notifier/Bridge/Vonage/phpunit.xml.dist b/src/Symfony/Component/Notifier/Bridge/Vonage/phpunit.xml.dist
diff --git a/src/Symfony/Component/Notifier/Exception/UnsupportedSchemeException.php b/src/Symfony/Component/Notifier/Exception/UnsupportedSchemeException.php
diff --git a/src/Symfony/Component/Notifier/Tests/Exception/UnsupportedSchemeExceptionTest.php b/src/Symfony/Component/Notifier/Tests/Exception/UnsupportedSchemeExceptionTest.php
diff --git a/src/Symfony/Component/Notifier/Transport.php b/src/Symfony/Component/Notifier/Transport.php

Original file line number	Diff line number	Diff line change
`@@ -18,6 +18,8 @@`
`18`	`18`
`19`	`19`	`/**`
`20`	`20`	`* @author Fabien Potencier <[email protected]>`
	`21`	`+ *`
	`22`	`+ * @deprecated since Symfony 5.4, use the Vonage bridge instead.`
`21`	`23`	`*/`
`22`	`24`	`final class NexmoTransportFactory extends AbstractTransportFactory`
`23`	`25`	`{`
Original file line number	Diff line number	Diff line change
`@@ -15,6 +15,9 @@`
`15`	`15`	`use Symfony\Component\Notifier\Test\TransportFactoryTestCase;`
`16`	`16`	`use Symfony\Component\Notifier\Transport\TransportFactoryInterface;`
`17`	`17`
	`18`	`+/**`
	`19`	`+ * @group legacy`
	`20`	`+ */`
`18`	`21`	`final class NexmoTransportFactoryTest extends TransportFactoryTestCase`
`19`	`22`	`{`
`20`	`23`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -19,6 +19,9 @@`
`19`	`19`	`use Symfony\Component\Notifier\Transport\TransportInterface;`
`20`	`20`	`use Symfony\Contracts\HttpClient\HttpClientInterface;`
`21`	`21`
	`22`	`+/**`
	`23`	`+ * @group legacy`
	`24`	`+ */`
`22`	`25`	`final class NexmoTransportTest extends TransportTestCase`
`23`	`26`	`{`
`24`	`27`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+vendor/`
	`2`	`+composer.lock`
	`3`	`+phpunit.xml`