Transfer sms sender component to Klipper

Author: francoispluchino

.gitignore

@@ -0,0 +1,2 @@
+/.php_cs.cache
+/vendor/

DelayedSmsEnvelope.php

@@ -0,0 +1,132 @@
+<?php
+
+/*
+ * This file is part of the Klipper package.
+ *
+ * (c) François Pluchino <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Klipper\Component\SmsSender;
+
+use Klipper\Component\SmsSender\Exception\InvalidArgumentException;
+use Klipper\Component\SmsSender\Exception\LogicException;
+use Klipper\Component\SmsSender\Mime\Phone;
+use Klipper\Component\SmsSender\Mime\Sms;
+use Symfony\Component\Mime\Header\Headers;
+use Symfony\Component\Mime\Header\MailboxListHeader;
+use Symfony\Component\Mime\Message;
+use Symfony\Component\Mime\RawMessage;
+
+/**
+ * Delayed Sms envelope.
+ *
+ * @author François Pluchino <[email protected]>
+ */
+class DelayedSmsEnvelope extends SmsEnvelope
+{
+    /**
+     * @var bool
+     */
+    private $senderSet = false;
+
+    /**
+     * @var bool
+     */
+    private $recipientsSet = false;
+
+    /**
+     * @var Message
+     */
+    private $message;
+
+    /**
+     * Constructor.
+     *
+     * @param Message|RawMessage $message The message
+     */
+    public function __construct(RawMessage $message)
+    {
+        if (!$message instanceof Message) {
+            throw new InvalidArgumentException(sprintf(
+                'A delayed SMS envelope requires an instance of %s ("%s" given).',
+                Message::class,
+                \get_class($message)
+            ));
+        }
+
+        $this->message = $message;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function setFrom(Phone $from): void
+    {
+        parent::setFrom($from);
+
+        $this->senderSet = true;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getFrom(): Phone
+    {
+        if ($this->senderSet) {
+            return parent::getFrom();
+        }
+
+        if ($this->message instanceof Sms && null !== $from = $this->message->getFrom()) {
+            return $from;
+        }
+
+        throw new LogicException('Unable to determine the sender of the message.');
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function setRecipients(array $recipients): void
+    {
+        parent::setRecipients($recipients);
+
+        $this->recipientsSet = \count(parent::getRecipients()) > 0;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getRecipients(): array
+    {
+        if ($this->recipientsSet) {
+            return parent::getRecipients();
+        }
+
+        return self::getRecipientsFromHeaders($this->message->getHeaders());
+    }
+
+    /**
+     * Get the recipient phones from the message header.
+     *
+     * @param Headers $headers The message headers
+     *
+     * @return Phone[]
+     */
+    private static function getRecipientsFromHeaders(Headers $headers): array
+    {
+        $recipients = [];
+
+        /** @var MailboxListHeader $header */
+        foreach ($headers->all('to') as $header) {
+            /** @var Phone $phone */
+            foreach ($header->getAddresses() as $phone) {
+                $recipients[] = new Phone($phone->getPhone());
+            }
+        }
+
+        return $recipients;
+    }
+}

Event/AbstractMessageEvent.php

@@ -0,0 +1,84 @@
+<?php
+
+/*
+ * This file is part of the Klipper package.
+ *
+ * (c) François Pluchino <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Klipper\Component\SmsSender\Event;
+
+use Klipper\Component\SmsSender\SmsEnvelope;
+use Symfony\Component\Mime\RawMessage;
+use Symfony\Contracts\EventDispatcher\Event;
+
+/**
+ * @author François Pluchino <[email protected]>
+ */
+abstract class AbstractMessageEvent extends Event
+{
+    /**
+     * @var RawMessage
+     */
+    private $message;
+
+    /**
+     * @var SmsEnvelope
+     */
+    private $envelope;
+
+    /**
+     * Constructor.
+     *
+     * @param RawMessage  $message  The message
+     * @param SmsEnvelope $envelope The envelope
+     */
+    public function __construct(RawMessage $message, SmsEnvelope $envelope)
+    {
+        $this->message = $message;
+        $this->envelope = $envelope;
+    }
+
+    /**
+     * Get the message.
+     *
+     * @return RawMessage
+     */
+    public function getMessage(): RawMessage
+    {
+        return $this->message;
+    }
+
+    /**
+     * Set the message.
+     *
+     * @param RawMessage $message The message
+     */
+    public function setMessage(RawMessage $message): void
+    {
+        $this->message = $message;
+    }
+
+    /**
+     * Get the envelope.
+     *
+     * @return SmsEnvelope
+     */
+    public function getEnvelope(): SmsEnvelope
+    {
+        return $this->envelope;
+    }
+
+    /**
+     * Set the envelope.
+     *
+     * @param SmsEnvelope $envelope The envelope
+     */
+    public function setEnvelope(SmsEnvelope $envelope): void
+    {
+        $this->envelope = $envelope;
+    }
+}

Event/MessageEvent.php

@@ -0,0 +1,21 @@
+<?php
+
+/*
+ * This file is part of the Klipper package.
+ *
+ * (c) François Pluchino <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Klipper\Component\SmsSender\Event;
+
+/**
+ * Allows the transformation of a Message.
+ *
+ * @author François Pluchino <[email protected]>
+ */
+class MessageEvent extends AbstractMessageEvent
+{
+}

Event/MessageResultEvent.php

@@ -0,0 +1,51 @@
+<?php
+
+/*
+ * This file is part of the Klipper package.
+ *
+ * (c) François Pluchino <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Klipper\Component\SmsSender\Event;
+
+use Klipper\Component\SmsSender\SmsEnvelope;
+use Klipper\Component\SmsSender\Transport\Result;
+use Symfony\Component\Mime\RawMessage;
+
+/**
+ * @author François Pluchino <[email protected]>
+ */
+class MessageResultEvent extends AbstractMessageEvent
+{
+    /**
+     * @var Result
+     */
+    private $result;
+
+    /**
+     * Constructor.
+     *
+     * @param RawMessage  $message  The message
+     * @param SmsEnvelope $envelope The envelope
+     * @param Result      $result   The result
+     */
+    public function __construct(RawMessage $message, SmsEnvelope $envelope, Result $result)
+    {
+        parent::__construct($message, $envelope);
+
+        $this->result = $result;
+    }
+
+    /**
+     * Get the result.
+     *
+     * @return Result
+     */
+    public function getResult(): Result
+    {
+        return $this->result;
+    }
+}