Add Email and Phone Number Masking to URI Sanitization (#35)

mask for phone number and email

Author: annacia

src/Support/Uri.php

@@ -26,7 +26,9 @@ public static function sanitize(string $uri, array $uriMask = []): string
                     '/\/(?<=\/)([A-Z]{3}-?\d[0-9A-Z]\d{2})(?=\/)?/i',
                     '/\/(?<=\/)[0-9A-F]{16,24}(?=\/)?/i',
                     '/\/(?<=\/)\d+(?=\/)?/',
+                    '/\/(?<=\/)\+?\d{10,15}(?=\/|$)/',
                     '/\/(?<=\/)R[RN]\d{16}[A-Za-z0-9]{11}/',
+                    '/\/(?<=\/)[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\.[A-Za-z]{2,}(?=\/|$)/i',
                     '/\/([A-Z]{3,}(?:-[A-Z]{3,})*)-([A-Z0-9]{3}-\d+(?:_\d{3})?|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|[A-Za-z0-9]{8,})(?=\/|$)/i',
                 ],
             ),
@@ -39,7 +41,9 @@ public static function sanitize(string $uri, array $uriMask = []): string
                     '/<LICENSE-PLATE>',
                     '/<OID>',
                     '/<NUMBER>',
+                    '/<PHONE-NUMBER>',
                     '/<EXTERNAL-ID>',
+                    '/<EMAIL>',
                     '/<PREFIXED-ID>',
                 ],
             ),

tests/Cases/UriTest.php

@@ -32,6 +32,21 @@ public function testSanitizeNumbers(): void
         self::assertSame('/v8/test/<NUMBER>/<NUMBER>/<NUMBER>/', Uri::sanitize('/v8/test/123/456/789/'));
     }
 
+    public function testSanitizePhoneNumber(): void
+    {
+        $phoneNumber = '+5511983999292';
+        $phoneNumber2 = '+9607392675';
+
+        self::assertSame('/v1/test', Uri::sanitize('/v1/test'));
+        self::assertSame('/v2/test/<PHONE-NUMBER>', Uri::sanitize("/v2/test/{$phoneNumber}"));
+        self::assertSame('/v3/test/<PHONE-NUMBER>/bar', Uri::sanitize("/v3/test/{$phoneNumber}/bar"));
+        self::assertSame('/v4/test/<PHONE-NUMBER>/bar/<PHONE-NUMBER>/', Uri::sanitize("/v4/test/{$phoneNumber}/bar/{$phoneNumber2}/"));
+        self::assertSame('/v5/test/<PHONE-NUMBER>/<PHONE-NUMBER>', Uri::sanitize("/v5/test/$phoneNumber/$phoneNumber2"));
+        self::assertSame('/v6/test/<PHONE-NUMBER>/<PHONE-NUMBER>/', Uri::sanitize("/v6/test/$phoneNumber/$phoneNumber2/"));
+        self::assertSame('/v7/test/<PHONE-NUMBER>/<PHONE-NUMBER>/<PHONE-NUMBER>', Uri::sanitize("/v7/test/$phoneNumber/$phoneNumber2/$phoneNumber"));
+        self::assertSame('/v8/test/<PHONE-NUMBER>/<PHONE-NUMBER>/<PHONE-NUMBER>/', Uri::sanitize("/v8/test/$phoneNumber/$phoneNumber2/$phoneNumber/"));
+    }
+
     public function testSanitizeLicensePlatesStrings(): void
     {
         self::assertSame('/v1/test', Uri::sanitize('/v1/test'));
@@ -162,6 +177,21 @@ public function testClearUriExternalIds(): void
         self::assertSame('/v9/test/<EXTERNAL-ID>/bar/<NUMBER>', Uri::sanitize('/v9/test/RR2101818220123720H9KJTERfw1a/bar/12345'));
     }
 
+    public function testSanitizeEmail(): void
+    {
+        $email = '[email protected]';
+        $email2 = '[email protected]';
+
+        self::assertSame('/v1/test', Uri::sanitize('/v1/test'));
+        self::assertSame('/v2/test/<EMAIL>', Uri::sanitize("/v2/test/{$email}"));
+        self::assertSame('/v3/test/<EMAIL>/bar', Uri::sanitize("/v3/test/{$email}/bar"));
+        self::assertSame('/v4/test/<EMAIL>/bar/<EMAIL>/', Uri::sanitize("/v4/test/{$email}/bar/{$email2}/"));
+        self::assertSame('/v5/test/<EMAIL>/<EMAIL>', Uri::sanitize("/v5/test/$email/$email2"));
+        self::assertSame('/v6/test/<EMAIL>/<EMAIL>/', Uri::sanitize("/v6/test/$email/$email2/"));
+        self::assertSame('/v7/test/<EMAIL>/<EMAIL>/<EMAIL>', Uri::sanitize("/v7/test/$email/$email2/$email"));
+        self::assertSame('/v8/test/<EMAIL>/<EMAIL>/<EMAIL>/', Uri::sanitize("/v8/test/$email/$email2/$email/"));
+    }
+
     public function testClearUriPrefixedId(): void
     {
         // Casos de teste específicos solicitados