Renamed utils.get_file_download_url and corrected broken tests

Author: sgeulette

src/imio/esign/testing.py

@@ -6,6 +6,7 @@
 from plone.app.testing import PLONE_FIXTURE
 from plone.app.testing import PloneSandboxLayer
 from plone.testing import z2
+from zope.globalrequest import setLocal
 
 import imio.esign  # noqa: F401
 
@@ -30,6 +31,7 @@ def setUpZope(self, app, configurationContext):
         self.loadZCML(package=imio.esign)
 
     def setUpPloneSite(self, portal):
+        setLocal("request", portal.REQUEST)
         applyProfile(portal, "imio.annex:default")
         applyProfile(portal, "imio.esign:default")
 

src/imio/esign/tests/test_utils.py

@@ -3,7 +3,7 @@
 from datetime import timedelta
 from imio.esign.testing import IMIO_ESIGN_INTEGRATION_TESTING  # noqa: E501
 from imio.esign.utils import add_files_to_session
-from imio.esign.utils import get_file_uid_url
+from imio.esign.utils import get_file_download_url
 from imio.esign.utils import get_max_download_date
 from imio.esign.utils import get_session_annotation
 from imio.esign.utils import remove_context_from_session
@@ -297,32 +297,32 @@ def test_remove_session(self):
         self.assertEqual(len(annot["c_uids"]), 2)
         self.assertEqual(len(annot["sessions"]), 1)
 
-    def test_get_file_uid_url(self):
+    def test_get_file_download_url(self):
         """Test generating file download URL from UID."""
         uid = "f40682caafc045b4b81973bd82ea9ab6"
         # Test error when no root_url is configured
         with self.assertRaises(Exception) as cm:
-            get_file_uid_url(uid)
+            get_file_download_url(uid)
         self.assertIn("No root URL provided", str(cm.exception))
 
         api.portal.set_registry_record("imio.esign.file_url", "https://downloads.files.com")
 
-        result = get_file_uid_url(uid)
-        self.assertEqual(result, "https://downloads.files.com/Rzgwy-9BVG9-viEts-5GBkn-Rm")
+        result = get_file_download_url(uid)
+        self.assertEqual(result, ("https://downloads.files.com/Rzgwy-9BVG9-viEts-5GBkn-Rm",
+                                  "Rzgwy-9BVG9-viEts-5GBkn-Rm"))
 
-        result = get_file_uid_url(uid, separator="_", block_size=3)
-        self.assertEqual(result, "https://downloads.files.com/Rzg_wy9_BVG_9vi_Ets_5GB_knR_m")
+        result = get_file_download_url(uid, separator="_", block_size=3)
+        self.assertEqual(result[0], "https://downloads.files.com/Rzg_wy9_BVG_9vi_Ets_5GB_knR_m")
 
         custom_url = "https://custom.domain.org/"
-        result = get_file_uid_url(uid, root_url=custom_url)
-        self.assertEqual(result, "https://custom.domain.org/Rzgwy-9BVG9-viEts-5GBkn-Rm")
+        result = get_file_download_url(uid, root_url=custom_url)
+        self.assertEqual(result[0], "https://custom.domain.org/Rzgwy-9BVG9-viEts-5GBkn-Rm")
 
         # Test with another UID to verify encoding works
         uid2 = self.uids[0]
-        result2 = get_file_uid_url(uid2)
-        self.assertTrue(result2.startswith("https://downloads.files.com/"))
-        suid = result2[len("https://downloads.files.com/") :]
-        self.assertEqual(shortuid_decode_id(suid, separator="-"), uid2)  # correctly decoded
+        result2 = get_file_download_url(uid2)
+        self.assertTrue(result2[0].startswith("https://downloads.files.com/"))
+        self.assertEqual(shortuid_decode_id(result2[1], separator="-"), uid2)  # correctly decoded
 
     def test_get_max_download_date(self):
         annex = self.folders[0]

src/imio/esign/utils.py

@@ -384,22 +384,22 @@ def remove_session(session_id):
     # logger.info("Session %s removed", session_id)
 
 
-def get_file_uid_url(uid, separator="-", block_size=5, root_url=None):
+def get_file_download_url(uid, separator="-", block_size=5, root_url=None):
     """Get the file download URL for a given file UID.
 
     :param uid: file UID
     :param separator: separator used in short UID encoding
     :param block_size: block size used in short UID encoding
     :param root_url: root URL. If not provided, the settings value is used
-    :return: file download URL
+    :return: file download URL, short_uid
     """
     if not root_url:
         root_url = get_registry_file_url()
 
     if not root_url:
         raise Exception("No root URL provided for file download url.")
     short_uid = shortuid_encode_id(uid, separator=separator, block_size=block_size)
-    return "{}/{}".format(root_url.strip('/'), short_uid)
+    return "{}/{}".format(root_url.strip('/'), short_uid), short_uid
 
 
 def get_max_download_date(obj, delta=timedelta(days=120)):