feature #35690 [Notifier] Add Free Mobile notifier (noniagriconomie)
This PR was merged into the 5.1-dev branch.
Discussion
----------
[Notifier] Add Free Mobile notifier
| Q | A
| ------------- | ---
| Branch? | master
| Bug fix? | no
| New feature? | yes
| Deprecations? | no
| Tickets | Implements https://github.com/symfony/symfony-docs/pull/13025#pullrequestreview-352447344
| License | MIT
| Doc PR | Will document if accepted (see **Usage** below)
## Add a new notifier (SMS) with the French Free Mobile provider.
It is a **special notifier** as it **only send the SMS to the self user**,
but I think it can be **useful for notification alerting purposes** (the way I use it already, and plan to use it with the component)
---
**Provider doc:** (🇫🇷 sorry)
https://mobile.free.fr/moncompte/index.php?page=options
<img width="716" alt="1" src="https://user-images.githubusercontent.com/13205768/74357784-b55c3500-4dc0-11ea-95ba-19ded062e800.png">
<img width="431" alt="2" src="https://user-images.githubusercontent.com/13205768/74357786-b7be8f00-4dc0-11ea-837e-b922c20e9a2e.png">
---
**Usage:**
```
// .env file
FREEMOBILE_DSN=freemobile://LOGIN:PASSWORD@default?phone=PHONE
```
where:
- `LOGIN` is your Free Mobile login
- `PASSWORD` is the token displayed in the config panel
- `PHONE` is your Free Mobile phone number
```yaml
// config/packages/notifiers.yaml file
framework:
notifier:
texter_transports:
freemobile: '%env(FREEMOBILE_DSN)%'
```
Then you can then use it like documented here https://symfony.com/doc/current/notifier/texters.html
ℹ️ As this is a special notifier, the `PHONE` provided inside the DSN mut be the same used [here](https://github.com/symfony/symfony/blob/master/src/Symfony/Component/Notifier/Message/SmsMessage.php#L31) for `$phone` value
---
Voilà!
Commits
-------
1b8709ee72
Add Free Mobile notifier
This commit is contained in:
commit
4cc605537f
@ -92,6 +92,7 @@ use Symfony\Component\Messenger\Transport\TransportInterface;
|
||||
use Symfony\Component\Mime\MimeTypeGuesserInterface;
|
||||
use Symfony\Component\Mime\MimeTypes;
|
||||
use Symfony\Component\Notifier\Bridge\Firebase\FirebaseTransportFactory;
|
||||
use Symfony\Component\Notifier\Bridge\FreeMobile\FreeMobileTransportFactory;
|
||||
use Symfony\Component\Notifier\Bridge\Mattermost\MattermostTransportFactory;
|
||||
use Symfony\Component\Notifier\Bridge\Nexmo\NexmoTransportFactory;
|
||||
use Symfony\Component\Notifier\Bridge\OvhCloud\OvhCloudTransportFactory;
|
||||
@ -2044,6 +2045,7 @@ class FrameworkExtension extends Extension
|
||||
RocketChatTransportFactory::class => 'notifier.transport_factory.rocketchat',
|
||||
TwilioTransportFactory::class => 'notifier.transport_factory.twilio',
|
||||
FirebaseTransportFactory::class => 'notifier.transport_factory.firebase',
|
||||
FreeMobileTransportFactory::class => 'notifier.transport_factory.freemobile',
|
||||
OvhCloudTransportFactory::class => 'notifier.transport_factory.ovhcloud',
|
||||
SinchTransportFactory::class => 'notifier.transport_factory.sinch',
|
||||
];
|
||||
|
@ -38,6 +38,10 @@
|
||||
<tag name="texter.transport_factory" />
|
||||
</service>
|
||||
|
||||
<service id="notifier.transport_factory.freemobile" class="Symfony\Component\Notifier\Bridge\FreeMobile\FreeMobileTransportFactory" parent="notifier.transport_factory.abstract">
|
||||
<tag name="texter.transport_factory" />
|
||||
</service>
|
||||
|
||||
<service id="notifier.transport_factory.ovhcloud" class="Symfony\Component\Notifier\Bridge\OvhCloud\OvhCloudTransportFactory" parent="notifier.transport_factory.abstract">
|
||||
<tag name="texter.transport_factory" />
|
||||
</service>
|
||||
|
3
src/Symfony/Component/Notifier/Bridge/FreeMobile/.gitattributes
vendored
Normal file
3
src/Symfony/Component/Notifier/Bridge/FreeMobile/.gitattributes
vendored
Normal file
@ -0,0 +1,3 @@
|
||||
/Tests export-ignore
|
||||
/phpunit.xml.dist export-ignore
|
||||
/.gitignore export-ignore
|
@ -0,0 +1,7 @@
|
||||
CHANGELOG
|
||||
=========
|
||||
|
||||
5.1.0
|
||||
-----
|
||||
|
||||
* Added the bridge as `@experimental`
|
@ -0,0 +1,74 @@
|
||||
<?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\FreeMobile;
|
||||
|
||||
use Symfony\Component\Notifier\Exception\LogicException;
|
||||
use Symfony\Component\Notifier\Exception\TransportException;
|
||||
use Symfony\Component\Notifier\Message\MessageInterface;
|
||||
use Symfony\Component\Notifier\Message\SmsMessage;
|
||||
use Symfony\Component\Notifier\Transport\AbstractTransport;
|
||||
use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
|
||||
use Symfony\Contracts\HttpClient\HttpClientInterface;
|
||||
|
||||
/**
|
||||
* @author Antoine Makdessi <amakdessi@me.com>
|
||||
*
|
||||
* @experimental in 5.1
|
||||
*/
|
||||
final class FreeMobileTransport extends AbstractTransport
|
||||
{
|
||||
protected const HOST = 'https://smsapi.free-mobile.fr/sendmsg';
|
||||
|
||||
private $login;
|
||||
private $password;
|
||||
private $phone;
|
||||
|
||||
public function __construct(string $login, string $password, string $phone, HttpClientInterface $client = null, EventDispatcherInterface $dispatcher = null)
|
||||
{
|
||||
$this->login = $login;
|
||||
$this->password = $password;
|
||||
$this->phone = $phone;
|
||||
|
||||
parent::__construct($client, $dispatcher);
|
||||
}
|
||||
|
||||
public function __toString(): string
|
||||
{
|
||||
return sprintf('freemobile://%s?phone=%s', $this->getEndpoint(), $this->phone);
|
||||
}
|
||||
|
||||
public function supports(MessageInterface $message): bool
|
||||
{
|
||||
return $message instanceof SmsMessage && $this->phone === $message->getPhone();
|
||||
}
|
||||
|
||||
protected function doSend(MessageInterface $message): void
|
||||
{
|
||||
if (!$this->supports($message)) {
|
||||
throw new LogicException(sprintf('The "%s" transport only supports instances of "%s" (instance of "%s" given) and configured with your phone number.', __CLASS__, SmsMessage::class, \get_class($message)));
|
||||
}
|
||||
|
||||
$response = $this->client->request('POST', $this->getEndpoint(), [
|
||||
'json' => [
|
||||
'user' => $this->login,
|
||||
'pass' => $this->password,
|
||||
'msg' => $message->getSubject(),
|
||||
],
|
||||
]);
|
||||
|
||||
if (200 !== $response->getStatusCode()) {
|
||||
$error = $response->toArray(false);
|
||||
|
||||
throw new TransportException(sprintf('Unable to send the SMS: "%s" (see "%s").', $error['message'], $error['more_info']), $response);
|
||||
}
|
||||
}
|
||||
}
|
@ -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\FreeMobile;
|
||||
|
||||
use Symfony\Component\Notifier\Exception\IncompleteDsnException;
|
||||
use Symfony\Component\Notifier\Exception\UnsupportedSchemeException;
|
||||
use Symfony\Component\Notifier\Transport\AbstractTransportFactory;
|
||||
use Symfony\Component\Notifier\Transport\Dsn;
|
||||
use Symfony\Component\Notifier\Transport\TransportInterface;
|
||||
|
||||
/**
|
||||
* @author Antoine Makdessi <amakdessi@me.com>
|
||||
*
|
||||
* @experimental in 5.1
|
||||
*/
|
||||
final class FreeMobileTransportFactory extends AbstractTransportFactory
|
||||
{
|
||||
/**
|
||||
* @return FreeMobileTransport
|
||||
*/
|
||||
public function create(Dsn $dsn): TransportInterface
|
||||
{
|
||||
$scheme = $dsn->getScheme();
|
||||
$login = $this->getUser($dsn);
|
||||
$password = $this->getPassword($dsn);
|
||||
$phone = $dsn->getOption('phone');
|
||||
|
||||
if (null === $phone || '' === $phone) {
|
||||
throw new IncompleteDsnException('Missing phone.');
|
||||
}
|
||||
|
||||
if ('freemobile' === $scheme) {
|
||||
return new FreeMobileTransport($login, $password, $phone, $this->client, $this->dispatcher);
|
||||
}
|
||||
|
||||
throw new UnsupportedSchemeException($dsn, 'freemobile', $this->getSupportedSchemes());
|
||||
}
|
||||
|
||||
protected function getSupportedSchemes(): array
|
||||
{
|
||||
return ['freemobile'];
|
||||
}
|
||||
}
|
19
src/Symfony/Component/Notifier/Bridge/FreeMobile/LICENSE
Normal file
19
src/Symfony/Component/Notifier/Bridge/FreeMobile/LICENSE
Normal file
@ -0,0 +1,19 @@
|
||||
Copyright (c) 2020 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.
|
14
src/Symfony/Component/Notifier/Bridge/FreeMobile/README.md
Normal file
14
src/Symfony/Component/Notifier/Bridge/FreeMobile/README.md
Normal file
@ -0,0 +1,14 @@
|
||||
Free Mobile Notifier
|
||||
====================
|
||||
|
||||
Provides Free Mobile integration for Symfony Notifier.
|
||||
This provider allows you to receive an SMS notification
|
||||
on your personal mobile number.
|
||||
|
||||
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)
|
@ -0,0 +1,68 @@
|
||||
<?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\FreeMobile\Tests;
|
||||
|
||||
use PHPUnit\Framework\TestCase;
|
||||
use Symfony\Component\Notifier\Bridge\FreeMobile\FreeMobileTransportFactory;
|
||||
use Symfony\Component\Notifier\Exception\IncompleteDsnException;
|
||||
use Symfony\Component\Notifier\Exception\UnsupportedSchemeException;
|
||||
use Symfony\Component\Notifier\Transport\Dsn;
|
||||
|
||||
final class FreeMobileTransportFactoryTest extends TestCase
|
||||
{
|
||||
public function testCreateWithDsn(): void
|
||||
{
|
||||
$factory = $this->initFactory();
|
||||
|
||||
$dsn = 'freemobile://login:pass@default?phone=0611223344';
|
||||
$transport = $factory->create(Dsn::fromString($dsn));
|
||||
$transport->setHost('host.test');
|
||||
|
||||
$this->assertSame('freemobile://host.test?phone=0611223344', (string) $transport);
|
||||
}
|
||||
|
||||
public function testCreateWithNoPhoneThrowsMalformed(): void
|
||||
{
|
||||
$factory = $this->initFactory();
|
||||
|
||||
$this->expectException(IncompleteDsnException::class);
|
||||
|
||||
$dsnIncomplete = 'freemobile://login:pass@default';
|
||||
$factory->create(Dsn::fromString($dsnIncomplete));
|
||||
}
|
||||
|
||||
public function testSupportsFreeMobileScheme(): void
|
||||
{
|
||||
$factory = $this->initFactory();
|
||||
|
||||
$dsn = 'freemobile://login:pass@default?phone=0611223344';
|
||||
$dsnUnsupported = 'foobarmobile://login:pass@default?phone=0611223344';
|
||||
|
||||
$this->assertTrue($factory->supports(Dsn::fromString($dsn)));
|
||||
$this->assertFalse($factory->supports(Dsn::fromString($dsnUnsupported)));
|
||||
}
|
||||
|
||||
public function testNonFreeMobileSchemeThrows(): void
|
||||
{
|
||||
$factory = $this->initFactory();
|
||||
|
||||
$this->expectException(UnsupportedSchemeException::class);
|
||||
|
||||
$dsnUnsupported = 'foobarmobile://login:pass@default?phone=0611223344';
|
||||
$factory->create(Dsn::fromString($dsnUnsupported));
|
||||
}
|
||||
|
||||
private function initFactory(): FreeMobileTransportFactory
|
||||
{
|
||||
return new FreeMobileTransportFactory();
|
||||
}
|
||||
}
|
@ -0,0 +1,54 @@
|
||||
<?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\FreeMobile\Tests;
|
||||
|
||||
use PHPUnit\Framework\TestCase;
|
||||
use Symfony\Component\Notifier\Bridge\FreeMobile\FreeMobileTransport;
|
||||
use Symfony\Component\Notifier\Exception\LogicException;
|
||||
use Symfony\Component\Notifier\Message\MessageInterface;
|
||||
use Symfony\Component\Notifier\Message\SmsMessage;
|
||||
use Symfony\Contracts\HttpClient\HttpClientInterface;
|
||||
|
||||
final class FreeMobileTransportTest extends TestCase
|
||||
{
|
||||
public function testToStringContainsProperties(): void
|
||||
{
|
||||
$transport = $this->initTransport();
|
||||
|
||||
$this->assertSame('freemobile://host.test?phone=0611223344', (string) $transport);
|
||||
}
|
||||
|
||||
public function testSupportsMessageInterface(): void
|
||||
{
|
||||
$transport = $this->initTransport();
|
||||
|
||||
$this->assertTrue($transport->supports(new SmsMessage('0611223344', 'Hello!')));
|
||||
$this->assertFalse($transport->supports(new SmsMessage('0699887766', 'Hello!')));
|
||||
$this->assertFalse($transport->supports($this->createMock(MessageInterface::class), 'Hello!'));
|
||||
}
|
||||
|
||||
public function testSendNonSmsMessageThrowsException(): void
|
||||
{
|
||||
$transport = $this->initTransport();
|
||||
|
||||
$this->expectException(LogicException::class);
|
||||
|
||||
$transport->send(new SmsMessage('0699887766', 'Hello!'));
|
||||
}
|
||||
|
||||
private function initTransport(): FreeMobileTransport
|
||||
{
|
||||
return (new FreeMobileTransport(
|
||||
'login', 'pass', '0611223344', $this->createMock(HttpClientInterface::class)
|
||||
))->setHost('host.test');
|
||||
}
|
||||
}
|
@ -0,0 +1,36 @@
|
||||
{
|
||||
"name": "symfony/freemobile-notifier",
|
||||
"type": "symfony-bridge",
|
||||
"description": "Symfony Free Mobile Notifier Bridge",
|
||||
"keywords": ["sms", "FreeMobile", "notifier", "alerting"],
|
||||
"homepage": "https://symfony.com",
|
||||
"license": "MIT",
|
||||
"authors": [
|
||||
{
|
||||
"name": "Antoine Makdessi",
|
||||
"email": "amakdessi@me.com",
|
||||
"homepage": "http://antoine.makdessi.free.fr"
|
||||
},
|
||||
{
|
||||
"name": "Symfony Community",
|
||||
"homepage": "https://symfony.com/contributors"
|
||||
}
|
||||
],
|
||||
"require": {
|
||||
"php": "^7.2.5",
|
||||
"symfony/http-client": "^4.3|^5.1",
|
||||
"symfony/notifier": "^5.1"
|
||||
},
|
||||
"autoload": {
|
||||
"psr-4": { "Symfony\\Component\\Notifier\\Bridge\\FreeMobile\\": "" },
|
||||
"exclude-from-classmap": [
|
||||
"/Tests/"
|
||||
]
|
||||
},
|
||||
"minimum-stability": "dev",
|
||||
"extra": {
|
||||
"branch-alias": {
|
||||
"dev-master": "5.1-dev"
|
||||
}
|
||||
}
|
||||
}
|
@ -0,0 +1,31 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
|
||||
<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
|
||||
xsi:noNamespaceSchemaLocation="http://schema.phpunit.de/5.2/phpunit.xsd"
|
||||
backupGlobals="false"
|
||||
colors="true"
|
||||
bootstrap="vendor/autoload.php"
|
||||
failOnRisky="true"
|
||||
failOnWarning="true"
|
||||
>
|
||||
<php>
|
||||
<ini name="error_reporting" value="-1" />
|
||||
</php>
|
||||
|
||||
<testsuites>
|
||||
<testsuite name="Symfony FreeMobile Notifier Bridge Test Suite">
|
||||
<directory>./Tests/</directory>
|
||||
</testsuite>
|
||||
</testsuites>
|
||||
|
||||
<filter>
|
||||
<whitelist>
|
||||
<directory>./</directory>
|
||||
<exclude>
|
||||
<directory>./Resources</directory>
|
||||
<directory>./Tests</directory>
|
||||
<directory>./vendor</directory>
|
||||
</exclude>
|
||||
</whitelist>
|
||||
</filter>
|
||||
</phpunit>
|
@ -50,6 +50,10 @@ class UnsupportedSchemeException extends LogicException
|
||||
'class' => Bridge\Firebase\FirebaseTransportFactory::class,
|
||||
'package' => 'symfony/firebase-notifier',
|
||||
],
|
||||
'freemobile' => [
|
||||
'class' => Bridge\FreeMobile\FreeMobileTransportFactory::class,
|
||||
'package' => 'symfony/freemobile-notifier',
|
||||
],
|
||||
'ovhcloud' => [
|
||||
'class' => Bridge\OvhCloud\OvhCloudTransportFactory::class,
|
||||
'package' => 'symfony/ovhcloud-notifier',
|
||||
|
@ -12,6 +12,7 @@
|
||||
namespace Symfony\Component\Notifier;
|
||||
|
||||
use Symfony\Component\Notifier\Bridge\Firebase\FirebaseTransportFactory;
|
||||
use Symfony\Component\Notifier\Bridge\FreeMobile\FreeMobileTransportFactory;
|
||||
use Symfony\Component\Notifier\Bridge\Mattermost\MattermostTransportFactory;
|
||||
use Symfony\Component\Notifier\Bridge\Nexmo\NexmoTransportFactory;
|
||||
use Symfony\Component\Notifier\Bridge\OvhCloud\OvhCloudTransportFactory;
|
||||
@ -48,6 +49,7 @@ class Transport
|
||||
OvhCloudTransportFactory::class,
|
||||
FirebaseTransportFactory::class,
|
||||
SinchTransportFactory::class,
|
||||
FreeMobileTransportFactory::class,
|
||||
];
|
||||
|
||||
private $factories;
|
||||
|
Reference in New Issue
Block a user