refactor: rearrange packages

dbluhm · dbluhm · commit b56127a724af · 2024-06-06T12:19:36.000-04:00
Signed-off-by: Daniel Bluhm &lt;dbluhm@pm.me&gt;
diff --git a/didcomm_messaging/v1/__init__.py b/didcomm_messaging/v1/__init__.py
@@ -1,4 +1,4 @@
-"""V1 DIDComm v1 Interfaces.
+"""DIDComm v1 Interfaces.
 
 These components are intended to provide a similar structure to the DIDComm v2
 interfaces provided by this library. While the community is transitioning from
diff --git a/didcomm_messaging/v1/crypto/__init__.py b/didcomm_messaging/v1/crypto/__init__.py
@@ -0,0 +1,10 @@
+"""V1 DIDComm Crypto interfaces.
+
+These components are intended to provide a similar structure to the DIDComm v2
+interfaces provided by this library. While the community is transitioning from
+DIDComm v1 to v2, having a consistent interface to interact with will help
+implementers to support both versions until the transition is complete.
+
+It is expected that a future version of this library will eventually remove
+these interfaces.
+"""
diff --git a/didcomm_messaging/v1/crypto/askar.py b/didcomm_messaging/v1/crypto/askar.py
@@ -7,7 +7,7 @@
 from pydid import VerificationMethod
 
 from didcomm_messaging.crypto.jwe import JweBuilder, JweEnvelope, JweRecipient
-from didcomm_messaging.legacy.base import (
+from .base import (
     V1CryptoService,
     V1UnpackResult,
     RecipData,
diff --git a/didcomm_messaging/v1/crypto/base.py b/didcomm_messaging/v1/crypto/base.py
diff --git a/didcomm_messaging/v1/crypto/nacl.py b/didcomm_messaging/v1/crypto/nacl.py
@@ -18,7 +18,7 @@
     import nacl.utils
 except ImportError as err:
     raise ImportError(
-        "V1 implementation requires 'legacy' extra to be installed"
+        "V1 nacl implementation requires 'nacl' extra to be installed"
     ) from err
 
 
diff --git a/didcomm_messaging/v1/messaging.py b/didcomm_messaging/v1/messaging.py
@@ -10,13 +10,13 @@
 from pydid.service import DIDCommV1Service
 
 from didcomm_messaging.crypto import P, S, SecretsManager
-from didcomm_messaging.legacy.base import V1CryptoService
-from didcomm_messaging.legacy.packaging import V1PackagingService
+from didcomm_messaging.v1.crypto.base import V1CryptoService
+from didcomm_messaging.v1.packaging import V1PackagingService
 from didcomm_messaging.resolver import DIDResolver
 
 
 class V1DIDCommMessagingError(Exception):
-    """Raised on error in legacy didcomm messaging."""
+    """Raised on error in v1 didcomm messaging."""
 
 
 @dataclass
diff --git a/didcomm_messaging/v1/packaging.py b/didcomm_messaging/v1/packaging.py
@@ -4,7 +4,7 @@
 
 from didcomm_messaging.crypto.base import P, S, SecretsManager
 from didcomm_messaging.crypto.jwe import JweEnvelope, JweRecipient
-from didcomm_messaging.legacy.base import (
+from didcomm_messaging.v1.crypto.base import (
     V1CryptoService,
     V1UnpackResult,
     RecipData,
diff --git a/pyproject.toml b/pyproject.toml
@@ -31,6 +31,10 @@ legacy = [
     "msgpack>=1.0.8",
     "PyNaCl>=1.5.0",
 ]
+nacl = [
+    "msgpack>=1.0.8",
+    "PyNaCl>=1.5.0",
+]
 
 [build-system]
 requires = ["pdm-backend"]
diff --git a/tests/legacy/test_crypto.py b/tests/legacy/test_crypto.py
@@ -2,7 +2,7 @@
 
 import pytest
 from didcomm_messaging.legacy import crypto
-from didcomm_messaging.legacy.nacl import KeyPair
+from didcomm_messaging.v1.crypto.nacl import KeyPair
 
 
 @pytest.fixture
diff --git a/tests/v1/__init__.py b/tests/v1/__init__.py
diff --git a/tests/v1/conftest.py b/tests/v1/conftest.py
@@ -1,22 +1,22 @@
 from aries_askar import Key, KeyAlg, Store
 import base58
-from did_peer_4.input_doc import KeySpec, input_doc_from_keys_and_services
 import did_peer_4
+from did_peer_4.input_doc import KeySpec, input_doc_from_keys_and_services
 import pytest
 import pytest_asyncio
 
 from didcomm_messaging.crypto.backend.askar import AskarKey, AskarSecretsManager
-from didcomm_messaging.legacy.askar import AskarV1CryptoService, AskarSecretKey
-from didcomm_messaging.legacy.messaging import V1DIDCommMessaging
-from didcomm_messaging.legacy.nacl import (
+from didcomm_messaging.resolver import DIDResolver
+from didcomm_messaging.resolver.peer import Peer4
+from didcomm_messaging.v1.crypto.askar import AskarSecretKey, AskarV1CryptoService
+from didcomm_messaging.v1.crypto.nacl import (
     EdPublicKey,
     InMemSecretsManager,
     KeyPair,
     NaclV1CryptoService,
 )
-from didcomm_messaging.legacy.packaging import V1PackagingService
-from didcomm_messaging.resolver import DIDResolver
-from didcomm_messaging.resolver.peer import Peer4
+from didcomm_messaging.v1.messaging import V1DIDCommMessaging
+from didcomm_messaging.v1.packaging import V1PackagingService
 
 
 @pytest.fixture
diff --git a/tests/v1/test_nacl_x_askar.py b/tests/v1/test_nacl_x_askar.py
@@ -1,7 +1,7 @@
 import pytest
 
 from didcomm_messaging.crypto.base import SecretKey
-from didcomm_messaging.legacy.messaging import V1DIDCommMessaging
+from didcomm_messaging.v1.messaging import V1DIDCommMessaging
 
 
 @pytest.mark.asyncio

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-"""V1 DIDComm v1 Interfaces.`
	`1`	`+"""DIDComm v1 Interfaces.`
`2`	`2`
`3`	`3`	`These components are intended to provide a similar structure to the DIDComm v2`
`4`	`4`	`interfaces provided by this library. While the community is transitioning from`