metaspn-entities 0.1.0__tar.gz → 0.1.3__tar.gz

{metaspn_entities-0.1.0 → metaspn_entities-0.1.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: metaspn-entities
-Version: 0.1.0
+Version: 0.1.3
 Summary: Canonical entity resolution, aliasing, and merges for MetaSPN systems
 Author: MetaSPN Contributors
 License-Expression: MIT
@@ -55,3 +55,17 @@ print(resolution.entity_id, resolution.confidence)
 - `undo_merge(from_entity_id, to_entity_id, ...)` (implemented as reverse merge with redirect correction)
 - `drain_events() -> list[EmittedEvent]`
 - `export_snapshot(output_path)` to inspect SQLite state as JSON
+
+## Event Contract Guarantees
+
+`drain_events()` returns `EmittedEvent` objects whose `event_type` and `payload` are
+schema-compatible with `metaspn-schemas` entity events.
+
+- `EntityResolved` payload keys:
+  - `entity_id`, `resolver`, `resolved_at`, `confidence`, `schema_version`
+- `EntityMerged` payload keys:
+  - `entity_id`, `merged_from`, `merged_at`, `reason`, `schema_version`
+- `EntityAliasAdded` payload keys:
+  - `entity_id`, `alias`, `alias_type`, `added_at`, `schema_version`
+
+Datetime fields are emitted as UTC ISO-8601 strings for deterministic serialization.

{metaspn_entities-0.1.0 → metaspn_entities-0.1.3}/README.md

@@ -30,3 +30,17 @@ print(resolution.entity_id, resolution.confidence)
 - `undo_merge(from_entity_id, to_entity_id, ...)` (implemented as reverse merge with redirect correction)
 - `drain_events() -> list[EmittedEvent]`
 - `export_snapshot(output_path)` to inspect SQLite state as JSON
+
+## Event Contract Guarantees
+
+`drain_events()` returns `EmittedEvent` objects whose `event_type` and `payload` are
+schema-compatible with `metaspn-schemas` entity events.
+
+- `EntityResolved` payload keys:
+  - `entity_id`, `resolver`, `resolved_at`, `confidence`, `schema_version`
+- `EntityMerged` payload keys:
+  - `entity_id`, `merged_from`, `merged_at`, `reason`, `schema_version`
+- `EntityAliasAdded` payload keys:
+  - `entity_id`, `alias`, `alias_type`, `added_at`, `schema_version`
+
+Datetime fields are emitted as UTC ISO-8601 strings for deterministic serialization.

metaspn_entities-0.1.3/metaspn_entities/events.py

@@ -0,0 +1,65 @@
+from __future__ import annotations
+
+from dataclasses import dataclass
+from datetime import datetime, timezone
+from typing import Any, Dict
+
+DEFAULT_SCHEMA_VERSION = "0.1"
+try:
+    from metaspn_schemas.core import DEFAULT_SCHEMA_VERSION as _SCHEMA_VERSION
+
+    DEFAULT_SCHEMA_VERSION = _SCHEMA_VERSION
+except Exception:
+    # Keep local behavior deterministic when dependency is not importable in dev sandboxes.
+    pass
+
+
+@dataclass(frozen=True)
+class EmittedEvent:
+    event_type: str
+    payload: Dict[str, Any]
+
+
+class EventFactory:
+    @staticmethod
+    def _now() -> datetime:
+        return datetime.now(timezone.utc).replace(microsecond=0)
+
+    @staticmethod
+    def entity_resolved(entity_id: str, resolver: str, confidence: float) -> EmittedEvent:
+        return EmittedEvent(
+            event_type="EntityResolved",
+            payload={
+                "entity_id": entity_id,
+                "resolver": resolver,
+                "resolved_at": EventFactory._now().isoformat(),
+                "confidence": confidence,
+                "schema_version": DEFAULT_SCHEMA_VERSION,
+            },
+        )
+
+    @staticmethod
+    def entity_merged(entity_id: str, merged_from: tuple[str, ...], reason: str | None = None) -> EmittedEvent:
+        return EmittedEvent(
+            event_type="EntityMerged",
+            payload={
+                "entity_id": entity_id,
+                "merged_from": list(merged_from),
+                "merged_at": EventFactory._now().isoformat(),
+                "reason": reason,
+                "schema_version": DEFAULT_SCHEMA_VERSION,
+            },
+        )
+
+    @staticmethod
+    def entity_alias_added(entity_id: str, alias: str, alias_type: str) -> EmittedEvent:
+        return EmittedEvent(
+            event_type="EntityAliasAdded",
+            payload={
+                "entity_id": entity_id,
+                "alias": alias,
+                "alias_type": alias_type,
+                "added_at": EventFactory._now().isoformat(),
+                "schema_version": DEFAULT_SCHEMA_VERSION,
+            },
+        )

{metaspn_entities-0.1.0 → metaspn_entities-0.1.3}/metaspn_entities/resolver.py

@@ -39,12 +39,11 @@ class EntityResolver:
                 created_new_entity=False,
                 matched_identifiers=matched_identifiers,
             )
-            self._event_buffer.append(
-                EventFactory.entity_resolved(entity_id, identifier_type, value, resolution.confidence, False)
-            )
+            self._event_buffer.append(EventFactory.entity_resolved(entity_id, caused_by, resolution.confidence))
             return resolution
 
         entity_id = self.store.create_entity(entity_type)
+        created_entity_id = entity_id
         added, conflicting_entity_id = self.store.add_alias(
             identifier_type=identifier_type,
             normalized_value=normalized,
@@ -58,9 +57,7 @@ class EntityResolver:
             merge_reason = f"auto-merge on {identifier_type}:{normalized}"
             self.store.merge_entities(entity_id, conflicting_entity_id, merge_reason, "auto-merge")
             entity_id = self.store.canonical_entity_id(conflicting_entity_id)
-            self._event_buffer.append(
-                EventFactory.entity_merged(entity_id, conflicting_entity_id, merge_reason, "auto-merge")
-            )
+            self._event_buffer.append(EventFactory.entity_merged(entity_id, (created_entity_id,), merge_reason))
 
         matched_identifiers = list(self.store.iter_identifiers_for_entity(entity_id))
         resolution = EntityResolution(
@@ -70,10 +67,8 @@ class EntityResolver:
             matched_identifiers=matched_identifiers,
         )
         if added:
-            self._event_buffer.append(EventFactory.entity_alias_added(entity_id, identifier_type, normalized, caused_by))
-        self._event_buffer.append(
-            EventFactory.entity_resolved(entity_id, identifier_type, value, resolution.confidence, True)
-        )
+            self._event_buffer.append(EventFactory.entity_alias_added(entity_id, normalized, identifier_type))
+        self._event_buffer.append(EventFactory.entity_resolved(entity_id, caused_by, resolution.confidence))
         return resolution
 
     def add_alias(
@@ -102,7 +97,7 @@ class EntityResolver:
             if identifier_type in AUTO_MERGE_IDENTIFIER_TYPES:
                 reason = f"auto-merge on {identifier_type}:{normalized}"
                 self.store.merge_entities(canonical_entity_id, conflicting_entity_id, reason, "auto-merge")
-                event = EventFactory.entity_merged(canonical_entity_id, conflicting_entity_id, reason, "auto-merge")
+                event = EventFactory.entity_merged(conflicting_entity_id, (canonical_entity_id,), reason)
                 self._event_buffer.append(event)
                 return [event]
             raise ValueError(
@@ -112,7 +107,7 @@ class EntityResolver:
         if not added:
             return []
 
-        event = EventFactory.entity_alias_added(canonical_entity_id, identifier_type, normalized, caused_by)
+        event = EventFactory.entity_alias_added(canonical_entity_id, normalized, identifier_type)
         self._event_buffer.append(event)
         return [event]
 
@@ -120,7 +115,7 @@ class EntityResolver:
         self.store.ensure_entity(from_entity_id)
         self.store.ensure_entity(to_entity_id)
         self.store.merge_entities(from_entity_id, to_entity_id, reason, caused_by)
-        event = EventFactory.entity_merged(from_entity_id, to_entity_id, reason, caused_by)
+        event = EventFactory.entity_merged(self.store.canonical_entity_id(to_entity_id), (from_entity_id,), reason)
         self._event_buffer.append(event)
         return event
 
@@ -130,7 +125,7 @@ class EntityResolver:
             self.store.remove_redirect(from_entity_id)
             self.store.set_entity_status(from_entity_id, EntityStatus.ACTIVE)
         self.store.merge_entities(to_entity_id, from_entity_id, reason, caused_by)
-        event = EventFactory.entity_merged(to_entity_id, from_entity_id, reason, caused_by)
+        event = EventFactory.entity_merged(self.store.canonical_entity_id(from_entity_id), (to_entity_id,), reason)
         self._event_buffer.append(event)
         return event
 

{metaspn_entities-0.1.0 → metaspn_entities-0.1.3}/metaspn_entities.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: metaspn-entities
-Version: 0.1.0
+Version: 0.1.3
 Summary: Canonical entity resolution, aliasing, and merges for MetaSPN systems
 Author: MetaSPN Contributors
 License-Expression: MIT
@@ -55,3 +55,17 @@ print(resolution.entity_id, resolution.confidence)
 - `undo_merge(from_entity_id, to_entity_id, ...)` (implemented as reverse merge with redirect correction)
 - `drain_events() -> list[EmittedEvent]`
 - `export_snapshot(output_path)` to inspect SQLite state as JSON
+
+## Event Contract Guarantees
+
+`drain_events()` returns `EmittedEvent` objects whose `event_type` and `payload` are
+schema-compatible with `metaspn-schemas` entity events.
+
+- `EntityResolved` payload keys:
+  - `entity_id`, `resolver`, `resolved_at`, `confidence`, `schema_version`
+- `EntityMerged` payload keys:
+  - `entity_id`, `merged_from`, `merged_at`, `reason`, `schema_version`
+- `EntityAliasAdded` payload keys:
+  - `entity_id`, `alias`, `alias_type`, `added_at`, `schema_version`
+
+Datetime fields are emitted as UTC ISO-8601 strings for deterministic serialization.

{metaspn_entities-0.1.0 → metaspn_entities-0.1.3}/metaspn_entities.egg-info/SOURCES.txt

@@ -12,4 +12,5 @@ metaspn_entities.egg-info/SOURCES.txt
 metaspn_entities.egg-info/dependency_links.txt
 metaspn_entities.egg-info/requires.txt
 metaspn_entities.egg-info/top_level.txt
+tests/test_event_contract.py
 tests/test_resolver.py

{metaspn_entities-0.1.0 → metaspn_entities-0.1.3}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "metaspn-entities"
-version = "0.1.0"
+version = "0.1.3"
 description = "Canonical entity resolution, aliasing, and merges for MetaSPN systems"
 readme = "README.md"
 requires-python = ">=3.10"

metaspn_entities-0.1.3/tests/test_event_contract.py

@@ -0,0 +1,98 @@
+import importlib
+import sys
+import tempfile
+import unittest
+from datetime import datetime
+from pathlib import Path
+
+from metaspn_entities import EntityResolver, SQLiteEntityStore
+
+
+class EventContractTests(unittest.TestCase):
+    def setUp(self) -> None:
+        self.tempdir = tempfile.TemporaryDirectory()
+        self.db_path = str(Path(self.tempdir.name) / "entities.db")
+        self.store = SQLiteEntityStore(self.db_path)
+        self.resolver = EntityResolver(self.store)
+
+    def tearDown(self) -> None:
+        self.store.close()
+        self.tempdir.cleanup()
+
+    def test_entity_resolved_payload_shape(self) -> None:
+        self.resolver.resolve("twitter_handle", "contract_user")
+        event = self.resolver.drain_events()[-1]
+
+        self.assertEqual(event.event_type, "EntityResolved")
+        self.assertEqual(
+            sorted(event.payload.keys()),
+            ["confidence", "entity_id", "resolved_at", "resolver", "schema_version"],
+        )
+        self.assertIsInstance(event.payload["resolver"], str)
+        self.assertGreaterEqual(float(event.payload["confidence"]), 0.0)
+        datetime.fromisoformat(event.payload["resolved_at"])
+
+    def test_entity_merged_payload_shape(self) -> None:
+        a = self.resolver.resolve("twitter_handle", "merge_a")
+        b = self.resolver.resolve("twitter_handle", "merge_b")
+        self.resolver.drain_events()
+
+        self.resolver.merge_entities(a.entity_id, b.entity_id, reason="dedupe")
+        event = self.resolver.drain_events()[-1]
+
+        self.assertEqual(event.event_type, "EntityMerged")
+        self.assertEqual(
+            sorted(event.payload.keys()),
+            ["entity_id", "merged_at", "merged_from", "reason", "schema_version"],
+        )
+        self.assertEqual(event.payload["entity_id"], b.entity_id)
+        self.assertEqual(event.payload["merged_from"], [a.entity_id])
+        datetime.fromisoformat(event.payload["merged_at"])
+
+    def test_entity_alias_added_payload_shape(self) -> None:
+        created = self.resolver.resolve("twitter_handle", "alias_contract")
+        self.resolver.drain_events()
+
+        events = self.resolver.add_alias(created.entity_id, "email", "alias@example.com")
+        self.assertEqual(len(events), 1)
+        event = events[0]
+
+        self.assertEqual(event.event_type, "EntityAliasAdded")
+        self.assertEqual(
+            sorted(event.payload.keys()),
+            ["added_at", "alias", "alias_type", "entity_id", "schema_version"],
+        )
+        self.assertEqual(event.payload["entity_id"], created.entity_id)
+        self.assertEqual(event.payload["alias_type"], "email")
+        self.assertEqual(event.payload["alias"], "alias@example.com")
+        datetime.fromisoformat(event.payload["added_at"])
+
+    def test_schema_round_trip_when_metaspn_schemas_is_available(self) -> None:
+        # Try import from installed package first, then from sibling checkout if present.
+        entities_module = None
+        try:
+            entities_module = importlib.import_module("metaspn_schemas.entities")
+        except Exception:
+            sibling_src = Path(__file__).resolve().parents[2] / "metaspn-schemas" / "src"
+            if sibling_src.exists():
+                sys.path.insert(0, str(sibling_src))
+                entities_module = importlib.import_module("metaspn_schemas.entities")
+
+        if entities_module is None:
+            self.skipTest("metaspn_schemas is unavailable")
+
+        self.resolver.resolve("twitter_handle", "roundtrip_user")
+        resolved_event = self.resolver.drain_events()[-1]
+
+        entity_resolved = entities_module.EntityResolved.from_dict(resolved_event.payload)
+        self.assertEqual(entity_resolved.entity_id, resolved_event.payload["entity_id"])
+
+        created = self.resolver.resolve("twitter_handle", "roundtrip_alias")
+        self.resolver.drain_events()
+        alias_event = self.resolver.add_alias(created.entity_id, "email", "rt@example.com")[0]
+        entity_alias = entities_module.EntityAliasAdded.from_dict(alias_event.payload)
+        self.assertEqual(entity_alias.alias, "rt@example.com")
+
+
+if __name__ == "__main__":
+    unittest.main()

metaspn_entities-0.1.0/metaspn_entities/events.py

@@ -1,49 +0,0 @@
-from __future__ import annotations
-
-from dataclasses import dataclass
-from typing import Any, Dict
-
-
-@dataclass(frozen=True)
-class EmittedEvent:
-    event_type: str
-    payload: Dict[str, Any]
-
-
-class EventFactory:
-    @staticmethod
-    def entity_resolved(entity_id: str, identifier_type: str, value: str, confidence: float, created_new_entity: bool) -> EmittedEvent:
-        return EmittedEvent(
-            event_type="EntityResolved",
-            payload={
-                "entity_id": entity_id,
-                "identifier_type": identifier_type,
-                "value": value,
-                "confidence": confidence,
-                "created_new_entity": created_new_entity,
-            },
-        )
-
-    @staticmethod
-    def entity_merged(from_entity_id: str, to_entity_id: str, reason: str, caused_by: str) -> EmittedEvent:
-        return EmittedEvent(
-            event_type="EntityMerged",
-            payload={
-                "from_entity_id": from_entity_id,
-                "to_entity_id": to_entity_id,
-                "reason": reason,
-                "caused_by": caused_by,
-            },
-        )
-
-    @staticmethod
-    def entity_alias_added(entity_id: str, identifier_type: str, normalized_value: str, caused_by: str) -> EmittedEvent:
-        return EmittedEvent(
-            event_type="EntityAliasAdded",
-            payload={
-                "entity_id": entity_id,
-                "identifier_type": identifier_type,
-                "normalized_value": normalized_value,
-                "caused_by": caused_by,
-            },
-        )