Merge branch 'MC-18365' of https://github.com/magento-chaika/magento2ce into PR-16-08-2019

Spandana Chittimala · Spandana Chittimala · commit 5bc04c606cff · 2019-08-16T12:02:36.000-05:00
diff --git a/app/code/Magento/Paypal/Model/Api/Nvp.php b/app/code/Magento/Paypal/Model/Api/Nvp.php
@@ -6,11 +6,13 @@
 
 namespace Magento\Paypal\Model\Api;
 
+use Magento\Framework\DataObject;
 use Magento\Payment\Model\Cart;
 use Magento\Payment\Model\Method\Logger;
 
 /**
  * NVP API wrappers model
+ *
  * @TODO: move some parts to abstract, don't hesitate to throw exceptions on api calls
  *
  * @method string getToken()
@@ -1085,11 +1087,11 @@ public function callUpdateBillingAgreement()
      * Import callback request array into $this public data
      *
      * @param array $request
-     * @return \Magento\Framework\DataObject
+     * @return DataObject
      */
     public function prepareShippingOptionsCallbackAddress(array $request)
     {
-        $address = new \Magento\Framework\DataObject();
+        $address = new DataObject();
         \Magento\Framework\DataObject\Mapper::accumulateByMap($request, $address, $this->_callbackRequestMap);
         $address->setExportedKeys(array_values($this->_callbackRequestMap));
         $this->_applyStreetAndRegionWorkarounds($address);
@@ -1126,6 +1128,7 @@ protected function _addMethodToRequest($methodName, $request)
 
     /**
      * Additional response processing.
+     *
      * Hack to cut off length from API type response params.
      *
      * @param array $response
@@ -1414,6 +1417,7 @@ protected function _validateResponse($method, $response)
 
     /**
      * Parse an NVP response string into an associative array
+     *
      * @param string $nvpstr
      * @return array
      */
@@ -1477,7 +1481,7 @@ protected function _exportAddressses($data)
      */
     protected function _exportAddresses($data)
     {
-        $address = new \Magento\Framework\DataObject();
+        $address = new DataObject();
         \Magento\Framework\DataObject\Mapper::accumulateByMap($data, $address, $this->_billingAddressMap);
         $address->setExportedKeys(array_values($this->_billingAddressMap));
         $this->_applyStreetAndRegionWorkarounds($address);
@@ -1488,18 +1492,18 @@ protected function _exportAddresses($data)
             \Magento\Framework\DataObject\Mapper::accumulateByMap($data, $shippingAddress, $this->_shippingAddressMap);
             $this->_applyStreetAndRegionWorkarounds($shippingAddress);
             // PayPal doesn't provide detailed shipping name fields, so the name will be overwritten
-            $shippingAddress->addData(['firstname'  => $data['SHIPTONAME']]);
+            $this->updateShippingAddressWithShipToName($shippingAddress, $data);
             $this->setExportedShippingAddress($shippingAddress);
         }
     }
 
     /**
      * Adopt specified address object to be compatible with Magento
      *
-     * @param \Magento\Framework\DataObject $address
+     * @param DataObject $address
      * @return void
      */
-    protected function _applyStreetAndRegionWorkarounds(\Magento\Framework\DataObject $address)
+    protected function _applyStreetAndRegionWorkarounds(DataObject $address)
     {
         // merge street addresses into 1
         if ($address->getData('street2') !== null) {
@@ -1515,11 +1519,10 @@ protected function _applyStreetAndRegionWorkarounds(\Magento\Framework\DataObjec
             )->setPageSize(
                 1
             );
-            foreach ($regions as $region) {
-                $address->setRegionId($region->getId());
-                $address->setExportedKeys(array_merge($address->getExportedKeys(), ['region_id']));
-                break;
-            }
+            $regionItems = $regions->getItems();
+            $region = array_shift($regionItems);
+            $address->setRegionId($region->getId());
+            $address->setExportedKeys(array_merge($address->getExportedKeys(), ['region_id']));
         }
     }
 
@@ -1757,4 +1760,23 @@ protected function _prepareExpressCheckoutCallRequest(&$requestFields)
             }
         }
     }
+
+    /**
+     * Updates shipping address with 'ship to name' data
+     *
+     * @param DataObject $shippingAddress
+     * @param array $data
+     * @return void
+     */
+    private function updateShippingAddressWithShipToName(DataObject $shippingAddress, array $data)
+    {
+        if (isset($data['SHIPTONAME'])) {
+            $nameParts = explode(' ', $data['SHIPTONAME'], 2);
+            $shippingAddress->addData(['firstname' => $nameParts[0]]);
+
+            if (isset($nameParts[1])) {
+                $shippingAddress->addData(['lastname' => $nameParts[1]]);
+            }
+        }
+    }
 }
diff --git a/app/code/Magento/Paypal/Model/Express/Checkout.php b/app/code/Magento/Paypal/Model/Express/Checkout.php
@@ -357,12 +357,14 @@ public function __construct(
         if (isset($params['config']) && $params['config'] instanceof PaypalConfig) {
             $this->_config = $params['config'];
         } else {
+            // phpcs:ignore Magento2.Exceptions.DirectThrow
             throw new \Exception('Config instance is required.');
         }
 
         if (isset($params['quote']) && $params['quote'] instanceof \Magento\Quote\Model\Quote) {
             $this->_quote = $params['quote'];
         } else {
+            // phpcs:ignore Magento2.Exceptions.DirectThrow
             throw new \Exception('Quote instance is required.');
         }
     }
@@ -631,10 +633,9 @@ public function returnFromPaypal($token, string $payerIdentifier = null)
             if ($shippingAddress) {
                 if ($exportedShippingAddress && $isButton) {
                     $this->_setExportedAddressData($shippingAddress, $exportedShippingAddress);
-                    // PayPal doesn't provide detailed shipping info: prefix, middlename, lastname, suffix
+                    // PayPal doesn't provide detailed shipping info: prefix, middlename, suffix
                     $shippingAddress->setPrefix(null);
                     $shippingAddress->setMiddlename(null);
-                    $shippingAddress->setLastname(null);
                     $shippingAddress->setSuffix(null);
                     $shippingAddress->setCollectShippingRates(true);
                     $shippingAddress->setSameAsBilling(0);
@@ -1037,7 +1038,7 @@ protected function _prepareShippingOptions(Address $address, $mayReturnEmpty = f
 
         // Magento will transfer only first 10 cheapest shipping options if there are more than 10 available.
         if (count($options) > 10) {
-            usort($options, [get_class($this), 'cmpShippingOptions']);
+            usort($options, [$this, 'cmpShippingOptions']);
             array_splice($options, 10);
             // User selected option will be always included in options list
             if ($userSelectedOption !== null && !in_array($userSelectedOption, $options)) {
@@ -1058,7 +1059,7 @@ protected function _prepareShippingOptions(Address $address, $mayReturnEmpty = f
      * @param \Magento\Framework\DataObject $option2
      * @return int
      */
-    protected static function cmpShippingOptions(DataObject $option1, DataObject $option2)
+    protected function cmpShippingOptions(DataObject $option1, DataObject $option2)
     {
         return $option1->getAmount() <=> $option2->getAmount();
     }
diff --git a/app/code/Magento/Paypal/Test/Unit/Model/Api/NvpTest.php b/app/code/Magento/Paypal/Test/Unit/Model/Api/NvpTest.php
@@ -6,6 +6,7 @@
 
 namespace Magento\Paypal\Test\Unit\Model\Api;
 
+use Magento\Framework\Exception\LocalizedException;
 use Magento\Framework\TestFramework\Unit\Helper\ObjectManager as ObjectManagerHelper;
 use Magento\Paypal\Model\Info;
 
@@ -35,7 +36,7 @@ class NvpTest extends \PHPUnit\Framework\TestCase
     /** @var \Magento\Paypal\Model\Api\ProcessableException|\PHPUnit_Framework_MockObject_MockObject */
     protected $processableException;
 
-    /** @var \Magento\Framework\Exception\LocalizedException|\PHPUnit_Framework_MockObject_MockObject */
+    /** @var LocalizedException|\PHPUnit_Framework_MockObject_MockObject */
     protected $exception;
 
     /** @var \Magento\Framework\HTTP\Adapter\Curl|\PHPUnit_Framework_MockObject_MockObject */
@@ -47,6 +48,9 @@ class NvpTest extends \PHPUnit\Framework\TestCase
     /** @var \Magento\Payment\Model\Method\Logger|\PHPUnit_Framework_MockObject_MockObject */
     protected $customLoggerMock;
 
+    /**
+     * {@inheritDoc}
+     */
     protected function setUp()
     {
         $this->customerAddressHelper = $this->createMock(\Magento\Customer\Helper\Address::class);
@@ -64,26 +68,32 @@ protected function setUp()
         );
         $processableExceptionFactory->expects($this->any())
             ->method('create')
-            ->will($this->returnCallback(function ($arguments) {
-                $this->processableException = $this->getMockBuilder(
-                    \Magento\Paypal\Model\Api\ProcessableException::class
+            ->will(
+                $this->returnCallback(
+                    function ($arguments) {
+                        $this->processableException = $this->getMockBuilder(
+                            \Magento\Paypal\Model\Api\ProcessableException::class
+                        )->setConstructorArgs([$arguments['phrase'], null, $arguments['code']])->getMock();
+                        return $this->processableException;
+                    }
                 )
-                    ->setConstructorArgs([$arguments['phrase'], null, $arguments['code']])
-                    ->getMock();
-                return $this->processableException;
-            }));
+            );
         $exceptionFactory = $this->createPartialMock(
             \Magento\Framework\Exception\LocalizedExceptionFactory::class,
             ['create']
         );
         $exceptionFactory->expects($this->any())
             ->method('create')
-            ->will($this->returnCallback(function ($arguments) {
-                $this->exception = $this->getMockBuilder(\Magento\Framework\Exception\LocalizedException::class)
-                    ->setConstructorArgs([$arguments['phrase']])
-                    ->getMock();
-                return $this->exception;
-            }));
+            ->will(
+                $this->returnCallback(
+                    function ($arguments) {
+                        $this->exception = $this->getMockBuilder(LocalizedException::class)
+                            ->setConstructorArgs([$arguments['phrase']])
+                            ->getMock();
+                        return $this->exception;
+                    }
+                )
+            );
         $this->curl = $this->createMock(\Magento\Framework\HTTP\Adapter\Curl::class);
         $curlFactory = $this->createPartialMock(\Magento\Framework\HTTP\Adapter\CurlFactory::class, ['create']);
         $curlFactory->expects($this->any())->method('create')->will($this->returnValue($this->curl));
@@ -155,7 +165,7 @@ public function callDataProvider()
             [
                 "\r\n" . 'ACK=Failure&L_ERRORCODE0=10417&L_SHORTMESSAGE0=Message.&L_LONGMESSAGE0=Long%20Message.',
                 [],
-                \Magento\Framework\Exception\LocalizedException::class,
+                LocalizedException::class,
                 'PayPal gateway has rejected request. Long Message (#10417: Message).',
                 0
             ],
@@ -184,27 +194,56 @@ public function callDataProvider()
         ];
     }
 
-    public function testCallGetExpressCheckoutDetails()
+    /**
+     * Test getting of the ExpressCheckout details
+     *
+     * @param $input
+     * @param $expected
+     * @dataProvider callGetExpressCheckoutDetailsDataProvider
+     */
+    public function testCallGetExpressCheckoutDetails($input, $expected)
     {
         $this->curl->expects($this->once())
             ->method('read')
-            ->will($this->returnValue(
-                "\r\n" . 'ACK=Success&SHIPTONAME=Ship%20To%20Name'
+            ->will($this->returnValue($input));
+        $this->model->callGetExpressCheckoutDetails();
+        $address = $this->model->getExportedShippingAddress();
+        $this->assertEquals($expected['firstName'], $address->getData('firstname'));
+        $this->assertEquals($expected['lastName'], $address->getData('lastname'));
+        $this->assertEquals($expected['street'], $address->getStreet());
+        $this->assertEquals($expected['company'], $address->getCompany());
+        $this->assertEquals($expected['city'], $address->getCity());
+        $this->assertEquals($expected['telephone'], $address->getTelephone());
+        $this->assertEquals($expected['region'], $address->getRegion());
+    }
+
+    /**
+     * Data Provider
+     *
+     * @return array
+     */
+    public function callGetExpressCheckoutDetailsDataProvider()
+    {
+        return [
+            [
+                "\r\n" . 'ACK=Success&SHIPTONAME=Jane%20Doe'
                 . '&SHIPTOSTREET=testStreet'
                 . '&SHIPTOSTREET2=testApartment'
                 . '&BUSINESS=testCompany'
                 . '&SHIPTOCITY=testCity'
                 . '&PHONENUM=223322'
-                . '&STATE=testSTATE'
-            ));
-        $this->model->callGetExpressCheckoutDetails();
-        $address = $this->model->getExportedShippingAddress();
-        $this->assertEquals('Ship To Name', $address->getData('firstname'));
-        $this->assertEquals(implode("\n", ['testStreet','testApartment']), $address->getStreet());
-        $this->assertEquals('testCompany', $address->getCompany());
-        $this->assertEquals('testCity', $address->getCity());
-        $this->assertEquals('223322', $address->getTelephone());
-        $this->assertEquals('testSTATE', $address->getRegion());
+                . '&STATE=testSTATE',
+                [
+                    'firstName' => 'Jane',
+                    'lastName' => 'Doe',
+                    'street' => 'testStreet' . "\n" . 'testApartment',
+                    'company' => 'testCompany',
+                    'city' => 'testCity',
+                    'telephone' => '223322',
+                    'region' => 'testSTATE',
+                ]
+            ]
+        ];
     }
 
     /**
@@ -243,6 +282,9 @@ public function testCallDoReauthorization()
         $this->assertEquals($expectedImportedData, $this->model->getData());
     }
 
+    /**
+     * Test replace keys for debug data
+     */
     public function testGetDebugReplacePrivateDataKeys()
     {
         $debugReplacePrivateDataKeys = $this->_invokeNvpProperty($this->model, '_debugReplacePrivateDataKeys');
diff --git a/dev/tests/integration/testsuite/Magento/Paypal/Model/Express/CheckoutTest.php b/dev/tests/integration/testsuite/Magento/Paypal/Model/Express/CheckoutTest.php
@@ -278,7 +278,6 @@ public function testReturnFromPaypal()
         $this->assertTrue((bool)$shippingAddress->getSameAsBilling());
         $this->assertNull($shippingAddress->getPrefix());
         $this->assertNull($shippingAddress->getMiddlename());
-        $this->assertNull($shippingAddress->getLastname());
         $this->assertNull($shippingAddress->getSuffix());
         $this->assertTrue($shippingAddress->getShouldIgnoreValidation());
         $this->assertContains('exported', $shippingAddress->getFirstname());
