Merge pull request #221 from magento-fearless-kiwis/FearlessKiwis-MAGETWO-55117-ShippingMethodManagement-estimateByAddressId-not-full

magicbunneh · web-flow · commit 08786229f233 · 2016-08-05T10:46:18.000+03:00
[Fearless Kiwis] MAGETWO-55117: Shipping method management estimate by address id
diff --git a/app/code/Magento/Quote/Model/ShippingMethodManagement.php b/app/code/Magento/Quote/Model/ShippingMethodManagement.php
@@ -13,6 +13,9 @@
 use Magento\Quote\Api\Data\EstimateAddressInterface;
 use Magento\Quote\Api\ShipmentEstimationInterface;
 use Magento\Quote\Model\Quote;
+use Magento\Framework\Reflection\DataObjectProcessor;
+use Magento\Framework\App\ObjectManager;
+use Magento\Customer\Api\Data\AddressInterfaceFactory;
 
 /**
  * Shipping method read service.
@@ -49,6 +52,16 @@ class ShippingMethodManagement implements
      */
     protected $totalsCollector;
 
+    /**
+     * @var \Magento\Framework\Reflection\DataObjectProcessor $dataProcessor
+     */
+    private $dataProcessor;
+
+    /**
+     * @var AddressInterfaceFactory $addressFactory
+     */
+    private $addressFactory;
+
     /**
      * Constructs a shipping method read service object.
      *
@@ -189,13 +202,7 @@ public function estimateByAddress($cartId, \Magento\Quote\Api\Data\EstimateAddre
             return [];
         }
 
-        return $this->getEstimatedRates(
-            $quote,
-            $address->getCountryId(),
-            $address->getPostcode(),
-            $address->getRegionId(),
-            $address->getRegion()
-        );
+        return $this->getShippingMethods($quote, $address);
     }
 
     /**
@@ -210,7 +217,7 @@ public function estimateByExtendedAddress($cartId, AddressInterface $address)
         if ($quote->isVirtual() || 0 == $quote->getItemsCount()) {
             return [];
         }
-        return $this->getShippingMethods($quote, $address->getData());
+        return $this->getShippingMethods($quote, $address);
     }
 
     /**
@@ -227,13 +234,7 @@ public function estimateByAddressId($cartId, $addressId)
         }
         $address = $this->addressRepository->getById($addressId);
 
-        return $this->getEstimatedRates(
-            $quote,
-            $address->getCountryId(),
-            $address->getPostcode(),
-            $address->getRegionId(),
-            $address->getRegion()
-        );
+        return $this->getShippingMethods($quote, $address);
     }
 
     /**
@@ -244,30 +245,39 @@ public function estimateByAddressId($cartId, $addressId)
      * @param string $postcode
      * @param int $regionId
      * @param string $region
+     * @param \Magento\Framework\Api\ExtensibleDataInterface|null $address
      * @return \Magento\Quote\Api\Data\ShippingMethodInterface[] An array of shipping methods.
+     * @deprecated
      */
-    protected function getEstimatedRates(\Magento\Quote\Model\Quote $quote, $country, $postcode, $regionId, $region)
-    {
-        $data = [
-            EstimateAddressInterface::KEY_COUNTRY_ID => $country,
-            EstimateAddressInterface::KEY_POSTCODE => $postcode,
-            EstimateAddressInterface::KEY_REGION_ID => $regionId,
-            EstimateAddressInterface::KEY_REGION => $region
-        ];
-        return $this->getShippingMethods($quote, $data);
+    protected function getEstimatedRates(
+        \Magento\Quote\Model\Quote $quote,
+        $country,
+        $postcode,
+        $regionId,
+        $region,
+        $address = null
+    ) {
+        if (!$address) {
+            $address = $this->getAddressFactory()->create()
+                ->setCountryId($country)
+                ->setPostcode($postcode)
+                ->setRegionId($regionId)
+                ->setRegion($region);
+        }
+        return $this->getShippingMethods($quote, $address);
     }
 
     /**
      * Get list of available shipping methods
      * @param \Magento\Quote\Model\Quote $quote
-     * @param array $addressData
+     * @param \Magento\Framework\Api\ExtensibleDataInterface $address
      * @return \Magento\Quote\Api\Data\ShippingMethodInterface[]
      */
-    private function getShippingMethods(Quote $quote, array $addressData)
+    private function getShippingMethods(Quote $quote, $address)
     {
         $output = [];
         $shippingAddress = $quote->getShippingAddress();
-        $shippingAddress->addData($addressData);
+        $shippingAddress->addData($this->extractAddressData($address));
         $shippingAddress->setCollectShippingRates(true);
 
         $this->totalsCollector->collectAddressTotals($quote, $shippingAddress);
@@ -279,4 +289,51 @@ private function getShippingMethods(Quote $quote, array $addressData)
         }
         return $output;
     }
+
+    /**
+     * Get transform address interface into Array
+     * @param \Magento\Framework\Api\ExtensibleDataInterface  $address
+     * @return array
+     */
+    private function extractAddressData($address)
+    {
+        $className = \Magento\Customer\Api\Data\AddressInterface::class;
+        if ($address instanceof \Magento\Quote\Api\Data\AddressInterface) {
+            $className = \Magento\Quote\Api\Data\AddressInterface::class;
+        } elseif ($address instanceof EstimateAddressInterface) {
+            $className = EstimateAddressInterface::class;
+        }
+        return $this->getDataObjectProcessor()->buildOutputDataArray(
+            $address,
+            $className
+        );
+    }
+
+    /**
+     * Gets the data object processor
+     * @return \Magento\Framework\Reflection\DataObjectProcessor
+     * @deprecated
+     */
+    private function getDataObjectProcessor()
+    {
+        if ($this->dataProcessor === null) {
+            $this->dataProcessor = ObjectManager::getInstance()
+                ->get(DataObjectProcessor::class);
+        }
+        return $this->dataProcessor;
+    }
+
+    /**
+     * Gets the address factory
+     * @return AddressInterfaceFactory
+     * @deprecated
+     */
+    private function getAddressFactory()
+    {
+        if ($this->addressFactory === null) {
+            $this->addressFactory = ObjectManager::getInstance()
+                ->get(AddressInterfaceFactory::class);
+        }
+        return $this->addressFactory;
+    }
 }
diff --git a/app/code/Magento/Quote/Test/Unit/Model/ShippingMethodManagementTest.php b/app/code/Magento/Quote/Test/Unit/Model/ShippingMethodManagementTest.php
@@ -63,6 +63,21 @@ class ShippingMethodManagementTest extends \PHPUnit_Framework_TestCase
      */
     private $shippingAddress;
 
+    /**
+     * @var \Magento\Framework\Reflection\DataObjectProcessor|MockObject
+     */
+    private $dataProcessor;
+
+    /**
+     * @var \Magento\Customer\Api\Data\AddressInterfaceFactory|MockObject
+     */
+    private $addressFactory;
+
+    /**
+     * @var \Magento\Customer\Api\AddressRepositoryInterface|MockObject
+     */
+    private $addressRepository;
+
     /**
      * @var TotalsCollector|MockObject
      */
@@ -72,16 +87,17 @@ protected function setUp()
     {
         $this->objectManager = new ObjectManager($this);
         $this->quoteRepository = $this->getMock(\Magento\Quote\Api\CartRepositoryInterface::class);
-        $this->methodDataFactoryMock = $this->getMock(
-            \Magento\Quote\Api\Data\ShippingMethodInterfaceFactory::class,
-            [
-                'create'
-            ],
-            [],
-            '',
-            false
-        );
+        $this->addressRepository = $this->getMock(\Magento\Customer\Api\AddressRepositoryInterface::class);
+
+        $className = \Magento\Quote\Api\Data\ShippingMethodInterfaceFactory::class;
+        $this->methodDataFactoryMock = $this->getMock($className, ['create'], [], '', false);
 
+        $className = \Magento\Customer\Api\Data\AddressInterfaceFactory::class;
+        $this->addressFactory = $this->getMock($className, ['create'], [], '', false);
+
+        $className = \Magento\Framework\Reflection\DataObjectProcessor::class;
+        $this->dataProcessor = $this->getMock($className, [], [], '', false);
+        
         $this->storeMock = $this->getMock(\Magento\Store\Model\Store::class, [], [], '', false);
         $this->quote = $this->getMockBuilder(Quote::class)
             ->disableOriginalConstructor()
@@ -132,9 +148,22 @@ protected function setUp()
                 'quoteRepository' => $this->quoteRepository,
                 'methodDataFactory' => $this->methodDataFactoryMock,
                 'converter' => $this->converter,
-                'totalsCollector' => $this->totalsCollector
+                'totalsCollector' => $this->totalsCollector,
+                'addressRepository' => $this->addressRepository
             ]
         );
+
+        $this->objectManager->setBackwardCompatibleProperty(
+            $this->model,
+            'addressFactory',
+            $this->addressFactory
+        );
+
+        $this->objectManager->setBackwardCompatibleProperty(
+            $this->model,
+            'dataProcessor',
+            $this->dataProcessor
+        );
     }
 
     /**
@@ -457,11 +486,17 @@ public function testEstimateByExtendedAddress()
         ];
         $currencyCode = 'UAH';
 
+        /**
+         * @var \Magento\Quote\Api\Data\AddressInterface|MockObject $address
+         */
         $address = $this->getMockBuilder(Address::class)
             ->disableOriginalConstructor()
-            ->setMethods(['getData'])
             ->getMock();
 
+        $this->addressFactory->expects($this->any())
+            ->method('create')
+            ->will($this->returnValue($address));
+
         $this->quoteRepository->expects(static::once())
             ->method('getActive')
             ->with($cartId)
@@ -474,18 +509,98 @@ public function testEstimateByExtendedAddress()
             ->method('getItemsCount')
             ->willReturn(1);
 
-        $address->expects(static::once())
-            ->method('getData')
-            ->willReturn($addressData);
-
         $this->quote->expects(static::once())
             ->method('getShippingAddress')
             ->willReturn($this->shippingAddress);
 
+        $this->dataProcessor->expects(static::any())
+            ->method('buildOutputDataArray')
+            ->willReturn($addressData);
+
         $this->shippingAddress->expects(static::once())
-            ->method('addData')
-            ->with($addressData)
+            ->method('setCollectShippingRates')
+            ->with(true)
+            ->willReturnSelf();
+
+        $this->totalsCollector->expects(static::once())
+            ->method('collectAddressTotals')
+            ->with($this->quote, $this->shippingAddress)
             ->willReturnSelf();
+
+        $rate = $this->getMockBuilder(Rate::class)
+            ->disableOriginalConstructor()
+            ->setMethods([])
+            ->getMock();
+        $methodObject = $this->getMockForAbstractClass(ShippingMethodInterface::class);
+        $expectedRates = [$methodObject];
+
+        $this->shippingAddress->expects(static::once())
+            ->method('getGroupedAllShippingRates')
+            ->willReturn([[$rate]]);
+
+        $this->quote->expects(static::once())
+            ->method('getQuoteCurrencyCode')
+            ->willReturn($currencyCode);
+
+        $this->converter->expects(static::once())
+            ->method('modelToDataObject')
+            ->with($rate, $currencyCode)
+            ->willReturn($methodObject);
+
+        $carriersRates = $this->model->estimateByExtendedAddress($cartId, $address);
+        static::assertEquals($expectedRates, $carriersRates);
+    }
+
+    /**
+     * @covers \Magento\Quote\Model\ShippingMethodManagement::estimateByAddressId
+     */
+    public function testEstimateByAddressId()
+    {
+        $cartId = 1;
+
+        $addressData = [
+            'region' => 'California',
+            'region_id' => 23,
+            'country_id' => 1,
+            'postcode' => 90200
+        ];
+        $currencyCode = 'UAH';
+
+        /**
+         * @var \Magento\Customer\Api\Data\AddressInterface|MockObject $address
+         */
+        $address = $this->getMockBuilder(\Magento\Customer\Api\Data\AddressInterface::class)
+            ->disableOriginalConstructor()
+            ->getMock();
+
+        $this->addressRepository->expects($this->any())
+            ->method('getById')
+            ->will($this->returnValue($address));
+
+        $this->addressFactory->expects($this->any())
+            ->method('create')
+            ->will($this->returnValue($address));
+
+        $this->quoteRepository->expects(static::once())
+            ->method('getActive')
+            ->with($cartId)
+            ->willReturn($this->quote);
+
+        $this->quote->expects(static::once())
+            ->method('isVirtual')
+            ->willReturn(false);
+        $this->quote->expects(static::once())
+            ->method('getItemsCount')
+            ->willReturn(1);
+
+        $this->quote->expects(static::once())
+            ->method('getShippingAddress')
+            ->willReturn($this->shippingAddress);
+
+        $this->dataProcessor->expects(static::any())
+            ->method('buildOutputDataArray')
+            ->willReturn($addressData);
+
         $this->shippingAddress->expects(static::once())
             ->method('setCollectShippingRates')
             ->with(true)
@@ -516,7 +631,7 @@ public function testEstimateByExtendedAddress()
             ->with($rate, $currencyCode)
             ->willReturn($methodObject);
 
-        $carriersRates = $this->model->estimateByExtendedAddress($cartId, $address);
+        $carriersRates = $this->model->estimateByAddressId($cartId, $address);
         static::assertEquals($expectedRates, $carriersRates);
     }
 }
