Explicit coverage over creation of parameterized URLs (#256)

* Explicit coverage over creation of parameterized URLs

* black .

* Update request.py

* Update request.py

Author: amadeo-workos

tests/utils/test_requests.py

@@ -149,3 +149,10 @@ def test_request_parses_json_when_encoding_in_content_type(
         )
 
         assert RequestHelper().request("ok_place") == {"foo": "bar"}
+
+    def test_build_url(self):
+        assert RequestHelper().build_parameterized_url("a/b/c") == "a/b/c"
+        assert RequestHelper().build_parameterized_url("a/{b}/c", b="b") == "a/b/c"
+        assert (
+            RequestHelper().build_parameterized_url("a/{b}/c", b="test") == "a/test/c"
+        )

workos/mfa.py

@@ -106,8 +106,9 @@ def get_factor(
             raise ValueError("Incomplete arguments. Need to specify a factor ID")
 
         response = self.request_helper.request(
-            "auth/factors/{authentication_factor_id}".format(
-                authentication_factor_id=authentication_factor_id
+            self.request_helper.build_parameterized_url(
+                "auth/factors/{authentication_factor_id}",
+                authentication_factor_id=authentication_factor_id,
             ),
             method=REQUEST_METHOD_GET,
             token=workos.api_key,
@@ -137,8 +138,9 @@ def delete_factor(
             raise ValueError("Incomplete arguments. Need to specify a factor ID.")
 
         return self.request_helper.request(
-            "auth/factors/{authentication_factor_id}".format(
-                authentication_factor_id=authentication_factor_id
+            self.request_helper.build_parameterized_url(
+                "auth/factors/{authentication_factor_id}",
+                authentication_factor_id=authentication_factor_id,
             ),
             method=REQUEST_METHOD_DELETE,
             token=workos.api_key,
@@ -169,8 +171,8 @@ def challenge_factor(
             )
 
         response = self.request_helper.request(
-            "auth/factors/{factor_id}/challenge".format(
-                factor_id=authentication_factor_id
+            self.request_helper.build_parameterized_url(
+                "auth/factors/{factor_id}/challenge", factor_id=authentication_factor_id
             ),
             method=REQUEST_METHOD_POST,
             params=params,
@@ -228,8 +230,9 @@ def verify_challenge(
             )
 
         response = self.request_helper.request(
-            "auth/challenges/{challenge_id}/verify".format(
-                challenge_id=authentication_challenge_id
+            self.request_helper.build_parameterized_url(
+                "auth/challenges/{challenge_id}/verify",
+                challenge_id=authentication_challenge_id,
             ),
             method=REQUEST_METHOD_POST,
             params=params,

workos/utils/request.py

@@ -1,6 +1,7 @@
 import platform
 
 import requests
+import urllib
 
 import workos
 from workos.exceptions import (
@@ -45,6 +46,10 @@ def set_base_api_url(self, base_api_url):
     def generate_api_url(self, path):
         return self.base_api_url.format(path)
 
+    def build_parameterized_url(self, url, **params):
+        escaped_params = {k: urllib.parse.quote(str(v)) for k, v in params.items()}
+        return url.format(**escaped_params)
+
     def request(
         self,
         path,