Merge pull request #9 from LeanderCS/8

8 | Extend docs

Author: LeanderCS

.DS_Store

@@ -1,2 +1,5 @@
 [run]
-omit = __init__.py, setup.py, test_*.py
+source = flask_inputfilter
+
+[report]
+omit = __init__.py, setup.py, */test/*

.coveragerc

@@ -1,6 +1,5 @@
 **.md
 .gitignore
-.git
 .github
 .idea
 .vscode

.dockerignore

@@ -1,6 +1,6 @@
 name: Run Tests
 
-on: [ push ]
+on: [push]
 
 permissions:
   actions: read
@@ -23,7 +23,12 @@ jobs:
           set -e # Exit immediately if a command exits with a non-zero status.
           set -u # Exit immediately if a variable is not defined.
 
-          docker run flask-inputfilter pytest
+          docker run flask-inputfilter coverage run --source=flask_inputfilter -m pytest test/
+
+      - name: Upload coverage to Coveralls
+        env:
+          COVERALLS_REPO_TOKEN: ${{ secrets.COVERALLS_REPO_TOKEN }}
+        run: docker run -e COVERALLS_REPO_TOKEN=${{ secrets.COVERALLS_REPO_TOKEN }} flask-inputfilter coveralls
 
       - name: Run code style checks
         run: |

.github/workflows/test.yaml

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

CHAGELOG.md

@@ -0,0 +1 @@
+# Create own 

CREATE_OWN.md

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

Dockerfile

@@ -0,0 +1,145 @@
+flask-inputfilter
+==================================
+
+The `InputFilter` class is used to validate and filter input data in Flask applications.
+It provides a modular way to clean and ensure that incoming data meets expected format
+and type requirements before being processed.
+
+:Test Status:
+
+    .. image:: https://img.shields.io/github/actions/workflow/status/LeanderCS/flask-inputfilter/test.yaml?branch=main&style=flat-square&label=Github%20Actions
+        :target: https://github.com/LeanderCS/flask-inputfilter/actions
+    .. image:: https://img.shields.io/coveralls/LeanderCS/flask-inputfilter/main.svg?style=flat-square&label=Coverage
+        :target: https://coveralls.io/r/LeanderCS/flask-inputfilter
+
+:Version Info:
+
+    .. image:: https://img.shields.io/pypi/v/flask-inputfilter?style=flat-square&label=PyPI
+        :target: https://pypi.org/project/flask-inputfilter/
+
+:Compatibility:
+
+    .. image:: https://img.shields.io/pypi/pyversions/flask-inputfilter?style=flat-square&label=PyPI
+        :target: https://pypi.org/project/flask-inputfilter/
+
+:Downloads:
+
+    .. image:: https://img.shields.io/pypi/dm/flask-inputfilter?style=flat-square&label=PyPI
+        :target: https://pypi.org/project/flask-inputfilter/
+
+Installation
+============
+
+.. code-block:: bash
+
+    pip install flask-inputfilter
+
+Quickstart
+==========
+
+To use the `InputFilter` class, create a new class that inherits from it and define the
+fields you want to validate and filter.
+
+There are numerous filters and validators available, but you can also create your own.
+Refer to the [CREATE_OWN.md](CREATE_OWN.md) file for guidance.
+
+Definition
+----------
+
+.. code-block:: 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, IsStringValidator, RegexValidator
+
+    class UpdateZipcodeInputFilter(InputFilter):
+        def __init__(self):
+            super().__init__()
+
+            self.add(
+                'id',
+                required=True,
+                filters=[ToIntegerFilter(), ToNullFilter()],
+                validators=[
+                    IsIntegerValidator()
+                ]
+            )
+
+            self.add(
+                'zipcode',
+                filters=[StringTrimFilter()],
+                validators=[
+                    RegexValidator(
+                        RegexEnum.POSTAL_CODE.value,
+                        'The zipcode is not in the correct format.'
+                    )
+                ]
+            )
+
+            self.add(
+                'city',
+                filters=[StringTrimFilter()],
+                validators=[
+                    IsStringValidator()
+                ]
+            )
+
+            self.addCondition(
+                ExactlyOneOfCondition(['zipcode', 'city'])
+            )
+
+Usage
+-----
+
+To use the `InputFilter` class, call the `validate` method on the class instance.
+After calling `validate`, the validated data will be available in `g.validatedData`.
+If the data is invalid, a 400 response with an error message will be returned.
+
+.. code-block:: python
+
+    from flask import Flask, g
+    from your-path import UpdateZipcodeInputFilter
+
+    app = Flask(__name__)
+
+    @app.route('/update-zipcode', methods=['POST'])
+    @UpdateZipcodeInputFilter.validate()
+    def updateZipcode():
+        data = g.validatedData
+
+        # Do something with validated data
+        id = data.get('id')
+        zipcode = data.get('zipcode')
+
+Options
+=======
+
+The `add` method supports several options:
+
+- `Required`_
+- `Filter` (see `Filter` documentation in :file:`flask_inputfilter/Filter/README.md`)
+- `Validator` (see `Validator` documentation in :file:`flask_inputfilter/Validator/README.md`)
+- `Default`_
+- `Fallback`_
+- `ExternalApi` (see :file:`EXTERNAL_API.md`)
+
+Required
+--------
+
+The `required` option specifies whether the field must be included in the input data.
+If the field is missing, a `ValidationError` will be raised with an appropriate error message.
+
+Default
+-------
+
+The `default` option allows you to specify a default value to use if the field is not
+present in the input data.
+
+Fallback
+--------
+
+The `fallback` option specifies a value to use if validation fails or required data
+is missing. Note that if the field is optional and absent, `fallback` will not apply;
+use `default` in such cases.

README.md

@@ -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_array_field: str, second_array_field: str
+    ) -> None:
+        self.first_array_field = first_array_field
+        self.second_array_field = second_array_field
+
+    def check(self, data: Dict[str, Any]) -> bool:
+        return len(data.get(self.first_array_field) or []) == len(
+            data.get(self.second_array_field) or []
+        )