yookassa-sdk-php/tests/Request/Receipts/PaymentReceiptResponseTest.php

<?php
/*
 * The MIT License
 *
 * Copyright (c) 2026 "YooMoney", NBСO LLC
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */

namespace Tests\YooKassa\Request\Receipts;

use InvalidArgumentException;
use TypeError;
use YooKassa\Common\Exceptions\InvalidPropertyException;
use YooKassa\Model\Receipt\Settlement;
use YooKassa\Request\Receipts\AbstractReceiptResponse;
use YooKassa\Request\Receipts\ReceiptResponseItem;
use YooKassa\Validator\Exceptions\EmptyPropertyValueException;
use YooKassa\Validator\Exceptions\InvalidPropertyValueException;
use YooKassa\Helpers\Random;
use YooKassa\Model\Receipt\SettlementInterface;
use YooKassa\Request\Receipts\PaymentReceiptResponse;
use YooKassa\Request\Receipts\ReceiptResponseItemInterface;

/**
 * @internal
 */
class PaymentReceiptResponseTest extends AbstractTestReceiptResponse
{
    protected string $type = 'payment';

    /**
     * @dataProvider validDataProvider
     */
    public function testSpecificProperties(array $options): void
    {
        $instance = $this->getTestInstance($options);
        self::assertEquals($options['payment_id'], $instance->getPaymentId());
    }

    /**
     * @dataProvider invalidDataProvider
     */
    public function testInvalidSpecificProperties(array $options): void
    {
        $this->expectException(InvalidPropertyValueException::class);
        $instance = $this->getTestInstance($options);
        $instance->setPaymentId($options['payment_id']);
    }

    /**
     * @dataProvider validDataProvider
     */
    public function testGetsValidData(array $options): void
    {
        $instance = $this->getTestInstance($options);

        if (!is_null($options['fiscal_document_number'])) {
            self::assertNotNull($instance->getFiscalDocumentNumber());
        }
        self::assertEquals($options['fiscal_document_number'], $instance->getFiscalDocumentNumber());

        self::assertNotNull($instance->getFiscalStorageNumber());
        self::assertEquals($options['fiscal_storage_number'], $instance->getFiscalStorageNumber());

        self::assertNotNull($instance->getFiscalAttribute());
        self::assertEquals($options['fiscal_attribute'], $instance->getFiscalAttribute());

        self::assertNotNull($instance->getFiscalProviderId());
        self::assertEquals($options['fiscal_provider_id'], $instance->getFiscalProviderId());

        self::assertNotNull($instance->getRegisteredAt());
        self::assertEquals($options['registered_at'], $instance->getRegisteredAt()->format(YOOKASSA_DATE));

        self::assertNotNull($instance->getItems());
        foreach ($instance->getItems() as $item) {
            self::assertInstanceOf(ReceiptResponseItemInterface::class, $item);
        }
        $instance->getItems()->clear();
        foreach ($options['items'] as $key => $option) {
            $instance->addItem(new ReceiptResponseItem($option));
            self::assertEquals($option, $instance->getItems()->get($key)->toArray());
            self::assertInstanceOf(ReceiptResponseItemInterface::class, $instance->getItems()->get($key));
        }

        self::assertNotNull($instance->getSettlements());
        foreach ($instance->getSettlements() as $settlements) {
            self::assertInstanceOf(SettlementInterface::class, $settlements);
        }

        $instance->getSettlements()->clear();
        foreach ($options['settlements'] as $key => $option) {
            $instance->addSettlement(new Settlement($option));
            self::assertEquals($option, $instance->getSettlements()->get($key)->toArray());
            self::assertInstanceOf(SettlementInterface::class, $instance->getSettlements()->get($key));
        }

        self::assertNotNull($instance->getOnBehalfOf());
        self::assertEquals($options['on_behalf_of'], $instance->getOnBehalfOf());

        self::assertTrue($instance->notEmpty());

        $instance = $this->getTestInstance();
        self::assertIsObject($instance->getItems());
        self::assertIsObject($instance->getSettlements());
        self::assertIsObject($instance->getReceiptIndustryDetails());
    }

    public function testSetFiscalDocumentNumber(): void
    {
        $instance = $this->getTestInstance([]);
        $instance->setFiscalDocumentNumber(null);

        self::assertNull($instance->getFiscalStorageNumber());
    }

    public function testSetTaxSystemCode(): void
    {
        $instance = $this->getTestInstance([]);
        $instance->setTaxSystemCode(null);

        self::assertNull($instance->getTaxSystemCode());
    }

    public function testInvalidIdData(): void
    {
        $this->expectException(InvalidArgumentException::class);
        $instance = $this->getTestInstance([]);
        $instance->setId(Random::str(AbstractReceiptResponse::LENGTH_RECEIPT_ID + 1));
    }

    public function testInvalidTypeData(): void
    {
        $this->expectException(InvalidArgumentException::class);
        $instance = $this->getTestInstance([]);
        $instance->setType(Random::str(10));
    }

    public function testInvalidStatusIdData(): void
    {
        $this->expectException(InvalidArgumentException::class);
        $instance = $this->getTestInstance([]);
        $instance->setStatus(Random::str(10));
    }

    /**
     * @dataProvider invalidItemsDataProvider
     *
     * @param mixed $value
     * @param string $exceptionClassName
     */
    public function testInvalidItemsData(mixed $value, string $exceptionClassName): void
    {
        $instance = $this->getTestInstance([]);

        $this->expectException($exceptionClassName);
        $instance->setItems($value);
    }

    /**
     * @dataProvider invalidSettlementsDataProvider
     *
     * @param mixed $value
     * @param string $exceptionClassName
     */
    public function testInvalidSettlementsData(mixed $value, string $exceptionClassName): void
    {
        $instance = $this->getTestInstance([]);

        $this->expectException($exceptionClassName);
        $instance->setSettlements($value);
    }

    /**
     * @dataProvider invalidBoolNullDataProvider
     */
    public function testInvalidOnBehalfOfData(mixed $options): void
    {
        $this->expectException(TypeError::class);
        $instance = $this->getTestInstance([]);
        $instance->setOnBehalfOf($options);
    }

    protected function getTestInstance(mixed $options = null): PaymentReceiptResponse
    {
        return new PaymentReceiptResponse($options);
    }

    protected function addSpecificProperties(mixed $options, mixed $i): array
    {
        $array = [
            Random::str(30),
            Random::str(40),
        ];
        $options['payment_id'] = !$this->valid
            ? (Random::value($array))
            : Random::value([null, '', Random::str(PaymentReceiptResponse::LENGTH_PAYMENT_ID)]);

        return $options;
    }
}