Create client for Audit Logs (#9)

* WIP

* Undo staging url

* Re-factor validation to a decorator

* Add unit tests to client

* Fix formatting

* Re-factor per PR feedback

* Fix formatting

Author: Rohan Jadvani

tests/test_audit_log.py

@@ -0,0 +1,50 @@
+from datetime import datetime
+import json
+from requests import Response
+
+import pytest
+
+import workos
+from workos.audit_log import AuditLog
+
+
+class TestSSO(object):
+    @pytest.fixture(autouse=True)
+    def setup(self, set_api_key_and_project_id):
+        self.audit_log = AuditLog()
+
+    def test_create_audit_log_event_succeeds(self, mock_request_method):
+        event = {
+            "group": "Terrace House",
+            "location": "1.1.1.1",
+            "action": "house.created",
+            "action_type": "C",
+            "actor_name": "Daiki Miyagi",
+            "actor_id": "user_12345",
+            "target_name": "Ryota Yamasato",
+            "target_id": "user_67890",
+            "occurred_at": datetime.utcnow().isoformat(),
+            "metadata": {"a": "b"},
+        }
+        mock_response = Response()
+        mock_response.status_code = 200
+        mock_request_method("post", mock_response, 200)
+        response = self.audit_log.create_event(event)
+        assert response.status_code == 200
+
+    def test_create_audit_log_event_fails_with_long_metadata(self):
+        with pytest.raises(Exception, match=r"Number of metadata keys exceeds .*"):
+            metadata = {str(num): num for num in range(51)}
+            event = {
+                "group": "Terrace House",
+                "location": "1.1.1.1",
+                "action": "house.created",
+                "action_type": "C",
+                "actor_name": "Daiki Miyagi",
+                "actor_id": "user_12345",
+                "target_name": "Ryota Yamasato",
+                "target_id": "user_67890",
+                "occurred_at": datetime.utcnow().isoformat(),
+                "metadata": metadata,
+            }
+            self.audit_log.create_event(event)

tests/test_client.py

@@ -8,10 +8,14 @@ class TestClient(object):
     @pytest.fixture(autouse=True)
     def setup(self):
         client._sso = None
+        client._audit_log = None
 
     def test_initialize_sso(self, set_api_key_and_project_id):
         assert bool(client.sso)
 
+    def test_initialize_audit_log(self, set_api_key_and_project_id):
+        assert bool(client.audit_log)
+
     def test_initialize_sso_missing_api_key(self, set_project_id):
         with pytest.raises(ConfigurationException) as ex:
             client.sso
@@ -37,3 +41,29 @@ def test_initialize_sso_missing_api_key_and_project_id(self):
         message = str(ex)
 
         assert all(setting in message for setting in ("api_key", "project_id",))
+
+    def test_initialize_audit_log_missing_api_key(self, set_project_id):
+        with pytest.raises(ConfigurationException) as ex:
+            client.audit_log
+
+        message = str(ex)
+
+        assert "api_key" in message
+        assert "project_id" not in message
+
+    def test_initialize_audit_log_missing_project_id(self, set_api_key):
+        with pytest.raises(ConfigurationException) as ex:
+            client.audit_log
+
+        message = str(ex)
+
+        assert "project_id" in message
+        assert "api_key" not in message
+
+    def test_initialize_audit_log_missing_api_key_and_project_id(self):
+        with pytest.raises(ConfigurationException) as ex:
+            client.audit_log
+
+        message = str(ex)
+
+        assert all(setting in message for setting in ("api_key", "project_id",))

workos/audit_log.py

@@ -0,0 +1,63 @@
+import workos
+from workos.exceptions import ConfigurationException
+from workos.utils.request import RequestHelper, REQUEST_METHOD_POST
+from workos.utils.validation import validate_api_key_and_project_id
+
+EVENTS_PATH = "events"
+METADATA_LIMIT = 50
+
+
+class AuditLog(object):
+    """Offers methods through the WorkOS Audit Log service."""
+
+    @validate_api_key_and_project_id("Audit Log")
+    def __init__(self):
+        pass
+
+    @property
+    def request_helper(self):
+        if not getattr(self, "_request_helper", None):
+            self._request_helper = RequestHelper()
+        return self._request_helper
+
+    def create_event(self, event, idempotency_key=None):
+        """Create an Audit Log event.
+
+        Args:
+            event (dict) - An event object
+                event[action] (str) - Specific activity performed by the actor.
+                event[action_type] (str) - Corresponding CRUD category of the 
+                    event. Can be one of C, R, U, or D.
+                event[actor_name] (str) - Display name of the entity performing the action
+                event[actor_id] (str) - Unique identifier of the entity performing the action
+                event[group] (str) - A single organization containing related .
+                    members. This will normally be the customer of a vendor's application
+                event[location] (str) - Identifier for where the event 
+                    originated. This will be an IP address (IPv4 or IPv6),
+                    hostname, or device ID.
+                event[occurred_at] (str) - ISO-8601 datetime at which the event
+                    happened, with millisecond precision.
+                event[metadata] (str) - Arbitrary key-value data containing
+                    information associated with the event. Note: There is a limit of 50
+                    keys. Key names can be up to 40 characters long, and values can be up
+                    to 500 characters long.
+                event[target_id] (str) - Unique identifier of the object or
+                    resource being acted upon.
+                event[target_name] (str) - Display name of the object or
+                    resource that is being acted upon.
+            idempotency_key (str) - An idempotency key
+
+        Returns:
+            dict: Response from WorkOS
+        """
+        if len(event.get("metadata", {})) > METADATA_LIMIT:
+            raise Exception("Number of metadata keys exceeds %d." % METADATA_LIMIT)
+
+        headers = {
+            "Authorization": "Bearer %s" % workos.api_key,
+            "idempotency_key": idempotency_key,
+        }
+
+        return self.request_helper.request(
+            EVENTS_PATH, method=REQUEST_METHOD_POST, params=event, headers=headers
+        )

workos/client.py

@@ -1,3 +1,4 @@
+from workos.audit_log import AuditLog
 from workos.sso import SSO
 
 
@@ -10,5 +11,11 @@ def sso(self):
             self._sso = SSO()
         return self._sso
 
+    @property
+    def audit_log(self):
+        if not getattr(self, "_audit_log", None):
+            self._audit_log = AuditLog()
+        return self._audit_log
+
 
 client = Client()

workos/sso.py

@@ -6,6 +6,7 @@
 from workos.exceptions import ConfigurationException
 from workos.resources.sso import WorkOSProfile
 from workos.utils.request import RequestHelper, RESPONSE_TYPE_CODE, REQUEST_METHOD_POST
+from workos.utils.validation import validate_api_key_and_project_id
 
 AUTHORIZATION_PATH = "sso/authorize"
 TOKEN_PATH = "sso/token"
@@ -16,23 +17,9 @@
 class SSO(object):
     """Offers methods to assist in authenticating through the WorkOS SSO service."""
 
+    @validate_api_key_and_project_id("SSO")
     def __init__(self):
-        required_settings = [
-            "api_key",
-            "project_id",
-        ]
-
-        missing_settings = []
-        for setting in required_settings:
-            if not getattr(workos, setting, None):
-                missing_settings.append(setting)
-
-        if missing_settings:
-            raise ConfigurationException(
-                "The following settings are missing for SSO: {}".format(
-                    ", ".join(missing_settings)
-                )
-            )
+        pass
 
     @property
     def request_helper(self):

workos/utils/request.py

@@ -33,7 +33,7 @@ def set_base_api_url(self, base_api_url):
     def generate_api_url(self, path):
         return self.base_api_url.format(path)
 
-    def request(self, path, method=REQUEST_METHOD_GET, params=None):
+    def request(self, path, method=REQUEST_METHOD_GET, params=None, headers=None):
         """Executes a request against the WorkOS API.
 
         Args:
@@ -46,9 +46,16 @@ def request(self, path, method=REQUEST_METHOD_GET, params=None):
         Returns:
             dict: Response from WorkOS
         """
+        if headers is None:
+            headers = {}
+        headers.update(BASE_HEADERS)
         url = self.generate_api_url(path)
 
-        response = getattr(requests, method)(url, headers=BASE_HEADERS, params=params)
+        request_fn = getattr(requests, method)
+        if method == REQUEST_METHOD_GET:
+            response = request_fn(url, headers=headers, params=params)
+        else:
+            response = request_fn(url, headers=headers, data=params)
 
         status_code = response.status_code
         if status_code >= 400 and status_code < 500:

workos/utils/validation.py

@@ -0,0 +1,31 @@
+from functools import wraps
+
+import workos
+from workos.exceptions import ConfigurationException
+
+
+def validate_api_key_and_project_id(module_name):
+    def decorator(fn):
+        @wraps(fn)
+        def wrapper(*args, **kwargs):
+            required_settings = [
+                "api_key",
+                "project_id",
+            ]
+
+            missing_settings = []
+            for setting in required_settings:
+                if not getattr(workos, setting, None):
+                    missing_settings.append(setting)
+
+            if missing_settings:
+                raise ConfigurationException(
+                    "The following settings are missing for {}: {}".format(
+                        ", ".join(missing_settings), module_name
+                    )
+                )
+            return fn(*args, **kwargs)
+
+        return wrapper
+
+    return decorator