aliexpress-top-client/tests/RetailCrm/Tests/TopClient/ClientTest.php

<?php

/**
 * PHP version 7.3
 *
 * @category ClientTest
 * @package  RetailCrm\Tests\TopClient
 * @author   RetailCRM <integration@retailcrm.ru>
 * @license  MIT
 * @link     http://retailcrm.ru
 * @see      http://help.retailcrm.ru
 */
namespace RetailCrm\Tests\TopClient;

use Http\Message\RequestMatcher\CallbackRequestMatcher;
use Psr\Http\Message\RequestInterface;
use RetailCrm\Builder\TopClientBuilder;
use RetailCrm\Component\ConstraintViolationListTransformer;
use RetailCrm\Component\Exception\ValidationException;
use RetailCrm\Model\Entity\CategoryInfo;
use RetailCrm\Model\Enum\FeedOperationTypes;
use RetailCrm\Model\Enum\FeedStatuses;
use RetailCrm\Model\Enum\OfflinePickupTypes;
use RetailCrm\Model\Enum\OrderStatuses;
use RetailCrm\Model\Request\AliExpress\Data\OrderQuery;
use RetailCrm\Model\Request\AliExpress\Data\SingleItemRequestDto;
use RetailCrm\Model\Request\AliExpress\PostproductRedefiningCategoryForecast;
use RetailCrm\Model\Request\AliExpress\SolutionFeedListGet;
use RetailCrm\Model\Request\AliExpress\SolutionFeedQuery;
use RetailCrm\Model\Request\AliExpress\SolutionFeedSubmit;
use RetailCrm\Model\Request\AliExpress\SolutionOrderGet;
use RetailCrm\Model\Request\AliExpress\SolutionProductSchemaGet;
use RetailCrm\Model\Request\AliExpress\SolutionSellerCategoryTreeQuery;
use RetailCrm\Model\Request\Taobao\HttpDnsGetRequest;
use RetailCrm\Model\Response\AliExpress\Data\SolutionFeedSubmitResponseData;
use RetailCrm\Model\Response\AliExpress\Data\SolutionSellerCategoryTreeQueryResponseData;
use RetailCrm\Model\Response\AliExpress\Data\SolutionSellerCategoryTreeQueryResponseDataChildrenCategoryList;
use RetailCrm\Model\Response\AliExpress\PostproductRedefiningCategoryForecastResponse;
use RetailCrm\Model\Response\AliExpress\SolutionFeedListGetResponse;
use RetailCrm\Model\Response\AliExpress\SolutionProductSchemaGetResponse;
use RetailCrm\Model\Response\AliExpress\SolutionSellerCategoryTreeQueryResponse;
use RetailCrm\Model\Response\ErrorResponseBody;
use RetailCrm\Model\Response\Taobao\HttpDnsGetResponse;
use RetailCrm\Test\FakeDataRequestDto;
use RetailCrm\Test\RequestMatcher;
use RetailCrm\Test\TestCase;

/**
 * Class ClientTest
 *
 * @category ClientTest
 * @package  RetailCrm\Tests\TopClient
 * @author   RetailDriver LLC <integration@retailcrm.ru>
 * @license  MIT
 * @link     http://retailcrm.ru
 * @see      https://help.retailcrm.ru
 */
class ClientTest extends TestCase
{
    public function testClientRequestException()
    {
        $errorBody = new ErrorResponseBody();
        $errorBody->code = 999;
        $errorBody->msg = 'Mocked error';
        $errorBody->subCode = 'subcode';
        $errorBody->requestId = '1';
        $errorResponse = new HttpDnsGetResponse();
        $errorResponse->errorResponse = $errorBody;

        $mockClient = self::getMockClient();
        $mockClient->on(new CallbackRequestMatcher(function (RequestInterface $request) {
            return true;
        }), $this->responseJson(400, $errorResponse));

        $client = TopClientBuilder::create()
            ->setContainer($this->getContainer($mockClient))
            ->setAppData($this->getEnvAppData())
            ->build();

        $this->expectExceptionMessage($errorBody->msg);

        $client->sendRequest(new HttpDnsGetRequest());
    }

    public function testClientRequestXmlUnsupported()
    {
        $client = TopClientBuilder::create()
            ->setContainer($this->getContainer(self::getMockClient()))
            ->setAppData($this->getEnvAppData())
            ->build();

        $request = new HttpDnsGetRequest();
        $request->format = 'xml';

        $this->expectExceptionMessage('TopClient only supports JSON mode, got `xml` mode');
        $client->sendRequest($request);
    }

    public function testClientAliexpressSolutionSellerCategoryTreeQueryResponse()
    {
        $json = <<<'EOF'
{
    "aliexpress_solution_seller_category_tree_query_response":{
        "children_category_list":{
            "category_info":[
                {
                    "children_category_id":5090301,
                    "is_leaf_category":true,
                    "level":2,
                    "multi_language_names":"{   \"de\": \"Mobiltelefon\",   \"ru\": \"Мобильные телефоны\",   \"pt\": \"Telefonia\",   \"in\": \"Ponsel\",   \"en\": \"Mobile Phones\",   \"it\": \"Telefoni cellulari\",   \"fr\": \"Smartphones\",   \"es\": \"Smartphones\",   \"tr\": \"Cep Telefonu\",   \"nl\": \"Mobiele telefoons\" }"
                }
            ]
        },
        "is_success":true
    }
}
EOF;
        $expectedLangs = [
            'de' => 'Mobiltelefon',
            'ru' => 'Мобильные телефоны',
            'pt' => 'Telefonia',
            'in' => 'Ponsel',
            'en' => 'Mobile Phones',
            'it' => 'Telefoni cellulari',
            'fr' => 'Smartphones',
            'es' => 'Smartphones',
            'tr' => 'Cep Telefonu',
            'nl' => 'Mobiele telefoons'
        ];

        $mock = self::getMockClient();
        $mock->on(
            RequestMatcher::createMatcher('api.taobao.com')
                ->setPath('/router/rest')
                ->setOptionalQueryParams([
                    'app_key' => self::getEnvAppKey(),
                    'method' => 'aliexpress.solution.seller.category.tree.query',
                    'category_id' => '5090300',
                    'filter_no_permission' => 1,
                    'session' => self::getEnvToken()
                ]),
            $this->responseJson(200, $json)
        );
        $client = TopClientBuilder::create()
            ->setContainer($this->getContainer($mock))
            ->setAppData($this->getEnvAppData())
            ->setAuthenticator($this->getEnvTokenAuthenticator())
            ->build();
        $request = new SolutionSellerCategoryTreeQuery();

        $request->categoryId = 5090300;
        $request->filterNoPermission = true;

        /** @var SolutionSellerCategoryTreeQueryResponse $response */
        $result = $client->sendAuthenticatedRequest($request);

        self::assertInstanceOf(SolutionSellerCategoryTreeQueryResponseData::class, $result->responseData);
        self::assertInstanceOf(
            SolutionSellerCategoryTreeQueryResponseDataChildrenCategoryList::class,
            $result->responseData->childrenCategoryList
        );
        self::assertIsArray($result->responseData->childrenCategoryList->categoryInfo);
        self::assertCount(1, $result->responseData->childrenCategoryList->categoryInfo);

        $info = $result->responseData->childrenCategoryList->categoryInfo[0];

        self::assertInstanceOf(CategoryInfo::class, $info);
        self::assertEquals(5090301, $info->childrenCategoryId);
        self::assertTrue($info->isLeafCategory);
        self::assertEquals(2, $info->level);
        self::assertIsArray($info->multiLanguageNames);

        foreach ($expectedLangs as $lang => $value) {
            self::assertArrayHasKey($lang, $info->multiLanguageNames);
            self::assertEquals($value, $info->multiLanguageNames[$lang]);
        }
    }

    public function testClientAliexpressPostproductRedefiningCategoryForecastEmpty()
    {
        $json = <<<'EOF'
{
    "aliexpress_postproduct_redefining_categoryforecast_response":{
        "result":{
            "error_message":"The result of dii is empty. It should have a correct JSON format data return.",
            "category_suitability_list":{
                "json":[
                    "N\/A"
                ]
            },
            "time_stamp":"20181101111211",
            "error_code":24000011,
            "success":true
        }
    }
}
EOF;
        $mock = self::getMockClient();
        $mock->on(
            RequestMatcher::createMatcher('api.taobao.com')
                ->setPath('/router/rest')
                ->setOptionalQueryParams([
                    'app_key' => self::getEnvAppKey(),
                    'method' => 'aliexpress.postproduct.redefining.categoryforecast',
                    'session' => self::getEnvToken()
                ]),
            $this->responseJson(200, $json)
        );
        $client = TopClientBuilder::create()
            ->setContainer($this->getContainer($mock))
            ->setAppData($this->getEnvAppData())
            ->setAuthenticator($this->getEnvTokenAuthenticator())
            ->build();

        $request = new PostproductRedefiningCategoryForecast();
        $request->subject = 'man t-shirt';
        $request->locale = 'en';

        /** @var PostproductRedefiningCategoryForecastResponse $response */
        $response = $client->sendAuthenticatedRequest($request);

        self::assertInstanceOf(PostproductRedefiningCategoryForecastResponse::class, $response);
        self::assertEquals(
            "The result of dii is empty. It should have a correct JSON format data return.",
            $response->responseData->result->errorMessage
        );
        self::assertNull($response->responseData->result->categorySuitabilityList->json);
        self::assertEquals('20181101111211', $response->responseData->result->timeStamp);
        self::assertEquals('24000011', $response->responseData->result->errorCode);
        self::assertTrue($response->responseData->result->success);
    }

    public function testClientAliexpressPostproductRedefiningCategoryForecast()
    {
        $json = <<<'EOF'
{
  "aliexpress_postproduct_redefining_categoryforecast_response": {
    "result": {
      "category_suitability_list": {
        "json": [
          "{\"score\":0.696,\"suitabilityRank\":1,\"categoryId\":200000346}"
        ]
      },
      "success": true,
      "time_stamp": "2019-07-15 13:49:58"
    },
    "request_id": "10ixzzbmna198"
  }
}
EOF;
        $mock = self::getMockClient();
        $mock->on(
            RequestMatcher::createMatcher('api.taobao.com')
                ->setPath('/router/rest')
                ->setOptionalQueryParams([
                    'app_key' => self::getEnvAppKey(),
                    'method' => 'aliexpress.postproduct.redefining.categoryforecast',
                    'session' => self::getEnvToken()
                ]),
            $this->responseJson(200, $json)
        );
        $client = TopClientBuilder::create()
            ->setContainer($this->getContainer($mock))
            ->setAppData($this->getEnvAppData())
            ->setAuthenticator($this->getEnvTokenAuthenticator())
            ->build();

        $request = new PostproductRedefiningCategoryForecast();
        $request->subject = 'man t-shirt';
        $request->locale = 'en';

        /** @var PostproductRedefiningCategoryForecastResponse $response */
        $response = $client->sendAuthenticatedRequest($request);
        $items = $response->responseData->result->categorySuitabilityList->json;

        self::assertCount(1, $items);

        $item = $response->responseData->result->categorySuitabilityList->json[0];

        self::assertEquals(0.696, $item->score);
        self::assertEquals(1, $item->suitabilityRank);
        self::assertEquals(200000346, $item->categoryId);
    }

    public function testClientAliexpressSolutionFeedSubmit()
    {
        $json = <<<'EOF'
{
    "aliexpress_solution_feed_submit_response":{
        "job_id":200000000060024475
    }
}
EOF;
        $mock = self::getMockClient();
        $mock->on(
            RequestMatcher::createMatcher('api.taobao.com')
                ->setPath('/router/rest')
                ->setOptionalQueryParams([
                    'app_key' => self::getEnvAppKey(),
                    'method' => 'aliexpress.solution.feed.submit',
                    'session' => self::getEnvToken()
                ]),
            $this->responseJson(200, $json)
        );
        $client = TopClientBuilder::create()
            ->setContainer($this->getContainer($mock))
            ->setAppData($this->getEnvAppData())
            ->setAuthenticator($this->getEnvTokenAuthenticator())
            ->build();
        $dto = new FakeDataRequestDto();
        $item = new SingleItemRequestDto();
        $request = new SolutionFeedSubmit();

        $dto->code = 'code';
        $item->itemContent = $dto;
        $item->itemContentId = 'A00000000Y1';
        $request->operationType = FeedOperationTypes::PRODUCT_PRICES_UPDATE;
        $request->itemList = [$item];

        $response = $client->sendAuthenticatedRequest($request);

        self::assertInstanceOf(SolutionFeedSubmitResponseData::class, $response->responseData);
        self::assertEquals(200000000060024475, $response->responseData->jobId);
    }

    public function testClientAliexpressSolutionFeedQuery()
    {
        $json = <<<'EOF'
{
    "aliexpress_solution_feed_query_response":{
        "job_id":200000000060054475,
        "success_item_count":1,
        "result_list":{
            "single_item_response_dto":[
                {
                    "item_execution_result":"{\"productId\":33030372006,\"success\":true}",
                    "item_content_id":"A00000000Y1"
                }
            ]
        },
        "total_item_count":1
    }
}
EOF;
        $mock = self::getMockClient();
        $mock->on(
            RequestMatcher::createMatcher('api.taobao.com')
                ->setPath('/router/rest')
                ->setOptionalQueryParams([
                    'app_key' => self::getEnvAppKey(),
                    'method' => 'aliexpress.solution.feed.query',
                    'session' => self::getEnvToken()
                ]),
            $this->responseJson(200, $json)
        );
        $client = TopClientBuilder::create()
            ->setContainer($this->getContainer($mock))
            ->setAppData($this->getEnvAppData())
            ->setAuthenticator($this->getEnvTokenAuthenticator())
            ->build();
        $request = new SolutionFeedQuery();
        $request->jobId = 200000000060054475;

        /** @var \RetailCrm\Model\Response\AliExpress\SolutionFeedQueryResponse $response */
        $response = $client->sendAuthenticatedRequest($request);

        self::assertEquals(200000000060054475, $response->responseData->jobId);
        self::assertEquals(1, $response->responseData->successItemCount);
        self::assertNotNull($response->responseData->resultList);
        self::assertNotNull($response->responseData->resultList->singleItemResponseDto);
        self::assertCount(1, $response->responseData->resultList->singleItemResponseDto);

        $item = $response->responseData->resultList->singleItemResponseDto[0];

        self::assertEquals("A00000000Y1", $item->itemContentId);
        self::assertNotNull($item->itemExecutionResult);
        self::assertTrue($item->itemExecutionResult->success);
        self::assertEquals(33030372006, $item->itemExecutionResult->productId);
    }

    public function testAliexpressSolutionFeedListGet()
    {
        $json = <<<'EOF'
{
    "aliexpress_solution_feed_list_get_response":{
        "current_page":3,
        "job_list":{
            "batch_operation_job_dto":[
                {
                    "status":"PROCESSING",
                    "operation_type":"PRODUCT_CREATE",
                    "job_id":2000000000123456
                }
            ]
        },
        "page_size":20,
        "total_count":300,
        "total_page":15
    }
}
EOF;
        $mock = self::getMockClient();
        $mock->on(
            RequestMatcher::createMatcher('api.taobao.com')
                ->setPath('/router/rest')
                ->setOptionalQueryParams([
                    'app_key' => self::getEnvAppKey(),
                    'method' => 'aliexpress.solution.feed.list.get',
                    'session' => self::getEnvToken()
                ]),
            $this->responseJson(200, $json)
        );
        $client = TopClientBuilder::create()
            ->setContainer($this->getContainer($mock))
            ->setAppData($this->getEnvAppData())
            ->setAuthenticator($this->getEnvTokenAuthenticator())
            ->build();
        /** @var SolutionFeedListGetResponse $response */
        $response = $client->sendAuthenticatedRequest(new SolutionFeedListGet());

        self::assertEquals(3, $response->responseData->currentPage);
        self::assertEquals(20, $response->responseData->pageSize);
        self::assertEquals(300, $response->responseData->totalCount);
        self::assertEquals(15, $response->responseData->totalPage);
        self::assertNotNull($response->responseData->jobList);
        self::assertCount(1, $response->responseData->jobList->batchOperationJobDto);

        $item = $response->responseData->jobList->batchOperationJobDto[0];

        self::assertEquals(FeedStatuses::PROCESSING, $item->status);
        self::assertEquals(FeedOperationTypes::PRODUCT_CREATE, $item->operationType);
        self::assertEquals(2000000000123456, $item->jobId);
    }

    public function testAliexpressSolutionProductSchemaGet()
    {
        $json = <<<'EOF'
{
    "aliexpress_solution_product_schema_get_response":{
        "result":{
            "success":true,
            "error_code":"F00-00-10007-007",
            "error_message":"duplicate sku_code, please check your input",
            "schema":"{}"
        }
    }
}
EOF;
        $mock = self::getMockClient();
        $mock->on(
            RequestMatcher::createMatcher('api.taobao.com')
                ->setPath('/router/rest')
                ->setOptionalQueryParams([
                    'app_key' => self::getEnvAppKey(),
                    'method' => 'aliexpress.solution.product.schema.get',
                    'session' => self::getEnvToken()
                ]),
            $this->responseJson(200, $json)
        );
        $client = TopClientBuilder::create()
            ->setContainer($this->getContainer($mock))
            ->setAppData($this->getEnvAppData())
            ->setAuthenticator($this->getEnvTokenAuthenticator())
            ->build();
        $request = new SolutionProductSchemaGet();
        $request->aliexpressCategoryId = 1;

        $response = $client->sendAuthenticatedRequest($request);

        self::assertEquals('{}', $response->responseData->result->schema);
    }

    public function testAliexpressSolutionOrderGet()
    {
        $json = <<<'EOF'
{
    "aliexpress_solution_order_get_response":{
        "result":{
            "error_message":"1",
            "total_count":1,
            "target_list":{
                "order_dto":[
                    {
                        "timeout_left_time":120340569,
                        "seller_signer_fullname":"cn1234",
                        "seller_operator_login_id":"cn1234",
                        "seller_login_id":"cn1234",
                        "product_list":{
                            "order_product_dto":[
                                {
                                    "total_product_amount":{
                                        "currency_code":"USD",
                                        "amount":"1.01"
                                    },
                                    "son_order_status":"PLACE_ORDER_SUCCESS",
                                    "sku_code":"12",
                                    "show_status":"PLACE_ORDER_SUCCESS",
                                    "send_goods_time":"2017-10-12 12:12:12",
                                    "send_goods_operator":"WAREHOUSE_SEND_GOODS",
                                    "product_unit_price":{
                                        "currency_code":"USD",
                                        "amount":"1.01"
                                    },
                                    "product_unit":"piece",
                                    "product_standard":"",
                                    "product_snap_url":"http:\/\/www.aliexpress.com:1080\/snapshot\/null.html?orderId\\u003d1160045860056286",
                                    "product_name":"mobile",
                                    "product_img_url":"http:\/\/g03.a.alicdn.com\/kf\/images\/eng\/no_photo.gif",
                                    "product_id":2356980,
                                    "product_count":1,
                                    "order_id":222222,
                                    "money_back3x":false,
                                    "memo":"1",
                                    "logistics_type":"EMS",
                                    "logistics_service_name":"EMS",
                                    "logistics_amount":{
                                        "currency_code":"USD",
                                        "amount":"1.01"
                                    },
                                    "issue_status":"END_ISSUE",
                                    "issue_mode":"w",
                                    "goods_prepare_time":3,
                                    "fund_status":"WAIT_SELLER_CHECK",
                                    "freight_commit_day":"27",
                                    "escrow_fee_rate":"0.01",
                                    "delivery_time":"5-10",
                                    "child_id":23457890,
                                    "can_submit_issue":false,
                                    "buyer_signer_last_name":"1",
                                    "buyer_signer_first_name":"1",
                                    "afflicate_fee_rate":"0.03"
                                }
                            ]
                        },
                        "phone":false,
                        "payment_type":"ebanx101",
                        "pay_amount":{
                            "currency_code":"USD",
                            "amount":"1.01"
                        },
                        "order_status":"PLACE_ORDER_SUCCESS",
                        "order_id":1160045860056286,
                        "order_detail_url":"http",
                        "logistics_status":"NO_LOGISTICS",
                        "logisitcs_escrow_fee_rate":"1",
                        "loan_amount":{
                            "currency_code":"USD",
                            "amount":"1.01"
                        },
                        "left_send_good_min":"1",
                        "left_send_good_hour":"1",
                        "left_send_good_day":"1",
                        "issue_status":"END_ISSUE",
                        "has_request_loan":false,
                        "gmt_update":"2017-10-12 12:12:12",
                        "gmt_send_goods_time":"2017-10-12 12:12:12",
                        "gmt_pay_time":"2017-10-12 12:12:12",
                        "gmt_create":"2017-10-12 12:12:12",
                        "fund_status":"WAIT_SELLER_CHECK",
                        "frozen_status":"IN_FROZEN",
                        "escrow_fee_rate":1,
                        "escrow_fee":{
                            "currency_code":"USD",
                            "amount":"1.01"
                        },
                        "end_reason":"buyer_confirm_goods",
                        "buyer_signer_fullname":"test",
                        "buyer_login_id":"test",
                        "biz_type":"AE_RECHARGE",
                        "offline_pickup_type":"RU_OFFLINE_SELF_PICK_UP_EXPRESSION"
                    }
                ]
            },
            "page_size":1,
            "error_code":"1",
            "current_page":1,
            "total_page":1,
            "success":true,
            "time_stamp":"1"
        }
    }
}
EOF;
        $mock = self::getMockClient();
        $mock->on(
            RequestMatcher::createMatcher('api.taobao.com')
                ->setPath('/router/rest')
                ->setOptionalQueryParams([
                    'app_key' => self::getEnvAppKey(),
                    'method' => 'aliexpress.solution.order.get',
                    'session' => self::getEnvToken()
                ]),
            $this->responseJson(200, $json)
        );
        $client = TopClientBuilder::create()
            ->setContainer($this->getContainer($mock))
            ->setAppData($this->getEnvAppData())
            ->setAuthenticator($this->getEnvTokenAuthenticator())
            ->build();
        $query = new OrderQuery();
        $query->orderStatus = OrderStatuses::PLACE_ORDER_SUCCESS;
        $request = new SolutionOrderGet();
        $request->param0 = $query;

        /** @var \RetailCrm\Model\Response\AliExpress\SolutionOrderGetResponse $response */
        $response = $client->sendAuthenticatedRequest($request);
        $result = $response->responseData->result;

        self::assertTrue($result->success);
        self::assertEquals(1, $result->totalCount);
        self::assertCount(1, $result->targetList->orderDto);
        self::assertEquals(OrderStatuses::PLACE_ORDER_SUCCESS, $result->targetList->orderDto[0]->orderStatus);
        self::assertEquals(222222, $result->targetList->orderDto[0]->productList->orderProductDto[0]->orderId);
        self::assertEquals(
            OfflinePickupTypes::RU_OFFLINE_SELF_PICK_UP_EXPRESSION,
            $result->targetList->orderDto[0]->offlinePickupType
        );
    }
}