Туча доработок

- класс `PayingAgent`, покрытый тестами
- новые константы для тегов ФФД 1.05 `Ffd105Tags`
- `Entity::jsonSerialize()` object -> array (again)
- `TooManyException::$max` int -> float
- тесты по psr-4, потому что почему бы и нет
- некоторые провайдеры вынесены в `BasicTestCase`
- улучшен тест покупателя
pull/10/head
Anthony Axenov 2021-11-24 01:30:54 +08:00
parent b5a01debd2
commit 42d194116f
40 changed files with 622 additions and 192 deletions

View File

@ -57,9 +57,9 @@
}
},
"autoload-dev": {
"psr-4": {
"AtolOnlineTests\\": "tests/"
}
"classmap": [
"tests/"
]
},
"scripts": {
"test": "vendor/bin/phpunit --colors=always",

View File

@ -113,4 +113,4 @@ $kkt = $monitor->getOne($kkts->first()->serialNumber);
---
[Вернуться к содержанию](readme.md)
[Вернуться к содержанию](readme.md)

View File

@ -25,17 +25,17 @@ final class Constraints
* Максимальная длина email
*/
const MAX_LENGTH_EMAIL = 64;
/**
* Максимальная длина логина ККТ
*/
const MAX_LENGTH_LOGIN = 100;
/**
* Максимальная длина пароля ККТ
*/
const MAX_LENGTH_PASSWORD = 100;
/**
* Максимальная длина адреса места расчётов
*/
@ -116,17 +116,31 @@ final class Constraints
/**
* Максимальная длина имени кассира (1021)
*
* @see https://online.atol.ru/files/API_atol_online_v4.pdf Документация, стр 32
*/
const MAX_LENGTH_CASHIER_NAME = 64;
/**
* Регулярное выражание для валидации строки ИНН
*
* @see https://online.atol.ru/possystem/v4/schema/sell Схема "#/receipt/client/inn"
*/
const PATTERN_INN = "/(^[0-9]{10}$)|(^[0-9]{12}$)/";
const PATTERN_INN = /* @lang PhpRegExp */
'/(^[\d]{10}$)|(^[\d]{12}$)/';
/**
* Регулярное выражение для валидации номера телефона
*
* @see https://online.atol.ru/possystem/v4/schema/sell Схема "#/definitions/phone_number"
*/
const PATTERN_PHONE = /* @lang PhpRegExp */
'/^([^\s\\\]{0,17}|\+[^\s\\\]{1,18})$/';
/**
* Регулярное выражание для валидации строки Callback URL
*/
const PATTERN_CALLBACK_URL = "/^http(s?)\:\/\/[0-9a-zA-Zа-яА-Я]([-.\w]*[0-9a-zA-Zа-яА-Я])*(:(0-9)*)*(\/?)([a-zAZ0-9а-яА-Я\-\.\?\,\'\/\\\+&=%\$#_]*)?$/";
}
const PATTERN_CALLBACK_URL = /* @lang PhpRegExp */
'/^http(s?)\:\/\/[0-9a-zA-Zа-яА-Я]' .
'([-.\w]*[0-9a-zA-Zа-яА-Я])*(:(0-9)*)*(\/?)([a-zAZ0-9а-яА-Я\-\.\?\,\'\/\\\+&=%\$#_]*)?$/';
}

View File

@ -0,0 +1,86 @@
<?php
/*
* Copyright (c) 2020-2021 Антон Аксенов (Anthony Axenov)
*
* This code is licensed under MIT.
* Этот код распространяется по лицензии MIT.
* https://github.com/anthonyaxenov/atol-online/blob/master/LICENSE
*/
namespace AtolOnline\Constants;
/**
* Константы тегов ФФД 1.05
*/
final class Ffd105Tags
{
/**
* Телефон или электронный адрес покупателя
*/
const CLIENT_CONTACT = 1008;
/**
* Наименование организации или фамилия, имя, отчество (при наличии), серия и номер паспорта покупателя (клиента)
*/
const CLIENT_NAME = 1227;
/**
* ИНН организации или покупателя (клиента)
*/
const CLIENT_INN = 1228;
/**
* Адрес электронной почты отправителя чека
*/
const COMPANY_EMAIL = 1117;
/**
* ИНН пользователя
*/
const COMPANY_INN = 1008;
/**
* Место расчетов
*/
const COMPANY_PADDRESS = 1187;
/**
* ИНН оператора перевода
*/
const MTO_INN = 1016;
/**
* Телефон платежного агента
*/
const PAGENT_PHONE = 1073;
/**
* ИНН поставщика
*/
const SUPPLIER_INN = 1226;
/**
* Кассир
*/
const CASHIER = 1021;
/**
* Наименование предмета расчета
*/
const ITEM_NAME = 1030;
/**
* Цена за единицу предмета расчета с учетом скидок и наценок
*/
const ITEM_PRICE = 1079;
/**
* Единица измерения предмета расчета
*/
const ITEM_MEASURE = 1197;
/**
* Дополнительный реквизит предмета расчета
*/
const ITEM_USERDATA = 1191;
}

View File

@ -17,8 +17,8 @@ use AtolOnline\{
Exceptions\InvalidInnLengthException,
Exceptions\TooLongClientContactException,
Exceptions\TooLongClientNameException,
Exceptions\TooLongEmailException,
Exceptions\TooLongItemNameException};
Exceptions\TooLongEmailException
};
/**
* Класс Client, описывающий сущность покупателя
@ -50,11 +50,11 @@ class Client extends Entity
/**
* Конструктор объекта покупателя
*
* @param string|null $name Наименование. Тег ФФД - 1227.
* @param string|null $phone Email. Тег ФФД - 1008.
* @param string|null $email Телефон покупателя. Тег ФФД - 1008.
* @param string|null $inn ИНН. Тег ФФД - 1228.
* @throws TooLongItemNameException
* @param string|null $name Наименование (1227)
* @param string|null $phone Email (1008)
* @param string|null $email Телефон покупателя (1008)
* @param string|null $inn ИНН (1228)
* @throws TooLongClientNameException
* @throws TooLongClientContactException
* @throws TooLongEmailException
* @throws InvalidEmailException
@ -90,6 +90,7 @@ class Client extends Entity
*
* Тег ФФД - 1227
*
* @todo улучшить валидацию по Constraints::PATTERN_PHONE
* @param string|null $name
* @return $this
* @throws TooLongClientNameException
@ -203,13 +204,13 @@ class Client extends Entity
/**
* @inheritDoc
*/
public function jsonSerialize(): object
public function jsonSerialize(): array
{
$json = [];
$this->getName() && $json['name'] = $this->getName();
$this->getEmail() && $json['email'] = $this->getEmail();
$this->getPhone() && $json['phone'] = $this->getPhone();
$this->getInn() && $json['inn'] = $this->getInn();
return (object)$json;
return $json;
}
}

View File

@ -205,9 +205,9 @@ class Company extends Entity
* @throws InvalidInnLengthException
* @throws InvalidPaymentAddressException
*/
public function jsonSerialize(): object
public function jsonSerialize(): array
{
return (object)[
return [
'email' => $this->email
? $this->getEmail()
: throw new InvalidEmailException(),
@ -222,4 +222,4 @@ class Company extends Entity
: throw new InvalidPaymentAddressException(),
];
}
}
}

View File

@ -123,12 +123,12 @@ class CorrectionInfo extends Entity
/**
* @inheritDoc
*/
public function jsonSerialize(): object
public function jsonSerialize(): array
{
return (object)[
'type' => $this->getType() ?? '', // обязателен
'base_date' => $this->getDate() ?? '', // обязателен
'base_number' => $this->getNumber() ?? '', // обязателен
return [
'type' => $this->getType() ?? '',
'base_date' => $this->getDate() ?? '',
'base_number' => $this->getNumber() ?? '',
];
}
}
}

View File

@ -129,8 +129,8 @@ final class Kkt extends Entity
/**
* @inheritDoc
*/
public function jsonSerialize()
public function jsonSerialize(): array
{
return $this->data;
return (array)$this->data;
}
}

View File

@ -0,0 +1,123 @@
<?php
/*
* Copyright (c) 2020-2021 Антон Аксенов (Anthony Axenov)
*
* This code is licensed under MIT.
* Этот код распространяется по лицензии MIT.
* https://github.com/anthonyaxenov/atol-online/blob/master/LICENSE
*/
declare(strict_types = 1);
namespace AtolOnline\Entities;
use AtolOnline\Constants\Constraints;
use AtolOnline\Exceptions\InvalidPhoneException;
use AtolOnline\Exceptions\TooLongPayingAgentOperationException;
use Illuminate\Support\Collection;
/**
* Класс, описывающий данные платёжного агента
*
* @see https://online.atol.ru/files/API_atol_online_v4.pdf Документация, стр 19
*/
class PayingAgent extends Entity
{
/**
* @var string|null Наименование операции (1044)
*/
protected ?string $operation = null;
/**
* @var Collection Телефоны платежного агента (1073)
*/
protected Collection $phones;
/**
* Конструктор
*
* @param string|null $operation Наименование операции (1044)
* @param array|Collection|null $phones Телефоны платежного агента (1073)
* @throws TooLongPayingAgentOperationException
* @throws InvalidPhoneException
*/
public function __construct(
?string $operation = null,
array|Collection|null $phones = null,
) {
!is_null($operation) && $this->setOperation($operation);
$this->setPhones($phones);
}
/**
* Устанавливает операцию
*
* @param string|null $operation
* @return $this
* @throws TooLongPayingAgentOperationException
*/
public function setOperation(?string $operation): self
{
if (!is_null($operation)) {
$operation = trim($operation);
if (mb_strlen($operation) > Constraints::MAX_LENGTH_PAYING_AGENT_OPERATION) {
throw new TooLongPayingAgentOperationException($operation);
}
}
$this->operation = empty($operation) ? null : $operation;
return $this;
}
/**
* Вoзвращает установленную операцию
*
* @return string|null
*/
public function getOperation(): ?string
{
return $this->operation;
}
/**
* Устанавливает массив номеров телефонов
*
* @param array|Collection|null $phones
* @return $this
* @throws InvalidPhoneException
*/
public function setPhones(array|Collection|null $phones): self
{
if (!is_null($phones)) {
$phones = is_array($phones) ? collect($phones) : $phones;
$phones->each(function ($phone) {
$phone = preg_replace('/[^\d]/', '', trim($phone));
if (preg_match(Constraints::PATTERN_PHONE, $phone) != 1) {
throw new InvalidPhoneException($phone);
}
});
}
$this->phones = empty($phones) ? collect() : $phones;
return $this;
}
/**
* Возвращает установленные
*
* @return Collection
*/
public function getPhones(): Collection
{
return $this->phones;
}
/**
* @inheritDoc
*/
public function jsonSerialize(): array
{
$json = [];
$this->getOperation() && $json['operation'] = $this->getOperation();
!$this->getPhones()->isEmpty() && $json['phones'] = $this->getPhones()->toArray();
return $json;
}
}

View File

@ -11,12 +11,18 @@ declare(strict_types = 1);
namespace AtolOnline\Exceptions;
use AtolOnline\Constants\Ffd105Tags;
/**
* Исключение, возникающее при попытке указать пустой email
*
* @see https://online.atol.ru/files/API_atol_online_v4.pdf Документация, стр 17
*/
class EmptyEmailException extends AtolException
{
protected $message = 'Email не может быть пустым';
protected array $ffd_tags = [1008, 1117];
protected array $ffd_tags = [
Ffd105Tags::CLIENT_CONTACT,
Ffd105Tags::COMPANY_EMAIL,
];
}

View File

@ -11,13 +11,19 @@ declare(strict_types = 1);
namespace AtolOnline\Exceptions;
use AtolOnline\Constants\Ffd105Tags;
/**
* Исключение, возникающее при ошибке валидации email
*
* @see https://online.atol.ru/files/API_atol_online_v4.pdf Документация, стр 17
*/
class InvalidEmailException extends AtolException
{
protected array $ffd_tags = [1008, 1117];
protected array $ffd_tags = [
Ffd105Tags::CLIENT_CONTACT,
Ffd105Tags::COMPANY_EMAIL,
];
/**
* Конструктор

View File

@ -11,12 +11,19 @@ declare(strict_types = 1);
namespace AtolOnline\Exceptions;
use AtolOnline\Constants\Ffd105Tags;
/**
* Исключение, возникающее при попытке указать ИНН некорректной длины
*/
class InvalidInnLengthException extends AtolException
{
protected array $ffd_tags = [1016, 1018, 1226, 1228];
protected array $ffd_tags = [
Ffd105Tags::MTO_INN,
Ffd105Tags::COMPANY_INN,
Ffd105Tags::SUPPLIER_INN,
Ffd105Tags::CLIENT_INN,
];
/**
* Конструктор

View File

@ -11,13 +11,16 @@ declare(strict_types = 1);
namespace AtolOnline\Exceptions;
use AtolOnline\Constants\Ffd105Tags;
/**
* Исключение, возникающее при попытке указать некорректный адрес места расчётов
*
* @see https://online.atol.ru/files/API_atol_online_v4.pdf Документация, стр 35
*/
class InvalidPaymentAddressException extends AtolException
{
protected array $ffd_tags = [1187];
protected array $ffd_tags = [Ffd105Tags::COMPANY_PADDRESS];
/**
* Конструктор

View File

@ -0,0 +1,35 @@
<?php
/*
* Copyright (c) 2020-2021 Антон Аксенов (Anthony Axenov)
*
* This code is licensed under MIT.
* Этот код распространяется по лицензии MIT.
* https://github.com/anthonyaxenov/atol-online/blob/master/LICENSE
*/
declare(strict_types = 1);
namespace AtolOnline\Exceptions;
use AtolOnline\Constants\Ffd105Tags;
/**
* Исключение, возникающее при ошибке валидации телефона
*/
class InvalidPhoneException extends AtolException
{
protected array $ffd_tags = [
Ffd105Tags::CLIENT_CONTACT,
Ffd105Tags::PAGENT_PHONE,
];
/**
* Конструктор
*
* @param string $phone
*/
public function __construct(string $phone = '')
{
parent::__construct("Невалидный номер телефона: '$phone'");
}
}

View File

@ -11,20 +11,15 @@ declare(strict_types = 1);
namespace AtolOnline\Exceptions;
use AtolOnline\Constants\Constraints;
use AtolOnline\Constants\Ffd105Tags;
/**
* Исключение, возникающее при попытке указать слишком высокую цену (сумму)
*/
class TooHighPriceException extends TooManyException
{
/**
* @inheritDoc
*/
protected array $ffd_tags = [
1079,
];
/**
* @var string Сообщение об ошибке
*/
protected $message = 'Price is too high';
}
protected $message = 'Слишком высокая цена';
protected array $ffd_tags = [Ffd105Tags::ITEM_PRICE];
protected float $max = Constraints::MAX_COUNT_ITEM_PRICE;
}

View File

@ -19,5 +19,5 @@ use AtolOnline\Constants\Constraints;
class TooLongCallbackUrlException extends TooLongException
{
protected $message = 'Слишком длинный адрес колбека';
protected int $max = Constraints::MAX_LENGTH_CALLBACK_URL;
protected float $max = Constraints::MAX_LENGTH_CALLBACK_URL;
}

View File

@ -12,6 +12,7 @@ declare(strict_types = 1);
namespace AtolOnline\Exceptions;
use AtolOnline\Constants\Constraints;
use AtolOnline\Constants\Ffd105Tags;
/**
* Исключение, возникающее при попытке указать слишком длинное имя кассира
@ -19,6 +20,6 @@ use AtolOnline\Constants\Constraints;
class TooLongCashierException extends TooLongException
{
protected $message = 'Слишком длинное имя кассира';
protected int $max = Constraints::MAX_LENGTH_CASHIER_NAME;
protected array $ffd_tags = [1021];
protected float $max = Constraints::MAX_LENGTH_CASHIER_NAME;
protected array $ffd_tags = [Ffd105Tags::CASHIER];
}

View File

@ -12,6 +12,7 @@ declare(strict_types = 1);
namespace AtolOnline\Exceptions;
use AtolOnline\Constants\Constraints;
use AtolOnline\Constants\Ffd105Tags;
/**
* Исключение, возникающее при попытке указать слишком длинный телефон или email покупателя
@ -19,6 +20,6 @@ use AtolOnline\Constants\Constraints;
class TooLongClientContactException extends TooLongException
{
protected $message = 'Cлишком длинный телефон или email покупателя';
protected int $max = Constraints::MAX_LENGTH_CLIENT_CONTACT;
protected array $ffd_tags = [1008];
protected float $max = Constraints::MAX_LENGTH_CLIENT_CONTACT;
protected array $ffd_tags = [Ffd105Tags::CLIENT_CONTACT];
}

View File

@ -12,6 +12,7 @@ declare(strict_types = 1);
namespace AtolOnline\Exceptions;
use AtolOnline\Constants\Constraints;
use AtolOnline\Constants\Ffd105Tags;
/**
* Исключение, возникающее при попытке указать слишком длинное наименование покупателя
@ -19,6 +20,6 @@ use AtolOnline\Constants\Constraints;
class TooLongClientNameException extends TooLongException
{
protected $message = 'Cлишком длинное наименование покупателя';
protected int $max = Constraints::MAX_LENGTH_CLIENT_NAME;
protected array $ffd_tags = [1227];
protected float $max = Constraints::MAX_LENGTH_CLIENT_NAME;
protected array $ffd_tags = [Ffd105Tags::CLIENT_NAME];
}

View File

@ -12,6 +12,7 @@ declare(strict_types = 1);
namespace AtolOnline\Exceptions;
use AtolOnline\Constants\Constraints;
use AtolOnline\Constants\Ffd105Tags;
/**
* Исключение, возникающее при попытке указать слишком длинный email
@ -19,6 +20,9 @@ use AtolOnline\Constants\Constraints;
class TooLongEmailException extends TooLongException
{
protected $message = 'Слишком длинный email';
protected int $max = Constraints::MAX_LENGTH_EMAIL;
protected array $ffd_tags = [1008, 1117];
protected float $max = Constraints::MAX_LENGTH_EMAIL;
protected array $ffd_tags = [
Ffd105Tags::CLIENT_CONTACT,
Ffd105Tags::COMPANY_EMAIL,
];
}

View File

@ -22,9 +22,9 @@ class TooLongException extends AtolException
protected $message = 'Слишком длинное значение';
/**
* @var int Максимальная длина строки
* @var float Максимальная длина строки
*/
protected int $max = 0;
protected float $max = 0;
/**
* Конструктор

View File

@ -11,7 +11,10 @@ declare(strict_types = 1);
namespace AtolOnline\Exceptions;
use AtolOnline\Constants\Constraints;
use AtolOnline\Constants\{
Constraints,
Ffd105Tags
};
/**
* Исключение, возникающее при попытке указать слишком длинное имя
@ -19,6 +22,6 @@ use AtolOnline\Constants\Constraints;
class TooLongItemNameException extends TooLongException
{
protected $message = 'Слишком длинное наименование предмета расчёта';
protected int $max = Constraints::MAX_LENGTH_ITEM_NAME;
protected array $ffd_tags = [1030];
protected float $max = Constraints::MAX_LENGTH_ITEM_NAME;
protected array $ffd_tags = [Ffd105Tags::ITEM_NAME];
}

View File

@ -19,5 +19,5 @@ use AtolOnline\Constants\Constraints;
class TooLongLoginException extends TooLongException
{
protected $message = 'Слишком длинный логин';
protected int $max = Constraints::MAX_LENGTH_LOGIN;
protected float $max = Constraints::MAX_LENGTH_LOGIN;
}

View File

@ -19,5 +19,5 @@ use AtolOnline\Constants\Constraints;
class TooLongPasswordException extends TooLongException
{
protected $message = 'Слишком длинный пароль';
protected int $max = Constraints::MAX_LENGTH_PASSWORD;
protected float $max = Constraints::MAX_LENGTH_PASSWORD;
}

View File

@ -11,7 +11,10 @@ declare(strict_types = 1);
namespace AtolOnline\Exceptions;
use AtolOnline\Constants\Constraints;
use AtolOnline\Constants\{
Constraints,
Ffd105Tags
};
/**
* Исключение, возникающее при попытке указать слишком длинную операцию для платёжного агента
@ -19,6 +22,6 @@ use AtolOnline\Constants\Constraints;
class TooLongPayingAgentOperationException extends TooLongException
{
protected $message = 'Слишком длинное yаименование операции платёжного агента';
protected int $max = Constraints::MAX_LENGTH_PAYING_AGENT_OPERATION;
protected array $ffd_tags = [1073];
protected float $max = Constraints::MAX_LENGTH_PAYING_AGENT_OPERATION;
protected array $ffd_tags = [Ffd105Tags::PAGENT_PHONE];
}

View File

@ -12,6 +12,7 @@ declare(strict_types = 1);
namespace AtolOnline\Exceptions;
use AtolOnline\Constants\Constraints;
use AtolOnline\Constants\Ffd105Tags;
/**
* Исключение, возникающее при попытке указать слишком длинный адрес места расчётов
@ -19,6 +20,6 @@ use AtolOnline\Constants\Constraints;
class TooLongPaymentAddressException extends TooLongException
{
protected $message = 'Слишком длинный адрес места расчётов';
protected int $max = Constraints::MAX_LENGTH_PAYMENT_ADDRESS;
protected array $ffd_tags = [1187];
protected float $max = Constraints::MAX_LENGTH_PAYMENT_ADDRESS;
protected array $ffd_tags = [Ffd105Tags::COMPANY_PADDRESS];
}

View File

@ -12,6 +12,7 @@ declare(strict_types = 1);
namespace AtolOnline\Exceptions;
use AtolOnline\Constants\Constraints;
use AtolOnline\Constants\Ffd105Tags;
/**
* Исключение, возникающее при попытке указать слишком длинную единицу измерения предмета расчёта
@ -19,6 +20,6 @@ use AtolOnline\Constants\Constraints;
class TooLongUnitException extends TooLongException
{
protected $message = 'Слишком длинная единица измерения предмета расчёта';
protected int $max = Constraints::MAX_LENGTH_MEASUREMENT_UNIT;
protected array $ffd_tags = [1197];
protected float $max = Constraints::MAX_LENGTH_MEASUREMENT_UNIT;
protected array $ffd_tags = [Ffd105Tags::ITEM_MEASURE];
}

View File

@ -12,6 +12,7 @@ declare(strict_types = 1);
namespace AtolOnline\Exceptions;
use AtolOnline\Constants\Constraints;
use AtolOnline\Constants\Ffd105Tags;
/**
* Исключение, возникающее при попытке указать слишком длинный дополнительный реквизит
@ -19,6 +20,6 @@ use AtolOnline\Constants\Constraints;
class TooLongUserdataException extends TooLongException
{
protected $message = 'Слишком длинный дополнительный реквизит предмета расчёта';
protected int $max = Constraints::MAX_LENGTH_USER_DATA;
protected array $ffd_tags = [1191];
protected float $max = Constraints::MAX_LENGTH_USER_DATA;
protected array $ffd_tags = [Ffd105Tags::ITEM_USERDATA];
}

View File

@ -22,9 +22,9 @@ class TooManyException extends AtolException
protected $message = 'Слишком большое количество';
/**
* @var int Максимальное количество
* @var float Максимальное количество
*/
protected int $max = 0;
protected float $max = 0;
/**
* Конструктор

View File

@ -19,5 +19,5 @@ use AtolOnline\Constants\Constraints;
class TooManyItemsException extends TooManyException
{
protected $message = 'Слишком много предметов расчёта в документе';
protected int $max = Constraints::MAX_COUNT_DOC_ITEMS;
protected float $max = Constraints::MAX_COUNT_DOC_ITEMS;
}

View File

@ -19,5 +19,5 @@ use AtolOnline\Constants\Constraints;
class TooManyPaymentsException extends TooManyException
{
protected $message = 'Слишком много платежей в документе';
protected int $max = Constraints::MAX_COUNT_DOC_PAYMENTS;
protected float $max = Constraints::MAX_COUNT_DOC_PAYMENTS;
}

View File

@ -19,5 +19,5 @@ use AtolOnline\Constants\Constraints;
class TooManyVatsException extends TooManyException
{
protected $message = 'Слишком много ставок НДС в документе';
protected int $max = Constraints::MAX_COUNT_DOC_VATS;
protected float $max = Constraints::MAX_COUNT_DOC_VATS;
}

View File

@ -39,7 +39,7 @@ final class Helpers
/**
* Генерирует случайную строку указанной длины
*
* @param int $length Длина, по умолчнанию 8
* @param int $length Длина, по умолчанию 8
* @param bool $with_digits Включать ли цифры
* @return string
*/
@ -115,4 +115,4 @@ final class Helpers
return is_array($actual_classes)
&& !empty(array_intersect($classes, $actual_classes));
}
}
}

View File

@ -7,7 +7,7 @@
* https://github.com/anthonyaxenov/atol-online/blob/master/LICENSE
*/
namespace AtolOnlineTests;
namespace AtolOnline\Tests\Api;
use AtolOnline\Api\AtolClient;
use AtolOnline\Api\KktMonitor;
@ -22,6 +22,7 @@ use AtolOnline\Exceptions\TooLongLoginException;
use AtolOnline\Exceptions\TooLongPasswordException;
use AtolOnline\Helpers;
use AtolOnline\TestEnvParams;
use AtolOnline\Tests\BasicTestCase;
use GuzzleHttp\Exception\GuzzleException;
/**

View File

@ -9,7 +9,7 @@
declare(strict_types = 1);
namespace AtolOnlineTests;
namespace AtolOnline\Tests;
use AtolOnline\Entities\Entity;
use AtolOnline\Helpers;
@ -19,7 +19,7 @@ use Illuminate\Support\Collection;
use PHPUnit\Framework\TestCase;
/**
* Class BasicTestCase
* Базовый класс для тестов
*/
class BasicTestCase extends TestCase
{
@ -73,8 +73,7 @@ class BasicTestCase extends TestCase
*/
public function assertAtolable(Entity $entity, array $json_structure = []): void
{
$this->assertIsObject($entity);
$this->assertIsObject($entity->jsonSerialize());
$this->assertIsArray($entity->jsonSerialize());
$this->assertIsString((string)$entity);
$this->assertJson((string)$entity);
if ($json_structure) {
@ -138,6 +137,23 @@ class BasicTestCase extends TestCase
$this->assertIsSameClass($expected, Collection::class);
}
//------------------------------------------------------------------------------------------------------------------
/**
* Провайдер строк, которые приводятся к null
*
* @return array<array<string|null>>
*/
public function providerNullableStrings(): array
{
return [
[''],
[' '],
[null],
["\n\r\t"],
];
}
/**
* Провайдер валидных телефонов
*
@ -155,6 +171,22 @@ class BasicTestCase extends TestCase
];
}
/**
* Провайдер телефонов, которые приводятся к null
*
* @return array<array<string>>
*/
public function providerNullablePhones(): array
{
return array_merge(
$this->providerNullableStrings(),
[
[Helpers::randomStr(10, false)],
["asdfgvs \n\rtt\t*/(*&%^*$%"],
]
);
}
/**
* Провайдер валидных email-ов
*
@ -170,4 +202,24 @@ class BasicTestCase extends TestCase
['abc.def@mail-archive.com'],
];
}
}
/**
* Провайдер невалидных email-ов
*
* @return array<array<string>>
*/
public function providerInvalidEmails(): array
{
return [
['@example'],
[Helpers::randomStr(15)],
['@example.com'],
['abc.def@mail'],
['.abc@mail.com'],
['example@example'],
['abc..def@mail.com'],
['abc.def@mail..com'],
['abc.def@mail#archive.com'],
];
}
}

View File

@ -7,7 +7,7 @@
* https://github.com/anthonyaxenov/atol-online/blob/master/LICENSE
*/
namespace AtolOnlineTests;
namespace AtolOnline\Tests\Entities;
use AtolOnline\{
Entities\Client,
@ -16,91 +16,28 @@ use AtolOnline\{
Exceptions\TooLongClientContactException,
Exceptions\TooLongClientNameException,
Exceptions\TooLongEmailException,
Exceptions\TooLongItemNameException,
Helpers};
Helpers,
Tests\BasicTestCase
};
/**
* Набор тестов для проверки работы класс покупателя
* Набор тестов для проверки работы класса покупателя
*/
class ClientTest extends BasicTestCase
{
/**
* Провайдер строк, которые приводятся к null
*
* @return array<array<string|null>>
*/
public function providerNullableStrings(): array
{
return [
[''],
[' '],
[null],
["\n\r\t"],
];
}
/**
* Провайдер телефонов, которые приводятся к null
*
* @return array<array<string>>
*/
public function providerNullablePhones(): array
{
return array_merge(
$this->providerNullableStrings(),
[
[Helpers::randomStr(10, false)],
["asdfgvs \n\rtt\t*/(*&%^*$%"],
]
);
}
/**
* Провайдер невалидных email-ов
*
* @return array<array<string>>
*/
public function providerInvalidEmails(): array
{
return [
['@example'],
[Helpers::randomStr(15)],
['@example.com'],
['abc.def@mail'],
['.abc@mail.com'],
['example@example'],
['abc..def@mail.com'],
['abc.def@mail..com'],
['abc.def@mail#archive.com'],
];
}
//------------------------------------------------------------------------------------------------------------------
/**
* Тестирует приведение покупателя к json
*
* @covers \AtolOnline\Entities\Client
* @covers \AtolOnline\Entities\Client::jsonSerialize
*/
public function testAtolable(): void
{
$this->assertAtolable(new Client());
}
/**
* Тестирует конструктор покупателя без передачи значений
* Тестирует конструктор без передачи значений и приведение к json
*
* @covers \AtolOnline\Entities\Client
* @covers \AtolOnline\Entities\Client::jsonSerialize
*/
public function testConstructorWithoutArgs(): void
{
$this->assertEquals('{}', (string)(new Client()));
$this->assertEquals('[]', (string)(new Client()));
}
/**
* Тестирует конструктор с передачей значений (внутри работают сеттеры)
* Тестирует конструктор с передачей значений и приведение к json
*
* @covers \AtolOnline\Entities\Client
* @covers \AtolOnline\Entities\Client::jsonSerialize
@ -108,16 +45,23 @@ class ClientTest extends BasicTestCase
* @covers \AtolOnline\Entities\Client::setPhone
* @covers \AtolOnline\Entities\Client::setEmail
* @covers \AtolOnline\Entities\Client::setInn
* @covers \AtolOnline\Entities\Client::getName
* @covers \AtolOnline\Entities\Client::getPhone
* @covers \AtolOnline\Entities\Client::getEmail
* @covers \AtolOnline\Entities\Client::getInn
*/
public function testConstructorWithArgs(): void
{
$customer = new Client(
$this->assertAtolable(new Client('John Doe'), ['name' => 'John Doe']);
$this->assertAtolable(new Client(email: 'john@example.com'), ['email' => 'john@example.com']);
$this->assertAtolable(new Client(phone: '+1/22/99*73s dsdas654 5s6'), ['phone' => '+122997365456']);
$this->assertAtolable(new Client(inn: '+fasd3\qe3fs_=nac99013928czc'), ['inn' => '3399013928']);
$this->assertAtolable(new Client(
'John Doe',
'john@example.com',
'+1/22/99*73s dsdas654 5s6', // +122997365456
'+fasd3\qe3fs_=nac99013928czc' // 3399013928
);
$this->assertAtolable($customer, [
), [
'name' => 'John Doe',
'email' => 'john@example.com',
'phone' => '+122997365456',
@ -125,10 +69,8 @@ class ClientTest extends BasicTestCase
]);
}
//------------------------------------------------------------------------------------------------------------------
/**
* Тестирует установку имён покупателя, которые приводятся к null
* Тестирует установку имён, которые приводятся к null
*
* @param mixed $name
* @dataProvider providerNullableStrings
@ -139,27 +81,25 @@ class ClientTest extends BasicTestCase
*/
public function testNullableNames(mixed $name): void
{
$customer = (new Client())->setName($name);
$this->assertNull($customer->getName());
$this->assertNull((new Client())->setName($name)->getName());
}
/**
* Тестирует установку валидного имени покупателя
* Тестирует установку валидного имени
*
* @covers \AtolOnline\Entities\Client
* @covers \AtolOnline\Entities\Client::setName
* @covers \AtolOnline\Entities\Client::getName
* @throws TooLongItemNameException
* @throws TooLongClientNameException
*/
public function testValidName(): void
{
$name = Helpers::randomStr();
$customer = (new Client())->setName($name);
$this->assertEquals($name, $customer->getName());
$this->assertEquals($name, (new Client())->setName($name)->getName());
}
/**
* Тестирует установку невалидного имени покупателя
* Тестирует установку невалидного имени
*
* @covers \AtolOnline\Entities\Client
* @covers \AtolOnline\Entities\Client::setName
@ -174,7 +114,7 @@ class ClientTest extends BasicTestCase
//------------------------------------------------------------------------------------------------------------------
/**
* Тестирует установку телефонов покупателя, которые приводятся к null
* Тестирует установку телефонов, которые приводятся к null
*
* @param mixed $phone
* @dataProvider providerNullablePhones
@ -185,13 +125,13 @@ class ClientTest extends BasicTestCase
*/
public function testNullablePhones(mixed $phone): void
{
$customer = (new Client())->setPhone($phone);
$this->assertNull($customer->getPhone());
$this->assertNull((new Client())->setPhone($phone)->getPhone());
}
/**
* Тестирует установку валидного телефона покупателя
* Тестирует установку валидного телефона
*
* @todo актуализировать при доработатанной валидации
* @dataProvider providerValidPhones
* @covers \AtolOnline\Entities\Client
* @covers \AtolOnline\Entities\Client::setPhone
@ -200,13 +140,13 @@ class ClientTest extends BasicTestCase
*/
public function testValidPhone(string $input, string $output): void
{
$customer = (new Client())->setPhone($input);
$this->assertEquals($output, $customer->getPhone());
$this->assertEquals($output, (new Client())->setPhone($input)->getPhone());
}
/**
* Тестирует установку невалидного телефона покупателя
* Тестирует установку невалидного телефона
*
* @todo актуализировать при доработатанной валидации
* @covers \AtolOnline\Entities\Client
* @covers \AtolOnline\Entities\Client::setPhone
* @covers \AtolOnline\Exceptions\TooLongClientContactException
@ -221,7 +161,7 @@ class ClientTest extends BasicTestCase
//------------------------------------------------------------------------------------------------------------------
/**
* Тестирует установку валидных email-ов покупателя
* Тестирует установку валидных email-ов
*
* @param mixed $email
* @dataProvider providerValidEmails
@ -233,12 +173,11 @@ class ClientTest extends BasicTestCase
*/
public function testValidEmails(mixed $email): void
{
$customer = (new Client())->setEmail($email);
$this->assertEquals($email, $customer->getEmail());
$this->assertEquals($email, (new Client())->setEmail($email)->getEmail());
}
/**
* Тестирует установку слишком длинного email покупателя
* Тестирует установку слишком длинного email
*
* @covers \AtolOnline\Entities\Client
* @covers \AtolOnline\Entities\Client::setEmail
@ -253,7 +192,7 @@ class ClientTest extends BasicTestCase
}
/**
* Тестирует установку невалидного email покупателя
* Тестирует установку невалидного email
*
* @param mixed $email
* @dataProvider providerInvalidEmails
@ -281,10 +220,8 @@ class ClientTest extends BasicTestCase
*/
public function testValidInn(): void
{
$customer = (new Client())->setInn('1234567890');
$this->assertEquals('1234567890', $customer->getInn());
$customer = $customer->setInn('123456789012');
$this->assertEquals('123456789012', $customer->getInn());
$this->assertEquals('1234567890', (new Client())->setInn('1234567890')->getInn());
$this->assertEquals('123456789012', (new Client())->setInn('123456789012')->getInn());
}
/**

View File

@ -7,7 +7,7 @@
* https://github.com/anthonyaxenov/atol-online/blob/master/LICENSE
*/
namespace AtolOnlineTests;
namespace AtolOnline\Tests\Entities;
use AtolOnline\{
Entities\Company,
@ -18,7 +18,9 @@ use AtolOnline\{
Exceptions\InvalidPaymentAddressException,
Exceptions\TooLongEmailException,
Exceptions\TooLongPaymentAddressException,
Helpers};
Helpers,
Tests\BasicTestCase
};
/**
* Набор тестов для проверки работы класс продавца
@ -131,4 +133,4 @@ class CompanyTest extends BasicTestCase
$this->expectException(InvalidPaymentAddressException::class);
new Company('company@example.com', SnoTypes::OSN, '1234567890', '');
}
}
}

View File

@ -9,11 +9,12 @@
declare(strict_types = 1);
namespace AtolOnlineTests;
namespace AtolOnline\Tests\Entities;
use AtolOnline\Entities\Kkt;
use AtolOnline\Exceptions\EmptyMonitorDataException;
use AtolOnline\Exceptions\NotEnoughMonitorDataException;
use AtolOnline\Tests\BasicTestCase;
use DateTime;
use Exception;

View File

@ -0,0 +1,145 @@
<?php
/*
* Copyright (c) 2020-2021 Антон Аксенов (Anthony Axenov)
*
* This code is licensed under MIT.
* Этот код распространяется по лицензии MIT.
* https://github.com/anthonyaxenov/atol-online/blob/master/LICENSE
*/
namespace AtolOnline\Tests\Entities;
use AtolOnline\{
Entities\PayingAgent,
Exceptions\InvalidPhoneException,
Exceptions\TooLongPayingAgentOperationException,
Helpers,
Tests\BasicTestCase
};
/**
* Набор тестов для проверки работы класса платёжного агента
*/
class PayingAgentTest extends BasicTestCase
{
/**
* Тестирует конструктор без передачи значений и корректное приведение к json
*
* @covers \AtolOnline\Entities\PayingAgent
* @covers \AtolOnline\Entities\PayingAgent::jsonSerialize
*/
public function testConstructorWithoutArgs(): void
{
$this->assertEquals('[]', (string)(new PayingAgent()));
}
/**
* Тестирует конструктор с передачей значений и корректное приведение к json
*
* @covers \AtolOnline\Entities\PayingAgent
* @covers \AtolOnline\Entities\PayingAgent::jsonSerialize
* @covers \AtolOnline\Entities\PayingAgent::setOperation
* @covers \AtolOnline\Entities\PayingAgent::setPhones
* @covers \AtolOnline\Entities\PayingAgent::getOperation
* @covers \AtolOnline\Entities\PayingAgent::getPhones
* @throws InvalidPhoneException
* @throws TooLongPayingAgentOperationException
*/
public function testConstructorWithArgs(): void
{
$operation = Helpers::randomStr();
$this->assertAtolable(new PayingAgent(
$operation,
['+122997365456'],
), [
'operation' => $operation,
'phones' => ['+122997365456'],
]);
$this->assertAtolable(
new PayingAgent($operation),
['operation' => $operation]
);
$this->assertAtolable(
new PayingAgent(phones: ['+122997365456']),
['phones' => ['+122997365456']]
);
}
/**
* Тестирует установку операций, которые приводятся к null
*
* @param mixed $name
* @dataProvider providerNullableStrings
* @covers \AtolOnline\Entities\PayingAgent
* @covers \AtolOnline\Entities\PayingAgent::setOperation
* @covers \AtolOnline\Entities\PayingAgent::getOperation
* @throws TooLongPayingAgentOperationException
*/
public function testNullableOperations(mixed $name): void
{
$this->assertNull((new PayingAgent())->setOperation($name)->getOperation());
}
/**
* Тестирует установку невалидного имени покупателя
*
* @covers \AtolOnline\Entities\PayingAgent
* @covers \AtolOnline\Entities\PayingAgent::setOperation
* @covers \AtolOnline\Exceptions\TooLongPayingAgentOperationException
*/
public function testTooLongPayingAgentOperationException(): void
{
$this->expectException(TooLongPayingAgentOperationException::class);
(new PayingAgent())->setOperation(Helpers::randomStr(25));
}
/**
* Провайдер массивов телефонов, которые приводятся к null
*
* @return array<array<mixed>>
*/
public function providerNullablePhonesArrays(): array
{
return [
[[]],
[null],
[collect()],
];
}
/**
* Тестирует установку пустых телефонов
*
* @dataProvider providerNullablePhonesArrays
* @covers \AtolOnline\Entities\PayingAgent
* @covers \AtolOnline\Entities\PayingAgent::setPhones
* @covers \AtolOnline\Entities\PayingAgent::getPhones
* @throws InvalidPhoneException
* @throws TooLongPayingAgentOperationException
*/
public function testNullablePhones(mixed $phones): void
{
$agent = new PayingAgent(phones: $phones);
$this->assertIsCollection($agent->getPhones());
$this->assertTrue($agent->getPhones()->isEmpty());
}
/**
* Тестирует установку невалидных телефонов
*
* @covers \AtolOnline\Entities\PayingAgent
* @covers \AtolOnline\Entities\PayingAgent::setPhones
* @covers \AtolOnline\Exceptions\InvalidPhoneException
* @throws InvalidPhoneException
*/
public function testInvalidPhoneException(): void
{
$this->expectException(InvalidPhoneException::class);
(new PayingAgent())->setPhones([
'12345678901234567', // good
'+123456789012345678', // good
'12345678901234567890', // bad
'+12345678901234567890', // bad
]);
}
}

View File

@ -7,7 +7,7 @@
* https://github.com/anthonyaxenov/atol-online/blob/master/LICENSE
*/
namespace AtolOnlineTests;
namespace AtolOnline\Tests;
use AtolOnline\Helpers;
@ -120,4 +120,4 @@ class HelpersTest extends BasicTestCase
$this->assertEquals($output, strlen($result));
// тестировать на наличие цифр быссмысленно
}
}
}