Refactor settings validation

Author: Henry Chan

tests/test_client.py

@@ -42,28 +42,10 @@ 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, set_project_id):
+    def test_initialize_audit_log_missing_api_key(self):
         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

@@ -1,7 +1,7 @@
 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
+from workos.utils.validation import AUDIT_LOG_MODULE, validate_settings
 
 EVENTS_PATH = "events"
 METADATA_LIMIT = 50
@@ -10,7 +10,7 @@
 class AuditLog(object):
     """Offers methods through the WorkOS Audit Log service."""
 
-    @validate_api_key_and_project_id("Audit Log")
+    @validate_settings(AUDIT_LOG_MODULE)
     def __init__(self):
         pass
 

workos/sso.py

@@ -7,7 +7,7 @@
 from workos.resources.sso import WorkOSProfile
 from workos.utils.connection_types import ConnectionType
 from workos.utils.request import RequestHelper, RESPONSE_TYPE_CODE, REQUEST_METHOD_POST
-from workos.utils.validation import validate_api_key_and_project_id
+from workos.utils.validation import SSO_MODULE, validate_settings
 
 AUTHORIZATION_PATH = "sso/authorize"
 TOKEN_PATH = "sso/token"
@@ -18,7 +18,7 @@
 class SSO(object):
     """Offers methods to assist in authenticating through the WorkOS SSO service."""
 
-    @validate_api_key_and_project_id("SSO")
+    @validate_settings(SSO_MODULE)
     def __init__(self):
         pass
 

workos/utils/validation.py

@@ -3,18 +3,21 @@
 import workos
 from workos.exceptions import ConfigurationException
 
+AUDIT_LOG_MODULE = "AuditLog"
+SSO_MODULE = "SSO"
 
-def validate_api_key_and_project_id(module_name):
+REQUIRED_SETTINGS_FOR_MODULE = {
+    AUDIT_LOG_MODULE: ["api_key",],
+    SSO_MODULE: ["api_key", "project_id",],
+}
+
+
+def validate_settings(module_name):
     def decorator(fn):
         @wraps(fn)
         def wrapper(*args, **kwargs):
-            required_settings = [
-                "api_key",
-                "project_id",
-            ]
-
             missing_settings = []
-            for setting in required_settings:
+            for setting in REQUIRED_SETTINGS_FOR_MODULE[module_name]:
                 if not getattr(workos, setting, None):
                     missing_settings.append(setting)