Adding logic to convert state names to full name (#501)

* Adding logic to convert state names to full name

* Pivoting to using Magento's inbuilt region resolver

* As suggested in PR feedback, moving state to fullname function to Shipping helper

* correcting the accessor function for full name

* Redundant else case

* addressing PHPDoc convention

Author: sol-loup

app/code/Meta/Sales/Helper/ShippingHelper.php

@@ -37,10 +37,10 @@ class ShippingHelper extends AbstractHelper
      * @param array $supportedShippingCarriers
      */
     public function __construct(
-        Context $context,
-        RegionFactory $regionFactory,
+        Context         $context,
+        RegionFactory   $regionFactory,
         LoggerInterface $logger,
-        array $supportedShippingCarriers = []
+        array           $supportedShippingCarriers = []
     ) {
         parent::__construct($context);
         $this->regionFactory = $regionFactory;
@@ -78,6 +78,26 @@ public function getRegionName($stateId)
         return $stateId;
     }
 
+    /**
+     * Gets the region name from state code
+     *
+     * @param null|string $stateCode - State code
+     * @param null|string $countryCode - Country code
+     * @return null|string
+     */
+    public function getRegionNameFromCode(?string $stateCode, ?string $countryCode): ?string
+    {
+        $regionName = $stateCode ?? null;
+        try {
+            $region = $this->regionFactory->create();
+            $region = $region->loadByCode($stateCode, $countryCode);
+            $regionName = $region->getDefaultName() ?? $regionName;
+        } catch (Exception $e) {
+            $this->logger->critical($e->getMessage());
+        }
+        return $regionName;
+    }
+
     /**
      * A map for popular US carriers with long titles
      *
@@ -86,8 +106,8 @@ public function getRegionName($stateId)
     private function getSupplementaryCarriersMap()
     {
         return [
-            'UPS'   => 'United Parcel Service',
-            'USPS'  => 'United States Postal Service',
+            'UPS' => 'United Parcel Service',
+            'USPS' => 'United States Postal Service',
             'FEDEX' => 'Federal Express',
         ];
     }

app/code/Meta/Sales/Model/Mapper/OrderMapper.php

@@ -32,6 +32,7 @@
 use Meta\BusinessExtension\Helper\GraphAPIAdapter;
 use Meta\BusinessExtension\Model\System\Config as SystemConfig;
 use Meta\Sales\Plugin\ShippingMethodTypes;
+use Meta\Sales\Helper\ShippingHelper;
 
 /**
  * Map facebook order data to magento order
@@ -74,6 +75,11 @@ class OrderMapper
      */
     private OrderItemMapper $orderItemMapper;
 
+    /**
+     * @var ShippingHelper
+     */
+    private ShippingHelper $shippingHelper;
+
     /**
      * @param StoreManagerInterface $storeManager
      * @param GraphAPIAdapter $graphAPIAdapter
@@ -82,6 +88,7 @@ class OrderMapper
      * @param OrderPaymentInterfaceFactory $paymentFactory
      * @param OrderAddressInterfaceFactory $orderAddressFactory
      * @param OrderItemMapper $orderItemMapper
+     * @param ShippingHelper $shippingHelper
      */
     public function __construct(
         StoreManagerInterface        $storeManager,
@@ -90,7 +97,8 @@ public function __construct(
         OrderInterfaceFactory        $orderFactory,
         OrderPaymentInterfaceFactory $paymentFactory,
         OrderAddressInterfaceFactory $orderAddressFactory,
-        OrderItemMapper              $orderItemMapper
+        OrderItemMapper              $orderItemMapper,
+        ShippingHelper               $shippingHelper
     ) {
         $this->storeManager = $storeManager;
         $this->graphAPIAdapter = $graphAPIAdapter;
@@ -99,6 +107,7 @@ public function __construct(
         $this->paymentFactory = $paymentFactory;
         $this->orderAddressFactory = $orderAddressFactory;
         $this->orderItemMapper = $orderItemMapper;
+        $this->shippingHelper = $shippingHelper;
     }
 
     /**
@@ -183,8 +192,8 @@ public function map(array $data, int $storeId): Order
     private function getShippingMethod(string $shippingOptionName, string $shippingReferenceId, int $storeId): ?string
     {
         $static_shipping_options = [ShippingMethodTypes::FREE_SHIPPING,
-                                    ShippingMethodTypes::FLAT_RATE,
-                                    ShippingMethodTypes::TABLE_RATE];
+            ShippingMethodTypes::FLAT_RATE,
+            ShippingMethodTypes::TABLE_RATE];
         if (in_array($shippingReferenceId, $static_shipping_options)) {
             return $shippingReferenceId;
         }
@@ -229,8 +238,13 @@ private function getOrderBillingAddress(array $data): Order\Address
             ? [$data['shipping_address']['street1'], $data['shipping_address']['street2']]
             : $data['shipping_address']['street1'];
 
+        $regionName = $this->shippingHelper->getRegionNameFromCode(
+            $data['shipping_address']['state'],
+            $data['shipping_address']['country']
+        );
+
         $addressData = [
-            'region' => $data['shipping_address']['state'] ?? null,
+            'region' => $regionName,
             'postcode' => $data['shipping_address']['postal_code'],
             'firstname' => $data['shipping_address']['first_name'],
             'lastname' => $data['shipping_address']['last_name'],