Enhancement: clients can use REST url for all methods

examples/api-demo-1-list-projects.py

@@ -23,4 +23,4 @@ def parse_command_line_args():
     print("  Issues Found:")
     print("      High  : %s" % proj.issueCountsBySeverity.high)
     print("      Medium: %s" % proj.issueCountsBySeverity.medium)
-    print("      Low   : %s" % proj.issueCountsBySeverity.low)
+    print("      Low   : %s" % proj.issueCountsBySeverity.low)

snyk/client.py

@@ -1,6 +1,8 @@
+import copy
 import logging
+import re
 import urllib.parse
-from typing import Any, List, Optional
+from typing import Any, Dict, List, Optional, Pattern
 from urllib.parse import parse_qs, urlparse
 
 import requests
@@ -40,13 +42,18 @@ def __init__(
             "Authorization": "token %s" % self.api_token,
             "User-Agent": user_agent,
         }
-        self.api_post_headers = self.api_headers
+        self.api_post_headers = copy.deepcopy(self.api_headers)
         self.api_post_headers["Content-Type"] = "application/json"
+        self.api_patch_headers = copy.deepcopy(self.api_headers)
+        self.api_patch_headers["Content-Type"] = "application/vnd.api+json"
         self.tries = tries
         self.backoff = backoff
         self.delay = delay
         self.verify = verify
         self.version = version
+        self.__uuid_pattern = (
+            r"[0-9a-f]{8}-[0-9a-f]{4}-[4][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}"
+        )
 
         # Ensure we don't have a trailing /
         if self.api_url[-1] == "/":
@@ -82,14 +89,28 @@ def request(
             raise SnykHTTPError(resp)
         return resp
 
-    def post(self, path: str, body: Any, headers: dict = {}) -> requests.Response:
-        url = f"{self.api_url}/{path}"
+    def post(
+        self,
+        path: str,
+        body: Any,
+        headers: dict = {},
+        params: Dict[str, Any] = {},
+        use_rest: bool = False,
+    ) -> requests.Response:
+        url = f"{self.rest_api_url if use_rest else self.api_url}/{path}"
         logger.debug(f"POST: {url}")
 
+        if use_rest and "version" not in params:
+            params["version"] = self.version if self.version else "2024-06-21"
+
         resp = retry_call(
             self.request,
             fargs=[requests.post, url],
-            fkwargs={"json": body, "headers": {**self.api_post_headers, **headers}},
+            fkwargs={
+                "json": body,
+                "headers": {**self.api_post_headers, **headers},
+                "params": params,
+            },
             tries=self.tries,
             delay=self.delay,
             backoff=self.backoff,
@@ -103,14 +124,64 @@ def post(self, path: str, body: Any, headers: dict = {}) -> requests.Response:
 
         return resp
 
-    def put(self, path: str, body: Any, headers: dict = {}) -> requests.Response:
-        url = "%s/%s" % (self.api_url, path)
+    def patch(
+        self,
+        path: str,
+        body: Dict[str, Any],
+        headers: Dict[str, str] = {},
+        params: Dict[str, Any] = {},
+    ) -> requests.Response:
+        url = f"{self.rest_api_url}/{path}"
+        logger.debug(f"PATCH: {url}")
+
+        if "version" not in params:
+            params["version"] = self.version if self.version else "2024-06-21"
+
+        resp = retry_call(
+            self.request,
+            fargs=[requests.patch, url],
+            fkwargs={
+                "json": body,
+                "headers": {**self.api_patch_headers, **headers},
+                "params": params,
+            },
+            tries=self.tries,
+            delay=self.delay,
+            backoff=self.backoff,
+            logger=logger,
+        )
+
+        if not resp.ok:
+            logger.error(resp.text)
+            raise SnykHTTPError(resp)
+
+        return resp
+
+    def put(
+        self,
+        path: str,
+        body: Any,
+        headers: dict = {},
+        params: Dict[str, Any] = {},
+        use_rest: bool = False,
+    ) -> requests.Response:
+        url = "%s/%s" % (
+            self.rest_api_url if use_rest else self.api_url,
+            path,
+        )
         logger.debug("PUT: %s" % url)
 
+        if use_rest and "version" not in params:
+            params["version"] = self.version if self.version else "2024-06-21"
+
         resp = retry_call(
             self.request,
             fargs=[requests.put, url],
-            fkwargs={"json": body, "headers": {**self.api_post_headers, **headers}},
+            fkwargs={
+                "json": body,
+                "headers": {**self.api_post_headers, **headers},
+                "params": params,
+            },
             tries=self.tries,
             delay=self.delay,
             backoff=self.backoff,
@@ -196,14 +267,26 @@ def get(
 
         return resp
 
-    def delete(self, path: str) -> requests.Response:
-        url = f"{self.api_url}/{path}"
+    def delete(self, path: str, use_rest: bool = False) -> requests.Response:
+        is_v1_project_path: bool = self.__is_v1_project_path(path)
+        if is_v1_project_path:
+            ids = re.findall(rf"{self.__uuid_pattern}", path)
+            path = f"orgs/{ids[0]}/projects/{ids[1]}"
+            url = f"{self.rest_api_url}/{path}"
+            use_rest = True
+        else:
+            url = f"{self.rest_api_url if use_rest else self.api_url}/{path}"
+
+        params = {}
+        if use_rest:
+            params["version"] = self.version if self.version else "2024-06-21"
+
         logger.debug(f"DELETE: {url}")
 
         resp = retry_call(
             self.request,
             fargs=[requests.delete, url],
-            fkwargs={"headers": self.api_headers},
+            fkwargs={"headers": self.api_headers, "params": params},
             tries=self.tries,
             delay=self.delay,
             backoff=self.backoff,
@@ -293,3 +376,14 @@ def groups(self):
     # https://snyk.docs.apiary.io/#reference/reporting-api/issues/get-list-of-issues
     def issues(self):
         raise SnykNotImplementedError  # pragma: no cover
+
+    def __is_v1_project_path(self, path: str) -> bool:
+        v1_paths: List[Pattern[str]] = [
+            re.compile(f"^org/{self.__uuid_pattern}/project/{self.__uuid_pattern}$")
+        ]
+
+        for v1_path in v1_paths:
+            if re.match(v1_path, path):
+                return True
+
+        return False

snyk/managers.py

@@ -1,5 +1,4 @@
 import abc
-import json
 from typing import Any, Dict, List
 
 from deprecation import deprecated  # type: ignore

snyk/models.py

@@ -3,7 +3,6 @@
 from dataclasses import InitVar, dataclass, field
 from typing import Any, Dict, List, Optional, Union
 
-import requests
 from deprecation import deprecated  # type: ignore
 from mashumaro.mixins.json import DataClassJSONMixin  # type: ignore
 
@@ -245,7 +244,7 @@ def import_project(self, url, files: Optional[List[str]] = None) -> bool:
     # https://snyk.docs.apiary.io/#reference/users/user-organisation-notification-settings/modify-org-notification-settings
     # https://snyk.docs.apiary.io/#reference/users/user-organisation-notification-settings/get-org-notification-settings
     def notification_settings(self):
-        raise SnykNotImplemented  # pragma: no cover
+        raise SnykNotImplementedError  # pragma: no cover
 
     # https://snyk.docs.apiary.io/#reference/organisations/the-snyk-organisation-for-a-request/invite-users
     def invite(self, email: str, admin: bool = False) -> bool:

snyk/test_client.py

@@ -13,7 +13,7 @@
 
 REST_ORG = "39ddc762-b1b9-41ce-ab42-defbe4575bd6"
 REST_URL = "https://api.snyk.io/rest"
-REST_VERSION = "2022-02-16~experimental"
+REST_VERSION = "2024-06-21"
 
 V3_ORG = "39ddc762-b1b9-41ce-ab42-defbe4575bd6"
 V3_URL = "https://api.snyk.io/v3"
@@ -207,9 +207,7 @@ def test_non_existent_project(self, requests_mock, client, organizations, projec
 
     @pytest.fixture
     def rest_client(self):
-        return SnykClient(
-            "token", version="2022-02-16~experimental", url="https://api.snyk.io/rest"
-        )
+        return SnykClient("token", version="2024-06-21", url="https://api.snyk.io/rest")
 
     @pytest.fixture
     def v3_client(self):
@@ -329,3 +327,140 @@ def test_rest_limit_deduplication(self, requests_mock, rest_client):
         )
         params = {"limit": 10}
         rest_client.get(f"orgs/{REST_ORG}/projects?limit=100", params)
+
+    def test_patch_update_project_should_return_new_project(
+        self, requests_mock, rest_client, projects
+    ):
+        project = projects["data"][0]
+        matcher = re.compile(
+            f"orgs/{REST_ORG}/projects/{project['id']}\\?([^&=]+=[^&=]+&?)+$"
+        )
+        body = {
+            "data": {
+                "attributes": {
+                    "business_criticality": ["critical"],
+                    "environment": ["backend", "internal"],
+                    "lifecycle": ["development"],
+                    "tags": [{"key": "key-test", "value": "value-test"}],
+                }
+            }
+        }
+        project["attributes"] = {**project["attributes"], **body["data"]["attributes"]}
+        requests_mock.patch(matcher, json=project, status_code=200)
+
+        response = rest_client.patch(
+            f"orgs/{REST_ORG}/projects/{project['id']}",
+            body=project,
+            params={"expand": "target"},
+        )
+
+        response_data = response.json()
+        assert response.status_code == 200
+        assert response_data == project
+
+    def test_token_added_to_patch_headers(self, client):
+        assert client.api_patch_headers["Authorization"] == "token token"
+
+    def test_patch_headers_use_correct_mimetype(self, client):
+        assert client.api_patch_headers["Content-Type"] == "application/vnd.api+json"
+
+    def test_patch_has_version_in_query_params(self, client, requests_mock):
+        matcher = re.compile("\\?version=2[0-9]{3}-[0-9]{2}-[0-9]{2}$")
+        requests_mock.patch(matcher, json={}, status_code=200)
+        client.patch(
+            f"{REST_URL}/orgs/{REST_ORG}/projects/f9fec29a-d288-40d9-a019-cedf825e6efb",
+            body={},
+        )
+
+        assert requests_mock.call_count == 1
+
+    def test_patch_update_project_when_invalid_should_throw_exception(
+        self, requests_mock, rest_client
+    ):
+        matcher = re.compile(
+            "projects/f9fec29a-d288-40d9-a019-cedf825e6efb\\?version=2[0-9]{3}-[0-9]{2}-[0-9]{2}$"
+        )
+        body = {"attributes": {"environment": ["backend"]}}
+
+        requests_mock.patch(matcher, json=body, status_code=400)
+        with pytest.raises(SnykError):
+            rest_client.patch(
+                f"orgs/{REST_ORG}/projects/f9fec29a-d288-40d9-a019-cedf825e6efb",
+                body=body,
+            )
+
+        assert requests_mock.call_count == 1
+
+    def test_post_request_rest_api_when_specified(self, requests_mock, client):
+        matcher = re.compile(
+            f"{REST_URL}/orgs/{REST_ORG}/projects/f9fec29a-d288-40d9-a019-cedf825e6efb\\?version={REST_VERSION}$"
+        )
+        requests_mock.post(matcher, json={}, status_code=200)
+        params = {"version": REST_VERSION}
+        client.post(
+            f"{REST_URL}/orgs/{REST_ORG}/projects/f9fec29a-d288-40d9-a019-cedf825e6efb",
+            body={},
+            params=params,
+            use_rest=True,
+        )
+
+        assert requests_mock.call_count == 1
+
+    def test_put_request_rest_api_when_specified(self, requests_mock, client):
+        matcher = re.compile(
+            f"{REST_URL}/orgs/{REST_ORG}/projects/f9fec29a-d288-40d9-a019-cedf825e6efb\\?version={REST_VERSION}$"
+        )
+        requests_mock.put(matcher, json={}, status_code=200)
+        params = {"version": REST_VERSION}
+        client.put(
+            f"{REST_URL}/orgs/{REST_ORG}/projects/f9fec29a-d288-40d9-a019-cedf825e6efb",
+            body={},
+            params=params,
+            use_rest=True,
+        )
+
+        assert requests_mock.call_count == 1
+
+    def test_put_request_v1_api_when_specified(self, requests_mock, client):
+        matcher = re.compile(
+            f"^https://api.snyk.io/v1/org/{REST_ORG}/project/f9fec29a-d288-40d9-a019-cedf825e6efb"
+        )
+        requests_mock.put(matcher, json={}, status_code=200)
+        client.put(
+            f"org/{REST_ORG}/project/f9fec29a-d288-40d9-a019-cedf825e6efb",
+            body={},
+            use_rest=False,
+        )
+
+        assert requests_mock.call_count == 1
+
+    def test_delete_use_rest_when_specified(self, requests_mock, client):
+        matcher = re.compile(
+            "^%s/orgs/%s\\?version=2[0-9]{3}-[0-9]{2}-[0-9]{2}$" % (REST_URL, REST_ORG)
+        )
+        requests_mock.delete(matcher, json={}, status_code=200)
+
+        client.delete(f"orgs/{REST_ORG}", use_rest=True)
+        assert requests_mock.call_count == 1
+
+    def test_delete_use_v1_when_specified(self, requests_mock, client):
+        matcher = re.compile("^%s/orgs/%s" % ("https://api.snyk.io/v1", REST_ORG))
+        requests_mock.delete(matcher, json={}, status_code=200)
+
+        client.delete(f"orgs/{REST_ORG}")
+        assert requests_mock.call_count == 1
+
+    def test_delete_redirects_to_rest_api_for_delete_project(
+        self, client, requests_mock, projects
+    ):
+        project = projects["data"][0]
+        matcher = re.compile(
+            "orgs/%s/projects/%s\\?version=2[0-9]{3}-[0-9]{2}-[0-9]{2}$"
+            % (REST_ORG, project["id"])
+        )
+
+        requests_mock.delete(matcher, json={}, status_code=200)
+
+        client.delete(f"org/{REST_ORG}/project/{project['id']}")
+
+        assert requests_mock.call_count == 1

snyk/test_data/rest_targets_page1.json

@@ -115,6 +115,6 @@
     }
   ],
   "links": {
-    "next": "/orgs/39ddc762-b1b9-41ce-ab42-defbe4575bd6/targets?limit=10&version=2022-02-16~experimental&excludeEmpty=true&starting_after=v1.eyJpZCI6IjMyODE4ODAifQ%3D%3D"
+    "next": "/orgs/39ddc762-b1b9-41ce-ab42-defbe4575bd6/targets?limit=10&version=2024-06-21&excludeEmpty=true&starting_after=v1.eyJpZCI6IjMyODE4ODAifQ%3D%3D"
   }
 }

snyk/test_data/rest_targets_page2.json

@@ -115,7 +115,7 @@
     }
   ],
   "links": {
-    "next": "/orgs/39ddc762-b1b9-41ce-ab42-defbe4575bd6/targets?limit=10&version=2022-02-16~experimental&excludeEmpty=true&starting_after=v1.eyJpZCI6IjI5MTk1NjgifQ%3D%3D",
-    "prev": "/orgs/39ddc762-b1b9-41ce-ab42-defbe4575bd6/targets?limit=10&version=2022-02-16~experimental&excludeEmpty=true&ending_before=v1.eyJpZCI6IjMyODE4NzkifQ%3D%3D"
+    "next": "/orgs/39ddc762-b1b9-41ce-ab42-defbe4575bd6/targets?limit=10&version=2024-06-21&excludeEmpty=true&starting_after=v1.eyJpZCI6IjI5MTk1NjgifQ%3D%3D",
+    "prev": "/orgs/39ddc762-b1b9-41ce-ab42-defbe4575bd6/targets?limit=10&version=2024-06-21&excludeEmpty=true&ending_before=v1.eyJpZCI6IjMyODE4NzkifQ%3D%3D"
   }
 }

snyk/test_data/rest_targets_page3.json

@@ -115,6 +115,6 @@
     }
   ],
   "links": {
-    "prev": "/orgs/39ddc762-b1b9-41ce-ab42-defbe4575bd6/targets?limit=10&version=2022-02-16~experimental&excludeEmpty=true&ending_before=v1.eyJpZCI6IjMyODE4ODAifQ%3D%3D"
+    "prev": "/orgs/39ddc762-b1b9-41ce-ab42-defbe4575bd6/targets?limit=10&version=2024-06-21&excludeEmpty=true&ending_before=v1.eyJpZCI6IjMyODE4ODAifQ%3D%3D"
   }
 }