Merge pull request #2 from I559656/cmis-retrieval-apis

Add CMIS retrieval and user APIs for DMS module

Author: JagnathReddy

src/sap_cloud_sdk/core/telemetry/operation.py

@@ -52,7 +52,6 @@ class Operation(str, Enum):
     AICORE_SET_CONFIG = "set_aicore_config"
     AICORE_AUTO_INSTRUMENT = "auto_instrument"
 
-
     # DMS Operations
     DMS_ONBOARD_REPOSITORY = "onboard_repository"
     DMS_GET_REPOSITORY = "get_repository"
@@ -64,5 +63,17 @@ class Operation(str, Enum):
     DMS_UPDATE_CONFIG = "update_config"
     DMS_DELETE_CONFIG = "delete_config"
 
+    # DMS CMIS Operations
+    DMS_CREATE_FOLDER = "create_folder"
+    DMS_CREATE_DOCUMENT = "create_document"
+    DMS_CHECK_OUT = "check_out"
+    DMS_CHECK_IN = "check_in"
+    DMS_CANCEL_CHECK_OUT = "cancel_check_out"
+    DMS_APPLY_ACL = "apply_acl"
+    DMS_GET_OBJECT = "get_object"
+    DMS_GET_CONTENT = "get_content"
+    DMS_UPDATE_PROPERTIES = "update_properties"
+    DMS_GET_CHILDREN = "get_children"
+
     def __str__(self) -> str:
         return self.value

src/sap_cloud_sdk/dms/__init__.py

@@ -5,15 +5,16 @@
 
 
 def create_client(
-    *,
-    instance: Optional[str] = None,
-    dms_cred: Optional[DMSCredentials] = None
+    *, instance: Optional[str] = None, dms_cred: Optional[DMSCredentials] = None
 ):
     if dms_cred is not None:
         return DMSClient(dms_cred)
     if instance is not None:
         return DMSClient(load_sdm_config_from_env_or_mount(instance))
-    
-    raise ValueError("No configuration provided. Please provide either instance name, config, or dms_cred.")
 
-__all__ = ["create_client"]
+    raise ValueError(
+        "No configuration provided. Please provide either instance name, config, or dms_cred."
+    )
+
+
+__all__ = ["create_client"]

src/sap_cloud_sdk/dms/_auth.py

@@ -3,7 +3,11 @@
 import requests
 from requests.exceptions import RequestException
 from typing import Optional, TypedDict
-from sap_cloud_sdk.dms.exceptions import DMSError, DMSConnectionError, DMSPermissionDeniedException
+from sap_cloud_sdk.dms.exceptions import (
+    DMSError,
+    DMSConnectionError,
+    DMSPermissionDeniedException,
+)
 from sap_cloud_sdk.dms.model import DMSCredentials
 
 logger = logging.getLogger(__name__)
@@ -14,6 +18,7 @@ class _TokenResponse(TypedDict):
     expires_in: int
 
 
+# TODO: limit number of access tokens in cache to 10
 class _CachedToken:
     def __init__(self, token: str, expires_at: float) -> None:
         self.token = token
@@ -74,12 +79,16 @@ def _fetch_token(self, token_url: str) -> _TokenResponse:
             response.raise_for_status()
         except requests.exceptions.ConnectionError as e:
             logger.error("Failed to connect to token endpoint")
-            raise DMSConnectionError("Failed to connect to the authentication server") from e
+            raise DMSConnectionError(
+                "Failed to connect to the authentication server"
+            ) from e
         except requests.exceptions.HTTPError as e:
             status = e.response.status_code if e.response is not None else None
             logger.error("Token request failed with status %s", status)
             if status in (401, 403):
-                raise DMSPermissionDeniedException("Authentication failed — invalid client credentials", status) from e
+                raise DMSPermissionDeniedException(
+                    "Authentication failed — invalid client credentials", status
+                ) from e
             raise DMSError("Failed to obtain access token", status) from e
         except RequestException as e:
             logger.error("Unexpected error during token fetch")
@@ -90,4 +99,4 @@ def _fetch_token(self, token_url: str) -> _TokenResponse:
             raise DMSError("Token response missing access_token")
 
         logger.debug("Token fetched successfully")
-        return payload
+        return payload

src/sap_cloud_sdk/dms/_endpoints.py

@@ -1,2 +1,2 @@
-REPOSITORIES        = "/rest/v2/repositories"
-CONFIGS             = "/rest/v2/configs"
+REPOSITORIES = "/rest/v2/repositories"
+CONFIGS = "/rest/v2/configs"

src/sap_cloud_sdk/dms/_http.py

@@ -6,6 +6,7 @@
 from sap_cloud_sdk.dms._auth import Auth
 from sap_cloud_sdk.dms.exceptions import (
     DMSError,
+    DMSConflictException,
     DMSConnectionError,
     DMSInvalidArgumentException,
     DMSObjectNotFoundException,
@@ -38,15 +39,19 @@ def get(
         tenant_subdomain: Optional[str] = None,
         headers: Optional[dict[str, str]] = None,
         user_claim: Optional[UserClaim] = None,
+        params: Optional[dict[str, str]] = None,
     ) -> Response:
         logger.debug("GET %s", path)
-        return self._handle(self._execute(
-            lambda: requests.get(
-                f"{self._base_url}{path}",
-                headers=self._merged_headers(tenant_subdomain, headers, user_claim),
-                timeout=(self._connect_timeout, self._read_timeout),
+        return self._handle(
+            self._execute(
+                lambda: requests.get(
+                    f"{self._base_url}{path}",
+                    headers=self._merged_headers(tenant_subdomain, headers, user_claim),
+                    params=params,
+                    timeout=(self._connect_timeout, self._read_timeout),
+                )
             )
-        ))
+        )
 
     def post(
         self,
@@ -57,14 +62,16 @@ def post(
         user_claim: Optional[UserClaim] = None,
     ) -> Response:
         logger.debug("POST %s", path)
-        return self._handle(self._execute(
-            lambda: requests.post(
-                f"{self._base_url}{path}",
-                headers=self._merged_headers(tenant_subdomain, headers, user_claim),
-                json=payload,
-                timeout=(self._connect_timeout, self._read_timeout),
+        return self._handle(
+            self._execute(
+                lambda: requests.post(
+                    f"{self._base_url}{path}",
+                    headers=self._merged_headers(tenant_subdomain, headers, user_claim),
+                    json=payload,
+                    timeout=(self._connect_timeout, self._read_timeout),
+                )
             )
-        ))
+        )
 
     def put(
         self,
@@ -75,14 +82,16 @@ def put(
         user_claim: Optional[UserClaim] = None,
     ) -> Response:
         logger.debug("PUT %s", path)
-        return self._handle(self._execute(
-            lambda: requests.put(
-                f"{self._base_url}{path}",
-                headers=self._merged_headers(tenant_subdomain, headers, user_claim),
-                json=payload,
-                timeout=(self._connect_timeout, self._read_timeout),
+        return self._handle(
+            self._execute(
+                lambda: requests.put(
+                    f"{self._base_url}{path}",
+                    headers=self._merged_headers(tenant_subdomain, headers, user_claim),
+                    json=payload,
+                    timeout=(self._connect_timeout, self._read_timeout),
+                )
             )
-        ))
+        )
 
     def delete(
         self,
@@ -92,13 +101,68 @@ def delete(
         user_claim: Optional[UserClaim] = None,
     ) -> Response:
         logger.debug("DELETE %s", path)
-        return self._handle(self._execute(
-            lambda: requests.delete(
-                f"{self._base_url}{path}",
-                headers=self._merged_headers(tenant_subdomain, headers, user_claim),
-                timeout=(self._connect_timeout, self._read_timeout),
+        return self._handle(
+            self._execute(
+                lambda: requests.delete(
+                    f"{self._base_url}{path}",
+                    headers=self._merged_headers(tenant_subdomain, headers, user_claim),
+                    timeout=(self._connect_timeout, self._read_timeout),
+                )
+            )
+        )
+
+    def post_form(
+        self,
+        path: str,
+        *,
+        data: dict[str, str],
+        files: Optional[dict[str, Any]] = None,
+        tenant_subdomain: Optional[str] = None,
+        user_claim: Optional[UserClaim] = None,
+    ) -> Response:
+        """POST with form-encoded data and optional multipart file uploads.
+
+        Does not set Content-Type — ``requests`` sets it automatically
+        to ``application/x-www-form-urlencoded`` or ``multipart/form-data``.
+        """
+        logger.debug("POST_FORM %s", path)
+        return self._handle(
+            self._execute(
+                lambda: requests.post(
+                    f"{self._base_url}{path}",
+                    headers=self._auth_header(tenant_subdomain, user_claim),
+                    data=data,
+                    files=files,
+                    timeout=(self._connect_timeout, self._read_timeout),
+                )
+            )
+        )
+
+    def get_stream(
+        self,
+        path: str,
+        *,
+        params: Optional[dict[str, str]] = None,
+        tenant_subdomain: Optional[str] = None,
+        user_claim: Optional[UserClaim] = None,
+    ) -> Response:
+        """GET that returns a raw streaming Response for binary content.
+
+        The caller is responsible for closing the response.
+        On non-2xx status the usual typed exception is raised.
+        """
+        logger.debug("GET_STREAM %s", path)
+        return self._handle(
+            self._execute(
+                lambda: requests.get(
+                    f"{self._base_url}{path}",
+                    headers=self._merged_headers(tenant_subdomain, None, user_claim),
+                    params=params,
+                    stream=True,
+                    timeout=(self._connect_timeout, self._read_timeout),
+                )
             )
-        ))
+        )
 
     def _execute(self, fn: Any) -> Response:
         """Execute an HTTP call, wrapping network errors into DMSConnectionError."""
@@ -114,7 +178,20 @@ def _execute(self, fn: Any) -> Response:
             logger.error("Unexpected network error")
             raise DMSConnectionError("Unexpected network error") from e
 
-    def _default_headers(self, tenant_subdomain: Optional[str] = None) -> dict[str, str]:
+    def _auth_header(
+        self,
+        tenant_subdomain: Optional[str] = None,
+        user_claim: Optional[UserClaim] = None,
+    ) -> dict[str, str]:
+        """Auth-only headers (no Content-Type). Used by post_form."""
+        return {
+            "Authorization": f"Bearer {self._auth.get_token(tenant_subdomain)}",
+            **self._user_claim_headers(user_claim),
+        }
+
+    def _default_headers(
+        self, tenant_subdomain: Optional[str] = None
+    ) -> dict[str, str]:
         return {
             "Authorization": f"Bearer {self._auth.get_token(tenant_subdomain)}",
             "Content-Type": "application/json",
@@ -152,24 +229,49 @@ def _handle(self, response: Response) -> Response:
         error_content = response.text
         logger.warning("Request failed with status %s", response.status_code)
 
+        # Try to extract the server's error message from the JSON body
+        try:
+            body = response.json()
+            server_message = body.get("message", "") if isinstance(body, dict) else ""
+        except Exception:
+            server_message = ""
+
         match response.status_code:
             case 400:
                 raise DMSInvalidArgumentException(
-                    "Request contains invalid or disallowed parameters", 400, error_content
+                    server_message
+                    or "Request contains invalid or disallowed parameters",
+                    400,
+                    error_content,
                 )
             case 401 | 403:
                 raise DMSPermissionDeniedException(
-                    "Access denied — invalid or expired token", response.status_code, error_content
+                    server_message or "Access denied — invalid or expired token",
+                    response.status_code,
+                    error_content,
                 )
             case 404:
                 raise DMSObjectNotFoundException(
-                    "The requested resource was not found", 404, error_content
+                    server_message or "The requested resource was not found",
+                    404,
+                    error_content,
+                )
+            case 409:
+                raise DMSConflictException(
+                    server_message
+                    or "The request conflicts with the current state of the resource",
+                    409,
+                    error_content,
                 )
             case 500:
                 raise DMSRuntimeException(
-                    "The DMS service encountered an internal error", 500, error_content
+                    server_message or "The DMS service encountered an internal error",
+                    500,
+                    error_content,
                 )
             case _:
                 raise DMSError(
-                    f"Unexpected response from DMS service : "+error_content, response.status_code, error_content
-                )
+                    f"Unexpected response from DMS service: {error_content}",
+                    response.status_code,
+                    error_content,
+                )