tests: strong api key assertions

Author: Justintime50

easypost/__init__.py

@@ -1,6 +1,7 @@
 # flake8: noqa
 import easypost.beta
 from easypost.address import Address
+from easypost.api_key import ApiKey
 from easypost.batch import Batch
 from easypost.billing import Billing
 from easypost.brand import Brand

easypost/api_key.py

@@ -0,0 +1,5 @@
+from easypost.resource import Resource
+
+
+class ApiKey(Resource):
+    pass

easypost/easypost_object.py

@@ -10,6 +10,7 @@
 
 
 EASYPOST_OBJECT_ID_PREFIX_TO_CLASS_NAME_MAP = {
+    "ak": "ApiKey",
     "adr": "Address",
     "batch": "Batch",
     "brd": "Brand",

easypost/user.py

@@ -5,6 +5,7 @@
     Optional,
 )
 
+from easypost.api_key import ApiKey
 from easypost.easypost_object import convert_to_easypost_object
 from easypost.requestor import (
     RequestMethod,
@@ -57,7 +58,7 @@ def all_api_keys(cls, api_key: Optional[str] = None) -> Dict[str, Any]:
         response, api_key = requestor.request(method=RequestMethod.GET, url=url)
         return convert_to_easypost_object(response=response, api_key=api_key)
 
-    def api_keys(self) -> List[Dict[str, Any]]:
+    def api_keys(self) -> List[ApiKey]:
         """Retrieve a list of API keys (works for the authenticated user or a child user)."""
         api_keys = self.all_api_keys()
 

tests/cassettes/test_authenticated_user_api_keys.yaml

@@ -112,13 +112,11 @@ def vcr_config():
         ],
         "before_record_response": scrub_response_bodies(
             scrubbers=[
-                ["api_keys", SCRUBBED_ARRAY],
                 ["client_ip", SCRUBBED_STRING],
                 ["credentials", SCRUBBED_DICT],
                 ["email", SCRUBBED_STRING],
                 ["fields", SCRUBBED_ARRAY],
                 ["key", SCRUBBED_STRING],
-                ["keys", SCRUBBED_ARRAY],
                 ["phone_number", SCRUBBED_STRING],
                 ["phone", SCRUBBED_STRING],
                 ["test_credentials", SCRUBBED_DICT],

tests/cassettes/test_child_user_api_keys.yaml

@@ -70,7 +70,9 @@ def test_user_all_api_keys(prod_api_key):
     user = easypost.User.retrieve_me()
     api_keys = user.all_api_keys()
 
-    assert api_keys["keys"] is not None
+    assert all(isinstance(key, easypost.ApiKey) for key in api_keys.keys)
+    for child in api_keys.children:
+        assert all(isinstance(key, easypost.ApiKey) for key in child["keys"])
 
 
 @pytest.mark.vcr()
@@ -79,7 +81,7 @@ def test_authenticated_user_api_keys(prod_api_key):
     user = easypost.User.retrieve_me()
     api_keys = user.api_keys()
 
-    assert api_keys is not None
+    assert all(isinstance(key, easypost.ApiKey) for key in api_keys)
 
 
 @pytest.mark.vcr()
@@ -90,7 +92,10 @@ def test_child_user_api_keys(prod_api_key):
 
     api_keys = child_user.api_keys()
 
-    assert api_keys is not None
+    assert all(isinstance(key, easypost.ApiKey) for key in api_keys)
+
+    # Delete the user so we don't clutter up the test environment
+    user.delete()
 
 
 @pytest.mark.vcr()