Samir Boulahtit
967f08e4ba
Add new validation rules MOD-020 to MOD-023 for module definition completeness and standardize permissions across all modules. Changes: - Add MOD-020: Module definitions must have required attributes - Add MOD-021: Modules with menus should have features - Add MOD-022: Feature modules should have permissions - Add MOD-023: Modules with routers should use get_*_with_routers pattern Module permissions added: - analytics: view, export, manage_dashboards - billing: view_tiers, manage_tiers, view_subscriptions, manage_subscriptions, view_invoices - cart: view, manage - checkout: view_settings, manage_settings - cms: view_pages, manage_pages, view_media, manage_media, manage_themes - loyalty: view_programs, manage_programs, view_rewards, manage_rewards - marketplace: view_integration, manage_integration, sync_products - messaging: view_messages, send_messages, manage_templates - payments: view_gateways, manage_gateways, view_transactions Module improvements: - Complete cart module with features and permissions - Complete checkout module with features and permissions - Add features to catalog module - Add version to cms module - Fix loyalty platform_router attachment - Add path definitions to payments module - Remove empty scheduled_tasks from dev_tools module Documentation: - Update module-system.md with new validation rules - Update architecture-rules.md with MOD-020 to MOD-023 Tests: - Add unit tests for module definition completeness - Add tests for permission structure validation Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
109 lines
3.6 KiB
Python
109 lines
3.6 KiB
Python
# app/modules/payments/definition.py
|
|
"""
|
|
Payments module definition.
|
|
|
|
Defines the payments module including its features, menu items,
|
|
and route configurations.
|
|
|
|
The payments module provides gateway abstractions that can be used by:
|
|
- billing module: For platform subscriptions and invoices
|
|
- orders module: For customer checkout payments
|
|
|
|
This separation allows:
|
|
1. Using payments standalone (e.g., one-time payments without subscriptions)
|
|
2. Billing without orders (platform subscription only)
|
|
3. Orders without billing (customer payments only)
|
|
"""
|
|
|
|
from app.modules.base import ModuleDefinition, PermissionDefinition
|
|
from app.modules.enums import FrontendType
|
|
|
|
|
|
def _get_admin_router():
|
|
"""Lazy import of admin router to avoid circular imports."""
|
|
from app.modules.payments.routes.api.admin import admin_router
|
|
|
|
return admin_router
|
|
|
|
|
|
def _get_vendor_router():
|
|
"""Lazy import of vendor router to avoid circular imports."""
|
|
from app.modules.payments.routes.api.vendor import vendor_router
|
|
|
|
return vendor_router
|
|
|
|
|
|
# Payments module definition
|
|
payments_module = ModuleDefinition(
|
|
code="payments",
|
|
name="Payment Gateways",
|
|
description=(
|
|
"Payment gateway integrations for Stripe, PayPal, and bank transfers. "
|
|
"Provides payment processing, refunds, and payment method management."
|
|
),
|
|
version="1.0.0",
|
|
features=[
|
|
"payment_processing", # Process payments
|
|
"payment_refunds", # Issue refunds
|
|
"payment_methods", # Store payment methods
|
|
"stripe_gateway", # Stripe integration
|
|
"paypal_gateway", # PayPal integration
|
|
"bank_transfer", # Bank transfer support
|
|
"transaction_history", # Transaction records
|
|
],
|
|
# Module-driven permissions
|
|
permissions=[
|
|
PermissionDefinition(
|
|
id="payments.view_gateways",
|
|
label_key="payments.permissions.view_gateways",
|
|
description_key="payments.permissions.view_gateways_desc",
|
|
category="payments",
|
|
),
|
|
PermissionDefinition(
|
|
id="payments.manage_gateways",
|
|
label_key="payments.permissions.manage_gateways",
|
|
description_key="payments.permissions.manage_gateways_desc",
|
|
category="payments",
|
|
),
|
|
PermissionDefinition(
|
|
id="payments.view_transactions",
|
|
label_key="payments.permissions.view_transactions",
|
|
description_key="payments.permissions.view_transactions_desc",
|
|
category="payments",
|
|
),
|
|
],
|
|
menu_items={
|
|
FrontendType.ADMIN: [
|
|
"payment-gateways", # Configure payment gateways
|
|
],
|
|
FrontendType.VENDOR: [
|
|
"payment-methods", # Manage stored payment methods
|
|
],
|
|
},
|
|
is_core=False,
|
|
is_internal=False,
|
|
# =========================================================================
|
|
# Self-Contained Module Configuration
|
|
# =========================================================================
|
|
is_self_contained=True,
|
|
services_path="app.modules.payments.services",
|
|
models_path="app.modules.payments.models",
|
|
schemas_path="app.modules.payments.schemas",
|
|
exceptions_path="app.modules.payments.exceptions",
|
|
)
|
|
|
|
|
|
def get_payments_module_with_routers() -> ModuleDefinition:
|
|
"""
|
|
Get payments module with routers attached.
|
|
|
|
This function attaches the routers lazily to avoid circular imports
|
|
during module initialization.
|
|
"""
|
|
payments_module.admin_router = _get_admin_router()
|
|
payments_module.vendor_router = _get_vendor_router()
|
|
return payments_module
|
|
|
|
|
|
__all__ = ["payments_module", "get_payments_module_with_routers"]
|