exceptions.py

"""Package exceptions.

Copyright (c) 2016-2024 Cisco and/or its affiliates.

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
"""

import logging

import requests

from .response_codes import RESPONSE_CODES


logger = logging.getLogger(__name__)


class webexpythonsdkException(Exception):
    """Base class for all webexpythonsdk package exceptions."""

    pass


class webexpythonsdkWarning(webexpythonsdkException, Warning):
    """Base class for all webexpythonsdk warnings."""

    pass


class AccessTokenError(webexpythonsdkException):
    """Raised when an incorrect Webex Access Token has been provided."""

    pass


class ApiError(webexpythonsdkException):
    """Errors returned in response to requests sent to the Webex APIs.

    Several data attributes are available for inspection.
    """

    def __init__(self, response):
        assert isinstance(response, requests.Response)

        # Extended exception attributes
        self.response = response
        """The :class:`requests.Response` object returned from the API call."""

        self.request = self.response.request
        """The :class:`requests.PreparedRequest` of the API call."""

        self.status_code = self.response.status_code
        """The HTTP status code from the API response."""

        self.status = self.response.reason
        """The HTTP status from the API response."""

        self.description = RESPONSE_CODES.get(self.status_code)
        """A description of the HTTP Response Code from the API docs."""

        self.details = None
        """The parsed JSON details from the API response."""
        if (
            "application/json"
            in self.response.headers.get("Content-Type", "").lower()
        ):
            try:
                self.details = self.response.json()
            except ValueError:
                logger.warning("Error parsing JSON response body")

        self.message = self.details.get("message") if self.details else None
        """The error message from the parsed API response."""

        self.tracking_id = (
            self.details.get("trackingId")
            if self.details
            else None or self.response.headers.get("trackingId")
        )
        """The Webex Tracking ID from the response."""

        self.error_message = (
            "[{status_code}]{status} - {detail}{tracking_id}".format(
                status_code=self.status_code,
                status=" " + self.status if self.status else "",
                detail=self.message or self.description or "Unknown Error",
                tracking_id=(
                    " [Tracking ID: " + self.tracking_id + "]"
                    if self.tracking_id
                    else ""
                ),
            )
        )

        super(ApiError, self).__init__(self.error_message)

    def __repr__(self):
        return "<{exception_name} [{status_code}]{status}>".format(
            exception_name=self.__class__.__name__,
            status_code=self.status_code,
            status=" " + self.status if self.status else "",
        )


class ApiWarning(webexpythonsdkWarning, ApiError):
    """Warnings raised from API responses received from the Webex APIs.

    Several data attributes are available for inspection.
    """

    pass


class RateLimitError(ApiError):
    """Webex Rate-Limit exceeded Error.

    Raised when a rate-limit exceeded message is received and the request
    **will not** be retried.
    """

    def __init__(self, response):
        assert isinstance(response, requests.Response)

        # Extended exception attributes
        try:
            retry_after = int(response.headers.get("Retry-After", 15))
        except (ValueError, TypeError):
            # Handle malformed Retry-After headers gracefully
            # Log a warning for debugging purposes
            import logging

            logger = logging.getLogger(__name__)
            logger.warning(
                f"Malformed Retry-After header received: {response.headers.get('Retry-After')}. "
                "Defaulting to 15 seconds."
            )
            retry_after = 15

        self.retry_after = max(1, retry_after)
        """The `Retry-After` time period (in seconds) provided by Webex.

        Defaults to 15 seconds if the response `Retry-After` header isn't
        present in the response headers, and defaults to a minimum wait time of
        1 second if Webex returns a `Retry-After` header of 0 seconds.

        Note: If the Retry-After header contains malformed values (non-integer strings,
        etc.), it will default to 15 seconds and log a warning.
        """

        super(RateLimitError, self).__init__(response)


class RateLimitWarning(ApiWarning, RateLimitError):
    """Webex rate-limit exceeded warning.

    Raised when a rate-limit exceeded message is received and the request will
    be retried.
    """

    pass


class MalformedResponse(webexpythonsdkException):
    """Raised when a malformed response is received from Webex."""

    pass