Merge pull request #26 from LeanderCS/25

25 | Add more filters and validators

Author: LeanderCS

.coveragerc

@@ -2,4 +2,4 @@
 source = flask_inputfilter
 
 [report]
-omit = __init__.py, setup.py, */test/*
+omit = __init__.py, setup.py, */test/*

Dockerfile

@@ -2,7 +2,7 @@ FROM python:3.7-slim
 
 WORKDIR /app
 
-RUN apt-get update && apt-get install -y gcc python3-dev git
+RUN apt-get update && apt-get install -y gcc python3-dev
 
 RUN pip install --upgrade pip
 

README.rst

@@ -36,6 +36,8 @@ For information about the usage you can view the documentation `here <https://le
 
     .. image:: https://img.shields.io/pypi/dm/flask-inputfilter?style=flat-square&label=PyPI
         :target: https://pypi.org/project/flask-inputfilter/
+    .. image:: https://static.pepy.tech/badge/flask-inputfilter
+        :target: https://pypi.org/project/flask-inputfilter/
 
 Installation
 ============
@@ -127,7 +129,7 @@ If the data is invalid, a 400 response with an error message will be returned.
 See also
 ========
 
-For further instructions please view the documentary `here <https://leandercs.github.io/flask-inputfilter>`__.
+For further instructions please view the `documentary <https://leandercs.github.io/flask-inputfilter>`__.
 
-For ideas, suggestions or questions, please open an issue on GitHub `here <https://github.com/LeanderCS/flask-inputfilter>`__.
+For ideas, suggestions or questions, please open an issue on `GitHub <https://github.com/LeanderCS/flask-inputfilter>`__.
 

docs/changelog.rst

@@ -3,90 +3,109 @@ Changelog
 
 All notable changes to this project will be documented in this file.
 
-[0.0.8] - 2025-01-20
+[0.0.9] - 2025-01-29
 --------------------
 
 Added
 ^^^^^
+- New ``copy`` functionality to copy the value of another field. `Check it out <options/copy>`_
+
+Filter
+""""""
+- New ``ToDataclassFilter`` to convert a dictionary to a dataclass.
+- New ``ToTypedDictFilter`` to convert a dictionary to a TypedDict.
+
+Validator
+"""""""""
+- New ``CustomJsonValidator`` to check if a value is the format of a specific json.
+- New ``IsDataclassValidator`` to check if a value is a dataclass.
+- New ``IsTypedDictValidator`` to check if a value is a TypedDict.
+
+Changed
+^^^^^^^
+- Moved external API call before the filter and validation process.
+  Before, filters and validators the the external API field where useless,
+  because the value of the field where replaced by the API result.
+- Updated ``SlugifyFilter`` to remove accents and other special characters.
+
+
+[0.0.8] - 2025-01-20
+--------------------
 
+Added
+^^^^^
 - New functionality to define steps for a field to have more control over the
   order of the validation and filtering process.
 - Documentary
 
 Filter
 """"""
-
-- New `Base64ImageDownscaleFilter` to reduce the size of an image.
-- New `Base64ImageResizeFilter` to reduce the file size of an image.
+- New ``Base64ImageDownscaleFilter`` to reduce the size of an image.
+- New ``Base64ImageResizeFilter`` to reduce the file size of an image.
 
 Validator
 """""""""
-
-- New `IsHorizontalImageValidator` to check if an image is horizontal.
-- New `IsVerticalImageValidator` to check if an image is vertical.
+- New ``IsHorizontalImageValidator`` to check if an image is horizontal.
+- New ``IsVerticalImageValidator`` to check if an image is vertical.
 
 Changed
 ^^^^^^^
-
-- Added `UnicodeFormEnum` to show possible config values for `ToNormalizedUnicodeFilter`.
+- Added ``UnicodeFormEnum`` to show possible config values for ``ToNormalizedUnicodeFilter``.
   Old config is still supported, but will be removed in a later version.
 
+
 [0.0.7.1] - 2025-01-16
 ----------------------
 
 Changed
 ^^^^^^^
+- Updated ``setup.py`` to fix the issue with the missing subfolders.
 
-- Updated `setup.py` to fix the issue with the missing subfolders.
 
 [0.0.7] - 2025-01-14
 --------------------
 
 Added
 ^^^^^
-
-- Workflow to run tests on all supported Python versions. [Check it out](.github/workflows/test_env.yaml)
+- Workflow to run tests on all supported Python versions.
 - Added more test coverage for validators and filters.
 - Added tracking of coverage in tests. `Check it out <https://coveralls.io/github/LeanderCS/flask-inputfilter>`_
-- New functionality for global filters and validators in `InputFilters`.
+- New functionality for global filters and validators in ``InputFilters``.
 - New functionality to define custom supported methods.
 
 Validator
 """""""""
+- New ``NotInArrayValidator`` to check if a value is not in a list.
+- New ``NotValidator`` to invert the result of another validator.
 
-- New `NotInArrayValidator` to check if a value is not in a list.
-- New `NotValidator` to invert the result of another validator.
 
 [0.0.6] - 2025-01-12
 --------------------
 
 Added
 ^^^^^
-
 - New date validators and filters.
 
 Removed
 ^^^^^^^
-
 - Dropped support for Python 3.6.
 
+
 [0.0.5] - 2025-01-12
 --------------------
 
 Added
 ^^^^^
-
-- New condition functionality between fields. [Check it out](flask_inputfilter/Condition/README.md)
+- New ``condition`` functionality between fields. `Check it out <options/condition>`_
 
 Changed
 ^^^^^^^
+- Switched ``external_api`` config from dict to class. `Check it out <options/external_api#Configuration>`_
 
-- Switched `external_api` config from dict to class. [Check it out](flask_inputfilter/Model/ExternalApiConfig.py)
 
 [0.0.4] - 2025-01-09
 --------------------
 
 Added
 ^^^^^
-
-- New external API functionality. [Check it out](docs/EXTERNAL_API.md)
+- New external API functionality. `Check it out <options/external_api>`_

docs/index.rst

@@ -32,22 +32,12 @@ Available functions:
         </p>
         <p style="margin:0;">
             Thank you for using <code>flask-inputfilter</code>!<br>
-            If you have any questions or suggestions, please feel free to open an issue on GitHub <a href="https://github.com/LeanderCS/flask-inputfilter">here</a>.<br>
+            If you have any questions or suggestions, please feel free to open an issue on <a href="https://github.com/LeanderCS/flask-inputfilter">GitHub</a>.<br>
             If you don't want to miss any updates, please star the repository.<br>
             This will help me to understand how many people are interested in this project.<br>
         </p>
     </div>
 
-    <div style="border:1px solid #86989B;padding:1rem;border-radius:3px;margin:20px 0 40px;">
-        <p style="background-color:hsl(150, 36.7%, 90%);margin:-1rem -1rem 0.8rem -1rem;padding:0.3rem 1rem 0.3rem 2.5rem;position:relative;border-radius:3px 3px 0 0;">
-            <span style="content:'';position:absolute;top:.25rem;left:.5rem;width:1.5rem;height:1.5rem;background-color:hsl(150, 36.7%, 50%);mask-image:url('data:image/svg+xml;charset=utf-8,<svg xmlns=&quot;http://www.w3.org/2000/svg&quot; viewBox=&quot;0 0 24 24&quot;><path d=&quot;M15.07 11.25l-.9.92C13.45 12.89 13 13.5 13 15h-2v-.5c0-1.11.45-2.11 1.17-2.83l1.24-1.26c.37-.36.59-.86.59-1.41a2 2 0 00-2-2 2 2 0 00-2 2H8a4 4 0 014-4 4 4 0 014 4 3.2 3.2 0 01-.93 2.25M13 19h-2v-2h2M12 2A10 10 0 002 12a10 10 0 0010 10 10 10 0 0010-10c0-5.53-4.5-10-10-10z&quot;/></svg>');"></span>
-            Hint
-        </p>
-        <p style="margin:0;">
-            For information about the usage you can view the documentation <a href="https://leandercs.github.io/flask-inputfilter">here</a>.
-        </p>
-    </div>
-
 Installation
 ------------
 

docs/options/copy.rst

@@ -0,0 +1,49 @@
+Copy functionality
+==================
+
+
+Overview
+--------
+
+The copy functionality is configured via the ``copy`` parameter in the ``add`` method.
+This parameter accepts a string with the name the value should be copied from.
+
+.. note::
+
+    The copy functionality runs **before** all filters and validators have been executed.
+    This means the copied data can be validated and/or filtered.
+
+Examples
+--------
+
+Basic Copy Integration
+
+.. code-block:: python
+
+    from flask_inputfilter import InputFilter
+    from flask_inputfilter.Filter import SlugifyFilter
+
+    class MyInputFilter(InputFilter):
+        def __init__(self):
+            super().__init__()
+
+            self.add(
+                "username"
+            )
+
+            self.add(
+                "escapedUsername",
+                copy="username"
+                filters=[SlugifyFilter()]
+            )
+
+    # Example usage
+    # Body: {"username": "Very Important User"}
+
+    @app.route("/test", methods=["GET"])
+    @MyInputFilter.validate()
+    def test_route():
+        validated_data = g.validated_data
+
+        # Cotains the same value as username but escaped eg. "very-important-user"
+        print(validated_data["escapedUsername"])

docs/options/external_api.rst

@@ -1,7 +1,8 @@
 External API
 ============
 
-This documentation provides a comprehensive overview of the external API functionality available in the `InputFilter` class. It covers the configuration, core methods, and examples of usage for interacting with external APIs.
+This documentation provides a comprehensive overview of the external API functionality available in the `InputFilter` class.
+It covers the configuration, core methods, and examples of usage for interacting with external APIs.
 
 Overview
 --------
@@ -11,8 +12,8 @@ This feature allows dynamic data retrieval based on user inputs, such as validat
 
 .. note::
 
-    The external API functionality runs **after** all other filters and validators have been executed.
-    This means the data fetched from the external API will not be validated or filtered.
+    The external API functionality runs **before** all filters and validators have been executed.
+    This means the data fetched from the external API can be validated and/or filtered as normal.
 
 Configuration
 -------------
@@ -52,7 +53,7 @@ Basic External API Integration
 
 .. code-block:: python
 
-    from flask_inputfilter.InputFilter import InputFilter
+    from flask_inputfilter import InputFilter
 
     class MyInputFilter(InputFilter):
         def __init__(self):
@@ -72,9 +73,13 @@ Basic External API Integration
             )
 
     # Example usage
-    filter_instance = MyInputFilter()
-    validated_data = filter_instance.validateData({"user_id": 123})
-    print(validated_data["is_active"])  # True or False based on API response
+    # Body: {"user_id": 123}
+
+    @app.route("/test", methods=["GET"])
+    @MyInputFilter.validate()
+    def test_route():
+        validated_data = g.validated_data
+        print(validated_data["is_active"])  # True or False based on API response
 
 Using Query Parameters
 ^^^^^^^^^^^^^^^^^^^^^^

flask_inputfilter/Condition/BaseCondition.py

@@ -1,11 +1,13 @@
+from abc import ABC, abstractmethod
 from typing import Any, Dict
 
 
-class BaseCondition:
+class BaseCondition(ABC):
     """
     Base class for defining conditions.
     Each condition should implement the `check` method.
     """
 
+    @abstractmethod
     def check(self, data: Dict[str, Any]) -> bool:
-        raise NotImplementedError("Condition must implement 'check' method.")
+        pass

flask_inputfilter/Filter/BaseFilter.py

@@ -1,10 +1,12 @@
+from abc import ABC, abstractmethod
 from typing import Any
 
 
-class BaseFilter:
+class BaseFilter(ABC):
     """
     BaseFilter-Class. Every filter should inherit from it.
     """
 
+    @abstractmethod
     def apply(self, value: Any) -> Any:
-        raise NotImplementedError("Filter apply method must be implemented")
+        pass

flask_inputfilter/Filter/SlugifyFilter.py

@@ -1,6 +1,8 @@
 import re
+import unicodedata
 from typing import Any, Optional, Union
 
+from flask_inputfilter.Enum import UnicodeFormEnum
 from flask_inputfilter.Filter import BaseFilter
 
 
@@ -13,6 +15,17 @@ def apply(self, value: Any) -> Union[Optional[str], Any]:
         if not isinstance(value, str):
             return value
 
+        value_without_accents = "".join(
+            char
+            for char in unicodedata.normalize(UnicodeFormEnum.NFD.value, value)
+            if unicodedata.category(char) != "Mn"
+        )
+
+        value = unicodedata.normalize(
+            UnicodeFormEnum.NFKD.value, value_without_accents
+        )
+        value = value.encode("ascii", "ignore").decode("ascii")
+
         value = value.lower()
 
         value = re.sub(r"[^\w\s-]", "", value)