Rename PlatformApiClient to Oauth2ApiClient

Author: nonword

CHANGELOG.md

@@ -1,7 +1,7 @@
 # Changelog
 
 ## v0.0.7 - 2/28/23
-- Added PlatformApiClient for oauth2 authenticated calls to our Platform API
+- Added Oauth2ApiClient for oauth2 authenticated calls to our Platform API and Sierra
 
 ## v0.0.5 - 2/22/23
 - Support write queries to PostgreSQL and MySQL databases

README.md

@@ -10,7 +10,7 @@ This package contains common Python utility classes and functions.
 * Connecting to and querying a MySQL database
 * Connecting to and querying a PostgreSQL database using a connection pool
 * Connecting to and querying Redshift
-* Making requests to the NYPL Platform API
+* Making requests to the Oauth2 authenticated APIS such as NYPL Platform API and Sierra
 
 ## Functions
 * Reading a YAML config file and putting the contents in os.environ

src/nypl_py_utils/__init__.py

@@ -2,7 +2,7 @@
 from .classes.kinesis_client import KinesisClient, KinesisClientError  # noqa
 from .classes.kms_client import KmsClient, KmsClientError # noqa
 from .classes.mysql_client import MySQLClient, MySQLClientError  # noqa
-from .classes.platform_api_client import PlatformApiClient  # noqa
+from .classes.oauth2_api_client import Oauth2ApiClient  # noqa
 from .classes.postgresql_client import PostgreSQLClient, PostgreSQLClientError  # noqa
 from .classes.redshift_client import RedshiftClient, RedshiftClientError  # noqa
 from .classes.s3_client import S3Client, S3ClientError  # noqa

…_py_utils/classes/platform_api_client.py …pl_py_utils/classes/oauth2_api_client.pysrc/nypl_py_utils/classes/platform_api_client.py renamed to src/nypl_py_utils/classes/oauth2_api_client.py src/nypl_py_utils/classes/platform_api_client.py renamed to src/nypl_py_utils/classes/oauth2_api_client.py

@@ -4,9 +4,10 @@
 from nypl_py_utils.functions.log_helper import create_log
 
 
-class PlatformApiClient:
+class Oauth2ApiClient:
     """
-    Client for interacting with NYPL Platform API endpoints
+    Client for interacting with an Oauth2 authenticated API such as NYPL's
+    Platform API endpoints
     """
 
     def __init__(self, client_id=None, client_secret=None, base_url=None,
@@ -23,7 +24,7 @@ def __init__(self, client_id=None, client_secret=None, base_url=None,
         self.client = None
         self.token = None
 
-        self.logger = create_log('platform_api_client')
+        self.logger = create_log('oauth2_api_client')
 
     def get(self, request_path, **kwargs):
         """

tests/test_platform_api_client.py tests/test_oauth2_api_client.pytests/test_platform_api_client.py renamed to tests/test_oauth2_api_client.py

@@ -3,7 +3,7 @@
 import pytest
 from requests_oauthlib import OAuth2Session
 
-from nypl_py_utils import PlatformApiClient
+from nypl_py_utils import Oauth2ApiClient
 # from requests.exceptions import ConnectTimeout
 
 _TOKEN_RESPONSE = {
@@ -18,18 +18,18 @@
 BASE_URL = 'https://example.com/api/v0.1'
 
 
-class TestPlatformApiClient:
+class TestOauth2ApiClient:
 
     @pytest.fixture
     def test_instance(self, requests_mock):
         token_url = 'https://oauth.example.com/oauth/token'
         requests_mock.post(token_url, text=json.dumps(_TOKEN_RESPONSE))
 
-        return PlatformApiClient(base_url=BASE_URL,
-                                 token_url=token_url,
-                                 client_id='clientid',
-                                 client_secret='clientsecret'
-                                 )
+        return Oauth2ApiClient(base_url=BASE_URL,
+                               token_url=token_url,
+                               client_id='clientid',
+                               client_secret='clientsecret'
+                               )
 
     def test_uses_env_vars(self):
         env = {
@@ -41,7 +41,7 @@ def test_uses_env_vars(self):
         for key, value in env.items():
             os.environ[key] = value
 
-        client = PlatformApiClient()
+        client = Oauth2ApiClient()
         assert client.client_id == 'env client id'
         assert client.client_secret == 'env client secret'
         assert client.token_url == 'env token url'