markdown-to-confluence 0.4.4__py3-none-any.whl → 0.4.6__py3-none-any.whl

md2conf/api.py

@@ -11,6 +11,8 @@ import enum
 import io
 import logging
 import mimetypes
+import ssl
+import sys
 import typing
 from dataclasses import dataclass
 from pathlib import Path
@@ -19,15 +21,28 @@ from typing import Any, Optional, TypeVar
 from urllib.parse import urlencode, urlparse, urlunparse
 
 import requests
+from requests.adapters import HTTPAdapter
 from strong_typing.core import JsonType
 from strong_typing.serialization import DeserializerOptions, json_dump_string, json_to_object, object_to_json
 
+from .environment import ArgumentError, ConfluenceConnectionProperties, ConfluenceError, PageError
+from .extra import override
 from .metadata import ConfluenceSiteMetadata
-from .properties import ArgumentError, ConfluenceConnectionProperties, ConfluenceError, PageError
+
+if sys.version_info >= (3, 10):
+    import truststore
+else:
+    import certifi
 
 T = TypeVar("T")
 
+mimetypes.add_type("application/vnd.openxmlformats-officedocument.wordprocessingml.document", ".docx", strict=True)
 mimetypes.add_type("text/vnd.mermaid", ".mmd", strict=True)
+mimetypes.add_type("application/vnd.oasis.opendocument.presentation", ".odp", strict=True)
+mimetypes.add_type("application/vnd.oasis.opendocument.spreadsheet", ".ods", strict=True)
+mimetypes.add_type("application/vnd.oasis.opendocument.text", ".odt", strict=True)
+mimetypes.add_type("application/vnd.openxmlformats-officedocument.presentationml.presentation", ".pptx", strict=True)
+mimetypes.add_type("application/vnd.openxmlformats-officedocument.spreadsheetml.sheet", ".xlsx", strict=True)
 
 
 def _json_to_object(
@@ -330,9 +345,33 @@ class ConfluenceUpdateAttachmentRequest:
     version: ConfluenceContentVersion
 
 
+class TruststoreAdapter(HTTPAdapter):
+    """
+    Provides a general-case interface for HTTPS sessions to connect to HTTPS URLs.
+
+    This class implements the Transport Adapter interface in the Python library `requests`.
+
+    This class will usually be created by the :class:`requests.Session` class under the covers.
+    """
+
+    @override
+    def init_poolmanager(self, connections: int, maxsize: int, block: bool = False, **pool_kwargs: Any) -> None:
+        """
+        Adapts the pool manager to use the provided SSL context instead of the default.
+        """
+
+        if sys.version_info >= (3, 10):
+            ctx = truststore.SSLContext(ssl.PROTOCOL_TLS_CLIENT)
+        else:
+            ctx = ssl.create_default_context(ssl.Purpose.SERVER_AUTH, cafile=certifi.where())
+        ctx.check_hostname = True
+        ctx.verify_mode = ssl.CERT_REQUIRED
+        super().init_poolmanager(connections, maxsize, block, ssl_context=ctx, **pool_kwargs)  # type: ignore[no-untyped-call]
+
+
 class ConfluenceAPI:
     """
-    Represents an active connection to a Confluence server.
+    Encapsulates operations that can be invoked via the [Confluence REST API](https://developer.atlassian.com/cloud/confluence/rest/v2/).
     """
 
     properties: ConfluenceConnectionProperties
@@ -342,7 +381,13 @@ class ConfluenceAPI:
         self.properties = properties or ConfluenceConnectionProperties()
 
     def __enter__(self) -> "ConfluenceSession":
+        """
+        Opens a connection to a Confluence server.
+        """
+
         session = requests.Session()
+        session.mount("https://", TruststoreAdapter())
+
         if self.properties.user_name:
             session.auth = (self.properties.user_name, self.properties.api_key)
         else:
@@ -366,6 +411,10 @@ class ConfluenceAPI:
         exc_val: Optional[BaseException],
         exc_tb: Optional[TracebackType],
     ) -> None:
+        """
+        Closes an open connection.
+        """
+
         if self.session is not None:
             self.session.close()
             self.session = None
@@ -373,7 +422,7 @@ class ConfluenceAPI:
 
 class ConfluenceSession:
     """
-    Information about an open session to a Confluence server.
+    Represents an active connection to a Confluence server.
     """
 
     session: requests.Session
@@ -412,8 +461,31 @@ class ConfluenceSession:
         if not base_path:
             raise ArgumentError("Confluence base path not specified and cannot be inferred")
         self.site = ConfluenceSiteMetadata(domain, base_path, space_key)
+
         if not api_url:
-            self.api_url = f"https://{self.site.domain}{self.site.base_path}"
+            LOGGER.info("Discovering Confluence REST API URL")
+            try:
+                # obtain cloud ID to build URL for access with scoped token
+                response = self.session.get(f"https://{self.site.domain}/_edge/tenant_info", headers={"Accept": "application/json"}, verify=True)
+                if response.text:
+                    LOGGER.debug("Received HTTP payload:\n%s", response.text)
+                response.raise_for_status()
+                cloud_id = response.json()["cloudId"]
+
+                # try next-generation REST API URL
+                LOGGER.info("Probing scoped Confluence REST API URL")
+                self.api_url = f"https://api.atlassian.com/ex/confluence/{cloud_id}/"
+                url = self._build_url(ConfluenceVersion.VERSION_2, "/spaces", {"limit": "1"})
+                response = self.session.get(url, headers={"Accept": "application/json"}, verify=True)
+                if response.text:
+                    LOGGER.debug("Received HTTP payload:\n%s", response.text)
+                response.raise_for_status()
+
+                LOGGER.info("Configured scoped Confluence REST API URL: %s", self.api_url)
+            except requests.exceptions.HTTPError:
+                # fall back to classic REST API URL
+                self.api_url = f"https://{self.site.domain}{self.site.base_path}"
+                LOGGER.info("Configured classic Confluence REST API URL: %s", self.api_url)
 
     def close(self) -> None:
         self.session.close()
@@ -448,7 +520,7 @@ class ConfluenceSession:
         "Executes an HTTP request via Confluence API."
 
         url = self._build_url(version, path, query)
-        response = self.session.get(url, headers={"Accept": "application/json"})
+        response = self.session.get(url, headers={"Accept": "application/json"}, verify=True)
         if response.text:
             LOGGER.debug("Received HTTP payload:\n%s", response.text)
         response.raise_for_status()
@@ -460,7 +532,7 @@ class ConfluenceSession:
         items: list[JsonType] = []
         url = self._build_url(ConfluenceVersion.VERSION_2, path, query)
         while True:
-            response = self.session.get(url, headers={"Accept": "application/json"})
+            response = self.session.get(url, headers={"Accept": "application/json"}, verify=True)
             response.raise_for_status()
 
             payload = typing.cast(dict[str, JsonType], response.json())
@@ -496,22 +568,16 @@ class ConfluenceSession:
         "Creates a new object via Confluence REST API."
 
         url, headers, data = self._build_request(version, path, body, response_type)
-        response = self.session.post(
-            url,
-            data=data,
-            headers=headers,
-        )
+        response = self.session.post(url, data=data, headers=headers, verify=True)
+        response.raise_for_status()
         return response_cast(response_type, response)
 
     def _put(self, version: ConfluenceVersion, path: str, body: Any, response_type: type[T]) -> T:
         "Updates an existing object via Confluence REST API."
 
         url, headers, data = self._build_request(version, path, body, response_type)
-        response = self.session.put(
-            url,
-            data=data,
-            headers=headers,
-        )
+        response = self.session.put(url, data=data, headers=headers, verify=True)
+        response.raise_for_status()
         return response_cast(response_type, response)
 
     def space_id_to_key(self, id: str) -> str:
@@ -681,6 +747,7 @@ class ConfluenceSession:
                         "X-Atlassian-Token": "no-check",
                         "Accept": "application/json",
                     },
+                    verify=True,
                 )
         elif raw_data is not None:
             LOGGER.info("Uploading raw data: %s", attachment_name)
@@ -708,6 +775,7 @@ class ConfluenceSession:
                     "X-Atlassian-Token": "no-check",
                     "Accept": "application/json",
                 },
+                verify=True,
             )
         else:
             raise NotImplementedError("parameter match not exhaustive")
@@ -869,6 +937,7 @@ class ConfluenceSession:
                 "Content-Type": "application/json; charset=utf-8",
                 "Accept": "application/json",
             },
+            verify=True,
         )
         response.raise_for_status()
         return _json_to_object(ConfluencePage, response.json())
@@ -886,7 +955,7 @@ class ConfluenceSession:
         # move to trash
         url = self._build_url(ConfluenceVersion.VERSION_2, path)
         LOGGER.info("Moving page to trash: %s", page_id)
-        response = self.session.delete(url)
+        response = self.session.delete(url, verify=True)
         response.raise_for_status()
 
         if purge:
@@ -894,7 +963,7 @@ class ConfluenceSession:
             query = {"purge": "true"}
             url = self._build_url(ConfluenceVersion.VERSION_2, path, query)
             LOGGER.info("Permanently deleting page: %s", page_id)
-            response = self.session.delete(url)
+            response = self.session.delete(url, verify=True)
             response.raise_for_status()
 
     def page_exists(
@@ -929,6 +998,7 @@ class ConfluenceSession:
                 "Content-Type": "application/json; charset=utf-8",
                 "Accept": "application/json",
             },
+            verify=True,
         )
         response.raise_for_status()
         data = typing.cast(dict[str, JsonType], response.json())
@@ -993,7 +1063,7 @@ class ConfluenceSession:
             query = {"name": label.name}
 
             url = self._build_url(ConfluenceVersion.VERSION_1, path, query)
-            response = self.session.delete(url)
+            response = self.session.delete(url, verify=True)
             if response.text:
                 LOGGER.debug("Received HTTP payload:\n%s", response.text)
             response.raise_for_status()
@@ -1052,7 +1122,7 @@ class ConfluenceSession:
 
         path = f"/pages/{page_id}/properties/{property_id}"
         url = self._build_url(ConfluenceVersion.VERSION_2, path)
-        response = self.session.delete(url)
+        response = self.session.delete(url, verify=True)
         response.raise_for_status()
 
     def update_content_property_for_page(