first commit

Author: gabriel-logan

.gitignore

@@ -0,0 +1,4 @@
+dist/
+comopublicar.txt
+multiform_validator.egg-info
+__pycache__

LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2023 The Python Packaging Authority
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,173 @@
+# Multiform-validator
+
+[![PyPI version](https://badge.fury.io/py/multiform-validator.svg)](https://badge.fury.io/py/multiform-validator)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![PyPI downloads](https://img.shields.io/pypi/dm/multiform-validator.svg?style=flat-square)](https://pypistats.org/packages/multiform-validator)
+
+This package provides Python functions to validate various forms fields.
+
+Documentation: https://multiform-validator.vercel.app/documentation/py
+
+Feel free to find bugs and report them to me. Your feedback is highly appreciated. Hugs from Gabriel Logan!
+
+If you want to help me, you can buy me a coffee (:
+
+<p align="center">
+	<a href="https://www.buymeacoffee.com/gabriellogan" target="_blank">
+		<img src="https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png" alt="Buy Me A Coffee" style="height: 50px !important;width: 180px !important;" >
+	</a>
+</p>
+
+### Installation
+
+```bash
+pip install multiform-validator
+```
+
+# Data Validator
+
+This package contains various modules for validating different types of data. Below are the available validation modules:
+
+# Avaliable for while
+
+- **cnpjValidator**: CNPJ validation.
+- **cpfValidator**: CPF validation.
+- **getOnlyEmail**: Extracts only the email or emails address from a string.
+- **identifyFlagCard**: Identifies the flag of a credit card.
+- **isCreditCardValid**: Credit card validation.
+- **isEmail**: Email address validation format.
+- **passwordStrengthTester**: Password strength test.
+- **validateBRPhoneNumber**: Brazilian phone number validation.
+- **isValidImage**: Image validation.
+
+## Usage
+
+Here is an example of how to use the functions in this package:
+
+```python
+from multiform_validator import (
+    cnpjIsValid,
+    cpfIsValid,
+    getOnlyEmail,
+    identifyFlagCard,
+    isCreditCardValid,
+    isEmail,
+    passwordStrengthTester,
+    validateBRPhoneNumber,
+    isValidImage
+)
+```
+
+### Usage Example
+
+```python
+
+print("Is email", isEmail("[email protected]")) # True
+print("Get only email", getOnlyEmail("awdawd wadawd wda awd [email protected] awdawdawd")) # [email protected]
+print("Password strength", passwordStrengthTester("aA1!asd@qd2asd")) # Strong
+print("Is CPF valid", cpfIsValid("123.456.789-02")['isValid']) # False
+print("Is CNPJ valid", cnpjIsValid("12.345.678/0001-09")) # { 'isValid': False, 'errorMsg': 'CNPJ is not valid' }
+print("Is credit card valid", isCreditCardValid("5117 2161 1334 8362")) # True
+print("Identify flag card", identifyFlagCard("5117 2161 1334 8362")) # Mastercard
+print("Validate BR phone number", validateBRPhoneNumber("(11) 91234-5678")) # { 'isValid': True, 'errorMsg': None }
+
+```
+
+### isValidImage Usage Example
+
+```python
+import os
+from pathlib import Path
+
+from multiform_validator import isValidImage
+
+# Resolve the file path
+file_path = Path.cwd() / 'static' / 'uploads'
+retrieved_file = file_path / filename
+
+# Read the first 4 bytes of the file
+with open(retrieved_file, 'rb') as f:
+    file_buffer = f.read(4)
+
+print(isValidImage(file_buffer)) # True or False
+```
+
+## Functions signature
+
+All params with default values are optional.
+
+```python
+
+def isEmail(email: str) -> bool:
+    pass
+
+def getOnlyEmail(text: str, multiple=False, clean_domain=False, repeat_email=False) -> str:
+    pass
+
+def passwordStrengthTester(password: str) -> str:
+    pass
+
+defaultErrorMsgCPF = [
+  'CPF invalid',
+  'CPF must have 11 numerical digits',
+  'CPF is not valid',
+  'Unknown error',
+]
+def cpfIsValid(cpf: str, errorMsg=defaultErrorMsgCPF) -> Dict[str, Union[bool, str, None]]:
+    pass
+
+default_error_msgCNPJ = [
+   'CNPJ invalid', 
+   'CNPJ must have 14 numerical digits', 
+   'CNPJ is not valid', 
+   'Unknown error'
+]
+def cnpjIsValid(cnpj: str, errorMsg=default_error_msgCNPJ) -> Dict[str, Union[bool, str, None]]:
+    pass
+
+def isCreditCardValid(cardNumber: str) -> bool:
+    pass
+
+def identifyFlagCard(cardNumber: str) -> str:
+    pass
+
+default_error_msg = ['Invalid value passed', 'Invalid phone number', 'Unknown error']
+def validateBRPhoneNumber(phoneNumber: str, errorMsg=default_error_msg) -> Dict[str, Union[bool, str, None]]:
+    pass
+
+def isValidImage(file_buffer: bytes) -> bool:
+    pass
+
+```
+
+## Looking for contributions. 
+
+## Available Validation Modules !!! STILL NOT AVALIABLE !!!
+
+- **isAscii**: Checks if the string contains only ASCII characters.
+- **isBase64**: Checks if the string is a valid Base64 encoding.
+- **isCEP**: CEP validation (Brazilian postal code).
+- **isDate**: Date format validation.
+- **isDecimal**: Checks if the number is a decimal.
+- **isEmpty**: Checks if the string is empty.
+- **isMACAddress**: MAC address validation.
+- **isMD5**: Checks if the string is a valid MD5 hash.
+- **validatePassportNumber**: Passport number validation.
+- **isPort**: Port number validation.
+- **isPostalCode**: Postal code validation.
+- **isTime**: Time format validation.
+- **validateEmail**: Email address full validation.
+- **validatePassword**: Password validation.
+- **validatePhoneNumber**: Phone number validation.
+- **validateUsername**: Username validation.
+- **validateUSPhoneNumber**: US phone number validation.
+- **isNumber**: Checks if the value is a number.
+- **validateName**: Name validation.
+- **validateSurname**: Surname validation.
+- **validateTextarea**: Textarea validation.
+
+### For better information, read the documentation
+
+Feel free to explore the various functions and experiment with different inputs to understand their behavior. If you encounter any issues or have suggestions, don't hesitate to reach out to me. Your feedback is valuable and helps improve the package. Happy coding!
+
+# By - Gabriel Logan

pyproject.toml

@@ -0,0 +1,25 @@
+[build-system]
+requires = [
+    "setuptools>=61"
+]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "multiform-validator"
+version = "1.0.1"
+authors = [
+  { name="Gabriel Logan" },
+]
+description = "Multilingual library made for validation, various form fields, such as: email, cpf, cnpj, credit card, and much more."
+readme = "README.md"
+keywords = ["validator", "multiform", "validação", "email-validator", "image", "multiform-validator", "python", "security", "safe", "pentest", "security-tools", "Validator", "validate", "cpf", "cnpj", "email validator", "password", "email", "isEmail"]
+requires-python = ">=3.1"
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+]
+
+[project.urls]
+"Homepage" = "https://multiform-validator.vercel.app/documentation"
+"Bug Tracker" = "https://github.com/gabriel-logan/multiform-validator/tree/main/packages/python"

requirements.txt

@@ -0,0 +1,9 @@
+from .cpfValidator import cpfValidator as cpfIsValid
+from .cnpjValidator import cnpjValidator as cnpjIsValid
+from .getOnlyEmail import getOnlyEmail
+from .isEmail import isEmail
+from .identifyFlagCard import identifyFlagCard
+from .isCreditCardValid import isCreditCardValid
+from .passwordStrengthTester import passwordStrengthTester
+from .validateBRPhoneNumber import validateBRPhoneNumber
+from .isValidImage import isValidImage

src/multiform_validator/__init__.py

@@ -0,0 +1,61 @@
+def calculate_first_verifier(cnpj_base):
+    weight = [5, 4, 3, 2, 9, 8, 7, 6, 5, 4, 3, 2]
+    total_sum = 0
+    for i in range(12):
+        total_sum += cnpj_base[i] * weight[i]
+    remainder = total_sum % 11
+    return 0 if remainder < 2 else 11 - remainder
+
+def calculate_second_verifier(cnpj_base, first_verifier):
+    weight = [6, 5, 4, 3, 2, 9, 8, 7, 6, 5, 4, 3, 2]
+    total_sum = 0
+    for i in range(12):
+        total_sum += cnpj_base[i] * weight[i]
+    total_sum += first_verifier * weight[12]
+    remainder = total_sum % 11
+    return 0 if remainder < 2 else 11 - remainder
+
+default_error_msg = ['CNPJ invalid', 'CNPJ must have 14 numerical digits', 'CNPJ is not valid', 'Unknown error']
+
+def cnpjValidator(cnpj, errorMsg = default_error_msg):
+    if not isinstance(cnpj, str):
+        raise TypeError('The input should be a string.')
+
+    if errorMsg:
+        if not isinstance(errorMsg, list):
+            raise ValueError('Must be a list')
+        for msg in errorMsg:
+            if msg is not None and not isinstance(msg, str):
+                raise TypeError('All values within the list must be strings or None/NoneType.')
+
+    def get_error_message(index):
+            error_message = errorMsg[index]
+            return error_message if error_message is not None else default_error_msg[index]
+
+    try:
+        if not cnpj:
+            return {
+                'isValid': False,
+                'errorMsg': get_error_message(0),  # 'CNPJ invalid'
+            }
+
+        cnpj_clean = ''.join(filter(str.isdigit, cnpj))
+        cnpj_array = list(map(int, cnpj_clean))
+        first_verifier = calculate_first_verifier(cnpj_array[:12])
+        second_verifier = calculate_second_verifier(cnpj_array[:12] + [first_verifier], first_verifier)
+
+        if cnpj_array[12] == first_verifier and cnpj_array[13] == second_verifier:
+            return {
+                'isValid': True,
+                'errorMsg': None,
+            }
+
+        return {
+            'isValid': False,
+            'errorMsg': get_error_message(2),  # 'CNPJ is not valid'
+        }
+    except Exception as error:
+        return {
+            'isValid': False,
+            'errorMsg': get_error_message(3),  # 'Unknown error'
+        }

src/multiform_validator/cnpjValidator.py

@@ -0,0 +1,92 @@
+defaultErrorMsg = [
+  'CPF invalid',
+  'CPF must have 11 numerical digits',
+  'CPF is not valid',
+  'Unknown error',
+]
+
+def cpfValidator(cpf, errorMsg = defaultErrorMsg):
+	"""
+	Validates a CPF (Brazilian individual taxpayer registry identification) number.
+
+	:param cpf: The CPF number to be validated.
+	:param error_msg: An optional list of error messages.
+	:return: A dictionary with 'is_valid' (boolean) and 'error_msg' (string) properties.
+	"""
+	if (type(cpf) != str): raise TypeError('The input should be a string.')
+
+	if (errorMsg):
+			if (not isinstance(errorMsg, list)):
+					raise TypeError('Must be a list')
+			for index in range(len(errorMsg)):
+					if errorMsg[index] is not None and not isinstance(errorMsg[index], str):
+							raise TypeError('All values within the list must be strings or None.')
+
+	def getErrorMessage(index):
+			if (errorMsg and index >= 0 and index < len(errorMsg)):
+					errorMessage = errorMsg[index]
+					return errorMessage if errorMessage is not None else defaultErrorMsg[index]
+			return defaultErrorMsg[index]
+
+	try:
+
+		if(not cpf):
+			return {
+				"isValid": False,
+				"errorMsg": getErrorMessage(0)
+			}
+
+		numeroBase = 10
+		numeroBase2 = 11
+		somaTotal = somaTotal2 = 0
+
+		if(len(cpf) != 11 and len(cpf) != 14):
+			return {
+				"isValid": False,
+				"errorMsg": getErrorMessage(1),
+			}
+
+		cpfLimpo = ''.join(filter(str.isdigit, cpf))
+
+		if (len(cpfLimpo) == 11 and cpfLimpo == cpfLimpo[0] * 11):
+			return {
+					"isValid": False,
+					"errorMsg": getErrorMessage(2),
+			}
+
+		primeiroVerificador = segundoVerificador = repetidor = 0
+
+		while (repetidor < 11):
+			multiplicador = int(cpfLimpo[repetidor]) * numeroBase
+			numeroBase -= 1
+			somaTotal += multiplicador
+
+			multiplicador2 = int(cpfLimpo[repetidor]) * numeroBase2
+			numeroBase2 -= 1
+			somaTotal2 += multiplicador2
+
+			valorDeVerificacao = somaTotal - int(cpfLimpo[9])
+			valorDeVerificacao2 = somaTotal2 - int(cpfLimpo[10])
+
+			primeiroVerificador = 11 - (valorDeVerificacao % 11)
+			segundoVerificador = 11 - (valorDeVerificacao2 % 11)
+
+			repetidor += 1
+
+		if(primeiroVerificador > 9): primeiroVerificador = 0
+		if(segundoVerificador > 9): segundoVerificador = 0
+
+		if(primeiroVerificador == int(cpfLimpo[9]) and segundoVerificador == int(cpfLimpo[10])):
+			return {
+        "isValid": True,
+        "errorMsg": None,
+      }
+		return {
+			"isValid": False,
+			"errorMsg": getErrorMessage(2)
+		}
+	except:
+		return {
+      "isValid": False,
+      "errorMsg": getErrorMessage(3),
+    }