add network packages

Vonage · Jun 12, 2024 · 8ef8ece · 8ef8ece
1 parent f220715
commit 8ef8ece
Show file tree

Hide file tree

Showing 51 changed files with 273 additions and 589 deletions.
diff --git a/application/tests/test_application.py b/application/tests/test_application.py
@@ -2,7 +2,6 @@
 
 import responses
 from pytest import raises
-from testutils import build_response, get_mock_api_key_auth
 from vonage_application.application import Application
 from vonage_application.common import (
     ApplicationUrl,
@@ -25,6 +24,8 @@
 from vonage_application.requests import ApplicationConfig, ListApplicationsFilter
 from vonage_http_client.http_client import HttpClient
 
+from testutils import build_response, get_mock_api_key_auth
+
 path = abspath(__file__)
 
 application = Application(HttpClient(get_mock_api_key_auth()))

diff --git a/camara_auth/README.md b/camara_auth/README.md
diff --git a/camara_auth/src/vonage_camara_auth/__init__.py b/camara_auth/src/vonage_camara_auth/__init__.py
diff --git a/camara_auth/tests/BUILD b/camara_auth/tests/BUILD
diff --git a/camara_auth/tests/test_camara_auth.py b/camara_auth/tests/test_camara_auth.py
diff --git a/gnp_sim_swap/README.md b/gnp_sim_swap/README.md
diff --git a/gnp_sim_swap/src/vonage_gnp_sim_swap/__init__.py b/gnp_sim_swap/src/vonage_gnp_sim_swap/__init__.py
diff --git a/gnp_sim_swap/tests/BUILD b/gnp_sim_swap/tests/BUILD
diff --git a/gnp_sim_swap/tests/_test_camara_auth.py b/gnp_sim_swap/tests/_test_camara_auth.py
diff --git a/camara_auth/BUILD → network_auth/BUILD b/camara_auth/BUILD → network_auth/BUILD
@@ -4,11 +4,11 @@ file(name='readme', source='README.md')
 files(sources=['tests/data/*'])
 
 python_distribution(
-    name='vonage-camara-auth',
+    name='vonage-network-auth',
     dependencies=[
         ':pyproject',
         ':readme',
-        'camara_auth/src/vonage_camara_auth',
+        'network_auth/src/vonage_network_auth',
     ],
     provides=python_artifact(),
     generate_setup=False,

diff --git a/camara_auth/CHANGES.md → network_auth/CHANGES.md b/camara_auth/CHANGES.md → network_auth/CHANGES.md
diff --git a/network_auth/README.md b/network_auth/README.md
@@ -0,0 +1,34 @@
+# Vonage Network API Authentication Client
+
+This package (`vonage-network-auth`) provides a client for authenticating Network APIs that require Oauth2 authentcation. Using it, it is possible to generate authenticated JWTs for use with GNP APIs, e.g. Sim Swap, Number Verification.
+
+This package is intended to be used as part of an SDK, accessing required methods through the SDK instead of directly. 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).
+
+## Installation
+
+Install from the Python Package Index with pip:
+
+```bash
+pip install vonage-network-auth
+```
+
+## Usage
+
+### Create a `NetworkAuth` Object
+
+```python
+from vonage_network_auth import NetworkAuth
+from vonage_http_client import HttpClient, Auth
+
+network_auth = NetworkAuth(HttpClient(Auth(application_id='application-id', private_key='private-key')))
+```
+
+### Generate an Authenticated Access Token
+
+```python
+token = camara_auth.get_oauth2_user_token(
+    number='447700900000', scope='dpv:FraudPreventionAndDetection#check-sim-swap'
+)
+```
diff --git a/camara_auth/pyproject.toml → network_auth/pyproject.toml b/camara_auth/pyproject.toml → network_auth/pyproject.toml
@@ -1,7 +1,7 @@
 [project]
-name = "vonage-camara-auth"
+name = "vonage-network-auth"
 version = "1.0.0"
-description = "Package for working with Camara APIs that require Oauth2 in Python."
+description = "Package for working with Network APIs that require Oauth2 in Python."
 readme = "README.md"
 authors = [{ name = "Vonage", email = "devrel@vonage.com" }]
 requires-python = ">=3.8"

diff --git a/camara_auth/src/vonage_camara_auth/BUILD → network_auth/src/vonage_network_auth/BUILD b/camara_auth/src/vonage_camara_auth/BUILD → network_auth/src/vonage_network_auth/BUILD
diff --git a/network_auth/src/vonage_network_auth/__init__.py b/network_auth/src/vonage_network_auth/__init__.py
@@ -0,0 +1,4 @@
+from .network_auth import NetworkAuth
+from .responses import OidcResponse, TokenResponse
+
+__all__ = ['NetworkAuth', 'OidcResponse', 'TokenResponse']