Initial commit

Author: Herbie (Christian) Keuerleber

Classes/ActorTraits/MailPit.php

@@ -0,0 +1,91 @@
+<?php
+namespace PunktDe\Codeception\MailPit\ActorTraits;
+
+/*
+ * This file is part of the PunktDe\Codeception-MailPit package.
+ *
+ * This package is open source software. For the full copyright and license
+ * information, please view the LICENSE file which was distributed with this
+ * source code.
+ */
+
+trait MailPit
+{
+    /**
+     * @Then /^the inbox contains (\d+) mails?$/
+     * @param int|string $numberOfMails
+     */
+    public function theInboxContainsMails(int|string $numberOfMails): void
+    {
+        $this->inboxContainsNumberOfMails((int)$numberOfMails);
+    }
+
+    /**
+     * @When I follow :link in the email
+     * @param string $link
+     */
+    public function iFollowInTheEmailSentTo(string $link): void
+    {
+        $this->openMailByNumber(1);
+        $this->followLinkInTheEmail($link);
+    }
+
+    /**
+     * @When I clear my inbox
+     */
+    public function iClearMyInbox(): void
+    {
+        $this->clearInbox();
+    }
+
+    /**
+     * @When I open the first mail
+     */
+    public function iOpenTheFirstMail(): void
+    {
+        $this->openMailByNumber(1);
+    }
+
+    /**
+     * @When I open the second mail
+     */
+    public function iOpenTheSecondMail(): void
+    {
+        $this->openMailByNumber(2);
+    }
+
+    /**
+     * @Then I should see :text in the email
+     * @param string $text
+     */
+    public function iSeeInMail(string $text): void
+    {
+        $this->seeTextInMail($text);
+    }
+
+    /**
+     * @Then The email is addressed to :address
+     * @param string $address
+     */
+    public function mailIsAddressedTo(string $address): void
+    {
+        $this->checkRecipientAddress($address);
+    }
+
+    /**
+     * @Then I should see :subject in the email subject
+     * @param string $subject
+     */
+    public function iSeeSubjectOfMail(string $subject): void
+    {
+        $this->seeSubjectOfMail($subject);
+    }
+
+    /**
+     * @Then This mail is spam
+     */
+    public function ifSpamMail(): void
+    {
+        $this->checkIfSpam();
+    }
+}

Classes/Domain/MailDevClient.php

@@ -0,0 +1,106 @@
+<?php
+namespace PunktDe\Codeception\MailPit\Domain;
+
+/*
+ * This file is part of the PunktDe\Codeception-MailPit package.
+ *
+ * This package is open source software. For the full copyright and license
+ * information, please view the LICENSE file which was distributed with this
+ * source code.
+ */
+
+use GuzzleHttp\Client;
+use PunktDe\Codeception\MailPit\Domain\Model\Mail;
+
+class MailPitClient
+{
+    /**
+     * @var Client
+     */
+    protected $client;
+
+    protected const BASE_PATH = '/api/v1';
+
+    /**
+     * MailPitClient constructor.
+     * @param string $baseUri
+     * @param string $username
+     * @param string $password
+     * @param string $authenticationType
+     */
+    public function __construct(string $baseUri, string $username = '', string $password = '', string $authenticationType = 'basic')
+    {
+        $configuration = [
+            'base_uri' => $baseUri,
+            'cookies' => true,
+            'headers' => [
+                'User-Agent' => 'FancyPunktDeGuzzleTestingAgent'
+            ],
+        ];
+
+        if($username !== '' && $password !== '') {
+            $configuration = array_merge($configuration, ['auth' => [$username, $password, $authenticationType]]);
+        }
+
+        $this->client = new Client($configuration);
+    }
+
+    public function deleteAllMails(): void
+    {
+        $this->client->delete(self::BASE_PATH . '/messages');
+    }
+
+    /**
+     * @return int
+     * @throws \Exception
+     */
+    public function countAll(): int
+    {
+        $data = $this->getDataFromMailPit('/messages');
+
+        return $data['total'];
+    }
+
+    /**
+     * @param $index
+     * @return Mail
+     */
+    public function findOneByIndex(int $index): Mail
+    {
+        $list = $this->getDataFromMailPit('/messages');
+
+        $id = $list['messages'][$index]['ID'];
+
+        $data = $this->getDataFromMailPit('/message/' . $id);
+
+        return new Mail($data);
+    }
+
+    /**
+     * @param $apiCall
+     * @return array
+     * @throws \Exception
+     */
+    protected function getDataFromMailPit($apiCall): array
+    {
+        $result = $this->client->get(self::BASE_PATH . $apiCall)->getBody();
+
+        $data = json_decode($result, true);
+
+        if ($data === false) {
+            throw new \Exception('The mailpit result could not be parsed to json', 1774452891);
+        }
+
+        return $data;
+    }
+
+    /**
+     * @param array $data
+     * @return Mail
+     */
+    protected function buildMailObjectFromJson(array $data): Mail
+    {
+        return new Mail($data);
+    }
+
+}

Classes/Domain/Model/Mail.php

@@ -0,0 +1,73 @@
+<?php
+namespace PunktDe\Codeception\MailPit\Domain\Model;
+/*
+ * This file is part of the PunktDe\Codeception-MailPit package.
+ *
+ * This package is open source software. For the full copyright and license
+ * information, please view the LICENSE file which was distributed with this
+ * source code.
+ */
+
+use Neos\Utility\Arrays;
+
+class Mail
+{
+
+    /**
+     * @var array
+     */
+    protected $mailData = [];
+
+    /**
+     * @var array
+     */
+    protected $recipients;
+
+    /**
+     * @var string
+     */
+    protected $subject;
+
+    /**
+     * @var string
+     */
+    protected $body;
+
+
+    /**
+     * Mail constructor.
+     * @param array $mailData
+     */
+    public function __construct(array $mailData)
+    {
+        $this->mailData = $mailData;
+
+        $this->body = Arrays::getValueByPath($this->mailData, 'HTML');
+        $this->recipients = Arrays::getValueByPath($this->mailData, 'To.0.Address');
+        $this->subject = Arrays::getValueByPath($this->mailData, 'Subject');
+    }
+
+    /**
+     * @return string
+     */
+    public function getBody()
+    {
+        return $this->body;
+    }
+
+    /**
+     * @return string
+     */
+    public function getSubject()
+    {
+        return $this->subject;
+    }
+
+    /**
+     * @return array
+     */
+    public function getRecipients()
+    {
+        return $this->recipients;
+    }
+}