Add Custom Country Data Endpoint (#311)

* Add Custom Country Data Endpoint

* Exclude regions if optional

* added comment

Api/GetCountryDataInterface.php

@@ -0,0 +1,14 @@
+<?php
+
+namespace Bold\Checkout\Api;
+
+use Magento\Directory\Api\Data\CountryInformationInterface;
+
+interface GetCountryDataInterface
+{
+    /**
+     * @param string $countryId
+     * @return \Magento\Directory\Api\Data\CountryInformationInterface
+     */
+    public function getData(string $countryId): CountryInformationInterface;
+}

Model/GetCountryData.php

@@ -0,0 +1,68 @@
+<?php
+
+namespace Bold\Checkout\Model;
+
+use Bold\Checkout\Api\GetCountryDataInterface;
+use Magento\Directory\Api\CountryInformationAcquirerInterface;
+use Magento\Directory\Api\Data\CountryInformationInterface;
+use Magento\Directory\Api\Data\CountryInformationInterfaceFactory;
+use Magento\Framework\App\Config\ScopeConfigInterface;
+use Magento\Store\Model\ScopeInterface;
+use Magento\Store\Model\StoreManagerInterface;
+
+class GetCountryData implements GetCountryDataInterface
+{
+    /**
+     * @var StoreManagerInterface
+     */
+    private $storeManager;
+
+    /**
+     * @var ScopeConfigInterface
+     */
+    private $scopeConfig;
+
+    /**
+     * @var CountryInformationAcquirerInterface
+     */
+    private $countryInformationAcquirer;
+
+    /**
+     * @var CountryInformationInterfaceFactory
+     */
+    private $countryInformationFactory;
+
+    public function __construct(
+        StoreManagerInterface $storeManager,
+        ScopeConfigInterface $scopeConfig,
+        CountryInformationAcquirerInterface $countryInformationAcquirer,
+        CountryInformationInterfaceFactory $countryInformationFactory
+    ) {
+        $this->storeManager = $storeManager;
+        $this->scopeConfig = $scopeConfig;
+        $this->countryInformationAcquirer = $countryInformationAcquirer;
+        $this->countryInformationFactory = $countryInformationFactory;
+    }
+
+    public function getData(string $countryId): CountryInformationInterface
+    {
+        $storeId = $this->storeManager->getStore()->getId();
+        $countriesRequiringStates = $this->scopeConfig->getValue('general/region/state_required', ScopeInterface::SCOPE_STORE, $storeId);
+        $statesOptional = !in_array($countryId, explode(',', $countriesRequiringStates));
+        $countryData = $this->countryInformationAcquirer->getCountryInfo($countryId);
+
+        // if states are optional build our own CountryInformation object omitting available_regions
+        if ($statesOptional) {
+            $customCountryData = $this->countryInformationFactory->create();
+            $customCountryData->setId($countryId);
+            $customCountryData->setTwoLetterAbbreviation($countryData->getTwoLetterAbbreviation());
+            $customCountryData->setThreeLetterAbbreviation($countryData->getThreeLetterAbbreviation());
+            $customCountryData->setFullNameLocale($countryData->getFullNameLocale());
+            $customCountryData->setFullNameEnglish($countryData->getFullNameEnglish());
+
+            return $customCountryData;
+        }
+
+        return $countryData;
+    }
+}

etc/di.xml

@@ -35,6 +35,7 @@
     <preference for="Bold\Checkout\Model\Order\CompleteOrderInterface" type="Bold\Checkout\Model\Order\CompleteOrderPool"/>
     <preference for="Bold\Checkout\Api\Data\BoldQuoteInterface" type="Bold\Checkout\Model\Quote\QuoteExtensionData"/>
     <preference for="Bold\Checkout\Api\BoldQuoteRepositoryInterface" type="Bold\Checkout\Model\BoldQuoteRepository"/>
+    <preference for="Bold\Checkout\Api\GetCountryDataInterface" type="Bold\Checkout\Model\GetCountryData"/>
 
     <type name="Bold\Checkout\Model\Order\CompleteOrderPool">
         <arguments>

etc/webapi.xml

@@ -93,4 +93,10 @@
             <resource ref="Bold_Checkout::integration" />
         </resources>
     </route>
+    <route method="GET" url="/V1/countries/:countryId">
+        <service class="Bold\Checkout\Api\GetCountryDataInterface" method="getData"/>
+        <resources>
+            <resource ref="anonymous"/>
+        </resources>
+    </route>
 </routes>