using GanException for validation errors and response.raise_for_status HTTPError for api problems

Author: Rasmus Lager

ganapi/__init__.py

@@ -4,4 +4,5 @@
 from list_manager import ListManager
 from attribute import Attribute
 from contact import Contact
-from list import List
+from list import List
+from gan_exception import GanException

ganapi/api.py

@@ -1,9 +1,6 @@
 import json
 import requests
-import math
-from requests.exceptions import RequestException
-
-
+from gan_exception import GanException
 class Api(object):
     """
         Handles connection to the API
@@ -41,7 +38,7 @@ def call(self, method, resource_path, payload=None):
             :param resource_path string The path to the resource (e.g. contacts/john@example.com/)
             :param payload string The data that is sent to the service. Not used for GET or DELETE.
             :return response The Requests response object from the service.
-            :raises Exception
+            :raises GanException in case of invalid HTTP method or HTTPError
         """
         uri = u'{base_uri}{resource_path}'.format(base_uri=self.base_uri,
                                                   resource_path=resource_path)
@@ -59,8 +56,10 @@ def call(self, method, resource_path, payload=None):
             response = requests.put(uri, headers=self.headers, data=payload)
         elif method == 'PATCH':
             response = requests.patch(uri, headers=self.headers, data=payload)
+        else:
+            raise GanException(u'Invalid HTTP method',
+                               u'{method} is not a valid HTTP method! Valid HTTP methods are GET, POST, DELETE, PUT, PATCH.'.format(method=method))
 
-        if math.floor(response.status_code / 100) != 2:
-            raise RequestException(response.status_code, response.content)
+        response.raise_for_status()
 
-        return response
+        return response

ganapi/entity_manager.py

@@ -1,6 +1,6 @@
 import urllib
 from helpers import PaginatedResultSet
-
+from api import GanException
 
 class EntityManager(object):
     """
@@ -67,7 +67,7 @@ def lookup_path(self, entity):
 
         lookup_field = self.lookup_field
         if not getattr(entity, lookup_field):
-            raise Exception(u'Missing required property: {lookup_field}'.format(lookup_field=lookup_field))
+            raise GanException(u'Missing required property', u'Missing: {lookup_field}'.format(lookup_field=lookup_field))
 
         return self.get_path(getattr(entity, lookup_field))
 
@@ -134,8 +134,8 @@ def save(self, entity, overwrite=False):
         :param entity: The entity object to update/save.
         :param overwrite: Set to True if you want
         :return: The updated/created entity.
-        :raises RequestException if there is an error from the API
-        :raises Exception if the normalixation fails, i.e. missing lookup field.
+        :raises HTTPError if there is an error from the API
+        :raises GanException if the normalization fails, i.e. missing lookup field.
         """
         data = self.normalize_entity(entity)
         if overwrite:

ganapi/gan_exception.py

@@ -0,0 +1,8 @@
+class GanException(Exception):
+    def __init__(self, error_type, error_message, *args, **kwargs):
+        self.error_type = error_type
+        self.error_message = error_message
+
+    def __str__(self):
+        return u'({error_type}) {error_message}'.format(error_type=self.error_type,
+                                                        error_message=self.error_message)

ganapi/test_attribute_manager.py

@@ -3,6 +3,7 @@
 from attribute import Attribute
 from attribute_manager import AttributeManager
 from httmock import HTTMock, all_requests
+from requests import HTTPError
 
 
 class ContactManagerTest(unittest.TestCase):
@@ -29,15 +30,15 @@ def test_get_existing_attribute(self):
 
     @all_requests
     def get_non_existing_attribute_mock(self, url, request):
-        self.assertEqual(url.path, self.start_path + '/attribute/non_existing/')
+        self.assertEqual(url.path, self.start_path + '/attributes/non_existing/')
         status_code = 404
         content = '{"detail":"Not found."}'
         return {'status_code': status_code,
                 'content': content}
 
     def test_get_non_existing_attribute(self):
         with HTTMock(self.get_non_existing_attribute_mock):
-            self.assertRaises(Exception, self.attribute_manager.get, 'not_existing')
+            self.assertRaises(HTTPError, self.attribute_manager.get, 'non_existing')
 
     @all_requests
     def create_attribute_mock(self, url, request):

ganapi/test_contact_manager.py

@@ -1,9 +1,9 @@
 import unittest
-from api import Api
+from api import Api, GanException
 from contact import Contact
 from contact_manager import ContactManager
 from httmock import HTTMock, all_requests
-
+from requests import HTTPError
 
 class ContactManagerTest(unittest.TestCase):
     def setUp(self):
@@ -48,11 +48,7 @@ def non_existing_contact_mock(self, url, request):
 
     def test_non_existing_contact(self):
         with HTTMock(self.non_existing_contact_mock):
-            try:
-                non_existing_contact = self.contact_manager.get('noone@nothing.com')
-            except Exception as e:
-                self.assertEqual(e[0], 404)
-                self.assertEqual(e[1], '{"detail":"Not found."}')
+            self.assertRaises(HTTPError, self.contact_manager.get, 'noone@nothing.com')
 
     @all_requests
     def create_new_contact_mock(self, url, request):
@@ -94,7 +90,7 @@ def test_update_without_email(self):
         contact = self.contact_manager.create()
         contact.first_name = 'John'
         contact.set_persisted()
-        self.assertRaises(Exception, contact.save)
+        self.assertRaises(GanException, contact.save)
 
     @all_requests
     def overwrite_contact_mock(self, url, request):

ganapi/test_list_manager.py

@@ -3,7 +3,7 @@
 from list import List
 from list_manager import ListManager
 from httmock import HTTMock, all_requests
-
+from gan_exception import GanException
 
 class ListManagerTest(unittest.TestCase):
     def setUp(self):
@@ -32,7 +32,7 @@ def test_update_without_hash(self):
         list.name = 'list'
         list.sender = 'John Doe'
         list.set_persisted()
-        self.assertRaises(Exception, list.save)
+        self.assertRaises(GanException, list.save)
 
     @all_requests
     def create_new_list_mock(self, url, request):