Move DEFAULT_BASE_URL and helper functions out of restsession.py

Move the DEFAULT_BASE_URL to the package __init__.py file, and move the
helper functions to helper.py.

Author: cmlccie

ciscosparkapi/__init__.py

@@ -8,22 +8,27 @@
 from api.teammemberships import TeamMembership, TeamMembershipsAPI
 from api.webhooks import Webhook, WebhooksAPI
 
+
+# Default base URL
+DEFAULT_BASE_URL = 'https://api.ciscospark.com/v1/'
+
+
 class CiscoSparkAPI(object):
     """Cisco Spark API wrapper class."""
 
-    def __init__(self, access_token, base_url=None, timeout=None):
+    def __init__(self, access_token, base_url=DEFAULT_BASE_URL, timeout=None):
         # Process args
         assert isinstance(access_token, basestring)
         # Process kwargs
         session_args = {}
-        if base_url:  session_args['base_url'] = base_url
-        if timeout:  session_args['timeout'] = timeout
+        if timeout:
+            session_args['timeout'] = timeout
 
         # Create API session
         # All of the API calls associated with a CiscoSparkAPI object will
         # leverage a single RESTful 'session' connecting to the Cisco Spark
         # cloud.
-        self.session = RestSession(access_token, **session_args)
+        self.session = RestSession(access_token, base_url, **session_args)
 
         # Spark API wrappers
         self.people = PeopleAPI(self.session)
@@ -45,3 +50,4 @@ def base_url(self):
     @property
     def timeout(self):
         return self.session.timeout
+

ciscosparkapi/helper.py

@@ -13,6 +13,71 @@
 
 
 import functools
+import urlparse
+
+from ciscosparkapi import ciscosparkapiException, SparkApiError
+
+
+# Cisco Spark cloud Expected Response Codes (HTTP Response Codes)
+ERC = {
+    'GET': 200,
+    'POST': 200,
+    'PUT': 200,
+    'DELETE': 204
+}
+
+
+def validate_base_url(base_url):
+    """Verify that base_url specifies a protocol and network location."""
+    parsed_url = urlparse.urlparse(base_url)
+    if parsed_url.scheme and parsed_url.netloc:
+        return parsed_url.geturl()
+    else:
+        error_message = "base_url must contain a valid scheme (protocol " \
+                        "specifier) and network location (hostname)"
+        raise ciscosparkapiException(error_message)
+
+
+def raise_if_extra_kwargs(kwargs):
+    """Raise a TypeError if kwargs is not empty."""
+    if kwargs:
+        raise TypeError("Unexpected **kwargs: %r" % kwargs)
+
+
+def check_response_code(response, erc):
+    """Check response code against the expected code; raise SparkApiError.
+
+    Checks the requests.response.status_code against the provided expected
+    response code (erc), and raises a SparkApiError if they do not match.
+
+    Args:
+        response(requests.response): The response object returned by a request
+            using the requests package.
+        erc(int): The expected response code (HTTP response code).
+
+    Raises:
+        SparkApiError: If the requests.response.status_code does not match the
+            provided expected response code (erc).
+
+     """
+    if response.status_code != erc:
+        raise SparkApiError(response.status_code,
+                            request=response.request,
+                            response=response)
+
+
+def extract_and_parse_json(response):
+    """Extract and parse the JSON data from an requests.response object.
+
+    Args:
+        response(requests.response): The response object returned by a request
+            using the requests package.
+
+    Returns:
+        The parsed JSON data as the appropriate native Python data type.
+
+    """
+    return response.json()
 
 
 def utf8(string):

ciscosparkapi/restsession.py

@@ -1,53 +1,18 @@
 """RestSession class for creating 'connections' to the Cisco Spark APIs."""
 
-
 import urlparse
-import requests
-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
-}
-
-
-def _validate_base_url(base_url):
-    parsed_url = urlparse.urlparse(base_url)
-    if parsed_url.scheme and parsed_url.netloc:
-        return parsed_url.geturl()
-    else:
-        error_message = "base_url must contain a valid scheme (protocol " \
-                        "specifier) and network location (hostname)"
-        raise ciscosparkapiException(error_message)
-
-
-def _raise_if_extra_kwargs(kwargs):
-    if kwargs:
-        raise TypeError("Unexpected **kwargs: %r" % kwargs)
-
-
-def _check_response_code(response, erc):
-    if response.status_code != erc:
-        raise SparkApiError(response.status_code,
-                            request=response.request,
-                            response=response)
 
+import requests
 
-def _extract_and_parse_json(response):
-    return response.json()
+from .exceptions import ciscosparkapiException
+from .helper import ERC, validate_base_url, \
+    raise_if_extra_kwargs, check_response_code, extract_and_parse_json
 
 
 class RestSession(object):
-    def __init__(self, access_token, base_url=DEFAULT_API_URL, timeout=None):
+    def __init__(self, access_token, base_url, timeout=None):
         super(RestSession, self).__init__()
-        self._base_url = _validate_base_url(base_url)
+        self._base_url = validate_base_url(base_url)
         self._access_token = access_token
         self._req_session = requests.session()
         self._timeout = None
@@ -91,13 +56,13 @@ def get(self, url, params=None, **kwargs):
         # Process kwargs
         timeout = kwargs.pop('timeout', self.timeout)
         erc = kwargs.pop('erc', ERC['GET'])
-        _raise_if_extra_kwargs(kwargs)
+        raise_if_extra_kwargs(kwargs)
         # API request
         response = self._req_session.get(abs_url, params=params,
                                          timeout=timeout)
         # Process response
-        _check_response_code(response, erc)
-        return _extract_and_parse_json(response)
+        check_response_code(response, erc)
+        return extract_and_parse_json(response)
 
     def get_pages(self, url, params=None, **kwargs):
         # Process args
@@ -107,14 +72,14 @@ def get_pages(self, url, params=None, **kwargs):
         # Process kwargs
         timeout = kwargs.pop('timeout', self.timeout)
         erc = kwargs.pop('erc', ERC['GET'])
-        _raise_if_extra_kwargs(kwargs)
+        raise_if_extra_kwargs(kwargs)
         # API request - get first page
         response = self._req_session.get(abs_url, params=params,
                                          timeout=timeout)
         while True:
             # Process response - Yield page's JSON data
-            _check_response_code(response, erc)
-            yield _extract_and_parse_json(response)
+            check_response_code(response, erc)
+            yield extract_and_parse_json(response)
             # Get next page
             if response.links.get('next'):
                 next_url = response.links.get('next').get('url')
@@ -148,12 +113,12 @@ def post(self, url, json, **kwargs):
         # Process kwargs
         timeout = kwargs.pop('timeout', self.timeout)
         erc = kwargs.pop('erc', ERC['POST'])
-        _raise_if_extra_kwargs(kwargs)
+        raise_if_extra_kwargs(kwargs)
         # API request
         response = self._req_session.post(abs_url, json=json, timeout=timeout)
         # Process response
-        _check_response_code(response, erc)
-        return _extract_and_parse_json(response)
+        check_response_code(response, erc)
+        return extract_and_parse_json(response)
 
     def put(self, url, json, **kwargs):
         # Process args
@@ -163,12 +128,12 @@ def put(self, url, json, **kwargs):
         # Process kwargs
         timeout = kwargs.pop('timeout', self.timeout)
         erc = kwargs.pop('erc', ERC['PUT'])
-        _raise_if_extra_kwargs(kwargs)
+        raise_if_extra_kwargs(kwargs)
         # API request
         response = self._req_session.put(abs_url, json=json, timeout=timeout)
         # Process response
-        _check_response_code(response, erc)
-        return _extract_and_parse_json(response)
+        check_response_code(response, erc)
+        return extract_and_parse_json(response)
 
     def delete(self, url, **kwargs):
         # Process args
@@ -177,8 +142,8 @@ def delete(self, url, **kwargs):
         # Process kwargs
         timeout = kwargs.pop('timeout', self.timeout)
         erc = kwargs.pop('erc', ERC['DELETE'])
-        _raise_if_extra_kwargs(kwargs)
+        raise_if_extra_kwargs(kwargs)
         # API request
         response = self._req_session.delete(abs_url, timeout=timeout)
         # Process response
-        _check_response_code(response, erc)
+        check_response_code(response, erc)