Merge pull request #45 from elimity-com/feature/44-new-connector-framework

Support endpoints for new connector framework

Author: jdeflander

README.md

@@ -5,7 +5,7 @@ Insights server.
 
 ## Usage
 
-```python
+```python3
 from datetime import datetime
 
 from elimity_insights_client import Client, Config, ConnectorLog, Level
@@ -30,4 +30,5 @@ $ pip install git+https://github.com/elimity-com/insights-client-python.git
 
 | Client version | Insights version |
 | -------------- | ---------------- |
-| 1              | ^2.8             |
+| 1              | 2.8 - 2.10       |
+| 2              | ^2.11            |

elimity_insights_client.py

@@ -27,16 +27,6 @@ class AttributeAssignment:
     value: "Value"
 
 
-@dataclass
-class AttributeType:
-    """Attribute type for an entity type."""
-
-    description: str
-    entity_type: str
-    name: str
-    type: "Type"
-
-
 @dataclass
 class BooleanValue:
     """Value to assign for a boolean attribute type."""
@@ -59,27 +49,15 @@ def __init__(self, config: "Config") -> None:
         """Return a new client with the given configuration."""
         self._config = config
 
-    def create_attribute_type(self, type_: AttributeType) -> None:
-        """Create a new attribute type."""
-        body = _encode_attribute_type(type_)
-        self._post(body, "attributeTypes")
-
     def create_connector_logs(self, logs: Iterable["ConnectorLog"]) -> None:
         """Create connector logs."""
         body = map(_encode_connector_log, logs)
-        self._post(body, "connectorLogs")
-
-    def create_relationship_attribute_type(
-        self, type_: "RelationshipAttributeType"
-    ) -> None:
-        """Create a new relationship attribute type."""
-        body = _encode_relationship_attribute_type(type_)
-        self._post(body, "relationshipAttributeTypes")
+        self._post(body, "custom-connector-logs")
 
     def reload_domain_graph(self, graph: "DomainGraph") -> None:
         """Reload a domain graph."""
         body = _encode_domain_graph(graph)
-        self._post(body, "domain-graph/reload")
+        self._post(body, "custom-connector-domain-graphs")
 
     def _post(self, body: Any, path: str) -> None:
         data = _encode(body)
@@ -176,17 +154,6 @@ class Relationship:
     to_entity_type: str
 
 
-@dataclass
-class RelationshipAttributeType:
-    """Attribute type for relationships between entities of specific types."""
-
-    description: str
-    from_entity_type: str
-    name: str
-    to_entity_type: str
-    type: "Type"
-
-
 @dataclass
 class StringValue:
     """Value to assign for a string attribute type."""
@@ -201,17 +168,6 @@ class TimeValue:
     value: time
 
 
-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()
-
-
 Value = Union[
     BooleanValue, DateValue, DateTimeValue, NumberValue, StringValue, TimeValue
 ]
@@ -249,16 +205,6 @@ def _encode_attribute_assignment(assignment: AttributeAssignment) -> Any:
     }
 
 
-def _encode_attribute_type(type_: AttributeType) -> Any:
-    type__ = _encode_type(type_.type)
-    return {
-        "category": type_.entity_type,
-        "description": type_.description,
-        "name": type_.name,
-        "type": type__,
-    }
-
-
 def _encode_bool(bool_: bool) -> Any:
     return "true" if bool_ else "false"
 
@@ -327,17 +273,6 @@ def _encode_relationship(relationship: Relationship) -> Any:
     }
 
 
-def _encode_relationship_attribute_type(type_: RelationshipAttributeType) -> Any:
-    type__ = _encode_type(type_.type)
-    return {
-        "childType": type_.to_entity_type,
-        "description": type_.description,
-        "name": type_.name,
-        "parentType": type_.from_entity_type,
-        "type": type__,
-    }
-
-
 def _encode_time(time_: time) -> Any:
     datetime_ = datetime(
         2000, 1, 1, time_.hour, time_.minute, time_.second, tzinfo=time_.tzinfo,
@@ -346,21 +281,6 @@ def _encode_time(time_: time) -> Any:
     return f"{datetime__:%H:%M:%S}Z"
 
 
-def _encode_type(type_: Type) -> Any:
-    if type_ == Type.BOOLEAN:
-        return "boolean"
-    elif type_ == Type.DATE:
-        return "date"
-    elif type_ == Type.DATE_TIME:
-        return "dateTime"
-    elif type_ == Type.NUMBER:
-        return "number"
-    elif type_ == Type.STRING:
-        return "string"
-    else:
-        return "time"
-
-
 def _encode_value(value: Value) -> Any:
     if isinstance(value, BooleanValue):
         boolean_value = _encode_bool(value.value)

test_elimity_insights_client.py

@@ -15,9 +15,6 @@
 from elimity_insights_client import (
     Client,
     Config,
-    AttributeType,
-    Type,
-    RelationshipAttributeType,
     Relationship,
     Entity,
     DomainGraph,
@@ -34,13 +31,6 @@
 
 
 class TestClient(TestCase):
-    def test_create_attribute_type(self) -> None:
-        type_ = AttributeType(
-            description="foo", entity_type="bar", name="baz", type=Type.BOOLEAN
-        )
-        with _create_client(_CreateAttributeTypeHandler) as client:
-            client.create_attribute_type(type_)
-
     def test_create_connector_logs(self) -> None:
         logs = [
             ConnectorLog(
@@ -58,17 +48,6 @@ def test_create_connector_logs(self) -> None:
         with _create_client(_CreateConnectorLogsHandler) as client:
             client.create_connector_logs(logs_iter)
 
-    def test_create_relationship_attribute_type(self) -> None:
-        type_ = RelationshipAttributeType(
-            description="foo",
-            from_entity_type="bar",
-            name="baz",
-            to_entity_type="asd",
-            type=Type.DATE_TIME,
-        )
-        with _create_client(_CreateRelationshipAttributeTypeHandler) as client:
-            client.create_relationship_attribute_type(type_)
-
     def test_encode_datetime(self) -> None:
         # use pre-epoch local timestamp to trigger https://bugs.python.org/issue36759
         timestamp = datetime(1969, 1, 1)
@@ -164,37 +143,11 @@ def _decode(chunked: BinaryIO) -> Any:
     return loads(serialized)
 
 
-class _CreateAttributeTypeHandler(BaseHTTPRequestHandler):
-    protocol_version = "HTTP/1.1"
-
-    def do_POST(self) -> None:
-        if self.path != "/attributeTypes":
-            self.send_error(HTTPStatus.NOT_FOUND)
-            return
-
-        expected = {
-            "category": "bar",
-            "description": "foo",
-            "name": "baz",
-            "type": "boolean",
-        }
-        actual = _decode(self.rfile)
-        if expected != actual:
-            self.send_error(HTTPStatus.BAD_REQUEST)
-            return
-
-        self.send_response(HTTPStatus.NO_CONTENT)
-        self.end_headers()
-
-    def log_message(self, format, *args):
-        pass
-
-
 class _CreateConnectorLogsHandler(BaseHTTPRequestHandler):
     protocol_version = "HTTP/1.1"
 
     def do_POST(self) -> None:
-        if self.path != "/connectorLogs":
+        if self.path != "/custom-connector-logs":
             self.send_error(HTTPStatus.NOT_FOUND)
             return
 
@@ -222,33 +175,6 @@ def log_message(self, format, *args):
         pass
 
 
-class _CreateRelationshipAttributeTypeHandler(BaseHTTPRequestHandler):
-    protocol_version = "HTTP/1.1"
-
-    def do_POST(self) -> None:
-        if self.path != "/relationshipAttributeTypes":
-            self.send_error(HTTPStatus.NOT_FOUND)
-            return
-
-        expected = {
-            "childType": "asd",
-            "description": "foo",
-            "name": "baz",
-            "parentType": "bar",
-            "type": "dateTime",
-        }
-        actual = _decode(self.rfile)
-        if expected != actual:
-            self.send_error(HTTPStatus.BAD_REQUEST)
-            return
-
-        self.send_response(HTTPStatus.NO_CONTENT)
-        self.end_headers()
-
-    def log_message(self, format, *args) -> None:
-        pass
-
-
 class _EncodeDatetimeHandler(BaseHTTPRequestHandler):
     protocol_version = "HTTP/1.1"
 
@@ -267,7 +193,7 @@ class _ReloadDomainGraphHandler(BaseHTTPRequestHandler):
     protocol_version = "HTTP/1.1"
 
     def do_POST(self) -> None:
-        if self.path != "/domain-graph/reload":
+        if self.path != "/custom-connector-domain-graphs":
             self.send_error(HTTPStatus.NOT_FOUND)
             return