Merge pull request #93 from JerrySmidt/master

3.3.0

Author: JozefVerhoef

Block/System/Config/Status.php

@@ -181,7 +181,7 @@ private function _getAccountInfo(): array
     {
         $status = $this->_storeConfigHelper->getValue(StoreConfigHelper::PATH['account_status']);
         if ($status === \Flekto\Postcode\Helper\ApiClientHelper::API_ACCOUNT_STATUS_ACTIVE) {
-            return $this->_apiClientHelper->getApiClient()->accountInfo();
+            return $this->_apiClientHelper->getAccountInfo();
         }
 
         return [];

Helper/ApiClientHelper.php

@@ -123,7 +123,9 @@ public function getAddressDetails(string $context): array
             $client = $this->getApiClient();
             $sessionId = $this->_getSessionId();
             $response = $client->internationalGetDetails($context, $sessionId);
-            return $this->_prepareResponse($response, $client);
+            $response = $this->_prepareResponse($response, $client);
+
+            return $response;
 
         } catch (\Exception $e) {
             return $this->_handleClientException($e);
@@ -315,6 +317,16 @@ public function getCountryIso3Code(string $iso2Code): ?string
         return $this->_countryCodeMap[$mapKey][strtoupper($iso2Code)] ?? null;
     }
 
+    public function getAccountInfo(): array
+    {
+        try {
+            return $this->getApiClient()->accountInfo();
+        }
+        catch (\Exception $e) {
+            return [];
+        }
+    }
+
     /**
      * _getModuleInfo function.
      *

Helper/StoreConfigHelper.php

@@ -28,6 +28,7 @@ class StoreConfigHelper extends AbstractHelper
         // Advanced
         'api_debug' => 'postcodenl_api/advanced_config/api_debug',
         'disabled_countries' => 'postcodenl_api/advanced_config/disabled_countries',
+        'allow_pobox_shipping' => 'postcodenl_api/advanced_config/allow_pobox_shipping',
 
         // Status
         'module_version' => 'postcodenl_api/status/module_version',
@@ -177,8 +178,8 @@ public function getJsinit(): array
             'show_hide_address_fields' => $this->getValue(static::PATH['show_hide_address_fields']) ?? \Flekto\Postcode\Model\Config\Source\ShowHideAddressFields::SHOW,
             'base_url' => $this->getCurrentStoreBaseUrl(),
             'debug' => $this->isDebugging(),
-            'fixedCountry' => $this->_getFixedCountry(),
             'change_fields_position' => $this->isSetFlag(static::PATH['change_fields_position']),
+            'allow_pobox_shipping' => $this->isSetFlag(static::PATH['allow_pobox_shipping']),
         ];
     }
 
@@ -204,21 +205,4 @@ public function isDebugging(): bool
     {
         return $this->isSetFlag(static::PATH['api_debug'], ScopeInterface::SCOPE_STORE) && $this->_developerHelper->isDevAllowed();
     }
-
-    /**
-     * Get fixed country (ISO2) if there's only one allowed country.
-     *
-     * @access private
-     * @return string|null
-     */
-    private function _getFixedCountry(): ?string
-    {
-        $allowedCountries = $this->getValue('general/country/allow');
-
-        if (isset($allowedCountries) && strlen($allowedCountries) === 2) {
-            return $allowedCountries;
-        }
-
-        return null;
-    }
 }

README.md

@@ -1,17 +1,17 @@
 ![Postcode.eu](media/postcode-eu-logo-gradient.svg)
 
-# International Address API module for Magento 2
+## International Address API module for Magento 2
 
 Adds autocompletion for addresses to the checkout page. [Multiple countries](https://www.postcode.nl/services/adresdata/internationaal) are supported using official postal data via the [Postcode.eu](https://postcode.eu) API.
 
 This module is maintained by [Postcode.nl](https://postcode.nl) since version 3.0.0. Earlier versions were developed by [Flekto](https://www.flekto.nl).
 
-# Postcode.eu account
+## Postcode.eu account
 
 A [Postcode.eu account](https://www.postcode.nl/en/services/adresdata/producten-overzicht) is required.
 Testing is free. After testing you can choose to purchase a subscription.
 
-# Installation instructions
+## Installation instructions
 
 1. Install this component using Composer:
 
@@ -26,9 +26,9 @@ $ php bin/magento setup:di:compile
 $ php bin/magento cache:flush
 ```
 
-# Screenshots
+## Screenshots
 
-## International Address API
+### International Address API
 
 A single field for autocompletion:
 
@@ -39,7 +39,7 @@ To allow users to skip the autocomplete field and manually enter an address, the
 
 ![](media/example-intl-api-manual-entry-option.png)
 
-## Dutch Postcode API
+### Dutch Postcode API
 
 Get a Dutch address by postcode and house number. In this example asking the user to select from valid house number additions:
 
@@ -55,41 +55,26 @@ Other output options are:
 * Disable address fields until postcode and house number combination is valid.
 * No change; address fields remain visible and editable.
 
-# Compatibility
+## Compatibility
 
 Although we can't guarantee compatibility with other checkout modules, our module works well with most one-step-checkout modules. If you are having issues and think this may be caused by our module, please [contact Postcode.nl]([email protected]) and tell us which other module(s) and version(s) are used.
 
 If you found the solution already and have some code to contribute, feel free to open a pull request in this repository.
 
-## OneStepCheckout.com configuration instructions
-
-1. Go to Stores -> Configuration -> Sales -> Postcode.eu Address API
-   1. 'Change address fields position' to 'no'
-2. Go to Stores -> Configuration -> Sales -> OneStepCheckout
-   1. The following fields need to be enabled for the billing **and** shipping fields:
-      1. street.0
-      2. postcode
-      3. city
-      4. region
-   2. Add the following fields to the billing **and** shipping fields:
-      1. address_autofill_nl.postcode
-      2. address_autofill_nl.house_number
-      3. address_autofill_nl.house_number_select
-      4. address_autofill_intl
-      5. address_autofill_formatted_output
-   3. Optional: you may need to apply some custom CSS to display the fields correctly. You may set the region field to hidden.
+## Address API documentation
 
+You can find our API documentation at https://developer.postcode.eu/documentation.
 
-# Address API documentation
+## Module Wiki
 
-You can find our API documentation at https://developer.postcode.eu/documentation.
+Instructions for additional configuration and customization can be found on the [wiki pages](https://github.com/postcode-nl/PostcodeNl_Api_Magento2/wiki).
 
-# FAQ and Knowledge Base
+## FAQ and Knowledge Base
 
 * View Frequently Asked Questions at https://www.postcode.eu/#faq.
 * For more questions and answers, see https://kb.postcode.nl/help
 * If the above didn't answer your question, [contact us](https://www.postcode.eu/contact).
 
-# License
+## License
 
 The code is available under the Simplified BSD License, see the included LICENSE file.

composer.json

@@ -1,6 +1,6 @@
 {
     "name": "postcode-nl/api-magento2-module",
-    "version": "3.2.0",
+    "version": "3.3.0",
     "description": "Postcode.eu International Address API module for Magento 2. Adds autocompletion for addresses in multiple countries using official postal data.",
     "require": {
       "php": "^7.4 || ^8.0 || ^8.1 || ^8.2 || ^8.3",

etc/adminhtml/system.xml

@@ -62,7 +62,12 @@
                     <comment>Selected countries will have Address API disabled.</comment>
                     <source_model>Flekto\Postcode\Model\Config\Source\DisabledCountries</source_model>
                 </field>
-                <field id="api_debug" showInDefault="1" showInStore="1" showInWebsite="1" sortOrder="100" translate="label" type="select" canRestore="1">
+                <field id="allow_pobox_shipping" showInDefault="1" showInStore="1" showInWebsite="1" sortOrder="100" translate="label" type="select" canRestore="1">
+                    <label>PO box shipping</label>
+                    <comment>Allow shipping to PO boxes.</comment>
+                    <source_model>Magento\Config\Model\Config\Source\Yesno</source_model>
+                </field>
+                <field id="api_debug" showInDefault="1" showInStore="1" showInWebsite="1" sortOrder="110" translate="label" type="select" canRestore="1">
                     <label>Debug</label>
                     <comment/>
                     <source_model>Magento\Config\Model\Config\Source\Yesno</source_model>

etc/config.xml

@@ -3,13 +3,16 @@
     <default>
         <postcodenl_api>
             <status>
-                <module_version>3.2.0</module_version>
+                <module_version>3.3.0</module_version>
                 <account_status>new</account_status>
             </status>
             <general>
                 <enabled>1</enabled>
                 <change_fields_position>1</change_fields_position>
             </general>
+            <advanced_config>
+                <allow_pobox_shipping>1</allow_pobox_shipping>
+            </advanced_config>
         </postcodenl_api>
     </default>
 </config>

i18n/en_US.csv

@@ -46,4 +46,6 @@
 "An error has occurred while retrieving address data. Please contact us if the problem persists.","An error has occurred while retrieving address data. Please contact us if the problem persists."
 "Please select a house number.","Please select a house number."
 "Enter an address","Enter an address"
-"Please select an address from metropolitan France.","Please select an address from metropolitan France."
+"PO box shipping","PO box shipping"
+"Allow shipping to PO boxes.","Allow shipping to PO boxes."
+"Sorry, we cannot ship to a PO Box address.","Sorry, we cannot ship to a PO Box address."

i18n/nl_BE.csv

@@ -46,4 +46,6 @@
 "An error has occurred while retrieving address data. Please contact us if the problem persists.","Er is een fout opgetreden bij het ophalen van adres gegevens. Neem contact met ons op als het probleem blijft optreden."
 "Please select a house number.","Selecteer alstublieft een huisnummer."
 "Enter an address","Vul een adres in"
-"Please select an address from metropolitan France.","Selecteer een adres uit Europees Frankrijk."
+"PO box shipping","Postbus verzending"
+"Allow shipping to PO boxes.","Verzenden naar postbussen toestaan."
+"Sorry, we cannot ship to a PO Box address.","Sorry, we versturen niet naar een postbus adres."

i18n/nl_NL.csv

@@ -46,4 +46,6 @@
 "An error has occurred while retrieving address data. Please contact us if the problem persists.","Er is een fout opgetreden bij het ophalen van adres gegevens. Neem contact met ons op als het probleem blijft optreden."
 "Please select a house number.","Selecteer alstublieft een huisnummer."
 "Enter an address","Vul een adres in"
-"Please select an address from metropolitan France.","Selecteer een adres uit Europees Frankrijk."
+"PO box shipping","Postbus verzending"
+"Allow shipping to PO boxes.","Verzenden naar postbussen toestaan."
+"Sorry, we cannot ship to a PO Box address.","Sorry, we versturen niet naar een postbus adres."