diff --git a/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php b/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php index 442acb9dab840..643ff72fb2c5d 100644 --- a/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php +++ b/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php @@ -92,6 +92,7 @@ use Symfony\Component\Mime\MimeTypes; use Symfony\Component\Notifier\Bridge\Mattermost\MattermostTransportFactory; use Symfony\Component\Notifier\Bridge\Nexmo\NexmoTransportFactory; +use Symfony\Component\Notifier\Bridge\RocketChat\RocketChatTransportFactory; use Symfony\Component\Notifier\Bridge\Slack\SlackTransportFactory; use Symfony\Component\Notifier\Bridge\Telegram\TelegramTransportFactory; use Symfony\Component\Notifier\Bridge\Twilio\TwilioTransportFactory; @@ -2000,6 +2001,7 @@ private function registerNotifierConfiguration(array $config, ContainerBuilder $ TelegramTransportFactory::class => 'notifier.transport_factory.telegram', MattermostTransportFactory::class => 'notifier.transport_factory.mattermost', NexmoTransportFactory::class => 'notifier.transport_factory.nexmo', + RocketChatTransportFactory::class => 'notifier.transport_factory.rocketchat', TwilioTransportFactory::class => 'notifier.transport_factory.twilio', ]; diff --git a/src/Symfony/Bundle/FrameworkBundle/Resources/config/notifier_transports.xml b/src/Symfony/Bundle/FrameworkBundle/Resources/config/notifier_transports.xml index 4625458280039..14c4b8e7c1761 100644 --- a/src/Symfony/Bundle/FrameworkBundle/Resources/config/notifier_transports.xml +++ b/src/Symfony/Bundle/FrameworkBundle/Resources/config/notifier_transports.xml @@ -26,6 +26,10 @@ + + + + diff --git a/src/Symfony/Component/Notifier/Bridge/RocketChat/.gitattributes b/src/Symfony/Component/Notifier/Bridge/RocketChat/.gitattributes new file mode 100644 index 0000000000000..aa02dc6518d99 --- /dev/null +++ b/src/Symfony/Component/Notifier/Bridge/RocketChat/.gitattributes @@ -0,0 +1,2 @@ +/Tests export-ignore +/phpunit.xml.dist export-ignore diff --git a/src/Symfony/Component/Notifier/Bridge/RocketChat/CHANGELOG.md b/src/Symfony/Component/Notifier/Bridge/RocketChat/CHANGELOG.md new file mode 100644 index 0000000000000..7bd5e9a57fd19 --- /dev/null +++ b/src/Symfony/Component/Notifier/Bridge/RocketChat/CHANGELOG.md @@ -0,0 +1,7 @@ +CHANGELOG +========= + +5.1.0 +----- + + * Added the bridge diff --git a/src/Symfony/Component/Notifier/Bridge/RocketChat/LICENSE b/src/Symfony/Component/Notifier/Bridge/RocketChat/LICENSE new file mode 100644 index 0000000000000..1a1869751d250 --- /dev/null +++ b/src/Symfony/Component/Notifier/Bridge/RocketChat/LICENSE @@ -0,0 +1,19 @@ +Copyright (c) 2019 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/RocketChat/README.md b/src/Symfony/Component/Notifier/Bridge/RocketChat/README.md new file mode 100644 index 0000000000000..57916e8bffb5f --- /dev/null +++ b/src/Symfony/Component/Notifier/Bridge/RocketChat/README.md @@ -0,0 +1,12 @@ +RocketChat Notifier +=================== + +Provides RocketChat integration for Symfony Notifier. + +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/RocketChat/RocketChatOptions.php b/src/Symfony/Component/Notifier/Bridge/RocketChat/RocketChatOptions.php new file mode 100644 index 0000000000000..b6f392f68b08d --- /dev/null +++ b/src/Symfony/Component/Notifier/Bridge/RocketChat/RocketChatOptions.php @@ -0,0 +1,60 @@ + + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ + +namespace Symfony\Component\Notifier\Bridge\RocketChat; + +use Symfony\Component\Notifier\Message\MessageOptionsInterface; + +/** + * @author Jeroen Spee + * + * @experimental in 5.1 + * + * @see https://rocket.chat/docs/administrator-guides/integrations/ + */ +final class RocketChatOptions implements MessageOptionsInterface +{ + /** @var string|null prefix with '@' for personal messages */ + private $channel; + + /** @var mixed[] */ + private $attachments; + + /** + * @param string[] $attachments + */ + public function __construct(array $attachments = []) + { + $this->attachments = $attachments; + } + + public function toArray(): array + { + return [ + 'attachments' => [$this->attachments], + ]; + } + + public function getRecipientId(): ?string + { + return $this->channel; + } + + /** + * @return $this + */ + public function channel(string $channel): self + { + $this->channel = $channel; + + return $this; + } +} diff --git a/src/Symfony/Component/Notifier/Bridge/RocketChat/RocketChatTransport.php b/src/Symfony/Component/Notifier/Bridge/RocketChat/RocketChatTransport.php new file mode 100644 index 0000000000000..f3fd43f661eb2 --- /dev/null +++ b/src/Symfony/Component/Notifier/Bridge/RocketChat/RocketChatTransport.php @@ -0,0 +1,90 @@ + + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ + +namespace Symfony\Component\Notifier\Bridge\RocketChat; + +use Symfony\Component\Notifier\Exception\LogicException; +use Symfony\Component\Notifier\Exception\TransportException; +use Symfony\Component\Notifier\Message\ChatMessage; +use Symfony\Component\Notifier\Message\MessageInterface; +use Symfony\Component\Notifier\Transport\AbstractTransport; +use Symfony\Contracts\EventDispatcher\EventDispatcherInterface; +use Symfony\Contracts\HttpClient\HttpClientInterface; + +/** + * @author Jeroen Spee + * + * @internal + * + * @experimental in 5.1 + */ +final class RocketChatTransport extends AbstractTransport +{ + protected const HOST = 'rocketchat.com'; + + private $accessToken; + private $chatChannel; + + public function __construct(string $accessToken, string $chatChannel = null, HttpClientInterface $client = null, EventDispatcherInterface $dispatcher = null) + { + $this->accessToken = $accessToken; + $this->chatChannel = $chatChannel; + $this->client = $client; + + parent::__construct($client, $dispatcher); + } + + public function __toString(): string + { + return sprintf('rocketchat://%s?channel=%s', $this->getEndpoint(), $this->chatChannel); + } + + public function supports(MessageInterface $message): bool + { + return $message instanceof ChatMessage && (null === $message->getOptions() || $message->getOptions() instanceof RocketChatOptions); + } + + /** + * @see https://rocket.chat/docs/administrator-guides/integrations/ + */ + protected function doSend(MessageInterface $message): void + { + if (!$message instanceof ChatMessage) { + throw new LogicException(sprintf('The "%s" transport only supports instances of "%s" (instance of "%s" given).', __CLASS__, ChatMessage::class, \get_class($message))); + } + if ($message->getOptions() && !$message->getOptions() instanceof RocketChatOptions) { + throw new LogicException(sprintf('The "%s" transport only supports instances of "%s" for options.', __CLASS__, RocketChatOptions::class)); + } + + $options = ($opts = $message->getOptions()) ? $opts->toArray() : []; + if (!isset($options['channel'])) { + $options['channel'] = $message->getRecipientId() ?: $this->chatChannel; + } + $options['text'] = $message->getSubject(); + + $response = $this->client->request( + 'POST', + sprintf('https://%s/hooks/%s', $this->getEndpoint(), $this->accessToken), + [ + 'json' => array_filter($options), + ] + ); + + if (200 !== $response->getStatusCode()) { + throw new TransportException(sprintf('Unable to post the RocketChat message: %s.', $response->getContent(false)), $response); + } + + $result = $response->toArray(false); + if (!$result['success']) { + throw new TransportException(sprintf('Unable to post the RocketChat message: %s.', $result['error']), $response); + } + } +} diff --git a/src/Symfony/Component/Notifier/Bridge/RocketChat/RocketChatTransportFactory.php b/src/Symfony/Component/Notifier/Bridge/RocketChat/RocketChatTransportFactory.php new file mode 100644 index 0000000000000..b77b4db15b3c5 --- /dev/null +++ b/src/Symfony/Component/Notifier/Bridge/RocketChat/RocketChatTransportFactory.php @@ -0,0 +1,45 @@ + + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ + +namespace Symfony\Component\Notifier\Bridge\RocketChat; + +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 Jeroen Spee + * + * @experimental in 5.1 + */ +final class RocketChatTransportFactory extends AbstractTransportFactory +{ + public function create(Dsn $dsn): TransportInterface + { + $scheme = $dsn->getScheme(); + $accessToken = $this->getUser($dsn); + $channel = $dsn->getOption('channel'); + $host = 'default' === $dsn->getHost() ? null : $dsn->getHost(); + $port = $dsn->getPort(); + + if ('rocketchat' === $scheme) { + return (new RocketChatTransport($accessToken, $channel, $this->client, $this->dispatcher))->setHost($host)->setPort($port); + } + + throw new UnsupportedSchemeException($dsn, 'rocketchat', $this->getSupportedSchemes()); + } + + protected function getSupportedSchemes(): array + { + return ['rocketchat']; + } +} diff --git a/src/Symfony/Component/Notifier/Bridge/RocketChat/composer.json b/src/Symfony/Component/Notifier/Bridge/RocketChat/composer.json new file mode 100644 index 0000000000000..40af3e56324dd --- /dev/null +++ b/src/Symfony/Component/Notifier/Bridge/RocketChat/composer.json @@ -0,0 +1,35 @@ +{ + "name": "symfony/rocketchat-notifier", + "type": "symfony-bridge", + "description": "Symfony RocketChat Notifier Bridge", + "keywords": ["rocketchat", "notifier"], + "homepage": "https://symfony.com", + "license": "MIT", + "authors": [ + { + "name": "Jeroen Spee", + "homepage": "https://github.com/Jeroeny" + }, + { + "name": "Symfony Community", + "homepage": "https://symfony.com/contributors" + } + ], + "require": { + "php": "^7.2.5", + "symfony/http-client": "^4.3|^5.0", + "symfony/notifier": "^5.0" + }, + "autoload": { + "psr-4": { "Symfony\\Component\\Notifier\\Bridge\\RocketChat\\": "" }, + "exclude-from-classmap": [ + "/Tests/" + ] + }, + "minimum-stability": "dev", + "extra": { + "branch-alias": { + "dev-master": "5.1-dev" + } + } +} diff --git a/src/Symfony/Component/Notifier/Bridge/RocketChat/phpunit.xml.dist b/src/Symfony/Component/Notifier/Bridge/RocketChat/phpunit.xml.dist new file mode 100644 index 0000000000000..846dd0f13e359 --- /dev/null +++ b/src/Symfony/Component/Notifier/Bridge/RocketChat/phpunit.xml.dist @@ -0,0 +1,31 @@ + + + + + + + + + + ./Tests/ + + + + + + ./ + + ./Resources + ./Tests + ./vendor + + + + diff --git a/src/Symfony/Component/Notifier/Exception/UnsupportedSchemeException.php b/src/Symfony/Component/Notifier/Exception/UnsupportedSchemeException.php index 24bdebeb17c80..914e26549ad70 100644 --- a/src/Symfony/Component/Notifier/Exception/UnsupportedSchemeException.php +++ b/src/Symfony/Component/Notifier/Exception/UnsupportedSchemeException.php @@ -38,6 +38,10 @@ class UnsupportedSchemeException extends LogicException 'class' => Bridge\Nexmo\NexmoTransportFactory::class, 'package' => 'symfony/nexmo-notifier', ], + 'rocketchat' => [ + 'class' => Bridge\RocketChat\RocketChatTransportFactory::class, + 'package' => 'rocketchat-notifier', + ], 'twilio' => [ 'class' => Bridge\Twilio\TwilioTransportFactory::class, 'package' => 'symfony/twilio-notifier', diff --git a/src/Symfony/Component/Notifier/Transport.php b/src/Symfony/Component/Notifier/Transport.php index 1671fca2c964a..868766916b71a 100644 --- a/src/Symfony/Component/Notifier/Transport.php +++ b/src/Symfony/Component/Notifier/Transport.php @@ -13,6 +13,7 @@ use Symfony\Component\Notifier\Bridge\Mattermost\MattermostTransportFactory; use Symfony\Component\Notifier\Bridge\Nexmo\NexmoTransportFactory; +use Symfony\Component\Notifier\Bridge\RocketChat\RocketChatTransportFactory; use Symfony\Component\Notifier\Bridge\Slack\SlackTransportFactory; use Symfony\Component\Notifier\Bridge\Telegram\TelegramTransportFactory; use Symfony\Component\Notifier\Bridge\Twilio\TwilioTransportFactory; @@ -39,6 +40,7 @@ class Transport TelegramTransportFactory::class, MattermostTransportFactory::class, NexmoTransportFactory::class, + RocketChatTransportFactory::class, TwilioTransportFactory::class, ];