661 regels
26 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
*/
2025-01-05 15:20:56 +01:00
declare(strict_types=1);
namespace D3\KlicktippPhpClient\tests\unit\Entities;
use D3\KlicktippPhpClient\Entities\Account;
use D3\KlicktippPhpClient\Exceptions\InvalidCredentialTypeException;
use D3\KlicktippPhpClient\Resources\Account as AccountEndpoint;
use D3\KlicktippPhpClient\tests\TestCase;
2025-01-04 00:52:19 +01:00
use Doctrine\Common\Collections\ArrayCollection;
use Generator;
use PHPUnit\Framework\MockObject\Rule\InvokedCount;
use ReflectionException;
/**
* @covers \D3\KlicktippPhpClient\Entities\Account
*/
class AccountTest extends TestCase
{
public function setUp(): void
{
parent::setUp();
$this->entity = new Account(
[
AccountEndpoint::UID => "1094633",
AccountEndpoint::STATUS => "1",
AccountEndpoint::TIER => 10000,
AccountEndpoint::USERGROUP => "16",
AccountEndpoint::USERNAME => "myUsername",
AccountEndpoint::EMAIL => "myemail@mydomain.com",
AccountEndpoint::FIRSTNAME => "John",
AccountEndpoint::LASTNAME => "Doe",
AccountEndpoint::COMPANY => "ShopCompany",
AccountEndpoint::WEBSITE => "https://mywebsite.com",
AccountEndpoint::STREET => "Unter den Linden 20",
AccountEndpoint::CITY => "Berlin",
AccountEndpoint::STATE => "",
AccountEndpoint::ZIP => "01100",
AccountEndpoint::COUNTRY => "DE",
AccountEndpoint::PHONE => "",
AccountEndpoint::FAX => "",
AccountEndpoint::AFFILIATE_ID => "197030",
AccountEndpoint::ACCESS_RIGHTS => [
"administer klicktipp" => false,
"access facebook audience" => false,
"access translation translater" => false,
"access translation admin" => false,
"use whitelabel domain" => false,
"access email editor" => true,
"access user segments" => false,
"access feature limiter" => true,
],
AccountEndpoint::SENDERS => [
"email" => [
2025-01-04 00:52:19 +01:00
"myemail@mydomain.com" => "myemail@mydomain.com (ohne DKIM Signatur <20> eingeschr<68>nkte Zustellbarkeit)",
],
"reply_email" => [
"myemail@mydomain.com" => "myemail@mydomain.com",
],
"sms" => [],
"defaultEmail" => "myemail@mydomain.com",
"defaultReplyEmail" => "myemail@mydomain.com",
"domains" => [],
"providers" => [],
"previewEmails" => [],
],
AccountEndpoint::GMAIL_PREVIEW => "gmail-inspector@klick-tipp.team",
AccountEndpoint::LIMITS => [
"automation" => "10",
"statistics" => "5",
],
AccountEndpoint::PREFERENCES => [
"colors" => [
"start" => "yellow-dark",
"decision" => "violet-dark",
"goal" => "",
"goto" => "violet-dark",
"wait" => "",
"start automation" => "yellow-dark",
"stop automation" => "pink-dark",
"exit" => "pink-dark",
"restart" => "pink-dark",
"email" => "blue-dark",
"sms" => "blue-dark",
"notify by email" => "blue-dark",
"notify by sms" => "blue-dark",
"outbound" => "blue-dark",
"facebook audience add" => "blue-dark",
"tagging" => "green-dark",
"untagging" => "pink-dark",
"unsubscribe" => "pink-dark",
"setfield" => "green-dark",
"detect name" => "green-dark",
"detect gender" => "green-dark",
"fullcontact" => "green-dark",
],
],
AccountEndpoint::SETTINGS => [
"PlainTextContentByUser" => 0,
],
AccountEndpoint::SHOW_OTHER_ACCOUNT_INFO => false,
AccountEndpoint::SHOW_SUPPORT_INFO => false,
AccountEndpoint::SUPPORT => [
"username" => "klicktipp_account_username",
"switchAccountsLink" => [
"href" => "https://app.klicktipp.com/user/me/subaccount/switch",
"title" => "Unterkonto wechseln",
],
],
AccountEndpoint::LANGUAGE => "de",
AccountEndpoint::SEGMENTS => [],
AccountEndpoint::CUSTOMER_DATA => [
"isActive" => true,
"email" => "myemail@mydomain.com",
"firstName" => "John",
"lastName" => "Doe",
"zipcode" => "01100",
"city" => "Berlin",
"street" => "Unter den Linden 20",
"country" => "DE",
"company" => "ShopCompany",
"product" => "KlickTipp Deluxe 10.000",
"order_id" => "",
"weight" => "1010",
"tier" => "10000",
"period" => 67,
"digistore_affiliate_name" => "",
"tracking_pixels" => "",
"apikeys" => false,
"subscriber_key" => "3xtlh8zavzz04zdc45",
"addOns" => [],
],
AccountEndpoint::SUBSCRIPTION_INFO => [
"category" => "Account Platinum",
"tier" => "10000",
"term" => "monatlich",
"period" => 67,
"productID" => "107",
"title" => "KlickTipp Deluxe 10.000",
"weight" => "1010",
"orderID" => "",
"machineCategory" => "klick-tipp-account-platinum",
"emailAddress" => "myemail@mydomain.com",
"groupId" => "16",
"aMemberId" => "179045",
],
AccountEndpoint::ACTIVE_PAYMENTS => [],
]
);
}
/**
* @test
* @throws ReflectionException
* @covers \D3\KlicktippPhpClient\Entities\Account::__construct
*/
public function testConstruct(): void
{
$elements = [
'key1' => 'value1',
'key2' => 'value2',
];
$endpoint = $this->getMockBuilder(AccountEndpoint::class)
->disableOriginalConstructor()
->getMock();
$sut = new Account($elements, $endpoint);
$this->assertSame(
$elements,
$sut->toArray()
);
}
2025-01-04 00:52:19 +01:00
/**
* @test
* @throws ReflectionException
* @covers \D3\KlicktippPhpClient\Entities\Account::getId
* @covers \D3\KlicktippPhpClient\Entities\Account::getStatus
* @covers \D3\KlicktippPhpClient\Entities\Account::getTier
* @covers \D3\KlicktippPhpClient\Entities\Account::getUsergroup
* @covers \D3\KlicktippPhpClient\Entities\Account::getEmail
* @covers \D3\KlicktippPhpClient\Entities\Account::getFirstname
* @covers \D3\KlicktippPhpClient\Entities\Account::getLastname
* @covers \D3\KlicktippPhpClient\Entities\Account::getCompany
* @covers \D3\KlicktippPhpClient\Entities\Account::getWebsite
* @covers \D3\KlicktippPhpClient\Entities\Account::getStreet
* @covers \D3\KlicktippPhpClient\Entities\Account::getCity
* @covers \D3\KlicktippPhpClient\Entities\Account::getState
* @covers \D3\KlicktippPhpClient\Entities\Account::getZIP
* @covers \D3\KlicktippPhpClient\Entities\Account::getCountry
* @covers \D3\KlicktippPhpClient\Entities\Account::getPhone
* @covers \D3\KlicktippPhpClient\Entities\Account::getFax
* @covers \D3\KlicktippPhpClient\Entities\Account::getAffiliateId
* @covers \D3\KlicktippPhpClient\Entities\Account::getAccessRights
* @covers \D3\KlicktippPhpClient\Entities\Account::getSenders
* @covers \D3\KlicktippPhpClient\Entities\Account::getGmailPreview
* @covers \D3\KlicktippPhpClient\Entities\Account::getLimits
* @covers \D3\KlicktippPhpClient\Entities\Account::getPreferences
* @covers \D3\KlicktippPhpClient\Entities\Account::getSettings
* @covers \D3\KlicktippPhpClient\Entities\Account::canShowOtherAccountInfo
* @covers \D3\KlicktippPhpClient\Entities\Account::canShowSupportInfo
* @covers \D3\KlicktippPhpClient\Entities\Account::getSupport
* @covers \D3\KlicktippPhpClient\Entities\Account::getLanguage
* @covers \D3\KlicktippPhpClient\Entities\Account::getSegments
* @covers \D3\KlicktippPhpClient\Entities\Account::getCustomerData
* @covers \D3\KlicktippPhpClient\Entities\Account::getSubscriptionInfo
* @covers \D3\KlicktippPhpClient\Entities\Account::getActivePayments
* @dataProvider getDataProvider
*/
public function testGet(string $testMethod, $expected): void
2025-01-04 00:52:19 +01:00
{
$this->assertEquals(
$expected,
2025-01-04 00:52:19 +01:00
$this->callMethod(
$this->entity,
$testMethod,
)
);
$this->assertEquals(
$expected,
$this->callMethod(
$this->entity,
$testMethod,
)
);
}
/**
* @test
* @throws ReflectionException
* @covers \D3\KlicktippPhpClient\Entities\Account::getId
* @covers \D3\KlicktippPhpClient\Entities\Account::getStatus
* @covers \D3\KlicktippPhpClient\Entities\Account::getTier
* @covers \D3\KlicktippPhpClient\Entities\Account::getUsergroup
* @covers \D3\KlicktippPhpClient\Entities\Account::getEmail
* @covers \D3\KlicktippPhpClient\Entities\Account::getFirstname
* @covers \D3\KlicktippPhpClient\Entities\Account::getLastname
* @covers \D3\KlicktippPhpClient\Entities\Account::getCompany
* @covers \D3\KlicktippPhpClient\Entities\Account::getWebsite
* @covers \D3\KlicktippPhpClient\Entities\Account::getStreet
* @covers \D3\KlicktippPhpClient\Entities\Account::getCity
* @covers \D3\KlicktippPhpClient\Entities\Account::getState
* @covers \D3\KlicktippPhpClient\Entities\Account::getZIP
* @covers \D3\KlicktippPhpClient\Entities\Account::getCountry
* @covers \D3\KlicktippPhpClient\Entities\Account::getPhone
* @covers \D3\KlicktippPhpClient\Entities\Account::getFax
* @covers \D3\KlicktippPhpClient\Entities\Account::getAffiliateId
* @covers \D3\KlicktippPhpClient\Entities\Account::getAccessRights
* @covers \D3\KlicktippPhpClient\Entities\Account::getSenders
* @covers \D3\KlicktippPhpClient\Entities\Account::getGmailPreview
* @covers \D3\KlicktippPhpClient\Entities\Account::getLimits
* @covers \D3\KlicktippPhpClient\Entities\Account::getPreferences
* @covers \D3\KlicktippPhpClient\Entities\Account::getSettings
* @covers \D3\KlicktippPhpClient\Entities\Account::canShowOtherAccountInfo
* @covers \D3\KlicktippPhpClient\Entities\Account::canShowSupportInfo
* @covers \D3\KlicktippPhpClient\Entities\Account::getSupport
* @covers \D3\KlicktippPhpClient\Entities\Account::getLanguage
* @covers \D3\KlicktippPhpClient\Entities\Account::getSegments
* @covers \D3\KlicktippPhpClient\Entities\Account::getCustomerData
* @covers \D3\KlicktippPhpClient\Entities\Account::getSubscriptionInfo
* @covers \D3\KlicktippPhpClient\Entities\Account::getActivePayments
* @dataProvider getDataProvider
*/
public function testGetNull(string $testMethod): void
{
$nullProperties = [];
foreach (array_keys($this->entity->toArray()) as $key) {
$nullProperties[$key] = null;
}
$sut = new Account($nullProperties);
$this->assertNull(
$this->callMethod(
$sut,
$testMethod,
)
);
}
/**
* @test
* @throws ReflectionException
* @covers \D3\KlicktippPhpClient\Entities\Account::getId
* @covers \D3\KlicktippPhpClient\Entities\Account::getStatus
* @covers \D3\KlicktippPhpClient\Entities\Account::getTier
* @covers \D3\KlicktippPhpClient\Entities\Account::getUsergroup
* @covers \D3\KlicktippPhpClient\Entities\Account::getEmail
* @covers \D3\KlicktippPhpClient\Entities\Account::getFirstname
* @covers \D3\KlicktippPhpClient\Entities\Account::getLastname
* @covers \D3\KlicktippPhpClient\Entities\Account::getCompany
* @covers \D3\KlicktippPhpClient\Entities\Account::getWebsite
* @covers \D3\KlicktippPhpClient\Entities\Account::getStreet
* @covers \D3\KlicktippPhpClient\Entities\Account::getCity
* @covers \D3\KlicktippPhpClient\Entities\Account::getState
* @covers \D3\KlicktippPhpClient\Entities\Account::getZIP
* @covers \D3\KlicktippPhpClient\Entities\Account::getCountry
* @covers \D3\KlicktippPhpClient\Entities\Account::getPhone
* @covers \D3\KlicktippPhpClient\Entities\Account::getFax
* @covers \D3\KlicktippPhpClient\Entities\Account::getAffiliateId
* @covers \D3\KlicktippPhpClient\Entities\Account::getAccessRights
* @covers \D3\KlicktippPhpClient\Entities\Account::getSenders
* @covers \D3\KlicktippPhpClient\Entities\Account::getGmailPreview
* @covers \D3\KlicktippPhpClient\Entities\Account::getLimits
* @covers \D3\KlicktippPhpClient\Entities\Account::getPreferences
* @covers \D3\KlicktippPhpClient\Entities\Account::getSettings
* @covers \D3\KlicktippPhpClient\Entities\Account::canShowOtherAccountInfo
* @covers \D3\KlicktippPhpClient\Entities\Account::canShowSupportInfo
* @covers \D3\KlicktippPhpClient\Entities\Account::getSupport
* @covers \D3\KlicktippPhpClient\Entities\Account::getLanguage
* @covers \D3\KlicktippPhpClient\Entities\Account::getSegments
* @covers \D3\KlicktippPhpClient\Entities\Account::getCustomerData
* @covers \D3\KlicktippPhpClient\Entities\Account::getSubscriptionInfo
* @covers \D3\KlicktippPhpClient\Entities\Account::getActivePayments
* @dataProvider getDataProvider
*/
public function testGetInvalidType(string $testMethod): void
{
$invalidProperties = [
AccountEndpoint::UID => [],
AccountEndpoint::STATUS => [],
AccountEndpoint::TIER => [],
AccountEndpoint::USERGROUP => [],
AccountEndpoint::USERNAME => [],
AccountEndpoint::EMAIL => [],
AccountEndpoint::FIRSTNAME => [],
AccountEndpoint::LASTNAME => [],
AccountEndpoint::COMPANY => [],
AccountEndpoint::WEBSITE => [],
AccountEndpoint::STREET => [],
AccountEndpoint::CITY => [],
AccountEndpoint::STATE => [],
AccountEndpoint::ZIP => [],
AccountEndpoint::COUNTRY => [],
AccountEndpoint::PHONE => [],
AccountEndpoint::FAX => [],
AccountEndpoint::AFFILIATE_ID => [],
AccountEndpoint::ACCESS_RIGHTS => 'string',
AccountEndpoint::SENDERS => 'string',
AccountEndpoint::GMAIL_PREVIEW => [],
AccountEndpoint::LIMITS => 'string',
AccountEndpoint::PREFERENCES => 'string',
AccountEndpoint::SETTINGS => 'string',
AccountEndpoint::SHOW_OTHER_ACCOUNT_INFO => [],
AccountEndpoint::SHOW_SUPPORT_INFO => [],
AccountEndpoint::SUPPORT => 'string',
AccountEndpoint::LANGUAGE => [],
AccountEndpoint::SEGMENTS => 'string',
AccountEndpoint::CUSTOMER_DATA => 'string',
AccountEndpoint::SUBSCRIPTION_INFO => 'string',
AccountEndpoint::ACTIVE_PAYMENTS => 'string',
];
$sut = new Account($invalidProperties);
$this->expectException(InvalidCredentialTypeException::class);
$this->assertNull(
$this->callMethod(
$sut,
$testMethod,
)
);
2025-01-04 00:52:19 +01:00
}
public static function getDataProvider(): Generator
{
yield ['getId', '1094633'];
yield ['getStatus', "1"];
yield ['getTier', 10000];
yield ['getUsergroup', "16"];
yield ['getEmail', "myemail@mydomain.com"];
yield ['getFirstname', "John"];
yield ['getLastname', "Doe"];
yield ['getCompany', "ShopCompany"];
yield ['getWebsite', "https://mywebsite.com"];
yield ['getStreet', "Unter den Linden 20"];
yield ['getCity', "Berlin"];
yield ['getState', ""];
yield ['getZIP', "01100"];
yield ['getCountry', "DE"];
yield ['getPhone', ""];
yield ['getFax', ""];
yield ['getAffiliateId', "197030"];
yield ['getAccessRights', new ArrayCollection([
"administer klicktipp" => false,
"access facebook audience" => false,
"access translation translater" => false,
"access translation admin" => false,
"use whitelabel domain" => false,
"access email editor" => true,
"access user segments" => false,
"access feature limiter" => true,
])];
yield ['getSenders', new ArrayCollection([
"email" => [
"myemail@mydomain.com" => "myemail@mydomain.com (ohne DKIM Signatur <20> eingeschr<68>nkte Zustellbarkeit)",
],
"reply_email" => [
"myemail@mydomain.com" => "myemail@mydomain.com",
],
"sms" => [],
"defaultEmail" => "myemail@mydomain.com",
"defaultReplyEmail" => "myemail@mydomain.com",
"domains" => [],
"providers" => [],
"previewEmails" => [],
])];
yield ['getGmailPreview', "gmail-inspector@klick-tipp.team"];
yield ['getLimits', new ArrayCollection([
"automation" => "10",
"statistics" => "5",
])];
yield ['getPreferences', new ArrayCollection([
"colors" => [
"start" => "yellow-dark",
"decision" => "violet-dark",
"goal" => "",
"goto" => "violet-dark",
"wait" => "",
"start automation" => "yellow-dark",
"stop automation" => "pink-dark",
"exit" => "pink-dark",
"restart" => "pink-dark",
"email" => "blue-dark",
"sms" => "blue-dark",
"notify by email" => "blue-dark",
"notify by sms" => "blue-dark",
"outbound" => "blue-dark",
"facebook audience add" => "blue-dark",
"tagging" => "green-dark",
"untagging" => "pink-dark",
"unsubscribe" => "pink-dark",
"setfield" => "green-dark",
"detect name" => "green-dark",
"detect gender" => "green-dark",
"fullcontact" => "green-dark",
],
])];
yield ['getSettings', new ArrayCollection([
"PlainTextContentByUser" => 0,
])];
yield ['canShowOtherAccountInfo', false];
yield ['canShowSupportInfo', false];
yield ['getSupport', new ArrayCollection([
"username" => "klicktipp_account_username",
"switchAccountsLink" => [
"href" => "https://app.klicktipp.com/user/me/subaccount/switch",
"title" => "Unterkonto wechseln",
],
])];
yield ['getLanguage', "de"];
yield ['getSegments', new ArrayCollection([])];
yield ['getCustomerData', new ArrayCollection([
"isActive" => true,
"email" => "myemail@mydomain.com",
"firstName" => "John",
"lastName" => "Doe",
"zipcode" => "01100",
"city" => "Berlin",
"street" => "Unter den Linden 20",
"country" => "DE",
"company" => "ShopCompany",
"product" => "KlickTipp Deluxe 10.000",
"order_id" => "",
"weight" => "1010",
"tier" => "10000",
"period" => 67,
"digistore_affiliate_name" => "",
"tracking_pixels" => "",
"apikeys" => false,
"subscriber_key" => "3xtlh8zavzz04zdc45",
"addOns" => [],
])];
yield ['getSubscriptionInfo', new ArrayCollection([
"category" => "Account Platinum",
"tier" => "10000",
"term" => "monatlich",
"period" => 67,
"productID" => "107",
"title" => "KlickTipp Deluxe 10.000",
"weight" => "1010",
"orderID" => "",
"machineCategory" => "klick-tipp-account-platinum",
"emailAddress" => "myemail@mydomain.com",
"groupId" => "16",
"aMemberId" => "179045",
])];
yield ['getActivePayments', new ArrayCollection()];
}
/**
* @test
* @throws ReflectionException
* @covers \D3\KlicktippPhpClient\Entities\Account::persist
* @dataProvider persistDataProvider
*/
public function testPersist(
bool $endpointSet,
InvokedCount $endpointInvocation,
?bool $expectedReturn
): void {
$endpointMock = $this->getMockBuilder(AccountEndpoint::class)
->disableOriginalConstructor()
->onlyMethods(['update'])
->getMock();
$endpointMock->expects($endpointInvocation)->method('update')->willReturn(true);
$sut = new Account([AccountEndpoint::UID => 'foo'], $endpointSet ? $endpointMock : null);
$this->assertSame(
$expectedReturn,
$this->callMethod(
$sut,
'persist'
)
);
}
public static function persistDataProvider(): Generator
{
yield 'has endpoint' => [true, self::once(), true];
yield 'has no endpoint' => [false, self::never(), null];
}
/**
* @test
* @throws ReflectionException
* @covers \D3\KlicktippPhpClient\Entities\Entity::getArrayCollectionFromValue
* @dataProvider getArrayCollectionFromValueDataProvider
*/
public function testGetArrayCollectionFromValue($value, ?ArrayCollection $expected, bool $expectException): void
{
if ($expectException) {
2025-01-08 15:29:51 +01:00
$this->expectException(InvalidCredentialTypeException::class);
}
$this->assertEquals(
$expected,
$this->callMethod(
$this->entity,
'getArrayCollectionFromValue',
[$value]
)
);
}
public static function getArrayCollectionFromValueDataProvider(): Generator
{
yield 'ArrayCollection' => [['foo' => 'bar'], new ArrayCollection(['foo' => 'bar']), false];
yield 'null' => [null, null, false];
yield 'wrong type' => ['string', null, true];
}
/**
* @test
* @throws ReflectionException
* @covers \D3\KlicktippPhpClient\Entities\Entity::getStringOrNullValue
* @dataProvider getStringOrNullValueDataProvider
*/
public function testGetStringOrNullValue($value, ?string $expected, bool $expectException): void
{
if ($expectException) {
2025-01-08 15:29:51 +01:00
$this->expectException(InvalidCredentialTypeException::class);
}
$this->assertEquals(
$expected,
$this->callMethod(
$this->entity,
'getStringOrNullValue',
[$value]
)
);
}
public static function getStringOrNullValueDataProvider(): Generator
{
yield 'string' => ['foobar', "foobar", false];
yield 'null' => [null, null, false];
yield 'wrong type' => [[], null, true];
}
/**
* @test
* @throws ReflectionException
* @covers \D3\KlicktippPhpClient\Entities\Entity::getIntOrNullValue
* @dataProvider getIntOrNullValueDataProvider
*/
public function testGetIntOrNullValue($value, ?int $expected, bool $expectException): void
{
if ($expectException) {
2025-01-08 15:29:51 +01:00
$this->expectException(InvalidCredentialTypeException::class);
}
$this->assertEquals(
$expected,
$this->callMethod(
$this->entity,
'getIntOrNullValue',
[$value]
)
);
}
public static function getIntOrNullValueDataProvider(): Generator
{
yield 'int' => [10000, 10000, false];
yield 'null' => [null, null, false];
yield 'wrong type' => [[], null, true];
}
/**
* @test
* @throws ReflectionException
* @covers \D3\KlicktippPhpClient\Entities\Entity::getBooleanOrNullValue
* @dataProvider getBooleanOrNullValueDataProvider
*/
public function testGetBooleanOrNullValue($value, ?bool $expected, bool $expectException): void
{
if ($expectException) {
2025-01-08 15:29:51 +01:00
$this->expectException(InvalidCredentialTypeException::class);
}
$this->assertEquals(
$expected,
$this->callMethod(
$this->entity,
'getBooleanOrNullValue',
[$value]
)
);
}
public static function getBooleanOrNullValueDataProvider(): Generator
{
yield 'true' => [true, true, false];
yield 'false' => [false, false, false];
yield 'null' => [null, null, false];
yield 'wrong type' => [[], null, true];
}
}