Skip to content

Commit 8a67ad2

Browse files
committed
Renamed the errors. fixes intercom#1
1 parent 6b6b2e5 commit 8a67ad2

File tree

7 files changed

+30
-30
lines changed

7 files changed

+30
-30
lines changed

intercom/__init__.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,9 @@ def wrapper(instance, value):
2626
return wrapper
2727

2828

29+
from .intercom import AuthenticationError
30+
from .intercom import ResourceNotFound
31+
from .intercom import ServerError
2932
from .intercom import Intercom
3033
from .user import User
3134
from .message_thread import MessageThread

intercom/intercom.py

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -16,16 +16,13 @@ def __init__(self, message, result=None):
1616
super(IntercomError, self).__init__(message)
1717
self.result = result
1818

19-
class AuthConfigError(IntercomError):
19+
class AuthenticationError(IntercomError):
2020
pass
2121

22-
class AuthError(IntercomError):
22+
class ResourceNotFound(IntercomError):
2323
pass
2424

25-
class NotFoundError(IntercomError):
26-
pass
27-
28-
class APIError(IntercomError):
25+
class ServerError(IntercomError):
2926
pass
3027

3128
def api_call(func_to_decorate):
@@ -35,16 +32,16 @@ def wrapper(*args, **kwargs):
3532
""" Decorator closure. """
3633
response = func_to_decorate(*args, **kwargs)
3734
if response.status_code == 401:
38-
raise AuthError("Invalid API key/username provided.")
35+
raise AuthenticationError("Invalid API key/username provided.")
3936
result = json.loads(response.content)
4037
if response.status_code in (200, 201):
4138
pass
4239
else:
4340
message = result['error']['message']
4441
if response.status_code == 404:
45-
raise NotFoundError(message, result)
42+
raise ResourceNotFound(message, result)
4643
else:
47-
raise APIError(message, result)
44+
raise ServerError(message, result)
4845
return result
4946
return wrapper
5047

tests/integration/test.py

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
from unittest import TestCase
22

3-
from intercom.intercom import AuthError
4-
from intercom.intercom import APIError
5-
from intercom.intercom import NotFoundError
3+
from intercom import AuthenticationError
4+
from intercom import ResourceNotFound
5+
from intercom import ServerError
66
from intercom import Intercom
77
from intercom import User
88
from intercom import MessageThread
@@ -19,15 +19,15 @@ def test_user(self):
1919
user = User.find(email='somebody@example.com')
2020
self.assertEqual('Somebody', user.name)
2121

22-
@raises(NotFoundError)
22+
@raises(ResourceNotFound)
2323
def test_not_found(self):
2424
User.find(email='not-found@example.com')
2525

26-
@raises(APIError)
26+
@raises(ServerError)
2727
def test_server_error(self):
2828
User.find(email='server-error@example.com')
2929

30-
@raises(AuthError)
30+
@raises(AuthenticationError)
3131
def test_bad_api_key(self):
3232
try:
3333
Intercom.app_id = 'bad-app-id'

tests/unit/test_impression.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,12 +14,12 @@
1414

1515
from . import create_response
1616

17-
from intercom.intercom import AuthError
17+
from intercom.intercom import AuthenticationError
1818
from intercom import Impression
1919

2020
class ImpressionTest(TestCase):
2121

22-
@raises(AuthError)
22+
@raises(AuthenticationError)
2323
@patch('requests.request', create_response(401))
2424
def test_create_impression_identifiers(self):
2525
Impression.create()

tests/unit/test_intercom.py

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -11,17 +11,17 @@
1111
from nose.tools import raises
1212
from unittest import TestCase
1313

14-
from intercom.intercom import APIError
15-
from intercom.intercom import AuthError
16-
from intercom.intercom import NotFoundError
14+
from intercom import ServerError
15+
from intercom import AuthenticationError
16+
from intercom import ResourceNotFound
1717
from intercom import Intercom
1818
from intercom.user import CustomData
1919
from intercom.user import SocialProfile
2020
from intercom.user import User
2121

2222
class IntercomUsersTest(TestCase):
2323

24-
@raises(AuthError)
24+
@raises(AuthenticationError)
2525
@patch('requests.request', create_response(401))
2626
def test_create_user_identifiers(self):
2727
Intercom.create_user()
@@ -32,7 +32,7 @@ def test_create_valid(self):
3232
self.assertEqual(None, resp['user_id'])
3333
self.assertEqual('xxx@example.com', resp['email'])
3434

35-
@raises(AuthError)
35+
@raises(AuthenticationError)
3636
@patch('requests.request', create_response(401))
3737
def test_get_user_identifiers(self):
3838
Intercom.get_user()
@@ -43,7 +43,7 @@ def test_get_user_valid(self):
4343
self.assertEqual(None, resp['user_id'])
4444
self.assertEqual('xxx@example.com', resp['email'])
4545

46-
@raises(AuthError)
46+
@raises(AuthenticationError)
4747
@patch('requests.request', create_response(401))
4848
def test_create_user_identifiers(self):
4949
Intercom.update_user()
@@ -56,7 +56,7 @@ def test_update_user_valid(self):
5656
self.assertEqual('xxx@example.com', resp['email'])
5757
self.assertEqual('42', resp['custom_data']['age'])
5858

59-
@raises(AuthError)
59+
@raises(AuthenticationError)
6060
@patch('requests.request', create_response(401))
6161
def test_get_users_identifiers(self):
6262
Intercom.create_user()
@@ -68,12 +68,12 @@ def test_get_users_valid(self):
6868
self.assertEqual(3, resp['total_count'])
6969
self.assertEqual(1, resp['total_pages'])
7070

71-
@raises(NotFoundError)
71+
@raises(ResourceNotFound)
7272
@patch('requests.request', create_response(404, '404.json'))
7373
def test_not_found(self):
7474
resp = Intercom.get_users()
7575

76-
@raises(APIError)
76+
@raises(ServerError)
7777
@patch('requests.request', create_response(500, '500.json'))
7878
def test_api_error(self):
7979
resp = Intercom.get_users()

tests/unit/test_message_thread.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,11 +16,11 @@
1616

1717
from intercom import Intercom
1818
from intercom.message_thread import MessageThread
19-
from intercom.intercom import AuthError
19+
from intercom import AuthenticationError
2020

2121
class MessageThreadTest(TestCase):
2222

23-
@raises(AuthError)
23+
@raises(AuthenticationError)
2424
@patch('requests.request', create_response(401))
2525
def test_get_message_threads_identifiers(self):
2626
MessageThread.find_all()

tests/unit/test_user.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414

1515
from . import create_response
1616

17-
from intercom.intercom import AuthError
17+
from intercom import AuthenticationError
1818
from intercom.user import CustomData
1919
from intercom.user import LocationData
2020
from intercom.user import SocialProfile
@@ -105,7 +105,7 @@ def test_create(self):
105105
self.assertEqual(None, user.user_id)
106106
self.assertEqual('xxx@example.com', user.email)
107107

108-
@raises(AuthError)
108+
@raises(AuthenticationError)
109109
@patch('requests.request', create_response(401))
110110
def test_find_identifiers(self):
111111
User.find()

0 commit comments

Comments
 (0)