[TOOLSLIBS-503] Add retry to Airship (#192)

* adds retry on AirshipFailure

* cleanup

* adds backoff module

* adds retry prop test

Author: aschuman0

requirements-dev.txt

@@ -6,3 +6,4 @@ tox
 black
 pre-commit
 sphinx-rtd-theme
+backoff>=1.11

requirements.txt

@@ -3,3 +3,4 @@ six
 nose
 mock
 sphinx-rtd-theme
+backoff>=1.11

tests/core/test_airship.py

@@ -25,6 +25,13 @@ def test_airship_timeout_exception(self):
         with self.assertRaises(ValueError):
             ua.Airship(key=TEST_KEY, secret=TEST_SECRET, timeout=timeout_str)
 
+    def test_airship_retry(self):
+        retry_int = 5
+
+        airship_w_retry = ua.Airship(TEST_KEY, TEST_SECRET, retries=retry_int)
+
+        self.assertEqual(retry_int, airship_w_retry.retries)
+
     def test_airship_location(self):
         location = "eu"
 

urbanairship/core.py

@@ -1,6 +1,7 @@
 import logging
 import re
 
+import backoff
 import requests
 
 from . import __about__, common
@@ -67,7 +68,9 @@ def get(self, endpoint):
 
 
 class Airship(object):
-    def __init__(self, key, secret=None, token=None, location="us", timeout=None):
+    def __init__(
+        self, key, secret=None, token=None, location="us", timeout=None, retries=0
+    ):
         """Main client class for interacting with the Airship API.
 
         :param key: [required] An Airship project key used to authenticate
@@ -77,13 +80,17 @@ def __init__(self, key, secret=None, token=None, location="us", timeout=None):
         :param location: [optional] The Airship cloud site your project is associated
         with. Possible values: 'us', 'eu'. Defaults to 'us'.
         :param: timeout: [optional] An integer specifying the number of seconds used
-        for a timeout threshold
+        for a response timeout threshold
+        :param retries: [optional] An integer specifying the number of times to retry a
+        failed request. Retried requests use exponential backoff between requests.
+        Defaults to 0, no retry.
         """
         self.key = key
         self.secret = secret
         self.token = token
         self.location = location
         self.timeout = timeout
+        self.retries = retries
         self.urls = Urls(self.location)
 
         if all([secret, token]):
@@ -99,6 +106,14 @@ def __init__(self, key, secret=None, token=None, location="us", timeout=None):
         else:
             raise ValueError("Either token or secret must be included")
 
+    @property
+    def retries(self):
+        return self._retries
+
+    @retries.setter
+    def retries(self, value):
+        self._retries = value
+
     @property
     def timeout(self):
         return self._timeout
@@ -182,33 +197,46 @@ def _request(
         if encoding:
             headers["Content-Encoding"] = encoding
 
-        logger.debug(
-            "Making %s request to %s. Headers:\n\t%s\nBody:\n\t%s",
-            method,
-            url,
-            "\n\t".join("%s: %s" % (key, value) for (key, value) in headers.items()),
-            body,
+        @backoff.on_exception(
+            backoff.expo, common.AirshipFailure, max_tries=(self.retries + 1)
         )
+        def make_retryable_request(method, url, body, params, headers):
+            response = self.session.request(
+                method,
+                url,
+                data=body,
+                params=params,
+                headers=headers,
+                timeout=self.timeout,
+            )
 
-        response = self.session.request(
-            method, url, data=body, params=params, headers=headers, timeout=self.timeout
-        )
+            logger.debug(
+                "Making %s request to %s. Headers:\n\t%s\nBody:\n\t%s",
+                method,
+                url,
+                "\n\t".join(
+                    "%s: %s" % (key, value) for (key, value) in headers.items()
+                ),
+                body,
+            )
 
-        logger.debug(
-            "Received %s response. Headers:\n\t%s\nBody:\n\t%s",
-            response.status_code,
-            "\n\t".join(
-                "%s: %s" % (key, value) for (key, value) in response.headers.items()
-            ),
-            response.content,
-        )
+            logger.debug(
+                "Received %s response. Headers:\n\t%s\nBody:\n\t%s",
+                response.status_code,
+                "\n\t".join(
+                    "%s: %s" % (key, value) for (key, value) in response.headers.items()
+                ),
+                response.content,
+            )
+
+            if response.status_code == 401:
+                raise common.Unauthorized
+            elif not (200 <= response.status_code < 300):
+                raise common.AirshipFailure.from_response(response)
 
-        if response.status_code == 401:
-            raise common.Unauthorized
-        elif not (200 <= response.status_code < 300):
-            raise common.AirshipFailure.from_response(response)
+            return response
 
-        return response
+        return make_retryable_request(method, url, body, params, headers)
 
     def create_push(self):
         """Create a Push notification."""