create protected domain via the sdk

Author: TobyDrane

sdk/rapid/exceptions.py

@@ -84,3 +84,11 @@ class SubjectNotFoundException(Exception):
 
 class SubjectDeletionFailedException(Exception):
     pass
+
+
+class InvalidDomainNameException(Exception):
+    pass
+
+
+class DomainConflictException(Exception):
+    pass

sdk/rapid/rapid.py

@@ -27,6 +27,8 @@
     InvalidPermissionsException,
     SubjectAlreadyExistsException,
     SubjectNotFoundException,
+    InvalidDomainNameException,
+    DomainConflictException,
 )
 
 
@@ -413,3 +415,29 @@ def update_subject_permissions(self, subject_id: str, permissions: list[str]):
         raise InvalidPermissionsException(
             "One or more of the provided permissions is invalid or duplicated"
         )
+
+    def create_protected_domain(self, name: str):
+        """
+        Creates a new protected domain.
+
+        Args:
+            name (str): The name of the protected domain to create.
+
+        Raises:
+            rapid.exceptions.InvalidDomainNameException: If the domain name is invalid.
+            rapid.exceptions.DomainConflictException: If the domain already exists.
+
+        """
+        url = f"{self.auth.url}/protected_domains/{name}"
+        response = requests.post(
+            url, headers=self.generate_headers(), timeout=TIMEOUT_PERIOD
+        )
+        data = json.loads(response.content.decode("utf-8"))
+        if response.status_code == 201:
+            return
+        elif response.status_code == 400:
+            raise InvalidDomainNameException(data["details"])
+        elif response.status_code == 409:
+            raise DomainConflictException(data["details"])
+
+        raise Exception("Failed to create protected domain")

sdk/tests/test_rapid.py

@@ -18,6 +18,8 @@
     InvalidPermissionsException,
     SubjectNotFoundException,
     SubjectAlreadyExistsException,
+    InvalidDomainNameException,
+    DomainConflictException,
 )
 from .conftest import RAPID_URL, RAPID_TOKEN
 
@@ -392,7 +394,9 @@ def test_delete_client_failure(self, requests_mock: Mocker, rapid: Rapid):
             rapid.delete_client("xxx-yyy-zzz")
 
     @pytest.mark.usefixtures("requests_mock", "rapid")
-    def update_subject_permissions_success(self, requests_mock: Mocker, rapid: Rapid):
+    def test_update_subject_permissions_success(
+        self, requests_mock: Mocker, rapid: Rapid
+    ):
         mocked_response = {"data": "dummy"}
         requests_mock.put(
             f"{RAPID_URL}/subject/permissions", json=mocked_response, status_code=200
@@ -401,10 +405,58 @@ def update_subject_permissions_success(self, requests_mock: Mocker, rapid: Rapid
         assert res == mocked_response
 
     @pytest.mark.usefixtures("requests_mock", "rapid")
-    def update_subject_permissions_failure(self, requests_mock: Mocker, rapid: Rapid):
+    def test_update_subject_permissions_failure(
+        self, requests_mock: Mocker, rapid: Rapid
+    ):
         mocked_response = {"data": "dummy"}
         requests_mock.put(
             f"{RAPID_URL}/subject/permissions", json=mocked_response, status_code=400
         )
         with pytest.raises(InvalidPermissionsException):
             rapid.update_subject_permissions("xxx-yyy-zzz", ["READ_ALL"])
+
+    @pytest.mark.usefixtures("requests_mock", "rapid")
+    def test_create_protected_domain_invalid_name_failure(
+        self, requests_mock: Mocker, rapid: Rapid
+    ):
+        mocked_response = {
+            "details": "The value set for domain [dummy] can only contain alphanumeric and underscore `_` characters and must start with an alphabetic character"
+        }
+        requests_mock.post(
+            f"{RAPID_URL}/protected_domains/dummy",
+            json=mocked_response,
+            status_code=400,
+        )
+        with pytest.raises(InvalidDomainNameException) as exc_info:
+            rapid.create_protected_domain("dummy")
+
+        assert (
+            str(exc_info.value)
+            == "The value set for domain [dummy] can only contain alphanumeric and underscore `_` characters and must start with an alphabetic character"
+        )
+
+    @pytest.mark.usefixtures("requests_mock", "rapid")
+    def test_create_protected_domain_conflict_failure(
+        self, requests_mock: Mocker, rapid: Rapid
+    ):
+        mocked_response = {"details": "The protected domain, [dummy] already exists"}
+        requests_mock.post(
+            f"{RAPID_URL}/protected_domains/dummy",
+            json=mocked_response,
+            status_code=409,
+        )
+        with pytest.raises(DomainConflictException) as exc_info:
+            rapid.create_protected_domain("dummy")
+
+        assert str(exc_info.value) == "The protected domain, [dummy] already exists"
+
+    @pytest.mark.usefixtures("requests_mock", "rapid")
+    def test_create_protected_domain_success(self, requests_mock: Mocker, rapid: Rapid):
+        mocked_response = {"data": "dummy"}
+        requests_mock.post(
+            f"{RAPID_URL}/protected_domains/dummy",
+            json=mocked_response,
+            status_code=201,
+        )
+        res = rapid.create_protected_domain("dummy")
+        assert res is None