chore: remove custom URL encoding

JohnVillalovos · JohnVillalovos · commit ca85f9348daa · 2022-01-08T15:38:05.000-08:00
We were using `str.replace()` calls to take care of URL encoding issues. Switch them to use our `utils.clean_str_id` which itself uses `urllib.parse.quote()` Closes: #1356
diff --git a/gitlab/mixins.py b/gitlab/mixins.py
@@ -100,7 +100,7 @@ def get(
             GitlabGetError: If the server cannot perform the request
         """
         if not isinstance(id, int):
-            id = utils.clean_str_id(id)
+            id = utils._url_encode(id)
         path = f"{self.path}/{id}"
         if TYPE_CHECKING:
             assert self._obj_cls is not None
@@ -444,7 +444,7 @@ def set(self, key: str, value: str, **kwargs: Any) -> base.RESTObject:
         Returns:
             The created/updated attribute
         """
-        path = f"{self.path}/{utils.clean_str_id(key)}"
+        path = f"{self.path}/{utils._url_encode(key)}"
         data = {"value": value}
         server_data = self.gitlab.http_put(path, post_data=data, **kwargs)
         if TYPE_CHECKING:
@@ -478,7 +478,7 @@ def delete(self, id: Union[str, int], **kwargs: Any) -> None:
             path = self.path
         else:
             if not isinstance(id, int):
-                id = utils.clean_str_id(id)
+                id = utils._url_encode(id)
             path = f"{self.path}/{id}"
         self.gitlab.http_delete(path, **kwargs)
 
diff --git a/gitlab/utils.py b/gitlab/utils.py
@@ -15,8 +15,8 @@
 # You should have received a copy of the GNU Lesser General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
+import urllib.parse
 from typing import Any, Callable, Dict, Optional
-from urllib.parse import quote
 
 import requests
 
@@ -56,8 +56,25 @@ def copy_dict(dest: Dict[str, Any], src: Dict[str, Any]) -> None:
             dest[k] = v
 
 
-def clean_str_id(id: str) -> str:
-    return quote(id, safe="")
+def _url_encode(id: str) -> str:
+    """Encode/quote the characters in the string so that they can be used in a path.
+
+    Reference to documentation on why this is necessary.
+
+    https://docs.gitlab.com/ee/api/index.html#namespaced-path-encoding
+
+    If using namespaced API requests, make sure that the NAMESPACE/PROJECT_PATH is
+    URL-encoded. For example, / is represented by %2F
+
+    https://docs.gitlab.com/ee/api/index.html#path-parameters
+
+    Path parameters that are required to be URL-encoded must be followed. If not, it
+    doesn’t match an API endpoint and responds with a 404. If there’s something in front
+    of the API (for example, Apache), ensure that it doesn’t decode the URL-encoded path
+    parameters.
+
+    """
+    return urllib.parse.quote(id, safe="")
 
 
 def remove_none_from_dict(data: Dict[str, Any]) -> Dict[str, Any]:
diff --git a/gitlab/v4/cli.py b/gitlab/v4/cli.py
@@ -75,7 +75,7 @@ def _process_from_parent_attrs(self) -> None:
             if key not in self.args:
                 continue
 
-            self.parent_args[key] = gitlab.utils.clean_str_id(self.args[key])
+            self.parent_args[key] = gitlab.utils._url_encode(self.args[key])
             # If we don't delete it then it will be added to the URL as a query-string
             del self.args[key]
 
diff --git a/gitlab/v4/objects/features.py b/gitlab/v4/objects/features.py
@@ -52,7 +52,8 @@ def set(
         Returns:
             The created/updated attribute
         """
-        path = f"{self.path}/{name.replace('/', '%2F')}"
+        name = utils._url_encode(name)
+        path = f"{self.path}/{name}"
         data = {
             "value": value,
             "feature_group": feature_group,
diff --git a/gitlab/v4/objects/files.py b/gitlab/v4/objects/files.py
@@ -56,7 +56,7 @@ def save(  # type: ignore
         """
         self.branch = branch
         self.commit_message = commit_message
-        self.file_path = self.file_path.replace("/", "%2F")
+        self.file_path = utils._url_encode(self.file_path)
         super(ProjectFile, self).save(**kwargs)
 
     @exc.on_http_error(exc.GitlabDeleteError)
@@ -76,7 +76,7 @@ def delete(  # type: ignore
             GitlabAuthenticationError: If authentication is not correct
             GitlabDeleteError: If the server cannot perform the request
         """
-        file_path = self.get_id().replace("/", "%2F")
+        file_path = utils._url_encode(self.get_id())
         self.manager.delete(file_path, branch, commit_message, **kwargs)
 
 
@@ -144,7 +144,7 @@ def create(
             assert data is not None
         self._check_missing_create_attrs(data)
         new_data = data.copy()
-        file_path = new_data.pop("file_path").replace("/", "%2F")
+        file_path = utils._url_encode(new_data.pop("file_path"))
         path = f"{self.path}/{file_path}"
         server_data = self.gitlab.http_post(path, post_data=new_data, **kwargs)
         if TYPE_CHECKING:
@@ -173,7 +173,7 @@ def update(  # type: ignore
         """
         new_data = new_data or {}
         data = new_data.copy()
-        file_path = file_path.replace("/", "%2F")
+        file_path = utils._url_encode(file_path)
         data["file_path"] = file_path
         path = f"{self.path}/{file_path}"
         self._check_missing_update_attrs(data)
@@ -203,7 +203,8 @@ def delete(  # type: ignore
             GitlabAuthenticationError: If authentication is not correct
             GitlabDeleteError: If the server cannot perform the request
         """
-        path = f"{self.path}/{file_path.replace('/', '%2F')}"
+        file_path = utils._url_encode(file_path)
+        path = f"{self.path}/{file_path}"
         data = {"branch": branch, "commit_message": commit_message}
         self.gitlab.http_delete(path, query_data=data, **kwargs)
 
@@ -238,7 +239,7 @@ def raw(
         Returns:
             The file content
         """
-        file_path = file_path.replace("/", "%2F").replace(".", "%2E")
+        file_path = utils._url_encode(file_path)
         path = f"{self.path}/{file_path}/raw"
         query_data = {"ref": ref}
         result = self.gitlab.http_get(
@@ -265,7 +266,7 @@ def blame(self, file_path: str, ref: str, **kwargs: Any) -> List[Dict[str, Any]]
         Returns:
             A list of commits/lines matching the file
         """
-        file_path = file_path.replace("/", "%2F").replace(".", "%2E")
+        file_path = utils._url_encode(file_path)
         path = f"{self.path}/{file_path}/blame"
         query_data = {"ref": ref}
         result = self.gitlab.http_list(path, query_data, **kwargs)
diff --git a/gitlab/v4/objects/repositories.py b/gitlab/v4/objects/repositories.py
@@ -39,7 +39,7 @@ def update_submodule(
             GitlabPutError: If the submodule could not be updated
         """
 
-        submodule = submodule.replace("/", "%2F")  # .replace('.', '%2E')
+        submodule = utils._url_encode(submodule)
         path = f"/projects/{self.get_id()}/repository/submodules/{submodule}"
         data = {"branch": branch, "commit_sha": commit_sha}
         if "commit_message" in kwargs:
diff --git a/tests/unit/test_utils.py b/tests/unit/test_utils.py
@@ -18,15 +18,20 @@
 from gitlab import utils
 
 
-def test_clean_str_id():
+def test_url_encode():
     src = "nothing_special"
     dest = "nothing_special"
-    assert dest == utils.clean_str_id(src)
+    assert dest == utils._url_encode(src)
 
     src = "foo#bar/baz/"
     dest = "foo%23bar%2Fbaz%2F"
-    assert dest == utils.clean_str_id(src)
+    assert dest == utils._url_encode(src)
 
     src = "foo%bar/baz/"
     dest = "foo%25bar%2Fbaz%2F"
-    assert dest == utils.clean_str_id(src)
+    assert dest == utils._url_encode(src)
+
+    # periods/dots should not be modified
+    src = "docs/README.md"
+    dest = "docs%2FREADME.md"
+    assert dest == utils._url_encode(src)
