Мелкофиксы

- `Ffd105Tags::CLIENT_CONTACTS` => `CLIENT_PHONE_EMAIL`
+ мелочи по `Client`, `ClientTest` и `PayingAgentTest`

src/Constants/Ffd105Tags.php

@@ -17,7 +17,7 @@ final class Ffd105Tags
     /**
      * Телефон или электронный адрес покупателя
      */
-    const CLIENT_CONTACT = 1008;
+    const CLIENT_PHONE_EMAIL = 1008;
 
     /**
      * Наименование организации или фамилия, имя, отчество (при наличии), серия и номер паспорта покупателя (клиента)
@@ -49,6 +49,11 @@ final class Ffd105Tags
      */
     const RPO_PHONES = 1074;
 
+    /**
+     * Телефон оператора перевода
+     */
+    const MTO_PHONES = 1075;
+
     /**
      * ИНН оператора перевода
      */
@@ -59,6 +64,16 @@ final class Ffd105Tags
      */
     const PAGENT_PHONE = 1073;
 
+    /**
+     * Телефон поставщика
+     */
+    const SUPPLIER_PHONES = 1171;
+
+    /**
+     * Наименование поставщика
+     */
+    const SUPPLIER_NAME = 1225;
+
     /**
      * ИНН поставщика
      */

src/Entities/Client.php

@@ -17,8 +17,7 @@ use AtolOnline\{
     Exceptions\InvalidInnLengthException,
     Exceptions\TooLongClientContactException,
     Exceptions\TooLongClientNameException,
-    Exceptions\TooLongEmailException
-};
+    Exceptions\TooLongEmailException};
 
 /**
  * Класс Client, описывающий сущность покупателя
@@ -28,22 +27,22 @@ use AtolOnline\{
 class Client extends Entity
 {
     /**
-     * @var string|null Наименование. Тег ФФД - 1227.
+     * @var string|null Наименование (1227)
      */
     protected ?string $name = null;
 
     /**
-     * @var string|null Email. Тег ФФД -  1008.
+     * @var string|null Email (1008)
      */
     protected ?string $email = null;
 
     /**
-     * @var string|null Телефон покупателя. Тег ФФД - 1008.
+     * @var string|null Телефон (1008)
      */
     protected ?string $phone = null;
 
     /**
-     * @var string|null ИНН. Тег ФФД -  1228.
+     * @var string|null ИНН (1228)
      */
     protected ?string $inn = null;
 
@@ -52,7 +51,7 @@ class Client extends Entity
      *
      * @param string|null $name Наименование (1227)
      * @param string|null $phone Email (1008)
-     * @param string|null $email Телефон покупателя (1008)
+     * @param string|null $email Телефон (1008)
      * @param string|null $inn ИНН (1228)
      * @throws TooLongClientNameException
      * @throws TooLongClientContactException
@@ -65,8 +64,7 @@ class Client extends Entity
         ?string $email = null,
         ?string $phone = null,
         ?string $inn = null
-    )
-    {
+    ) {
         !is_null($name) && $this->setName($name);
         !is_null($email) && $this->setEmail($email);
         !is_null($phone) && $this->setPhone($phone);
@@ -76,8 +74,6 @@ class Client extends Entity
     /**
      * Возвращает наименование покупателя
      *
-     * Тег ФФД - 1227
-     *
      * @return string|null
      */
     public function getName(): ?string
@@ -88,8 +84,6 @@ class Client extends Entity
     /**
      * Устанавливает наименование покупателя
      *
-     * Тег ФФД - 1227
-     *
      * @todo улучшить валидацию по Constraints::PATTERN_PHONE
      * @param string|null $name
      * @return $this
@@ -142,8 +136,6 @@ class Client extends Entity
     /**
      * Возвращает установленный телефон
      *
-     * Тег ФФД - 1008
-     *
      * @return string|null
      */
     public function getPhone(): ?string
@@ -154,8 +146,6 @@ class Client extends Entity
     /**
      * Устанавливает телефон
      *
-     * Тег ФФД - 1008
-     *
      * @param string|null $phone Номер телефона
      * @return $this
      * @throws TooLongClientContactException

src/Entities/ReceivePaymentsOperator.php

@@ -20,17 +20,17 @@ use Illuminate\Support\Collection;
  *
  * @see https://online.atol.ru/files/API_atol_online_v4.pdf Документация, стр 19-20
  */
-class MoneyTransferOperator extends Entity
+class ReceivePaymentsOperator extends Entity
 {
     /**
-     * @var Collection Телефоны платёжного агента (1073)
+     * @var Collection Телефоны оператора по приёму платежей (1074)
      */
     protected Collection $phones;
 
     /**
      * Конструктор
      *
-     * @param array|Collection|null $phones Телефон оператора по приёму платежей (1074)
+     * @param array|Collection|null $phones Телефоны оператора по приёму платежей (1074)
      * @throws InvalidPhoneException
      */
     public function __construct(

src/Entities/Supplier.php

@@ -0,0 +1,157 @@
+<?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\InvalidInnLengthException;
+use AtolOnline\Exceptions\InvalidPhoneException;
+use Illuminate\Support\Collection;
+
+/**
+ * Класс, описывающий поставшика
+ *
+ * @see https://online.atol.ru/files/API_atol_online_v4.pdf Документация, стр 20-21
+ */
+class Supplier extends Entity
+{
+    /**
+     * @var string|null Наименование (1225)
+     */
+    protected ?string $name = null;
+
+    /**
+     * @var string|null ИНН (1226)
+     */
+    protected ?string $inn = null;
+
+    /**
+     * @var Collection Телефоны (1171)
+     */
+    protected Collection $phones;
+
+    /**
+     * Конструктор
+     *
+     * @param string|null $name Наименование поставщика (1225)
+     * @param string|null $inn ИНН (1226)
+     * @param array|Collection|null $phones Телефоны поставщика (1171)
+     * @throws InvalidInnLengthException
+     * @throws InvalidPhoneException
+     */
+    public function __construct(
+        ?string $name = null,
+        ?string $inn = null,
+        array|Collection|null $phones = null,
+    ) {
+        !is_null($name) && $this->setName($name);
+        !is_null($inn) && $this->setInn($inn);
+        $this->setPhones($phones);
+    }
+
+    /**
+     * Возвращает установленное наименование поставщика
+     *
+     * @return string|null
+     */
+    public function getName(): ?string
+    {
+        return $this->name;
+    }
+
+    /**
+     * Устанавливает наименование поставщика
+     *
+     * @param string|null $name
+     * @return Supplier
+     */
+    public function setName(?string $name): self
+    {
+        // критерии к длине строки не описаны ни в схеме, ни в документации
+        $this->name = trim($name) ?: null;
+        return $this;
+    }
+
+    /**
+     * Возвращает установленные номера телефонов
+     *
+     * @todo вытащить в трейт
+     * @return Collection
+     */
+    public function getPhones(): Collection
+    {
+        return $this->phones;
+    }
+
+    /**
+     * Устанавливает массив номеров телефонов
+     *
+     * @todo вытащить в трейт
+     * @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 string|null
+     */
+    public function getInn(): ?string
+    {
+        return $this->inn;
+    }
+
+    /**
+     * Устанавливает ИНН
+     *
+     * @param string|null $inn
+     * @return $this
+     * @throws InvalidInnLengthException Некорректная длина ИНН
+     */
+    public function setInn(?string $inn): self
+    {
+        if (is_string($inn)) {
+            $inn = preg_replace('/[^\d]/', '', trim($inn));
+            if (preg_match_all(Constraints::PATTERN_INN, $inn) === 0) {
+                throw new InvalidInnLengthException($inn);
+            }
+        }
+        $this->inn = empty($inn) ? null : $inn;
+        return $this;
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function jsonSerialize(): array
+    {
+        $json = [];
+        $this->getName() && $json['name'] = $this->getName();
+        $this->getInn() && $json['inn'] = $this->getInn();
+        !$this->getPhones()->isEmpty() && $json['phones'] = $this->getPhones()->toArray();
+        return $json;
+    }
+}

src/Exceptions/EmptyEmailException.php

@@ -22,7 +22,7 @@ class EmptyEmailException extends AtolException
 {
     protected $message = 'Email не может быть пустым';
     protected array $ffd_tags = [
-        Ffd105Tags::CLIENT_CONTACT,
+        Ffd105Tags::CLIENT_PHONE_EMAIL,
         Ffd105Tags::COMPANY_EMAIL,
     ];
 }

src/Exceptions/InvalidEmailException.php

@@ -21,7 +21,7 @@ use AtolOnline\Constants\Ffd105Tags;
 class InvalidEmailException extends AtolException
 {
     protected array $ffd_tags = [
-        Ffd105Tags::CLIENT_CONTACT,
+        Ffd105Tags::CLIENT_PHONE_EMAIL,
         Ffd105Tags::COMPANY_EMAIL,
     ];
 

src/Exceptions/InvalidPhoneException.php

@@ -19,9 +19,11 @@ use AtolOnline\Constants\Ffd105Tags;
 class InvalidPhoneException extends AtolException
 {
     protected array $ffd_tags = [
-        Ffd105Tags::CLIENT_CONTACT,
+        Ffd105Tags::CLIENT_PHONE_EMAIL,
         Ffd105Tags::PAGENT_PHONE,
         Ffd105Tags::RPO_PHONES,
+        Ffd105Tags::MTO_PHONES,
+        Ffd105Tags::SUPPLIER_PHONES,
     ];
 
     /**

src/Exceptions/TooLongClientContactException.php

@@ -21,5 +21,5 @@ class TooLongClientContactException extends TooLongException
 {
     protected $message = 'Cлишком длинный телефон или email покупателя';
     protected float $max = Constraints::MAX_LENGTH_CLIENT_CONTACT;
-    protected array $ffd_tags = [Ffd105Tags::CLIENT_CONTACT];
+    protected array $ffd_tags = [Ffd105Tags::CLIENT_PHONE_EMAIL];
 }

src/Exceptions/TooLongEmailException.php

@@ -22,7 +22,7 @@ class TooLongEmailException extends TooLongException
     protected $message = 'Слишком длинный email';
     protected float $max = Constraints::MAX_LENGTH_EMAIL;
     protected array $ffd_tags = [
-        Ffd105Tags::CLIENT_CONTACT,
+        Ffd105Tags::CLIENT_PHONE_EMAIL,
         Ffd105Tags::COMPANY_EMAIL,
     ];
 }

tests/AtolOnline/Tests/Entities/ClientTest.php

@@ -17,8 +17,7 @@ use AtolOnline\{
     Exceptions\TooLongClientNameException,
     Exceptions\TooLongEmailException,
     Helpers,
-    Tests\BasicTestCase
-};
+    Tests\BasicTestCase};
 
 /**
  * Набор тестов для проверки работы класса покупателя
@@ -111,8 +110,6 @@ class ClientTest extends BasicTestCase
         (new Client())->setName(Helpers::randomStr(400));
     }
 
-    //------------------------------------------------------------------------------------------------------------------
-
     /**
      * Тестирует установку телефонов, которые приводятся к null
      *
@@ -158,8 +155,6 @@ class ClientTest extends BasicTestCase
         (new Client())->setPhone('99999999999999999999999999999999999999999999999999999999999999999999999999');
     }
 
-    //------------------------------------------------------------------------------------------------------------------
-
     /**
      * Тестирует установку валидных email-ов
      *
@@ -208,8 +203,6 @@ class ClientTest extends BasicTestCase
         (new Client())->setEmail($email);
     }
 
-    //------------------------------------------------------------------------------------------------------------------
-
     /**
      * Тестирует исключение о корректной длине ИНН
      *

tests/AtolOnline/Tests/Entities/PayingAgentTest.php

@@ -67,16 +67,17 @@ class PayingAgentTest extends BasicTestCase
     /**
      * Тестирует установку операций, которые приводятся к null
      *
-     * @param mixed $name
+     * @param mixed $operation
      * @dataProvider providerNullableStrings
      * @covers       \AtolOnline\Entities\PayingAgent
      * @covers       \AtolOnline\Entities\PayingAgent::setOperation
      * @covers       \AtolOnline\Entities\PayingAgent::getOperation
      * @throws TooLongPayingAgentOperationException
+     * @throws InvalidPhoneException
      */
-    public function testNullableOperations(mixed $name): void
+    public function testNullableOperations(mixed $operation): void
     {
-        $this->assertNull((new PayingAgent())->setOperation($name)->getOperation());
+        $this->assertNull((new PayingAgent($operation))->getOperation());
     }
 
     /**

tests/AtolOnline/Tests/Entities/ReceivePaymentsOperatorTest.php

@@ -10,38 +10,38 @@
 namespace AtolOnline\Tests\Entities;
 
 use AtolOnline\{
-    Entities\MoneyTransferOperator,
+    Entities\ReceivePaymentsOperator,
     Exceptions\InvalidPhoneException,
     Tests\BasicTestCase};
 
 /**
  * Набор тестов для проверки работы класса оператора по приёму платежей
  */
-class MoneyTransferOperatorTest extends BasicTestCase
+class ReceivePaymentsOperatorTest extends BasicTestCase
 {
     /**
      * Тестирует конструктор без передачи значений и корректное приведение к json
      *
-     * @covers \AtolOnline\Entities\MoneyTransferOperator
-     * @covers \AtolOnline\Entities\MoneyTransferOperator::jsonSerialize
+     * @covers \AtolOnline\Entities\ReceivePaymentsOperator
+     * @covers \AtolOnline\Entities\ReceivePaymentsOperator::jsonSerialize
      */
     public function testConstructorWithoutArgs(): void
     {
-        $this->assertEquals('[]', (string)(new MoneyTransferOperator()));
+        $this->assertEquals('[]', (string)(new ReceivePaymentsOperator()));
     }
 
     /**
      * Тестирует конструктор с передачей значений и корректное приведение к json
      *
-     * @covers \AtolOnline\Entities\MoneyTransferOperator
-     * @covers \AtolOnline\Entities\MoneyTransferOperator::jsonSerialize
-     * @covers \AtolOnline\Entities\MoneyTransferOperator::setPhones
-     * @covers \AtolOnline\Entities\MoneyTransferOperator::getPhones
+     * @covers \AtolOnline\Entities\ReceivePaymentsOperator
+     * @covers \AtolOnline\Entities\ReceivePaymentsOperator::jsonSerialize
+     * @covers \AtolOnline\Entities\ReceivePaymentsOperator::setPhones
+     * @covers \AtolOnline\Entities\ReceivePaymentsOperator::getPhones
      * @throws InvalidPhoneException
      */
     public function testConstructorWithArgs(): void
     {
-        $this->assertAtolable(new MoneyTransferOperator(['+122997365456']), ['phones' => ['+122997365456']]);
+        $this->assertAtolable(new ReceivePaymentsOperator(['+122997365456']), ['phones' => ['+122997365456']]);
     }
 
     /**
@@ -62,14 +62,14 @@ class MoneyTransferOperatorTest extends BasicTestCase
      * Тестирует установку пустых телефонов
      *
      * @dataProvider providerNullablePhonesArrays
-     * @covers       \AtolOnline\Entities\MoneyTransferOperator
-     * @covers       \AtolOnline\Entities\MoneyTransferOperator::setPhones
-     * @covers       \AtolOnline\Entities\MoneyTransferOperator::getPhones
+     * @covers       \AtolOnline\Entities\ReceivePaymentsOperator
+     * @covers       \AtolOnline\Entities\ReceivePaymentsOperator::setPhones
+     * @covers       \AtolOnline\Entities\ReceivePaymentsOperator::getPhones
      * @throws InvalidPhoneException
      */
     public function testNullablePhones(mixed $phones): void
     {
-        $agent = new MoneyTransferOperator($phones);
+        $agent = new ReceivePaymentsOperator($phones);
         $this->assertIsCollection($agent->getPhones());
         $this->assertTrue($agent->getPhones()->isEmpty());
     }
@@ -77,19 +77,19 @@ class MoneyTransferOperatorTest extends BasicTestCase
     /**
      * Тестирует установку невалидных телефонов
      *
-     * @covers \AtolOnline\Entities\MoneyTransferOperator
-     * @covers \AtolOnline\Entities\MoneyTransferOperator::setPhones
+     * @covers \AtolOnline\Entities\ReceivePaymentsOperator
+     * @covers \AtolOnline\Entities\ReceivePaymentsOperator::setPhones
      * @covers \AtolOnline\Exceptions\InvalidPhoneException
      * @throws InvalidPhoneException
      */
     public function testInvalidPhoneException(): void
     {
         $this->expectException(InvalidPhoneException::class);
-        (new MoneyTransferOperator())->setPhones([
+        (new ReceivePaymentsOperator([
             '12345678901234567', // good
             '+123456789012345678', // good
             '12345678901234567890', // bad
             '+12345678901234567890', // bad
-        ]);
+        ]));
     }
 }

tests/AtolOnline/Tests/Entities/SupplierTest.php

@@ -0,0 +1,172 @@
+<?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\Supplier,
+    Exceptions\InvalidInnLengthException,
+    Exceptions\InvalidPhoneException,
+    Tests\BasicTestCase};
+
+/**
+ * Набор тестов для проверки работы класса поставщика
+ */
+class SupplierTest extends BasicTestCase
+{
+    /**
+     * Тестирует конструктор без передачи значений и корректное приведение к json
+     *
+     * @covers \AtolOnline\Entities\Supplier
+     * @covers \AtolOnline\Entities\Supplier::jsonSerialize
+     */
+    public function testConstructorWithoutArgs(): void
+    {
+        $this->assertEquals('[]', (string)(new Supplier()));
+    }
+
+    /**
+     * Тестирует конструктор с передачей значений и корректное приведение к json
+     *
+     * @covers \AtolOnline\Entities\Supplier
+     * @covers \AtolOnline\Entities\Supplier::jsonSerialize
+     * @covers \AtolOnline\Entities\Supplier::setName
+     * @covers \AtolOnline\Entities\Supplier::getName
+     * @covers \AtolOnline\Entities\Supplier::setPhones
+     * @covers \AtolOnline\Entities\Supplier::getPhones
+     * @covers \AtolOnline\Entities\Supplier::setInn
+     * @covers \AtolOnline\Entities\Supplier::getInn
+     * @throws InvalidPhoneException
+     * @throws InvalidInnLengthException
+     */
+    public function testConstructorWithArgs(): void
+    {
+        $this->assertAtolable(new Supplier('some name'), ['name' => 'some name']);
+        $this->assertAtolable(new Supplier(inn: '+fasd3\qe3fs_=nac99013928czc'), ['inn' => '3399013928']);
+        $this->assertAtolable(new Supplier(phones: ['+122997365456']), ['phones' => ['+122997365456']]);
+        $this->assertAtolable(new Supplier(
+            'some name',
+            '+fasd3\qe3fs_=nac99013928czc',
+            ['+122997365456'],
+        ), [
+            'name' => 'some name',
+            'inn' => '3399013928',
+            'phones' => ['+122997365456'],
+        ]);
+    }
+
+    /**
+     * Тестирует установку имён, которые приводятся к null
+     *
+     * @param mixed $name
+     * @dataProvider providerNullableStrings
+     * @covers       \AtolOnline\Entities\Supplier
+     * @covers       \AtolOnline\Entities\Supplier::setName
+     * @covers       \AtolOnline\Entities\Supplier::getName
+     * @throws InvalidPhoneException
+     * @throws InvalidInnLengthException
+     */
+    public function testNullableOperations(mixed $name): void
+    {
+        $this->assertNull((new Supplier($name))->getName());
+    }
+
+    /**
+     * Провайдер массивов телефонов, которые приводятся к null
+     *
+     * @return array<array>
+     */
+    public function providerNullablePhonesArrays(): array
+    {
+        return [
+            [[]],
+            [null],
+            [collect()],
+        ];
+    }
+
+    /**
+     * Тестирует установку пустых телефонов
+     *
+     * @dataProvider providerNullablePhonesArrays
+     * @covers       \AtolOnline\Entities\Supplier
+     * @covers       \AtolOnline\Entities\Supplier::setPhones
+     * @covers       \AtolOnline\Entities\Supplier::getPhones
+     * @throws InvalidPhoneException
+     * @throws InvalidInnLengthException
+     */
+    public function testNullablePhones(mixed $phones): void
+    {
+        $agent = new Supplier(phones: $phones);
+        $this->assertIsCollection($agent->getPhones());
+        $this->assertTrue($agent->getPhones()->isEmpty());
+    }
+
+    /**
+     * Тестирует установку невалидных телефонов
+     *
+     * @covers \AtolOnline\Entities\Supplier
+     * @covers \AtolOnline\Entities\Supplier::setPhones
+     * @covers \AtolOnline\Exceptions\InvalidPhoneException
+     * @throws InvalidPhoneException
+     * @throws InvalidInnLengthException
+     */
+    public function testInvalidPhoneException(): void
+    {
+        $this->expectException(InvalidPhoneException::class);
+        (new Supplier(phones: [
+            '12345678901234567', // good
+            '+123456789012345678', // good
+            '12345678901234567890', // bad
+            '+12345678901234567890', // bad
+        ]));
+    }
+
+    /**
+     * Тестирует исключение о корректной длине ИНН
+     *
+     * @covers \AtolOnline\Entities\Supplier
+     * @covers \AtolOnline\Entities\Supplier::setInn
+     * @covers \AtolOnline\Entities\Supplier::getInn
+     * @throws InvalidInnLengthException
+     */
+    public function testValidInn(): void
+    {
+        $this->assertEquals('1234567890', (new Supplier())->setInn('1234567890')->getInn());
+        $this->assertEquals('123456789012', (new Supplier())->setInn('123456789012')->getInn());
+    }
+
+    /**
+     * Тестирует исключение о некорректной длине ИНН (10 цифр)
+     *
+     * @covers \AtolOnline\Entities\Supplier
+     * @covers \AtolOnline\Entities\Supplier::setInn
+     * @covers \AtolOnline\Exceptions\InvalidInnLengthException
+     * @throws InvalidInnLengthException
+     */
+    public function testInvalidInn10(): void
+    {
+        $this->expectException(InvalidInnLengthException::class);
+        (new Supplier())->setInn('12345678901');
+    }
+
+    /**
+     * Тестирует исключение о некорректной длине ИНН (12 цифр)
+     *
+     * @covers \AtolOnline\Entities\Supplier
+     * @covers \AtolOnline\Entities\Supplier::setInn
+     * @covers \AtolOnline\Exceptions\InvalidInnLengthException
+     * @throws InvalidInnLengthException
+     */
+    public function testInvalidInn12(): void
+    {
+        $this->expectException(InvalidInnLengthException::class);
+        (new Supplier())->setInn('1234567890123');
+    }
+}