add data validation

Author: dipudey

src/Apis/BaseApi.php

@@ -7,6 +7,7 @@
 use GuzzleHttp\Exception\GuzzleException;
 use GuzzleHttp\Exception\ClientException;
 use Codeboxr\PathaoCourier\Exceptions\PathaoException;
+use Codeboxr\PathaoCourier\Exceptions\PathaoCourierValidationException;
 
 class BaseApi
 {
@@ -159,4 +160,35 @@ public function send($method, $uri, $body = [])
         }
     }
 
+    /**
+     * Data Validation
+     *
+     * @param array $data
+     * @param array $requiredFields
+     *
+     * @throws PathaoCourierValidationException
+     */
+    public function validation($data, $requiredFields)
+    {
+        if (!is_array($data) || !is_array($requiredFields)) {
+            throw new \TypeError("Argument must be of the type array", 500);
+        }
+
+        if (!count($data) || !count($requiredFields)) {
+            throw new PathaoCourierValidationException("Invalid data!", 422);
+        }
+
+        $requiredColumns = array_diff($requiredFields, array_keys($data));
+        if (count($requiredColumns)) {
+            throw new PathaoCourierValidationException($requiredColumns, 422);
+        }
+
+        foreach ($requiredFields as $filed) {
+            if (isset($data[$filed]) && empty($data[$filed])) {
+                throw new PathaoCourierValidationException("$filed is required", 422);
+            }
+        }
+
+    }
+
 }

src/Apis/OrderApi.php

@@ -4,6 +4,7 @@
 
 use GuzzleHttp\Exception\GuzzleException;
 use Codeboxr\PathaoCourier\Exceptions\PathaoException;
+use Codeboxr\PathaoCourier\Exceptions\PathaoCourierValidationException;
 
 class OrderApi extends BaseApi
 {
@@ -14,10 +15,23 @@ class OrderApi extends BaseApi
      *
      * @return mixed
      * @throws PathaoException
-     * @throws GuzzleException
+     * @throws GuzzleException|PathaoCourierValidationException
      */
     public function create($array)
     {
+        $this->validation($array, [
+            "store_id",
+            "recipient_name",
+            "recipient_phone",
+            "recipient_address",
+            "recipient_city",
+            "recipient_zone",
+            "delivery_type",
+            "item_type",
+            "item_quantity",
+            "amount_to_collect",
+        ]);
+
         $response = $this->authorization()->send("POST", "aladdin/api/v1/orders", $array);
         return $response->data;
     }
@@ -44,10 +58,19 @@ public function orderDetails($consignmentId)
      *
      * @return mixed
      * @throws GuzzleException
-     * @throws PathaoException
+     * @throws PathaoException|PathaoCourierValidationException
      */
     public function priceCalculation($array)
     {
+        $this->validation($array, [
+            "store_id",
+            "item_type",
+            "delivery_type",
+            "item_weight",
+            "recipient_city",
+            "recipient_zone"
+        ]);
+
         $response = $this->authorization()->send("POST", "aladdin/api/v1/merchant/price-plan", $array);
         return $response->data;
     }

src/Apis/StoreApi.php

@@ -4,6 +4,7 @@
 
 use GuzzleHttp\Exception\GuzzleException;
 use Codeboxr\PathaoCourier\Exceptions\PathaoException;
+use Codeboxr\PathaoCourier\Exceptions\PathaoCourierValidationException;
 
 class StoreApi extends BaseApi
 {
@@ -29,10 +30,14 @@ public function list($page = 1)
      *
      * @return mixed
      * @throws GuzzleException
-     * @throws PathaoException
+     * @throws PathaoException|PathaoCourierValidationException
      */
     public function create($storeInfo)
     {
+        $this->validation($storeInfo, [
+            "name", "contact_name", "contact_number", "address", "city_id", "zone_id", "area_id"
+        ]);
+
         $response = $this->authorization()->send("POST", "aladdin/api/v1/stores", $storeInfo);
         return $response->data;
     }

src/Exceptions/PathaoCourierValidationException.php

@@ -0,0 +1,19 @@
+<?php
+
+namespace Codeboxr\PathaoCourier\Exceptions;
+
+use Exception;
+use Throwable;
+
+class PathaoCourierValidationException extends Exception
+{
+    public function __construct($message = "", $code = 0, Throwable $previous = null)
+    {
+        if (is_array($message)) {
+            $requiredColumnsImplode = implode(",", $message);
+            parent::__construct("$requiredColumnsImplode filed is required", $code, $previous);
+        } else {
+            parent::__construct($message, $code, $previous);
+        }
+    }
+}