Refactor Exceptions

Author: cmlccie

docs/user/api.rst

@@ -126,11 +126,11 @@ Exceptions
     :show-inheritance:
     :members:
 
-.. autoexception:: SparkApiError()
+.. autoexception:: ApiError()
     :show-inheritance:
     :members:
 
-.. autoexception:: SparkRateLimitError()
+.. autoexception:: RateLimitError()
     :show-inheritance:
     :members:
 

docs/user/intro.rst

@@ -61,7 +61,7 @@ With webexteamsdk, the above Python code can be consolidated to the following:
         message = api.messages.create('<room_id>', text='<message_text>')
         print("New message created, with ID:", message.id)
         print(message.text)
-    except SparkApiError as e:
+    except ApiError as e:
         print(e)
 
 

docs/user/quickstart.rst

@@ -262,13 +262,13 @@ Catching Exceptions
 -------------------
 
 If something should go wrong with the API call, an exception will be raised.
-:exc:`SparkApiError` exceptions are raised when an error condition is
+:exc:`ApiError` exceptions are raised when an error condition is
 returned from the Webex Teams cloud.  Details will be provided in the error
 message.
 
 .. code-block:: python
 
-    >>> from webexteamsdk import CiscoSparkAPI, SparkApiError
+    >>> from webexteamsdk import CiscoSparkAPI, ApiError
     >>> api = CiscoSparkAPI()
     >>> room = api.rooms.create("webexteamsdk Test Room")
     >>> me = api.people.me()
@@ -281,19 +281,19 @@ message.
         check_response_code(response, erc)
       File "webexteamsdk/utils.py", line 104, in check_response_code
         response=response)
-    webexteamsdk.exceptions.SparkApiError: Response Code [409] - The request
+    webexteamsdk.exceptions.ApiError: Response Code [409] - The request
     could not be processed because it conflicts with some established rule of
     the system. For example, a person may not be added to a room more than
     once.
 
 You can catch any errors returned by the Webex Teams cloud by catching
-:exc:`SparkApiError` exceptions in a try-except block.
+:exc:`ApiError` exceptions in a try-except block.
 
 .. code-block:: python
 
     >>> try:
     ...     api.memberships.create(roomId=room.id, personId=me.id)
-    ... except SparkApiError as e:
+    ... except ApiError as e:
     ...     memberships = api.memberships.list(roomId=room.id)
     ...     for membership in memberships:
     ...         if membership.personId == me.id:

tests/api/test_memberships.py

@@ -83,7 +83,7 @@ def are_valid_memberships(iterable):
 def membership_exists(api, membership):
     try:
         get_membership_by_id(api, membership.id)
-    except webexteamsdk.SparkApiError:
+    except webexteamsdk.ApiError:
         return False
     else:
         return True

tests/api/test_messages.py

@@ -51,7 +51,7 @@ def are_valid_messages(iterable):
 def message_exists(api, message):
     try:
         api.messages.get(message.id)
-    except webexteamsdk.SparkApiError:
+    except webexteamsdk.ApiError:
         return False
     else:
         return True
@@ -95,7 +95,7 @@ def inner_function(roomId, **message_attributes):
     for message in messages:
         try:
             delete_message(api, message)
-        except webexteamsdk.SparkApiError as e:
+        except webexteamsdk.ApiError as e:
             pass
 
 

tests/api/test_people.py

@@ -66,7 +66,7 @@ def are_valid_people(iterable):
 def person_exists(api, person):
     try:
         get_person_by_id(api, person.id)
-    except webexteamsdk.SparkApiError:
+    except webexteamsdk.ApiError:
         return False
     else:
         return True

tests/api/test_rooms.py

@@ -29,7 +29,7 @@ def create_team_room(api, team, room_title):
 def delete_room(api, room):
     try:
         api.rooms.delete(room.id)
-    except webexteamsdk.SparkApiError as e:
+    except webexteamsdk.ApiError as e:
         if e.response.status_code == 404:
             # Room doesn't exist
             pass
@@ -48,7 +48,7 @@ def are_valid_rooms(iterable):
 def room_exists(api, room):
     try:
         api.rooms.get(room.id)
-    except webexteamsdk.SparkApiError:
+    except webexteamsdk.ApiError:
         return False
     else:
         return True

tests/api/test_teammemberships.py

@@ -64,7 +64,7 @@ def are_valid_team_memberships(iterable):
 def membership_exists(api, membership):
     try:
         get_team_membership_by_id(api, membership.id)
-    except webexteamsdk.SparkApiError:
+    except webexteamsdk.ApiError:
         return False
     else:
         return True

tests/api/test_teams.py

@@ -30,7 +30,7 @@ def get_team_details_by_id(api, team_id):
 def delete_team(api, team):
     try:
         api.teams.delete(team.id)
-    except webexteamsdk.SparkApiError as e:
+    except webexteamsdk.ApiError as e:
         if e.response.status_code == 404:
             # Team doesn't exist
             pass
@@ -49,7 +49,7 @@ def are_valid_teams(iterable):
 def team_exists(api, team):
     try:
         get_team_details_by_id(api, team.id)
-    except webexteamsdk.SparkApiError:
+    except webexteamsdk.ApiError:
         return False
     else:
         return True

tests/test_restsession.py

@@ -23,7 +23,7 @@
 def rate_limit_detected(w):
     """Check to see if a rate-limit warning is in the warnings list."""
     while w:
-        if issubclass(w.pop().category, webexteamsdk.SparkRateLimitWarning):
+        if issubclass(w.pop().category, webexteamsdk.RateLimitWarning):
             return True
             break
     return False