rename audit log to audit trail (#14)

* rename audit log to audit trail

* bump version

Author: maxchehab

tests/test_audit_log.py

@@ -5,15 +5,15 @@
 import pytest
 
 import workos
-from workos.audit_log import AuditLog
+from workos.audit_trail import AuditTrail
 
 
 class TestSSO(object):
     @pytest.fixture(autouse=True)
     def setup(self, set_api_key_and_project_id):
-        self.audit_log = AuditLog()
+        self.audit_trail = AuditTrail()
 
-    def test_create_audit_log_event_succeeds(self, mock_request_method):
+    def test_create_audit_trail_event_succeeds(self, mock_request_method):
         event = {
             "group": "Terrace House",
             "location": "1.1.1.1",
@@ -29,10 +29,10 @@ def test_create_audit_log_event_succeeds(self, mock_request_method):
         mock_response = Response()
         mock_response.status_code = 200
         mock_request_method("post", mock_response, 200)
-        response = self.audit_log.create_event(event)
+        response = self.audit_trail.create_event(event)
         assert response.status_code == 200
 
-    def test_create_audit_log_event_fails_with_long_metadata(self):
+    def test_create_audit_trail_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 = {
@@ -47,4 +47,4 @@ def test_create_audit_log_event_fails_with_long_metadata(self):
                 "occurred_at": datetime.utcnow().isoformat(),
                 "metadata": metadata,
             }
-            self.audit_log.create_event(event)
+            self.audit_trail.create_event(event)

tests/test_client.py

@@ -8,13 +8,13 @@ class TestClient(object):
     @pytest.fixture(autouse=True)
     def setup(self):
         client._sso = None
-        client._audit_log = None
+        client._audit_trail = 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)
+        assert bool(client.audit_trail)
 
     def test_initialize_sso_missing_api_key(self, set_project_id):
         with pytest.raises(ConfigurationException) as ex:
@@ -42,9 +42,9 @@ def test_initialize_sso_missing_api_key_and_project_id(self):
 
         assert all(setting in message for setting in ("api_key", "project_id",))
 
-    def test_initialize_audit_log_missing_api_key(self):
+    def test_initialize_audit_trail_missing_api_key(self):
         with pytest.raises(ConfigurationException) as ex:
-            client.audit_log
+            client.audit_trail
 
         message = str(ex)
 

workos/__about__.py

@@ -12,7 +12,7 @@
 
 __package_url__ = "https://github.com/workos-inc/workos-python"
 
-__version__ = "0.1.1"
+__version__ = "0.2.0"
 
 __author__ = "WorkOS"
 

workos/audit_log.py workos/audit_trail.pyworkos/audit_log.py renamed to workos/audit_trail.py

@@ -1,16 +1,16 @@
 import workos
 from workos.exceptions import ConfigurationException
 from workos.utils.request import RequestHelper, REQUEST_METHOD_POST
-from workos.utils.validation import AUDIT_LOG_MODULE, validate_settings
+from workos.utils.validation import AUDIT_TRAIL_MODULE, validate_settings
 
 EVENTS_PATH = "events"
 METADATA_LIMIT = 50
 
 
-class AuditLog(object):
-    """Offers methods through the WorkOS Audit Log service."""
+class AuditTrail(object):
+    """Offers methods through the WorkOS Audit Trail service."""
 
-    @validate_settings(AUDIT_LOG_MODULE)
+    @validate_settings(AUDIT_TRAIL_MODULE)
     def __init__(self):
         pass
 
@@ -21,7 +21,7 @@ def request_helper(self):
         return self._request_helper
 
     def create_event(self, event, idempotency_key=None):
-        """Create an Audit Log event.
+        """Create an Audit Trail event.
 
         Args:
             event (dict) - An event object

workos/client.py

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

workos/utils/validation.py

@@ -3,11 +3,11 @@
 import workos
 from workos.exceptions import ConfigurationException
 
-AUDIT_LOG_MODULE = "AuditLog"
+AUDIT_TRAIL_MODULE = "AuditTrail"
 SSO_MODULE = "SSO"
 
 REQUIRED_SETTINGS_FOR_MODULE = {
-    AUDIT_LOG_MODULE: ["api_key",],
+    AUDIT_TRAIL_MODULE: ["api_key",],
     SSO_MODULE: ["api_key", "project_id",],
 }