fix!: publicKey to verificationMethod correction, minor fixes

.pre-commit-config.yaml

@@ -5,15 +5,15 @@ repos:
     hooks:
       - id: commitlint
         stages: [commit-msg]
+        args: ["--config", ".commitlint.config.js"]
         additional_dependencies: ['@commitlint/config-conventional']
   - repo: https://github.com/psf/black
     rev: 23.7.0
     hooks:
       - id: black
         stages: [commit]
-  - repo: https://gitlab.com/retnikt/flake9
-    rev: 3.8.3.post1
+  - repo: https://github.com/pycqa/flake8
+    rev: 3.9.0
     hooks:
       - id: flake8
-        additional_dependencies: ['toml']
         stages: [commit]

pydid/__init__.py

@@ -11,6 +11,7 @@
     BaseDIDDocument,
     BasicDIDDocument,
     DIDDocument,
+    DIDDocumentError,
     NonconformantDocument,
 )
 from .resource import Resource
@@ -51,7 +52,7 @@ def deserialize_document(
     corrections: Optional[List[Callable]] = None,
     *,
     strict: bool = False,
-    cls: Type[BaseDIDDocument] = None,
+    cls: Optional[Type[BaseDIDDocument]] = None,
 ) -> BaseDIDDocument:
     """Deserialize a document from a dictionary."""
     if corrections:

pydid/doc/__init__.py

@@ -6,6 +6,7 @@
     DIDDocumentRoot,
     BasicDIDDocument,
     DIDDocument,
+    DIDDocumentError,
 )
 
 from .builder import (

pydid/doc/corrections.py

@@ -19,7 +19,7 @@ def insert_missing_ids(value: dict) -> dict:
     >>> import pydid
     >>> doc_raw = {"@context": "http://example.com", "id": "did:example:123"}
     >>> doc = pydid.deserialize_document(
-    ...     doc, corrections=[pydid.corrections.insert_missing_ids]
+    ...     doc_raw, corrections=[pydid.corrections.insert_missing_ids]
     ... )
     """
     if "id" not in value:
@@ -46,3 +46,40 @@ def _walk(value: Union[str, list, dict]):
         _walk(nested)
 
     return value
+
+
+def public_key_is_verification_method(value: dict) -> dict:
+    """Transform publicKey to verificationMethod.
+
+    This is helpful if dealing with DID resolvers that have not updated to the
+    latest DID Spec.
+
+    This correction can be applied directly to a raw document dictionary or
+    with the pydid.deserialize_document method:
+
+    >>> import pydid
+    >>> doc_raw = {
+    ...     "@context": "http://example.com",
+    ...     "id": "did:example:123",
+    ...     "publicKey": [{"id": "did:example:123#key-1"}],
+    ... }
+    >>> doc_raw = pydid.corrections.public_key_is_verification_method(doc_raw)
+    >>> assert "verificationMethod" in doc_raw
+    >>> assert "publicKey" not in doc_raw
+
+    Or:
+    >>> import pydid
+    >>> doc_raw = {
+    ...     "@context": "http://example.com",
+    ...     "id": "did:example:123",
+    ...     "publicKey": [{"id": "did:example:123#key-1"}],
+    ... }
+    >>> doc = pydid.deserialize_document(
+    ...     doc_raw, corrections=[pydid.corrections.public_key_is_verification_method]
+    ... )
+    >>> assert doc.verification_method
+    """
+
+    if "publicKey" in value:
+        value["verificationMethod"] = value.pop("publicKey")
+    return value

pydid/doc/doc.py

@@ -3,7 +3,7 @@
 from abc import ABC
 from typing import Any, List, Optional, Union
 
-from pydantic import Field, root_validator, validator
+from pydantic import Field, validator
 from typing_extensions import Annotated
 
 from ..did import DID, InvalidDIDError
@@ -58,17 +58,6 @@ def _listify(cls, value):
             return value
         return [value]
 
-    @root_validator(pre=True, allow_reuse=True)
-    @classmethod
-    def _allow_publickey_instead_of_verification_method(cls, values: dict):
-        """Accept publickKey, transforming to verificationMethod.
-
-        This validator handles a common DID Document mutation.
-        """
-        if "publicKey" in values:
-            values["verificationMethod"] = values["publicKey"]
-        return values
-
 
 class BaseDIDDocument(DIDDocumentRoot, IndexedResource, ABC):
     """Abstract BaseDIDDocument class."""

pyproject.toml

@@ -33,7 +33,7 @@ pytest-asyncio = "^0.21.0"
 coverage = {extras = ["toml"], version = "^7.2.0"}
 
 [tool.pytest.ini_options]
-addopts = "-p no:warnings --cov pydid"
+addopts = "-p no:warnings --cov pydid --doctest-modules"
 markers = "int: integration tests"
 
 [tool.coverage.report]