[TOOLSLIBS-325] Adds bearer token auth (#189)

* rm py2 dep warning

* adds TEST_TOKEN

* adds support for bearer token and airship class docstring

* adds tests for bearer token, uses context manager for exception tests

* rm python 2 deprecation warning

* rm py2.7 from CI test runner

* removes some python2 things

Author: aschuman0

.github/workflows/test_runner.yaml

@@ -8,7 +8,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: ["2.7", "3.6", "3.7", "3.8", "3.9"]
+        python-version: ["3.6", "3.7", "3.8", "3.9"]
 
     steps:
       - uses: actions/checkout@v2

.gitmodules

@@ -8,10 +8,10 @@ repos:
     -   id: no-commit-to-branch
         args: ["--branch", "master", "--branch", "main"]
 -   repo: https://github.com/psf/black
-    rev: 19.3b0
+    rev: 21.12b0
     hooks:
     -   id: black
 -   repo: https://github.com/codespell-project/codespell
-    rev: v1.16.0
+    rev: v2.1.0
     hooks:
       - id: codespell

.pre-commit-config.yaml

@@ -1,2 +1,3 @@
 TEST_KEY = "x" * 22
 TEST_SECRET = "y" * 22
+TEST_TOKEN = "z" * 92

isort.cfg

@@ -6,7 +6,7 @@
 import requests
 
 import urbanairship as ua
-from tests import TEST_SECRET, TEST_KEY
+from tests import TEST_SECRET, TEST_KEY, TEST_TOKEN
 
 
 class TestAirshipCore(unittest.TestCase):
@@ -22,12 +22,8 @@ def test_airship_timeout(self):
     def test_airship_timeout_exception(self):
         timeout_str = "50"
 
-        try:
-            airship_raises_value_error = ua.Airship(
-                key=TEST_KEY, secret=TEST_SECRET, timeout=timeout_str
-            )
-        except ValueError as e:
-            self.assertIsInstance(e, ValueError)
+        with self.assertRaises(ValueError):
+            ua.Airship(key=TEST_KEY, secret=TEST_SECRET, timeout=timeout_str)
 
     def test_airship_location(self):
         location = "eu"
@@ -39,12 +35,25 @@ def test_airship_location(self):
     def test_airship_location_exception(self):
         invalid_location = "xx"
 
-        try:
-            airship_rasises_value_error = ua.Airship(
-                key=TEST_KEY, secret=TEST_SECRET, location=invalid_location
-            )
-        except ValueError as e:
-            self.assertIsInstance(e, ValueError)
+        with self.assertRaises(ValueError):
+            ua.Airship(key=TEST_KEY, secret=TEST_SECRET, location=invalid_location)
+
+    def test_token_auth(self):
+        test_airship = ua.Airship(key=TEST_KEY, token=TEST_TOKEN)
+
+        self.assertEqual(TEST_TOKEN, test_airship.token)
+
+    def test_no_secret_nor_token(self):
+        with self.assertRaises(
+            ValueError, msg="One of token or secret must be used, not both"
+        ):
+            ua.Airship(key=TEST_KEY)
+
+    def test_both_secret_and_token(self):
+        with self.assertRaises(
+            ValueError, msg="Either token or secret must be included"
+        ):
+            ua.Airship(key=TEST_KEY, secret=TEST_SECRET, token=TEST_TOKEN)
 
 
 class TestAirshipResponse(unittest.TestCase):

tests/__init__.py

@@ -76,21 +76,37 @@ def get(self, endpoint):
 
 
 class Airship(object):
-    def __init__(self, key, secret, location=None, timeout=None):
+    def __init__(self, key, secret=None, token=None, location="us", timeout=None):
+        """Main client class for interacting with the Airship API.
+
+        :param key: [required] An Airship project key used to authenticate
+        :param secret: [optional] The Airship-generated app or master secret for the
+        provided key
+        :param token: [optional] An Airship-generated bearer token for the provided key
+        :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
+        """
         self.key = key
         self.secret = secret
+        self.token = token
         self.location = location
         self.timeout = timeout
-
-        self.session = requests.Session()
-        self.session.auth = (key, secret)
         self.urls = Urls(self.location)
 
-        if sys.version[0] == "2":
-            warnings.warn(
-                "Support for Python 2.x will be removed in urbanairship version 6.0",
-                DeprecationWarning,
+        if all([secret, token]):
+            raise ValueError("One of token or secret must be used, not both")
+
+        self.session = requests.Session()
+        if self.token:
+            self.session.headers.update(
+                {"X-UA-Appkey": key, "Authorization": f"Bearer {self.token}"}
             )
+        elif self.secret:
+            self.session.auth = (key, secret)
+        else:
+            raise ValueError("Either token or secret must be included")
 
     @property
     def timeout(self):
@@ -128,10 +144,18 @@ def secret(self):
 
     @secret.setter
     def secret(self, value):
-        if not VALID_KEY.match(value):
+        if isinstance(value, str) and not VALID_KEY.match(value):
             raise ValueError("secrets must be 22 characters")
         self._secret = value
 
+    @property
+    def token(self):
+        return self._token
+
+    @token.setter
+    def token(self, value):
+        self._token = value
+
     def request(
         self,
         method,