Add shape validator; fix date for fingerprints

Author: daniel-zahariev

src/MerchantApi/MerchantApi.php

@@ -17,6 +17,7 @@
  * @property Balance balance
  * @property Profile profile
  * @property StatusCodes status_codes
+ * @property PermissionRequests permission_requests
  */
 class MerchantApi extends SettleApi
 {
@@ -35,6 +36,7 @@ protected function getMagicProperties()
             'settlements' => Settlements::class,
             'short_links' => ShortLinks::class,
             'status_codes' => StatusCodes::class,
+            'permission_requests' => PermissionRequests::class,
         ];
     }
 }

src/SettleApi.php

@@ -24,12 +24,13 @@ final public function __construct(SettleApiClient $api_client)
      * @param string $method
      * @param string $path
      * @param array $data
+     * @param array $shape
      * @return array
      * @throws SettleApiException
      */
-    final protected function call(string $method, string $path, array $data = [])
+    final protected function call(string $method, string $path, array $data = [], $shape = [])
     {
-        return $this->api_client->call($method, $path, $data);
+        return $this->api_client->call($method, $path, $data, $shape);
     }
 
     /**

src/SettleApiClient.php

@@ -2,6 +2,9 @@
 
 namespace SettleApi;
 
+use DateTime;
+use DateTimeZone;
+
 /**
  * Class SettleApiClient
  * @package SettleApi
@@ -14,6 +17,7 @@ class SettleApiClient
     protected string $publicKey;
     protected string $privateKey;
     protected bool $isSandbox;
+    protected bool $validateShapes = true;
 
     const BASE_URL_PRODUCTION = 'https://api.settle.eu/merchant/v1/';
     const BASE_URL_SANDBOX = 'https://api.sandbox.settle.eu/merchant/v1/';
@@ -69,15 +73,37 @@ public function setIsSandbox($isSandbox)
         $this->isSandbox = $isSandbox;
     }
 
+    /**
+     * @return bool
+     */
+    public function getValidateShapes()
+    {
+        return $this->validateShapes;
+    }
+
+    /**
+     * @param $validateShapes
+     */
+    public function setValidateShapes($validateShapes)
+    {
+        $this->validateShapes = $validateShapes;
+    }
+
     /**
      * @param string $method
      * @param string $path
      * @param array $postFields
+     * @param array $shape
      * @return array|bool
      * @throws SettleApiException
      */
-    public function call(string $method, string $path, array $postFields = [])
+    public function call(string $method, string $path, array $postFields = [], $shape = [])
     {
+        if ($this->validateShapes && !empty($shape)) {
+            $validator = new ShapeValidator($shape, $postFields);
+            $validator->validate();
+        }
+
         $method = strtoupper($method);
         $path = ltrim($path, '/');
         $url = $this->getApiBaseUrl() . $path;
@@ -111,12 +137,17 @@ public function call(string $method, string $path, array $postFields = [])
             case $httpCode >= 200 && $httpCode < 300:
                 return $response;
 
+            case $httpCode == 404:
+                throw new SettleApiException("The resource could not be found.", $httpCode);
+
             default:
                 if ($response !== null) {
                     $message = $response['error_description'] ?? $response['error_detail'] ?? $response['error_type'] ?? 'Something went wrong.';
                     throw new SettleApiException($message, $httpCode);
                 }
-                throw new SettleApiException('Something went wrong.', $httpCode);
+
+                $errorMessage = !empty($response_body) ? $response_body : 'Something went wrong.';
+                throw new SettleApiException($errorMessage, $httpCode);
         }
     }
 
@@ -146,10 +177,11 @@ protected function getHeaders(string $method, string $url, array $postFields): a
             'Content-Length: ' . strlen($content),
         ];
 
+        $date = (new DateTime())->setTimezone(new DateTimeZone('UTC'));
         $settle_headers = [
             'x-settle-merchant' => $this->merchantId,
             'x-settle-user' => $this->userId,
-            'x-settle-timestamp' => date('Y-m-d H:i:s'),
+            'x-settle-timestamp' => $date->format('Y-m-d H:i:s'),
             'x-settle-content-digest' => 'SHA256=' . $content_digest,
         ];
 

src/SettleApiException.php

@@ -3,11 +3,31 @@
 namespace SettleApi;
 
 use Exception;
+use Throwable;
 
 /**
  * Class SettleApiException
  * @package SettleApi
  */
 class SettleApiException extends Exception
 {
+    /**
+     * @var array A list of error messages for every field (array key)
+     */
+    protected $validationErrors;
+
+    public function __construct($message = "", $code = 0, Throwable $previous = null, $validationErrors = [])
+    {
+        parent::__construct($message, $code, $previous);
+
+        $this->validationErrors = $validationErrors;
+    }
+
+    /**
+     * @return array A list of error messages for every field (array key)
+     */
+    public function getValidationErrors()
+    {
+        return $this->validationErrors;
+    }
 }

src/ShapeValidator.php

@@ -0,0 +1,88 @@
+<?php
+
+
+namespace SettleApi;
+
+
+class ShapeValidator
+{
+    protected $shape;
+    protected $data;
+
+    /**
+     * @param array $shape
+     * @param array $data
+     */
+    public function __construct($shape = [], $data = [])
+    {
+        $this->shape = $shape;
+        $this->data = $data;
+    }
+
+    public function validate()
+    {
+        $errors = [];
+
+        $extra_keys = array_diff(array_keys($this->data), array_keys($this->shape));
+        foreach($extra_keys as $extra_key) {
+            $errors[$extra_key] = "Field '{$extra_key}' is not supported.";
+        }
+
+        foreach($this->shape as $key => $rules) {
+            if (!is_array($rules)) $rules = explode('|', $rules);
+
+            $error = $this->validateField($key, $rules);
+
+            if ($error != '') {
+                $errors[$key] = $error;
+            }
+        }
+
+        if (!empty($errors)) {
+            throw new SettleApiException("Shape validation error", 400, null, $errors);
+        }
+    }
+
+    /**
+     * @param string $key
+     * @param array $rules
+     * @return string
+     */
+    protected function validateField($key, $rules)
+    {
+        $error = '';
+        $value = $this->data[$key] ?? null;
+
+        foreach ($rules as $rule) {
+            $error = $this->validateValue($key, $value, $rule);
+            if ($error != '') break;
+        }
+
+        return $error;
+    }
+
+    protected function validateValue($key, $value, $rule)
+    {
+        $error = '';
+
+        switch($rule) {
+            case 'required':
+                if (is_null($value)) {
+                    $error = "Field '{$key}' is required.";
+                }
+                break;
+            case 'string':
+                if (!is_null($value) && !is_string($value)) {
+                    $error = "Field '{$key}' is must be a string.";
+                }
+                break;
+            case 'numeric':
+                if (!is_null($value) && !is_numeric($value)) {
+                    $error = "Field '{$key}' is must have numeric value.";
+                }
+                break;
+        }
+
+        return $error;
+    }
+}