Merge pull request #162 from urbanairship/TOOLSLIBS-354-appkey-header

[TOOLSLIBS-354] Adds App Key to user agent string

Author: aschuman0

CHANGELOG

@@ -1,3 +1,8 @@
+--------------------
+5.5.1
+--------------------
+- Adds app key to user agent string
+
 --------------------
 5.5.0
 --------------------

tests/reports/test_response_statistics.py

@@ -272,7 +272,7 @@ def test_empty_date(self):
 
 
 class TestOptInList(unittest.TestCase):
-    test_class = ua.reports.OptInList
+    class_to_test = ua.reports.OptInList
     response_key = 'optins'
 
     def test_list(self):
@@ -305,7 +305,7 @@ def test_list(self):
         end_date = datetime(2012, 4, 1)
         precision = 'MONTHLY'
 
-        response_list = self.test_class(
+        response_list = self.class_to_test(
             airship,
             start_date,
             end_date,
@@ -381,30 +381,30 @@ def test_empty_precision(self):
 
 
 class TestOptOutList(TestOptInList):
-    test_class = ua.reports.OptOutList
+    class_to_test = ua.reports.OptOutList
     response_key = 'optouts'
 
 
 class TestPushList(TestOptInList):
-    test_class = ua.reports.PushList
+    class_to_test = ua.reports.PushList
     response_key = 'sends'
 
 
 class TestResponseReportList(TestOptInList):
-    test_class = ua.reports.ResponseReportList
+    class_to_test = ua.reports.ResponseReportList
     response_key = 'responses'
 
 
 class TestAppOpensList(TestOptInList):
-    test_class = ua.reports.AppOpensList
+    class_to_test = ua.reports.AppOpensList
     response_key = 'opens'
 
 
 class TestTimeInAppList(TestOptInList):
-    test_class = ua.reports.TimeInAppList
+    class_to_test = ua.reports.TimeInAppList
     response_key = 'timeinapp'
 
 
 class TestCustomEventsList(TestOptInList):
-    test_class = ua.reports.CustomEventsList
+    class_to_test = ua.reports.CustomEventsList
     response_key = 'events'

urbanairship/__about__.py

@@ -1,2 +1,2 @@
 
-__version__ = '5.5.0'
+__version__ = '5.5.1'

urbanairship/core.py

@@ -6,67 +6,66 @@
 from . import common, __about__
 from .push import Push, ScheduledPush, TemplatePush
 
-logger = logging.getLogger('urbanairship')
+logger = logging.getLogger("urbanairship")
 
-VALID_KEY = re.compile(r'^[\w-]{22}$')
-VALID_LOCATIONS = ['eu', 'us', None]
+VALID_KEY = re.compile(r"^[\w-]{22}$")
+VALID_LOCATIONS = ["eu", "us", None]
 
 
 class Urls(object):
     def __init__(self, location=None):
-        if not location or location.lower() == 'us':
-            self.base_url = 'https://go.urbanairship.com/api/'
-        elif location.lower() == 'eu':
-            self.base_url = 'https://go.airship.eu/api/'
-
-        self.channel_url = self.base_url + 'channels/'
-        self.open_channel_url = self.channel_url + 'open/'
-        self.device_token_url = self.base_url + 'device_tokens/'
-        self.apid_url = self.base_url + 'apids/'
-        self.push_url = self.base_url + 'push/'
-        self.schedules_url = self.base_url + 'schedules/'
-        self.tags_url = self.base_url + 'tags/'
-        self.segments_url = self.base_url + 'segments/'
-        self.reports_url = self.base_url + 'reports/'
-        self.lists_url = self.base_url + 'lists/'
-        self.location_url = self.base_url + 'location/'
-
-        self.templates_url = self.base_url + 'templates/'
-        self.schedule_template_url = self.templates_url + 'schedules/'
-
-        self.pipelines_url = self.base_url + 'pipelines/'
-
-        self.named_user_url = self.base_url + 'named_users/'
-        self.named_user_tag_url = self.named_user_url + 'tags/'
-        self.named_user_disassociate_url = self.named_user_url + 'disassociate/'
-        self.named_user_associate_url = self.named_user_url + 'associate/'
-
-        self.sms_url = self.channel_url + 'sms/'
-        self.sms_opt_out_url = self.sms_url + 'opt-out/'
-        self.sms_uninstall_url = self.sms_url + 'uninstall/'
-
-        self.email_url = self.channel_url + 'email/'
-        self.email_tags_url = self.email_url + 'tags/'
-        self.email_uninstall_url = self.email_url + 'uninstall/'
-
-        self.create_and_send_url = self.base_url + 'create-and-send/'
-        self.schedule_create_and_send_url = self.schedules_url + 'create-and-send/'
-
-        self.experiments_url = self.base_url + 'experiments/'
-        self.experiments_schedule_url = self.experiments_url + 'scheduled/'
-        self.experiments_validate = self.experiments_url + 'validate/'
+        if not location or location.lower() == "us":
+            self.base_url = "https://go.urbanairship.com/api/"
+        elif location.lower() == "eu":
+            self.base_url = "https://go.airship.eu/api/"
+
+        self.channel_url = self.base_url + "channels/"
+        self.open_channel_url = self.channel_url + "open/"
+        self.device_token_url = self.base_url + "device_tokens/"
+        self.apid_url = self.base_url + "apids/"
+        self.push_url = self.base_url + "push/"
+        self.schedules_url = self.base_url + "schedules/"
+        self.tags_url = self.base_url + "tags/"
+        self.segments_url = self.base_url + "segments/"
+        self.reports_url = self.base_url + "reports/"
+        self.lists_url = self.base_url + "lists/"
+        self.location_url = self.base_url + "location/"
+
+        self.templates_url = self.base_url + "templates/"
+        self.schedule_template_url = self.templates_url + "schedules/"
+
+        self.pipelines_url = self.base_url + "pipelines/"
+
+        self.named_user_url = self.base_url + "named_users/"
+        self.named_user_tag_url = self.named_user_url + "tags/"
+        self.named_user_disassociate_url = self.named_user_url + "disassociate/"
+        self.named_user_associate_url = self.named_user_url + "associate/"
+
+        self.sms_url = self.channel_url + "sms/"
+        self.sms_opt_out_url = self.sms_url + "opt-out/"
+        self.sms_uninstall_url = self.sms_url + "uninstall/"
+
+        self.email_url = self.channel_url + "email/"
+        self.email_tags_url = self.email_url + "tags/"
+        self.email_uninstall_url = self.email_url + "uninstall/"
+
+        self.create_and_send_url = self.base_url + "create-and-send/"
+        self.schedule_create_and_send_url = self.schedules_url + "create-and-send/"
+
+        self.experiments_url = self.base_url + "experiments/"
+        self.experiments_schedule_url = self.experiments_url + "scheduled/"
+        self.experiments_validate = self.experiments_url + "validate/"
 
     def get(self, endpoint):
         url = getattr(self, endpoint, None)
 
         if not url:
-            raise AttributeError('No url for endpoint %s' % endpoint)
+            raise AttributeError("No url for endpoint %s" % endpoint)
 
         return url
 
 
 class Airship(object):
-
     def __init__(self, key, secret, location=None, timeout=None):
         self.key = key
         self.secret = secret
@@ -84,7 +83,7 @@ def timeout(self):
     @timeout.setter
     def timeout(self, value):
         if not isinstance(value, int) and value is not None:
-            raise ValueError('Timeout must be an integer')
+            raise ValueError("Timeout must be an integer")
         self._timeout = value
 
     @property
@@ -94,7 +93,7 @@ def key(self):
     @key.setter
     def key(self, value):
         if not VALID_KEY.match(value):
-            raise ValueError('keys must be 22 characters')
+            raise ValueError("keys must be 22 characters")
         self._key = value
 
     @property
@@ -104,7 +103,7 @@ def location(self):
     @location.setter
     def location(self, value):
         if value not in VALID_LOCATIONS:
-            raise ValueError('location must be one of {}'.format(VALID_LOCATIONS))
+            raise ValueError("location must be one of {}".format(VALID_LOCATIONS))
         self._location = value
 
     @property
@@ -114,49 +113,54 @@ def secret(self):
     @secret.setter
     def secret(self, value):
         if not VALID_KEY.match(value):
-            raise ValueError('secrets must be 22 characters')
+            raise ValueError("secrets must be 22 characters")
         self._secret = value
 
-    def request(self, method, body, url,
-                content_type=None, version=None, params=None):
-        return self._request(method, body, url,
-                             content_type, version, params)
-
-    def _request(self, method, body, url, content_type=None,
-                 version=None, params=None, encoding=None):
-
-        headers = \
-                {'User-agent': 'UAPythonLib/{0}'.format(__about__.__version__)}
+    def request(self, method, body, url, content_type=None, version=None, params=None):
+        return self._request(method, body, url, content_type, version, params)
+
+    def _request(
+        self,
+        method,
+        body,
+        url,
+        content_type=None,
+        version=None,
+        params=None,
+        encoding=None,
+    ):
+
+        headers = {
+            "User-agent": "UAPythonLib/{0} {1}".format(__about__.__version__, self.key),
+        }
         if content_type:
-            headers['Content-type'] = content_type
+            headers["Content-type"] = content_type
         if version:
-            headers['Accept'] = ('application/vnd.urbanairship+json; '
-                                 'version=%d;' % version)
+            headers["Accept"] = (
+                "application/vnd.urbanairship+json; " "version=%d;" % version
+            )
         if encoding:
-            headers['Content-Encoding'] = encoding
+            headers["Content-Encoding"] = encoding
 
         logger.debug(
-            'Making %s request to %s. Headers:\n\t%s\nBody:\n\t%s',
+            "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
+            "\n\t".join("%s: %s" % (key, value) for (key, value) in headers.items()),
+            body,
         )
 
         response = self.session.request(
-            method, url, data=body, params=params,
-            headers=headers, timeout=self.timeout)
+            method, url, data=body, params=params, headers=headers, timeout=self.timeout
+        )
 
         logger.debug(
-            'Received %s response. Headers:\n\t%s\nBody:\n\t%s',
+            "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()
+            "\n\t".join(
+                "%s: %s" % (key, value) for (key, value) in response.headers.items()
             ),
-            response.content
+            response.content,
         )
 
         if response.status_code == 401: