1 | Create new filters and validators

Author: LeanderCS

.flake8

@@ -1,2 +1,3 @@
 [flake8]
 exclude = __init__.py, venv, *.md, .*
+max-line-length = 90

DEVELOPMENT.md

@@ -2,7 +2,7 @@
 
 ### Build docker image
 ```bash
-docker build -t jtrfaker .
+docker build -t flask-inputfilter .
 ```
 
 ### Run docker container in interactive mode
@@ -11,15 +11,15 @@ docker compose up -d
 ```
 
 ```bash
-docker exec -it jtrfaker bash
+docker exec -it flask-inputfilter /bin/bash
 ```
 
 ### Run tests
 ```bash
-docker exec -it jtrfaker pytest
+docker exec -it flask-inputfilter pytest
 ```
 
 ### Run linting
 ```bash
-docker exec -it jtrfaker flake8
+docker exec -it flask-inputfilter black .
 ```

README.md

@@ -9,7 +9,7 @@ It provides a modular way to clean and ensure that incoming data meets expected
 pip install flask-inputfilter
 ```
 
-## Usage
+## Quickstart
 
 To use the `InputFilter` class, you need to create a new class that inherits from it and define the fields you want to validate and filter.
 There are lots of different filters and validators available to use, and you can also create your own custom filters and validators.
@@ -19,8 +19,8 @@ There are lots of different filters and validators available to use, and you can
 ```python
 from flask_inputfilter import InputFilter
 from flask_inputfilter.Enum import RegexEnum
-from flask_inputfilter.Filter import ToIntegerFilter, ToNullFilter, StringTrimFilter
-from flask_inputfilter.Validator import RegexValidator
+from flask_inputfilter.Filter import StringTrimFilter, ToIntegerFilter, ToNullFilter
+from flask_inputfilter.Validator import IsIntegerValidator, RegexValidator 
 
 
 class UpdateZipcodeInputFilter(InputFilter):
@@ -31,7 +31,10 @@ class UpdateZipcodeInputFilter(InputFilter):
         self.add(
             'id',
             required=True,
-            filters=[ToIntegerFilter(), ToNullFilter()]
+            filters=[ToIntegerFilter(), ToNullFilter()],
+            validators=[
+                IsIntegerValidator()
+            ]
         )
 
         self.add(
@@ -41,7 +44,7 @@ class UpdateZipcodeInputFilter(InputFilter):
             validators=[
                 RegexValidator(
                     RegexEnum.POSTAL_CODE.value,
-                    'The email is not in the format of an email.'
+                    'The zipcode is not in the correct format.'
                 )
             ]
         )
@@ -69,3 +72,25 @@ def updateZipcode():
     zipcode = data.get('zipcode')
 ```
 
+## Options
+
+The `add` method takes the following options:
+
+- [`Required`](#required)
+- [`Filter`](src/flask_inputfilter/Filter/README.md)
+- [`Validator`](src/flask_inputfilter/Validator/README.md)
+- [`Default`](#default)
+- [`Fallback`](#fallback)
+
+### Required
+
+The `required` option is used to specify if the field is required or not.
+If the field is required and not present in the input data, the `validate` method will return a 400 response with the error message.
+
+### Default
+
+The `default` option is used to specify a default value to use if the field is not present in the input data.
+
+### Fallback
+
+The `fallback` option is used to specify a fallback value to use if the field is not present in the input data, although it is required or the validation fails.

pyproject.toml

@@ -1,3 +1,6 @@
 [build-system]
 requires = ["setuptools", "wheel"]
 build-backend = "setuptools.build_meta"
+
+[tool.black]
+line-length = 90

requirements.txt

@@ -4,3 +4,4 @@ pillow==2.0.0
 pytest
 setuptools
 twine
+black

setup.py

@@ -5,8 +5,7 @@
     version="0.0.3",
     author="Leander Cain Slotosch",
     author_email="[email protected]",
-    description="A library to filter and validate input data in"
-                "Flask applications",
+    description="A library to filter and validate input data in" "Flask applications",
     long_description=open("README.md").read(),
     long_description_content_type="text/markdown",
     url="https://github.com/LeanderCS/flask-inputfilter",

src/flask_inputfilter/Enum/RegexEnum.py

@@ -6,17 +6,18 @@ class RegexEnum(Enum):
     Enum for regex patterns.
     """
 
-    EMAIL = r'^[a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\.[a-zA-Z0-9-.]+$'
+    EMAIL = r"^[a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\.[a-zA-Z0-9-.]+$"
 
-    IPV4_ADDRESS = r'^(?:\d{1,3}\.){3}\d{1,3}$'
-    IPV6_ADDRESS = r'^\[?([a-fA-F0-9:]+:+)+[a-fA-F0-9]+\]?$'
+    IPV4_ADDRESS = r"^(?:\d{1,3}\.){3}\d{1,3}$"
+    IPV6_ADDRESS = r"^\[?([a-fA-F0-9:]+:+)+[a-fA-F0-9]+\]?$"
 
-    ISO_DATE = r'^\d{4}-\d{2}-\d{2}$'
-    ISO_DATETIME = (r'^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}'
-                    r'(?:\.\d+)?(?:Z|[+-]\d{2}:\d{2})?$')
+    ISO_DATE = r"^\d{4}-\d{2}-\d{2}$"
+    ISO_DATETIME = (
+        r"^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}" r"(?:\.\d+)?(?:Z|[+-]\d{2}:\d{2})?$"
+    )
 
-    PHONE_NUMBER = r'^\+?[\d\s\-()]{7,}$'
+    PHONE_NUMBER = r"^\+?[\d\s\-()]{7,}$"
 
-    POSTAL_CODE = r'^\d{4,10}$'
+    POSTAL_CODE = r"^\d{4,10}$"
 
-    URL = r'^(https?|ftp):\/\/[^\s/$.?#].[^\s]*$'
+    URL = r"^(https?|ftp):\/\/[^\s/$.?#].[^\s]*$"

src/flask_inputfilter/Exception/ValidationError.py

@@ -1,4 +1,3 @@
-
 class ValidationError(Exception):
     """
     This class is used to raise an exception when a validation error occurs.

src/flask_inputfilter/Filter/ArrayExplodeFilter.py

@@ -0,0 +1,20 @@
+from typing import Any, List, Optional
+
+from ..Filter.BaseFilter import BaseFilter
+
+
+class ArrayExplodeFilter(BaseFilter):
+    """
+    Filter that splits a string into an array based on a specified delimiter.
+    """
+
+    def __init__(self, delimiter: str = ",") -> None:
+
+        self.delimiter = delimiter
+
+    def apply(self, value: Any) -> Optional[List[str]]:
+
+        if not isinstance(value, str):
+            return None
+
+        return value.split(self.delimiter)

src/flask_inputfilter/Filter/README.md

@@ -0,0 +1,21 @@
+# Filter
+
+The `Filter` module contains the filters that can be used to filter the input data.
+
+## Available filters
+
+The following filters are available in the `Filter` module:
+
+1. [`ArrayExplodeFilter`](src/flask_inputfilter/Filter/ArrayExplodeFilter.py) - Explodes the input string into an array.
+2. [`StringTrimFilter`](src/flask_inputfilter/Filter/StringTrimFilter.py) - Trims the whitespace from the beginning and end of the string.
+3. [`ToBooleanFilter`](src/flask_inputfilter/Filter/ToBooleanFilter.py) - Converts the string to a boolean value.
+4. [`ToCamelCaseFilter`](src/flask_inputfilter/Filter/ToCamelCaseFilter.py) - Converts the string to camel case.
+5. [`ToFloatFilter`](src/flask_inputfilter/Filter/ToFloatFilter.py) - Converts the string to a float value.
+5. [`ToIntegerFilter`](src/flask_inputfilter/Filter/ToIntegerFilter.py) - Converts the string to an integer value.
+6. [`ToLowerFilter`](src/flask_inputfilter/Filter/ToLowerFilter.py) - Converts the string to lowercase.
+7. [`ToNullFilter`](src/flask_inputfilter/Filter/ToNullFilter.py) - Converts the string to `None` if it is already `None` or `''` (empty string).
+8. [`ToPascaleCaseFilter`](src/flask_inputfilter/Filter/ToPascaleCaseFilter.py) - Converts the string to pascal case.
+9. [`ToSnakeCaseFilter`](src/flask_inputfilter/Filter/ToSnakeCaseFilter.py) - Converts the string to snake case.
+9. [`ToStringFilter`](src/flask_inputfilter/Filter/ToStringFilter.py) - Converts the input to a string value.
+9. [`ToUpperFilter`](src/flask_inputfilter/Filter/ToUpperFilter.py) - Converts the string to uppercase.
+10. [`WhitespaceCollapseFilter`](src/flask_inputfilter/Filter/WhitespaceCollapseFilter.py) - Collapses the whitespace in the string.