Merge pull request #355 from rubenhesselink/add-testmode-to-body-instead-of-query-param

Make sure testmode is added to the body on all http_methods except GET

Author: geertjanvdenbosch

mollie/api/client.py

@@ -159,33 +159,53 @@ def _format_request_data(
         path: str,
         data: Optional[Dict[str, Any]],
         params: Optional[Dict[str, Any]],
+        http_method: str,
     ) -> Tuple[str, str, Optional[Dict[str, Any]]]:
         if path.startswith(f"{self.api_endpoint}/{self.api_version}"):
             url = path
         else:
             url = f"{self.api_endpoint}/{self.api_version}/{path}"
 
+        params = params or {}
+        data = data or {}
+        params, data = self._build_request_params_and_data(params, data, http_method)
+
+        querystring = generate_querystring(params)
+        if querystring:
+            url += "?" + querystring
+            params = None
+
         payload = ""
         if data is not None:
             try:
                 payload = json.dumps(data)
             except TypeError as err:
                 raise RequestSetupError(f"Error encoding data into JSON: {err}.")
 
-        if params is None:
-            params = {}
-        if self.testmode and "testmode" not in params:
-            if not (self.api_key.startswith("access_") or hasattr(self, "_oauth_client")):
-                raise RequestSetupError("Configuring testmode only works with access_token or OAuth authorization")
-            params["testmode"] = "true"
-
-        querystring = generate_querystring(params)
-        if querystring:
-            url += "?" + querystring
-            params = None
-
         return url, payload, params
 
+    def _is_valid_testmode(self):
+        """Check if the testmode can be configured."""
+        if not self.api_key.startswith("access_") and not hasattr(self, "_oauth_client"):
+            raise RequestSetupError("Configuring testmode only works with access_token or OAuth authorization")
+
+    def _build_request_params_and_data(
+        self, params: Dict[str, Any], data: Dict[str, Any], http_method: str
+    ) -> Tuple[Dict[str, Any], Dict[str, Any]]:
+        if http_method == "GET":
+            if self.testmode and "testmode" not in params:
+                self._is_valid_testmode()
+                params["testmode"] = "true"
+        else:
+            if self.testmode and "testmode" not in data:
+                self._is_valid_testmode()
+                data["testmode"] = "true"
+            if "testmode" in params:
+                self._is_valid_testmode()
+                testmode = params.pop("testmode")
+                data["testmode"] = testmode
+        return params, data
+
     def _perform_http_call_apikey(
         self,
         http_method: str,
@@ -202,7 +222,7 @@ def _perform_http_call_apikey(
             self._client.verify = True
             self._setup_retry()
 
-        url, payload, params = self._format_request_data(path, data, params)
+        url, payload, params = self._format_request_data(path, data, params, http_method)
         try:
             headers = {
                 "Accept": "application/json",
@@ -236,7 +256,7 @@ def _perform_http_call_oauth(
         params: Optional[Dict[str, Any]] = None,
         idempotency_key: str = "",
     ) -> requests.Response:
-        url, payload, params = self._format_request_data(path, data, params)
+        url, payload, params = self._format_request_data(path, data, params, http_method)
         try:
             headers = {
                 "Accept": "application/json",

tests/test_api_client.py

@@ -530,3 +530,22 @@ def test_update_customer_bad_request(client, response):
         )
 
     assert exc.value.idempotency_key == "test_idempotency_key"
+
+
+@pytest.mark.parametrize(
+    "params, data, http_method, testmode, expected_return_value",
+    [
+        ({}, {}, "GET", True, ({"testmode": "true"}, {})),
+        ({}, {}, "GET", False, ({}, {})),
+        ({}, {}, "POST", True, ({}, {"testmode": "true"})),
+        ({"testmode": "true"}, {}, "POST", True, ({}, {"testmode": "true"})),
+        ({}, {"testmode": "true"}, "POST", True, ({}, {"testmode": "true"})),
+        ({}, {}, "POST", False, ({}, {})),
+        ({"testmode": "true"}, {}, "POST", False, ({}, {"testmode": "true"})),
+        ({}, {"testmode": "true"}, "POST", False, ({}, {"testmode": "true"})),
+    ],
+)
+def test_build_request_params_and_data(oauth_client, params, data, http_method, testmode, expected_return_value):
+    oauth_client.testmode = testmode
+    return_value = oauth_client._build_request_params_and_data(params, data, http_method)
+    assert return_value == expected_return_value