Merge pull request #24 from dbluhm/fix/did-regex

fix: did regex and partial matches

Author: dbluhm

pydid/common.py

@@ -1,7 +1,9 @@
 """Common components."""
 import re
 
-DID_PATTERN = re.compile("did:([a-z0-9]+):((?:[a-zA-Z0-9._-]*:)*[a-zA-Z0-9._-]+)")
+DID_REGEX = "did:([a-z0-9]+):((?:[a-zA-Z0-9._-]*:)*[a-zA-Z0-9._-]+)"
+DID_PATTERN = re.compile(f"^{DID_REGEX}$")
+DID_URL_DID_PART_PATTERN = re.compile(f"^({DID_REGEX})[?/#]")
 
 
 class DIDError(Exception):

pydid/did.py

@@ -25,7 +25,7 @@ class DID:
     def __init__(self, did: str):
         """Validate and parse raw DID str."""
         self._raw = did
-        matched = DID_PATTERN.fullmatch(did)
+        matched = DID_PATTERN.match(did)
         if not matched:
             raise InvalidDIDError("Unable to parse DID {}".format(did))
         self._method = matched.group(1)
@@ -73,7 +73,7 @@ def ref(self, ident: str) -> DIDUrl:
     @classmethod
     def is_valid(cls, did: str):
         """Return if the passed string is a valid DID."""
-        return DID_PATTERN.fullmatch(did)
+        return DID_PATTERN.match(did)
 
     @classmethod
     def validate(cls, did: str):

pydid/did_url.py

@@ -4,7 +4,7 @@
 
 from voluptuous import Invalid
 
-from .common import DID_PATTERN, DIDError
+from .common import DID_URL_DID_PART_PATTERN, DIDError
 
 
 class InvalidDIDUrlError(DIDError, Invalid):
@@ -78,12 +78,12 @@ def __hash__(self):
     @classmethod
     def parse(cls, url: str):
         """Parse DID URL from string."""
-        matches = DID_PATTERN.match(url)
+        matches = DID_URL_DID_PART_PATTERN.match(url)
 
         if not matches:
             raise InvalidDIDUrlError("DID could not be parsed from URL {}".format(url))
 
-        did = matches.group(0)
+        did = matches.group(1)
         _, url_component = url.split(did)
 
         if not url_component:

tests/test_did.py

@@ -111,6 +111,7 @@ def test_validate(did):
         "did:nomethodspecificidentifier",
         "did:invalid-chars-in-method:method-specific-id",
         "bad-prefix:method:method-specific-id",
+        "did:bad:char'@='acters:example:1234abcd",
         *TEST_DID_URLS,
     ],
 )

tests/test_did_url.py

@@ -53,3 +53,7 @@ def test_is_valid(url):
 @pytest.mark.parametrize("bad_url", [TEST_DID0, "not a did url"])
 def test_is_valid_x(bad_url):
     assert not DIDUrl.is_valid(bad_url)
+
+
+def test_partial_match_url():
+    assert not DIDUrl.is_valid("did:bad:char'@='acters:example:1234abcd#4")