[Issue] Add VIES validation result object to the response.

m2-assistant[bot] commented 6 months ago

This issue is automatically created based on existing pull request: magento/magento2#31010: Add VIES validation result object to the response.

Description

This commit adds result_object to the method response. This allows doing some additional validation logic in the plugin written for Magento\Customer\Model\Vat model. For some countries, this object returns additional fields:

traderName: "customer or company name"
traderCompanyType: "company type"
traderAddress: "
multiline address
associated with tax number
"

Manual testing scenarios

Apply the patch.
To test it you need a valid Netherland taxvat number.
Open vat validator model and add the following code right before the end of the method: https://github.com/magento/magento2/blob/HEAD/app/code/Magento/Customer/Model/Vat.php#L218
```
(new \Zend\Log\Logger())
    ->addWriter(new \Zend\Log\Writer\Stream(BP . '/var/log/custom.log'))
    ->debug((array)$gatewayResponse->getResultObject());
```
Go to admin config Stores > Configuration > General > Store Information
Select a valid country for your tax number, fill the tax number field, and press the "Validate VAT Number" button.

Check the magento_root/var/log/custom.log. You should see the VIES result object:

2020-11-23T09:25:57+00:00 DEBUG (7): array (
  'countryCode' => 'NL',
  'vatNumber' => 'vatnumber',
  'requestDate' => '2020-11-23+01:00',
  'valid' => true,
  'traderName' => 'companyname',
  'traderCompanyType' => '---',
  'traderAddress' => '
company
address
',
  'requestIdentifier' => '',
)

Contribution checklist (*)

[x] Pull request has a meaningful description of its purpose
[x] All commits are accompanied by meaningful commit messages
[ ] All new or changed code is covered with unit/integration tests (if applicable)
[ ] All automated tests passed successfully (all builds are green)

m2-assistant[bot] commented 5 months ago

Hi @engcom-November. Thank you for working on this issue. In order to make sure that issue has enough information and ready for development, please read and check the following instruction: :point_down:

[ ] 1. Verify that issue has all the required information. (Preconditions, Steps to reproduce, Expected result, Actual result).
[ ] 2. Verify that issue has a meaningful description and provides enough information to reproduce the issue.
[ ] 3. Add Area: XXXXX label to the ticket, indicating the functional areas it may be related to.
[ ] 4. Verify that the issue is reproducible on 2.4-develop branch
Details
- Add the comment @magento give me 2.4-develop instance to deploy test instance on Magento infrastructure.
- If the issue is reproducible on 2.4-develop branch, please, add the label Reproduced on 2.4.x.
- If the issue is not reproducible, add your comment that issue is not reproducible and close the issue and stop verification process here!
[ ] 5. Add label Issue: Confirmed once verification is complete.
[ ] 6. Make sure that automatic system confirms that report has been added to the backlog.

engcom-November commented 5 months ago

Hello @vovayatsyuk,

Thank you for the report and collaboration!

This issue can be marked as feature request, as you are adding reult object to log file for a better validation logic. Thank you.

vovayatsyuk commented 5 months ago

Yes, it's a feature request to add the address returned by Vat Vies validation service to the result object, so other third-party modules may work with it.

magento / magento2