Merge branch 'main' of https://github.com/Bandwidth/python-sdk into SWI-9203

Author: ckoegel

.github/workflows/deploy.yml

@@ -13,6 +13,8 @@ jobs:
       BW_ACCOUNT_ID: ${{ secrets.BW_ACCOUNT_ID }}
       BW_USERNAME: ${{ secrets.BW_USERNAME }}
       BW_PASSWORD: ${{ secrets.BW_PASSWORD }}
+      BW_CLIENT_ID: ${{ secrets.BW_CLIENT_ID }}
+      BW_CLIENT_SECRET: ${{ secrets.BW_CLIENT_SECRET }}
       BW_USERNAME_FORBIDDEN: ${{ secrets.BW_USERNAME_FORBIDDEN }}
       BW_PASSWORD_FORBIDDEN: ${{ secrets.BW_PASSWORD_FORBIDDEN }}
       BW_VOICE_APPLICATION_ID: ${{ secrets.BW_VOICE_APPLICATION_ID }}

.github/workflows/test-pr.yml

@@ -13,6 +13,8 @@ env:
   BW_ACCOUNT_ID: ${{ secrets.BW_ACCOUNT_ID }}
   BW_USERNAME: ${{ secrets.BW_USERNAME }}
   BW_PASSWORD: ${{ secrets.BW_PASSWORD }}
+  BW_CLIENT_ID: ${{ secrets.BW_CLIENT_ID }}
+  BW_CLIENT_SECRET: ${{ secrets.BW_CLIENT_SECRET }}
   BW_USERNAME_FORBIDDEN: ${{ secrets.BW_USERNAME_FORBIDDEN }}
   BW_PASSWORD_FORBIDDEN: ${{ secrets.BW_PASSWORD_FORBIDDEN }}
   BW_VOICE_APPLICATION_ID: ${{ secrets.BW_VOICE_APPLICATION_ID }}

.github/workflows/test-smoke.yml

@@ -27,6 +27,8 @@ env:
   OPERATING_SYSTEM: ubuntu
   BW_USERNAME: ${{ secrets.BW_USERNAME }}
   BW_PASSWORD: ${{ secrets.BW_PASSWORD }}
+  BW_CLIENT_ID: ${{ secrets.BW_CLIENT_ID }}
+  BW_CLIENT_SECRET: ${{ secrets.BW_CLIENT_SECRET }}
   BW_USERNAME_FORBIDDEN: ${{ secrets.BW_USERNAME_FORBIDDEN }}
   BW_PASSWORD_FORBIDDEN: ${{ secrets.BW_PASSWORD_FORBIDDEN }}
   USER_NUMBER: ${{ secrets.USER_NUMBER }}

README.md

@@ -73,7 +73,11 @@ configuration = bandwidth.Configuration(
     password = os.environ["PASSWORD"]
 )
 
-configuration.access_token = os.environ["ACCESS_TOKEN"]
+# Configure your client ID and secret for OAuth
+configuration = bandwidth.Configuration(
+    client_id = os.environ["CLIENT_ID"],
+    client_secret = os.environ["CLIENT_SECRET"]
+)
 
 
 # Enter a context with an instance of the API client

bandwidth.yml

@@ -8,6 +8,7 @@ info:
     email: [email protected]
   version: 1.0.0
 security:
+  - OAuth2: []
   - Basic: []
   - OAuth2: []
 tags:

bandwidth/configuration.py

@@ -13,6 +13,8 @@
 """  # noqa: E501
 
 
+import time
+import base64
 import copy
 import http.client as httplib
 import logging
@@ -150,6 +152,8 @@ class Configuration:
     :param username: Username for HTTP basic authentication.
     :param password: Password for HTTP basic authentication.
     :param access_token: Access token.
+    :param client_id: Client ID for OAuth2 authentication.
+    :param client_secret: Client Secret for OAuth2 authentication.
     :param server_index: Index to servers configuration.
     :param server_variables: Mapping with string values to replace variables in
       templated server configuration. The validation of enums is performed for
@@ -197,6 +201,8 @@ def __init__(
         username: Optional[str]=None,
         password: Optional[str]=None,
         access_token: Optional[str]=None,
+        client_id: Optional[str]=None,
+        client_secret: Optional[str]=None,
         server_index: Optional[int]=None,
         server_variables: Optional[ServerVariablesT]=None,
         server_operation_index: Optional[Dict[int, int]]=None,
@@ -252,6 +258,18 @@ def __init__(
         self.access_token = access_token
         """Access token
         """
+        self.client_id = client_id
+        """Client ID for OAuth2 authentication
+        """
+        self.client_secret = client_secret
+        """Client Secret for OAuth2 authentication
+        """
+        self.temp_access_token = None
+        """Temporary access token for OAuth2
+        """
+        self.temp_access_token_expiration = 0
+        """Expiration time of the temporary access token
+        """
         self.logger = {}
         """Logging Settings
         """
@@ -508,6 +526,32 @@ def get_basic_auth_token(self) -> Optional[str]:
             basic_auth=username + ':' + password
         ).get('authorization')
 
+    def get_access_token(self) -> str:
+        """Gets HTTP bearer authentication header (string).
+
+        :return: The token for bearer HTTP authentication.
+        """
+        now = int(time.time())
+        if self.temp_access_token and self.temp_access_token_expiration > now + 60:
+            return self.temp_access_token
+        else:
+            _bytes = f"{self.client_id}:{self.client_secret}".encode('utf-8')
+            _encoded_string = base64.b64encode(_bytes).decode('utf-8')
+            auth_header = f"Basic {_encoded_string}"
+            resp = urllib3.request(
+                'POST',
+                'https://api.bandwidth.com/api/v1/oauth2/token',
+                headers={
+                    'Authorization': auth_header,
+                    'Content-Type': 'application/x-www-form-urlencoded',
+                },
+                body='grant_type=client_credentials'
+            )
+            body = resp.json()
+            self.temp_access_token = body['access_token']
+            self.temp_access_token_expiration = now + body['expires_in']
+            return self.temp_access_token
+
     def auth_settings(self)-> AuthSettings:
         """Gets Auth Settings dict for api client.
 
@@ -528,6 +572,13 @@ def auth_settings(self)-> AuthSettings:
                 'key': 'Authorization',
                 'value': 'Bearer ' + self.access_token
             }
+        if self.client_id is not None and self.client_secret is not None:
+            auth['OAuth2'] = {
+                'type': 'oauth2',
+                'in': 'header',
+                'key': 'Authorization',
+                'value': 'Bearer ' + self.get_access_token(),
+            }
         return auth
 
     def to_debug_report(self) -> str: