Surface server_error in the Python SDK

Summary: This diff changes the Python SDK to expose `server_error` when available.

Test Plan: Mocked the error in the unit tests and wrote tests for all cases.

Reviewers: emfree

Reviewed By: emfree

Projects: #python-sdk

Differential Revision: https://phab.nylas.com/D2048

Author: khamidou

README.md

@@ -231,7 +231,20 @@ draft.to = [{'name': 'My Friend', 'email': '[email protected]'}]
 draft.subject = "Here's an attachment"
 draft.body = "Cheers mate!"
 draft.attach(myfile)
-draft.send()
+
+# Send it
+try:
+    draft.send()
+except nylas.client.errors.ConnectionError as e:
+    print "Unable to connect to the SMTP server."
+except nylas.client.errors.MessageRejectedError as e:
+    print "Message got rejected by the SMTP server!"
+    print e.message
+
+    # Sometimes the API gives us the exact error message
+    # returned by the server. Display it since it can be
+    # helpful to know exactly why our message got rejected:
+    print e.server_error
 ```
 
 ### Working with Events

nylas/client/client.py

@@ -52,12 +52,15 @@ def _validate(response):
         cls = status_code_to_exc[status_code]
         try:
             response = json.loads(response.text)
-            if 'message' in response:
-                raise cls(url=url, status_code=status_code,
-                          data=data, message=response['message'])
-            else:
-                raise cls(url=url, status_code=status_code,
-                          data=data, message="N/A")
+            kwargs = dict(url=url, status_code=status_code,
+                          data=data)
+
+            for key in ['message', 'server_error']:
+                if key in response:
+                    kwargs[key] = response[key]
+
+            raise cls(**kwargs)
+
         except (ValueError, TypeError):
             raise cls(url=url, status_code=status_code,
                       data=data, message="Malformed")

nylas/client/errors.py

@@ -3,12 +3,15 @@
 
 class APIClientError(Exception):
     def __init__(self, **kwargs):
+        if 'message' in kwargs:
+            Exception.__init__(self, kwargs['message'])
+        else:
+            Exception.__init__(self, '')
+
         self.attrs = kwargs.keys()
         for k, v in kwargs.items():
             setattr(self, k, v)
 
-        Exception.__init__(self, str(kwargs))
-
     def as_dict(self):
         resp = {}
         for attr in self.attrs:
@@ -61,3 +64,7 @@ class ServiceUnavailableError(APIClientError):
 
 class ServerTimeoutError(APIClientError):
     pass
+
+
+class FileUploadError(APIClientError):
+    pass

nylas/client/restful_models.py

@@ -1,4 +1,5 @@
 from .restful_model_collection import RestfulModelCollection
+from .errors import FileUploadError
 from six import StringIO
 import base64
 import json
@@ -367,8 +368,9 @@ def save(self):
         elif hasattr(self, 'data') and self.data is not None:
             data = {self.filename: StringIO(self.data)}
         else:
-            raise Exception("File object not properly formatted, must provide"
-                            " either a stream or data.")
+            raise FileUploadError(message=("File object not properly "
+                                               "formatted, must provide "
+                                               "either a stream or data."))
 
         new_obj = self.api._create_resources(File, data)
         new_obj = new_obj[0]
@@ -378,7 +380,8 @@ def save(self):
 
     def download(self):
         if not self.id:
-            raise Exception("Can't download a file that hasn't been uploaded.")
+            raise FileUploadError(message=("Can't download a file that "
+                                               "hasn't been uploaded."))
 
         return self.api._get_resource_data(File, self.id,
                                            extra='download')

tests/test_files.py

@@ -4,7 +4,7 @@
 import httpretty
 from httpretty import Response
 from conftest import API_URL
-from nylas.client.errors import InvalidRequestError
+from nylas.client.errors import InvalidRequestError, FileUploadError
 
 
 def test_file_upload(api_client):
@@ -23,13 +23,25 @@ def test_file_upload(api_client):
     httpretty.register_uri(httpretty.GET, API_URL + '/files/3qfe4k3siosfjtjpfdnon8zbn/download',
                            body='test body')
 
-    myfile2 = api_client.files.create()
-    myfile2.filename = 'test.txt'
-    myfile2.data = "Hello World."
-    myfile2.save()
+    myfile = api_client.files.create()
+    myfile.filename = 'test.txt'
+    myfile.data = "Hello World."
+    myfile.save()
 
-    assert myfile2.filename == 'a.txt'
-    assert myfile2.size == 762878
+    assert myfile.filename == 'a.txt'
+    assert myfile.size == 762878
 
-    data = myfile2.download()
+    data = myfile.download()
     assert data == 'test body'
+
+
+def test_file_upload_errors(api_client):
+    myfile = api_client.files.create()
+    myfile.filename = 'test.txt'
+    myfile.data = "Hello World."
+
+    with pytest.raises(FileUploadError) as exc:
+        myfile.download()
+
+    assert exc.value.message == ("Can't download a file that "
+                                 "hasn't been uploaded.")

tests/test_send_error_handling.py

@@ -8,12 +8,17 @@
 API_URL = 'http://localhost:2222'
 
 
-def mock_sending_error(http_code, message):
+def mock_sending_error(http_code, message, server_error=None):
     send_endpoint = re.compile(API_URL + '/send')
-    response_body = json.dumps({
+    response_body = {
         "type": "api_error",
         "message": message
-    })
+    }
+
+    if server_error is not None:
+        response_body['server_error'] = server_error
+
+    response_body = json.dumps(response_body)
     responses.add(responses.POST, send_endpoint,
                   content_type='application/json', status=http_code,
                   body=response_body)
@@ -48,3 +53,30 @@ def test_handle_service_unavailable(api_client, mock_account,
     with pytest.raises(ServiceUnavailableError) as exc:
         draft.send()
     assert exc.value.message == error_message
+
+
+@responses.activate
+def test_returns_server_error(api_client, mock_account,
+                              mock_save_draft):
+    draft = api_client.drafts.create()
+    error_message = 'The server unexpectedly closed the connection'
+    reason = 'Rejected potential SPAM'
+    mock_sending_error(503, error_message,
+                       server_error=reason)
+    with pytest.raises(ServiceUnavailableError) as exc:
+        draft.send()
+
+    assert exc.value.message == error_message
+    assert exc.value.server_error == reason
+
+
+@responses.activate
+def test_doesnt_return_server_error_if_not_defined(api_client, mock_account,
+                                                   mock_save_draft):
+    draft = api_client.drafts.create()
+    error_message = 'The server unexpectedly closed the connection'
+    mock_sending_error(503, error_message)
+    with pytest.raises(ServiceUnavailableError) as exc:
+        draft.send()
+    assert exc.value.message == error_message
+    assert not hasattr(exc.value, 'server_error')