feat: improve contact form match pattern (#70)

* Update schema to match pattern of contact form or email. Closes #69.

* Add in missing imports.

* Fix test for Anyurl.

* Fix missing imports.

* Compliance with flake8.

Author: vsmalladi

compliance_suite/models/v1_0_0_specs.py

@@ -9,7 +9,8 @@
 from enum import Enum
 from typing import Dict, List, Optional
 
-from pydantic import AnyUrl, BaseModel, Field
+from pydantic import AnyUrl, BaseModel, Field, EmailStr, validator, ValidationError
+from pydantic.tools import parse_obj_as
 
 
 class TesCancelTaskResponse(BaseModel):
@@ -295,7 +296,7 @@ class Service(BaseModel):
     organization: Organization = Field(
         ..., description='Organization providing the service'
     )
-    contactUrl: Optional[AnyUrl] = Field(
+    contactUrl: Optional[str] = Field(
         None,
         description='URL of the contact for the provider of this service, e.g. a link to a contact form '
                     '(RFC 3986 format), or an email (RFC 2368 format).',
@@ -333,6 +334,22 @@ class Service(BaseModel):
         example='1.0.0',
     )
 
+    @validator('contactUrl')
+    def check_url_or_email(cls, value):
+        if value.startswith("mailto:"):
+            email = value[len("mailto:"):]
+            try:
+                EmailStr.validate(email)
+                return value
+            except ValidationError:
+                raise ValueError("Invalid email address")
+        else:
+            try:
+                parse_obj_as(AnyUrl, value)
+                return value
+            except ValidationError:
+                raise ValueError("Invalid URL")
+
 
 class TesServiceType(ServiceType):
     artifact: Artifact = Field(..., example='tes')

compliance_suite/models/v1_1_0_specs.py

@@ -9,7 +9,8 @@
 from enum import Enum
 from typing import Dict, List, Optional
 
-from pydantic import AnyUrl, BaseModel, Field
+from pydantic import AnyUrl, BaseModel, Field, EmailStr, validator, ValidationError
+from pydantic.tools import parse_obj_as
 
 
 class TesCancelTaskResponse(BaseModel):
@@ -341,7 +342,7 @@ class Service(BaseModel):
     organization: Organization = Field(
         ..., description='Organization providing the service'
     )
-    contactUrl: Optional[AnyUrl] = Field(
+    contactUrl: Optional[str] = Field(
         None,
         description='URL of the contact for the provider of this service, e.g. a link to a contact form '
                     '(RFC 3986 format), or an email (RFC 2368 format).',
@@ -379,6 +380,22 @@ class Service(BaseModel):
         example='1.0.0',
     )
 
+    @validator('contactUrl')
+    def check_url_or_email(cls, value):
+        if value.startswith("mailto:"):
+            email = value[len("mailto:"):]
+            try:
+                EmailStr.validate(email)
+                return value
+            except ValidationError:
+                raise ValueError("Invalid email address")
+        else:
+            try:
+                parse_obj_as(AnyUrl, value)
+                return value
+            except ValidationError:
+                raise ValueError("Invalid URL")
+
 
 class TesServiceType(ServiceType):
     artifact: Artifact = Field(..., example='tes')

requirements.txt

@@ -10,4 +10,5 @@ pytest==7.1.2
 colorlog==6.6.0
 ga4gh-testbed-lib==0.2.0
 jinja2==3.1.2
-dotmap==1.3.30
+dotmap==1.3.30
+email-validator==2.1.1