Add reading API key from env vars (#28)

Author: ebram96

src/abstract_api/avatars/avatars.py

@@ -1,3 +1,5 @@
+from typing import ClassVar
+
 from ..core.bases import BaseService
 from ..core.exceptions import ClientRequestError
 from ..core.validators import numerical
@@ -14,6 +16,7 @@ class Avatars(BaseService[AvatarsResponse]):
         _subdomain: Avatars service subdomain.
     """
     _subdomain = "avatars"
+    _service_name_env_var: ClassVar[str] = "AVATARS"
 
     @staticmethod
     def _validate_params(**kwargs) -> None:

src/abstract_api/company_enrichment/company_enrichment.py

@@ -1,4 +1,4 @@
-from typing import Iterable
+from typing import ClassVar, Iterable
 
 from ..core.bases import BaseService
 from ..core.mixins import ResponseFieldsMixin
@@ -20,6 +20,7 @@ class CompanyEnrichment(
     """
     _subdomain = "companyenrichment"
     _response_fields = RESPONSE_FIELDS
+    _service_name_env_var: ClassVar[str] = "COMPANY_ENRICHMENT"
 
     def check(
         self,

src/abstract_api/core/bases/base_service.py

@@ -1,6 +1,7 @@
+import os
 from functools import lru_cache
 from io import BytesIO
-from typing import TYPE_CHECKING, Any, Final, Generic, Type, TypeVar
+from typing import TYPE_CHECKING, Any, ClassVar, Final, Generic, Type, TypeVar
 
 import requests
 from requests import codes
@@ -28,13 +29,37 @@ class BaseService(Generic[BaseResponseT]):
     """
     __base_url: Final[str] = "https://{subdomain}.abstractapi.com/v1/"
     _subdomain: str
+    _service_name_env_var: ClassVar[str]
 
-    def __init__(self, api_key: str) -> None:
+    @classmethod
+    def _read_api_key_from_env(cls) -> str | None:
+        """Reads service API key from environment variables.
+
+        API key exposed as an environment variable must be exposed using a
+        variable name with the pattern:
+        ABSTRACTAPI_{SERVICE_NAME}_API_KEY
+        Where SERVICE_NAME is the service name that the API key is for.
+        (service_name must be uppercase.)
+
+        Returns: API key read from environment variable.
+        """
+        pattern = "ABSTRACTAPI_{service_name}_API_KEY"
+        return os.environ.get(
+            pattern.format(service_name=cls._service_name_env_var)
+        )
+
+    def __init__(self, api_key: str | None = None) -> None:
         """Constructs a BaseService.
 
         Args:
             api_key: API key to be used to authenticate with AbstractAPI.
         """
+        api_key = api_key or self._read_api_key_from_env()
+        if api_key is None:
+            raise ValueError(
+                "API key was not provided nor exposed as an"
+                " environment variable"
+            )
         self._api_key: str = api_key
 
     @lru_cache(maxsize=5)

src/abstract_api/email_validation/email_validation.py

@@ -1,3 +1,5 @@
+from typing import ClassVar
+
 from ..core.bases import BaseService
 from .email_validation_response import EmailValidationResponse
 
@@ -11,6 +13,7 @@ class EmailValidation(BaseService[EmailValidationResponse]):
         _subdomain: Email validation service subdomain.
     """
     _subdomain = "emailvalidation"
+    _service_name_env_var: ClassVar[str] = "EMAIL_VALIDATION"
 
     def check(
         self,

src/abstract_api/exchange_rates/exchange_rates.py

@@ -1,4 +1,4 @@
-from typing import Iterable
+from typing import ClassVar, Iterable
 
 from ..core.bases import BaseService
 from ..core.validators import numerical
@@ -18,6 +18,7 @@ class ExchangeRates(BaseService):
         _subdomain: Exchange rates service subdomain.
     """
     _subdomain = "exchange-rates"
+    _service_name_env_var: ClassVar[str] = "EXCHANGE_RATES"
 
     @staticmethod
     def _target_as_param(target: Iterable[str] | None = None) -> str | None:

src/abstract_api/holidays/holidays.py

@@ -1,3 +1,5 @@
+from typing import ClassVar
+
 from ..core.bases import BaseService
 from ..core.validators import numerical
 from .holidays_response import HolidaysResponse
@@ -13,6 +15,7 @@ class Holidays(BaseService[HolidaysResponse]):
         _subdomain: Holidays service subdomain.
     """
     _subdomain = "holidays"
+    _service_name_env_var: ClassVar[str] = "HOLIDAYS"
 
     @staticmethod
     def _validate_params(**kwargs) -> None:

src/abstract_api/iban_validation/iban_validation.py

@@ -1,3 +1,5 @@
+from typing import ClassVar
+
 from ..core.bases import BaseService
 from .iban_validation_response import IBANValidationResponse
 
@@ -11,6 +13,7 @@ class IBANValidation(BaseService[IBANValidationResponse]):
         _subdomain: IBAN validation service subdomain.
     """
     _subdomain = "ibanvalidation"
+    _service_name_env_var: ClassVar[str] = "IBAN_VALIDATION"
 
     def check(self, iban: str) -> IBANValidationResponse:
         """Validates an IBAN.

src/abstract_api/image_processing/image_processing.py

@@ -1,5 +1,5 @@
 import json
-from typing import Any, BinaryIO
+from typing import Any, BinaryIO, ClassVar
 
 from ..core.bases import BaseService
 from ..core.exceptions import ClientRequestError
@@ -17,6 +17,7 @@ class ImageProcessing(BaseService[ImageProcessingResponse]):
         _subdomain: Image processing service subdomain.
     """
     _subdomain = "images"
+    _service_name_env_var: ClassVar[str] = "IMAGE_PROCESSING"
 
     def upload(
         self,

src/abstract_api/ip_geolocation/ip_geolocation.py

@@ -1,4 +1,4 @@
-from typing import Iterable
+from typing import ClassVar, Iterable
 
 from ..core.bases import BaseService
 from ..core.mixins import ResponseFieldsMixin
@@ -17,6 +17,7 @@ class IPGeolocation(ResponseFieldsMixin, BaseService[IPGeolocationResponse]):
             Geolocation service endpoint.
     """
     _subdomain = "ipgeolocation"
+    _service_name_env_var: ClassVar[str] = "IP_GEOLOCATION"
     _response_fields = RESPONSE_FIELDS
 
     def check(

src/abstract_api/phone_validation/phone_validation.py

@@ -1,3 +1,5 @@
+from typing import ClassVar
+
 from ..core.bases import BaseService
 from .phone_validation_response import PhoneValidationResponse
 
@@ -11,6 +13,7 @@ class PhoneValidation(BaseService[PhoneValidationResponse]):
         _subdomain: Phone validation service subdomain.
     """
     _subdomain = "phonevalidation"
+    _service_name_env_var: ClassVar[str] = "PHONE_VALIDATION"
 
     def check(self, phone: str) -> PhoneValidationResponse:
         """Validates and verifies a phone number.