Merge pull request #111 from JerrySmidt/master

3.6.0

Author: JerrySmidt

Api/Data/Autocomplete.php

@@ -10,17 +10,41 @@ class Autocomplete implements AutocompleteInterface
     public $matches = [];
 
     /**
-     * __construct function.
-     *
-     * @access public
+     * @var string|null
+     */
+    public $error;
+
+    /**
+     * @var string|null
+     */
+    public $message;
+
+    /**
+     * @var string|null
+     */
+    public $exception;
+
+    /**
+     * @var MagentoDebugInfoInterface|null
+     */
+    public $magentoDebugInfo = null;
+
+    /**
      * @param array $response
-     * @return void
      */
     public function __construct(array $response)
     {
         foreach ($response['matches'] ?? [] as $match) {
             $this->matches[] = new Autocomplete\AutocompleteMatch($match);
         }
+
+        $this->error = $response['error'] ?? null;
+        $this->message = $response['message'] ?? null;
+        $this->exception = $response['exception'] ?? null;
+
+        if (isset($response['magento_debug_info'])) {
+            $this->magentoDebugInfo = new MagentoDebugInfo($response['magento_debug_info']);
+        }
     }
 
     /**
@@ -30,4 +54,36 @@ public function getMatches(): array
     {
         return $this->matches;
     }
+
+    /**
+     * @inheritdoc
+     */
+    public function getError(): ?string
+    {
+        return $this->error;
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function getMessage(): ?string
+    {
+        return $this->message;
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function getException(): ?string
+    {
+        return $this->exception;
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function getMagentoDebugInfo(): ?MagentoDebugInfoInterface
+    {
+        return $this->magentoDebugInfo;
+    }
 }

Api/Data/AutocompleteInterface.php

@@ -8,4 +8,24 @@ interface AutocompleteInterface
      * @return Flekto\Postcode\Api\Data\Autocomplete\MatchInterface[]
      */
     public function getMatches(): array;
+
+    /**
+     * @return string|null
+     */
+    public function getError(): ?string;
+
+    /**
+     * @return string|null
+     */
+    public function getMessage(): ?string;
+
+    /**
+     * @return string|null
+     */
+    public function getException(): ?string;
+
+    /**
+     * @return Flekto\Postcode\Api\Data\MagentoDebugInfoInterface|null
+     */
+    public function getMagentoDebugInfo(): ?MagentoDebugInfoInterface;
 }

Api/Data/MagentoDebugInfo.php

@@ -0,0 +1,74 @@
+<?php
+
+namespace Flekto\Postcode\Api\Data;
+
+class MagentoDebugInfo implements MagentoDebugInfoInterface
+{
+    protected $moduleVersion;
+    protected $magentoVersion;
+    protected $client;
+    protected $session;
+    protected $configuration;
+    protected $modules;
+
+    /**
+     * @param array $data
+     */
+    public function __construct(array $data)
+    {
+        $this->moduleVersion = $data['moduleVersion'] ?? '';
+        $this->magentoVersion = $data['magentoVersion'] ?? '';
+        $this->client = $data['client'] ?? '';
+        $this->session = $data['session'] ?? '';
+        $this->configuration = new MagentoDebugInfo\Configuration($data['configuration'] ?? []);
+        $this->modules = $data['modules'] ?? [];
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function getModuleVersion(): string
+    {
+        return $this->moduleVersion;
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function getMagentoVersion(): string
+    {
+        return $this->magentoVersion;
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function getClient(): string
+    {
+        return $this->client;
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function getSession(): string
+    {
+        return $this->session;
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function getConfiguration(): MagentoDebugInfo\ConfigurationInterface
+    {
+        return $this->configuration;
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function getModules(): array
+    {
+        return $this->modules;
+    }
+}

Api/Data/MagentoDebugInfo/Configuration.php

@@ -0,0 +1,34 @@
+<?php
+
+namespace Flekto\Postcode\Api\Data\MagentoDebugInfo;
+
+class Configuration implements ConfigurationInterface
+{
+    protected $key;
+    protected $secret;
+
+    /**
+     * @param array $data
+     */
+    public function __construct(array $data)
+    {
+        $this->key = $data['key'] ?? '';
+        $this->secret = $data['secret'] ?? '';
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function getKey(): string
+    {
+        return $this->key;
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function getSecret(): string
+    {
+        return $this->secret;
+    }
+}

Api/Data/MagentoDebugInfo/ConfigurationInterface.php

@@ -0,0 +1,16 @@
+<?php
+
+namespace Flekto\Postcode\Api\Data\MagentoDebugInfo;
+
+interface ConfigurationInterface
+{
+    /**
+     * @return string
+     */
+    public function getKey(): string;
+
+    /**
+     * @return string
+     */
+    public function getSecret(): string;
+}

Api/Data/MagentoDebugInfo/MagentoModule.php

@@ -0,0 +1,34 @@
+<?php
+
+namespace Flekto\Postcode\Api\Data\MagentoDebugInfo;
+
+class MagentoModule implements MagentoModuleInterface
+{
+    private string $name;
+    private string $setupVersion;
+
+    /**
+     * @param array $data
+     */
+    public function __construct(array $data)
+    {
+        $this->name = $data['name'] ?? '';
+        $this->setupVersion = $data['setup_version'] ?? '';
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function getName(): string
+    {
+        return $this->name;
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function getSetupVersion(): string
+    {
+        return $this->setupVersion;
+    }
+}

Api/Data/MagentoDebugInfo/MagentoModuleInterface.php

@@ -0,0 +1,20 @@
+<?php
+
+namespace Flekto\Postcode\Api\Data\MagentoDebugInfo;
+
+interface MagentoModuleInterface
+{
+    /**
+     * Get module name
+     *
+     * @return string
+     */
+    public function getName(): string;
+
+    /**
+     * Get module setup version
+     *
+     * @return string
+     */
+    public function getSetupVersion(): string;
+}

Api/Data/MagentoDebugInfoInterface.php

@@ -0,0 +1,36 @@
+<?php
+
+namespace Flekto\Postcode\Api\Data;
+
+interface MagentoDebugInfoInterface
+{
+    /**
+     * @return string
+     */
+    public function getModuleVersion(): string;
+
+    /**
+     * @return string
+     */
+    public function getMagentoVersion(): string;
+
+    /**
+     * @return string
+     */
+    public function getClient(): string;
+
+    /**
+     * @return string
+     */
+    public function getSession(): string;
+
+    /**
+     * @return Flekto\Postcode\Api\Data\MagentoDebugInfo\ConfigurationInterface
+     */
+    public function getConfiguration(): MagentoDebugInfo\ConfigurationInterface;
+
+    /**
+     * @return Flekto\Postcode\Api\Data\MagentoDebugInfo\MagentoModuleInterface[]
+     */
+    public function getModules(): array;
+}

Api/PostcodeModelInterface.php

@@ -35,4 +35,25 @@ public function getAddressDetailsCountry(String $context, String $dispatchCountr
      * @return string[][]
      */
     public function getNlAddress(String $zipCode, String $houseNumber): array;
+
+    /**
+     * @access public
+     * @param string $country
+     * @param string|null $postcode
+     * @param string|null $locality
+     * @param string|null $street
+     * @param string|null $building
+     * @param string|null $region
+     * @param string|null $streetAndBuilding
+     * @return string[][]
+     */
+    public function validateAddress(
+        string $country,
+        ?string $postcode = null,
+        ?string $locality = null,
+        ?string $street = null,
+        ?string $building = null,
+        ?string $region = null,
+        ?string $streetAndBuilding = null
+    ): array;
 }

GraphQl/Exception/GraphQlHeaderException.php

@@ -14,7 +14,7 @@ class GraphQlHeaderException extends LocalizedException implements ClientAware
     /**
      * Describing a category of the error
      */
-    const EXCEPTION_CATEGORY = 'graphql-header';
+    public const EXCEPTION_CATEGORY = 'graphql-header';
 
     /**
      * @var boolean