Refactor package exception class names to improve clarity

Change package exception names to more clearly delineate the top level
‘package’ exception class (now ‘ciscosparkapiException’) from the
exceptions raised in response to error response codes from the Spark
cloud (now ‘SparkApiError’).

Also update module code organization to consistently place module
constants immediately following the module’s import statements.

Author: cmlccie

ciscosparkapi/exceptions.py

@@ -1,11 +1,4 @@
-"""ciscosparkapi package-level exceptions."""
-
-
-class CiscoSparkApiException(Exception):
-    """Base class for all ciscosparkapi package exceptions."""
-
-    def __init__(self, *args, **kwargs):
-        super(CiscoSparkApiException, self).__init__(*args, **kwargs)
+"""ciscosparkapi exception classes."""
 
 
 SPARK_RESPONSE_CODES = {
@@ -26,7 +19,14 @@ def __init__(self, *args, **kwargs):
 }
 
 
-class CiscoSparkApiError(CiscoSparkApiException):
+class ciscosparkapiException(Exception):
+    """Base class for all ciscosparkapi package exceptions."""
+
+    def __init__(self, *args, **kwargs):
+        super(ciscosparkapiException, self).__init__(*args, **kwargs)
+
+
+class SparkApiError(ciscosparkapiException):
     """Errors returned by requests to the Cisco Spark cloud APIs."""
 
     def __init__(self, response_code, request=None, response=None):
@@ -37,7 +37,9 @@ def __init__(self, response_code, request=None, response=None):
         response_text = SPARK_RESPONSE_CODES.get(response_code)
         if response_text:
             self.response_text = response_text
-            error_message = "[%s]: %s" % (response_code, response_text)
+            error_message = "Response Code [%s] - %s" % \
+                            (response_code, response_text)
         else:
-            error_message = "[%s]: Unknown Response Code" % response_code
-        super(CiscoSparkApiError, self).__init__(error_message)
+            error_message = "Response Code [%s] - Unknown Response Code" % \
+                            response_code
+        super(SparkApiError, self).__init__(error_message)

ciscosparkapi/restsession.py

@@ -3,17 +3,19 @@
 
 import urlparse
 import requests
-import exceptions
+from .exceptions import ciscosparkapiException, SparkApiError
 
 
 # Default api.ciscospark.com base URL
 DEFAULT_API_URL = 'https://api.ciscospark.com/v1/'
 
 # Cisco Spark cloud Expected Response Codes (HTTP Response Codes)
-ERC = {'GET': 200,
-       'POST': 200,
-       'PUT': 200,
-       'DELETE': 204}
+ERC = {
+    'GET': 200,
+    'POST': 200,
+    'PUT': 200,
+    'DELETE': 204
+}
 
 
 def _validate_base_url(base_url):
@@ -23,7 +25,7 @@ def _validate_base_url(base_url):
     else:
         error_message = "base_url must contain a valid scheme (protocol " \
                         "specifier) and network location (hostname)"
-        raise exceptions.CiscoSparkApiException(error_message)
+        raise ciscosparkapiException(error_message)
 
 
 def _raise_if_extra_kwargs(kwargs):
@@ -33,9 +35,9 @@ def _raise_if_extra_kwargs(kwargs):
 
 def _check_response_code(response, erc):
     if response.status_code != erc:
-        raise exceptions.CiscoSparkApiError(response.status_code,
-                                            request=response.request,
-                                            response=response)
+        raise SparkApiError(response.status_code,
+                            request=response.request,
+                            response=response)
 
 
 def _extract_and_parse_json(response):
@@ -137,7 +139,7 @@ def get_items(self, url, params=None, **kwargs):
             else:
                 error_message = "'items' object not found in JSON data: %r" \
                                 % json_page
-                raise exceptions.CiscoSparkApiException(error_message)
+                raise ciscosparkapiException(error_message)
 
     def post(self, url, json_dict, **kwargs):
         # Process args