Add agent package (#108)

Author: jasper-elimity

.pydocstyle.ini

@@ -0,0 +1,2 @@
+[pydocstyle]
+match = (?!(test)?_).*\.py

mypy.ini

@@ -1,3 +1,4 @@
 [mypy]
 disallow_any_explicit = True
+enable_recursive_aliases = True
 strict = True

poetry.lock

@@ -27,4 +27,8 @@ mypy = "^0.981"
 types-python-dateutil = "^2.8.19"
 types-requests = "^2.28.11"
 types-simplejson = "^3.17.7"
+pytest = "^7.1.3"
+hypothesis = "^6.54.6"
+jsonschema = "^4.16.0"
+types-jsonschema = "^4.16.1"
 

pyproject.toml

@@ -7,7 +7,6 @@
 
 from elimity_insights_client._elimity_insights_client import (
     AttributeAssignment,
-    AttributeType,
     BooleanValue,
     Certificate,
     Client,
@@ -17,18 +16,21 @@
     DateTimeValue,
     DateValue,
     DomainGraph,
-    DomainGraphSchema,
     Entity,
-    EntityType,
     Level,
     NumberValue,
     Relationship,
-    RelationshipAttributeType,
     StringValue,
     TimeValue,
-    Type,
     Value,
 )
+from elimity_insights_client._domain_graph_schema import (
+    AttributeType,
+    DomainGraphSchema,
+    EntityType,
+    RelationshipAttributeType,
+    Type,
+)
 
 __all__ = [
     "AttributeAssignment",

src/elimity_insights_client/__init__.py

@@ -0,0 +1,120 @@
+from typing import List
+
+from typing_extensions import TypedDict, NotRequired
+
+from elimity_insights_client._domain_graph_schema import (
+    DomainGraphSchema,
+    AttributeType,
+    RelationshipAttributeType,
+    EntityType,
+    Type,
+)
+from elimity_insights_client._util import map_list
+
+AttributeTypeDict = TypedDict(
+    "AttributeTypeDict",
+    {
+        "archived": bool,
+        "description": str,
+        "entityTypeId": str,
+        "id": str,
+        "name": str,
+        "type": str,
+    },
+)
+EntityTypeDict = TypedDict(
+    "EntityTypeDict",
+    {
+        "anonymized": bool,
+        "icon": str,
+        "id": str,
+        "plural": str,
+        "singular": str,
+    },
+)
+RelationshipAttributeTypeDict = TypedDict(
+    "RelationshipAttributeTypeDict",
+    {
+        "archived": bool,
+        "childType": str,
+        "description": NotRequired[str],
+        "id": str,
+        "name": str,
+        "parentType": str,
+        "type": str,
+    },
+)
+DomainGraphSchemaDict = TypedDict(
+    "DomainGraphSchemaDict",
+    {
+        "entityAttributeTypes": List[AttributeTypeDict],
+        "entityTypes": List[EntityTypeDict],
+        "relationshipAttributeTypes": List[RelationshipAttributeTypeDict],
+    },
+)
+
+
+def decode_domain_graph_schema(json: DomainGraphSchemaDict) -> DomainGraphSchema:
+    """Decode the given JSON value to a domain graph schema."""
+    attribute_types = json["entityAttributeTypes"]
+    attribute_types_ = map_list(_decode_attribute_type, attribute_types)
+    entity_types = json["entityTypes"]
+    entity_types_ = map_list(_decode_entity_type, entity_types)
+    relationship_attribute_types = json["relationshipAttributeTypes"]
+    relationship_attribute_types_ = map_list(
+        _decode_relationship_attribute_types, relationship_attribute_types
+    )
+    return DomainGraphSchema(
+        attribute_types_, entity_types_, relationship_attribute_types_
+    )
+
+
+def _decode_attribute_type(json: AttributeTypeDict) -> AttributeType:
+    archived = json["archived"]
+    description = json["description"]
+    entity_type = json["entityTypeId"]
+    id_ = json["id"]
+    name = json["name"]
+    type_ = json["type"]
+    type__ = _decode_type(type_)
+    return AttributeType(archived, description, entity_type, id_, name, type__)
+
+
+def _decode_entity_type(json: EntityTypeDict) -> EntityType:
+    anonymized = json["anonymized"]
+    icon = json["icon"]
+    id = json["id"]
+    plural = json["plural"]
+    singular = json["singular"]
+    return EntityType(anonymized, icon, id, plural, singular)
+
+
+def _decode_relationship_attribute_types(
+    json: RelationshipAttributeTypeDict,
+) -> RelationshipAttributeType:
+    archived = json["archived"]
+    description = json.get("description", "")
+    from_entity_type = json["parentType"]
+    id_ = json["id"]
+    name = json["name"]
+    to_entity_type = json["childType"]
+    type_ = json["type"]
+    type__ = _decode_type(type_)
+    return RelationshipAttributeType(
+        archived, description, from_entity_type, id_, name, to_entity_type, type__
+    )
+
+
+def _decode_type(json: str) -> Type:
+    if json == "boolean":
+        return Type.BOOLEAN
+    elif json == "date":
+        return Type.DATE
+    elif json == "dateTime":
+        return Type.DATE_TIME
+    elif json == "number":
+        return Type.NUMBER
+    elif json == "string":
+        return Type.STRING
+    else:
+        return Type.TIME

src/elimity_insights_client/_decode_domain_graph_schema.py

@@ -0,0 +1,59 @@
+from dataclasses import dataclass
+from enum import Enum, auto
+from typing import List
+
+
+@dataclass
+class AttributeType:
+    """Attribute type for an entity type."""
+
+    archived: bool
+    description: str
+    entity_type: str
+    id: str
+    name: str
+    type: "Type"
+
+
+@dataclass
+class DomainGraphSchema:
+    """Schema determining valid domain graphs."""
+
+    attribute_types: List[AttributeType]
+    entity_types: List["EntityType"]
+    relationship_attribute_types: List["RelationshipAttributeType"]
+
+
+@dataclass
+class EntityType:
+    """Type of an entity."""
+
+    anonymized: bool
+    icon: str
+    id: str
+    plural: str
+    singular: str
+
+
+@dataclass
+class RelationshipAttributeType:
+    """Attribute type for relationships between entities of specific types."""
+
+    archived: bool
+    description: str
+    from_entity_type: str
+    id: str
+    name: str
+    to_entity_type: str
+    type: "Type"
+
+
+class Type(Enum):
+    """Type of an attribute type, determining valid assignment values."""
+
+    BOOLEAN = auto()
+    DATE = auto()
+    DATE_TIME = auto()
+    NUMBER = auto()
+    STRING = auto()
+    TIME = auto()