1035 regels
38 KiB
PHP
1035 regels
38 KiB
PHP
<?php
|
|
|
|
/**
|
|
* Copyright (c) D3 Data Development (Inh. Thomas Dartsch)
|
|
*
|
|
* For the full copyright and license information, please view
|
|
* the LICENSE file that was distributed with this source code.
|
|
*
|
|
* https://www.d3data.de
|
|
*
|
|
* @copyright (C) D3 Data Development (Inh. Thomas Dartsch)
|
|
* @author D3 Data Development - Daniel Seifert <info@shopmodule.com>
|
|
* @link https://www.oxidmodule.com
|
|
*/
|
|
|
|
declare(strict_types=1);
|
|
|
|
namespace D3\KlicktippPhpClient\tests\unit\Entities;
|
|
|
|
use D3\KlicktippPhpClient\Entities\Subscriber;
|
|
use D3\KlicktippPhpClient\Exceptions\InvalidCredentialTypeException;
|
|
use D3\KlicktippPhpClient\Exceptions\MissingEndpointException;
|
|
use D3\KlicktippPhpClient\Resources\Subscriber as SubscriberEndpoint;
|
|
use D3\KlicktippPhpClient\tests\TestCase;
|
|
use DateTime;
|
|
use Doctrine\Common\Collections\ArrayCollection;
|
|
use Generator;
|
|
use PHPUnit\Framework\MockObject\Rule\InvokedCount;
|
|
use ReflectionException;
|
|
|
|
/**
|
|
* @covers \D3\KlicktippPhpClient\Entities\Subscriber
|
|
*/
|
|
class SubscriberTest extends TestCase
|
|
{
|
|
public function setUp(): void
|
|
{
|
|
parent::setUp();
|
|
$this->entity = new Subscriber(
|
|
[
|
|
SubscriberEndpoint::ID => "155988456",
|
|
SubscriberEndpoint::LISTID => "368370",
|
|
SubscriberEndpoint::OPTIN => "28.12.2024 22:52:09",
|
|
SubscriberEndpoint::OPTIN_IP => "0.0.0.0 - By API Request",
|
|
SubscriberEndpoint::EMAIL => "testsubscriber@mydomain.com",
|
|
SubscriberEndpoint::STATUS => "Opt-In Pending",
|
|
SubscriberEndpoint::BOUNCE => "Not Bounced",
|
|
SubscriberEndpoint::DATE => "2024-12-24",
|
|
SubscriberEndpoint::IP => "0.0.0.0 - By API Request",
|
|
SubscriberEndpoint::UNSUBSCRIPTION => "unsubscription fixture",
|
|
SubscriberEndpoint::UNSUBSCRIPTION_IP => "0.0.0.0",
|
|
SubscriberEndpoint::REFERRER => "referrer fixture",
|
|
SubscriberEndpoint::SMS_PHONE => "1234567890",
|
|
SubscriberEndpoint::SMS_STATUS => "sms status fixture",
|
|
SubscriberEndpoint::SMS_BOUNCE => "sms bounce fixture",
|
|
SubscriberEndpoint::SMS_DATE => "2024-12-23",
|
|
// ToDo: is this date real
|
|
SubscriberEndpoint::SMS_UNSUBSCRIPTION => "2024-12-24 18:00:00",
|
|
SubscriberEndpoint::SMS_REFERRER => "sms referrer fixture",
|
|
SubscriberEndpoint::FIELD_FIRSTNAME => "firstName",
|
|
SubscriberEndpoint::FIELD_LASTNAME => "lastName",
|
|
SubscriberEndpoint::FIELD_COMPANYNAME => "",
|
|
SubscriberEndpoint::FIELD_STREET1 => "",
|
|
SubscriberEndpoint::FIELD_STREET2 => "",
|
|
SubscriberEndpoint::FIELD_CITY => "",
|
|
SubscriberEndpoint::FIELD_STATE => "",
|
|
SubscriberEndpoint::FIELD_ZIP => "",
|
|
SubscriberEndpoint::FIELD_COUNTRY => "",
|
|
SubscriberEndpoint::FIELD_PRIVATEPHONE => "",
|
|
SubscriberEndpoint::FIELD_MOBILEPHONE => "",
|
|
SubscriberEndpoint::FIELD_PHONE => "",
|
|
SubscriberEndpoint::FIELD_FAX => "",
|
|
SubscriberEndpoint::FIELD_WEBSITE => "",
|
|
SubscriberEndpoint::FIELD_BIRTHDAY => "",
|
|
SubscriberEndpoint::FIELD_LEADVALUE => "",
|
|
SubscriberEndpoint::TAGS => [
|
|
"12494453",
|
|
"12494463",
|
|
],
|
|
SubscriberEndpoint::MANUALTAGS => [
|
|
"12594453" => "125959453",
|
|
"12594454" => "125960453",
|
|
"12594455" => "125961453",
|
|
],
|
|
SubscriberEndpoint::SMARTTAGS => [
|
|
"12594456" => "125959453",
|
|
"12594457" => "125960453",
|
|
"12594458" => "125961453",
|
|
"12594459" => "125961453",
|
|
],
|
|
SubscriberEndpoint::CAMPAIGNSSTARTED => [
|
|
"12594456" => "125959453",
|
|
],
|
|
SubscriberEndpoint::CAMPAIGNSFINISHED => [
|
|
"12594456" => "125959453",
|
|
"12594457" => "125959453",
|
|
],
|
|
SubscriberEndpoint::NOTIFICATIONEMAILSSENT => [
|
|
"1570256" => "1730508478",
|
|
"1570257" => "1730508479",
|
|
"1570258" => "1730508480",
|
|
],
|
|
SubscriberEndpoint::NOTIFICATIONEMAILSOPENED => [
|
|
"1570256" => "1730508478",
|
|
"1570257" => "1730508479",
|
|
"1570258" => "1730508480",
|
|
"1570259" => "1730508481",
|
|
],
|
|
SubscriberEndpoint::NOTIFICATIONEMAILSCLICKED => [
|
|
"1570256" => "1730508478",
|
|
"1570257" => "1730508479",
|
|
"1570258" => "1730508480",
|
|
"1570259" => "1730508481",
|
|
"1570260" => "1730508482",
|
|
],
|
|
SubscriberEndpoint::NOTIFICATIONEMAILSVIEWED => [
|
|
"1570256" => "1730508478",
|
|
"1570257" => "1730508479",
|
|
"1570258" => "1730508480",
|
|
"1570259" => "1730508481",
|
|
"1570260" => "1730508482",
|
|
"1570261" => "1730508483",
|
|
],
|
|
SubscriberEndpoint::OUTBOUND => [
|
|
"1570256" => "1730508478",
|
|
],
|
|
]
|
|
);
|
|
}
|
|
|
|
/**
|
|
* @test
|
|
* @throws ReflectionException
|
|
* @covers \D3\KlicktippPhpClient\Entities\Subscriber::__construct
|
|
*/
|
|
public function testConstruct(): void
|
|
{
|
|
$elements = [
|
|
'key1' => 'value1',
|
|
'key2' => 'value2',
|
|
];
|
|
|
|
$endpoint = $this->getMockBuilder(SubscriberEndpoint::class)
|
|
->disableOriginalConstructor()
|
|
->getMock();
|
|
|
|
$sut = new Subscriber($elements, $endpoint);
|
|
|
|
$this->assertSame(
|
|
$elements,
|
|
$sut->toArray()
|
|
);
|
|
$this->assertSame(
|
|
$endpoint,
|
|
$this->getValue($sut, 'endpoint')
|
|
);
|
|
}
|
|
|
|
/**
|
|
* @test
|
|
* @throws ReflectionException
|
|
* @covers \D3\KlicktippPhpClient\Entities\Subscriber::getId
|
|
* @covers \D3\KlicktippPhpClient\Entities\Subscriber::getListId
|
|
* @covers \D3\KlicktippPhpClient\Entities\Subscriber::getOptinIp
|
|
* @covers \D3\KlicktippPhpClient\Entities\Subscriber::getEmailAddress
|
|
* @covers \D3\KlicktippPhpClient\Entities\Subscriber::getStatus
|
|
* @covers \D3\KlicktippPhpClient\Entities\Subscriber::getBounce
|
|
* @covers \D3\KlicktippPhpClient\Entities\Subscriber::getIp
|
|
* @covers \D3\KlicktippPhpClient\Entities\Subscriber::getUnsubscriptionIp
|
|
* @covers \D3\KlicktippPhpClient\Entities\Subscriber::getReferrer
|
|
* @covers \D3\KlicktippPhpClient\Entities\Subscriber::getSmsPhone
|
|
* @covers \D3\KlicktippPhpClient\Entities\Subscriber::getSmsStatus
|
|
* @covers \D3\KlicktippPhpClient\Entities\Subscriber::getSmsBounce
|
|
* @covers \D3\KlicktippPhpClient\Entities\Subscriber::getSmsReferrer
|
|
* @dataProvider getDataProvider
|
|
*/
|
|
public function testGet(string $methodName, string $expectedValue): void
|
|
{
|
|
$this->assertSame(
|
|
$expectedValue,
|
|
$this->callMethod($this->entity, $methodName)
|
|
);
|
|
}
|
|
|
|
/**
|
|
* @test
|
|
* @throws ReflectionException
|
|
* @covers \D3\KlicktippPhpClient\Entities\Subscriber::getId
|
|
* @covers \D3\KlicktippPhpClient\Entities\Subscriber::getListId
|
|
* @covers \D3\KlicktippPhpClient\Entities\Subscriber::getOptinIp
|
|
* @covers \D3\KlicktippPhpClient\Entities\Subscriber::getEmailAddress
|
|
* @covers \D3\KlicktippPhpClient\Entities\Subscriber::getStatus
|
|
* @covers \D3\KlicktippPhpClient\Entities\Subscriber::getBounce
|
|
* @covers \D3\KlicktippPhpClient\Entities\Subscriber::getIp
|
|
* @covers \D3\KlicktippPhpClient\Entities\Subscriber::getUnsubscriptionIp
|
|
* @covers \D3\KlicktippPhpClient\Entities\Subscriber::getReferrer
|
|
* @covers \D3\KlicktippPhpClient\Entities\Subscriber::getSmsPhone
|
|
* @covers \D3\KlicktippPhpClient\Entities\Subscriber::getSmsStatus
|
|
* @covers \D3\KlicktippPhpClient\Entities\Subscriber::getSmsBounce
|
|
* @covers \D3\KlicktippPhpClient\Entities\Subscriber::getSmsReferrer
|
|
* @dataProvider getDataProvider
|
|
*/
|
|
public function testGetNull(string $testMethod): void
|
|
{
|
|
$nullProperties = [];
|
|
foreach (array_keys($this->entity->toArray()) as $key) {
|
|
$nullProperties[$key] = null;
|
|
}
|
|
|
|
$sut = new Subscriber($nullProperties);
|
|
|
|
$this->assertNull(
|
|
$this->callMethod(
|
|
$sut,
|
|
$testMethod,
|
|
)
|
|
);
|
|
}
|
|
|
|
/**
|
|
* @test
|
|
* @throws ReflectionException
|
|
* @covers \D3\KlicktippPhpClient\Entities\Subscriber::getId
|
|
* @covers \D3\KlicktippPhpClient\Entities\Subscriber::getListId
|
|
* @covers \D3\KlicktippPhpClient\Entities\Subscriber::getOptinIp
|
|
* @covers \D3\KlicktippPhpClient\Entities\Subscriber::getEmailAddress
|
|
* @covers \D3\KlicktippPhpClient\Entities\Subscriber::getStatus
|
|
* @covers \D3\KlicktippPhpClient\Entities\Subscriber::getBounce
|
|
* @covers \D3\KlicktippPhpClient\Entities\Subscriber::getIp
|
|
* @covers \D3\KlicktippPhpClient\Entities\Subscriber::getUnsubscriptionIp
|
|
* @covers \D3\KlicktippPhpClient\Entities\Subscriber::getReferrer
|
|
* @covers \D3\KlicktippPhpClient\Entities\Subscriber::getSmsPhone
|
|
* @covers \D3\KlicktippPhpClient\Entities\Subscriber::getSmsStatus
|
|
* @covers \D3\KlicktippPhpClient\Entities\Subscriber::getSmsBounce
|
|
* @covers \D3\KlicktippPhpClient\Entities\Subscriber::getSmsReferrer
|
|
* @dataProvider getDataProvider
|
|
*/
|
|
public function testGetInvalid(string $testMethod): void
|
|
{
|
|
$invalidProperties = [
|
|
SubscriberEndpoint::ID => [],
|
|
SubscriberEndpoint::LISTID => [],
|
|
SubscriberEndpoint::OPTIN_IP => [],
|
|
SubscriberEndpoint::EMAIL => [],
|
|
SubscriberEndpoint::STATUS => [],
|
|
SubscriberEndpoint::BOUNCE => [],
|
|
SubscriberEndpoint::IP => [],
|
|
SubscriberEndpoint::UNSUBSCRIPTION_IP => [],
|
|
SubscriberEndpoint::REFERRER => [],
|
|
SubscriberEndpoint::SMS_PHONE => [],
|
|
SubscriberEndpoint::SMS_STATUS => [],
|
|
SubscriberEndpoint::SMS_BOUNCE => [],
|
|
SubscriberEndpoint::SMS_REFERRER => [],
|
|
];
|
|
|
|
$sut = new Subscriber($invalidProperties);
|
|
|
|
$this->expectException(InvalidCredentialTypeException::class);
|
|
|
|
$this->assertNull(
|
|
$this->callMethod(
|
|
$sut,
|
|
$testMethod,
|
|
)
|
|
);
|
|
}
|
|
|
|
public static function getDataProvider(): Generator
|
|
{
|
|
yield ['getId', '155988456'];
|
|
yield ['getListId', '368370'];
|
|
yield ['getOptinIp', '0.0.0.0 - By API Request'];
|
|
yield ['getEmailAddress', 'testsubscriber@mydomain.com'];
|
|
yield ['getStatus', 'Opt-In Pending'];
|
|
yield ['getBounce', 'Not Bounced'];
|
|
yield ['getIp', '0.0.0.0 - By API Request'];
|
|
yield ['getUnsubscriptionIp', '0.0.0.0'];
|
|
yield ['getReferrer', 'referrer fixture'];
|
|
yield ['getSmsPhone', '1234567890'];
|
|
yield ['getSmsStatus', 'sms status fixture'];
|
|
yield ['getSmsBounce', 'sms bounce fixture'];
|
|
yield ['getSmsReferrer', 'sms referrer fixture'];
|
|
}
|
|
|
|
/**
|
|
* @test
|
|
* @throws ReflectionException
|
|
* @covers \D3\KlicktippPhpClient\Entities\Subscriber::getOptinTime
|
|
* @covers \D3\KlicktippPhpClient\Entities\Subscriber::getDate
|
|
* @covers \D3\KlicktippPhpClient\Entities\Subscriber::getUnsubscription
|
|
* @covers \D3\KlicktippPhpClient\Entities\Subscriber::getSmsDate
|
|
* @covers \D3\KlicktippPhpClient\Entities\Subscriber::getSmsUnsubscription
|
|
* @dataProvider getTimesDataProvider
|
|
*/
|
|
public function testGetTimes($methodName): void
|
|
{
|
|
$sut = $this->getMockBuilder(Subscriber::class)
|
|
->onlyMethods(['getDateTimeFromValue'])
|
|
->getMock();
|
|
$sut->expects($this->once())->method('getDateTimeFromValue');
|
|
|
|
$this->callMethod($sut, $methodName);
|
|
}
|
|
|
|
/**
|
|
* @test
|
|
* @throws ReflectionException
|
|
* @covers \D3\KlicktippPhpClient\Entities\Subscriber::getOptinTime
|
|
* @covers \D3\KlicktippPhpClient\Entities\Subscriber::getDate
|
|
* @covers \D3\KlicktippPhpClient\Entities\Subscriber::getUnsubscription
|
|
* @covers \D3\KlicktippPhpClient\Entities\Subscriber::getSmsDate
|
|
* @covers \D3\KlicktippPhpClient\Entities\Subscriber::getSmsUnsubscription
|
|
* @dataProvider getTimesDataProvider
|
|
*/
|
|
public function testGetInvalidTimes($methodName): void
|
|
{
|
|
$invalidProperties = [
|
|
SubscriberEndpoint::DATE => [],
|
|
SubscriberEndpoint::SMS_DATE => [],
|
|
SubscriberEndpoint::OPTIN => [],
|
|
SubscriberEndpoint::UNSUBSCRIPTION => [],
|
|
SubscriberEndpoint::SMS_UNSUBSCRIPTION => [],
|
|
];
|
|
|
|
$sut = new Subscriber($invalidProperties);
|
|
|
|
$this->expectException(InvalidCredentialTypeException::class);
|
|
|
|
$this->callMethod($sut, $methodName);
|
|
}
|
|
|
|
/**
|
|
* @test
|
|
* @throws ReflectionException
|
|
* @covers \D3\KlicktippPhpClient\Entities\Subscriber::getOptinTime
|
|
* @covers \D3\KlicktippPhpClient\Entities\Subscriber::getDate
|
|
* @covers \D3\KlicktippPhpClient\Entities\Subscriber::getUnsubscription
|
|
* @covers \D3\KlicktippPhpClient\Entities\Subscriber::getSmsDate
|
|
* @covers \D3\KlicktippPhpClient\Entities\Subscriber::getSmsUnsubscription
|
|
* @dataProvider getTimesDataProvider
|
|
*/
|
|
public function testGetNullTimes($methodName): void
|
|
{
|
|
$nullProperties = [];
|
|
foreach (array_keys($this->entity->toArray()) as $key) {
|
|
$nullProperties[$key] = null;
|
|
}
|
|
|
|
$sut = new Subscriber($nullProperties);
|
|
|
|
$this->assertNull(
|
|
$this->callMethod($sut, $methodName)
|
|
);
|
|
}
|
|
|
|
public static function getTimesDataProvider(): Generator
|
|
{
|
|
yield ['getOptinTime'];
|
|
yield ['getDate'];
|
|
yield ['getUnsubscription'];
|
|
yield ['getSmsDate'];
|
|
yield ['getSmsUnsubscription'];
|
|
}
|
|
|
|
/**
|
|
* @test
|
|
* @throws ReflectionException
|
|
* @covers \D3\KlicktippPhpClient\Entities\Subscriber::getDateTimeFromValue
|
|
* @dataProvider getDateTimeFromValueDataProvider
|
|
*/
|
|
public function testGetDateTimeFromValue(?string $value, ?DateTime $expectedValue): void
|
|
{
|
|
$this->assertEquals(
|
|
$expectedValue,
|
|
$this->callMethod(
|
|
$this->entity,
|
|
'getDateTimeFromValue',
|
|
[$value]
|
|
)
|
|
);
|
|
}
|
|
|
|
public static function getDateTimeFromValueDataProvider(): Generator
|
|
{
|
|
yield 'null' => [null, null];
|
|
yield 'valid date' => ['2024-12-24', new DateTime('2024-12-24')];
|
|
yield 'valid date time' => ['28.12.2024 22:52:09', new DateTime('2024-12-28 22:52:09')];
|
|
yield 'invalid date time' => ['half-life 3 release date', null];
|
|
yield 'invalid' => ['', null];
|
|
}
|
|
|
|
/**
|
|
* @test
|
|
* @throws ReflectionException
|
|
* @covers \D3\KlicktippPhpClient\Entities\Subscriber::isOptedIn
|
|
* @dataProvider isOptedinDataProvider
|
|
*/
|
|
public function testIsOptedIn(?DateTime $optinTime, bool $expected): void
|
|
{
|
|
$sut = $this->getMockBuilder(Subscriber::class)
|
|
->onlyMethods(['getOptinTime'])
|
|
->getMock();
|
|
$sut->method('getOptinTime')->willReturn($optinTime);
|
|
|
|
$this->assertSame(
|
|
$expected,
|
|
$this->callMethod($sut, 'isOptedIn')
|
|
);
|
|
}
|
|
|
|
public static function isOptedinDataProvider(): Generator
|
|
{
|
|
yield 'null' => [null, false];
|
|
yield 'zero date' => [new DateTime('0000-00-00'), false];
|
|
yield 'in past' => [new DateTime('1980-12-24'), true];
|
|
yield 'in future' => [new DateTime('2040-12-24'), false];
|
|
}
|
|
|
|
/**
|
|
* @test
|
|
* @throws ReflectionException
|
|
* @covers \D3\KlicktippPhpClient\Entities\Subscriber::isSubscribed
|
|
* @dataProvider isSubscribedDataProvider
|
|
*/
|
|
public function testIsSubscribed(?string $status, bool $expected): void
|
|
{
|
|
$sut = $this->getMockBuilder(Subscriber::class)
|
|
->onlyMethods(['getStatus'])
|
|
->getMock();
|
|
$sut->method('getStatus')->willReturn($status);
|
|
|
|
$this->assertSame(
|
|
$expected,
|
|
$this->callMethod($sut, 'isSubscribed')
|
|
);
|
|
}
|
|
|
|
public static function isSubscribedDataProvider(): Generator
|
|
{
|
|
yield 'null' => [null, false];
|
|
yield 'empty term' => ['', false];
|
|
yield 'wrong term' => ['fixture', false];
|
|
yield 'right term' => [Subscriber::STATUS_SUBSCRIBED, true];
|
|
}
|
|
|
|
/**
|
|
* @test
|
|
* @throws ReflectionException
|
|
* @covers \D3\KlicktippPhpClient\Entities\Subscriber::isBounced
|
|
* @dataProvider isBouncedDataProvider
|
|
*/
|
|
public function testIsBounced(?string $status, bool $expected): void
|
|
{
|
|
$sut = $this->getMockBuilder(Subscriber::class)
|
|
->onlyMethods(['getBounce'])
|
|
->getMock();
|
|
$sut->method('getBounce')->willReturn($status);
|
|
|
|
$this->assertSame(
|
|
$expected,
|
|
$this->callMethod($sut, 'isBounced')
|
|
);
|
|
}
|
|
|
|
public static function isBouncedDataProvider(): Generator
|
|
{
|
|
yield 'null' => [null, true];
|
|
yield 'empty term' => ['', true];
|
|
yield 'right term' => ['fixture', true];
|
|
yield 'wrong term' => [Subscriber::BOUNCE_NOTBOUNCED, false];
|
|
}
|
|
|
|
/**
|
|
* @test
|
|
* @throws ReflectionException
|
|
* @covers \D3\KlicktippPhpClient\Entities\Subscriber::changeEmailAddress
|
|
* @covers \D3\KlicktippPhpClient\Entities\Subscriber::setSmsPhone
|
|
* @dataProvider changeEmailAddressDataProvider
|
|
*/
|
|
public function testChangeEmailAddress(
|
|
string $testMethodName,
|
|
string $fieldName
|
|
): void {
|
|
$sut = $this->getMockBuilder(Subscriber::class)
|
|
->onlyMethods(['set'])
|
|
->setConstructorArgs([[SubscriberEndpoint::ID => 'foo']])
|
|
->getMock();
|
|
$sut->expects($this->once())->method('set')->with(
|
|
$this->identicalTo($fieldName)
|
|
);
|
|
|
|
$this->callMethod(
|
|
$sut,
|
|
$testMethodName,
|
|
['newValue']
|
|
);
|
|
}
|
|
|
|
public static function changeEmailAddressDataProvider(): Generator
|
|
{
|
|
yield 'change email has endpoint' => ['changeEmailAddress', 'email'];
|
|
yield 'change email has no endpoint' => ['changeEmailAddress', 'email'];
|
|
yield 'set phone has endpoint' => ['setSmsPhone', 'sms_phone'];
|
|
yield 'set phone has no endpoint' => ['setSmsPhone', 'sms_phone'];
|
|
}
|
|
|
|
/**
|
|
* @test
|
|
* @return void
|
|
* @throws ReflectionException
|
|
* @covers \D3\KlicktippPhpClient\Entities\Subscriber::getFields
|
|
*/
|
|
public function testGetFields(): void
|
|
{
|
|
$fields = $this->callMethod(
|
|
$this->entity,
|
|
'getFields',
|
|
);
|
|
|
|
$this->assertInstanceOf(ArrayCollection::class, $fields);
|
|
$this->assertCount(16, $fields);
|
|
}
|
|
|
|
/**
|
|
* @test
|
|
* @throws ReflectionException
|
|
* @covers \D3\KlicktippPhpClient\Entities\Subscriber::getField
|
|
* @covers \D3\KlicktippPhpClient\Entities\Subscriber::getFieldLongName
|
|
* @dataProvider getFieldDataProvider
|
|
*/
|
|
public function testGetField(string $fieldName, string $expectedFieldName): void
|
|
{
|
|
$arrayCollectionMock = $this->getMockBuilder(ArrayCollection::class)
|
|
->onlyMethods(['get'])
|
|
->getMock();
|
|
$arrayCollectionMock->expects($this->once())->method('get')->with(
|
|
$this->identicalTo($expectedFieldName)
|
|
)->willReturn('expected');
|
|
|
|
$sut = $this->getMockBuilder(Subscriber::class)
|
|
->onlyMethods(['getFields'])
|
|
->getMock();
|
|
$sut->method('getFields')->willReturn($arrayCollectionMock);
|
|
|
|
$this->assertSame(
|
|
'expected',
|
|
$this->callMethod(
|
|
$sut,
|
|
'getField',
|
|
[$fieldName]
|
|
)
|
|
);
|
|
}
|
|
|
|
public static function getFieldDataProvider(): Generator
|
|
{
|
|
yield 'short field name' => ['FirstName', SubscriberEndpoint::FIELD_FIRSTNAME];
|
|
yield 'long field name' => ['fieldLastName', SubscriberEndpoint::FIELD_LASTNAME];
|
|
}
|
|
|
|
/**
|
|
* @test
|
|
* @throws ReflectionException
|
|
* @covers \D3\KlicktippPhpClient\Entities\Subscriber::setField
|
|
* @dataProvider setFieldDataProvider
|
|
*/
|
|
public function testSetField(
|
|
string $fieldName,
|
|
string $longFieldName
|
|
): void {
|
|
$sut = $this->getMockBuilder(Subscriber::class)
|
|
->onlyMethods(['set'])
|
|
->setConstructorArgs([[SubscriberEndpoint::ID => 'foo']])
|
|
->getMock();
|
|
$sut->expects($this->once())->method('set')->with(
|
|
$this->identicalTo($longFieldName)
|
|
);
|
|
|
|
$this->callMethod(
|
|
$sut,
|
|
'setField',
|
|
[$fieldName, 'newValue']
|
|
);
|
|
}
|
|
|
|
public static function setFieldDataProvider(): Generator
|
|
{
|
|
yield 'short field name' => ['FirstName', SubscriberEndpoint::FIELD_FIRSTNAME];
|
|
yield 'long field name' => ['fieldLastName', SubscriberEndpoint::FIELD_LASTNAME];
|
|
}
|
|
|
|
/**
|
|
* @test
|
|
* @throws ReflectionException
|
|
* @covers \D3\KlicktippPhpClient\Entities\Subscriber::getTags
|
|
* @covers \D3\KlicktippPhpClient\Entities\Subscriber::getManualTags
|
|
* @covers \D3\KlicktippPhpClient\Entities\Subscriber::getSmartTags
|
|
* @covers \D3\KlicktippPhpClient\Entities\Subscriber::getStartedCampaigns
|
|
* @covers \D3\KlicktippPhpClient\Entities\Subscriber::getFinishedCampaigns
|
|
* @covers \D3\KlicktippPhpClient\Entities\Subscriber::getSentNotificationEmails
|
|
* @covers \D3\KlicktippPhpClient\Entities\Subscriber::getOpenedNotificationEmails
|
|
* @covers \D3\KlicktippPhpClient\Entities\Subscriber::getClickedNotificationEmails
|
|
* @covers \D3\KlicktippPhpClient\Entities\Subscriber::getViewedNotificationEmails
|
|
* @covers \D3\KlicktippPhpClient\Entities\Subscriber::getOutbounds
|
|
* @dataProvider getTagsDataProvider
|
|
*/
|
|
public function testGetTags(string $methodName, int $expectedCount): void
|
|
{
|
|
$tags = $this->callMethod(
|
|
$this->entity,
|
|
$methodName,
|
|
);
|
|
|
|
$this->assertInstanceOf(ArrayCollection::class, $tags);
|
|
$this->assertCount($expectedCount, $tags);
|
|
}
|
|
|
|
/**
|
|
* @test
|
|
* @throws ReflectionException
|
|
* @covers \D3\KlicktippPhpClient\Entities\Subscriber::getTags
|
|
* @covers \D3\KlicktippPhpClient\Entities\Subscriber::getManualTags
|
|
* @covers \D3\KlicktippPhpClient\Entities\Subscriber::getSmartTags
|
|
* @covers \D3\KlicktippPhpClient\Entities\Subscriber::getStartedCampaigns
|
|
* @covers \D3\KlicktippPhpClient\Entities\Subscriber::getFinishedCampaigns
|
|
* @covers \D3\KlicktippPhpClient\Entities\Subscriber::getSentNotificationEmails
|
|
* @covers \D3\KlicktippPhpClient\Entities\Subscriber::getOpenedNotificationEmails
|
|
* @covers \D3\KlicktippPhpClient\Entities\Subscriber::getClickedNotificationEmails
|
|
* @covers \D3\KlicktippPhpClient\Entities\Subscriber::getViewedNotificationEmails
|
|
* @covers \D3\KlicktippPhpClient\Entities\Subscriber::getOutbounds
|
|
* @dataProvider getTagsDataProvider
|
|
*/
|
|
public function testGetNullTags(string $methodName): void
|
|
{
|
|
$nullProperties = [];
|
|
foreach (array_keys($this->entity->toArray()) as $key) {
|
|
$nullProperties[$key] = null;
|
|
}
|
|
|
|
$sut = new Subscriber($nullProperties);
|
|
|
|
$this->assertNull(
|
|
$this->callMethod(
|
|
$sut,
|
|
$methodName,
|
|
)
|
|
);
|
|
}
|
|
|
|
/**
|
|
* @test
|
|
* @throws ReflectionException
|
|
* @covers \D3\KlicktippPhpClient\Entities\Subscriber::getTags
|
|
* @covers \D3\KlicktippPhpClient\Entities\Subscriber::getManualTags
|
|
* @covers \D3\KlicktippPhpClient\Entities\Subscriber::getSmartTags
|
|
* @covers \D3\KlicktippPhpClient\Entities\Subscriber::getStartedCampaigns
|
|
* @covers \D3\KlicktippPhpClient\Entities\Subscriber::getFinishedCampaigns
|
|
* @covers \D3\KlicktippPhpClient\Entities\Subscriber::getSentNotificationEmails
|
|
* @covers \D3\KlicktippPhpClient\Entities\Subscriber::getOpenedNotificationEmails
|
|
* @covers \D3\KlicktippPhpClient\Entities\Subscriber::getClickedNotificationEmails
|
|
* @covers \D3\KlicktippPhpClient\Entities\Subscriber::getViewedNotificationEmails
|
|
* @covers \D3\KlicktippPhpClient\Entities\Subscriber::getOutbounds
|
|
* @dataProvider getTagsDataProvider
|
|
*/
|
|
public function testGetInvalidTags(string $methodName): void
|
|
{
|
|
$invalidProperties = [
|
|
SubscriberEndpoint::TAGS => "",
|
|
SubscriberEndpoint::MANUALTAGS => "",
|
|
SubscriberEndpoint::SMARTTAGS => "",
|
|
SubscriberEndpoint::CAMPAIGNSSTARTED => "",
|
|
SubscriberEndpoint::CAMPAIGNSFINISHED => "",
|
|
SubscriberEndpoint::NOTIFICATIONEMAILSSENT => "",
|
|
SubscriberEndpoint::NOTIFICATIONEMAILSOPENED => "",
|
|
SubscriberEndpoint::NOTIFICATIONEMAILSCLICKED => "",
|
|
SubscriberEndpoint::NOTIFICATIONEMAILSVIEWED => "",
|
|
SubscriberEndpoint::OUTBOUND => "",
|
|
];
|
|
|
|
$sut = new Subscriber($invalidProperties);
|
|
|
|
$this->expectException(InvalidCredentialTypeException::class);
|
|
|
|
$this->callMethod(
|
|
$sut,
|
|
$methodName,
|
|
);
|
|
}
|
|
|
|
public static function getTagsDataProvider(): Generator
|
|
{
|
|
yield ['getTags', 2];
|
|
yield ['getManualTags', 3];
|
|
yield ['getSmartTags', 4];
|
|
yield ['getStartedCampaigns', 1];
|
|
yield ['getFinishedCampaigns', 2];
|
|
yield ['getSentNotificationEmails', 3];
|
|
yield ['getOpenedNotificationEmails', 4];
|
|
yield ['getClickedNotificationEmails', 5];
|
|
yield ['getViewedNotificationEmails', 6];
|
|
yield ['getOutbounds', 1];
|
|
}
|
|
|
|
/**
|
|
* @test
|
|
* @throws ReflectionException
|
|
* @covers \D3\KlicktippPhpClient\Entities\Subscriber::isTagSet
|
|
* @dataProvider isTagSetDataProvider
|
|
*/
|
|
public function testIsTagSet(?array $currentTags, string $searchTagId, bool $expected): void
|
|
{
|
|
$tagList = is_null($currentTags) ?
|
|
null :
|
|
new ArrayCollection($currentTags);
|
|
|
|
$sut = $this->getMockBuilder(Subscriber::class)
|
|
->onlyMethods(['getTags'])
|
|
->getMock();
|
|
$sut->method('getTags')->willReturn($tagList);
|
|
|
|
$this->assertSame(
|
|
$expected,
|
|
$this->callMethod(
|
|
$sut,
|
|
'isTagSet',
|
|
[$searchTagId]
|
|
)
|
|
);
|
|
}
|
|
|
|
public static function isTagSetDataProvider(): Generator
|
|
{
|
|
yield 'existing tag' => [["12494453", "12494463"], '12494463', true];
|
|
yield 'missing tag' => [["12494453", "12494463"], '12495463', false];
|
|
yield 'null tag' => [null, '12495463', false];
|
|
}
|
|
|
|
/**
|
|
* @test
|
|
* @return void
|
|
* @covers \D3\KlicktippPhpClient\Entities\Subscriber::clearTags
|
|
* @throws ReflectionException
|
|
* @dataProvider clearTagsDataProvider
|
|
*/
|
|
public function testClearTags(?array $currentTagList, ?array $expectedTags): void
|
|
{
|
|
$entityMock = new Subscriber([SubscriberEndpoint::TAGS => $currentTagList]);
|
|
|
|
$this->callMethod(
|
|
$entityMock,
|
|
'clearTags'
|
|
);
|
|
|
|
is_null($expectedTags) ?
|
|
$this->assertNull($this->callMethod($entityMock, 'getTags')) :
|
|
$this->assertEquals(new ArrayCollection($expectedTags), $this->callMethod($entityMock, 'getTags'));
|
|
}
|
|
|
|
public static function clearTagsDataProvider(): Generator
|
|
{
|
|
yield 'tag list exists' => [["12494453","12494463"], []];
|
|
yield 'tag list empty' => [[], []];
|
|
yield 'tag list null' => [null, null];
|
|
}
|
|
|
|
/**
|
|
* @test
|
|
* @return void
|
|
* @covers \D3\KlicktippPhpClient\Entities\Subscriber::addTag
|
|
* @throws ReflectionException
|
|
* @dataProvider addTagDataProvider
|
|
*/
|
|
public function testAddTag(?array $currentTagList, ?array $expectedTagList): void
|
|
{
|
|
$entityMock = new Subscriber([SubscriberEndpoint::TAGS => $currentTagList]);
|
|
|
|
$this->callMethod(
|
|
$entityMock,
|
|
'addTag',
|
|
['78546214']
|
|
);
|
|
|
|
is_null($expectedTagList) ?
|
|
$this->assertNull($this->callMethod($entityMock, 'getTags')) :
|
|
$this->assertEquals(new ArrayCollection($expectedTagList), $this->callMethod($entityMock, 'getTags'));
|
|
}
|
|
|
|
public static function addTagDataProvider(): Generator
|
|
{
|
|
yield 'tag list exists' => [["12494453","12494463"], ["12494453","12494463", "78546214"]];
|
|
yield 'tag list empty' => [[], ["78546214"]];
|
|
yield 'tag list null' => [null, ["78546214"]];
|
|
}
|
|
|
|
/**
|
|
* @test
|
|
* @throws ReflectionException
|
|
* @covers \D3\KlicktippPhpClient\Entities\Subscriber::removeTag
|
|
* @dataProvider removeTagDataProvider
|
|
*/
|
|
public function testRemoveTag(?array $currentTagList, ?array $expectedTags): void
|
|
{
|
|
$entityMock = new Subscriber([SubscriberEndpoint::TAGS => $currentTagList]);
|
|
|
|
$this->callMethod(
|
|
$entityMock,
|
|
'removeTag',
|
|
['12494453']
|
|
);
|
|
|
|
is_null($expectedTags) ?
|
|
$this->assertNull($this->callMethod($entityMock, 'getTags')) :
|
|
$this->assertEquals(new ArrayCollection($expectedTags), $this->callMethod($entityMock, 'getTags'));
|
|
}
|
|
|
|
public static function removeTagDataProvider(): Generator
|
|
{
|
|
yield 'tag list exists' => [["12494453","12494463"], [1 => "12494463"]];
|
|
yield 'tag list empty' => [[], []];
|
|
yield 'tag list null' => [null, null];
|
|
}
|
|
|
|
/**
|
|
* @test
|
|
* @throws ReflectionException
|
|
* @covers \D3\KlicktippPhpClient\Entities\Subscriber::persist
|
|
* @dataProvider persistDataProvider
|
|
*/
|
|
public function testPersist(
|
|
bool $endpointSet,
|
|
?string $currentId,
|
|
InvokedCount $endpointInvocation,
|
|
InvokedCount $persistTagsInvocation,
|
|
?bool $expectedReturn
|
|
): void {
|
|
$endpointMock = $this->getMockBuilder(SubscriberEndpoint::class)
|
|
->disableOriginalConstructor()
|
|
->onlyMethods(['update'])
|
|
->getMock();
|
|
$endpointMock->expects($endpointInvocation)->method('update')->willReturn(true);
|
|
|
|
$sut = $this->getMockBuilder(Subscriber::class)
|
|
->setConstructorArgs([[SubscriberEndpoint::ID => $currentId], $endpointSet ? $endpointMock : null])
|
|
->onlyMethods(['persistTags'])
|
|
->getMock();
|
|
$sut->expects($persistTagsInvocation)->method('persistTags');
|
|
|
|
if (!$endpointSet) {
|
|
$this->expectException(MissingEndpointException::class);
|
|
}
|
|
|
|
$this->assertSame(
|
|
$expectedReturn,
|
|
$this->callMethod(
|
|
$sut,
|
|
'persist'
|
|
)
|
|
);
|
|
}
|
|
|
|
public static function persistDataProvider(): Generator
|
|
{
|
|
yield 'has endpoint' => [true, 'fixture', self::once(), self::once(), true];
|
|
yield 'has no endpoint' => [false, 'fixture', self::never(), self::never(), null];
|
|
yield 'has endpoint, no id' => [true, null, self::never(), self::never(), null];
|
|
}
|
|
|
|
/**
|
|
* @test
|
|
* @throws ReflectionException
|
|
* @covers \D3\KlicktippPhpClient\Entities\Subscriber::persistTags
|
|
* @dataProvider persistTagsDataProvider
|
|
*/
|
|
public function testPersistTags(
|
|
bool $endpointSet,
|
|
InvokedCount $endpointInvocation,
|
|
?array $currentTagList,
|
|
?array $newTagList,
|
|
InvokedCount $removeTagInvocation,
|
|
InvokedCount $setTagInvocation
|
|
): void {
|
|
$entityMock = $this->getMockBuilder(Subscriber::class)
|
|
->disableOriginalConstructor()
|
|
->onlyMethods(['getTags'])
|
|
->getMock();
|
|
$entityMock->method('getTags')->willReturn(
|
|
is_null($currentTagList) ? null : new ArrayCollection($currentTagList)
|
|
);
|
|
|
|
$endpointMock = $this->getMockBuilder(SubscriberEndpoint::class)
|
|
->disableOriginalConstructor()
|
|
->onlyMethods(['getEntity', 'tag', 'untag'])
|
|
->getMock();
|
|
$endpointMock->expects($endpointInvocation)->method('getEntity')->willReturn($entityMock);
|
|
$endpointMock->expects($setTagInvocation)->method('tag')->willReturn(true);
|
|
$endpointMock->expects($removeTagInvocation)->method('untag')->willReturn(true);
|
|
|
|
$sut = new Subscriber([SubscriberEndpoint::ID => 'foo', SubscriberEndpoint::EMAIL => 'mymail@mydomain.tld'], $endpointSet ? $endpointMock : null);
|
|
if ($newTagList) {
|
|
$sut->set('tags', $newTagList);
|
|
}
|
|
|
|
if (!$endpointSet) {
|
|
$this->expectException(MissingEndpointException::class);
|
|
}
|
|
|
|
$this->callMethod(
|
|
$sut,
|
|
'persistTags'
|
|
);
|
|
}
|
|
|
|
public static function persistTagsDataProvider(): Generator
|
|
{
|
|
yield 'has endpoint, tag removed' => [true, self::once(), ["12494453", "12494463"], ["12494453"], self::once(), self::never()];
|
|
yield 'has endpoint, tag added' => [true, self::once(), ["12494453", "12494463"], ["12494453","12494463","12494464"], self::never(), self::once()];
|
|
yield 'has endpoint, taglist equals' => [true, self::once(), ["12494453", "12494463"], ["12494453","12494463"], self::never(), self::never()];
|
|
yield 'has no endpoint' => [false, self::never(), ["12494453", "12494463"], null, self::never(), self::never()];
|
|
yield 'has endpoint, taglist null' => [true, self::once(), null, null, self::never(), self::never()];
|
|
}
|
|
|
|
/**
|
|
* @test
|
|
* @throws ReflectionException
|
|
* @covers \D3\KlicktippPhpClient\Entities\Subscriber::isManualTagSet
|
|
* @dataProvider isManualTagSetDataProvider
|
|
*/
|
|
public function testIsManualTagSet(string $searchTagId, bool $expected): void
|
|
{
|
|
$this->assertSame(
|
|
$expected,
|
|
$this->callMethod(
|
|
$this->entity,
|
|
'isManualTagSet',
|
|
[$searchTagId]
|
|
)
|
|
);
|
|
}
|
|
|
|
public static function isManualTagSetDataProvider(): Generator
|
|
{
|
|
yield 'existing tag' => ['12594453', true];
|
|
yield 'missing tag' => ['12605453', false];
|
|
}
|
|
|
|
/**
|
|
* @test
|
|
* @covers \D3\KlicktippPhpClient\Entities\Subscriber::getManualTagTime
|
|
* @covers \D3\KlicktippPhpClient\Entities\Subscriber::getSmartTagTime
|
|
* @covers \D3\KlicktippPhpClient\Entities\Subscriber::getStartedCampaignTime
|
|
* @covers \D3\KlicktippPhpClient\Entities\Subscriber::getFinishedCampaignTime
|
|
* @dataProvider getTagDataProvider
|
|
* @throws ReflectionException
|
|
*/
|
|
public function testGetTag(string $testMethodName, string $invokedMethodName): void
|
|
{
|
|
$fixtureDate = '2024-12-24 18:00:00';
|
|
$fixture = new DateTime($fixtureDate);
|
|
|
|
$tagsMock = $this->getMockBuilder(ArrayCollection::class)
|
|
->disableOriginalConstructor()
|
|
->onlyMethods(['get'])
|
|
->getMock();
|
|
$tagsMock->expects($this->once())->method('get')->with(
|
|
$this->identicalTo('searchTagId')
|
|
)->willReturn($fixtureDate);
|
|
|
|
$sut = $this->getMockBuilder(Subscriber::class)
|
|
->onlyMethods([$invokedMethodName])
|
|
->getMock();
|
|
$sut->method($invokedMethodName)->willReturn($tagsMock);
|
|
|
|
$this->assertEquals(
|
|
$fixture,
|
|
$this->callMethod(
|
|
$sut,
|
|
$testMethodName,
|
|
['searchTagId']
|
|
)
|
|
);
|
|
}
|
|
|
|
public static function getTagDataProvider(): Generator
|
|
{
|
|
yield ['getManualTagTime', 'getManualTags'];
|
|
yield ['getSmartTagTime', 'getSmartTags'];
|
|
yield ['getStartedCampaignTime', 'getStartedCampaigns'];
|
|
yield ['getFinishedCampaignTime', 'getFinishedCampaigns'];
|
|
}
|
|
|
|
/**
|
|
* @test
|
|
* @throws ReflectionException
|
|
* @covers \D3\KlicktippPhpClient\Entities\Subscriber::resubscribe
|
|
* @covers \D3\KlicktippPhpClient\Entities\Subscriber::getEndpoint
|
|
* @dataProvider resubscribeDataProvider
|
|
*/
|
|
public function testReSubscribe(
|
|
bool $endpointSet,
|
|
InvokedCount $subscribeExpections,
|
|
bool $isSubscribed
|
|
): void {
|
|
$endpointMock = $this->getMockBuilder(SubscriberEndpoint::class)
|
|
->disableOriginalConstructor()
|
|
->onlyMethods(['subscribe'])
|
|
->getMock();
|
|
$endpointMock->expects($subscribeExpections)->method('subscribe');
|
|
|
|
$sut = $this->getMockBuilder(Subscriber::class)
|
|
->setConstructorArgs([[], $endpointSet ? $endpointMock : null])
|
|
->onlyMethods(['isSubscribed', 'getEmailAddress'])
|
|
->getMock();
|
|
$sut->method('isSubscribed')->willReturn($isSubscribed);
|
|
$sut->method('getEmailAddress')->willReturn('mail@mydomain.tld');
|
|
|
|
if (!$endpointSet && !$isSubscribed) {
|
|
$this->expectException(MissingEndpointException::class);
|
|
}
|
|
|
|
$this->callMethod(
|
|
$sut,
|
|
'resubscribe',
|
|
['listId', 'tagid']
|
|
);
|
|
}
|
|
|
|
public static function resubscribeDataProvider(): Generator
|
|
{
|
|
yield 'already subscribed, has endpoint' => [true, self::never(), true];
|
|
yield 'unsubscribed, has endpoint' => [true, self::once(), false];
|
|
yield 'already subscribed, no endpoint' => [false, self::never(), true];
|
|
yield 'unsubscribed, no endpoint' => [false, self::never(), false];
|
|
}
|
|
}
|