201 lines
9.1 KiB
Python
201 lines
9.1 KiB
Python
from datetime import timedelta
|
||
|
||
from django.utils.translation import gettext_lazy as _
|
||
|
||
from evibes.settings.base import * # noqa: F403
|
||
from evibes.settings.constance import CONSTANCE_CONFIG
|
||
|
||
REST_FRAMEWORK: dict[str, int | str | dict[str, str | bool]] = {
|
||
"DEFAULT_PAGINATION_CLASS": "evibes.pagination.CustomPagination",
|
||
"PAGE_SIZE": 30,
|
||
"DEFAULT_AUTHENTICATION_CLASSES": [
|
||
"rest_framework_simplejwt.authentication.JWTAuthentication",
|
||
],
|
||
"DEFAULT_RENDERER_CLASSES": (
|
||
"djangorestframework_camel_case.render.CamelCaseJSONRenderer",
|
||
"rest_framework.renderers.MultiPartRenderer",
|
||
"rest_framework_xml.renderers.XMLRenderer",
|
||
"rest_framework_yaml.renderers.YAMLRenderer",
|
||
),
|
||
"DEFAULT_PARSER_CLASSES": (
|
||
"djangorestframework_camel_case.parser.CamelCaseJSONParser",
|
||
"djangorestframework_camel_case.parser.CamelCaseMultiPartParser",
|
||
"rest_framework_xml.parsers.XMLParser",
|
||
"rest_framework_yaml.parsers.YAMLParser",
|
||
),
|
||
"DEFAULT_SCHEMA_CLASS": "drf_spectacular.generators.AutoSchema",
|
||
"DEFAULT_PERMISSION_CLASSES": ("rest_framework.permissions.AllowAny",),
|
||
"JSON_UNDERSCOREIZE": {
|
||
"no_underscore_before_number": False,
|
||
},
|
||
}
|
||
|
||
SIMPLE_JWT: dict[str, timedelta | str | bool] = {
|
||
"ACCESS_TOKEN_LIFETIME": timedelta(hours=8)
|
||
if not DEBUG # noqa: F405
|
||
else timedelta(hours=88),
|
||
"REFRESH_TOKEN_LIFETIME": timedelta(days=8),
|
||
"ROTATE_REFRESH_TOKENS": True,
|
||
"BLACKLIST_AFTER_ROTATION": True,
|
||
"UPDATE_LAST_LOGIN": True,
|
||
"SIGNING_KEY": getenv("JWT_SIGNING_KEY", SECRET_KEY), # noqa: F405
|
||
"USER_ID_FIELD": "uuid",
|
||
"USER_ID_CLAIM": "user_uuid",
|
||
"AUTH_HEADER_NAME": "HTTP_X_EVIBES_AUTH",
|
||
}
|
||
|
||
# type: ignore
|
||
SPECTACULAR_B2B_DESCRIPTION = _(f"""
|
||
Welcome to the {CONSTANCE_CONFIG.get("PROJECT_NAME")[0]} B2B API documentation.
|
||
|
||
The {CONSTANCE_CONFIG.get("PROJECT_NAME")[0]} B2B API is designed to provide seamless integration for merchants selling a wide range of electronics. Through this API, partnered merchants can manage products, orders, and inventory with ease, while accessing real-time stock levels.
|
||
|
||
## Key Features
|
||
- **Product Management:** Easily create, update, and manage your product listings with detailed specifications.
|
||
- **Order Processing:** Handle bulk orders efficiently with streamlined operations for merchants.
|
||
- **Inventory Management:** Keep track of stock levels in real-time, ensuring smooth fulfillment.
|
||
- **Secure Transactions:** Secure and encrypted transactions to protect sensitive business information.
|
||
- **Multi-Currency Support:** Expand your market reach with multi-currency transactions.
|
||
- **Real-Time Notifications:** Stay updated with instant alerts on stock changes and order statuses.
|
||
|
||
## Authentication
|
||
- Authentication is handled via your merchant token. Include the token in the `X-EVIBES-B2B-AUTH` header of your requests in the format `Bearer <your_token>`.
|
||
|
||
## I18N
|
||
- Apply an `Accept-Language` header to use non-default language. A list of all languages is available at `/app/languages/`.
|
||
|
||
## Version
|
||
Current API version: {EVIBES_VERSION}
|
||
""") # noqa: E501, F405
|
||
|
||
# type: ignore
|
||
SPECTACULAR_PLATFORM_DESCRIPTION = _(f"""
|
||
Welcome to the {CONSTANCE_CONFIG.get("PROJECT_NAME")[0]} Platform API documentation.
|
||
|
||
The {CONSTANCE_CONFIG.get("PROJECT_NAME")[0]} API is the central hub for managing product listings, monitoring orders, and accessing analytics for your electronics store. It provides RESTful endpoints for managing your store’s backend operations and includes both REST and GraphQL options.
|
||
|
||
## Key Features
|
||
- **Product Catalog:** Manage product details, pricing, and availability.
|
||
- **Order Management:** Access detailed order information and process customer requests efficiently.
|
||
- **User Roles & Permissions:** Set user roles and permissions for internal management.
|
||
- **Custom Integrations:** Connect your system with external platforms through powerful APIs.
|
||
- **Detailed Reporting:** Generate comprehensive reports on orders, sales performance, and product data.
|
||
- **Real-Time Data:** Get live updates on inventory, pricing, and order statuses.
|
||
|
||
## Authentication
|
||
- Authentication is handled via JWT tokens. Include the token in the `X-EVIBES-AUTH` header of your requests in the format `Bearer <your_token>`.
|
||
- Access token lifetime is {SIMPLE_JWT.get("ACCESS_TOKEN_LIFETIME").total_seconds() // 60 if not DEBUG else 3600} {"minutes" if not DEBUG else "hours"}.
|
||
- Refresh token lifetime is {SIMPLE_JWT.get("ACCESS_TOKEN_LIFETIME").total_seconds() // 3600} hours.
|
||
- Refresh tokens are automatically invalidated after usage.
|
||
|
||
## I18N
|
||
- Apply an `Accept-Language` header to use non-default language. A list of all languages is available at `/app/languages/`.
|
||
|
||
## Version
|
||
Current API version: {EVIBES_VERSION}
|
||
""") # noqa: E501, F405
|
||
|
||
SPECTACULAR_PLATFORM_SETTINGS = {
|
||
"TITLE": f"{CONSTANCE_CONFIG.get('PROJECT_NAME')[0]} API",
|
||
"DESCRIPTION": SPECTACULAR_PLATFORM_DESCRIPTION,
|
||
"VERSION": EVIBES_VERSION, # noqa: F405
|
||
"TOS": "https://wiseless.xyz/evibes/terms-of-service",
|
||
"SWAGGER_UI_DIST": "SIDECAR",
|
||
"CAMELIZE_NAMES": True,
|
||
"POSTPROCESSING_HOOKS": [
|
||
"drf_spectacular.contrib.djangorestframework_camel_case.camelize_serializer_fields",
|
||
"drf_spectacular.hooks.postprocess_schema_enums",
|
||
],
|
||
"REDOC_DIST": "SIDECAR",
|
||
"ENABLE_DJANGO_DEPLOY_CHECK": not DEBUG, # noqa: F405
|
||
"SWAGGER_UI_FAVICON_HREF": r"/static/favicon.png",
|
||
"SWAGGER_UI_SETTINGS": {
|
||
"requestInterceptor": """
|
||
function(request) {
|
||
const fmt = new URL(request.url).searchParams.get('format');
|
||
if (fmt) {
|
||
switch (fmt) {
|
||
case 'xml':
|
||
request.headers['Accept'] = 'application/xml';
|
||
break;
|
||
case 'yaml':
|
||
request.headers['Accept'] = 'application/x-yaml';
|
||
break;
|
||
case 'yml':
|
||
request.headers['Accept'] = 'application/x-yaml';
|
||
break;
|
||
default:
|
||
request.headers['Accept'] = 'application/json';
|
||
}
|
||
}
|
||
return request;
|
||
}
|
||
""",
|
||
},
|
||
"SERVERS": [
|
||
{
|
||
"url": f"https://api.{CONSTANCE_CONFIG.get('BASE_DOMAIN')[0]}/",
|
||
"description": "Production Server",
|
||
},
|
||
{"url": "http://api.localhost:8000/", "description": "Development Server"},
|
||
],
|
||
"CONTACT": {
|
||
"name": 'Egor "fureunoir" Gorbunov',
|
||
"email": "contact@fureunoir.com",
|
||
"URL": "https://t.me/fureunoir",
|
||
},
|
||
}
|
||
|
||
SPECTACULAR_B2B_SETTINGS = {
|
||
"TITLE": f"{CONSTANCE_CONFIG.get('PROJECT_NAME')[0]} API",
|
||
"DESCRIPTION": SPECTACULAR_B2B_DESCRIPTION,
|
||
"VERSION": EVIBES_VERSION, # noqa: F405
|
||
"TOS": "https://wiseless.xyz/evibes/terms-of-service",
|
||
"SWAGGER_UI_DIST": "SIDECAR",
|
||
"CAMELIZE_NAMES": True,
|
||
"POSTPROCESSING_HOOKS": [
|
||
"drf_spectacular.contrib.djangorestframework_camel_case.camelize_serializer_fields",
|
||
"drf_spectacular.hooks.postprocess_schema_enums",
|
||
],
|
||
"REDOC_DIST": "SIDECAR",
|
||
"ENABLE_DJANGO_DEPLOY_CHECK": not DEBUG, # noqa: F405
|
||
"SWAGGER_UI_FAVICON_HREF": r"/static/favicon.png",
|
||
"SWAGGER_UI_SETTINGS": {
|
||
"requestInterceptor": """
|
||
function(request) {
|
||
const fmt = new URL(request.url).searchParams.get('format');
|
||
if (fmt) {
|
||
switch (fmt) {
|
||
case 'xml':
|
||
request.headers['Accept'] = 'application/xml';
|
||
break;
|
||
case 'yaml':
|
||
request.headers['Accept'] = 'application/x-yaml';
|
||
break;
|
||
case 'yml':
|
||
request.headers['Accept'] = 'application/x-yaml';
|
||
break;
|
||
default:
|
||
request.headers['Accept'] = 'application/json';
|
||
}
|
||
}
|
||
return request;
|
||
}
|
||
""",
|
||
},
|
||
"SERVERS": [
|
||
{
|
||
"url": f"https://b2b.{CONSTANCE_CONFIG.get('BASE_DOMAIN')[0]}/",
|
||
"description": "Production Server",
|
||
},
|
||
{
|
||
"url": f"https://beta.b2b.{CONSTANCE_CONFIG.get('BASE_DOMAIN')[0]}/",
|
||
"description": "Beta Solutions Server",
|
||
},
|
||
],
|
||
"CONTACT": {
|
||
"name": f"{CONSTANCE_CONFIG.get('COMPANY_NAME')[0]}",
|
||
"email": f"{CONSTANCE_CONFIG.get('EMAIL_HOST_USER')[0]}",
|
||
"URL": f"https://www.{CONSTANCE_CONFIG.get('BASE_DOMAIN')[0]}/help",
|
||
},
|
||
}
|