feat: validator for non null and non empty parameter + new utilities (#56)

Author: asadali214

composer.json

@@ -16,7 +16,7 @@
     "ext-curl": "*",
     "ext-dom": "*",
     "ext-libxml": "*",
-    "apimatic/core-interfaces": "~0.1.0",
+    "apimatic/core-interfaces": "~0.1.4",
     "apimatic/jsonmapper": "^3.1.1",
     "php-jsonpointer/php-jsonpointer": "^3.0.2"
   },

composer.lock

@@ -30,9 +30,6 @@ private function __construct(string $key, $value)
 
     /**
      * Sets encoding header with the key and value provided.
-     *
-     * @param string $key
-     * @param string $value
      */
     public function encodingHeader(string $key, string $value): self
     {

src/Request/Parameters/FormParam.php

@@ -5,12 +5,13 @@
 namespace Core\Request\Parameters;
 
 use Closure;
-use CoreInterfaces\Core\Request\ParamInterface;
+use Core\Utils\CoreHelper;
+use CoreInterfaces\Core\Request\NonEmptyParamInterface;
 use CoreInterfaces\Core\Request\TypeValidatorInterface;
 use InvalidArgumentException;
 use Throwable;
 
-abstract class Parameter implements ParamInterface
+abstract class Parameter implements NonEmptyParamInterface
 {
     protected $key;
     protected $value;
@@ -63,7 +64,8 @@ private function extractFromArray(string $key, $defaultValue): self
     }
 
     /**
-     * Marks the value of the parameter as required and throws an exception on validate if the value is missing.
+     * Marks the value of the parameter as required and
+     * throws an exception on validate if the value is missing.
      */
     public function required(): self
     {
@@ -73,6 +75,18 @@ public function required(): self
         return $this;
     }
 
+    /**
+     * Marks the value of the parameter as required + non-empty and
+     * throws an exception on validate if the value is missing.
+     */
+    public function requiredNonEmpty(): self
+    {
+        if (CoreHelper::isNullOrEmpty($this->value)) {
+            $this->valueMissing = true;
+        }
+        return $this;
+    }
+
     /**
      * Serializes the parameter using the method provided.
      *

src/Request/Parameters/Parameter.php

@@ -84,6 +84,20 @@ public static function isAssociative(array $array): bool
         return false;
     }
 
+    /**
+     * Check if provided value is null or empty.
+     *
+     * @param $value mixed Value to be checked.
+     * @return bool True if given value is empty of null.
+     */
+    public static function isNullOrEmpty($value): bool
+    {
+        if (is_string($value) && $value == '0') {
+            return false;
+        }
+        return empty($value);
+    }
+
     /**
      * Check if all the given value or values are present in the provided list.
      *
@@ -150,4 +164,26 @@ public static function getOsInfo(string $osFamily = PHP_OS_FAMILY, string $funct
         }
         return $osFamily . '-' . call_user_func($functionName, 'r');
     }
+
+    /**
+     * Return base64 encoded string for given username and password, prepended with Basic substring.
+     */
+    public static function getBasicAuthEncodedString(string $username, string $password): string
+    {
+        if ($username == '' || $password == '') {
+            return '';
+        }
+        return 'Basic ' . base64_encode("$username:$password");
+    }
+
+    /**
+     * Return the accessToken prepended with Bearer substring.
+     */
+    public static function getBearerAuthString(string $accessToken): string
+    {
+        if ($accessToken == '') {
+            return '';
+        }
+        return 'Bearer ' . $accessToken;
+    }
 }

src/Utils/CoreHelper.php

@@ -43,6 +43,16 @@ public function testHeaderAuthWithMissingField()
         MockHelper::getClient()->validateAuth($auth);
     }
 
+    public function testHeaderAuthWithEmptyField()
+    {
+        $this->expectException(AuthValidationException::class);
+        $this->expectExceptionMessage("Following authentication credentials are required:" .
+            "\n-> Missing required header field: token");
+
+        $auth = Auth::or('headerWithEmpty');
+        MockHelper::getClient()->validateAuth($auth);
+    }
+
     public function testHeaderOrQueryAuth1()
     {
         $request = new Request('http://localhost:3000');
@@ -85,6 +95,19 @@ public function testHeaderWithMissingFieldOrQueryAuth()
         );
     }
 
+    public function testHeaderWithEmptyFieldOrQueryAuth()
+    {
+        $request = new Request('http://localhost:3000');
+        $auth = Auth::or('headerWithEmpty', 'query');
+        MockHelper::getClient()->validateAuth($auth)->apply($request);
+
+        $this->assertEquals([], $request->getHeaders());
+        $this->assertEquals(
+            'http://localhost:3000?token=someAuthToken&authorization=accessToken',
+            $request->getQueryUrl()
+        );
+    }
+
     public function testHeaderOrQueryAuthWithMissingFields()
     {
         $this->expectException(AuthValidationException::class);
@@ -122,6 +145,16 @@ public function testHeaderWithMissingFieldAndQueryAuth()
         MockHelper::getClient()->validateAuth($auth);
     }
 
+    public function testHeaderWithEmptyFieldAndQueryAuth()
+    {
+        $this->expectException(AuthValidationException::class);
+        $this->expectExceptionMessage("Following authentication credentials are required:" .
+            "\n-> Missing required header field: token");
+
+        $auth = Auth::and('headerWithEmpty', 'query');
+        MockHelper::getClient()->validateAuth($auth);
+    }
+
     public function testHeaderAndQueryAuthWithMissingFields()
     {
         $this->expectException(AuthValidationException::class);

tests/AuthenticationTest.php

@@ -10,8 +10,8 @@ class FormAuthManager extends CoreAuth
     public function __construct($token, $accessToken)
     {
         parent::__construct(
-            FormParam::init('token', $token)->required(),
-            FormParam::init('authorization', $accessToken)->required()
+            FormParam::init('token', $token)->requiredNonEmpty(),
+            FormParam::init('authorization', $accessToken)->requiredNonEmpty()
         );
     }
 }

tests/Mocking/Authentication/FormAuthManager.php

@@ -10,8 +10,8 @@ class HeaderAuthManager extends CoreAuth
     public function __construct($token, $accessToken)
     {
         parent::__construct(
-            HeaderParam::init('token', $token)->required(),
-            HeaderParam::init('authorization', $accessToken)->required()
+            HeaderParam::init('token', $token)->requiredNonEmpty(),
+            HeaderParam::init('authorization', $accessToken)->requiredNonEmpty()
         );
     }
 }

tests/Mocking/Authentication/HeaderAuthManager.php

@@ -10,8 +10,8 @@ class QueryAuthManager extends CoreAuth
     public function __construct($token, $accessToken)
     {
         parent::__construct(
-            QueryParam::init('token', $token)->required(),
-            QueryParam::init('authorization', $accessToken)->required()
+            QueryParam::init('token', $token)->requiredNonEmpty(),
+            QueryParam::init('authorization', $accessToken)->requiredNonEmpty()
         );
     }
 }

tests/Mocking/Authentication/QueryAuthManager.php

@@ -83,6 +83,7 @@ public static function getClient(): Client
                 ->authManagers([
                     "header" => new HeaderAuthManager('someAuthToken', 'accessToken'),
                     "headerWithNull" => new HeaderAuthManager('someAuthToken', null),
+                    "headerWithEmpty" => new HeaderAuthManager('', 'accessToken'),
                     "query" => new QueryAuthManager('someAuthToken', 'accessToken'),
                     "queryWithNull" => new QueryAuthManager(null, 'accessToken'),
                     "form" => new FormAuthManager('someAuthToken', 'accessToken'),