PhotosAPI/classes/exceptions.py

from typing import Literal


class AlbumNotFoundError(Exception):
    """Raises HTTP 404 if no album with this ID found."""
    def __init__(self, id: str):
        self.id = id
        self.openapi = {
            "description": "Album Does Not Exist",
            "content": {
                "application/json": {
                    "example": {
                        "detail": "Could not find album with id '{id}'."
                    }
                }
            }
        }

class AlbumNameNotFoundError(Exception):
    """Raises HTTP 404 if no album with this name found."""
    def __init__(self, name: str):
        self.name = name
        self.openapi = {
            "description": "Album Does Not Exist",
            "content": {
                "application/json": {
                    "example": {
                        "detail": "Could not find album with name '{name}'."
                    }
                }
            }
        }

class AlbumAlreadyExistsError(Exception):
    """Raises HTTP 409 if album with this name already exists."""
    def __init__(self, name: str):
        self.name = name
        self.openapi = {
            "description": "Album Already Exists",
            "content": {
                "application/json": {
                    "example": {
                        "detail": "Album with name '{name}' already exists."
                    }
                }
            }
        }

class AlbumIncorrectError(Exception):
    """Raises HTTP 406 if album's title or name is invalid."""
    def __init__(self, place: Literal["name", "title"], error: str) -> None:
        self.place = place
        self.error = error
        self.openapi = {
            "description": "Album Name/Title Invalid",
            "content": {
                "application/json": {
                    "example": {
                        "detail": "Album {name/title} invalid: {error}"
                    }
                }
            }
        }

class PhotoNotFoundError(Exception):
    """Raises HTTP 404 if no photo with this ID found."""
    def __init__(self, id: str):
        self.id = id
        self.openapi = {
            "description": "Photo Does Not Exist",
            "content": {
                "application/json": {
                    "example": {
                        "detail": "Could not find photo with id '{id}'."
                    }
                }
            }
        }

class PhotoSearchQueryEmptyError(Exception):
    """Raises HTTP 422 if no photo search query provided."""
    def __init__(self):
        self.openapi = {
            "description": "Invalid Query",
            "content": {
                "application/json": {
                    "example": {
                        "detail": "You must provide query, caption or coordinates to look for photos."
                    }
                }
            }
        }

class VideoNotFoundError(Exception):
    """Raises HTTP 404 if no video with this ID found."""
    def __init__(self, id: str):
        self.id = id
        self.openapi = {
            "description": "Video Does Not Exist",
            "content": {
                "application/json": {
                    "example": {
                        "detail": "Could not find video with id '{id}'."
                    }
                }
            }
        }

class VideoSearchQueryEmptyError(Exception):
    """Raises HTTP 422 if no video search query provided."""
    def __init__(self):
        self.openapi = {
            "description": "Invalid Query",
            "content": {
                "application/json": {
                    "example": {
                        "detail": "You must provide query or caption to look for videos."
                    }
                }
            }
        }

class SearchPageInvalidError(Exception):
    """Raises HTTP 400 if page or page size are not in valid range."""
    def __init__(self):
        self.openapi = {
            "description": "Invalid Page",
            "content": {
                "application/json": {
                    "example": {
                        "detail": "Parameters 'page' and 'page_size' must be greater or equal to 1."
                    }
                }
            }
        }

class SearchTokenInvalidError(Exception):
    """Raises HTTP 401 if search token is not valid."""
    def __init__(self):
        self.openapi = {
            "description": "Invalid Token",
            "content": {
                "application/json": {
                    "example": {
                        "detail": "Invalid search token."
                    }
                }
            }
        }

class UserEmailCodeInvalid(Exception):
    """Raises HTTP 400 if email confirmation code is not valid."""
    def __init__(self):
        self.openapi = {
            "description": "Invalid Email Code",
            "content": {
                "application/json": {
                    "example": {
                        "detail": "Confirmation code is invalid."
                    }
                }
            }
        }

class UserAlreadyExists(Exception):
    """Raises HTTP 409 if user with this name already exists."""
    def __init__(self):
        self.openapi = {
            "description": "User Already Exists",
            "content": {
                "application/json": {
                    "example": {
                        "detail": "User with this username already exists."
                    }
                }
            }
        }

class UserCredentialsInvalid(Exception):
    """Raises HTTP 401 if user credentials are not valid."""
    def __init__(self):
        self.openapi = {
            "description": "Invalid Credentials",
            "content": {
                "application/json": {
                    "example": {
                        "detail": "Invalid credentials."
                    }
                }
            }
        }