Add rich errors

Author: cbetta

amadeus/client/errors.py

@@ -13,16 +13,12 @@ class ResponseError(RuntimeError):
         ``NetworkError``, ``ParserError``, ``ServerError``,
         ``AuthenticationError``, ``NotFoundError`` and ``UnknownError``.
     :vartype code: str
-
-    :var description: The content of the response that describes the error
-    :vartype description: str
     '''
 
     def __init__(self, response):
         self.response = response
-        self.description = self.__determine_description()
         self.code = self.__determine_code()
-        RuntimeError.__init__(self, self.description)
+        RuntimeError.__init__(self, self.description())
 
     # PROTECTED
 
@@ -35,13 +31,51 @@ def _log(self, client):
 
     # PRIVATE
 
-    # extracts the error description from the response, if it exists
-    def __determine_description(self):
-        if (self.response and self.response.parsed):
-            if 'errors' in self.response.result:
-                return self.response.result['errors']
-            if 'error_description' in self.response.result:
-                return self.response.result
+    # Determines the description for this error, as used in in the error output
+    def description(self):
+        description = self.short_description(self.response)
+        return description + self.long_description(self.response)
+
+    # Determines the short description, printed after on the same line as the
+    # error class name
+    def short_description(self, response):
+        if hasattr(response, 'status_code') and response.status_code:
+            return '[{0}]'.format(response.status_code)
+        else:
+            return '[---]'
+
+    # Determines the longer description, printed after the initial error
+    def long_description(self, response):
+        message = ''
+        if not(response and response.parsed):
+            return message
+        if 'error_description' in response.result:
+            message += self.error_description(self.response)
+        if 'errors' in response.result:
+            message += self.errors_descriptions(self.response)
+        return message
+
+    # Returns the description of a single error
+    def error_description(self, response):
+        message = ''
+        if 'error' in response.result:
+            message += '\n{0}'.format(response.result['error'])
+        message += '\n{0}'.format(response.result['error_description'])
+        return message
+
+    # Returns the description of multiple errors
+    def errors_descriptions(self, response):
+        messages = map(self.errors_description, response.result['errors'])
+        return ''.join(messages)
+
+    # Returns the description of a single error in a multi error response
+    def errors_description(self, error):
+        message = '\n'
+        if ('source' in error) and ('parameter' in error['source']):
+            message += '[{0}] '.format(error['source']['parameter'])
+            if 'detail' in error:
+                message += error['detail']
+        return message
 
     # sets the error code to the name of this class
     def __determine_code(self):

specs/mixins/errors_spec.py

@@ -1,37 +1,62 @@
 from mamba import description, context, it, before
-from expects import expect, equal, be_none
+from expects import expect, equal
 from doublex import Stub, Spy
 from doublex_expects import have_been_called_with, have_been_called
 
 from amadeus import NetworkError, Response, Client
 
 with description('ResponseError') as self:
-    with context('.description'):
-        with it('should determine no description if no response is present'):
+    with context('str(error)'):
+        with it('should be undefine if no response is present'):
             error = NetworkError(None)
-            expect(error.description).to(be_none)
+            expect(str(error)).to(equal('[---]'))
 
-        with it('should determine no description if no data is present'):
+        with it('should just return the code if no data is present'):
             response = Stub(Response)
             response.parsed = True
             response.result = {}
+            response.status_code = 400
 
             error = NetworkError(response)
-            expect(error.description).to(be_none)
+            expect(str(error)).to(equal('[400]'))
 
-        with it('should be set if errors are present'):
+        with it('should be rich if errors are present'):
             response = Stub(Response)
             response.parsed = True
-            response.result = {'errors': [{'detail': 'error'}]}
+            response.result = {
+                'errors': [
+                    {
+                        'detail': 'This field must be filled.',
+                        'source': {'parameter': 'departureDate'}
+                    },
+                    {
+                         'detail': 'This field must be filled.',
+                         'source': {'parameter': 'origin'}
+                    },
+                    {
+                         'detail': 'This field must be filled.',
+                         'source': {'parameter': 'destination'}
+                    }
+                ]
+            }
+            response.status_code = 401
+
             error = NetworkError(response)
-            expect(error.description).to(equal([{'detail': 'error'}]))
+            expect(str(error)).to(equal(
+                ('''[401]
+[departureDate] This field must be filled.
+[origin] This field must be filled.
+[destination] This field must be filled.''')
+            ))
 
-        with it('should be set if an error_description is present'):
+        with it('should be rich if an error_description is present'):
             response = Stub(Response)
             response.parsed = True
             response.result = {'error_description': 'error'}
+            response.status_code = 401
+
             error = NetworkError(response)
-            expect(error.description).to(equal({'error_description': 'error'}))
+            expect(str(error)).to(equal('[401]\nerror'))
 
     with context('.code'):
         with it('should determine the code off the class name'):

tox.ini

@@ -13,7 +13,7 @@ deps =
   doublex-expects==0.7.0rc2
   flake8==3.5.0
   flake8-quotes==0.14.0
-usedevelop=true
+usedevelop=True
 
 [tox:travis]
 2.7 = py27