[TOOLSLIBS-1751] OAuth Support (#205)

* 7.0 requirements

* new clients

* prevent ciricular imports

* line length

* adds oauth baseurl support

* final oauth client

* inherits from BaseClient class

* typing changes for new clients

* adds client docstrings, type fixes

* adds types-mock

* adds new client tests

* conditional to prevent circular imports

* exception specificity

* moves urls to own file

* corrects name

* adds basic oauth client tests

* adds client info to docs

* adds types-oauthlib

* ignores mypy type checking here

* readds nose

* moves mock

* rm 3.6 test runner

* uses super _request

* add pyjwt and cryptography

* use only jwt assertion with oauth

* update docs index

* updates black

* add subject to self

* updates tests

* changes from review requests

* test fix

* private method override

Author: aschuman0

.github/workflows/test_runner.yaml

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

.pre-commit-config.yaml

@@ -1,22 +1,22 @@
 repos:
 -   repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v2.3.0
+    rev: v4.6.0
     hooks:
     -   id: check-yaml
     -   id: end-of-file-fixer
     -   id: trailing-whitespace
     -   id: no-commit-to-branch
         args: ["--branch", "master", "--branch", "main"]
 -   repo: https://github.com/psf/black
-    rev: 21.12b0
+    rev: 24.4.0
     hooks:
     -   id: black
 -   repo: https://github.com/codespell-project/codespell
-    rev: v2.1.0
+    rev: v2.2.6
     hooks:
       - id: codespell
 - repo: https://github.com/pre-commit/mirrors-mypy
-  rev: v0.931
+  rev: v1.9.0
   hooks:
     - id: mypy
       additional_dependencies: [types-requests, types-six, types-urllib3, types-mock]

docs/index.rst

@@ -22,7 +22,7 @@ import. To get started, import the package, and create an
 .. code-block:: python
 
    import urbanairship as ua
-   airship = ua.Airship('<app key>', '<master secret>')
+   airship = ua.client.BasicAuthClient('<app key>', '<master secret>')
 
    push = airship.Push(airship=airship)
    push.audience = ua.ios_channel('074e84a2-9ed9-4eee-9ca4-cc597bfdbef3')
@@ -35,6 +35,17 @@ providing connection pooling and strict SSL checking. The ``Airship``
 object is threadsafe, and can be instantiated once and reused in
 multiple threads.
 
+Authentication Clients
+----------------------
+
+The library supports authentication via 1 of 3 client classes:
+
+* BasicAuthClient - This is the same as the deprecated `Airship` client class for using Key/Secret authentication.
+* BearerTokenClient - This client takes a `token` argument with an Airship-generated bearer token in addition to the key and other configuration options.
+* OAuthClient - This client requests an OAuth bearer token using the `client_id` and JWT assertion and automatically refreshes tokens as needed from the Airship OAuth2 provider. Please see the OAuth2 section of the Airship API documentation for more on this authentication method.  If you prefer to handle token refresh yourself, the `access_token` returned from the Airship OAuth2 proivder can be used with the `BearerTokenClient`.
+
+More about these methods, including examples of instantiation can be found on the Airship docs site.
+
 EU Base URL
 -----------
 

requirements-dev.txt

@@ -1,9 +1,4 @@
-requests>=1.2
-six
-backoff>=1.11
-nose
-mock
+-r requirements.txt
 tox
 black
 pre-commit
-sphinx-rtd-theme

requirements.txt

@@ -1,10 +1,13 @@
-requests>=1.2
+requests==2.31.0
+backoff==2.2.1
 types-requests
 six
 types-six
-nose
-mock
 sphinx-rtd-theme
 mypy
 mypy-extensions
-backoff>=1.11
+nose
+mock
+types-mock
+pyjwt==2.8.0
+cryptography==42.0.5

setup.cfg

@@ -1,2 +1,5 @@
 [nosetests]
 with-doctest=1
+
+[flake8]
+max-line-length = 99

tests/client/__init__.py

@@ -0,0 +1,43 @@
+import unittest
+
+from tests import TEST_KEY, TEST_SECRET
+from urbanairship.client import BasicAuthClient
+
+
+class TestBasicClient(unittest.TestCase):
+    def test_basic_client_timeout(self):
+        timeout_int = 50
+
+        airship_timeout = BasicAuthClient(
+            key=TEST_KEY, secret=TEST_SECRET, timeout=timeout_int
+        )
+
+        self.assertEqual(airship_timeout.timeout, timeout_int)
+
+    def test_basic_client_timeout_exception(self):
+        timeout_str = "50"
+
+        with self.assertRaises(ValueError):
+            BasicAuthClient(key=TEST_KEY, secret=TEST_SECRET, timeout=timeout_str)
+
+    def test_basic_client_retry(self):
+        retry_int = 5
+
+        airship_w_retry = BasicAuthClient(TEST_KEY, TEST_SECRET, retries=retry_int)
+
+        self.assertEqual(retry_int, airship_w_retry.retries)
+
+    def test_basic_client_location(self):
+        location = "eu"
+
+        airship_eu = BasicAuthClient(
+            key=TEST_KEY, secret=TEST_SECRET, location=location
+        )
+
+        self.assertEqual(airship_eu.location, location)
+
+    def test_basic_client_location_exception(self):
+        invalid_location = "xx"
+
+        with self.assertRaises(ValueError):
+            BasicAuthClient(key=TEST_KEY, secret=TEST_SECRET, location=invalid_location)

tests/client/test_basic_auth_client.py

@@ -0,0 +1,47 @@
+import unittest
+
+from tests import TEST_KEY, TEST_TOKEN
+from urbanairship.client import OAuthClient
+
+
+class TestOAuthClient(unittest.TestCase):
+    def setUp(self) -> None:
+        self.scope = ["nu"]
+        self.ip_addr = ["24.20.40.0/24"]
+        self.timeout = 50
+        self.retries = 3
+        self.private_key = "-----BEGIN PRIVATE KEY-----\n...\n-----END PRIVATE KEY-----"
+
+        self.test_oauth_client = OAuthClient(
+            client_id=TEST_KEY,
+            private_key=self.private_key,
+            key=TEST_KEY,
+            scope=self.scope,
+            ip_addr=self.ip_addr,
+            timeout=self.timeout,
+            retries=self.retries,
+        )
+
+    def test_oauth_client_timeout(self):
+        self.assertEqual(self.test_oauth_client.timeout, self.timeout)
+
+    def test_oauth_client_id(self):
+        self.assertEqual(self.test_oauth_client.client_id, TEST_KEY)
+
+    def test_oauth_client_scope(self):
+        self.assertEqual(self.test_oauth_client.scope, self.scope)
+
+    def test_oauth_client_ip_addr(self):
+        self.assertEqual(self.test_oauth_client.ip_addr, self.ip_addr)
+
+    def test_oauth_client_retry(self):
+        self.assertEqual(self.test_oauth_client.retries, self.retries)
+
+    def test_oauth_token_url(self):
+        self.assertEqual(
+            self.test_oauth_client.token_url, "https://oauth2.asnapius.com/token"
+        )
+
+    def test_oauth_private_key(self):
+        self.assertIn("-----BEGIN PRIVATE KEY-----", self.test_oauth_client.private_key)
+        self.assertIn("-----END PRIVATE KEY-----", self.test_oauth_client.private_key)

tests/client/test_oauth_client.py

@@ -0,0 +1,57 @@
+import json
+import unittest
+import uuid
+
+import mock
+import requests
+
+import urbanairship as ua
+from tests import TEST_KEY, TEST_SECRET
+from urbanairship.client import BasicAuthClient
+
+
+class TestAirshipResponse(unittest.TestCase):
+    test_channel = str(uuid.uuid4())
+    airship = BasicAuthClient(TEST_KEY, TEST_SECRET, location="us")
+    common_push = ua.Push(airship=airship)
+    common_push.device_types = ua.device_types("ios")
+    common_push.audience = ua.channel(test_channel)
+    common_push.notification = ua.notification(alert="testing")
+
+    def test_unauthorized(self):
+        with mock.patch.object(BasicAuthClient, "_request") as mock_request:
+            response = requests.Response()
+            response._content = json.dumps({"ok": False}).encode("utf-8")
+            response.status_code = 401
+            mock_request.return_value = response
+
+            try:
+                self.common_push.send()
+            except Exception as e:
+                self.assertIsInstance(ua.Unauthorized, e)
+
+    def test_client_error(self):
+        with mock.patch.object(BasicAuthClient, "_request") as mock_request:
+            response = requests.Response()
+            response._content = json.dumps({"ok": False}).encode("utf-8")
+            response.status_code = 400
+            mock_request.return_value = response
+
+            try:
+                r = self.common_push.send()
+            except Exception as e:
+                self.assertIsInstance(ua.AirshipFailure, e)
+                self.assertEqual(r.status_code, 400)
+
+    def test_server_error(self):
+        with mock.patch.object(BasicAuthClient, "_request") as mock_request:
+            response = requests.Response()
+            response._content = json.dumps({"ok": False}).encode("utf-8")
+            response.status_code = 500
+            mock_request.return_value = response
+
+            try:
+                r = self.common_push.send()
+            except Exception as e:
+                self.assertIsInstance(ua.AirshipFailure, e)
+                self.assertEqual(r.status_code, 500)