[Notifier] Add push channel to notifier

Author: norkunas

CHANGELOG.md

@@ -5,6 +5,7 @@ CHANGELOG
 ---
 
  * Add `SentMessageEvent` and `FailedMessageEvent`
+ * Add `push` channel
 
 5.3
 ---

Channel/PushChannel.php

@@ -0,0 +1,50 @@
+<?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\Channel;
+
+use Symfony\Component\Notifier\Message\PushMessage;
+use Symfony\Component\Notifier\Notification\Notification;
+use Symfony\Component\Notifier\Notification\PushNotificationInterface;
+use Symfony\Component\Notifier\Recipient\RecipientInterface;
+
+/**
+ * @author Tomas Norkūnas <norkunas.tom@gmail.com>
+ */
+class PushChannel extends AbstractChannel
+{
+    public function notify(Notification $notification, RecipientInterface $recipient, string $transportName = null): void
+    {
+        $message = null;
+        if ($notification instanceof PushNotificationInterface) {
+            $message = $notification->asPushMessage($recipient, $transportName);
+        }
+
+        if (null === $message) {
+            $message = PushMessage::fromNotification($notification);
+        }
+
+        if (null !== $transportName) {
+            $message->transport($transportName);
+        }
+
+        if (null === $this->bus) {
+            $this->transport->send($message);
+        } else {
+            $this->bus->dispatch($message);
+        }
+    }
+
+    public function supports(Notification $notification, RecipientInterface $recipient): bool
+    {
+        return true;
+    }
+}

Exception/UnsupportedSchemeException.php

@@ -116,6 +116,10 @@ class UnsupportedSchemeException extends LogicException
             'class' => Bridge\Octopush\OctopushTransportFactory::class,
             'package' => 'symfony/octopush-notifier',
         ],
+        'onesignal' => [
+            'class' => Bridge\OneSignal\OneSignalTransportFactory::class,
+            'package' => 'symfony/one-signal-notifier',
+        ],
         'ovhcloud' => [
             'class' => Bridge\OvhCloud\OvhCloudTransportFactory::class,
             'package' => 'symfony/ovh-cloud-notifier',

Message/PushMessage.php

@@ -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\Message;
+
+use Symfony\Component\Notifier\Notification\Notification;
+
+/**
+ * @author Tomas Norkūnas <norkunas.tom@gmail.com>
+ */
+final class PushMessage implements MessageInterface
+{
+    private $transport;
+    private $subject;
+    private $content;
+    private $options;
+    private $notification;
+
+    public function __construct(string $subject, string $content, MessageOptionsInterface $options = null)
+    {
+        $this->subject = $subject;
+        $this->content = $content;
+        $this->options = $options;
+    }
+
+    public static function fromNotification(Notification $notification): self
+    {
+        $message = new self($notification->getSubject(), $notification->getContent());
+        $message->notification = $notification;
+
+        return $message;
+    }
+
+    public function getRecipientId(): ?string
+    {
+        return $this->options ? $this->options->getRecipientId() : null;
+    }
+
+    public function subject(string $subject): self
+    {
+        $this->subject = $subject;
+
+        return $this;
+    }
+
+    public function getSubject(): string
+    {
+        return $this->subject;
+    }
+
+    public function content(string $content): self
+    {
+        $this->content = $content;
+
+        return $this;
+    }
+
+    public function getContent(): string
+    {
+        return $this->content;
+    }
+
+    public function options(MessageOptionsInterface $options): self
+    {
+        $this->options = $options;
+
+        return $this;
+    }
+
+    public function getOptions(): ?MessageOptionsInterface
+    {
+        return $this->options;
+    }
+
+    public function transport(?string $transport): self
+    {
+        $this->transport = $transport;
+
+        return $this;
+    }
+
+    public function getTransport(): ?string
+    {
+        return $this->transport;
+    }
+
+    public function getNotification(): ?Notification
+    {
+        return $this->notification;
+    }
+}

Notification/PushNotificationInterface.php

@@ -0,0 +1,20 @@
+<?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\Notification;
+
+use Symfony\Component\Notifier\Message\PushMessage;
+use Symfony\Component\Notifier\Recipient\RecipientInterface;
+
+interface PushNotificationInterface
+{
+    public function asPushMessage(RecipientInterface $recipient, string $transport = null): ?PushMessage;
+}

Tests/Exception/UnsupportedSchemeExceptionTest.php

@@ -38,6 +38,7 @@
 use Symfony\Component\Notifier\Bridge\Mobyt\MobytTransportFactory;
 use Symfony\Component\Notifier\Bridge\Nexmo\NexmoTransportFactory;
 use Symfony\Component\Notifier\Bridge\Octopush\OctopushTransportFactory;
+use Symfony\Component\Notifier\Bridge\OneSignal\OneSignalTransportFactory;
 use Symfony\Component\Notifier\Bridge\OvhCloud\OvhCloudTransportFactory;
 use Symfony\Component\Notifier\Bridge\RocketChat\RocketChatTransportFactory;
 use Symfony\Component\Notifier\Bridge\Sendinblue\SendinblueTransportFactory;
@@ -91,6 +92,7 @@ public static function setUpBeforeClass(): void
             MobytTransportFactory::class => false,
             NexmoTransportFactory::class => false,
             OctopushTransportFactory::class => false,
+            OneSignalTransportFactory::class => false,
             OvhCloudTransportFactory::class => false,
             RocketChatTransportFactory::class => false,
             SendinblueTransportFactory::class => false,
@@ -150,6 +152,7 @@ public function messageWhereSchemeIsPartOfSchemeToPackageMapProvider(): \Generat
         yield ['mobyt', 'symfony/mobyt-notifier'];
         yield ['nexmo', 'symfony/nexmo-notifier'];
         yield ['octopush', 'symfony/octopush-notifier'];
+        yield ['onesignal', 'symfony/one-signal-notifier'];
         yield ['ovhcloud', 'symfony/ovh-cloud-notifier'];
         yield ['rocketchat', 'symfony/rocket-chat-notifier'];
         yield ['sendinblue', 'symfony/sendinblue-notifier'];

Tests/Message/PushMessageTest.php

@@ -0,0 +1,66 @@
+<?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\Tests\Message;
+
+use PHPUnit\Framework\TestCase;
+use Symfony\Component\Notifier\Message\PushMessage;
+use Symfony\Component\Notifier\Notification\Notification;
+
+/**
+ * @author Tomas Norkūnas <norkunas.tom@gmail.com>
+ */
+class PushMessageTest extends TestCase
+{
+    public function testCanBeConstructed()
+    {
+        $message = new PushMessage('Hello', 'World');
+
+        $this->assertSame('Hello', $message->getSubject());
+        $this->assertSame('World', $message->getContent());
+    }
+
+    public function testSetSubject()
+    {
+        $message = new PushMessage('Hello', 'World');
+        $message->subject('dlrow olleH');
+
+        $this->assertSame('dlrow olleH', $message->getSubject());
+    }
+
+    public function testSetContent()
+    {
+        $message = new PushMessage('Hello', 'World');
+        $message->content('dlrow olleH');
+
+        $this->assertSame('dlrow olleH', $message->getContent());
+    }
+
+    public function testSetTransport()
+    {
+        $message = new PushMessage('Hello', 'World');
+        $message->transport('next_one');
+
+        $this->assertSame('next_one', $message->getTransport());
+    }
+
+    public function testCreateFromNotification()
+    {
+        $notification = new Notification('Hello');
+        $notification->content('World');
+
+        $message = PushMessage::fromNotification($notification);
+
+        $this->assertSame('Hello', $message->getSubject());
+        $this->assertSame('World', $message->getContent());
+        $this->assertSame($notification, $message->getNotification());
+    }
+}