8000 feature #34654 [Notifier] added Sinch texter transport (imiroslavov) · symfony/symfony@2b68d53 · GitHub
[go: up one dir, main page]
Skip to content

Commit 2b68d53

Browse files
fabpotfabpot
committed
feature #34654 [Notifier] added Sinch texter transport (imiroslavov)
This PR was squashed before being merged into the 5.1-dev branch. Discussion ---------- [Notifier] added Sinch texter transport | Q | A | ------------- | --- | Branch? | master | Bug fix? | no | New feature? | yes | Deprecations? | no | Tickets | n/a | License | MIT | Doc PR | n/a This PR adds adapter for Sinch messaging gateway to the texter transport. Example configuration: `sinch://SID:TOKEN@default?from=PHONE` Commits ------- db6d360 [Notifier] added Sinch texter transport
2 parents 9acb060 + db6d360 commit 2b68d53

File tree

12 files changed

+242
-0
lines changed

12 files changed

+242
-0
lines changed

‎src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -95,6 +95,7 @@
9595
use Symfony\Component\Notifier\Bridge\Nexmo\NexmoTransportFactory;
9696
use Symfony\Component\Notifier\Bridge\OvhCloud\OvhCloudTransportFactory;
9797
use Symfony\Component\Notifier\Bridge\RocketChat\RocketChatTransportFactory;
98+
use Symfony\Component\Notifier\Bridge\Sinch\SinchTransportFactory;
9899
use Symfony\Component\Notifier\Bridge\Slack\SlackTransportFactory;
99100
use Symfony\Component\Notifier\Bridge\Telegram\TelegramTransportFactory;
100101
use Symfony\Component\Notifier\Bridge\Twilio\TwilioTransportFactory;
@@ -2007,6 +2008,7 @@ private function registerNotifierConfiguration(array $config, ContainerBuilder $
20072008
TwilioTransportFactory::class => 'notifier.transport_factory.twilio',
20082009
FirebaseTransportFactory::class => 'notifier.transport_factory.firebase',
20092010
OvhCloudTransportFactory::class => 'notifier.transport_factory.ovhcloud',
2011+
SinchTransportFactory::class => 'notifier.transport_factory.sinch',
20102012
];
20112013

20122014
foreach ($classToServices as $class => $service) {

‎src/Symfony/Bundle/FrameworkBundle/Resources/config/notifier_transports.xml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,10 @@
4242
<tag name="texter.transport_factory" />
4343
</service>
4444

45+
<service id="notifier.transport_factory.sinch" class="Symfony\Component\Notifier\Bridge\Sinch\SinchTransportFactory" parent="notifier.transport_factory.abstract">
46+
<tag name="texter.transport_factory" />
47+
</service>
48+
4549
<service id="notifier.transport_factory.null" class="Symfony\Component\Notifier\Transport\NullTransportFactory" parent="notifier.transport_factory.abstract">
4650
<tag name="notifier.transport_factory" />
4751
</service>

‎src/Symfony/Component/Notifier/Bridge/Sinch/.gitattributes

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
/Tests export-ignore
2+
/phpunit.xml.dist export-ignore
3+
/.gitignore export-ignore

‎src/Symfony/Component/Notifier/Bridge/Sinch/CHANGELOG.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
CHANGELOG
2+
=========
3+
4+
5.1
5+
-----
6+
7+
* Added the bridge

‎src/Symfony/Component/Notifier/Bridge/Sinch/LICENSE

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
Copyright (c) 2019 Fabien Potencier
2+
3+
Permission is hereby granted, free of charge, to any person obtaining a copy
4+
of this software and associated documentation files (the "Software"), to deal
5+
in the Software without restriction, including without limitation the rights
6+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
7+
copies of the Software, and to permit persons to whom the Software is furnished
8+
to do so, subject to the following conditions:
9+
10+
The above copyright notice and this permission notice shall be included in all
11+
copies or substantial portions of the Software.
12+
13+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
14+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
15+
FITNESS FOR A PARTICULAR PURPOSE AND NO F438 NINFRINGEMENT. IN NO EVENT SHALL THE
16+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
17+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
18+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
19+
THE SOFTWARE.

‎src/Symfony/Component/Notifier/Bridge/Sinch/README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
Sinch Notifier
2+
==============
3+
4+
Provides Sinch integration for Symfony Notifier.
5+
6+
Resources
7+
---------
8+
9+
* [Contributing](https://symfony.com/doc/current/contributing/index.html)
10+
* [Report issues](https://github.com/symfony/symfony/issues) and
11+
[send Pull Requests](https://github.com/symfony/symfony/pulls)
12+
in the [main Symfony repository](https://github.com/symfony/symfony)

‎src/Symfony/Component/Notifier/Bridge/Sinch/SinchTransport.php

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
<?php
2+
3+
/*
4+
* This file is part of the Symfony package.
5+
*
6+
* (c) Fabien Potencier <fabien@symfony.com>
7+
*
8+
* For the full copyright and license information, please view the LICENSE
9+
* file that was distributed with this source code.
10+
*/
11+
12+
namespace Symfony\Component\Notifier\Bridge\Sinch;
13+
14+
use Symfony\Component\Notifier\Exception\LogicException;
15+
use Symfony\Component\Notifier\Exception\TransportException;
16+
use Symfony\Component\Notifier\Message\MessageInterface;
17+
use Symfony\Component\Notifier\Message\SmsMessage;
18+
use Symfony\Component\Notifier\Transport\AbstractTransport;
19+
use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
20+
use Symfony\Contracts\HttpClient\HttpClientInterface;
21+
22+
/**
23+
* @author Iliya Miroslavov Iliev <i.miroslavov@gmail.com>
24+
*
25+
* @experimental in 5.1
26+
*/
27+
final class SinchTransport extends AbstractTransport
28+
{
29+
protected const HOST = 'sms.api.sinch.com';
30+
31+
private $accountSid;
32+
private $authToken;
33+
private $from;
34+
35+
public function __construct(string $accountSid, string $authToken, string $from, HttpClientInterface $client = null, EventDispatcherInterface $dispatcher = null)
36+
{
37+
$this->accountSid = $accountSid;
38+
$this->authToken = $authToken;
39+
$this->from = $from;
40+
41+
parent::__construct($client, $dispatcher);
42+
}
43+
44+
public function __toString(): string
45+
{
46+
return sprintf('sinch://%s?from=%s', $this->getEndpoint(), $this->from);
47+
}
48+
49+
public function supports(MessageInterface $message): bool
50+
{
51+
return $message instanceof SmsMessage;
52+
}
53+
54+
protected function doSend(MessageInterface $message): void
55+
{
56+
if (!$message instanceof SmsMessage) {
57+
throw new LogicException(sprintf('The "%s" transport only supports instances of "%s" (instance of "%s" given).', __CLASS__, SmsMessage::class, \get_class($message)));
58+
}
59+
60+
$endpoint = sprintf('https://%s/xms/v1/%s/batches', $this->getEndpoint(), $this->accountSid);
61+
$response = $this->client->request('POST', $endpoint, [
62+
'auth_bearer' => $this->authToken,
63+
'json' => [
64+
'from' => $this->from,
65+
'to' => [$message->getPhone()],
66+
'body' => $message->getSubject(),
67+
],
68+
]);
69+
70+
if (201 !== $response->getStatusCode()) {
71+
$error = $response->toArray(false);
72+
73+
throw new TransportException(sprintf('Unable to send the SMS: %s (%s).', $error['text'], $error['code']), $response);
74+
}
75+
}
76+
}

‎src/Symfony/Component/Notifier/Bridge/Sinch/SinchTransportFactory.php

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
<?php
2+
3+
/*
4+
* This file is part of the Symfony package.
5+
*
6+
* (c) Fabien Potencier <fabien@symfony.com>
7+
*
8+
* For the full copyright and license information, please view the LICENSE
9+
* file that was distributed with this source code.
10+
*/
11+
12+
namespace Symfony\Component\Notifier\Bridge\Sinch;
13+
14+
use Symfony\Component\Notifier\Exception\UnsupportedSchemeException;
15+
use Symfony\Component\Notifier\Transport\AbstractTransportFactory;
16+
use Symfony\Component\Notifier\Transport\Dsn;
17+
use Symfony\Component\Notifier\Transport\TransportInterface;
18+
19+
/**
20+
* @author Iliya Miroslavov Iliev <i.miroslavov@gmail.com>
21+
*
22+
* @experimental in 5.1
23+
*/
24+
final class SinchTransportFactory extends AbstractTransportFactory
25+
{
26+
public function create(Dsn $dsn): TransportInterface
27+
{
28+
$scheme = $dsn->getScheme();
29+
$accountSid = $this->getUser($dsn);
30+
$authToken = $this->getPassword($dsn);
31+
$from = $dsn->getOption('from');
32+
$host = 'default' === $dsn->getHost() ? null : $dsn->getHost();
33+
$port = $dsn->getPort();
34+
35+
if ('sinch' === $scheme) {
36+
return (new SinchTransport($accountSid, $authToken, $from, $this->client, $this->dispatcher))->setHost($host)->setPort($port);
37+
}
38+
39+
throw new UnsupportedSchemeException($dsn, 'sinch', $this->getSupportedSchemes());
40+
}
41+
42+
protected function getSupportedSchemes(): array
43+
{
44+
return ['sinch'];
45+
}
46+
}

‎src/Symfony/Component/Notifier/Bridge/Sinch/composer.json

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
{
2+
"name": "symfony/sinch-notifier",
3+
"type": "symfony-bridge",
4+
"description": "Symfony Sinch Notifier Bridge",
5+
"keywords": ["sms", "sinch", "notifier"],
6+
"homepage": "https://symfony.com",
7+
"license": "MIT",
8+
"authors": [
9+
{
10+
"name": "Fabien Potencier",
11+
"email": "fabien@symfony.com"
12+
},
13+
{
14+
"name": "Symfony Community",
15+
"homepage": "https://symfony.com/contributors"
16+
}
17+
],
18+
"require": {
19+
"php": "^7.2.5",
20+
"ext-json": "*",
21+
"symfony/http-client": "^4.3|^5.0",
22+
"symfony/notifier": "^5.0"
23+
},
24+
"autoload": {
25+
"psr-4": { "Symfony\\Component\\Notifier\\Bridge\\Sinch\\": "" },
26+
"exclude-from-classmap": [
27+
"/Tests/"
28+
]
29+
},
30+
"minimum-stability": "dev",
31+
"extra": {
32+
"branch-alias": {
33+
"dev-master": "5.1-dev"
34+
}
35+
}
36+
}

‎src/Symfony/Component/Notifier/Bridge/Sinch/phpunit.xml.dist

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
3+
<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
4+
xsi:noNamespaceSchemaLocation="http://schema.phpunit.de/5.2/phpunit.xsd"
5+
backupGlobals="false"
6+
colors="true"
7+
bootstrap="vendor/autoload.php"
8+
failOnRisky="true"
9+
failOnWarning="true"
10+
>
11+
<php>
12+
<ini name="error_reporting" value="-1" />
13+
</php>
14+
15+
<testsuites>
16+
<testsuite name="Symfony Sinch Notifier Bridge Test Suite">
17+
<directory>./Tests/</directory>
18+
</testsuite>
19+
</testsuites>
20+
21+
<filter>
22+
<whitelist>
23+
<directory>./</directory>
24+
<exclude>
25+
<directory>./Resources</directory>
26+
<directory>./Tests</directory>
27+
<directory>./vendor</directory>
28+
</exclude>
29+
</whitelist>
30+
</filter>
31+
</phpunit>

‎src/Symfony/Component/Notifier/Exception/UnsupportedSchemeException.php

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,10 @@ class UnsupportedSchemeException extends LogicException
5454
'class' => Bridge\OvhCloud\OvhCloudTransportFactory::class,
5555
'package' => 'symfony/ovhcloud-notifier',
5656
],
57+
'sinch' => [
58+
'class' => Bridge\Sinch\SinchTransportFactory::class,
59+
'package' => 'symfony/sinch-notifier',
60+
],
5761
];
5862

5963
/**

‎src/Symfony/Component/Notifier/Transport.php

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@
1616
use Symfony\Component\Notifier\Bridge\Nexmo\NexmoTransportFactory;
1717
use Symfony\Component\Notifier\Bridge\OvhCloud\OvhCloudTransportFactory;
1818
use Symfony\Component\Notifier\Bridge\RocketChat\RocketChatTransportFactory;
19+
use Symfony\Component\Notifier\Bridge\Sinch\SinchTransportFactory;
1920
use Symfony\Component\Notifier\Bridge\Slack\SlackTransportFactory;
2021
use Symfony\Component\Notifier\Bridge\Telegram\TelegramTransportFactory;
2122
use Symfony\Component\Notifier\Bridge\Twilio\TwilioTransportFactory;
@@ -46,6 +47,7 @@ class Transport
4647
TwilioTransportFactory::class,
4748
OvhCloudTransportFactory::class,
4849
FirebaseTransportFactory::class,
50+
SinchTransportFactory::class,
4951
];
5052

5153
private $factories;

0 commit comments

Comments
 (0)
0