Улучшен метод Kkt::registerDocument

+ теперь принимает любой собственного external_id, если пусто - сгенерирует uuid * исправлен недостаток полей компании в тестовом режиме * уточнения phpdoc
Метод Kkt::getAuthToken() теперь открыт
2020-05-30 04:29:44 +08:00 · 2020-05-30 03:45:06 +08:00 · 2020-05-30 01:59:24 +08:00 · 2020-05-30 01:59:24 +08:00 · 2020-05-30 01:59:23 +08:00 · 2020-05-29 22:24:15 +08:00
7 changed files with 89 additions and 114 deletions
--- a/src/AtolOnline/Api/Kkt.php
+++ b/src/AtolOnline/Api/Kkt.php
@@ -9,7 +9,8 @@

 namespace AtolOnline\Api;

-use AtolOnline\{Entities\Document,
+use AtolOnline\{Entities\Company,
+    Entities\Document,
    Exceptions\AtolCorrectionInfoException,
    Exceptions\AtolInvalidUuidException,
    Exceptions\AtolKktLoginEmptyException,
@@ -172,7 +173,7 @@ class Kkt extends Client
     */
    public function setCallbackUrl(string $url)
    {
-        $this->kkt_config['prod']['callback_url'] = $url;
+        $this->kkt_config[$this->isTestMode() ? 'test' : 'prod']['callback_url'] = $url;
        return $this;
    }
    
@@ -390,7 +391,7 @@ class Kkt extends Client
    {
        $headers['Content-type'] = 'application/json; charset=utf-8';
        if ($this->getAuthToken()) {
-            $headers['Token'] = $this->auth_token;
+            $headers['Token'] = $this->getAuthToken();
        }
        return $headers;
    }
@@ -429,6 +430,7 @@ class Kkt extends Client
     * @param mixed      $data        Данные для передачи
     * @param array|null $options     Параметры Guzzle
     * @return \AtolOnline\Api\KktResponse
+     * @throws \GuzzleHttp\Exception\GuzzleException
     * @see https://guzzle.readthedocs.io/en/latest/request-options.html
     */
    protected function sendAtolRequest(string $http_method, string $api_method, $data = null, array $options = null)
@@ -449,6 +451,7 @@ class Kkt extends Client
     * Производит авторизацию на ККТ и получает токен доступа для дальнейших HTTP-запросов
     *
     * @return bool
+     * @throws \GuzzleHttp\Exception\GuzzleException
     */
    protected function auth()
    {
@@ -468,26 +471,39 @@ class Kkt extends Client
    /**
     * Отправляет документ на регистрацию
     *
-     * @param string                        $api_method Метод API
-     * @param string                        $type       Тип документа: receipt, correction
-     * @param \AtolOnline\Entities\Document $document   Объект документа
+     * @param string                        $api_method  Метод API
+     * @param string                        $type        Тип документа: receipt, correction
+     * @param \AtolOnline\Entities\Document $document    Объект документа
+     * @param string|null                   $external_id Уникальный код документа (если не указан, то будет создан UUID)
     * @return \AtolOnline\Api\KktResponse
+     * @throws \AtolOnline\Exceptions\AtolEmailTooLongException
+     * @throws \AtolOnline\Exceptions\AtolEmailValidateException
+     * @throws \AtolOnline\Exceptions\AtolInnWrongLengthException
+     * @throws \AtolOnline\Exceptions\AtolPaymentAddressTooLongException
     * @throws \AtolOnline\Exceptions\AtolWrongDocumentTypeException Некорректный тип документа
-     * @throws \Exception
+     * @throws \GuzzleHttp\Exception\GuzzleException
     */
-    protected function registerDocument(string $api_method, string $type, Document $document)
+    protected function registerDocument(string $api_method, string $type, Document $document, ?string $external_id = null)
    {
        $type = trim($type);
        if (!in_array($type, ['receipt', 'correction'])) {
            throw new AtolWrongDocumentTypeException($type);
        }
        $this->auth();
-        $data = [
-            'timestamp' => date('d.m.y H:i:s'),
-            'external_id' => Uuid::uuid4()->toString(),
-            'service' => ['callback_url' => $this->getCallbackUrl()],
-            $type => $document,
-        ];
+        if ($this->isTestMode()) {
+            $document->setCompany((new Company())
+                ->setInn('5544332219')
+                ->setPaymentAddress('https://v4.online.atol.ru')
+                ->setEmail('test@example.com')
+                ->setSno('osn')
+            );
+        }
+        $data['timestamp'] = date('d.m.y H:i:s');
+        $data['external_id'] = $external_id ?: Uuid::uuid4()->toString();
+        $data[$type] = $document;
+        if ($this->getCallbackUrl()) {
+            $data['service'] = ['callback_url' => $this->getCallbackUrl()];
+        }
        return $this->sendAtolRequest('POST', trim($api_method), $data);
    }
    
@@ -496,7 +512,7 @@ class Kkt extends Client
     *
     * @return string
     */
-    protected function getAuthToken()
+    public function getAuthToken(): ?string
    {
        return $this->auth_token;
    }
--- a/src/AtolOnline/Api/KktResponse.php
+++ b/src/AtolOnline/Api/KktResponse.php
@@ -81,9 +81,9 @@ class KktResponse implements JsonSerializable
    /**
     * Возвращает объект результата запроса
     *
-     * @return \stdClass
+     * @return stdClass|null
     */
-    public function getContent(): stdClass
+    public function getContent(): ?stdClass
    {
        return $this->content;
    }
--- a/src/AtolOnline/Entities/Document.php
+++ b/src/AtolOnline/Entities/Document.php
@@ -199,9 +199,9 @@ class Document extends Entity
    /**
     * Возвращает заданного клиента (покупателя)
     *
-     * @return Client
+     * @return Client|null
     */
-    public function getClient(): Client
+    public function getClient(): ?Client
    {
        return $this->client;
    }
@@ -221,9 +221,9 @@ class Document extends Entity
    /**
     * Возвращает заданную компанию (продавца)
     *
-     * @return Company
+     * @return Company|null
     */
-    public function getCompany(): Company
+    public function getCompany(): ?Company
    {
        return $this->company;
    }
@@ -388,7 +388,7 @@ class Document extends Entity
                $doc->payments->add($payment);
            }
        }
-        if ($array['total'] != $doc->calcTotal()) {
+        if (isset($array['total']) && $array['total'] != $doc->calcTotal()) {
            throw new AtolException('Real total sum not equals to provided in JSON one');
        }
        return $doc;
@@ -401,16 +401,24 @@ class Document extends Entity
     */
    public function jsonSerialize()
    {
-        $json['company'] = $this->getCompany()->jsonSerialize();// обязательно
-        $json['payments'] = $this->payments->jsonSerialize(); // обязательно
+        if ($this->getCompany()) {
+            $json['company'] = $this->getCompany()->jsonSerialize(); // обязательно
+        }
+        if ($this->getPayments()) {
+            $json['payments'] = $this->payments->jsonSerialize(); // обязательно
+        }
        if ($this->getCashier()) {
            $json['cashier'] = $this->getCashier();
        }
        if ($this->getCorrectionInfo()) {
            $json['correction_info'] = $this->getCorrectionInfo()->jsonSerialize(); // обязательно для коррекционных
        } else {
-            $json['client'] = $this->getClient()->jsonSerialize(); // обязательно для некоррекционных
-            $json['items'] = $this->items->jsonSerialize(); // обязательно для некоррекционных
+            if ($this->getClient()) {
+                $json['client'] = $this->getClient()->jsonSerialize(); // обязательно для некоррекционных
+            }
+            if ($this->getItems()) {
+                $json['items'] = $this->items->jsonSerialize(); // обязательно для некоррекционных
+            }
            $json['total'] = $this->calcTotal(); // обязательно для некоррекционных
        }
        if ($this->getVats()) {
@@ -418,4 +426,4 @@ class Document extends Entity
        }
        return $json;
    }
-}
+}
--- a/tests/BasicTestCase.php
+++ b/tests/BasicTestCase.php
@@ -42,7 +42,22 @@ class BasicTestCase extends TestCase
     */
    public function tearDown(): void
    {
-        
        //parent::tearDown();
    }
+    
+    /**
+     * Возвращает случайную строку указанной длины
+     *
+     * @param int $length
+     * @return string
+     */
+    protected static function randomString($length = 8)
+    {
+        $characters = '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ';
+        $string = '';
+        for ($i = 0; $i < $length; $i++) {
+            $string .= $characters[mt_rand(0, strlen($characters) - 1)];
+        }
+        return $string;
+    }
 }
--- a/tests/Feature/ItemTest.php
+++ b/tests/Feature/ItemTest.php
@@ -85,10 +85,7 @@ class ItemTest extends BasicTestCase
    /**
     * Тестирует установку ставки НДС разными путями
     *
-     * @throws AtolOnline\Exceptions\AtolNameTooLongException
-     * @throws AtolOnline\Exceptions\AtolPriceTooHighException
-     * @throws AtolOnline\Exceptions\AtolTooManyException
-     * @throws AtolOnline\Exceptions\AtolUnitTooLongException
+     * @throws \AtolOnline\Exceptions\AtolPriceTooHighException
     */
    public function testSetVat()
    {
@@ -102,25 +99,21 @@ class ItemTest extends BasicTestCase
    /**
     * Тестирует исключение о слишком длинном наименовании
     *
-     * @throws AtolOnline\Exceptions\AtolNameTooLongException
-     * @throws AtolOnline\Exceptions\AtolPriceTooHighException
-     * @throws AtolOnline\Exceptions\AtolTooManyException
-     * @throws AtolOnline\Exceptions\AtolUnitTooLongException
+     * @throws \AtolOnline\Exceptions\AtolNameTooLongException
     */
    public function testAtolNameTooLongException()
    {
        $item = new Item();
        $this->expectException(AtolNameTooLongException::class);
-        $item->setName('Банан Банан Банан Банан Банан Банан Банан Банан Банан Банан Банан Банан');
+        $item->setName(self::randomString(130));
    }
    
    /**
     * Тестирует исключение о слишком высоком количестве
     *
-     * @throws AtolOnline\Exceptions\AtolNameTooLongException
-     * @throws AtolOnline\Exceptions\AtolTooManyException
-     * @throws AtolOnline\Exceptions\AtolPriceTooHighException
-     * @throws AtolOnline\Exceptions\AtolUnitTooLongException
+     * @throws \AtolOnline\Exceptions\AtolPriceTooHighException
+     * @throws \AtolOnline\Exceptions\AtolTooManyException
+     * @throws \AtolOnline\Exceptions\AtolUnitTooLongException
     */
    public function testAtolQuantityTooHighException()
    {
@@ -132,10 +125,7 @@ class ItemTest extends BasicTestCase
    /**
     * Тестирует исключение о слишком высокой цене
     *
-     * @throws AtolOnline\Exceptions\AtolPriceTooHighException
-     * @throws AtolOnline\Exceptions\AtolNameTooLongException
-     * @throws AtolOnline\Exceptions\AtolTooManyException
-     * @throws AtolOnline\Exceptions\AtolUnitTooLongException
+     * @throws \AtolOnline\Exceptions\AtolPriceTooHighException
     */
    public function testAtolPriceTooHighException()
    {
@@ -147,11 +137,7 @@ class ItemTest extends BasicTestCase
    /**
     * Тестирует исключение о слишком длинных польз. данных
     *
-     * @throws AtolOnline\Exceptions\AtolUserdataTooLongException
-     * @throws AtolOnline\Exceptions\AtolPriceTooHighException
-     * @throws AtolOnline\Exceptions\AtolNameTooLongException
-     * @throws AtolOnline\Exceptions\AtolTooManyException
-     * @throws AtolOnline\Exceptions\AtolUnitTooLongException
+     * @throws \AtolOnline\Exceptions\AtolUserdataTooLongException
     */
    public function testAtolUserdataTooLongException()
    {
@@ -163,10 +149,7 @@ class ItemTest extends BasicTestCase
    /**
     * Тестирует исключение о слишком длинной единице измерения
     *
-     * @throws AtolOnline\Exceptions\AtolNameTooLongException
-     * @throws AtolOnline\Exceptions\AtolPriceTooHighException
-     * @throws AtolOnline\Exceptions\AtolTooManyException
-     * @throws AtolOnline\Exceptions\AtolUnitTooLongException
+     * @throws \AtolOnline\Exceptions\AtolUnitTooLongException
     */
    public function testAtolUnitTooLongException()
    {
--- a/tests/Unit/ClientTest.php
+++ b/tests/Unit/ClientTest.php
@@ -22,12 +22,6 @@ class ClientTest extends BasicTestCase
 {
    /**
     * Тестирует установку параметров
-     *
-     * @throws \AtolOnline\Exceptions\AtolEmailTooLongException
-     * @throws \AtolOnline\Exceptions\AtolEmailValidateException
-     * @throws \AtolOnline\Exceptions\AtolNameTooLongException
-     * @throws \AtolOnline\Exceptions\AtolPhoneTooLongException
-     * @throws \AtolOnline\Exceptions\AtolInnWrongLengthException
     */
    public function testConstructor()
    {
@@ -48,30 +42,18 @@ class ClientTest extends BasicTestCase
     * Тестирует исключение о слишком длинном имени
     *
     * @throws \AtolOnline\Exceptions\AtolNameTooLongException
-     * @throws \AtolOnline\Exceptions\AtolEmailTooLongException
-     * @throws \AtolOnline\Exceptions\AtolEmailValidateException
-     * @throws \AtolOnline\Exceptions\AtolPhoneTooLongException
-     * @throws \AtolOnline\Exceptions\AtolInnWrongLengthException
     */
    public function testAtolNameTooLongException()
    {
        $customer = new Client();
        $this->expectException(AtolNameTooLongException::class);
-        $customer->setName('John Doe John Doe John Doe John Doe John Doe '.
-            'John Doe John Doe John Doe John Doe John Doe John Doe John Doe John '.
-            'Doe John Doe John Doe John Doe John DoeJohn Doe John Doe John Doe '.
-            'John Doe John Doe John Doe John Doe John Doe John Doe John Doe John '.
-            'Doe John Doe John Doe John Doe John Doe John Doe John Doe');
+        $customer->setName(self::randomString(257));
    }
    
    /**
     * Тестирует исключение о слишком длинном телефоне
     *
     * @throws \AtolOnline\Exceptions\AtolPhoneTooLongException
-     * @throws \AtolOnline\Exceptions\AtolNameTooLongException
-     * @throws \AtolOnline\Exceptions\AtolEmailTooLongException
-     * @throws \AtolOnline\Exceptions\AtolEmailValidateException
-     * @throws \AtolOnline\Exceptions\AtolInnWrongLengthException
     */
    public function testAtolPhoneTooLongException()
    {
@@ -84,42 +66,32 @@ class ClientTest extends BasicTestCase
     * Тестирует исключение о слишком длинной почте
     *
     * @throws \AtolOnline\Exceptions\AtolEmailTooLongException
-     * @throws \AtolOnline\Exceptions\AtolPhoneTooLongException
-     * @throws \AtolOnline\Exceptions\AtolNameTooLongException
     * @throws \AtolOnline\Exceptions\AtolEmailValidateException
-     * @throws \AtolOnline\Exceptions\AtolInnWrongLengthException
     */
    public function testAtolEmailTooLongException()
    {
        $customer = new Client();
        $this->expectException(AtolEmailTooLongException::class);
-        $customer->setEmail('johnjohnjohnjohnjohnjohndoedoedoedoe@exampleexampleexampleexample.com');
+        $customer->setEmail(self::randomString(65));
    }
    
    /**
     * Тестирует исключение о некорректной почте
     *
-     * @throws \AtolOnline\Exceptions\AtolEmailValidateException
     * @throws \AtolOnline\Exceptions\AtolEmailTooLongException
-     * @throws \AtolOnline\Exceptions\AtolPhoneTooLongException
-     * @throws \AtolOnline\Exceptions\AtolNameTooLongException
-     * @throws \AtolOnline\Exceptions\AtolInnWrongLengthException
+     * @throws \AtolOnline\Exceptions\AtolEmailValidateException
     */
    public function testAtolEmailValidateException()
    {
        $customer = new Client();
        $this->expectException(AtolEmailValidateException::class);
-        $customer->setEmail('John Doe');
+        $customer->setEmail(self::randomString(15));
    }
    
    /**
     * Тестирует исключение о некорректной длине ИНН
     *
     * @throws \AtolOnline\Exceptions\AtolInnWrongLengthException
-     * @throws \AtolOnline\Exceptions\AtolEmailTooLongException
-     * @throws \AtolOnline\Exceptions\AtolEmailValidateException
-     * @throws \AtolOnline\Exceptions\AtolNameTooLongException
-     * @throws \AtolOnline\Exceptions\AtolPhoneTooLongException
     */
    public function testAtolInnWrongLengthException()
    {
--- a/tests/Unit/CompanyTest.php
+++ b/tests/Unit/CompanyTest.php
@@ -22,11 +22,6 @@ class CompanyTest extends BasicTestCase
 {
    /**
     * Тестирует установку параметров через конструктор
-     *
-     * @throws AtolOnline\Exceptions\AtolEmailTooLongException
-     * @throws AtolOnline\Exceptions\AtolEmailValidateException
-     * @throws AtolOnline\Exceptions\AtolInnWrongLengthException
-     * @throws AtolOnline\Exceptions\AtolPaymentAddressTooLongException
     */
    public function testConstructor()
    {
@@ -46,10 +41,7 @@ class CompanyTest extends BasicTestCase
    /**
     * Тестирует исключение о некорректной длине ИНН
     *
-     * @throws AtolOnline\Exceptions\AtolInnWrongLengthException
-     * @throws AtolOnline\Exceptions\AtolEmailTooLongException
-     * @throws AtolOnline\Exceptions\AtolEmailValidateException
-     * @throws AtolOnline\Exceptions\AtolPaymentAddressTooLongException
+     * @throws \AtolOnline\Exceptions\AtolInnWrongLengthException
     */
    public function testAtolInnWrongLengthException()
    {
@@ -62,49 +54,38 @@ class CompanyTest extends BasicTestCase
    /**
     * Тестирует исключение о слишком длинном платёжном адресе
     *
-     * @throws AtolOnline\Exceptions\AtolPaymentAddressTooLongException
-     * @throws AtolOnline\Exceptions\AtolEmailTooLongException
-     * @throws AtolOnline\Exceptions\AtolEmailValidateException
-     * @throws AtolOnline\Exceptions\AtolInnWrongLengthException
+     * @throws \AtolOnline\Exceptions\AtolPaymentAddressTooLongException
     */
    public function testAtolPaymentAddressTooLongException()
    {
        $company = new Company();
        $this->expectException(AtolPaymentAddressTooLongException::class);
-        $company->setPaymentAddress('John Doe John Doe John Doe John Doe '.
-            'John Doe John Doe John Doe John Doe John Doe John Doe John Doe John Doe John '.
-            'Doe John Doe John Doe John Doe John DoeJohn Doe John Doe John Doe John Doe '.
-            'John Doe John Doe John Doe John Doe John Doe John Doe John Doe John Doe John '.
-            'Doe John Doe John Doe John Doe John Doe');
+        $company->setPaymentAddress(self::randomString(257));
    }
    
    /**
     * Тестирует исключение о слишком длинной почте
     *
-     * @throws AtolOnline\Exceptions\AtolEmailTooLongException
-     * @throws AtolOnline\Exceptions\AtolEmailValidateException
-     * @throws AtolOnline\Exceptions\AtolInnWrongLengthException
-     * @throws AtolOnline\Exceptions\AtolPaymentAddressTooLongException
+     * @throws \AtolOnline\Exceptions\AtolEmailTooLongException
+     * @throws \AtolOnline\Exceptions\AtolEmailValidateException
     */
    public function testAtolEmailTooLongException()
    {
        $company = new Company();
        $this->expectException(AtolEmailTooLongException::class);
-        $company->setEmail('johnjohnjohnjohnjohnjohndoedoedoedoe@exampleexampleexampleexample.com');
+        $company->setEmail(self::randomString(65));
    }
    
    /**
     * Тестирует исключение о некорректной почте
     *
-     * @throws AtolOnline\Exceptions\AtolEmailValidateException
-     * @throws AtolOnline\Exceptions\AtolEmailTooLongException
-     * @throws AtolOnline\Exceptions\AtolInnWrongLengthException
-     * @throws AtolOnline\Exceptions\AtolPaymentAddressTooLongException
+     * @throws \AtolOnline\Exceptions\AtolEmailTooLongException
+     * @throws \AtolOnline\Exceptions\AtolEmailValidateException
     */
    public function testAtolEmailValidateException()
    {
        $company = new Company();
        $this->expectException(AtolEmailValidateException::class);
-        $company->setEmail('John Doe');
+        $company->setEmail(self::randomString(15));
    }
 }
Author	SHA1	Message	Date
AnthonyAxenov	e70a65fa44	Улучшен метод Kkt::registerDocument + теперь принимает любой собственного external_id, если пусто - сгенерирует uuid * исправлен недостаток полей компании в тестовом режиме * уточнения phpdoc	2020-05-30 04:29:44 +08:00
AnthonyAxenov	ba5166f2cf	Метод Kkt::getAuthToken() теперь открыт	2020-05-30 03:45:06 +08:00
AnthonyAxenov	93f5186b15	Перезапись компании в документе при тестовом режиме	2020-05-30 01:59:24 +08:00
AnthonyAxenov	f2b4952aa5	Установка адреса callback для тестового режима	2020-05-30 01:59:24 +08:00
AnthonyAxenov	7899daf421	Снова фикс ошибок при приведении документа к json-строке	2020-05-30 01:59:23 +08:00
AnthonyAxenov	4cf6e81d5f	Исправлены тесты компании и клиента	2020-05-29 22:24:15 +08:00
AnthonyAxenov	9d7dd75cd9	Испарвлен тест на длину имени предмета расчёта	2020-05-29 22:15:47 +08:00
AnthonyAxenov	4d7e5dd76e	Фикс возвращаемого значения KktResponse::getContent()	2020-05-29 22:06:04 +08:00
AnthonyAxenov	0f658d38a9	Фикс ошибок при приведении докумнета к json-строке	2020-05-29 22:05:35 +08:00