MAGETWO-55117: ShippingMethodManagement::estimateByAddressId set not full address details

- merging the usage of all addresses types into one channel and deprecating incomplete protected method but still making it safe to use for other possible classes that might extend it

Author: cpartica

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,12 +202,9 @@ public function estimateByAddress($cartId, \Magento\Quote\Api\Data\EstimateAddre
             return [];
         }
 
-        return $this->getEstimatedRates(
+        return $this->getShippingMethods(
             $quote,
-            $address->getCountryId(),
-            $address->getPostcode(),
-            $address->getRegionId(),
-            $address->getRegion()
+            $address
         );
     }
 
@@ -210,7 +220,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 +237,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 +248,41 @@ 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|null $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);
+        if ($address) {
+            $shippingAddress->addData($this->extractAddressData($address));
+        }
         $shippingAddress->setCollectShippingRates(true);
 
         $this->totalsCollector->collectAddressTotals($quote, $shippingAddress);
@@ -279,4 +294,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;
+    }
 }