IsmpApiTest::testLkImportSend() - Code Metrics - Inspection of "Added limit option to doc body request (#15)" - lamoda/crpt-ismp-api-client - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — master ( db0ae1...f66061 )

by Agaletskiy
created 2020-02-20 08:51 UTC
IsmpApiTest::testLkImportSend() A

↳ Parent: IsmpApiTest
Complexity

Conditions	1
Paths	1
Size

Total Lines
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
dl	0
loc	33
c	0
b	0
f	0
rs	9.392
cc	1
nc	1
nop	0
<?php

declare(strict_types=1);

namespace Lamoda\IsmpClient\Tests\V3;

use GuzzleHttp\ClientInterface;
use GuzzleHttp\Exception\BadResponseException;
use GuzzleHttp\Psr7\Response;
use GuzzleHttp\RequestOptions;
use Lamoda\IsmpClient\Exception\IsmpGeneralErrorException;
use Lamoda\IsmpClient\Exception\IsmpRequestErrorException;
use Lamoda\IsmpClient\Serializer\SerializerInterface;
use Lamoda\IsmpClient\V3\Dto\AuthCertKeyResponse;
use Lamoda\IsmpClient\V3\Dto\AuthCertRequest;
use Lamoda\IsmpClient\V3\Dto\AuthCertResponse;
use Lamoda\IsmpClient\V3\Dto\DocumentCreateRequest;
use Lamoda\IsmpClient\V3\Dto\FacadeCisListResponse;
use Lamoda\IsmpClient\V3\Dto\FacadeDocBodyResponse;
use Lamoda\IsmpClient\V3\Dto\FacadeDocListV2Query;
use Lamoda\IsmpClient\V3\Dto\FacadeDocListV2Response;
use Lamoda\IsmpClient\V3\Dto\FacadeOrderDetailsResponse;
use Lamoda\IsmpClient\V3\Dto\FacadeOrderRequest;
use Lamoda\IsmpClient\V3\Dto\FacadeOrderResponse;
use Lamoda\IsmpClient\V3\Dto\ProductInfoResponse;
use Lamoda\IsmpClient\V3\Enum\DocumentLkType;
use Lamoda\IsmpClient\V3\Enum\ProductGroup;
use Lamoda\IsmpClient\V3\IsmpApi;
use PHPUnit\Framework\MockObject\MockObject;
use PHPUnit\Framework\TestCase;
use Psr\Http\Message\RequestInterface;
use function GuzzleHttp\Psr7\stream_for;

final class IsmpApiTest extends TestCase
{
    private const TOKEN = '0a893bdc-3127-4f3f-939e-f423d08d9bd6';
    private const UUID = '81497c0c-17ef-42a1-b1d1-d769dac7441c';
    private const RANDOM_DATA = '2b212c99-9955-45c7-8594-9d3aa59eae04';
    private const SERIALIZED_VALUE = '{"test:"value"}';
    private const API_RESPONSE = 'stub_api_response';
    private const IDENTITY = 'eb852349-647f-468f-bb90-d26a4d975a88';

    /**
     * @var ClientInterface|MockObject
     */
    private $client;
    /**
     * @var SerializerInterface|MockObject
     */
    private $serializer;
    /**
     * @var IsmpApi
     */
    private $api;

    protected function setUp(): void
    {
        $this->client = $this->createMock(ClientInterface::class);
        $this->serializer = $this->createMock(SerializerInterface::class);

        $this->api = new IsmpApi(
            $this->client,
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
            $this->serializer
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        );
    }

    public function testExceptionWithHttpCode(): void
    {
        $this->client
            ->method('request')
            ->willThrowException(new BadResponseException('Bad response', $this->createMock(RequestInterface::class)));
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);

        $this->expectException(IsmpRequestErrorException::class);
        $this->api->authCertKey();
    }

    public function testGeneralException(): void
    {
        $this->client
            ->method('request')
            ->willThrowException(new \RuntimeException());

        $this->expectException(IsmpGeneralErrorException::class);
        $this->api->authCertKey();
    }

    public function testAuthCertKey(): void
    {
        $expectedResult = new AuthCertKeyResponse(self::UUID, self::RANDOM_DATA);

        $this->serializer
            ->method('deserialize')
            ->with(
                get_class($expectedResult),
                self::API_RESPONSE
            )
            ->willReturn($expectedResult);

        $this->client->expects($this->once())
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
            ->method('request')
            ->with(
                'GET',
                'api/v3/auth/cert/key',
                [
                    RequestOptions::BODY => null,
                    RequestOptions::HEADERS => [
                        'Content-Type' => 'application/json',
                    ],
                    RequestOptions::HTTP_ERRORS => true,
                    RequestOptions::QUERY => null,
                ]
            )
            ->willReturn(
                (new Response())
                    ->withBody(stream_for(self::API_RESPONSE))
            );

        $result = $this->api->authCertKey();

        $this->assertEquals($expectedResult, $result);
    }

    public function testAuthCert(): void
    {
        $request = new AuthCertRequest(self::UUID, self::RANDOM_DATA);
        $expectedResult = new AuthCertResponse('token-value');

        $this->serializer
            ->method('serialize')
            ->with($request)
            ->willReturn(self::SERIALIZED_VALUE);

        $this->serializer
            ->method('deserialize')
            ->with(
                get_class($expectedResult),
                self::API_RESPONSE
            )
            ->willReturn($expectedResult);

        $this->client->expects($this->once())
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
            ->method('request')
            ->with(
                'POST',
                'api/v3/auth/cert/',
                [
                    RequestOptions::BODY => self::SERIALIZED_VALUE,
                    RequestOptions::HEADERS => [
                        'Content-Type' => 'application/json',
                    ],
                    RequestOptions::HTTP_ERRORS => true,
                    RequestOptions::QUERY => null,
                ]
            )
            ->willReturn(
                (new Response())
                    ->withBody(stream_for(self::API_RESPONSE))
            );

        $result = $this->api->authCert($request);

        $this->assertEquals($expectedResult, $result);
    }

    public function testFacadeOrder(): void
    {
        $request = new FacadeOrderRequest('document', 'MANUAL', 'signature');
        $expectedResult = new FacadeOrderResponse('orderId', 'status');

        $this->serializer
            ->method('serialize')
            ->with($request)
            ->willReturn(self::SERIALIZED_VALUE);

        $this->serializer
            ->method('deserialize')
            ->with(
                get_class($expectedResult),
                self::API_RESPONSE
            )
            ->willReturn($expectedResult);

        $this->client->expects($this->once())
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
            ->method('request')
            ->with(
                'POST',
                'api/v3/facade/order/',
                [
                    RequestOptions::BODY => self::SERIALIZED_VALUE,
                    RequestOptions::HEADERS => [
                        'Content-Type' => 'application/json',
                        'Authorization' => 'Bearer ' . self::TOKEN
                    ],
                    RequestOptions::HTTP_ERRORS => true,
                    RequestOptions::QUERY => null,
                ]
            )
            ->willReturn(
                (new Response())
                    ->withBody(stream_for(self::API_RESPONSE))
            );

        $result = $this->api->facadeOrder(self::TOKEN, $request);

        $this->assertEquals($expectedResult, $result);
    }

    public function testFacadeOrderDetails(): void
    {
        $expectedResult = new FacadeOrderDetailsResponse(self::IDENTITY, 'MANUAL', 123456);

        $this->serializer
            ->method('deserialize')
            ->with(
                get_class($expectedResult),
                self::API_RESPONSE
            )
            ->willReturn($expectedResult);

        $this->client->expects($this->once())
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
            ->method('request')
            ->with(
                'GET',
                sprintf('api/v3/facade/order/%s/details', self::IDENTITY),
                [
                    RequestOptions::BODY => null,
                    RequestOptions::HEADERS => [
                        'Content-Type' => 'application/json',
                        'Authorization' => 'Bearer ' . self::TOKEN
                    ],
                    RequestOptions::HTTP_ERRORS => true,
                    RequestOptions::QUERY => null,
                ]
            )
            ->willReturn(
                (new Response())
                    ->withBody(stream_for(self::API_RESPONSE))
            );

        $result = $this->api->facadeOrderDetails(self::TOKEN, self::IDENTITY);

        $this->assertEquals($expectedResult, $result);
    }

    public function testFacadeDocListV2(): void
    {
        $query = new FacadeDocListV2Query();
        $query->setDocumentStatus(FacadeDocListV2Query::DOCUMENT_STATUS_CHECKED_OK);
        $query->setDateFrom(new \DateTimeImmutable('2019-01-01 11:12:13', new \DateTimeZone('UTC')));
        $expectedResult = new FacadeDocListV2Response(0);

        $this->serializer
            ->method('deserialize')
            ->with(
                get_class($expectedResult),
                self::API_RESPONSE
            )
            ->willReturn($expectedResult);

        $this->client->expects($this->once())
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
            ->method('request')
            ->with(
                'GET',
                'api/v3/facade/doc/listV2',
                [
                    RequestOptions::BODY => null,
                    RequestOptions::HEADERS => [
                        'Content-Type' => 'application/json',
                        'Authorization' => 'Bearer ' . self::TOKEN
                    ],
                    RequestOptions::HTTP_ERRORS => true,
                    RequestOptions::QUERY => [
                        'documentStatus' => FacadeDocListV2Query::DOCUMENT_STATUS_CHECKED_OK,
                        'dateFrom' => '2019-01-01T11:12:13.000+00:00',
                        'limit' => $query->getLimit()
                    ],
                ]
            )
            ->willReturn(
                (new Response())
                    ->withBody(stream_for(self::API_RESPONSE))
            );

        $result = $this->api->facadeDocListV2(self::TOKEN, $query);

        $this->assertEquals($expectedResult, $result);
    }

    /**
     * @dataProvider dataFacadeDocBody
     */
    public function testFacadeDocBody(?int $limitOption, array $expectedOptions): void
    {
        $expectedResult = new FacadeDocBodyResponse(self::IDENTITY, '2019-01-01', 'IMPORT', 'NEW', 'Tester', 'Test');

        $this->serializer
            ->method('deserialize')
            ->with(
                get_class($expectedResult),
                self::API_RESPONSE
            )
            ->willReturn($expectedResult);

        $this->client->expects($this->once())
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
            ->method('request')
            ->with(
                'GET',
                sprintf('api/v3/facade/doc/%s/body', self::IDENTITY),
                $expectedOptions
            )
            ->willReturn(
                (new Response())
                    ->withBody(stream_for(self::API_RESPONSE))
            );

        $result = $this->api->facadeDocBody(self::TOKEN, self::IDENTITY, $limitOption);

        $this->assertEquals($expectedResult, $result);
    }

    public function dataFacadeDocBody(): iterable
    {
        yield 'null as a limit' => [
            null,
            [
                RequestOptions::BODY => null,
                RequestOptions::HEADERS => [
                    'Content-Type' => 'application/json',
                    'Authorization' => 'Bearer ' . self::TOKEN
                ],
                RequestOptions::HTTP_ERRORS => true,
                RequestOptions::QUERY => null,
            ]
        ];

        yield 'number as a limit' => [
            1000,
            [
                RequestOptions::BODY => null,
                RequestOptions::HEADERS => [
                    'Content-Type' => 'application/json',
                    'Authorization' => 'Bearer ' . self::TOKEN
                ],
                RequestOptions::HTTP_ERRORS => true,
                RequestOptions::QUERY => [
                    'limit' => 1000
                ],
            ]
        ];
    }

    public function testFacadeCisList(): void
    {
        $expectedResult = new FacadeCisListResponse();

        $this->serializer
            ->method('deserialize')
            ->with(
                get_class($expectedResult),
                self::API_RESPONSE
            )
            ->willReturn($expectedResult);

        $this->client->expects($this->once())
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
            ->method('request')
            ->with(
                'GET',
                'api/v3/facade/cis/cis_list',
                [
                    RequestOptions::BODY => null,
                    RequestOptions::HEADERS => [
                        'Content-Type' => 'application/json',
                        'Authorization' => 'Bearer ' . self::TOKEN
                    ],
                    RequestOptions::HTTP_ERRORS => true,
                    RequestOptions::QUERY => [
                        'cis' => self::IDENTITY
                    ],
                ]
            )
            ->willReturn(
                (new Response())
                    ->withBody(stream_for(self::API_RESPONSE))
            );

        $result = $this->api->facadeCisList(self::TOKEN, self::IDENTITY);

        $this->assertEquals($expectedResult, $result);
    }

    public function testLkDocumentsCreate(): void
    {
        $request = new DocumentCreateRequest(
            'document',
            'MANUAL',
            'signature',
            ProductGroup::SHOES,
            DocumentLkType::LP_INTRODUCE_GOODS
        );

        $this->serializer
            ->method('serialize')
            ->with($request)
            ->willReturn(self::SERIALIZED_VALUE);

        $this->client->expects($this->once())
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
            ->method('request')
            ->with(
                'POST',
                'api/v3/lk/documents/create',
                [
                    RequestOptions::BODY => self::SERIALIZED_VALUE,
                    RequestOptions::HEADERS => [
                        'Content-Type' => 'application/json',
                        'Authorization' => 'Bearer ' . self::TOKEN,
                    ],
                    RequestOptions::HTTP_ERRORS => true,
                    RequestOptions::QUERY => ['pg' => ProductGroup::SHOES],
                ]
            )
            ->willReturn(
                (new Response())
                    ->withBody(stream_for(self::API_RESPONSE))
            );

        $result = $this->api->lkDocumentsCreate(self::TOKEN, $request);

        $this->assertEquals(self::API_RESPONSE, $result);
    }

    public function testLkImportSend(): void
    {
        $request = new DocumentCreateRequest('document', 'MANUAL', 'signature');

        $this->serializer
            ->method('serialize')
            ->with($request)
            ->willReturn(self::SERIALIZED_VALUE);

        $this->client->expects($this->once())
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
            ->method('request')
            ->with(
                'POST',
                'api/v3/lk/import/send',
                [
                    RequestOptions::BODY => self::SERIALIZED_VALUE,
                    RequestOptions::HEADERS => [
                        'Content-Type' => 'application/json',
                        'Authorization' => 'Bearer ' . self::TOKEN
                    ],
                    RequestOptions::HTTP_ERRORS => true,
                    RequestOptions::QUERY => null,
                ]
            )
            ->willReturn(
                (new Response())
                    ->withBody(stream_for(self::API_RESPONSE))
            );

        $result = $this->api->lkImportSend(self::TOKEN, $request);

        $this->assertEquals(self::API_RESPONSE, $result);
    }

    public function testLkReceiptSend(): void
    {
        $request = new DocumentCreateRequest('document', 'MANUAL', 'signature');

        $this->serializer
            ->method('serialize')
            ->with($request)
            ->willReturn(self::SERIALIZED_VALUE);

        $this->client->expects($this->once())
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
            ->method('request')
            ->with(
                'POST',
                'api/v3/lk/receipt/send',
                [
                    RequestOptions::BODY => self::SERIALIZED_VALUE,
                    RequestOptions::HEADERS => [
                        'Content-Type' => 'application/json',
                        'Authorization' => 'Bearer ' . self::TOKEN
                    ],
                    RequestOptions::HTTP_ERRORS => true,
                    RequestOptions::QUERY => null,
                ]
            )
            ->willReturn(
                (new Response())
                    ->withBody(stream_for(self::API_RESPONSE))
            );

        $result = $this->api->lkReceiptSend(self::TOKEN, $request);

        $this->assertEquals(self::API_RESPONSE, $result);
    }

    public function testLkDocumentsShipmentCreate(): void
    {
        $request = new DocumentCreateRequest('document', 'MANUAL', 'signature');

        $this->serializer
            ->method('serialize')
            ->with($request)
            ->willReturn(self::SERIALIZED_VALUE);

        $this->client->expects($this->once())
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
            ->method('request')
            ->with(
                'POST',
                'api/v3/lk/documents/shipment/create',
                [
                    RequestOptions::BODY => self::SERIALIZED_VALUE,
                    RequestOptions::HEADERS => [
                        'Content-Type' => 'application/json',
                        'Authorization' => 'Bearer ' . self::TOKEN
                    ],
                    RequestOptions::HTTP_ERRORS => true,
                    RequestOptions::QUERY => null,
                ]
            )
            ->willReturn(
                (new Response())
                    ->withBody(stream_for(self::API_RESPONSE))
            );

        $result = $this->api->lkDocumentsShipmentCreate(self::TOKEN, $request);

        $this->assertEquals(self::API_RESPONSE, $result);
    }

    public function testLkDocumentsAcceptanceCreate(): void
    {
        $request = new DocumentCreateRequest('document', 'MANUAL', 'signature');

        $this->serializer
            ->method('serialize')
            ->with($request)
            ->willReturn(self::SERIALIZED_VALUE);

        $this->client->expects($this->once())
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
            ->method('request')
            ->with(
                'POST',
                'api/v3/lk/documents/acceptance/create',
                [
                    RequestOptions::BODY => self::SERIALIZED_VALUE,
                    RequestOptions::HEADERS => [
                        'Content-Type' => 'application/json',
                        'Authorization' => 'Bearer ' . self::TOKEN
                    ],
                    RequestOptions::HTTP_ERRORS => true,
                    RequestOptions::QUERY => null,
                ]
            )
            ->willReturn(
                (new Response())
                    ->withBody(stream_for(self::API_RESPONSE))
            );

        $result = $this->api->lkDocumentsAcceptanceCreate(self::TOKEN, $request);

        $this->assertEquals(self::API_RESPONSE, $result);
    }

    public function testProductInfo(): void
    {
        $request = ['aaa', 'bbb'];
        $expectedResult = new ProductInfoResponse([], 0);

        $this->serializer
            ->method('deserialize')
            ->with(
                get_class($expectedResult),
                self::API_RESPONSE
            )
            ->willReturn($expectedResult);

        $this->client->expects($this->once())
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
            ->method('request')
            ->with(
                'GET',
                'api/v3/product/info',
                [
                    RequestOptions::BODY => null,
                    RequestOptions::HEADERS => [
                        'Content-Type' => 'application/json',
                        'Authorization' => 'Bearer ' . self::TOKEN
                    ],
                    RequestOptions::HTTP_ERRORS => true,
                    RequestOptions::QUERY => [
                        'gtins' => implode(',', $request)
                    ],
                ]
            )
            ->willReturn(
                (new Response())
                    ->withBody(stream_for(self::API_RESPONSE))
            );

        $result = $this->api->productInfo(self::TOKEN, $request);

        $this->assertEquals($expectedResult, $result);
    }
}

Push — master ( db0ae1...f66061 )

IsmpApiTest::testLkImportSend() A

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

lamoda / crpt-ismp-api-client

Push — master ( db0ae1...f66061 )

IsmpApiTest::testLkImportSend() A

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like
