symfony · fabpot · Mar 26, 2022 · Nov 27, 2021
diff --git a/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php b/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php
@@ -119,6 +119,7 @@
 use Symfony\Component\Notifier\Bridge\AmazonSns\AmazonSnsTransportFactory;
 use Symfony\Component\Notifier\Bridge\Clickatell\ClickatellTransportFactory;
 use Symfony\Component\Notifier\Bridge\Discord\DiscordTransportFactory;
+use Symfony\Component\Notifier\Bridge\Engagespot\EngagespotTransportFactory;
 use Symfony\Component\Notifier\Bridge\Esendex\EsendexTransportFactory;
 use Symfony\Component\Notifier\Bridge\Expo\ExpoTransportFactory;
 use Symfony\Component\Notifier\Bridge\FakeChat\FakeChatTransportFactory;
@@ -2444,6 +2445,7 @@ private function registerNotifierConfiguration(array $config, ContainerBuilder $
             AmazonSnsTransportFactory::class => 'notifier.transport_factory.amazon-sns',
             ClickatellTransportFactory::class => 'notifier.transport_factory.clickatell',
             DiscordTransportFactory::class => 'notifier.transport_factory.discord',
+            EngagespotTransportFactory::class => 'notifier.transport_factory.engagespot',
             EsendexTransportFactory::class => 'notifier.transport_factory.esendex',
             ExpoTransportFactory::class => 'notifier.transport_factory.expo',
             FakeChatTransportFactory::class => 'notifier.transport_factory.fake-chat',

diff --git a/src/Symfony/Bundle/FrameworkBundle/Resources/config/notifier_transports.php b/src/Symfony/Bundle/FrameworkBundle/Resources/config/notifier_transports.php
@@ -15,6 +15,7 @@
 use Symfony\Component\Notifier\Bridge\AmazonSns\AmazonSnsTransportFactory;
 use Symfony\Component\Notifier\Bridge\Clickatell\ClickatellTransportFactory;
 use Symfony\Component\Notifier\Bridge\Discord\DiscordTransportFactory;
+use Symfony\Component\Notifier\Bridge\Engagespot\EngagespotTransportFactory;
 use Symfony\Component\Notifier\Bridge\Esendex\EsendexTransportFactory;
 use Symfony\Component\Notifier\Bridge\Expo\ExpoTransportFactory;
 use Symfony\Component\Notifier\Bridge\FakeChat\FakeChatTransportFactory;
@@ -256,5 +257,9 @@
         ->set('notifier.transport_factory.kaz-info-teh', KazInfoTehTransportFactory::class)
             ->parent('notifier.transport_factory.abstract')
             ->tag('texter.transport_factory')
+
+        ->set('notifier.transport_factory.engagespot', EngagespotTransportFactory::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,7 @@
+CHANGELOG
+=========
+
+6.1
+---
+
+* Add the bridge
@@ -0,0 +1,99 @@
+<?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\Engagespot;
+
+use Symfony\Component\Notifier\Message\MessageOptionsInterface;
+
+/**
+ * @author Daniel GORGAN <https://github.com/danut007ro>
+ *
+ * @see https://docs.engagespot.co/how-to-send-notifications-via-engagespot-api/how-to-send-notifications-using-engagespot-rest-api
+ */
+final class EngagespotOptions implements MessageOptionsInterface
+{
+    protected $options;
+
+    public function __construct(array $options = [])
+    {
+        $this->options = $options;
+    }
+
+    public function toArray(): array
+    {
+        return $this->options;
+    }
+
+    public function getRecipientId(): ?string
+    {
+        return $this->options['to'];
+    }
+
+    /**
+     * @return $this
+     */
+    public function campaignName(string $campaignName): static
+    {
+        $this->options['campaign_name'] = $campaignName;
+
+        return $this;
    }
+
+    /**
+     * @return $this
+     */
+    public function to(string $to): static
+    {
+        $this->options['to'] = $to;
+
+        return $this;
+    }
+
+    /**
+     * @return $this
+     */
+    public function identifiers(array $identifiers): static
+    {
+        $this->options['identifiers'] = $identifiers;
+
+        return $this;
+    }
+
+    /**
+     * @return $this
+     */
+    public function everyone(bool $everyone): static
+    {
+        $this->options['everyone'] = $everyone;
+
+        return $this;
+    }
+
+    /**
+     * @return $this
+     */
+    public function icon(string $icon): static
+    {
+        $this->options['icon'] = $icon;
+
+        return $this;
+    }
+
+    /**
+     * @return $this
+     */
+    public function url(string $url): static
+    {
+        $this->options['url'] = $url;
+
+        return $this;
+    }
+}
@@ -0,0 +1,113 @@
+<?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\Engagespot;
+
+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\PushMessage;
+use Symfony\Component\Notifier\Message\SentMessage;
+use Symfony\Component\Notifier\Transport\AbstractTransport;
+use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
+use Symfony\Contracts\HttpClient\Exception\TransportExceptionInterface;
+use Symfony\Contracts\HttpClient\HttpClientInterface;
+
+/**
+ * @author Daniel GORGAN <https://github.com/danut007ro>
+ */
+final class EngagespotTransport extends AbstractTransport
+{
+    protected const HOST = 'api.engagespot.co/2/campaigns';
+
+    private $apiKey;
+    private $campaignName;
+
+    public function __construct(string $apiKey, string $campaignName, HttpClientInterface $client = null, EventDispatcherInterface $dispatcher = null)
+    {
+        $this->apiKey = $apiKey;
+        $this->campaignName = $campaignName;
+        $this->client = $client;
+
+        parent::__construct($client, $dispatcher);
+    }
+
+    public function __toString(): string
+    {
+        return sprintf('engagespot://%s?campaign_name=%s', $this->getEndpoint(), $this->campaignName);
+    }
+
+    public function supports(MessageInterface $message): bool
+    {
+        return $message instanceof PushMessage;
+    }
+
+    protected function doSend(MessageInterface $message): SentMessage
+    {
+        if (!$message instanceof PushMessage) {
+            throw new UnsupportedMessageTypeException(__CLASS__, PushMessage::class, $message);
+        }
+
+        $endpoint = sprintf('https://%s', $this->getEndpoint());
+        $options = ($opts = $message->getOptions()) ? $opts->toArray() : [];
+        if (!isset($options['to'])) {
+            $options['to'] = $message->getRecipientId();
+        }
+
+        $sendToEveryone = $options['everyone'] ?? false;
+        if (!$sendToEveryone) {
+            // Use either "to" or "identifiers" as recipient list.
+            if (null !== $options['to']) {
+                $identifiers = [$options['to']];
+            } elseif (!\is_array($options['identifiers'] ?? null)) {
+                throw new InvalidArgumentException(sprintf('The "%s" transport required the "to" or "identifiers" option to be set when not sending to everyone.', __CLASS__));
+            } else {
+                $identifiers = $options['identifiers'];
+            }
+        }
+
+        $response = $this->client->request('POST', $endpoint, [
+            'headers' => [
+                'API-Key' => $this->apiKey,
+            ],
+            'json' => [
+                'campaign_name' => $options['campaign_name'] ?? $this->campaignName,
+                'notification' => [
+                    'title' => $message->getSubject(),
+                    'message' => $message->getContent(),
+                    'icon' => $options['icon'] ?? '',
+                    'url' => $options['url'] ?? '#',
+                ],
+                'send_to' => $sendToEveryone ? 'everyone' : 'identifiers',
+                'identifiers' => $identifiers ?? null,
+            ],
+        ]);
+
+        try {
+            $statusCode = $response->getStatusCode();
+            if (200 !== $statusCode) {
+                throw new TransportException('Invalid status code received from Engagespot server: '.$statusCode, $response);
+            }
+        } catch (TransportExceptionInterface $e) {
+            throw new TransportException('Could not reach the remote Engagespot server.', $response, 0, $e);
+        }
+
+        $jsonContents = $response->toArray(false);
+        if ('ok' !== $jsonContents['status'] ?? null) {
+            $errorMessage = $jsonContents['message'] ?? $response->getContent(false);
+
+            throw new TransportException('Unable to post the Engagespot message: '.$errorMessage, $response);
+        }
+
+        return new SentMessage($message, (string) $this);
+    }
+}
@@ -0,0 +1,44 @@
+<?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\Engagespot;
+
+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 Daniel GORGAN <https://github.com/danut007ro>
+ */
+final class EngagespotTransportFactory extends AbstractTransportFactory
+{
+    public function create(Dsn $dsn): EngagespotTransport
+    {
+        $scheme = $dsn->getScheme();
+    
+        if ('engagespot' !== $scheme) {
+            throw new UnsupportedSchemeException($dsn, 'engagespot', $this->getSupportedSchemes());
+        }
+
+        $apiKey = $dsn->getUser();
+        $campaignName = $dsn->getRequiredOption('campaign_name');
+        $host = 'default' === $dsn->getHost() ? null : $dsn->getHost();
+        $port = $dsn->getPort();
+
+        return (new EngagespotTransport($apiKey, $campaignName, $this->client, $this->dispatcher))->setHost($host)->setPort($port);
+    }
+
+    protected function getSupportedSchemes(): array
+    {
+        return ['engagespot'];
+    }
+}
@@ -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,23 @@
+Engagespot Notifier
+===================
+
+Provides [Engagespot](https://docs.engagespot.co/how-to-send-notifications-via-engagespot-api/how-to-send-notifications-using-engagespot-rest-api) integration for Symfony Notifier.
+
+DSN example
+-----------
+
+```
+ENGAGESPOT_DSN=engagespot://API_KEY@default?campaign_name=CAMPAIGN_NAME
+```
+
+where:
+ - `API_KEY` is your Engagespot API Key
+ - `CAMPAIGN_NAME` is your default campaign name
+
+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)