maciejslawik / freshmail

tests/Message/TransactionalEmailHandlerTest.php

<?php
/**
 * File: TransactionalEmailHandlerTest.php
 *
 * @author      Maciej Sławik <maciekslawik@gmail.com>
 * Github:      https://github.com/maciejslawik
 */

namespace MSlwk\FreshMail\Test\Message;

use MSlwk\FreshMail\Handler\Message\TransactionalEmailHandler;
use MSlwk\FreshMail\Tests\BaseTest;
use PHPUnit\Framework\TestCase;
use MSlwk\FreshMail\Error\ErrorHandler;
use MSlwk\FreshMail\Exception\Message\FreshMailTransactionalEmailException;

/**
 * Class TransactionalEmailHandlerTest
 *
 * @package MSlwk\FreshMail\Test\Message
 */
class TransactionalEmailHandlerTest extends TestCase
{
    use BaseTest;

    /**
     * @param $sendRequestReturnValue
     * @return \PHPUnit_Framework_MockObject_MockObject

The type PHPUnit_Framework_MockObject_MockObject was not found. Maybe you did not declare it correctly or list all dependencies?

     */
    public function getTransactionalEmailHandlerMock($sendRequestReturnValue)
    {
        $transactionalEmailHandler = $this->getMockBuilder('\MSlwk\FreshMail\Handler\Message\TransactionalEmailHandler')

The function PHPUnit\Framework\MockObject\MockBuilder::setMethods() has been deprecated: https://github.com/sebastianbergmann/phpunit/pull/3687

            ->setConstructorArgs([new ErrorHandler(), '', ''])
            ->setMethods(['sendRequest'])
            ->getMock();

        $transactionalEmailHandler->expects($this->once())
            ->method('sendRequest')
            ->will($this->returnValue($sendRequestReturnValue));

        return $transactionalEmailHandler;

The expression return $transactionalEmailHandler returns the type PHPUnit\Framework\MockObject\MockObject which is incompatible with the documented return type PHPUnit_Framework_MockObject_MockObject.

    }

    public function testEmailSuccessfullySent()
    {
        $transactionalEmailHandler = $this->getTransactionalEmailHandlerMock('{"status":"OK"}');
        $returnValue = $transactionalEmailHandler->sendTransactionalEmail(
            'recipient@email.com',
            'Email subject',
            'Email content',
            'sender@email.com',
            'Sender',
            'replyTo@email.com',
            'UTF-8',
            'http://attachment.com',
            'tag',
            false,
            'http://domain.com'
        );
        self::assertNull($returnValue);
    }

    public function testApiEndpoint()
    {
        $accountCreateHandler = new TransactionalEmailHandler(new ErrorHandler(), '', '');
        $expectedApiEndpoint = '/rest/mail';
        $returnedApiEndpoint = $this->getApiEndpoint($accountCreateHandler);
        self::assertEquals($expectedApiEndpoint, $returnedApiEndpoint);
    }

    public function testWrongSubscriberEmail()
    {
        $transactionalEmailHandler = $this->getTransactionalEmailHandlerMock(
            '{"errors":[{ "message":"Wrong email address", "code":"1201" }], "status":"errors"}'
        );
        $this->expectException(FreshMailTransactionalEmailException::class);
        $transactionalEmailHandler->sendTransactionalEmail('recipient@email.com', 'Email subject', 'Email content');
    }

    public function testNoEmailSubject()
    {
        $transactionalEmailHandler = $this->getTransactionalEmailHandlerMock(
            '{"errors":[{ "message":"Email subject missing", "code":"1202" }], "status":"errors"}'
        );
        $this->expectException(FreshMailTransactionalEmailException::class);
        $transactionalEmailHandler->sendTransactionalEmail('recipient@email.com', 'Email subject', 'Email content');
    }

    public function testNoEmailContent()
    {
        $transactionalEmailHandler = $this->getTransactionalEmailHandlerMock(
            '{"errors":[{ "message":"Email content missing", "code":"1203" }], "status":"errors"}'
        );
        $this->expectException(FreshMailTransactionalEmailException::class);
        $transactionalEmailHandler->sendTransactionalEmail('recipient@email.com', 'Email subject', 'Email content');
    }

    public function testWrongReplyToAddress()
    {
        $transactionalEmailHandler = $this->getTransactionalEmailHandlerMock(
            '{"errors":[{ "message":"Wrong replyTo email address", "code":"1204" }], "status":"errors"}'
        );
        $this->expectException(FreshMailTransactionalEmailException::class);
        $transactionalEmailHandler->sendTransactionalEmail('recipient@email.com', 'Email subject', 'Email content');
    }

    public function testWrongFromEmail()
    {
        $transactionalEmailHandler = $this->getTransactionalEmailHandlerMock(
            '{"errors":[{ "message":"Wrong from email", "code":"1205" }], "status":"errors"}'
        );
        $this->expectException(FreshMailTransactionalEmailException::class);
        $transactionalEmailHandler->sendTransactionalEmail('recipient@email.com', 'Email subject', 'Email content');
    }

    public function testEmptyFromName()
    {
        $transactionalEmailHandler = $this->getTransactionalEmailHandlerMock(
            '{"errors":[{ "message":"From name cannot be empty", "code":"1206" }], "status":"errors"}'
        );
        $this->expectException(FreshMailTransactionalEmailException::class);
        $transactionalEmailHandler->sendTransactionalEmail('recipient@email.com', 'Email subject', 'Email content');
    }

    public function testDailyLimitExceeded()
    {
        $transactionalEmailHandler = $this->getTransactionalEmailHandlerMock(
            '{"errors":[{ "message":"Daily limit exceeded", "code":"1207" }], "status":"errors"}'
        );
        $this->expectException(FreshMailTransactionalEmailException::class);
        $transactionalEmailHandler->sendTransactionalEmail('recipient@email.com', 'Email subject', 'Email content');
    }

    public function testUnsupportedEncoding()
    {
        $transactionalEmailHandler = $this->getTransactionalEmailHandlerMock(
            '{"errors":[{ "message":"Unsupported encoding", "code":"1208" }], "status":"errors"}'
        );
        $this->expectException(FreshMailTransactionalEmailException::class);
        $transactionalEmailHandler->sendTransactionalEmail('recipient@email.com', 'Email subject', 'Email content');
    }

    public function testIncorrectAttachmentUrl()
    {
        $transactionalEmailHandler = $this->getTransactionalEmailHandlerMock(
            '{"errors":[{ "message":"Wrong attachment URL", "code":"1209" }], "status":"errors"}'
        );
        $this->expectException(FreshMailTransactionalEmailException::class);
        $transactionalEmailHandler->sendTransactionalEmail('recipient@email.com', 'Email subject', 'Email content');
    }

    public function testAttachmentDoesntExist()
    {
        $transactionalEmailHandler = $this->getTransactionalEmailHandlerMock(
            '{"errors":[{ "message":"Attachment does not exist", "code":"1210" }], "status":"errors"}'
        );
        $this->expectException(FreshMailTransactionalEmailException::class);
        $transactionalEmailHandler->sendTransactionalEmail('recipient@email.com', 'Email subject', 'Email content');
    }

    public function testMaxAttachmentSizeExceeded()
    {
        $transactionalEmailHandler = $this->getTransactionalEmailHandlerMock(
            '{"errors":[{ "message":"Maximum attachment size exceeded", "code":"1211" }], "status":"errors"}'
        );
        $this->expectException(FreshMailTransactionalEmailException::class);
        $transactionalEmailHandler->sendTransactionalEmail('recipient@email.com', 'Email subject', 'Email content');
    }

    public function testIncorrectRebrandingDomain()
    {
        $transactionalEmailHandler = $this->getTransactionalEmailHandlerMock(
            '{"errors":[{ "message":"Incorrect rebranding domain", "code":"1212" }], "status":"errors"}'
        );
        $this->expectException(FreshMailTransactionalEmailException::class);
        $transactionalEmailHandler->sendTransactionalEmail('recipient@email.com', 'Email subject', 'Email content');
    }

    public function testIncorrectCampaignTag()
    {
        $transactionalEmailHandler = $this->getTransactionalEmailHandlerMock(
            '{"errors":[{ "message":"Incorrect campaign tag", "code":"1213" }], "status":"errors"}'
        );
        $this->expectException(FreshMailTransactionalEmailException::class);
        $transactionalEmailHandler->sendTransactionalEmail('recipient@email.com', 'Email subject', 'Email content');
    }

    public function testSystemError()
    {
        $transactionalEmailHandler = $this->getTransactionalEmailHandlerMock(
            '{"errors":[{ "message":"System error occurred", "code":"1250" }], "status":"errors"}'
        );
        $this->expectException(FreshMailTransactionalEmailException::class);
        $transactionalEmailHandler->sendTransactionalEmail('recipient@email.com', 'Email subject', 'Email content');
    }

    public function testSubscriberEmailBlocked()
    {
        $transactionalEmailHandler = $this->getTransactionalEmailHandlerMock(
            '{"errors":[{ "message":"The email address is blocked", "code":"1251" }], "status":"errors"}'
        );
        $this->expectException(FreshMailTransactionalEmailException::class);
        $transactionalEmailHandler->sendTransactionalEmail('recipient@email.com', 'Email subject', 'Email content');
    }
}