projectal.errors

  1from requests import HTTPError
  2
  3try:
  4    from simplejson.errors import JSONDecodeError
  5except ImportError:
  6    from json.decoder import JSONDecodeError
  7
  8
  9class LoginException(Exception):
 10    """Failed to log in with the credentials provided."""
 11
 12    pass
 13
 14
 15class UnsupportedException(Exception):
 16    """The API endpoint is not available for this entity."""
 17
 18    pass
 19
 20
 21class ProjectalException(Exception):
 22    """
 23    The API request failed. This exception will extract the specific
 24    error from the Projectal response if it can find one. To assist
 25    in debugging, the response object is attached to the exception
 26    which you may inspect for more precise details.
 27
 28    In case of failure of a bulk operation, only the error clue for
 29    the first failure is shown. A counter is included to show how
 30    many failed (i.e.: 1 of 25).
 31    """
 32
 33    def __init__(self, response, reason_message=None):
 34        """
 35        `response`: the response object
 36
 37        `reason_message`: if provided, will use this message as the cause
 38        of failure instead of assuming it was a misuse of the API.
 39        """
 40        self.response = response
 41        self.url = response.url
 42        self.body = response.request.body
 43        self.json = None
 44        self.message = None
 45        code = response.status_code
 46
 47        try:
 48            self.json = response.json()
 49        except JSONDecodeError:
 50            pass
 51
 52        # Did we get a 200 response but (manually) raised anyway? The consumer
 53        # method considered this an error. If it did, it MUST tell us why in
 54        # the message parameter. We pass this message on to the user.
 55        if code != 207:
 56            try:
 57                response.raise_for_status()
 58                if reason_message:
 59                    self.message = reason_message
 60                else:
 61                    self.message = "Unexpected response (API client error)"
 62            except HTTPError:
 63                pass
 64
 65        if code == 400 and not self.json:
 66            self.message = "Client request error"
 67        if code == 500:
 68            self.message = "Internal server error"
 69        if self.json and (code == 400 or code == 422 or code == 207):
 70            if self.json.get("feedbackList", False):
 71                self.feedback = [f for f in self.json.get("feedbackList", [])] or None
 72                clue = [
 73                    f["clue"]
 74                    for f in self.json["feedbackList"]
 75                    if f["clue"] not in ["OK", "Created"]
 76                ]
 77                hint = [
 78                    f["hint"].replace("'", '"')
 79                    for f in self.json["feedbackList"]
 80                    if f["clue"] not in ["OK", "Created"]
 81                ]
 82                if len(clue) == 1:
 83                    clue_part = " - Clue: {} ({})".format(clue[0], hint[0])
 84                else:
 85                    clue_part = " - Clue 1 of {}: {} ({})".format(
 86                        len(clue), clue[0], hint[0]
 87                    )
 88            else:
 89                # No feedback list, but clue in top-leel of dict
 90                clue = self.json["jobClue"]["clue"]
 91                hint = self.json["jobClue"]["hint"].replace("'", '"')
 92                clue_part = " - Clue: {} ({})".format(clue, hint)
 93            self.message = self.json["status"] + clue_part
 94
 95        if not self.message:
 96            self.message = "Request error: {}".format(code)
 97        super().__init__(self.message)
 98
 99
100class ProjectalVersionException(Exception):
101    """
102    The Projectal server version is incompatible with the version
103    of this library.
104    """
105
106    pass
107
108
109class UsageException(Exception):
110    """
111    The library was used incorrectly and we were able to detect it
112    before making a request.
113    """
114
115    pass