refactor jwt package, get tests passing

Author: maxkahan

jwt/BUILD

@@ -0,0 +1,16 @@
+resource(name='pyproject', source='pyproject.toml')
+file(name='readme', source='README.md')
+
+files(sources=['tests/data/*'])
+
+python_distribution(
+    name='vonage-jwt',
+    dependencies=[
+        ':pyproject',
+        ':readme',
+        'jwt/src/vonage_jwt',
+    ],
+    provides=python_artifact(),
+    generate_setup=False,
+    repositories=['@pypi'],
+)

jwt/CHANGES.md

@@ -1,3 +1,7 @@
+# 1.1.1
+- Exceptions inherit from `VonageError`
+- Moving the package into the Vonage Python SDK monorepo
+
 # 1.1.0
 - Add new module with method to verify JWT signatures, `verify_jwt.verify_signature`
 

jwt/README.md

@@ -2,9 +2,9 @@
 
 This package (`vonage-jwt`) provides functionality to generate a JWT in Python code.
 
-It is used by the [Vonage Python SDK](https://github.com/Vonage/vonage-python-sdk), specifically by the `vonage-http-client` package, to generate JWTs for authentication. Thus, it doesn't require manual installation or configuration unless you're using this package independently of a SDK.
+It is used by the [Vonage Python SDK](https://github.com/Vonage/vonage-python-sdk), specifically by the `vonage-http-client` package, to generate JWTs for authentication. Thus, it doesn't require manual installation or configuration unless you're using this package independently of an SDK.
 
-For full API documentation, refer to the [Vonage Developer documentation](https://developer.vonage.com).
+For full API documentation, refer to the [Vonage developer documentation](https://developer.vonage.com).
 
 - [Installation](#installation)
 - [Generating JWTs](#generating-jwts)
@@ -27,7 +27,7 @@ It can also be used as a standalone JWT generator for use with Vonage APIs, like
 ### Import the `JwtClient` object
 
 ```python
-from vonage_jwt.jwt import JwtClient
+from vonage_jwt import JwtClient
 ```
 
 ### Create a `JwtClient` object
@@ -54,7 +54,7 @@ jwt_client.generate_application_jwt(claims)
 You can use the `verify_jwt.verify_signature` method to verify a JWT signature is valid.
 
 ```python
-from vonage_jwt.verify_jwt import verify_signature
+from vonage_jwt import verify_signature
 
 verify_signature(TOKEN, SIGNATURE_SECRET) # Returns a boolean
 ```

jwt/pyproject.toml

@@ -5,9 +5,7 @@ description = "Tooling for working with JWTs for Vonage APIs in Python."
 readme = "README.md"
 authors = [{ name = "Vonage", email = "[email protected]" }]
 requires-python = ">=3.8"
-dependencies = [
-  "pyjwt[crypto] >=1.6.4"
-]
+dependencies = ["vonage-utils>=1.1.2", "pyjwt[crypto]>=1.6.4"]
 classifiers = [
   "Programming Language :: Python",
   "Programming Language :: Python :: 3",

jwt/src/vonage_jwt/__init__.py

@@ -1,4 +1,5 @@
-from .jwt import JwtClient, VonageJwtError
+from .errors import VonageJwtError, VonageVerifyJwtError
+from .jwt import JwtClient
 from .verify_jwt import verify_signature
 
-__all__ = ['JwtClient', 'VonageJwtError', 'verify_signature']
+__all__ = ['JwtClient', 'VonageJwtError', 'VonageVerifyJwtError', 'verify_signature']

jwt/src/vonage_jwt/errors.py

@@ -0,0 +1,9 @@
+from vonage_utils import VonageError
+
+
+class VonageJwtError(VonageError):
+    """An error relating to the Vonage JWT Generator."""
+
+
+class VonageVerifyJwtError(VonageError):
+    """The signature could not be verified."""

jwt/src/vonage_jwt/jwt.py

@@ -1,8 +1,11 @@
 import re
 from time import time
-from jwt import encode
-from uuid import uuid4
 from typing import Union
+from uuid import uuid4
+
+from jwt import encode
+
+from .errors import VonageJwtError
 
 
 class JwtClient:
@@ -22,8 +25,8 @@ def __init__(self, application_id: str, private_key: str):
             )
 
     def generate_application_jwt(self, jwt_options: dict = {}):
-        """
-        Generates a JWT for the specified Vonage application.
+        """Generates a JWT for the specified Vonage application.
+
         You can override values for application_id and private_key on the JWTClient object by
         specifying them in the `jwt_options` dict if required.
         """
@@ -51,7 +54,3 @@ def _set_private_key(self, key: Union[str, bytes]):
             )
         else:
             self._private_key = key
-
-
-class VonageJwtError(Exception):
-    """An error relating to the Vonage JWT Generator."""

jwt/src/vonage_jwt/verify_jwt.py

@@ -1,10 +1,10 @@
 from jwt import InvalidSignatureError, decode
 
+from .errors import VonageVerifyJwtError
+
 
 def verify_signature(token: str, signature_secret: str = None) -> bool:
-    """
-    Method to verify that an incoming JWT was sent by Vonage.
-    """
+    """Method to verify that an incoming JWT was sent by Vonage."""
 
     try:
         decode(token, signature_secret, algorithms='HS256')
@@ -13,7 +13,3 @@ def verify_signature(token: str, signature_secret: str = None) -> bool:
         return False
     except Exception as e:
         raise VonageVerifyJwtError(repr(e))
-
-
-class VonageVerifyJwtError(Exception):
-    """The signature could not be verified."""

jwt/tests/BUILD

@@ -1 +1 @@
-python_tests(dependencies=['messages', 'testutils'])
+python_tests(dependencies=['jwt', 'testutils'])

jwt/tests/test_jwt_generator.py

@@ -1,23 +1,25 @@
-from vonage_jwt.jwt import JwtClient, VonageJwtError
+from os import environ
+from os.path import dirname, join
+from time import time
 
-import os
+from jwt.exceptions import ImmatureSignatureError
 from pytest import raises
+from vonage_jwt.jwt import JwtClient, VonageJwtError
+
 from jwt import decode
-from jwt.exceptions import ImmatureSignatureError
-from time import time
 
 # Ensure the client isn't being configured with real values
-os.environ.clear()
+environ.clear()
 
 
 def read_file(path):
-    with open(os.path.join(os.path.dirname(__file__), path)) as input_file:
+    with open(join(dirname(__file__), path)) as input_file:
         return input_file.read()
 
 
 application_id = 'asdf1234'
 private_key_string = read_file('data/private_key.txt')
-private_key_file_path = './tests/data/private_key.txt'
+private_key_file_path = 'jwt/tests/data/private_key.txt'
 jwt_client = JwtClient(application_id, private_key_file_path)
 
 public_key = read_file('data/public_key.txt')