Merge pull request #7 from LeanderCS/6

6 | Add field dependency functionality

Author: LeanderCS

.flake8

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

CHAGELOG.md

@@ -0,0 +1,13 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+## [0.0.5] - 2025-01-12
+
+### Added
+
+- New condition functionality between fields. [Check it out](src/flask_inputfilter/Condition/README.md)
+
+### Changed
+
+- Switched external_api config from dict to class. [Check it out](src/flask_inputfilter/Model/ExternalApiConfig.py)

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2024 Leander Cain Slotosch
+Copyright (c) 2025 Leander Cain Slotosch
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,3 +1,5 @@
+from src.flask_inputfilter.Validator import IsStringValidator
+
 # flask-inputfilter
 
 The `InputFilter` class is used to validate and filter input data in Flask applications.
@@ -16,15 +18,18 @@ pip install flask-inputfilter
 ## 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.
+
+There are lots of different filters and validators available to use, but it is also possible to create your own.
 
 ### Definition
 
 ```python
+
 from flask_inputfilter import InputFilter
+from flask_inputfilter.Condition import ExactlyOneOfCondition
 from flask_inputfilter.Enum import RegexEnum
 from flask_inputfilter.Filter import StringTrimFilter, ToIntegerFilter, ToNullFilter
-from flask_inputfilter.Validator import IsIntegerValidator, RegexValidator 
+from flask_inputfilter.Validator import IsIntegerValidator, IsStringValidator, RegexValidator
 
 
 class UpdateZipcodeInputFilter(InputFilter):
@@ -35,15 +40,14 @@ class UpdateZipcodeInputFilter(InputFilter):
         self.add(
             'id',
             required=True,
-            filters=[ToIntegerFilter(), ToNullFilter()],
+            filters=[ToNullFilter()],
             validators=[
                 IsIntegerValidator()
             ]
         )
 
         self.add(
             'zipcode',
-            required=True,
             filters=[StringTrimFilter()],
             validators=[
                 RegexValidator(
@@ -52,6 +56,19 @@ class UpdateZipcodeInputFilter(InputFilter):
                 )
             ]
         )
+
+        self.add(
+            'city',
+            filters=[StringTrimFilter()],
+            validators=[
+                IsStringValidator()
+            ]
+        )
+
+        self.addCondition(
+            ExactlyOneOfCondition(['zipcode', 'city'])
+        )
+
 ```
 
 ### Usage
@@ -61,6 +78,7 @@ After calling the `validate` method, the validated data will be available in the
 If the data is not valid, the `validate` method will return a 400 response with the error message.
 
 ```python
+
 from flask import Flask, g
 from your-path import UpdateZipcodeInputFilter
 
@@ -74,6 +92,7 @@ def updateZipcode():
     # Do something with validatedData
     id = data.get('id')
     zipcode = data.get('zipcode')
+
 ```
 
 ---

docker-compose.yaml

@@ -1,5 +1,6 @@
 services:
-  app:
+
+  flask-inputfilter:
     build:
       context: .
       dockerfile: Dockerfile

setup.py

@@ -2,7 +2,7 @@
 
 setup(
     name="flask_inputfilter",
-    version="0.0.4",
+    version="0.0.5",
     author="Leander Cain Slotosch",
     author_email="[email protected]",
     description="A library to filter and validate input data in"

src/flask_inputfilter/Condition/ArrayLengthEqualCondition.py

@@ -0,0 +1,20 @@
+from typing import Any, Dict
+
+from .BaseCondition import BaseCondition
+
+
+class ArrayLengthEqualCondition(BaseCondition):
+    """
+    Condition that checks if the array is of the specified length.
+    """
+
+    def __init__(self, first_field: str, second_field: str) -> None:
+
+        self.first_field = first_field
+        self.second_field = second_field
+
+    def check(self, data: Dict[str, Any]) -> bool:
+
+        return len(data.get(self.first_field) or []) == len(
+            data.get(self.second_field) or []
+        )

src/flask_inputfilter/Condition/ArrayLongerThanCondition.py

@@ -0,0 +1,20 @@
+from typing import Any, Dict
+
+from .BaseCondition import BaseCondition
+
+
+class ArrayLongerThanCondition(BaseCondition):
+    """
+    Condition that checks if the array is longer than the specified length.
+    """
+
+    def __init__(self, longer_field: str, shorter_field: str) -> None:
+
+        self.longer_field = longer_field
+        self.shorter_field = shorter_field
+
+    def check(self, data: Dict[str, Any]) -> bool:
+
+        return len(data.get(self.longer_field) or []) > len(
+            data.get(self.shorter_field) or []
+        )

src/flask_inputfilter/Condition/BaseCondition.py

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

src/flask_inputfilter/Condition/CustomCondition.py

@@ -0,0 +1,17 @@
+from typing import Any, Callable, Dict
+
+from .BaseCondition import BaseCondition
+
+
+class CustomCondition(BaseCondition):
+    """
+    Allows users to define their own condition as a callable.
+    """
+
+    def __init__(self, condition: Callable[[Dict[str, Any]], bool]) -> None:
+
+        self.condition = condition
+
+    def check(self, data: Dict[str, Any]) -> bool:
+
+        return self.condition(data)