Test/adding project tests (#31)

* Add initial Avatars tests

* Add initial CompanyEnrichment tests

* Create specific directories under tests directory

* Add numerical validators tests

* Add _base_response module tests

* Add BaseService tests

* Exclude 'if TYPE_CHECKING:' branches from test coverage

* Add FileResponse tests

* Set source directory for coverage

* Add JSONResponseMeta tests

* Add JSONResponse tests

* Add Country tests

* Add CompanyEnrichmentResponse tests

* Add JSONResponse.__setattr__ test

* Add APIRequestError tests

* Add NestedEntitiesMixin tests

* Add ResponseFieldsMixin tests

* Add EmailValidation tests

* Enhance TestCompanyEnrichment tests

* Refactor _init_response_field in classes to use parent's logic

* Add EmailValidationResponse test

* Add MultipleExchangeRatesResponse test

* Remove unused imports

* Add HistoricalExchangeRatesResponse tests

* Add ExchangeRatesConversionResponse tests

* Add LiveExchangeRatesResponse tests

* Add ExchangeRates tests

* Add HolidaysResponse tests

* Add Holidays tests

* Add IBANValidationResponse test

* Add IBANValidation test

* Add CropModeMixin tests

* Add HeightMixin tests

* Add WidthMixin tests

* Add Crop tests

* Add BaseStrategy test

* Add Fill tests

* Add Square tests

* Add IPGeolocationResponse test

* Add IPGeolocation tests

* Add an assertion to IPGeolocationResponse test

* Add PhoneValidationResponse test

* Add PhoneValidation test

* Add CurrentTimezoneResponse test

* Add TimezoneConversionResponse test

* Add Timezone tests

* Add VATValidationResponse test

* Add VATCalculationResponse test

* Add VATCategoriesResponse tests

* Add VAT tests

* Add WebScraping test

* Fix Avatars test

* Add WebsiteScreenshot tests

Author: ebram96

.coveragerc

@@ -0,0 +1,7 @@
+[run]
+source = src
+
+[report]
+exclude_lines =
+    pragma: no cover
+    if TYPE_CHECKING:

.gitignore

@@ -9,3 +9,6 @@ __pycache__/
 
 # Distribution / packaging
 *.egg-info/
+
+# Coverage.py
+.coverage

.pre-commit-config.yaml

@@ -1,3 +1,4 @@
+fail_fast: true
 repos:
 -   repo: https://github.com/pre-commit/pre-commit-hooks
     rev: v4.5.0
@@ -12,6 +13,7 @@ repos:
     hooks:
     -   id: flake8
         args: [--max-line-length=79]
+        exclude: "tests"
 
 -   repo: https://github.com/pycqa/isort
     rev: 5.11.5
@@ -26,12 +28,23 @@ repos:
         args:
         -    --convention=google
         -    --add-ignore=D100,D104  # Ignore missing docstring in public module or package
+        exclude: "tests"
 
 -   repo: https://github.com/pre-commit/mirrors-mypy
     rev: v1.6.1
     hooks:
     -   id: mypy
         additional_dependencies: ['types-requests']
+        exclude: "tests"
+
+-   repo: local
+    hooks:
+      - id: unit-tests
+        name: unit tests
+        entry: pytest
+        language: system
+        pass_filenames: false
+        always_run: true
 
 -   repo: https://github.com/Lucas-C/pre-commit-hooks
     rev: v1.5.4

src/abstract_api/avatars/__init__.py

@@ -1,7 +1,9 @@
 from typing import Final
 
 from .avatars import Avatars
+from .avatars_response import AvatarsResponse
 
 __all__: Final[list[str]] = [
-    "Avatars"
+    "Avatars",
+    "AvatarsResponse"
 ]

src/abstract_api/core/bases/base_service.py

@@ -102,8 +102,8 @@ def _service_request(
             Parsed AbstractAPI's response.
         """
         # Prepare HTTP method
-        _method = _method.lower()
-        if _method not in ["get", "post"]:
+        _method = _method.upper()
+        if _method not in ["GET", "POST"]:
             raise ClientRequestError(
                 f"Invalid or not allowed HTTP method '{_method}'"
             )
@@ -113,7 +113,7 @@ def _service_request(
             "method": _method,
             "url": self.__service_url(_action)
         }
-        if _method == "get":
+        if _method == "GET":
             request_kwargs["params"] = {"api_key": self._api_key} | {
                 # Ignore all None parameters, no need to transfer them over
                 # the network call.
@@ -122,9 +122,9 @@ def _service_request(
                 if value is not None
             }
         else:
-            if _files:
+            if _files is not None:
                 request_kwargs["files"] = _files
-            if _body:
+            if _body is not None:
                 request_kwargs["json"] = _body
 
         # Make call

src/abstract_api/core/bases/json_response.py

@@ -28,6 +28,25 @@ class JSONResponse(BaseResponse):
     _meta_class: ClassVar[Type[JSONResponseMeta]] = JSONResponseMeta
     meta: JSONResponseMeta
 
+    def __setattr__(self, key: str, value: Any) -> None:
+        """Sets a property only if it is not a response field.
+
+        The main reason for customizing the original method is that we use
+        functools.cached_property, and it allows setting a property value after
+        it is cached, even if it has no setter.
+        """
+        response_fields_attr = "_response_fields"
+        if key == response_fields_attr:
+            if response_fields_attr in self.__dict__:
+                raise AttributeError(
+                    f"'{response_fields_attr}' should not be changed"
+                )
+        elif key in self._response_fields:
+            raise AttributeError(
+                f"value of response field '{key}' should not be changed"
+            )
+        return super().__setattr__(key, value)
+
     def _init_response_field(self, field: str, value: Any) -> None:
         """Sets a response field's value during instance initialization.
 
@@ -47,8 +66,9 @@ def __init__(
         list_response: bool = False
     ) -> None:
         """Initialize a new JSONResponse."""
+        self._response_fields = response_fields  # Must be set first.
+
         super().__init__(response)
-        self._response_fields = response_fields
 
         if self.meta.body_json is None:
             return

src/abstract_api/core/mixins/nested_entities_mixin.py

@@ -1,7 +1,18 @@
-from typing import Any, ClassVar, Type
+from typing import TYPE_CHECKING, Any, ClassVar, Protocol, Type
 
 
-class NestedEntitiesMixin:
+class _ResponseFieldProtocol(Protocol):
+    def _init_response_field(self, field: str, value: Any) -> None:
+        ...
+
+
+if TYPE_CHECKING:
+    _Base = _ResponseFieldProtocol
+else:
+    _Base = object
+
+
+class NestedEntitiesMixin(_Base):
     """Nested entities mixin for responses that have nested entities."""
     _nested_entities: ClassVar[dict[str, Type]]
 
@@ -15,9 +26,6 @@ def _init_response_field(self, field: str, value: Any) -> None:
             value: Value to be set. The value is parsed to a nested entity
                 if the field is a nested entity.
         """
-        setattr(
-            self,
-            f"_{field}",
-            value if field not in self._nested_entities
-            else self._nested_entities[field](**value)
-        )
+        if field in self._nested_entities:
+            value = self._nested_entities[field](**value)
+        super()._init_response_field(field, value)

src/abstract_api/email_validation/email_validation_response.py

@@ -30,12 +30,9 @@ def _init_response_field(self, field: str, value: Any) -> None:
             value: Value to be set. The value is parsed to a nested entity
                 if the field is a nested entity.
         """
-        setattr(
-            self,
-            f"_{field}",
-            value if field not in self._complex_bool_fields
-            else value["value"]
-        )
+        if field in self._complex_bool_fields:
+            value = value["value"]
+        super()._init_response_field(field, value)
 
     def __init__(
         self,

src/abstract_api/exchange_rates/exchange_rates.py

@@ -89,9 +89,14 @@ def convert(
         Returns:
             ExchangeRatesConversionResponse representing API call response.
         """
-        numerical.greater_or_equal("base_amount", base_amount, 0)
+        if base_amount is not None:
+            numerical.greater_or_equal("base_amount", base_amount, 0)
+
         return self._service_request(
             _response_class=ExchangeRatesConversionResponse,
+            _response_class_kwargs={
+                "date_included_in_request": date is not None
+            },
             _action="convert",
             base=base,
             target=target,

src/abstract_api/exchange_rates/exchange_rates_conversion_response.py

@@ -9,9 +9,20 @@
 class ExchangeRatesConversionResponse(JSONResponse):
     """Exchange rate conversion service response."""
 
-    def __init__(self, response: requests.models.Response) -> None:
+    def __init__(
+        self,
+        response: requests.models.Response,
+        date_included_in_request: bool | None = False
+    ) -> None:
         """Initializes a new ExchangeRateConversionResponse."""
-        super().__init__(response, CONVERSION_RESPONSE_FIELDS)
+        super().__init__(
+            response,
+            CONVERSION_RESPONSE_FIELDS - {
+                "last_updated"
+                if date_included_in_request
+                else "date"
+            }
+        )
 
     @cached_property
     def base(self) -> str | None:
@@ -27,7 +38,9 @@ def target(self) -> str | None:
     def date(self) -> str | None:
         """The date the currencies were pulled from.
 
-        This is per successful request.
+        This is per successful request and returned only when 'date' parameter
+        is passed in request.
+        This is mutually-exclusive with 'last_updated' in response.
         """
         return self._get_response_field("date")
 
@@ -52,5 +65,9 @@ def exchange_rate(self) -> float | None:
 
     @cached_property
     def last_updated(self) -> int | None:
-        """The Unix timestamp of when the returned data was last updated."""
+        """The Unix timestamp of when the returned data was last updated.
+
+        This is returned if 'date' parameter was not passed in request.
+        This is mutually-exclusive with 'date' in response.
+        """
         return self._get_response_field("last_updated")