refactor(test): refactor authentication tests (#126)

Author: stainless-bot

README.md

@@ -24,7 +24,7 @@ The full API of this library can be found in [api.md](https://www.github.com/Fin
 from finch import Finch
 
 client = Finch(
-    access_token="my access token",
+    access_token="My Access Token",
 )
 
 page = client.hris.directory.list(
@@ -42,7 +42,7 @@ Simply import `AsyncFinch` instead of `Finch` and use `await` with each API call
 from finch import AsyncFinch
 
 client = AsyncFinch(
-    access_token="my access token",
+    access_token="My Access Token",
 )
 
 

src/finch/_base_client.py

@@ -811,7 +811,10 @@ def close(self) -> None:
 
         The client will *not* be usable after this.
         """
-        self._client.close()
+        # If an error is thrown while constructing a client, self._client
+        # may not be present
+        if hasattr(self, "_client"):
+            self._client.close()
 
     def __enter__(self: _T) -> _T:
         return self

src/finch/_client.py

@@ -62,11 +62,11 @@ class Finch(SyncAPIClient):
     def __init__(
         self,
         *,
-        client_id: str | None = None,
-        client_secret: str | None = None,
-        webhook_secret: str | None = None,
+        access_token: str | None = None,
+        client_id: str | None = os.environ.get("FINCH_CLIENT_ID", None),
+        client_secret: str | None = os.environ.get("FINCH_CLIENT_SECRET", None),
+        webhook_secret: str | None = os.environ.get("FINCH_WEBHOOK_SECRET", None),
         base_url: Optional[str] = None,
-        access_token: Optional[str] = None,
         timeout: Union[float, Timeout, None, NotGiven] = NOT_GIVEN,
         max_retries: int = DEFAULT_MAX_RETRIES,
         default_headers: Mapping[str, str] | None = None,
@@ -98,14 +98,11 @@ def __init__(
         """
         self.access_token = access_token
 
-        client_id_envvar = os.environ.get("FINCH_CLIENT_ID", None)
-        self.client_id = client_id or client_id_envvar or None
+        self.client_id = client_id
 
-        client_secret_envvar = os.environ.get("FINCH_CLIENT_SECRET", None)
-        self.client_secret = client_secret or client_secret_envvar or None
+        self.client_secret = client_secret
 
-        webhook_secret_envvar = os.environ.get("FINCH_WEBHOOK_SECRET", None)
-        self.webhook_secret = webhook_secret or webhook_secret_envvar or None
+        self.webhook_secret = webhook_secret
 
         if base_url is None:
             base_url = f"https://api.tryfinch.com"
@@ -162,10 +159,10 @@ def _validate_headers(self, headers: Headers, custom_headers: Headers) -> None:
     def copy(
         self,
         *,
+        access_token: str | None = None,
         client_id: str | None = None,
         client_secret: str | None = None,
         webhook_secret: str | None = None,
-        access_token: str | None = None,
         base_url: str | None = None,
         timeout: float | Timeout | None | NotGiven = NOT_GIVEN,
         http_client: httpx.Client | None = None,
@@ -219,11 +216,11 @@ def copy(
             http_client = http_client or self._client
 
         return self.__class__(
+            access_token=access_token or self.access_token,
             client_id=client_id or self.client_id,
             client_secret=client_secret or self.client_secret,
             webhook_secret=webhook_secret or self.webhook_secret,
             base_url=base_url or str(self.base_url),
-            access_token=access_token or self.access_token,
             timeout=self.timeout if isinstance(timeout, NotGiven) else timeout,
             http_client=http_client,
             connection_pool_limits=connection_pool_limits,
@@ -354,11 +351,11 @@ class AsyncFinch(AsyncAPIClient):
     def __init__(
         self,
         *,
-        client_id: str | None = None,
-        client_secret: str | None = None,
-        webhook_secret: str | None = None,
+        access_token: str | None = None,
+        client_id: str | None = os.environ.get("FINCH_CLIENT_ID", None),
+        client_secret: str | None = os.environ.get("FINCH_CLIENT_SECRET", None),
+        webhook_secret: str | None = os.environ.get("FINCH_WEBHOOK_SECRET", None),
         base_url: Optional[str] = None,
-        access_token: Optional[str] = None,
         timeout: Union[float, Timeout, None, NotGiven] = NOT_GIVEN,
         max_retries: int = DEFAULT_MAX_RETRIES,
         default_headers: Mapping[str, str] | None = None,
@@ -390,14 +387,11 @@ def __init__(
         """
         self.access_token = access_token
 
-        client_id_envvar = os.environ.get("FINCH_CLIENT_ID", None)
-        self.client_id = client_id or client_id_envvar or None
+        self.client_id = client_id
 
-        client_secret_envvar = os.environ.get("FINCH_CLIENT_SECRET", None)
-        self.client_secret = client_secret or client_secret_envvar or None
+        self.client_secret = client_secret
 
-        webhook_secret_envvar = os.environ.get("FINCH_WEBHOOK_SECRET", None)
-        self.webhook_secret = webhook_secret or webhook_secret_envvar or None
+        self.webhook_secret = webhook_secret
 
         if base_url is None:
             base_url = f"https://api.tryfinch.com"
@@ -454,10 +448,10 @@ def _validate_headers(self, headers: Headers, custom_headers: Headers) -> None:
     def copy(
         self,
         *,
+        access_token: str | None = None,
         client_id: str | None = None,
         client_secret: str | None = None,
         webhook_secret: str | None = None,
-        access_token: str | None = None,
         base_url: str | None = None,
         timeout: float | Timeout | None | NotGiven = NOT_GIVEN,
         http_client: httpx.AsyncClient | None = None,
@@ -511,11 +505,11 @@ def copy(
             http_client = http_client or self._client
 
         return self.__class__(
+            access_token=access_token or self.access_token,
             client_id=client_id or self.client_id,
             client_secret=client_secret or self.client_secret,
             webhook_secret=webhook_secret or self.webhook_secret,
             base_url=base_url or str(self.base_url),
-            access_token=access_token or self.access_token,
             timeout=self.timeout if isinstance(timeout, NotGiven) else timeout,
             http_client=http_client,
             connection_pool_limits=connection_pool_limits,

src/finch/_utils/__init__.py

@@ -21,6 +21,9 @@
 from ._utils import extract_type_arg as extract_type_arg
 from ._utils import is_required_type as is_required_type
 from ._utils import is_annotated_type as is_annotated_type
+from ._utils import maybe_coerce_float as maybe_coerce_float
+from ._utils import maybe_coerce_boolean as maybe_coerce_boolean
+from ._utils import maybe_coerce_integer as maybe_coerce_integer
 from ._utils import strip_annotated_type as strip_annotated_type
 from ._transform import PropertyInfo as PropertyInfo
 from ._transform import transform as transform

src/finch/_utils/_utils.py

@@ -309,6 +309,24 @@ def coerce_boolean(val: str) -> bool:
     return val == "true" or val == "1" or val == "on"
 
 
+def maybe_coerce_integer(val: str | None) -> int | None:
+    if val is None:
+        return None
+    return coerce_integer(val)
+
+
+def maybe_coerce_float(val: str | None) -> float | None:
+    if val is None:
+        return None
+    return coerce_float(val)
+
+
+def maybe_coerce_boolean(val: str | None) -> bool | None:
+    if val is None:
+        return None
+    return coerce_boolean(val)
+
+
 def removeprefix(string: str, prefix: str) -> str:
     """Remove a prefix from a string.
 

tests/api_resources/hris/benefits/test_individuals.py

@@ -17,7 +17,7 @@
 )
 
 base_url = os.environ.get("TEST_API_BASE_URL", "http://127.0.0.1:4010")
-access_token = os.environ.get("API_KEY", "something1234")
+access_token = "My Access Token"
 
 
 class TestIndividuals:

tests/api_resources/hris/test_benefits.py

@@ -17,7 +17,7 @@
 )
 
 base_url = os.environ.get("TEST_API_BASE_URL", "http://127.0.0.1:4010")
-access_token = os.environ.get("API_KEY", "something1234")
+access_token = "My Access Token"
 
 
 class TestBenefits:

tests/api_resources/hris/test_company.py

@@ -11,7 +11,7 @@
 from finch.types.hris import Company
 
 base_url = os.environ.get("TEST_API_BASE_URL", "http://127.0.0.1:4010")
-access_token = os.environ.get("API_KEY", "something1234")
+access_token = "My Access Token"
 
 
 class TestCompany:

tests/api_resources/hris/test_directory.py

@@ -12,7 +12,7 @@
 from finch.types.hris import IndividualInDirectory
 
 base_url = os.environ.get("TEST_API_BASE_URL", "http://127.0.0.1:4010")
-access_token = os.environ.get("API_KEY", "something1234")
+access_token = "My Access Token"
 
 
 class TestDirectory:

tests/api_resources/hris/test_employments.py

@@ -12,7 +12,7 @@
 from finch.types.hris import EmploymentDataResponse
 
 base_url = os.environ.get("TEST_API_BASE_URL", "http://127.0.0.1:4010")
-access_token = os.environ.get("API_KEY", "something1234")
+access_token = "My Access Token"
 
 
 class TestEmployments:

tests/api_resources/hris/test_individuals.py

@@ -12,7 +12,7 @@
 from finch.types.hris import IndividualResponse
 
 base_url = os.environ.get("TEST_API_BASE_URL", "http://127.0.0.1:4010")
-access_token = os.environ.get("API_KEY", "something1234")
+access_token = "My Access Token"
 
 
 class TestIndividuals:

tests/api_resources/hris/test_pay_statements.py

@@ -12,7 +12,7 @@
 from finch.types.hris import PayStatementResponse
 
 base_url = os.environ.get("TEST_API_BASE_URL", "http://127.0.0.1:4010")
-access_token = os.environ.get("API_KEY", "something1234")
+access_token = "My Access Token"
 
 
 class TestPayStatements:

tests/api_resources/hris/test_payments.py

@@ -13,7 +13,7 @@
 from finch.types.hris import Payment
 
 base_url = os.environ.get("TEST_API_BASE_URL", "http://127.0.0.1:4010")
-access_token = os.environ.get("API_KEY", "something1234")
+access_token = "My Access Token"
 
 
 class TestPayments:

tests/api_resources/test_account.py

@@ -11,7 +11,7 @@
 from tests.utils import assert_matches_type
 
 base_url = os.environ.get("TEST_API_BASE_URL", "http://127.0.0.1:4010")
-access_token = os.environ.get("API_KEY", "something1234")
+access_token = "My Access Token"
 
 
 class TestAccount:

tests/api_resources/test_providers.py

@@ -12,7 +12,7 @@
 from finch.pagination import SyncSinglePage, AsyncSinglePage
 
 base_url = os.environ.get("TEST_API_BASE_URL", "http://127.0.0.1:4010")
-access_token = os.environ.get("API_KEY", "something1234")
+access_token = "My Access Token"
 
 
 class TestProviders:

tests/api_resources/test_request_forwarding.py

@@ -11,7 +11,7 @@
 from tests.utils import assert_matches_type
 
 base_url = os.environ.get("TEST_API_BASE_URL", "http://127.0.0.1:4010")
-access_token = os.environ.get("API_KEY", "something1234")
+access_token = "My Access Token"
 
 
 class TestRequestForwarding:

tests/api_resources/test_top_level.py

@@ -9,7 +9,7 @@
 from finch import Finch, AsyncFinch
 
 base_url = os.environ.get("TEST_API_BASE_URL", "http://127.0.0.1:4010")
-access_token = os.environ.get("API_KEY", "something1234")
+access_token = "My Access Token"
 
 
 class TestTopLevel:

tests/api_resources/test_webhooks.py

@@ -13,7 +13,7 @@
 from finch import Finch, AsyncFinch
 
 base_url = os.environ.get("TEST_API_BASE_URL", "http://127.0.0.1:4010")
-access_token = os.environ.get("API_KEY", "something1234")
+access_token = "My Access Token"
 
 
 class TestWebhooks:

tests/test_client.py

@@ -26,7 +26,7 @@
 )
 
 base_url = os.environ.get("TEST_API_BASE_URL", "http://127.0.0.1:4010")
-access_token = os.environ.get("API_KEY", "something1234")
+access_token = "My Access Token"
 
 
 def _get_params(client: BaseClient) -> dict[str, str]:
@@ -51,9 +51,9 @@ def test_copy(self) -> None:
         copied = self.client.copy()
         assert id(copied) != id(self.client)
 
-        copied = self.client.copy(access_token="my new access token")
-        assert copied.access_token == "my new access token"
-        assert self.client.access_token == access_token
+        copied = self.client.copy(access_token="another My Access Token")
+        assert copied.access_token == "another My Access Token"
+        assert self.client.access_token == "My Access Token"
 
     def test_copy_default_options(self) -> None:
         # options that have a default are overridden correctly
@@ -680,9 +680,9 @@ def test_copy(self) -> None:
         copied = self.client.copy()
         assert id(copied) != id(self.client)
 
-        copied = self.client.copy(access_token="my new access token")
-        assert copied.access_token == "my new access token"
-        assert self.client.access_token == access_token
+        copied = self.client.copy(access_token="another My Access Token")
+        assert copied.access_token == "another My Access Token"
+        assert self.client.access_token == "My Access Token"
 
     def test_copy_default_options(self) -> None:
         # options that have a default are overridden correctly