bedrock.exceptions

 5class BadRequestException(BedrockException):  # pragma: unit
 6    """
 7    Throw this exception when the client has sent a bad request.
 8
 9    Default HTTP code: 400.
10    """
11    def __init__(self, message="Bad request", exception=None):
12        super().__init__(message, exception, error_code=400)

 5class BedrockException(Exception):  # pragma: unit
 6    """
 7    A generic exception that can be thrown to return a user-friendly error to the client.
 8
 9    Default HTTP code: 500.
10    """
11    def __init__(self, message, original_exception=None, error_code=500):
12        self.message = message
13        self.error_code = error_code
14        if original_exception is None:
15            self.original_exception = traceback.format_exc()
16        else:
17            self.original_exception = original_exception
18        super().__init__(self.message)

 5class ConflictingObjectException(BedrockException):  # pragma: unit
 6    """
 7    Throw this exception when the client has sent a request that conflicts with an existing object.
 8
 9    Default HTTP code: 409.
10    """
11    def __init__(self, cls, unique_identifiers):
12        unique_identifiers_string = ', '.join(unique_identifiers)
13        unique_identifiers_message = (f"{cls.__name__} requires each or a combination of {unique_identifiers_string}"
14                                      f" to be unique. ")
15        super().__init__(f"{cls.__name__} already exists. {unique_identifiers_message}", error_code=409)

 5class ForbiddenException(BedrockException):  # pragma: unit
 6    """
 7    Throw this exception when the client is not authorised to access a resource but has provided valid credentials.
 8
 9    Default HTTP code: 403.
10    """
11    def __init__(self, exception=None):
12        super().__init__("Forbidden", exception, error_code=403)

 5class InvalidConfigurationException(BedrockException):  # pragma: unit
 6    """
 7    Throw this exception when the application is missing config or has invalid config.
 8
 9    Default HTTP code: 500.
10    """
11    invalid_items = []
12
13    def __init__(self, invalid_items):
14        self.invalid_items = invalid_items
15        invalid_items_as_string = ", ".join(invalid_items)
16        super().__init__(f"Invalid configuration options: {invalid_items_as_string}", error_code=400)

 5class NotFoundException(BedrockException):  # pragma: unit
 6    """
 7    Throw this exception when the client has requested a non-existing resource (or is not authorised to access it).
 8
 9    Default HTTP code: 404.
10    """
11    def __init__(self, message="Resource not found", exception=None):
12        super().__init__(message, exception, error_code=404)

 5class NotImplementedException(BedrockException):  # pragma: unit
 6    """
 7    Throw this exception when the client has requested a resource or action that is not implemented.
 8
 9    Default HTTP code: 501.
10    """
11    def __init__(self, exception=None):
12        super().__init__("Not implemented", exception, error_code=501)

 5class ObjectValidationException(BedrockException):  # pragma: unit
 6    """
 7    Throw this exception when the client has sent a request that doesn't pass validation (e.g. a body with nulls for
 8    fields that are not nullable).
 9
10    Default HTTP code: 400.
11    """
12    invalid_items = []
13
14    def __init__(self, cls, invalid_items):
15        self.invalid_items = invalid_items
16        invalid_items_as_string = ", ".join(invalid_items)
17        super().__init__(f"Invalid {cls.__name__} items: {invalid_items_as_string}", error_code=400)

 5class UnauthorisedException(BedrockException):  # pragma: unit
 6    """
 7    Throw this exception when the client is not authorised to access a resource because it has not provided valid credentials.
 8
 9    Default HTTP code: 401.
10    """
11    def __init__(self, message="Unauthorised", exception=None):
12        super().__init__(message, exception, error_code=401)