Move global variables from url.py to defaults

Signed-off-by: Saurav Tiwary <[email protected]>

Author: Saurav Tiwary

imagekitio/constants/defaults.py

@@ -9,4 +9,11 @@ class Default(enum.Enum):
         QUERY_TRANSFORMATION_POSITION,
     ]
     DEFAULT_TIMESTAMP = 9999999999
+    SDK_VERSION_PARAMETER = "ik-sdk-version"
     SDK_VERSION = "python-2.2.4"
+    TRANSFORMATION_PARAMETER = "tr"
+    CHAIN_TRANSFORM_DELIMITER = ":"
+    TRANSFORM_DELIMITER = ","
+    TRANSFORM_KEY_VALUE_DELIMITER = "-"
+    SIGNATURE_PARAMETER = "ik-s"
+    TIMESTAMP_PARAMETER = "ik-t"

imagekitio/url.py

@@ -11,16 +11,6 @@
 
 from .constants import ERRORS
 
-TRANSFORMATION_PARAMETER = "tr"
-DEFAULT_TRANSFORMATION_POSITION = "path"
-QUERY_TRANSFORMATION_POSITION = "query"
-CHAIN_TRANSFORM_DELIMITER = ":"
-TRANSFORM_DELIMITER = ","
-TRANSFORM_KEY_VALUE_DELIMITER = "-"
-
-SIGNATURE_PARAMETER = "ik-s"
-TIMESTAMP_PARAMETER = "ik-t"
-
 
 class Url:
     """
@@ -46,7 +36,7 @@ def build_url(self, options: dict) -> str:
         src = options.get("src", "").strip("/")
         url_endpoint = options.get("url_endpoint", "").strip("/")
         transformation_str = self.transformation_to_str(options.get("transformation"))
-        transformation_position = options.get("transformation_position", DEFAULT_TRANSFORMATION_POSITION)
+        transformation_position = options.get("transformation_position", Default.DEFAULT_TRANSFORMATION_POSITION.value)
 
         if transformation_position not in Default.VALID_TRANSFORMATION_POSITION.value:
             raise ValueError(ERRORS.INVALID_TRANSFORMATION_POSITION.value)
@@ -59,7 +49,7 @@ def build_url(self, options: dict) -> str:
             if transformation_position == "path":
                 temp_url = "{}/{}:{}/{}".format(
                     url_endpoint,
-                    TRANSFORMATION_PARAMETER,
+                    Default.TRANSFORMATION_PARAMETER.value,
                     transformation_str.strip("/"),
                     path
                 )
@@ -71,15 +61,15 @@ def build_url(self, options: dict) -> str:
         else:
             temp_url = src
             # if src parameter is used, then we force transformation position in query
-            transformation_position = QUERY_TRANSFORMATION_POSITION
+            transformation_position = Default.QUERY_TRANSFORMATION_POSITION.value
 
         url_object = urlparse(temp_url)
 
         query_params = dict(parse_qsl(url_object.query))
         query_params.update(options.get("query_parameters", {}))
-        if transformation_position == QUERY_TRANSFORMATION_POSITION:
-            query_params.update({"tr": transformation_str})
-        query_params.update({"ik-sdk-version": Default.SDK_VERSION.value})
+        if transformation_position == Default.QUERY_TRANSFORMATION_POSITION.value:
+            query_params.update({Default.TRANSFORMATION_PARAMETER.value: transformation_str})
+        query_params.update({Default.SDK_VERSION_PARAMETER.value: Default.SDK_VERSION.value})
 
         # Update query params in the url
         url_object = url_object._replace(query=urlencode(query_params))
@@ -103,9 +93,9 @@ def build_url(self, options: dict) -> str:
             If not present, then no ik-t parameter and the value 9999999999 is used.
             """
             if expire_seconds:
-                query_params.update({TIMESTAMP_PARAMETER: expiry_timestamp, SIGNATURE_PARAMETER: url_signature})
+                query_params.update({Default.TIMESTAMP_PARAMETER.value: expiry_timestamp, Default.SIGNATURE_PARAMETER.value: url_signature})
             else:
-                query_params.update({SIGNATURE_PARAMETER: url_signature})
+                query_params.update({Default.SIGNATURE_PARAMETER.value: url_signature})
 
             # Update signature related query params
             url_object = url_object._replace(query=urlencode(query_params))
@@ -191,12 +181,12 @@ def transformation_to_str(transformation):
                     parsed_transform_step.append(
                         "{}{}{}".format(
                             transform_key,
-                            TRANSFORM_KEY_VALUE_DELIMITER,
+                            Default.TRANSFORM_KEY_VALUE_DELIMITER.value,
                             transformation[i][key],
                         )
                     )
 
             parsed_transforms.append(
-                TRANSFORM_DELIMITER.join(parsed_transform_step))
+                Default.TRANSFORM_DELIMITER.value.join(parsed_transform_step))
 
-        return CHAIN_TRANSFORM_DELIMITER.join(parsed_transforms)
+        return Default.CHAIN_TRANSFORM_DELIMITER.value.join(parsed_transforms)

imagekitio/utils/formatter.py

@@ -31,6 +31,8 @@ def request_formatter(data: dict) -> dict:
 
 
 def camel_dict_to_snake_dict(data: dict) -> dict:
+    """Convert the keys of dictionary from camel case to snake case
+    """
     return {camel_to_snake(key): val for key, val in data.items()}
 
 

tests/test_generate_url.py

@@ -192,7 +192,7 @@ def test_generate_url_with_path_and_signed_in_proper_form(self):
         }
 
         url = self.client.url(options)
-        self.assertIn("ik-s", url)
+        self.assertIn(Default.SIGNATURE_PARAMETER.value, url)
 
     def test_generate_url_signed_without_expiry_does_not_have_timestamp_parameter(self):
         """
@@ -205,7 +205,7 @@ def test_generate_url_signed_without_expiry_does_not_have_timestamp_parameter(se
         }
 
         url = self.client.url(options)
-        self.assertNotIn("ik-t", url)
+        self.assertNotIn(Default.TIMESTAMP_PARAMETER.value, url)
 
     def test_url_with_new_transformation_returns_as_it_is(self):
         options = {