mirror of
https://github.com/HamzaSha1/zod-backend.git
synced 2026-10-23 11:47:57 +00:00
Compare commits
18
Commits
dev
..
server_demo
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
ad582d77d7 | ||
|
|
8ff142ce2f | ||
|
|
2086dcb472 | ||
|
|
d4eaaada74 | ||
|
|
396b4a32c3 | ||
|
|
232f082c77 | ||
|
|
aaa1730636 | ||
|
|
44b25dde3e | ||
|
|
b52819c033 | ||
|
|
9bd31f9e86 | ||
|
|
6374ea0a90 | ||
|
|
9db620d818 | ||
|
|
89982f851f | ||
|
|
c115873972 | ||
|
|
8bc3a307c0 | ||
|
|
501deaac0b | ||
|
|
5d386322e4 | ||
|
|
ecb058209d |
@@ -1,40 +0,0 @@
|
||||
NODE_ENV=dev
|
||||
PORT=5000
|
||||
DB_HOST=
|
||||
DB_PASS=
|
||||
DB_USER=postgres
|
||||
DB_PORT=5432
|
||||
DB_NAME=
|
||||
MIGRATIONS_RUN=true
|
||||
SWAGGER_API_DOCS_PATH="/api-docs"
|
||||
|
||||
JWT_ACCESS_TOKEN_SECRET=your_access_token_secret
|
||||
JWT_ACCESS_TOKEN_EXPIRY=1d
|
||||
JWT_REFRESH_TOKEN_SECRET=your_refresh_token_secret
|
||||
JWT_REFRESH_TOKEN_EXPIRY=1d
|
||||
USE_MOCK=true
|
||||
|
||||
|
||||
OCI_TENANCY_ID=
|
||||
OCI_USER_ID=
|
||||
OCI_FINGERPRINT=
|
||||
OCI_PRIVATE_KEY=
|
||||
OCI_PASSPHRASE=""
|
||||
OCI_NAMESPACE=
|
||||
OCI_REGION=
|
||||
|
||||
|
||||
MAIL_HOST=smtp.gmail.com
|
||||
MAIL_USER=[email protected]
|
||||
MAIL_PASSWORD=
|
||||
MAIL_PORT=587
|
||||
MAIL_FROM=UBA
|
||||
|
||||
|
||||
BRANCH_IO_URL=https://api2.branch.io/v1/url
|
||||
BRANCH_IO_KEY=
|
||||
ZOD_BASE_URL=http://localhost:5001
|
||||
ANDROID_PACKAGE_NAME=com.zod
|
||||
IOS_PACKAGE_NAME=com.zod
|
||||
ANDRIOD_JUNIOR_DEEPLINK_PATH=zodbank://juniors/qr-code/validate
|
||||
IOS_JUNIOR_DEEPLINK_PATH=zodbank://juniors/qr-code/validate
|
||||
@@ -1,47 +0,0 @@
|
||||
/** @type {import('eslint').Linter.Config} */
|
||||
module.exports = {
|
||||
parser: '@typescript-eslint/parser',
|
||||
parserOptions: {
|
||||
project: 'tsconfig.json',
|
||||
tsconfigRootDir: __dirname,
|
||||
sourceType: 'module',
|
||||
},
|
||||
plugins: ['@typescript-eslint/eslint-plugin'],
|
||||
extends: ['plugin:@typescript-eslint/recommended', 'plugin:prettier/recommended', 'plugin:security/recommended'],
|
||||
root: true,
|
||||
env: {
|
||||
node: true,
|
||||
jest: true,
|
||||
},
|
||||
ignorePatterns: ['.eslintrc.js', 'node_modules', 'dist', 'coverage', 'jest*\\.ts', 'typeorm*\\.ts'],
|
||||
rules: {
|
||||
'@typescript-eslint/interface-name-prefix': 'off',
|
||||
'@typescript-eslint/explicit-function-return-type': 'off',
|
||||
'@typescript-eslint/explicit-module-boundary-types': 'off',
|
||||
'@typescript-eslint/no-explicit-any': 'off',
|
||||
'@typescript-eslint/no-unused-vars': [
|
||||
'warn',
|
||||
{ argsIgnorePattern: '^_', varsIgnorePattern: '^_', caughtErrorsIgnorePattern: '^_' },
|
||||
],
|
||||
'@typescript-eslint/no-inferrable-types': 'off',
|
||||
'func-names': ['error', 'as-needed'],
|
||||
'no-underscore-dangle': ['error'],
|
||||
'require-await': ['error'],
|
||||
'no-console': ['error'],
|
||||
'no-multi-assign': ['error'],
|
||||
'no-magic-numbers': ['error', { ignoreArrayIndexes: true}],
|
||||
'no-multiple-empty-lines': ['error', { max: 1, maxEOF: 1, maxBOF: 0 }],
|
||||
'max-len': [
|
||||
'error',
|
||||
{ code: 120, tabWidth: 2, ignoreUrls: true, ignoreStrings: true, ignoreTemplateLiterals: true },
|
||||
],
|
||||
},
|
||||
overrides: [
|
||||
{
|
||||
files: ['*spec.ts'],
|
||||
rules: {
|
||||
'no-magic-numbers': ['off'],
|
||||
},
|
||||
},
|
||||
],
|
||||
};
|
||||
@@ -1,85 +0,0 @@
|
||||
name: CI Zod
|
||||
|
||||
on:
|
||||
pull_request:
|
||||
branches:
|
||||
- '*'
|
||||
push:
|
||||
branches:
|
||||
- dev
|
||||
- main
|
||||
|
||||
env:
|
||||
NODE_ENV: development
|
||||
TAG: dev
|
||||
|
||||
jobs:
|
||||
install_dependencies:
|
||||
name: Install Dependencies
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Checkout Code
|
||||
uses: actions/checkout@v3
|
||||
|
||||
- name: Set up Node.js
|
||||
uses: actions/setup-node@v3
|
||||
with:
|
||||
node-version: 22.4.1
|
||||
|
||||
- name: Install Dependencies
|
||||
run: npm install
|
||||
|
||||
- name: Cache Node Modules
|
||||
uses: actions/cache@v3
|
||||
with:
|
||||
path: node_modules
|
||||
key: ${{ runner.os }}-node_modules-${{ hashFiles('**/package-lock.json') }}
|
||||
restore-keys: |
|
||||
${{ runner.os }}-node_modules-
|
||||
|
||||
run_tests:
|
||||
name: Run Tests
|
||||
runs-on: ubuntu-latest
|
||||
needs: install_dependencies
|
||||
steps:
|
||||
- name: Checkout Code
|
||||
uses: actions/checkout@v3
|
||||
|
||||
- name: Set up Node.js
|
||||
uses: actions/setup-node@v3
|
||||
with:
|
||||
node-version: 22.4.1
|
||||
|
||||
- name: Install Dependencies
|
||||
run: npm install
|
||||
|
||||
- name: Run Lint
|
||||
run: npm run lint
|
||||
|
||||
- name: Run Tests with Coverage
|
||||
run: npm run test:cov
|
||||
|
||||
build_app:
|
||||
name: Build Application
|
||||
runs-on: ubuntu-latest
|
||||
needs: run_tests
|
||||
steps:
|
||||
- name: Checkout Code
|
||||
uses: actions/checkout@v3
|
||||
|
||||
- name: Set up Node.js
|
||||
uses: actions/setup-node@v3
|
||||
with:
|
||||
node-version: 22.4.1
|
||||
|
||||
- name: Install Dependencies
|
||||
run: npm install
|
||||
|
||||
- name: Build Application
|
||||
run: npm run build
|
||||
|
||||
- name: Upload Build Artifacts
|
||||
uses: actions/upload-artifact@v3
|
||||
with:
|
||||
name: dist
|
||||
path: dist/
|
||||
+21
-54
@@ -1,57 +1,24 @@
|
||||
# compiled output
|
||||
/dist
|
||||
/node_modules
|
||||
/build
|
||||
|
||||
# Logs
|
||||
logs
|
||||
/static
|
||||
/media
|
||||
.idea/
|
||||
*.pyc
|
||||
media/
|
||||
*.name
|
||||
*.iml
|
||||
*.log
|
||||
npm-debug.log*
|
||||
pnpm-debug.log*
|
||||
yarn-debug.log*
|
||||
yarn-error.log*
|
||||
lerna-debug.log*
|
||||
|
||||
# OS
|
||||
*.xml
|
||||
*.pyo
|
||||
.DS_Store
|
||||
.idea
|
||||
venv/*
|
||||
static/*
|
||||
*.pem
|
||||
*.sqlite3
|
||||
/migrations/__pycache__/
|
||||
/__pycache__/
|
||||
/*.pyc
|
||||
*/__pycache__/*.pyc
|
||||
__pycache__/
|
||||
*.env
|
||||
ve/*
|
||||
|
||||
# Tests
|
||||
/coverage
|
||||
/.nyc_output
|
||||
|
||||
# IDEs and editors
|
||||
/.idea
|
||||
.project
|
||||
.classpath
|
||||
.c9/
|
||||
*.launch
|
||||
.settings/
|
||||
*.sublime-workspace
|
||||
|
||||
# IDE - VSCode
|
||||
.vscode/*
|
||||
!.vscode/settings.json
|
||||
|
||||
|
||||
# dotenv environment variable files
|
||||
.env
|
||||
.env.development.local
|
||||
.env.test.local
|
||||
.env.production.local
|
||||
.env.local
|
||||
|
||||
# temp directory
|
||||
.temp
|
||||
.tmp
|
||||
|
||||
# Runtime data
|
||||
pids
|
||||
*.pid
|
||||
*.seed
|
||||
*.pid.lock
|
||||
|
||||
# Diagnostic reports (https://nodejs.org/api/report.html)
|
||||
report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
|
||||
|
||||
|
||||
zod-certs
|
||||
|
||||
@@ -1,6 +0,0 @@
|
||||
{
|
||||
"singleQuote": true,
|
||||
"trailingComma": "all",
|
||||
"tabWidth": 2,
|
||||
"printWidth": 120
|
||||
}
|
||||
Vendored
-6
@@ -1,6 +0,0 @@
|
||||
{
|
||||
"editor.formatOnSave": true,
|
||||
"editor.codeActionsOnSave": {
|
||||
"source.organizeImports": "explicit"
|
||||
}
|
||||
}
|
||||
@@ -1,291 +0,0 @@
|
||||
# Allowance Scheduling System (Backend)
|
||||
|
||||
This document captures the complete allowance scheduling feature as implemented in the backend.
|
||||
It is intended as a long-term reference for how the system works, why it was built this way,
|
||||
and how to operate/extend it safely.
|
||||
|
||||
## Goals and Scope
|
||||
|
||||
- Allow parents/guardians to create a recurring allowance schedule for a child.
|
||||
- Credit the allowance automatically based on the schedule.
|
||||
- Scale safely with multiple workers and avoid duplicate credits.
|
||||
- Keep cron lightweight and offload work to RabbitMQ workers.
|
||||
|
||||
Non-goals in the current implementation:
|
||||
- UI changes
|
||||
- Analytics/reporting views
|
||||
- Advanced scheduling (e.g., custom weekdays)
|
||||
|
||||
## High-Level Flow
|
||||
|
||||
1. Parent creates a schedule via API.
|
||||
2. Cron runs every 5 minutes and enqueues due schedules into RabbitMQ.
|
||||
3. Workers consume queue messages, credit the allowance, and update the next run.
|
||||
4. Idempotency is enforced in the database to prevent duplicate credits.
|
||||
|
||||
## Data Model
|
||||
|
||||
### Table: `allowance_schedules`
|
||||
|
||||
Purpose: Stores the schedule definition (amount, frequency, status, next run).
|
||||
|
||||
Key fields:
|
||||
- `guardian_id`, `junior_id`: who funds and who receives.
|
||||
- `amount`: the allowance amount.
|
||||
- `frequency`: DAILY / WEEKLY / MONTHLY.
|
||||
- `status`: ON / OFF.
|
||||
- `next_run_at`, `last_run_at`: scheduling metadata.
|
||||
|
||||
Constraints:
|
||||
- Unique `(guardian_id, junior_id)` ensures one schedule per child.
|
||||
|
||||
Entity: `src/allowance/entities/allowance-schedule.entity.ts`
|
||||
|
||||
### Table: `allowance_credits`
|
||||
|
||||
Purpose: Audit log and idempotency guard for each credit run.
|
||||
|
||||
Key fields:
|
||||
- `schedule_id`: which schedule executed.
|
||||
- `transaction_id`: the resulting transaction (nullable).
|
||||
- `amount`, `run_at`, `credited_at`.
|
||||
|
||||
Idempotency:
|
||||
- Unique `(schedule_id, run_at)` prevents duplicates even with multiple workers.
|
||||
|
||||
Entity: `src/allowance/entities/allowance-credit.entity.ts`
|
||||
|
||||
### Table: `cron_runs`
|
||||
|
||||
Purpose: shared audit table for all cron jobs (not just allowance).
|
||||
|
||||
Key fields:
|
||||
- `job_name`: unique identifier for the cron.
|
||||
- `status`: SUCCESS / FAILED.
|
||||
- `processed_count`: number of schedules processed.
|
||||
- `error_message`: failure reason.
|
||||
- `started_at`, `finished_at`.
|
||||
|
||||
Entity: `src/cron/entities/cron-run.entity.ts`
|
||||
|
||||
## API (Schedule Creation)
|
||||
|
||||
Endpoint:
|
||||
- `POST /guardians/me/allowances/:juniorId`
|
||||
|
||||
Input DTO:
|
||||
- `amount` (required, numeric, positive)
|
||||
- `frequency` (required, enum)
|
||||
- `status` (required, enum)
|
||||
|
||||
DTO: `src/allowance/dtos/request/create-allowance-schedule.request.dto.ts`
|
||||
|
||||
Response DTO:
|
||||
- `AllowanceScheduleResponseDto` with schedule fields.
|
||||
|
||||
DTO: `src/allowance/dtos/response/allowance-schedule.response.dto.ts`
|
||||
|
||||
Business validation:
|
||||
- Child must belong to guardian.
|
||||
- No duplicate schedule for the same guardian+child.
|
||||
|
||||
Service: `src/allowance/services/allowance.service.ts`
|
||||
|
||||
## Cron Producer (Queue Enqueue)
|
||||
|
||||
Cron job:
|
||||
- Runs every 5 minutes.
|
||||
- Batches schedules (cursor-based) to avoid large load.
|
||||
- Enqueues each schedule to RabbitMQ.
|
||||
|
||||
Cron: `src/cron/tasks/allowance-schedule.cron.ts`
|
||||
|
||||
Batch behavior:
|
||||
- Batch size = 100
|
||||
- Uses a cursor (`nextRunAt`, `id`) for stable pagination.
|
||||
- Prevents re-reading the same rows.
|
||||
|
||||
Locking:
|
||||
- `BaseCronService` uses cache lock to ensure only one instance runs.
|
||||
- Each cron run is logged to `cron_runs` with status and processed count.
|
||||
|
||||
Lock: `src/cron/services/base-cron.service.ts`
|
||||
|
||||
## Queue Publisher
|
||||
|
||||
Queue publisher:
|
||||
- Asserts queue + retry/DLQ exchanges.
|
||||
- Enqueues jobs with message id (for traceability).
|
||||
|
||||
Service: `src/allowance/services/allowance-queue.service.ts`
|
||||
|
||||
Queue names:
|
||||
- `allowance.schedule` (main)
|
||||
- `allowance.schedule.retry` (retry with TTL)
|
||||
- `allowance.schedule.dlq` (dead-letter queue)
|
||||
|
||||
Constants: `src/allowance/constants/allowance-queue.constants.ts`
|
||||
|
||||
## Worker Consumer (Transfers)
|
||||
|
||||
Worker:
|
||||
- Consumes `allowance.schedule` queue.
|
||||
- Validates schedule is due and active.
|
||||
- Creates `allowance_credits` record for idempotency.
|
||||
- Transfers money via `cardService.transferToChild`.
|
||||
- Updates `last_run_at` and `next_run_at`.
|
||||
|
||||
Worker: `src/allowance/services/allowance-worker.service.ts`
|
||||
|
||||
Transfer:
|
||||
- Uses existing logic in `card.service.ts` for balance updates and transaction creation.
|
||||
|
||||
Service: `src/card/services/card.service.ts`
|
||||
|
||||
### Idempotency details
|
||||
|
||||
1. Worker inserts `allowance_credits` row first.
|
||||
2. Unique constraint blocks duplicates.
|
||||
3. If transfer fails, the credit row is removed so the job can retry.
|
||||
|
||||
This makes multiple workers safe.
|
||||
|
||||
## Retry + DLQ Strategy
|
||||
|
||||
Retry delay:
|
||||
- Failed jobs are dead-lettered to retry queue.
|
||||
- Retry queue has `messageTtl = 10 minutes`.
|
||||
- After TTL, job is routed back to main queue.
|
||||
|
||||
DLQ:
|
||||
- If a job fails `ALLOWANCE_MAX_RETRIES` times (default 5), it is routed to the DLQ.
|
||||
- This prevents endless loops and allows manual inspection.
|
||||
|
||||
Config:
|
||||
- `ALLOWANCE_MAX_RETRIES` (default 5)
|
||||
|
||||
## Redis Usage
|
||||
|
||||
Redis is used by `BaseCronService` to enforce a **distributed lock** for the cron job.
|
||||
This prevents multiple backend instances from enqueuing the same schedules at the same time.
|
||||
|
||||
Lock behavior:
|
||||
- If the lock key exists, cron exits early.
|
||||
- If the lock key is absent, cron sets it with a TTL and proceeds.
|
||||
- TTL ensures the lock is released even if a node crashes.
|
||||
|
||||
Service: `src/cron/services/base-cron.service.ts`
|
||||
|
||||
## RabbitMQ Setup and Behavior
|
||||
|
||||
The allowance system uses RabbitMQ for asynchronous processing. Cron publishes due schedules,
|
||||
and workers consume them.
|
||||
|
||||
### Exchanges and Queues
|
||||
|
||||
Main queue:
|
||||
- `allowance.schedule`
|
||||
|
||||
Retry setup:
|
||||
- Exchange: `allowance.schedule.retry.exchange`
|
||||
- Queue: `allowance.schedule.retry`
|
||||
- Binding key: `allowance.schedule`
|
||||
- TTL: 10 minutes
|
||||
- Dead-letter route: back to `allowance.schedule`
|
||||
|
||||
Dead-letter queue (DLQ):
|
||||
- Exchange: `allowance.schedule.dlq.exchange`
|
||||
- Queue: `allowance.schedule.dlq`
|
||||
- Binding key: `allowance.schedule`
|
||||
|
||||
### Flow Summary
|
||||
|
||||
1. Cron enqueues jobs to `allowance.schedule`.
|
||||
2. Worker consumes jobs from `allowance.schedule`.
|
||||
3. On failure, job is **dead-lettered** to `allowance.schedule.retry`.
|
||||
4. After 10 minutes, it returns to `allowance.schedule`.
|
||||
5. After max retries, worker publishes the job to `allowance.schedule.dlq`.
|
||||
|
||||
### Where it is configured
|
||||
|
||||
- Publisher setup: `src/allowance/services/allowance-queue.service.ts`
|
||||
- Worker consumer: `src/allowance/services/allowance-worker.service.ts`
|
||||
- Queue constants: `src/allowance/constants/allowance-queue.constants.ts`
|
||||
|
||||
## Environment Variables
|
||||
|
||||
- `RABBITMQ_URL` (required for queue/worker)
|
||||
- `ALLOWANCE_QUEUE_NAME` (optional, defaults to `allowance.schedule`)
|
||||
- `ALLOWANCE_MAX_RETRIES` (optional, defaults to 5)
|
||||
- `ALLOWANCE_RETRY_DELAY_MS` (optional, defaults to 10 minutes)
|
||||
|
||||
### Example .env snippet
|
||||
|
||||
```
|
||||
RABBITMQ_URL=amqp://guest:guest@localhost:5672
|
||||
ALLOWANCE_QUEUE_NAME=allowance.schedule
|
||||
ALLOWANCE_MAX_RETRIES=5
|
||||
ALLOWANCE_RETRY_DELAY_MS=600000
|
||||
```
|
||||
|
||||
## Operational Checklist
|
||||
|
||||
- Ensure Redis is running (cron locking).
|
||||
- Ensure RabbitMQ is running (queue + workers).
|
||||
- Start at least one worker process.
|
||||
- Monitor DLQ for failures.
|
||||
|
||||
## Manual Test Checklist
|
||||
|
||||
1. Create schedule:
|
||||
- POST `/guardians/me/allowances/:juniorId`
|
||||
- Valid amount, frequency, status.
|
||||
2. Duplicate schedule:
|
||||
- Expect `ALLOWANCE.ALREADY_EXISTS`.
|
||||
3. Cron enqueue:
|
||||
- Wait for cron interval or manually trigger.
|
||||
- Confirm messages appear in RabbitMQ.
|
||||
4. Worker:
|
||||
- Ensure worker is running.
|
||||
- Verify transfers happen and `allowance_credits` is created.
|
||||
5. Failure paths:
|
||||
- Simulate transfer failure and verify retry queue behavior.
|
||||
- Confirm DLQ after max retries.
|
||||
|
||||
## Operational Notes
|
||||
|
||||
- For large volumes, scale workers horizontally.
|
||||
- Keep cron lightweight; do not perform transfers in cron.
|
||||
- Monitor queue depth and DLQ entries.
|
||||
|
||||
## Known Limitations (Current)
|
||||
|
||||
- Only one schedule per child (guardian+junior unique).
|
||||
- No custom weekdays or complex schedules.
|
||||
- Retry delay is fixed at 10 minutes (can be configurable).
|
||||
|
||||
## File Map (Quick Reference)
|
||||
|
||||
- API:
|
||||
- `src/allowance/controllers/allowance.controller.ts`
|
||||
- `src/allowance/services/allowance.service.ts`
|
||||
- `src/allowance/dtos/request/create-allowance-schedule.request.dto.ts`
|
||||
- `src/allowance/dtos/response/allowance-schedule.response.dto.ts`
|
||||
|
||||
- Cron:
|
||||
- `src/cron/tasks/allowance-schedule.cron.ts`
|
||||
- `src/cron/services/base-cron.service.ts`
|
||||
|
||||
- Queue/Worker:
|
||||
- `src/allowance/services/allowance-queue.service.ts`
|
||||
- `src/allowance/services/allowance-worker.service.ts`
|
||||
- `src/allowance/constants/allowance-queue.constants.ts`
|
||||
|
||||
- Repositories:
|
||||
- `src/allowance/repositories/allowance-schedule.repository.ts`
|
||||
- `src/allowance/repositories/allowance-credit.repository.ts`
|
||||
|
||||
- Entities:
|
||||
- `src/allowance/entities/allowance-schedule.entity.ts`
|
||||
- `src/allowance/entities/allowance-credit.entity.ts`
|
||||
|
||||
+11
@@ -0,0 +1,11 @@
|
||||
FROM python:3.9
|
||||
ENV PYTHONUNBUFFERED 1
|
||||
RUN mkdir /usr/src/app
|
||||
WORKDIR /usr/src/app
|
||||
COPY . .
|
||||
RUN apt-get update
|
||||
RUN apt-get install wkhtmltopdf -y
|
||||
RUN apt install -y gdal-bin python3-gdal
|
||||
RUN pip install -r requirements.txt
|
||||
WORKDIR /usr/src/app
|
||||
|
||||
@@ -1,33 +0,0 @@
|
||||
# Base image
|
||||
FROM node:22.4.1-alpine
|
||||
RUN apk update && \
|
||||
apk upgrade && \
|
||||
apk add ca-certificates curl && \
|
||||
update-ca-certificates
|
||||
|
||||
#saudi timezone
|
||||
ENV TZ=Asia/Riyadh
|
||||
|
||||
# Create app directory
|
||||
RUN mkdir /app && chown node:node /app
|
||||
WORKDIR /app
|
||||
|
||||
# finally switch user to node
|
||||
USER node
|
||||
|
||||
|
||||
# A wildcard is used to ensure both package.json, package-lock.json and package-lock.json are copied
|
||||
COPY --chown=node:node package*.json ./
|
||||
|
||||
|
||||
|
||||
# Install app dependencies
|
||||
RUN npm install --frozen-lockfile
|
||||
# Bundle app source
|
||||
COPY --chown=node:node . .
|
||||
|
||||
# Creates a "dist" folder with the production build
|
||||
RUN npm run build
|
||||
|
||||
# Start the server using the production build
|
||||
CMD [ "node", "dist/main" ]
|
||||
@@ -1,99 +1 @@
|
||||
<p align="center">
|
||||
<a href="http://nestjs.com/" target="blank"><img src="https://nestjs.com/img/logo-small.svg" width="120" alt="Nest Logo" /></a>
|
||||
</p>
|
||||
|
||||
[circleci-image]: https://img.shields.io/circleci/build/github/nestjs/nest/master?token=abc123def456
|
||||
[circleci-url]: https://circleci.com/gh/nestjs/nest
|
||||
|
||||
<p align="center">A progressive <a href="http://nodejs.org" target="_blank">Node.js</a> framework for building efficient and scalable server-side applications.</p>
|
||||
<p align="center">
|
||||
<a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/v/@nestjs/core.svg" alt="NPM Version" /></a>
|
||||
<a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/l/@nestjs/core.svg" alt="Package License" /></a>
|
||||
<a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/dm/@nestjs/common.svg" alt="NPM Downloads" /></a>
|
||||
<a href="https://circleci.com/gh/nestjs/nest" target="_blank"><img src="https://img.shields.io/circleci/build/github/nestjs/nest/master" alt="CircleCI" /></a>
|
||||
<a href="https://coveralls.io/github/nestjs/nest?branch=master" target="_blank"><img src="https://coveralls.io/repos/github/nestjs/nest/badge.svg?branch=master#9" alt="Coverage" /></a>
|
||||
<a href="https://discord.gg/G7Qnnhy" target="_blank"><img src="https://img.shields.io/badge/discord-online-brightgreen.svg" alt="Discord"/></a>
|
||||
<a href="https://opencollective.com/nest#backer" target="_blank"><img src="https://opencollective.com/nest/backers/badge.svg" alt="Backers on Open Collective" /></a>
|
||||
<a href="https://opencollective.com/nest#sponsor" target="_blank"><img src="https://opencollective.com/nest/sponsors/badge.svg" alt="Sponsors on Open Collective" /></a>
|
||||
<a href="https://paypal.me/kamilmysliwiec" target="_blank"><img src="https://img.shields.io/badge/Donate-PayPal-ff3f59.svg" alt="Donate us"/></a>
|
||||
<a href="https://opencollective.com/nest#sponsor" target="_blank"><img src="https://img.shields.io/badge/Support%20us-Open%20Collective-41B883.svg" alt="Support us"></a>
|
||||
<a href="https://twitter.com/nestframework" target="_blank"><img src="https://img.shields.io/twitter/follow/nestframework.svg?style=social&label=Follow" alt="Follow us on Twitter"></a>
|
||||
</p>
|
||||
<!--[](https://opencollective.com/nest#backer)
|
||||
[](https://opencollective.com/nest#sponsor)-->
|
||||
|
||||
## Description
|
||||
|
||||
[Nest](https://github.com/nestjs/nest) framework TypeScript starter repository.
|
||||
|
||||
## Project setup
|
||||
|
||||
```bash
|
||||
$ npm install
|
||||
```
|
||||
|
||||
## Compile and run the project
|
||||
|
||||
```bash
|
||||
# development
|
||||
$ npm run start
|
||||
|
||||
# watch mode
|
||||
$ npm run start:dev
|
||||
|
||||
# production mode
|
||||
$ npm run start:prod
|
||||
```
|
||||
|
||||
## Run tests
|
||||
|
||||
```bash
|
||||
# unit tests
|
||||
$ npm run test
|
||||
|
||||
# e2e tests
|
||||
$ npm run test:e2e
|
||||
|
||||
# test coverage
|
||||
$ npm run test:cov
|
||||
```
|
||||
|
||||
## Deployment
|
||||
|
||||
When you're ready to deploy your NestJS application to production, there are some key steps you can take to ensure it runs as efficiently as possible. Check out the [deployment documentation](https://docs.nestjs.com/deployment) for more information.
|
||||
|
||||
If you are looking for a cloud-based platform to deploy your NestJS application, check out [Mau](https://mau.nestjs.com), our official platform for deploying NestJS applications on AWS. Mau makes deployment straightforward and fast, requiring just a few simple steps:
|
||||
|
||||
```bash
|
||||
$ npm install -g mau
|
||||
$ mau deploy
|
||||
```
|
||||
|
||||
With Mau, you can deploy your application in just a few clicks, allowing you to focus on building features rather than managing infrastructure.
|
||||
|
||||
## Resources
|
||||
|
||||
Check out a few resources that may come in handy when working with NestJS:
|
||||
|
||||
- Visit the [NestJS Documentation](https://docs.nestjs.com) to learn more about the framework.
|
||||
- For questions and support, please visit our [Discord channel](https://discord.gg/G7Qnnhy).
|
||||
- To dive deeper and get more hands-on experience, check out our official video [courses](https://courses.nestjs.com/).
|
||||
- Deploy your application to AWS with the help of [NestJS Mau](https://mau.nestjs.com) in just a few clicks.
|
||||
- Visualize your application graph and interact with the NestJS application in real-time using [NestJS Devtools](https://devtools.nestjs.com).
|
||||
- Need help with your project (part-time to full-time)? Check out our official [enterprise support](https://enterprise.nestjs.com).
|
||||
- To stay in the loop and get updates, follow us on [X](https://x.com/nestframework) and [LinkedIn](https://linkedin.com/company/nestjs).
|
||||
- Looking for a job, or have a job to offer? Check out our official [Jobs board](https://jobs.nestjs.com).
|
||||
|
||||
## Support
|
||||
|
||||
Nest is an MIT-licensed open source project. It can grow thanks to the sponsors and support by the amazing backers. If you'd like to join them, please [read more here](https://docs.nestjs.com/support).
|
||||
|
||||
## Stay in touch
|
||||
|
||||
- Author - [Kamil Myśliwiec](https://twitter.com/kammysliwiec)
|
||||
- Website - [https://nestjs.com](https://nestjs.com/)
|
||||
- Twitter - [@nestframework](https://twitter.com/nestframework)
|
||||
|
||||
## License
|
||||
|
||||
Nest is [MIT licensed](https://github.com/nestjs/nest/blob/master/LICENSE).
|
||||
# ZODBank-Backend
|
||||
|
||||
@@ -0,0 +1,31 @@
|
||||
"""Account admin"""
|
||||
from django.contrib import admin
|
||||
|
||||
"""Import django app"""
|
||||
from .models import UserProfile, UserEmailOtp, UserPhoneOtp
|
||||
# Register your models here.
|
||||
@admin.register(UserProfile)
|
||||
class UserProfileAdmin(admin.ModelAdmin):
|
||||
"""User profile admin"""
|
||||
list_display = ['user']
|
||||
|
||||
def __str__(self):
|
||||
return self.user__email
|
||||
|
||||
@admin.register(UserEmailOtp)
|
||||
class UserEmailOtpAdmin(admin.ModelAdmin):
|
||||
"""User Email otp admin"""
|
||||
list_display = ['email']
|
||||
|
||||
def __str__(self):
|
||||
"""Return object in email and otp format"""
|
||||
return self.email + '-' + self.otp
|
||||
|
||||
@admin.register(UserPhoneOtp)
|
||||
class UserPhoneOtpAdmin(admin.ModelAdmin):
|
||||
"""User Phone otp admin"""
|
||||
list_display = ['phone']
|
||||
|
||||
def __str__(self):
|
||||
"""Return object in phone number and otp format"""
|
||||
return self.phone + '-' + self.otp
|
||||
@@ -0,0 +1,6 @@
|
||||
from django.apps import AppConfig
|
||||
|
||||
|
||||
class AccountConfig(AppConfig):
|
||||
default_auto_field = 'django.db.models.BigAutoField'
|
||||
name = 'account'
|
||||
@@ -0,0 +1,65 @@
|
||||
# Generated by Django 4.2.2 on 2023-06-23 12:05
|
||||
|
||||
from django.conf import settings
|
||||
from django.db import migrations, models
|
||||
import django.db.models.deletion
|
||||
|
||||
|
||||
class Migration(migrations.Migration):
|
||||
|
||||
initial = True
|
||||
|
||||
dependencies = [
|
||||
migrations.swappable_dependency(settings.AUTH_USER_MODEL),
|
||||
]
|
||||
|
||||
operations = [
|
||||
migrations.CreateModel(
|
||||
name='UserEmailOtp',
|
||||
fields=[
|
||||
('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
|
||||
('email', models.EmailField(max_length=254)),
|
||||
('otp', models.CharField(max_length=10)),
|
||||
('is_verified', models.BooleanField(default=False)),
|
||||
('created_at', models.DateTimeField(auto_now_add=True)),
|
||||
('updated_at', models.DateTimeField(auto_now=True)),
|
||||
('expired_at', models.DateTimeField(blank=True, null=True)),
|
||||
('is_active', models.BooleanField(default=True)),
|
||||
],
|
||||
options={
|
||||
'db_table': 'user_email_otp',
|
||||
},
|
||||
),
|
||||
migrations.CreateModel(
|
||||
name='UserPhoneOtp',
|
||||
fields=[
|
||||
('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
|
||||
('country_code', models.IntegerField()),
|
||||
('phone', models.CharField(max_length=17)),
|
||||
('otp', models.CharField(max_length=10)),
|
||||
('is_verified', models.BooleanField(default=False)),
|
||||
('created_at', models.DateTimeField(auto_now_add=True)),
|
||||
('updated_at', models.DateTimeField(auto_now=True)),
|
||||
('expired_at', models.DateTimeField(blank=True, null=True)),
|
||||
('is_active', models.BooleanField(default=True)),
|
||||
],
|
||||
options={
|
||||
'db_table': 'user_phone_otp',
|
||||
},
|
||||
),
|
||||
migrations.CreateModel(
|
||||
name='UserProfile',
|
||||
fields=[
|
||||
('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
|
||||
('user_type', models.CharField(blank=True, choices=[('1', 'junior'), ('2', 'guardian'), ('3', 'superuser')], default=None, max_length=15, null=True)),
|
||||
('is_verified', models.BooleanField(default=False)),
|
||||
('created_at', models.DateTimeField(auto_now_add=True)),
|
||||
('updated_at', models.DateTimeField(auto_now=True)),
|
||||
('is_active', models.BooleanField(default=False)),
|
||||
('user', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='user_profile', to=settings.AUTH_USER_MODEL)),
|
||||
],
|
||||
options={
|
||||
'db_table': 'user_profile',
|
||||
},
|
||||
),
|
||||
]
|
||||
@@ -0,0 +1,75 @@
|
||||
from django.db import models
|
||||
import random
|
||||
from django.contrib.auth.models import User
|
||||
from base.constants import USER_TYPE
|
||||
# Create your models here.
|
||||
|
||||
class UserProfile(models.Model):
|
||||
"""
|
||||
User details
|
||||
"""
|
||||
user = models.ForeignKey(User, on_delete=models.CASCADE, related_name='user_profile')
|
||||
user_type = models.CharField(max_length=15, choices=USER_TYPE, null=True, blank=True, default=None)
|
||||
is_verified = models.BooleanField(default=False)
|
||||
|
||||
# OTP validity
|
||||
created_at = models.DateTimeField(auto_now_add=True)
|
||||
updated_at = models.DateTimeField(auto_now=True)
|
||||
is_active = models.BooleanField(default=False)
|
||||
|
||||
class Meta(object):
|
||||
""" Meta information """
|
||||
db_table = 'user_profile'
|
||||
|
||||
def __str__(self):
|
||||
"""return phone as an object"""
|
||||
return f'{self.user}'
|
||||
|
||||
class UserPhoneOtp(models.Model):
|
||||
"""
|
||||
This class is used to verify user email and their contact no.
|
||||
"""
|
||||
"""user details"""
|
||||
country_code = models.IntegerField()
|
||||
phone = models.CharField(max_length=17)
|
||||
"""otp details"""
|
||||
otp = models.CharField(max_length=10)
|
||||
is_verified = models.BooleanField(default=False)
|
||||
|
||||
# OTP validity
|
||||
created_at = models.DateTimeField(auto_now_add=True)
|
||||
updated_at = models.DateTimeField(auto_now=True)
|
||||
expired_at = models.DateTimeField(blank=True, null=True)
|
||||
is_active = models.BooleanField(default=True)
|
||||
|
||||
class Meta(object):
|
||||
""" Meta information """
|
||||
db_table = 'user_phone_otp'
|
||||
|
||||
def __str__(self):
|
||||
"""return phone as an object"""
|
||||
return self.phone
|
||||
|
||||
class UserEmailOtp(models.Model):
|
||||
"""
|
||||
This class is used to verify user email and their contact no.
|
||||
"""
|
||||
"""user details"""
|
||||
email = models.EmailField()
|
||||
"""otp details"""
|
||||
otp = models.CharField(max_length=10)
|
||||
is_verified = models.BooleanField(default=False)
|
||||
|
||||
# OTP validity
|
||||
created_at = models.DateTimeField(auto_now_add=True)
|
||||
updated_at = models.DateTimeField(auto_now=True)
|
||||
expired_at = models.DateTimeField(blank=True, null=True)
|
||||
is_active = models.BooleanField(default=True)
|
||||
|
||||
class Meta(object):
|
||||
""" Meta information """
|
||||
db_table = 'user_email_otp'
|
||||
|
||||
def __str__(self):
|
||||
"""return phone as an object"""
|
||||
return self.email
|
||||
@@ -0,0 +1,162 @@
|
||||
from rest_framework import serializers
|
||||
from django.contrib.auth.models import User
|
||||
from guardian.models import Guardian
|
||||
from junior.models import Junior
|
||||
from account.models import UserProfile, UserEmailOtp, UserPhoneOtp
|
||||
from base.constants import GUARDIAN, JUNIOR, SUPERUSER
|
||||
from django.db import transaction
|
||||
from base.messages import ERROR_CODE_REQUIRED, ERROR_CODE, SUCCESS_CODE, STATUS_CODE_ERROR
|
||||
from django.core.exceptions import ObjectDoesNotExist
|
||||
from django.contrib.auth import authenticate
|
||||
from rest_framework import viewsets, status
|
||||
from rest_framework.decorators import action
|
||||
from django.contrib.auth import authenticate, login
|
||||
from rest_framework_simplejwt.tokens import RefreshToken
|
||||
|
||||
|
||||
class ResetPasswordSerializer(serializers.Serializer):
|
||||
"""Reset Password after verification"""
|
||||
verification_code = serializers.CharField(max_length=10)
|
||||
password = serializers.CharField(required=True)
|
||||
class Meta(object):
|
||||
"""Meta info"""
|
||||
model = User
|
||||
|
||||
def create(self, validated_data):
|
||||
verification_code = validated_data.pop('verification_code')
|
||||
password = validated_data.pop('password')
|
||||
print("verification_code===>",verification_code)
|
||||
print("password===>", password)
|
||||
user_opt_details = UserEmailOtp.objects.filter(otp=verification_code, is_verified=True).last()
|
||||
print("user_opt_details===>",user_opt_details)
|
||||
if user_opt_details:
|
||||
print("qqqqqqqqqq")
|
||||
user_details = User.objects.filter(email=user_opt_details.email).last()
|
||||
if user_details:
|
||||
print("333333333==>",user_details.password)
|
||||
user_details.set_password(password)
|
||||
user_details.save()
|
||||
return {'password':password}
|
||||
return user_opt_details
|
||||
return ''
|
||||
|
||||
class ChangePasswordSerializer(serializers.Serializer):
|
||||
"""Update Password after verification"""
|
||||
current_password = serializers.CharField(max_length=100)
|
||||
new_password = serializers.CharField(required=True)
|
||||
class Meta(object):
|
||||
"""Meta info"""
|
||||
model = User
|
||||
|
||||
def validate_current_password(self, value):
|
||||
user = self.context
|
||||
if self.context.password not in ('', None):
|
||||
if user.check_password(value):
|
||||
return value
|
||||
raise serializers.ValidationError({"error":"Invalid Current password"})
|
||||
def create(self, validated_data):
|
||||
new_password = validated_data.pop('new_password')
|
||||
user_details = User.objects.filter(email=self.context).last()
|
||||
print("user_details==>", user_details)
|
||||
if user_details:
|
||||
print("333333333==>",user_details.password)
|
||||
user_details.set_password(new_password)
|
||||
user_details.save()
|
||||
return {'password':new_password}
|
||||
return ''
|
||||
|
||||
|
||||
|
||||
class ForgotPasswordSerializer(serializers.Serializer):
|
||||
"""Forget password serializer"""
|
||||
email = serializers.EmailField()
|
||||
|
||||
class SuperUserSerializer(serializers.ModelSerializer):
|
||||
user_type = serializers.SerializerMethodField('get_user_type')
|
||||
|
||||
def get_user_type(self, obj):
|
||||
"""user type"""
|
||||
return SUPERUSER
|
||||
|
||||
class Meta(object):
|
||||
"""Meta info"""
|
||||
model = User
|
||||
fields = ['id', 'username', 'email', 'first_name', 'last_name', 'is_active', 'user_type']
|
||||
|
||||
|
||||
class GuardianSerializer(serializers.ModelSerializer):
|
||||
"""guardian serializer"""
|
||||
user_type = serializers.SerializerMethodField('get_user_type')
|
||||
email = serializers.SerializerMethodField('get_auth')
|
||||
first_name = serializers.SerializerMethodField('get_first_name')
|
||||
last_name = serializers.SerializerMethodField('get_last_name')
|
||||
auth_token = serializers.SerializerMethodField('get_auth_token')
|
||||
|
||||
def get_auth_token(self, obj):
|
||||
refresh = RefreshToken.for_user(obj.user)
|
||||
access_token = str(refresh.access_token)
|
||||
return access_token
|
||||
|
||||
def get_user_type(self, obj):
|
||||
"""user type"""
|
||||
return GUARDIAN
|
||||
|
||||
def get_auth(self, obj):
|
||||
"""user email address"""
|
||||
return obj.user.username
|
||||
|
||||
def get_first_name(self, obj):
|
||||
"""user first name"""
|
||||
return obj.user.first_name
|
||||
|
||||
def get_last_name(self, obj):
|
||||
"""user last name"""
|
||||
return obj.user.last_name
|
||||
|
||||
class Meta(object):
|
||||
"""Meta info"""
|
||||
model = Guardian
|
||||
fields = ['auth_token', 'email', 'first_name', 'last_name', 'country_code', 'phone', 'family_name', 'gender', 'dob',
|
||||
'referral_code', 'is_active', 'is_complete_profile', 'passcode',
|
||||
'created_at', 'updated_at', 'user_type']
|
||||
|
||||
|
||||
class JuniorSerializer(serializers.ModelSerializer):
|
||||
"""junior serializer"""
|
||||
user_type = serializers.SerializerMethodField('get_user_type')
|
||||
email = serializers.SerializerMethodField('get_auth')
|
||||
first_name = serializers.SerializerMethodField('get_first_name')
|
||||
last_name = serializers.SerializerMethodField('get_last_name')
|
||||
auth_token = serializers.SerializerMethodField('get_auth_token')
|
||||
|
||||
def get_auth_token(self, obj):
|
||||
refresh = RefreshToken.for_user(obj.auth)
|
||||
access_token = str(refresh.access_token)
|
||||
return access_token
|
||||
|
||||
def get_user_type(self, obj):
|
||||
return JUNIOR
|
||||
|
||||
def get_auth(self, obj):
|
||||
return obj.auth.username
|
||||
|
||||
def get_first_name(self, obj):
|
||||
return obj.auth.first_name
|
||||
|
||||
def get_last_name(self, obj):
|
||||
return obj.auth.last_name
|
||||
|
||||
class Meta(object):
|
||||
"""Meta info"""
|
||||
model = Junior
|
||||
fields = ['auth_token', 'email', 'first_name', 'last_name', 'country_code', 'phone', 'gender', 'dob',
|
||||
'guardian_code', 'referral_code','is_active', 'is_complete_profile', 'created_at',
|
||||
'updated_at', 'user_type']
|
||||
|
||||
class EmailVerificationSerializer(serializers.ModelSerializer):
|
||||
"""Email verification serializer"""
|
||||
class Meta(object):
|
||||
"""Meta info"""
|
||||
model = UserEmailOtp
|
||||
fields = '__all__'
|
||||
|
||||
@@ -0,0 +1,54 @@
|
||||
<!DOCTYPE HTML>
|
||||
{% block subject %}DinDin{% endblock %}
|
||||
{% load static %}
|
||||
|
||||
{% block html %}
|
||||
<html lang="en" style="height: 100%;">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type"
|
||||
content="text/html; charset=UTF-8">
|
||||
<meta name="viewport"
|
||||
content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=0">
|
||||
<title>Zod Bank | OTP</title>
|
||||
<style type="text/css">
|
||||
@media all and (max-width: 599px) {
|
||||
.block {
|
||||
display: block !important;
|
||||
width: 100%;
|
||||
}
|
||||
.top-space {
|
||||
padding: 15px 0 0 !important;
|
||||
}
|
||||
}
|
||||
</style>
|
||||
</head>
|
||||
|
||||
<body style="margin: 0; padding: 0; background: #f7f8f9; height: 100%;">
|
||||
<!-- begin template body -->
|
||||
<table style="background:#f7f8f9; border: 0; border-collapse: separate; border-spacing: 0px; margin: auto; width: 100%; font-family: Arial, Helvetica, sans-serif; height: 100%;" aria-describedby="email-data-wrapper">
|
||||
<tr>
|
||||
<td style="padding: 0;">
|
||||
<table style="background-color: white; border-collapse: separate; border-spacing: 0px; border: 1px solid #e4e8eb; width: 100%; max-width: 600px; margin-right:auto; margin-left: auto;
|
||||
font-family: Arial, Helvetica, sans-serif;" aria-describedby="email-data-wrapper">
|
||||
<tr>
|
||||
<td style="padding: 41px 30px 40px; height: 39px; background: url({% static 'images/backgrounds/email_template.png' %}) left center no-repeat; background-size: cover;">
|
||||
</td>
|
||||
</tr>
|
||||
{% block plain %}
|
||||
{% endblock %}
|
||||
<tr>
|
||||
<td style="padding: 0 27px;">
|
||||
<p style="margin: 0; font-size: 14px; line-height: 20px; color: #505050; font-weight: 400;">-</p>
|
||||
<p style="margin: 0; font-size: 14px; line-height: 20px; color: #505050; font-weight: 400;">Cheers!</p>
|
||||
<p style="margin: 0 0 30px; font-size: 14px; line-height: 20px; color: #505050; font-weight: 700;">Zod Bank Team</p>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<!-- end template body -->
|
||||
</body>
|
||||
</html>
|
||||
{% endblock %}
|
||||
@@ -0,0 +1,23 @@
|
||||
{% extends "templated_email/email_base.email" %}
|
||||
|
||||
{% block subject %}
|
||||
OTP Verification
|
||||
{% endblock %}
|
||||
|
||||
{% block plain %}
|
||||
<tr>
|
||||
<td style="padding: 0 27px 15px;">
|
||||
<p style="margin: 0; font-size: 16px; line-height: 20px; padding: 36px 0 0; font-weight: 500; color: #1f2532;">
|
||||
Hi User,
|
||||
</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td style="padding: 0 27px 22px;">
|
||||
<p style="margin: 0;font-size: 14px; font-weight: 400; line-height: 21px; color: #1f2532;">
|
||||
You are receiving this email for email verification. Please use <b>{{ otp }} </b>as the verification code for your email address & username.
|
||||
|
||||
</p>
|
||||
</td>
|
||||
</tr>
|
||||
{% endblock %}
|
||||
@@ -0,0 +1,23 @@
|
||||
{% extends "templated_email/email_base.email" %}
|
||||
|
||||
{% block subject %}
|
||||
Password Reset Verification Code
|
||||
{% endblock %}
|
||||
|
||||
{% block plain %}
|
||||
<tr>
|
||||
<td style="padding: 0 27px 15px;">
|
||||
<p style="margin: 0; font-size: 16px; line-height: 20px; padding: 36px 0 0; font-weight: 500; color: #1f2532;">
|
||||
Hi User,
|
||||
</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td style="padding: 0 27px 22px;">
|
||||
<p style="margin: 0;font-size: 14px; font-weight: 400; line-height: 21px; color: #1f2532;">
|
||||
You are receiving this email for reset password verification. Please use <b>{{ verification_code }} </b>as the verification code.
|
||||
|
||||
</p>
|
||||
</td>
|
||||
</tr>
|
||||
{% endblock %}
|
||||
@@ -0,0 +1,3 @@
|
||||
from django.test import TestCase
|
||||
|
||||
# Create your tests here.
|
||||
@@ -0,0 +1,25 @@
|
||||
""" Urls files"""
|
||||
"""Django import"""
|
||||
from django.urls import path, include
|
||||
from rest_framework.decorators import api_view
|
||||
"""Third party import"""
|
||||
from rest_framework import routers
|
||||
from .views import (UserLogin, SendPhoneOtp, UserPhoneVerification, UserEmailVerification, ReSendEmailOtp,
|
||||
ForgotPasswordAPIView, ResetPasswordAPIView, ChangePasswordAPIView)
|
||||
"""Router"""
|
||||
router = routers.SimpleRouter()
|
||||
|
||||
"""API End points with router"""
|
||||
router.register('user', UserLogin, basename='user')
|
||||
router.register('admin', UserLogin, basename='admin')
|
||||
router.register('send-phone-otp', SendPhoneOtp, basename='send-phone-otp')
|
||||
router.register('user-phone-verification', UserPhoneVerification, basename='user-phone-verification')
|
||||
router.register('user-email-verification', UserEmailVerification, basename='user-email-verification')
|
||||
router.register('resend-email-otp', ReSendEmailOtp, basename='resend-email-otp')
|
||||
|
||||
urlpatterns = [
|
||||
path('api/v1/', include(router.urls)),
|
||||
path('api/v1/forgot-password/', ForgotPasswordAPIView.as_view()),
|
||||
path('api/v1/reset-password/', ResetPasswordAPIView.as_view()),
|
||||
path('api/v1/change-password/', ChangePasswordAPIView.as_view())
|
||||
]
|
||||
@@ -0,0 +1,38 @@
|
||||
"""Account utils"""
|
||||
"""Third party Django app"""
|
||||
from django.conf import settings
|
||||
from rest_framework import viewsets, status
|
||||
from rest_framework.response import Response
|
||||
|
||||
from templated_email import send_templated_mail
|
||||
def send_otp_email(recipient_email, otp):
|
||||
from_email = settings.EMAIL_HOST_USER
|
||||
recipient_list = [recipient_email]
|
||||
send_templated_mail(
|
||||
template_name='email_otp_verification.email',
|
||||
from_email=from_email,
|
||||
recipient_list=recipient_list,
|
||||
context={
|
||||
'otp': otp
|
||||
}
|
||||
)
|
||||
return otp
|
||||
|
||||
def custom_response(detail, data=None, response_status=status.HTTP_200_OK):
|
||||
"""Custom response code"""
|
||||
if not data:
|
||||
data = None
|
||||
|
||||
return Response({"data": data, "message": detail, "status": "success", "code": response_status})
|
||||
|
||||
|
||||
def custom_error_response(detail, response_status):
|
||||
"""
|
||||
function is used for getting same global error response for all
|
||||
:param detail: error message .
|
||||
:param response_status: http status.
|
||||
:return: Json response
|
||||
"""
|
||||
if not detail:
|
||||
detail = {}
|
||||
return Response({"error": detail, "status": "failed", "code": response_status})
|
||||
@@ -0,0 +1,196 @@
|
||||
from rest_framework import viewsets, status, views
|
||||
from rest_framework.decorators import action
|
||||
import random
|
||||
import logging
|
||||
from django.contrib.auth import authenticate, login
|
||||
from guardian.models import Guardian
|
||||
from junior.models import Junior
|
||||
from account.models import UserProfile, UserPhoneOtp, UserEmailOtp
|
||||
from django.contrib.auth.models import User
|
||||
from .serializers import (SuperUserSerializer, GuardianSerializer, JuniorSerializer, EmailVerificationSerializer,
|
||||
ForgotPasswordSerializer, ResetPasswordSerializer, ChangePasswordSerializer)
|
||||
from rest_framework_simplejwt.tokens import RefreshToken
|
||||
from base.messages import ERROR_CODE, SUCCESS_CODE
|
||||
from guardian.tasks import generate_otp
|
||||
from django.conf import settings
|
||||
from account.utils import send_otp_email
|
||||
from account.utils import custom_response, custom_error_response
|
||||
from django.core.mail import EmailMessage
|
||||
from django.core.mail import send_mail
|
||||
from rest_framework.response import Response
|
||||
from rest_framework.permissions import IsAuthenticated
|
||||
from templated_email import send_templated_mail
|
||||
|
||||
|
||||
class ChangePasswordAPIView(views.APIView):
|
||||
permission_classes = [IsAuthenticated]
|
||||
def post(self, request):
|
||||
serializer = ChangePasswordSerializer(context=request.user, data=request.data)
|
||||
if serializer.is_valid():
|
||||
serializer.save()
|
||||
return custom_response(SUCCESS_CODE['3007'], response_status=status.HTTP_200_OK)
|
||||
return custom_error_response(serializer.errors, response_status=status.HTTP_400_BAD_REQUEST)
|
||||
|
||||
class ResetPasswordAPIView(views.APIView):
|
||||
def post(self, request):
|
||||
serializer = ResetPasswordSerializer(data=request.data)
|
||||
if serializer.is_valid():
|
||||
serializer.save()
|
||||
return custom_response(SUCCESS_CODE['3006'], response_status=status.HTTP_200_OK)
|
||||
return custom_error_response(serializer.errors, response_status=status.HTTP_400_BAD_REQUEST)
|
||||
|
||||
class ForgotPasswordAPIView(views.APIView):
|
||||
def post(self, request):
|
||||
serializer = ForgotPasswordSerializer(data=request.data)
|
||||
if serializer.is_valid():
|
||||
email = serializer.validated_data['email']
|
||||
try:
|
||||
User.objects.get(email=email)
|
||||
except User.DoesNotExist:
|
||||
return custom_error_response(ERROR_CODE['2004'], response_status=status.HTTP_404_NOT_FOUND)
|
||||
verification_code = ''.join([str(random.randrange(9)) for _ in range(6)])
|
||||
# Send the verification code to the user's email
|
||||
from_email = settings.EMAIL_HOST_USER
|
||||
recipient_list = [email]
|
||||
send_templated_mail(
|
||||
template_name='email_reset_verification.email',
|
||||
from_email=from_email,
|
||||
recipient_list=recipient_list,
|
||||
context={
|
||||
'verification_code': verification_code
|
||||
}
|
||||
)
|
||||
user_data, created = UserEmailOtp.objects.get_or_create(email=email)
|
||||
if user_data:
|
||||
user_data.otp = verification_code
|
||||
user_data.save()
|
||||
return custom_response(SUCCESS_CODE['3015'],
|
||||
response_status=status.HTTP_200_OK)
|
||||
return custom_error_response(serializer.errors, response_status=status.HTTP_400_BAD_REQUEST)
|
||||
|
||||
class SendPhoneOtp(viewsets.ModelViewSet):
|
||||
"""Send otp on phone"""
|
||||
def create(self, request, *args, **kwargs):
|
||||
otp = generate_otp()
|
||||
phone_number = self.request.data['phone']
|
||||
if phone_number.isdigit() and len(phone_number) == 10:
|
||||
phone_otp, created = UserPhoneOtp.objects.get_or_create(country_code=self.request.data['country_code'],
|
||||
phone=self.request.data['phone'])
|
||||
if phone_otp:
|
||||
phone_otp.otp = otp
|
||||
phone_otp.save()
|
||||
return custom_response(None, {'phone_otp':otp}, response_status=status.HTTP_200_OK)
|
||||
return custom_error_response(ERROR_CODE['2020'], response_status=status.HTTP_400_BAD_REQUEST)
|
||||
|
||||
|
||||
class UserPhoneVerification(viewsets.ModelViewSet):
|
||||
"""Send otp on phone"""
|
||||
def list(self, request, *args, **kwargs):
|
||||
try:
|
||||
phone_data = UserPhoneOtp.objects.filter(phone=self.request.GET.get('phone'),
|
||||
otp=self.request.GET.get('otp')).last()
|
||||
if phone_data:
|
||||
phone_data.is_verified = True
|
||||
phone_data.save()
|
||||
return custom_response(SUCCESS_CODE['3012'], response_status=status.HTTP_200_OK)
|
||||
else:
|
||||
return custom_error_response(ERROR_CODE["2008"], response_status=status.HTTP_400_BAD_REQUEST)
|
||||
except Exception:
|
||||
return custom_error_response(ERROR_CODE["2008"], response_status=status.HTTP_400_BAD_REQUEST)
|
||||
|
||||
|
||||
|
||||
class UserLogin(viewsets.ViewSet):
|
||||
@action(methods=['post'], detail=False)
|
||||
def login(self, request):
|
||||
username = request.data.get('username')
|
||||
password = request.data.get('password')
|
||||
user = authenticate(request, username=username, password=password)
|
||||
try:
|
||||
if user is not None:
|
||||
login(request, user)
|
||||
guardian_data = Guardian.objects.filter(user__username=username, is_complete_profile=True).last()
|
||||
if guardian_data:
|
||||
serializer = GuardianSerializer(guardian_data)
|
||||
junior_data = Junior.objects.filter(auth__username=username, is_complete_profile=True).last()
|
||||
if junior_data:
|
||||
serializer = JuniorSerializer(junior_data)
|
||||
return custom_response(SUCCESS_CODE['3003'], serializer.data, response_status=status.HTTP_200_OK)
|
||||
else:
|
||||
return custom_error_response(ERROR_CODE["2002"], response_status=status.HTTP_401_UNAUTHORIZED)
|
||||
except Exception as e:
|
||||
logging.error(e)
|
||||
user_profile_data = UserProfile.objects.filter(user__username=username).last()
|
||||
email_verified = UserEmailOtp.objects.filter(email=username).last()
|
||||
refresh = RefreshToken.for_user(user)
|
||||
access_token = str(refresh.access_token)
|
||||
data = {"auth_token":access_token, "is_profile_complete": False,
|
||||
"user_role": user_profile_data.user_type,
|
||||
}
|
||||
is_verified = False
|
||||
if email_verified:
|
||||
is_verified = email_verified.is_verified
|
||||
if not is_verified:
|
||||
otp = generate_otp()
|
||||
email_verified.otp = otp
|
||||
email_verified.save()
|
||||
data.update({"email_otp":otp})
|
||||
return custom_response(ERROR_CODE['2024'], {"email_otp": otp, "is_email_verified": is_verified},
|
||||
response_status=status.HTTP_200_OK)
|
||||
data.update({"is_email_verified": is_verified})
|
||||
return custom_response(None, data, response_status=status.HTTP_200_OK)
|
||||
|
||||
@action(methods=['post'], detail=False)
|
||||
def admin_login(self, request):
|
||||
username = request.data.get('username')
|
||||
password = request.data.get('password')
|
||||
user = authenticate(request, username=username, password=password)
|
||||
try:
|
||||
if user is not None:
|
||||
login(request, user)
|
||||
if user.is_superuser:
|
||||
serializer = SuperUserSerializer(user)
|
||||
return custom_response(SUCCESS_CODE['3003'], serializer.data, response_status=status.HTTP_200_OK)
|
||||
else:
|
||||
return custom_error_response(ERROR_CODE["2002"], response_status=status.HTTP_401_UNAUTHORIZED)
|
||||
except Exception as e:
|
||||
logging.error(e)
|
||||
refresh = RefreshToken.for_user(user)
|
||||
access_token = str(refresh.access_token)
|
||||
data = {"auth_token": access_token, "user_role": '3'}
|
||||
return custom_response(None, data, response_status=status.HTTP_200_OK)
|
||||
|
||||
class UserEmailVerification(viewsets.ModelViewSet):
|
||||
"""User Email verification"""
|
||||
serializer_class = EmailVerificationSerializer
|
||||
|
||||
def list(self, request, *args, **kwargs):
|
||||
try:
|
||||
user_obj = User.objects.filter(username=self.request.GET.get('email')).last()
|
||||
email_data = UserEmailOtp.objects.filter(email=self.request.GET.get('email'),
|
||||
otp=self.request.GET.get('otp')).last()
|
||||
if email_data:
|
||||
email_data.is_verified = True
|
||||
email_data.save()
|
||||
refresh = RefreshToken.for_user(user_obj)
|
||||
access_token = str(refresh.access_token)
|
||||
return custom_response(SUCCESS_CODE['3011'], {"auth_token":access_token}, response_status=status.HTTP_200_OK)
|
||||
else:
|
||||
return custom_error_response(ERROR_CODE["2008"], response_status=status.HTTP_400_BAD_REQUEST)
|
||||
except Exception as e:
|
||||
logging.error(e)
|
||||
return custom_error_response(ERROR_CODE["2008"], response_status=status.HTTP_400_BAD_REQUEST)
|
||||
|
||||
class ReSendEmailOtp(viewsets.ModelViewSet):
|
||||
"""Send otp on phone"""
|
||||
def create(self, request, *args, **kwargs):
|
||||
otp = generate_otp()
|
||||
if User.objects.filter(email=request.data['email']):
|
||||
email_data, created = UserEmailOtp.objects.get_or_create(email=request.data['email'])
|
||||
if email_data:
|
||||
email_data.otp = otp
|
||||
email_data.save()
|
||||
send_otp_email(request.data['email'], otp)
|
||||
return custom_response(SUCCESS_CODE['3016'], response_status=status.HTTP_200_OK)
|
||||
else:
|
||||
return custom_error_response(ERROR_CODE["2023"], response_status=status.HTTP_400_BAD_REQUEST)
|
||||
@@ -0,0 +1,3 @@
|
||||
"""
|
||||
This is init module of the Project Zod Bank
|
||||
"""
|
||||
@@ -0,0 +1,30 @@
|
||||
"""
|
||||
Common send_mail function
|
||||
"""
|
||||
import logging
|
||||
|
||||
from django.core.mail import EmailMultiAlternatives
|
||||
|
||||
|
||||
def send_mail(subject, message, from_email, recipient_list, html_message=None, cc=None,
|
||||
fail_silently=False):
|
||||
"""
|
||||
Send Email
|
||||
:param subject:
|
||||
:param message:
|
||||
:param from_email:
|
||||
:param recipient_list:
|
||||
:param html_message:
|
||||
:param cc:
|
||||
:param fail_silently:
|
||||
:return:
|
||||
"""
|
||||
try:
|
||||
mail = EmailMultiAlternatives(subject, message, from_email, recipient_list, cc)
|
||||
if html_message:
|
||||
mail.attach_alternative(html_message, 'text/html')
|
||||
|
||||
return mail.send(fail_silently)
|
||||
except Exception as e:
|
||||
logging.error(e)
|
||||
return False
|
||||
@@ -0,0 +1,51 @@
|
||||
"""
|
||||
This module contains constants used throughout the project
|
||||
"""
|
||||
import os
|
||||
|
||||
# GOOGLE_URL used for interact with google server to verify user existence.
|
||||
#GOOGLE_URL = "https://www.googleapis.com/plus/v1/"
|
||||
|
||||
|
||||
# Super Admin string constant for 'role'
|
||||
SUPER_ADMIN = "Super Admin"
|
||||
|
||||
# Define jwt_token_expiration time in minutes for now token will expire after 3 days
|
||||
JWT_TOKEN_EXPIRATION = 3 * 24 * 60
|
||||
|
||||
# Define common file extention
|
||||
FILE_EXTENSION = ("gif", "jpeg", "jpg", "png", "svg")
|
||||
|
||||
# Define file size in bytes(5MB = 5 * 1024 * 1024)
|
||||
FILE_SIZE = 5 * 1024 * 1024
|
||||
|
||||
# String constant for configurable date for allocation lock period
|
||||
ALLOCATION_LOCK_DATE = 1
|
||||
|
||||
sort_dict = {
|
||||
'1': 'name',
|
||||
'2': '-name'
|
||||
}
|
||||
USER_TYPE = (
|
||||
('1', 'junior'),
|
||||
('2', 'guardian'),
|
||||
('3', 'superuser')
|
||||
)
|
||||
GENDERS = (
|
||||
('1', 'Male'),
|
||||
('2', 'Female')
|
||||
)
|
||||
# duplicate name used defined in constant PROJECT_NAME
|
||||
PROJECT_NAME = 'Zod Bank'
|
||||
GUARDIAN = 'guardian'
|
||||
JUNIOR = 'junior'
|
||||
SUPERUSER = 'superuser'
|
||||
# numbers used as a constant
|
||||
|
||||
# Define the byte into kb
|
||||
BYTE_IMAGE_SIZE = 1024
|
||||
|
||||
# validate file size
|
||||
MAX_FILE_SIZE = 1024 * 1024 * 5
|
||||
|
||||
|
||||
@@ -0,0 +1,16 @@
|
||||
"""
|
||||
This module contains constants used throughout the project
|
||||
"""
|
||||
from zod_bank.settings import BUCKET_NAME
|
||||
|
||||
# Define S3 folder url
|
||||
S3_FOLDER_DIR = {
|
||||
'user_image': 'user_image/',
|
||||
}
|
||||
|
||||
# S3 bucket url
|
||||
S3_URL = "https://"+BUCKET_NAME+".s3.amazonaws.com/"
|
||||
|
||||
S3_FOLDER_URL = {
|
||||
'user_image_file': S3_URL+S3_FOLDER_DIR['user_image'],
|
||||
}
|
||||
@@ -0,0 +1,94 @@
|
||||
"""
|
||||
This module contains all the messages used all across the project
|
||||
"""
|
||||
|
||||
ERROR_CODE_REQUIRED = {
|
||||
# Error code for email address
|
||||
"1000": ["Required email address not found."],
|
||||
# Error code for password
|
||||
"1001": ["Required password not found."],
|
||||
# Error code for Required Post parameters
|
||||
"1002": ["Required POST parameters not found."],
|
||||
# Error code for Required Get parameters
|
||||
"1003": ["Required GET parameters not found."],
|
||||
# Error code for Required Headers
|
||||
"1004": ["Required headers were not found."],
|
||||
# Error code for Required Put parameters
|
||||
"1005": ["Required PUT parameters not found."],
|
||||
# Error code for Required query parameters
|
||||
"1006": ["Required query parameters is not valid."],
|
||||
# Error code for Required Head parameters
|
||||
"1008": ["Required HEAD parameters not found."]
|
||||
}
|
||||
|
||||
# Error code
|
||||
ERROR_CODE = {
|
||||
"2000": "Email not found.",
|
||||
"2001": "Your account has not been verified. Please check your email and verify it.",
|
||||
"2002": "Invalid login credentials.",
|
||||
"2003": "An account already exists with this email address.",
|
||||
"2004": "User not found.",
|
||||
"2005": "Your account has been activated.",
|
||||
"2006": "Your account is not activated.",
|
||||
"2007": "Your account already activated.",
|
||||
"2008": "Invalid OTP.",
|
||||
"2009": "The user provided cannot be found or the reset password token has become invalid/timed out.",
|
||||
"2010": "Invalid Link.",
|
||||
"2011": "Your profile has not been completed yet.",
|
||||
"2012": "Password and Confirm password should be same.",
|
||||
"2013": "Invalid token.",
|
||||
"2014": "Your old password doesn't match.",
|
||||
"2015": "Invalid old password.",
|
||||
"2016": "Invalid search.",
|
||||
"2017": "{model} object with {pk} does not exist",
|
||||
"2018": "Attached File not found",
|
||||
"2019": "Either File extension or File size doesn't meet the requirements",
|
||||
"2020": "Enter valid mobile number",
|
||||
"2021": "Already register",
|
||||
"2022":"Invalid Guardian code",
|
||||
"2023":"Invalid user",
|
||||
"2024":"Email not verified"
|
||||
}
|
||||
SUCCESS_CODE = {
|
||||
# Success code for password
|
||||
"3001": "Sign up successfully",
|
||||
# Success code for Thank you
|
||||
"3002": "Thank you for contacting us! Our Consumer Experience Team will reach out to you shortly.",
|
||||
# Success code for account activation
|
||||
"3003": "Log in successfully",
|
||||
# Success code for password reset
|
||||
"3004": "Password reset link has been sent to your email address",
|
||||
# Success code for link verified
|
||||
"3005": "Your link has been verified, it's valid",
|
||||
# Success code for password reset
|
||||
"3006": "Your password has been reset successfully.",
|
||||
# Success code for password update
|
||||
"3007": "Your password has been changed successfully.",
|
||||
# Success code for valid link
|
||||
"3008": "You have a valid link.",
|
||||
# Success code for logged out
|
||||
"3009": "You have successfully logged out!",
|
||||
# Success code for check all fields
|
||||
"3010": "All fields are valid",
|
||||
"3011": "Email OTP Verified successfully",
|
||||
"3012": "Phone OTP Verified successfully",
|
||||
"3013": "Valid Guardian code",
|
||||
"3014": "Password has been updated successfully.",
|
||||
"3015": "Verification code sent on your email.",
|
||||
"3016": "Send otp on your Email successfully"
|
||||
}
|
||||
|
||||
STATUS_CODE_ERROR = {
|
||||
# Status code for Invalid Input
|
||||
"4001": ["Invalid input."],
|
||||
# Status code for Authentication credentials
|
||||
"4002": ["Authentication credentials were not provided."],
|
||||
# Status code for Permission
|
||||
"4003": ["You do not have permission to perform this action."],
|
||||
# Status code for not found
|
||||
"4004": ["Not found."],
|
||||
# Status code for method not allowed
|
||||
"4005": ["Method not allowed."]
|
||||
}
|
||||
|
||||
|
||||
@@ -0,0 +1,17 @@
|
||||
"""
|
||||
Custom routers for job sourcing .
|
||||
"""
|
||||
# third party imports
|
||||
from rest_framework.routers import DefaultRouter
|
||||
|
||||
|
||||
class OptionalSlashRouter(DefaultRouter):
|
||||
"""
|
||||
optional slash router class
|
||||
"""
|
||||
def __init__(self):
|
||||
"""
|
||||
explicitly appending '/' in urls if '/' doesn't exists for making common url patterns .
|
||||
"""
|
||||
super(OptionalSlashRouter, self).__init__()
|
||||
self.trailing_slash = '/?'
|
||||
@@ -0,0 +1,177 @@
|
||||
"""
|
||||
This file used for file uploaded
|
||||
"""
|
||||
import datetime
|
||||
# python imports
|
||||
import logging
|
||||
import mimetypes
|
||||
import os
|
||||
|
||||
import boto3
|
||||
from django.core.files.storage import FileSystemStorage
|
||||
# django imports
|
||||
from django.utils.crypto import get_random_string
|
||||
from rest_framework.status import HTTP_400_BAD_REQUEST, HTTP_200_OK
|
||||
|
||||
from base import constants
|
||||
from base.constants import NUMBER
|
||||
# local import
|
||||
from zod_bank.settings import base_settings as settings
|
||||
from zod_bank.settings.base_settings import BASE_DIR
|
||||
|
||||
|
||||
def image_upload(folder, file_name, data):
|
||||
"""
|
||||
Function to upload files
|
||||
:param folder:folder location string
|
||||
:param file_name:file_name without ext string
|
||||
:param data:data file obj
|
||||
:return:Dictionary
|
||||
"""
|
||||
status = HTTP_400_BAD_REQUEST
|
||||
img_name = None
|
||||
error = None
|
||||
try:
|
||||
s3_client = boto3.client('s3',
|
||||
aws_access_key_id=settings.AWS_ACCESS_KEY,
|
||||
aws_secret_access_key=settings.AWS_SECRET_ACCESS_KEY,
|
||||
region_name=settings.AWS_DEFAULT_REGION
|
||||
)
|
||||
|
||||
bucket_name = settings.BUCKET_NAME
|
||||
MEDIA_ROOT = os.path.join(BASE_DIR, 'media/tmp')
|
||||
fss = FileSystemStorage()
|
||||
file = fss.save('tmp/' + str(file_name), data)
|
||||
fss.url(file)
|
||||
tmp_file = os.path.join(MEDIA_ROOT, str(file_name))
|
||||
s3_client.upload_file(
|
||||
tmp_file, bucket_name, folder + str(file_name),
|
||||
ExtraArgs={'ACL': 'public-read', 'ContentType': data.content_type}
|
||||
)
|
||||
os.unlink(tmp_file)
|
||||
img_name = file_name
|
||||
status = HTTP_200_OK
|
||||
except Exception as e:
|
||||
error = e
|
||||
logging.error(e)
|
||||
return status, error, img_name
|
||||
|
||||
|
||||
def file_delete(folder, file_name):
|
||||
"""
|
||||
To delete common file
|
||||
:param folder: folder name str
|
||||
:param file_name: file_name string type
|
||||
"""
|
||||
status = HTTP_400_BAD_REQUEST
|
||||
error = None
|
||||
try:
|
||||
s3_client = boto3.client('s3',
|
||||
aws_access_key_id=settings.AWS_ACCESS_KEY,
|
||||
aws_secret_access_key=settings.AWS_SECRET_ACCESS_KEY,
|
||||
region_name=settings.AWS_DEFAULT_REGION
|
||||
)
|
||||
|
||||
s3_client.delete_object(Bucket=settings.BUCKET_NAME, Key=str(folder) + str(file_name))
|
||||
status = HTTP_200_OK
|
||||
except Exception as e:
|
||||
error = e
|
||||
return status, error
|
||||
|
||||
|
||||
def get_aws_obj(folder, file_name):
|
||||
"""
|
||||
To get aws file obj
|
||||
:param folder: folder string type
|
||||
:param file_name: file_name string type
|
||||
"""
|
||||
status = HTTP_400_BAD_REQUEST
|
||||
obj = None
|
||||
try:
|
||||
s3_client = boto3.client('s3',
|
||||
aws_access_key_id=settings.AWS_ACCESS_KEY,
|
||||
aws_secret_access_key=settings.AWS_SECRET_ACCESS_KEY,
|
||||
region_name=settings.AWS_DEFAULT_REGION
|
||||
)
|
||||
file_name = folder + file_name
|
||||
obj = s3_client.get_object(Bucket=settings.BUCKET_NAME, Key=file_name)
|
||||
status = HTTP_200_OK
|
||||
except Exception as e:
|
||||
logging.error(e)
|
||||
return status, obj
|
||||
|
||||
|
||||
def upload_image(post_data, folder):
|
||||
"""
|
||||
:param post_data:
|
||||
:param folder: string type
|
||||
:return:
|
||||
"""
|
||||
upload_obj = None
|
||||
# Check Post data
|
||||
if post_data:
|
||||
date_now = datetime.datetime.now()
|
||||
file_extension = os.path.splitext(str(post_data.name))
|
||||
file_extension = file_extension[constants.NUMBER['one']].split(".")[constants.NUMBER['one']].lower()
|
||||
rand = get_random_string(NUMBER['twelve'])
|
||||
image_name = str(rand) + date_now.strftime("%s") + "." + file_extension
|
||||
upload_obj = image_upload(folder, image_name, post_data)
|
||||
return upload_obj
|
||||
|
||||
|
||||
def upload_voice_kit_image(post_data, folder, image_dir):
|
||||
"""
|
||||
:param post_data:
|
||||
:param folder: string type
|
||||
:param image_dir: image_dir
|
||||
:return:
|
||||
"""
|
||||
upload_obj = None
|
||||
# Check Post data
|
||||
if post_data:
|
||||
date_now = datetime.datetime.now()
|
||||
file_extension = os.path.splitext(str(post_data))
|
||||
file_extension = file_extension[constants.NUMBER['one']].split(".")[constants.NUMBER['one']].lower()
|
||||
rand = get_random_string(NUMBER['twelve'])
|
||||
image_name = str(rand) + date_now.strftime("%s") + "." + file_extension
|
||||
upload_obj = voice_kit_image_upload(folder, image_name, post_data, image_dir)
|
||||
return upload_obj
|
||||
|
||||
|
||||
def voice_kit_image_upload(folder, file_name, data, image_dir):
|
||||
"""
|
||||
Function to upload files
|
||||
:param folder:folder location string
|
||||
:param file_name:file_name without ext string
|
||||
:param data:data file obj
|
||||
:return:Dictionary
|
||||
"""
|
||||
status = HTTP_400_BAD_REQUEST
|
||||
img_name = None
|
||||
error = None
|
||||
try:
|
||||
s3_client = boto3.client('s3',
|
||||
aws_access_key_id=settings.AWS_ACCESS_KEY,
|
||||
aws_secret_access_key=settings.AWS_SECRET_ACCESS_KEY,
|
||||
region_name=settings.AWS_DEFAULT_REGION
|
||||
)
|
||||
|
||||
bucket_name = settings.BUCKET_NAME
|
||||
MEDIA_ROOT = os.path.join(BASE_DIR, 'media/tmp')
|
||||
fss = FileSystemStorage()
|
||||
with open(image_dir+data, 'rb') as f:
|
||||
file = fss.save('tmp/' + str(file_name), f)
|
||||
fss.url(file)
|
||||
tmp_file = os.path.join(MEDIA_ROOT, str(file_name))
|
||||
s3_client.upload_file(
|
||||
tmp_file, bucket_name, folder + str(file_name),
|
||||
ExtraArgs={'ACL': 'public-read', 'ContentType': mimetypes.guess_type(file_name)[0]}
|
||||
)
|
||||
os.unlink(tmp_file)
|
||||
img_name = file_name
|
||||
status = HTTP_200_OK
|
||||
except Exception as e:
|
||||
error = e
|
||||
logging.error(e)
|
||||
return status, error, img_name
|
||||
|
||||
@@ -0,0 +1,18 @@
|
||||
version: '3'
|
||||
services:
|
||||
nginx:
|
||||
image: nginx:latest
|
||||
container_name: nginx
|
||||
ports:
|
||||
- "8000:8000"
|
||||
volumes:
|
||||
- ./nginx:/etc/nginx/conf.d
|
||||
- .:/usr/src/app
|
||||
depends_on:
|
||||
- web
|
||||
web:
|
||||
build: .
|
||||
container_name: django
|
||||
command: bash -c "pip install -r requirements.txt && python manage.py collectstatic --noinput && python manage.py migrate && gunicorn zod_bank.wsgi -b 0.0.0.0:8000 -t 300 --log-level=info"
|
||||
volumes:
|
||||
- .:/usr/src/app
|
||||
@@ -0,0 +1,14 @@
|
||||
"""Guardian admin"""
|
||||
"""Third party Django app"""
|
||||
from django.contrib import admin
|
||||
"""Import Django app"""
|
||||
from .models import Guardian
|
||||
# Register your models here.
|
||||
@admin.register(Guardian)
|
||||
class GuardianAdmin(admin.ModelAdmin):
|
||||
"""Junior Admin"""
|
||||
list_display = ['user', 'family_name']
|
||||
|
||||
def __str__(self):
|
||||
"""Return email id"""
|
||||
return self.user__email
|
||||
@@ -0,0 +1,9 @@
|
||||
"""Guardian app file"""
|
||||
"""Third party Django app"""
|
||||
from django.apps import AppConfig
|
||||
|
||||
|
||||
class CustodianConfig(AppConfig):
|
||||
"""Guardian config"""
|
||||
default_auto_field = 'django.db.models.BigAutoField'
|
||||
name = 'guardian'
|
||||
@@ -0,0 +1,43 @@
|
||||
# Generated by Django 4.2.2 on 2023-06-23 12:05
|
||||
|
||||
from django.conf import settings
|
||||
import django.contrib.postgres.fields
|
||||
from django.db import migrations, models
|
||||
import django.db.models.deletion
|
||||
|
||||
|
||||
class Migration(migrations.Migration):
|
||||
|
||||
initial = True
|
||||
|
||||
dependencies = [
|
||||
migrations.swappable_dependency(settings.AUTH_USER_MODEL),
|
||||
]
|
||||
|
||||
operations = [
|
||||
migrations.CreateModel(
|
||||
name='Guardian',
|
||||
fields=[
|
||||
('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
|
||||
('country_code', models.IntegerField(blank=True, null=True)),
|
||||
('phone', models.CharField(blank=True, default=None, max_length=31, null=True)),
|
||||
('family_name', models.CharField(blank=True, default=None, max_length=50, null=True)),
|
||||
('gender', models.CharField(blank=True, choices=[('1', 'Male'), ('2', 'Female')], default=None, max_length=15, null=True)),
|
||||
('dob', models.DateField(blank=True, default=None, max_length=15, null=True)),
|
||||
('guardian_code', models.CharField(blank=True, default=None, max_length=10, null=True)),
|
||||
('junior_code', django.contrib.postgres.fields.ArrayField(base_field=models.CharField(blank=True, default=None, max_length=10, null=True), null=True, size=None)),
|
||||
('referral_code', models.CharField(blank=True, default=None, max_length=10, null=True)),
|
||||
('referral_code_used', models.CharField(blank=True, default=None, max_length=10, null=True)),
|
||||
('is_active', models.BooleanField(default=True)),
|
||||
('is_complete_profile', models.BooleanField(default=False)),
|
||||
('passcode', models.IntegerField(blank=True, default=None, null=True)),
|
||||
('created_at', models.DateTimeField(auto_now_add=True)),
|
||||
('updated_at', models.DateTimeField(auto_now=True)),
|
||||
('user', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='guardian_profile', to=settings.AUTH_USER_MODEL, verbose_name='Email')),
|
||||
],
|
||||
options={
|
||||
'verbose_name': 'Guardian',
|
||||
'db_table': 'guardians',
|
||||
},
|
||||
),
|
||||
]
|
||||
@@ -0,0 +1,17 @@
|
||||
# Generated by Django 4.2.2 on 2023-06-27 06:15
|
||||
|
||||
from django.db import migrations
|
||||
|
||||
|
||||
class Migration(migrations.Migration):
|
||||
|
||||
dependencies = [
|
||||
('guardian', '0001_initial'),
|
||||
]
|
||||
|
||||
operations = [
|
||||
migrations.RemoveField(
|
||||
model_name='guardian',
|
||||
name='junior_code',
|
||||
),
|
||||
]
|
||||
@@ -0,0 +1,39 @@
|
||||
"""Guardian model file"""
|
||||
"""Third party Django app"""
|
||||
from django.db import models
|
||||
from django.contrib.auth import get_user_model
|
||||
"""Import Django app"""
|
||||
from base.constants import GENDERS
|
||||
User = get_user_model()
|
||||
# Create your models here.
|
||||
|
||||
class Guardian(models.Model):
|
||||
"""Guardian model"""
|
||||
user = models.ForeignKey(User, on_delete=models.CASCADE, related_name='guardian_profile', verbose_name='Email')
|
||||
"""Contact details"""
|
||||
country_code = models.IntegerField(blank=True, null=True)
|
||||
phone = models.CharField(max_length=31, null=True, blank=True, default=None)
|
||||
"""Personal info"""
|
||||
family_name = models.CharField(max_length=50, null=True, blank=True, default=None)
|
||||
gender = models.CharField(choices=GENDERS, max_length=15, null=True, blank=True, default=None)
|
||||
dob = models.DateField(max_length=15, null=True, blank=True, default=None)
|
||||
"""Codes"""
|
||||
guardian_code = models.CharField(max_length=10, null=True, blank=True, default=None)
|
||||
referral_code = models.CharField(max_length=10, null=True, blank=True, default=None)
|
||||
referral_code_used = models.CharField(max_length=10, null=True, blank=True, default=None)
|
||||
"""Profile activity"""
|
||||
is_active = models.BooleanField(default=True)
|
||||
is_complete_profile = models.BooleanField(default=False)
|
||||
passcode = models.IntegerField(null=True, blank=True, default=None)
|
||||
"""Profile created and updated time"""
|
||||
created_at = models.DateTimeField(auto_now_add=True)
|
||||
updated_at = models.DateTimeField(auto_now=True)
|
||||
|
||||
class Meta(object):
|
||||
""" Meta class """
|
||||
db_table = 'guardians'
|
||||
verbose_name = 'Guardian'
|
||||
|
||||
def __str__(self):
|
||||
"""Return email id"""
|
||||
return f'{self.user}'
|
||||
@@ -0,0 +1,116 @@
|
||||
"""Serializer of Guardian"""
|
||||
"""Third party Django app"""
|
||||
import logging
|
||||
import random
|
||||
from rest_framework import serializers
|
||||
from rest_framework_simplejwt.tokens import RefreshToken
|
||||
from django.db import transaction
|
||||
from django.contrib.auth.models import User
|
||||
"""Import Django app"""
|
||||
from .models import Guardian
|
||||
from account.models import UserProfile
|
||||
from base.messages import ERROR_CODE, SUCCESS_CODE
|
||||
class UserSerializer(serializers.ModelSerializer):
|
||||
"""User serializer"""
|
||||
auth_token = serializers.SerializerMethodField('get_auth_token')
|
||||
|
||||
class Meta(object):
|
||||
"""Meta info"""
|
||||
model = User
|
||||
fields = ['email', 'password', 'auth_token']
|
||||
|
||||
def get_auth_token(self, obj):
|
||||
"""generate auth token"""
|
||||
refresh = RefreshToken.for_user(obj)
|
||||
access_token = str(refresh.access_token)
|
||||
return access_token
|
||||
def create(self, validated_data):
|
||||
"""fetch data"""
|
||||
email = validated_data.get('email')
|
||||
user_type = self.context
|
||||
password = validated_data.get('password')
|
||||
try:
|
||||
"""Create user profile"""
|
||||
user = User.objects.create_user(username=email, email=email, password=password)
|
||||
UserProfile.objects.create(user=user, user_type=user_type)
|
||||
return user
|
||||
except Exception as e:
|
||||
"""Error handling"""
|
||||
logging.error(e)
|
||||
raise serializers.ValidationError({"details":ERROR_CODE['2021']})
|
||||
|
||||
def save(self, **kwargs):
|
||||
"""save the data"""
|
||||
with transaction.atomic():
|
||||
instance = super().save(**kwargs)
|
||||
return instance
|
||||
|
||||
class CreateGuardianSerializer(serializers.ModelSerializer):
|
||||
"""Create guardian serializer"""
|
||||
"""Basic info"""
|
||||
first_name = serializers.SerializerMethodField('get_first_name')
|
||||
last_name = serializers.SerializerMethodField('get_last_name')
|
||||
email = serializers.SerializerMethodField('get_email')
|
||||
"""Contact details"""
|
||||
phone = serializers.CharField(max_length=20, required=False)
|
||||
country_code = serializers.IntegerField(required=False)
|
||||
family_name = serializers.CharField(max_length=100, required=False)
|
||||
dob = serializers.DateField(required=False)
|
||||
referral_code = serializers.CharField(max_length=100, required=False)
|
||||
|
||||
class Meta(object):
|
||||
"""Meta info"""
|
||||
model = Guardian
|
||||
fields = ['first_name', 'last_name', 'email', 'phone', 'family_name', 'gender', 'country_code',
|
||||
'dob', 'referral_code', 'passcode', 'is_complete_profile']
|
||||
|
||||
def get_first_name(self,obj):
|
||||
"""first name of guardian"""
|
||||
return obj.user.first_name
|
||||
|
||||
def get_last_name(self,obj):
|
||||
"""last name of guardian"""
|
||||
return obj.user.last_name
|
||||
|
||||
def get_email(self,obj):
|
||||
"""emailof guardian"""
|
||||
return obj.user.email
|
||||
|
||||
def create(self, validated_data):
|
||||
"""Create guardian profile"""
|
||||
user = User.objects.filter(username=self.context['user']).last()
|
||||
if user:
|
||||
"""Save first and last name of guardian"""
|
||||
user.first_name = self.context.get('first_name', user.first_name)
|
||||
user.last_name = self.context.get('last_name', user.last_name)
|
||||
user.save()
|
||||
"""Create guardian data"""
|
||||
guardian, created = Guardian.objects.get_or_create(user=self.context['user'])
|
||||
if created:
|
||||
"""Create referral code and guardian code"""
|
||||
guardian.referral_code = ''.join([str(random.randrange(9)) for _ in range(4)])
|
||||
guardian.guardian_code = ''.join([str(random.randrange(9)) for _ in range(4)])
|
||||
if guardian:
|
||||
"""update details according to the data get from request"""
|
||||
guardian.gender = validated_data.get('gender',guardian.gender)
|
||||
guardian.family_name = validated_data.get('family_name', guardian.family_name)
|
||||
guardian.dob = validated_data.get('dob',guardian.dob)
|
||||
"""Update country code and phone number"""
|
||||
guardian.phone = validated_data.get('phone', guardian.phone)
|
||||
guardian.country_code = validated_data.get('country_code', guardian.country_code)
|
||||
guardian.passcode = validated_data.get('passcode', guardian.passcode)
|
||||
guardian.referral_code_used = validated_data.get('referral_code_used', guardian.referral_code_used)
|
||||
"""Complete profile of the junior if below all data are filled"""
|
||||
complete_profile_field = all([guardian.phone, guardian.gender, guardian.family_name,
|
||||
guardian.dob, guardian.country_code, user.first_name, user.last_name])
|
||||
guardian.is_complete_profile = False
|
||||
if complete_profile_field:
|
||||
guardian.is_complete_profile = True
|
||||
guardian.save()
|
||||
return guardian
|
||||
|
||||
def save(self, **kwargs):
|
||||
"""Save the data into junior table"""
|
||||
with transaction.atomic():
|
||||
instance = super().save(**kwargs)
|
||||
return instance
|
||||
@@ -0,0 +1,6 @@
|
||||
"""task files"""
|
||||
"""Django import"""
|
||||
import random
|
||||
def generate_otp():
|
||||
"""generate random otp"""
|
||||
return ''.join([str(random.randrange(9)) for _ in range(6)])
|
||||
@@ -0,0 +1,5 @@
|
||||
"""Test file of Guardian"""
|
||||
"""Third party Django app"""
|
||||
from django.test import TestCase
|
||||
|
||||
# Create your tests here.
|
||||
@@ -0,0 +1,19 @@
|
||||
""" Urls files"""
|
||||
"""Django import"""
|
||||
from django.urls import path, include
|
||||
from .views import SignupViewset, UpdateGuardianProfile
|
||||
"""Third party import"""
|
||||
from rest_framework import routers
|
||||
|
||||
"""Define Router"""
|
||||
router = routers.SimpleRouter()
|
||||
|
||||
"""API End points with router"""
|
||||
"""Sign up API"""
|
||||
router.register('sign-up', SignupViewset, basename='sign-up')
|
||||
"""Create guardian profile API"""
|
||||
router.register('create-guardian-profile', UpdateGuardianProfile, basename='update-guardian-profile')
|
||||
"""Define Url pattern"""
|
||||
urlpatterns = [
|
||||
path('api/v1/', include(router.urls)),
|
||||
]
|
||||
@@ -0,0 +1,47 @@
|
||||
"""Views of Guardian"""
|
||||
"""Third party Django app"""
|
||||
from rest_framework.permissions import IsAuthenticated
|
||||
from rest_framework import viewsets, status
|
||||
"""Import Django app"""
|
||||
from .serializers import UserSerializer
|
||||
from .serializers import CreateGuardianSerializer
|
||||
from account.models import UserEmailOtp
|
||||
from .tasks import generate_otp
|
||||
from account.utils import send_otp_email
|
||||
from account.utils import custom_response, custom_error_response
|
||||
from base.messages import ERROR_CODE, SUCCESS_CODE
|
||||
# Create your views here.
|
||||
class SignupViewset(viewsets.ModelViewSet):
|
||||
"""Signup view set"""
|
||||
serializer_class = UserSerializer
|
||||
|
||||
def create(self, request, *args, **kwargs):
|
||||
"""Create user profile"""
|
||||
serializer = UserSerializer(context=request.data['user_type'], data=request.data)
|
||||
if serializer.is_valid():
|
||||
serializer.save()
|
||||
"""Generate otp"""
|
||||
otp = generate_otp()
|
||||
UserEmailOtp.objects.create(email=request.data['email'], otp=otp)
|
||||
"""Send email to the register user"""
|
||||
send_otp_email(request.data['email'], otp)
|
||||
return custom_response(SUCCESS_CODE['3001'], {"email_otp": otp},
|
||||
response_status=status.HTTP_200_OK)
|
||||
return custom_error_response(serializer.errors, response_status=status.HTTP_400_BAD_REQUEST)
|
||||
|
||||
class UpdateGuardianProfile(viewsets.ViewSet):
|
||||
"""Update guardian profile"""
|
||||
serializer_class = CreateGuardianSerializer
|
||||
permission_classes = [IsAuthenticated]
|
||||
|
||||
def create(self, request, *args, **kwargs):
|
||||
"""Create guardian profile"""
|
||||
serializer = CreateGuardianSerializer(context={"user":request.user,
|
||||
"first_name":request.data.get('first_name', ''),
|
||||
"last_name": request.data.get('last_name',' ')},
|
||||
data=request.data)
|
||||
if serializer.is_valid():
|
||||
"""save serializer"""
|
||||
serializer.save()
|
||||
return custom_response(None, serializer.data,response_status=status.HTTP_200_OK)
|
||||
return custom_error_response(serializer.errors, response_status=status.HTTP_400_BAD_REQUEST)
|
||||
@@ -1,35 +0,0 @@
|
||||
import type { Config as JestConfig } from 'jest';
|
||||
import { pathsToModuleNameMapper } from 'ts-jest';
|
||||
import { compilerOptions as tsConfigCompilerOptions } from './tsconfig.json';
|
||||
|
||||
type ArrayElement<A> = A extends readonly (infer T)[] ? T : never;
|
||||
type JestProjectConfig = Exclude<ArrayElement<JestConfig['projects']>, string>;
|
||||
|
||||
const baseJestConfig: JestConfig = {
|
||||
// ...
|
||||
};
|
||||
const baseJestProjectConfig: JestProjectConfig = {
|
||||
testEnvironment: 'node',
|
||||
transform: {
|
||||
'^.+\\.(t|j)s$': 'ts-jest',
|
||||
},
|
||||
moduleNameMapper: pathsToModuleNameMapper(tsConfigCompilerOptions.paths, { prefix: '<rootDir>' }),
|
||||
globalSetup: '<rootDir>/test/global-setup.ts',
|
||||
};
|
||||
const projects: { name?: string; rootDir: string }[] = [{ rootDir: '.' }];
|
||||
|
||||
export function buildJestConfig(config?: {
|
||||
jestConfigs?: JestConfig;
|
||||
jestProjectConfigs?: JestProjectConfig;
|
||||
}): JestConfig {
|
||||
return {
|
||||
...baseJestConfig,
|
||||
...config?.jestConfigs,
|
||||
projects: projects.map(({ name, rootDir }) => ({
|
||||
...baseJestProjectConfig,
|
||||
...config?.jestProjectConfigs,
|
||||
...(name && { displayName: name }),
|
||||
rootDir,
|
||||
})),
|
||||
};
|
||||
}
|
||||
@@ -1,16 +0,0 @@
|
||||
import type { Config } from 'jest';
|
||||
import { buildJestConfig } from './jest.base.config';
|
||||
|
||||
const config: Config = buildJestConfig({
|
||||
jestProjectConfigs: {
|
||||
testRegex: '.*\\.spec\\.ts$',
|
||||
coveragePathIgnorePatterns: ['__testing__', 'entities', '<rootDir>/src/db', 'index.ts'],
|
||||
},
|
||||
jestConfigs: {
|
||||
coverageDirectory: 'coverage',
|
||||
collectCoverageFrom: ['<rootDir>/src/**/*.(t|j)s'],
|
||||
coverageReporters: ['clover', 'json', 'lcov', 'text', 'text-summary', 'cobertura'],
|
||||
},
|
||||
});
|
||||
|
||||
export default config;
|
||||
@@ -0,0 +1,14 @@
|
||||
"""Junior admin"""
|
||||
"""Third party Django app"""
|
||||
from django.contrib import admin
|
||||
"""Import Django app"""
|
||||
from .models import Junior
|
||||
# Register your models here.
|
||||
@admin.register(Junior)
|
||||
class JuniorAdmin(admin.ModelAdmin):
|
||||
"""Junior Admin"""
|
||||
list_display = ['auth']
|
||||
|
||||
def __str__(self):
|
||||
"""Return email id"""
|
||||
return self.auth__email
|
||||
@@ -0,0 +1,8 @@
|
||||
"""App file"""
|
||||
"""Import AppConfig"""
|
||||
from django.apps import AppConfig
|
||||
|
||||
class JuniorConfig(AppConfig):
|
||||
"""Junior config"""
|
||||
default_auto_field = 'django.db.models.BigAutoField'
|
||||
name = 'junior'
|
||||
@@ -0,0 +1,42 @@
|
||||
# Generated by Django 4.2.2 on 2023-06-23 12:05
|
||||
|
||||
from django.conf import settings
|
||||
import django.contrib.postgres.fields
|
||||
from django.db import migrations, models
|
||||
import django.db.models.deletion
|
||||
|
||||
|
||||
class Migration(migrations.Migration):
|
||||
|
||||
initial = True
|
||||
|
||||
dependencies = [
|
||||
migrations.swappable_dependency(settings.AUTH_USER_MODEL),
|
||||
]
|
||||
|
||||
operations = [
|
||||
migrations.CreateModel(
|
||||
name='Junior',
|
||||
fields=[
|
||||
('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
|
||||
('phone', models.CharField(blank=True, default=None, max_length=31, null=True)),
|
||||
('country_code', models.IntegerField(blank=True, null=True)),
|
||||
('gender', models.CharField(blank=True, choices=[('1', 'Male'), ('2', 'Female')], default=None, max_length=10, null=True)),
|
||||
('dob', models.DateField(blank=True, default=None, max_length=15, null=True)),
|
||||
('junior_code', models.CharField(blank=True, default=None, max_length=10, null=True)),
|
||||
('guardian_code', django.contrib.postgres.fields.ArrayField(base_field=models.CharField(blank=True, default=None, max_length=10, null=True), null=True, size=None)),
|
||||
('referral_code', models.CharField(blank=True, default=None, max_length=10, null=True)),
|
||||
('referral_code_used', models.CharField(blank=True, default=None, max_length=10, null=True)),
|
||||
('is_active', models.BooleanField(default=True)),
|
||||
('is_complete_profile', models.BooleanField(default=False)),
|
||||
('passcode', models.IntegerField(blank=True, default=None, null=True)),
|
||||
('created_at', models.DateTimeField(auto_now_add=True)),
|
||||
('updated_at', models.DateTimeField(auto_now=True)),
|
||||
('auth', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='junior_profile', to=settings.AUTH_USER_MODEL, verbose_name='Email')),
|
||||
],
|
||||
options={
|
||||
'verbose_name': 'Junior',
|
||||
'db_table': 'junior',
|
||||
},
|
||||
),
|
||||
]
|
||||
@@ -0,0 +1,41 @@
|
||||
"""Junior model """
|
||||
"""Import django"""
|
||||
from django.db import models
|
||||
from django.contrib.auth import get_user_model
|
||||
from django.contrib.postgres.fields import ArrayField
|
||||
"""Import django app"""
|
||||
from base.constants import GENDERS
|
||||
User = get_user_model()
|
||||
# Create your models here.
|
||||
|
||||
class Junior(models.Model):
|
||||
"""Junior model"""
|
||||
auth = models.ForeignKey(User, on_delete=models.CASCADE, related_name='junior_profile', verbose_name='Email')
|
||||
"""Contact details"""
|
||||
phone = models.CharField(max_length=31, null=True, blank=True, default=None)
|
||||
country_code = models.IntegerField(blank=True, null=True)
|
||||
"""Personal info"""
|
||||
gender = models.CharField(max_length=10, choices=GENDERS, null=True, blank=True, default=None)
|
||||
dob = models.DateField(max_length=15, null=True, blank=True, default=None)
|
||||
# image = models.ImageField(upload_to='images/')
|
||||
"""Codes"""
|
||||
junior_code = models.CharField(max_length=10, null=True, blank=True, default=None)
|
||||
guardian_code = ArrayField(models.CharField(max_length=10, null=True, blank=True, default=None),null=True)
|
||||
referral_code = models.CharField(max_length=10, null=True, blank=True, default=None)
|
||||
referral_code_used = models.CharField(max_length=10, null=True, blank=True, default=None)
|
||||
"""Profile activity"""
|
||||
is_active = models.BooleanField(default=True)
|
||||
is_complete_profile = models.BooleanField(default=False)
|
||||
passcode = models.IntegerField(null=True, blank=True, default=None)
|
||||
"""Profile created and updated time"""
|
||||
created_at = models.DateTimeField(auto_now_add=True)
|
||||
updated_at = models.DateTimeField(auto_now=True)
|
||||
|
||||
class Meta(object):
|
||||
""" Meta class """
|
||||
db_table = 'junior'
|
||||
verbose_name = 'Junior'
|
||||
|
||||
def __str__(self):
|
||||
"""Return email id"""
|
||||
return f'{self.auth}'
|
||||
@@ -0,0 +1,92 @@
|
||||
"""Serializer file for junior"""
|
||||
"""Import Django 3rd party app"""
|
||||
from rest_framework import serializers
|
||||
from django.contrib.auth.models import User
|
||||
from django.db import transaction
|
||||
import random
|
||||
"""Import django app"""
|
||||
from junior.models import Junior
|
||||
|
||||
class ListCharField(serializers.ListField):
|
||||
"""Serializer for Array field"""
|
||||
child = serializers.CharField()
|
||||
|
||||
def to_representation(self, data):
|
||||
"""to represent the data"""
|
||||
return data
|
||||
|
||||
def to_internal_value(self, data):
|
||||
"""internal value"""
|
||||
if isinstance(data, list):
|
||||
return data
|
||||
raise serializers.ValidationError({"details":"Invalid input. Expected a list of strings."})
|
||||
|
||||
|
||||
class CreateJuniorSerializer(serializers.ModelSerializer):
|
||||
"""Create junior serializer"""
|
||||
first_name = serializers.SerializerMethodField('get_first_name')
|
||||
last_name = serializers.SerializerMethodField('get_last_name')
|
||||
email = serializers.SerializerMethodField('get_email')
|
||||
phone = serializers.CharField(max_length=20, required=False)
|
||||
country_code = serializers.IntegerField(required=False)
|
||||
dob = serializers.DateField(required=False)
|
||||
referral_code = serializers.CharField(max_length=100, required=False)
|
||||
guardian_code = ListCharField(required=False)
|
||||
|
||||
class Meta(object):
|
||||
"""Meta info"""
|
||||
model = Junior
|
||||
fields = ['first_name', 'last_name', 'email', 'phone', 'gender', 'country_code', 'dob', 'referral_code',
|
||||
'passcode', 'is_complete_profile', 'guardian_code']
|
||||
|
||||
def get_first_name(self,obj):
|
||||
"""first name of junior"""
|
||||
return obj.auth.first_name
|
||||
|
||||
def get_last_name(self,obj):
|
||||
"""last name of junior"""
|
||||
return obj.auth.last_name
|
||||
|
||||
def get_email(self,obj):
|
||||
"""email of junior"""
|
||||
return obj.auth.email
|
||||
|
||||
def create(self, validated_data):
|
||||
"""Create junior profile"""
|
||||
user = User.objects.filter(username=self.context['user']).last()
|
||||
if user:
|
||||
"""Save first and last name of junior"""
|
||||
user.first_name = self.context.get('first_name', user.first_name)
|
||||
user.last_name = self.context.get('last_name', user.last_name)
|
||||
user.save()
|
||||
"""Create junior data"""
|
||||
junior, created = Junior.objects.get_or_create(auth=self.context['user'])
|
||||
if created:
|
||||
"""Create referral code and junior code"""
|
||||
junior.referral_code = ''.join([str(random.randrange(9)) for _ in range(4)])
|
||||
junior.junior_code = ''.join([str(random.randrange(9)) for _ in range(4)])
|
||||
if junior:
|
||||
"""update details according to the data get from request"""
|
||||
junior.gender = validated_data.get('gender',junior.gender)
|
||||
"""Update guardian code"""
|
||||
junior.guardian_code = validated_data.get('guardian_code', junior.guardian_code)
|
||||
junior.dob = validated_data.get('dob',junior.dob)
|
||||
junior.passcode = validated_data.get('passcode', junior.passcode)
|
||||
"""Update country code and phone number"""
|
||||
junior.phone = validated_data.get('phone', junior.phone)
|
||||
junior.country_code = validated_data.get('country_code', junior.country_code)
|
||||
junior.referral_code_used = validated_data.get('referral_code_used', junior.referral_code_used)
|
||||
"""Complete profile of the junior if below all data are filled"""
|
||||
complete_profile_field = all([junior.phone, junior.gender, junior.family_name,
|
||||
junior.dob, junior.country_code, user.first_name, user.last_name])
|
||||
junior.is_complete_profile = False
|
||||
if complete_profile_field:
|
||||
junior.is_complete_profile = True
|
||||
junior.save()
|
||||
return junior
|
||||
|
||||
def save(self, **kwargs):
|
||||
"""Save the data into junior table"""
|
||||
with transaction.atomic():
|
||||
instance = super().save(**kwargs)
|
||||
return instance
|
||||
@@ -0,0 +1,5 @@
|
||||
"""Junior test file"""
|
||||
"""Import TestCase"""
|
||||
from django.test import TestCase
|
||||
|
||||
# Create your tests here.
|
||||
@@ -0,0 +1,19 @@
|
||||
""" Urls files"""
|
||||
"""Django import"""
|
||||
from django.urls import path, include
|
||||
from .views import UpdateJuniorProfile, ValidateGuardianCode
|
||||
"""Third party import"""
|
||||
from rest_framework import routers
|
||||
|
||||
"""Router"""
|
||||
router = routers.SimpleRouter()
|
||||
|
||||
"""API End points with router"""
|
||||
"""Create junior profile API"""
|
||||
router.register('create-junior-profile', UpdateJuniorProfile, basename='profile-update')
|
||||
"""validate guardian code API"""
|
||||
router.register('validate-guardian-code', ValidateGuardianCode, basename='validate-guardian-code')
|
||||
"""Define url pattern"""
|
||||
urlpatterns = [
|
||||
path('api/v1/', include(router.urls)),
|
||||
]
|
||||
@@ -0,0 +1,40 @@
|
||||
"""Junior view file"""
|
||||
from rest_framework import viewsets, status
|
||||
from rest_framework.permissions import IsAuthenticated
|
||||
"""Django app import"""
|
||||
from junior.models import Junior
|
||||
from .serializers import CreateJuniorSerializer
|
||||
from guardian.models import Guardian
|
||||
from base.messages import ERROR_CODE, SUCCESS_CODE
|
||||
from account.utils import custom_response, custom_error_response
|
||||
# Create your views here.
|
||||
class UpdateJuniorProfile(viewsets.ViewSet):
|
||||
"""Update junior profile"""
|
||||
serializer_class = CreateJuniorSerializer
|
||||
permission_classes = [IsAuthenticated]
|
||||
|
||||
def create(self, request, *args, **kwargs):
|
||||
"""Use CreateJuniorSerializer"""
|
||||
serializer = CreateJuniorSerializer(context={"user":request.user,
|
||||
"first_name":request.data.get('first_name', ''),
|
||||
"last_name": request.data.get('last_name',' ')},
|
||||
data=request.data)
|
||||
if serializer.is_valid():
|
||||
"""save serializer"""
|
||||
serializer.save()
|
||||
return custom_response(None, serializer.data, response_status=status.HTTP_200_OK)
|
||||
return custom_error_response(serializer.errors, response_status=status.HTTP_400_BAD_REQUEST)
|
||||
|
||||
class ValidateGuardianCode(viewsets.ViewSet):
|
||||
"""Check guardian code exist or not"""
|
||||
permission_classes = [IsAuthenticated]
|
||||
|
||||
def list(self, request, *args, **kwargs):
|
||||
"""check guardian code"""
|
||||
guardian_code = self.request.GET.get('guardian_code').split(',')
|
||||
for code in guardian_code:
|
||||
guardian_data = Guardian.objects.filter(guardian_code=code).exists()
|
||||
if guardian_data:
|
||||
return custom_response(SUCCESS_CODE['3013'], response_status=status.HTTP_200_OK)
|
||||
else:
|
||||
return custom_error_response(ERROR_CODE["2022"], response_status=status.HTTP_400_BAD_REQUEST)
|
||||
@@ -0,0 +1,25 @@
|
||||
#!/usr/bin/env python
|
||||
"""Django's command-line utility for administrative tasks."""
|
||||
"""Django import"""
|
||||
import os
|
||||
import sys
|
||||
|
||||
|
||||
def main():
|
||||
"""Main function"""
|
||||
os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'zod_bank.settings')
|
||||
try:
|
||||
"""Import execute from command line function"""
|
||||
from django.core.management import execute_from_command_line
|
||||
except ImportError as exc:
|
||||
"""Show Exception error"""
|
||||
raise ImportError(
|
||||
"Couldn't import Django. Are you sure it's installed and "
|
||||
"available on your PYTHONPATH environment variable? Did you "
|
||||
"forget to activate a virtual environment?"
|
||||
) from exc
|
||||
execute_from_command_line(sys.argv)
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
main()
|
||||
@@ -1,19 +0,0 @@
|
||||
{
|
||||
"$schema": "https://json.schemastore.org/nest-cli",
|
||||
"collection": "@nestjs/schematics",
|
||||
"sourceRoot": "src",
|
||||
"compilerOptions": {
|
||||
"deleteOutDir": true,
|
||||
"watchAssets": true,
|
||||
"assets": [
|
||||
{
|
||||
"include": "config",
|
||||
"exclude": "**/*.md"
|
||||
},
|
||||
{ "include": "common/modules/**/templates/**/*", "watchAssets": true },
|
||||
{ "include": "common/modules/neoleap/zod-certs" },
|
||||
"i18n",
|
||||
"files"
|
||||
]
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,24 @@
|
||||
upstream web {
|
||||
ip_hash;
|
||||
server web:8000;
|
||||
}
|
||||
|
||||
# portal
|
||||
server {
|
||||
location / {
|
||||
proxy_pass http://web/;
|
||||
proxy_set_header Host $http_host;
|
||||
}
|
||||
listen 8000;
|
||||
client_max_body_size 512M;
|
||||
server_name localhost;
|
||||
proxy_read_timeout 900;
|
||||
proxy_connect_timeout 900;
|
||||
proxy_send_timeout 900;
|
||||
#proxy_set_header Host $http_host;
|
||||
|
||||
location /static {
|
||||
autoindex on;
|
||||
alias /usr/src/app/zod_bank/static/;
|
||||
}
|
||||
}
|
||||
Generated
-22263
File diff suppressed because it is too large
Load Diff
-124
@@ -1,124 +0,0 @@
|
||||
{
|
||||
"name": "test",
|
||||
"version": "0.0.1",
|
||||
"description": "",
|
||||
"author": "",
|
||||
"private": true,
|
||||
"license": "UNLICENSED",
|
||||
"scripts": {
|
||||
"build": "nest build",
|
||||
"format": "prettier --write \"src/**/*.ts\" \"test/**/*.ts\"",
|
||||
"start": "nest start",
|
||||
"start:dev": "nest start --watch",
|
||||
"start:debug": "nest start --debug --watch",
|
||||
"start:prod": "node dist/main",
|
||||
"lint": "eslint \"{src,apps,libs,test}/**/*.ts\" --fix",
|
||||
"test": "jest",
|
||||
"test:watch": "jest --watch",
|
||||
"test:cov": "jest --coverage",
|
||||
"test:debug": "node --inspect-brk -r tsconfig-paths/register -r ts-node/register node_modules/.bin/jest --runInBand",
|
||||
"test:e2e": "jest --config ./test/jest-e2e.json",
|
||||
"typeorm:cli": "./node_modules/.bin/ts-node -r tsconfig-paths/register ./node_modules/.bin/typeorm",
|
||||
"typeorm:cli-d": "ts-node -r tsconfig-paths/register ./node_modules/.bin/typeorm -d typeorm.cli.ts",
|
||||
"migration:generate": "npm run typeorm:cli-d migration:generate",
|
||||
"migration:create": "npm run typeorm:cli migration:create",
|
||||
"migration:up": "npm run typeorm:cli-d migration:run",
|
||||
"migration:down": "npm run typeorm:cli-d migration:revert",
|
||||
"seed": "TS_NODE_PROJECT=tsconfig.json ts-node -r tsconfig-paths/register src/scripts/seed.ts"
|
||||
},
|
||||
"dependencies": {
|
||||
"@abdalhamid/hello": "^2.0.0",
|
||||
"@hamid/hello": "file:../libraries/test-package",
|
||||
"@keyv/redis": "^4.0.2",
|
||||
"@nestjs-modules/mailer": "^2.0.2",
|
||||
"@nestjs/axios": "^3.1.2",
|
||||
"@nestjs/common": "^10.0.0",
|
||||
"@nestjs/config": "^3.3.0",
|
||||
"@nestjs/core": "^10.0.0",
|
||||
"@nestjs/event-emitter": "^2.1.1",
|
||||
"@nestjs/jwt": "^10.2.0",
|
||||
"@nestjs/microservices": "^10.4.7",
|
||||
"@nestjs/passport": "^10.0.3",
|
||||
"@nestjs/platform-express": "^10.4.8",
|
||||
"@nestjs/schedule": "^4.1.2",
|
||||
"@nestjs/swagger": "^8.0.5",
|
||||
"@nestjs/terminus": "^10.2.3",
|
||||
"@nestjs/throttler": "^6.2.1",
|
||||
"@nestjs/typeorm": "^10.0.2",
|
||||
"amqp-connection-manager": "^4.1.14",
|
||||
"amqplib": "^0.10.4",
|
||||
"bcrypt": "^5.1.1",
|
||||
"cacheable": "^1.8.5",
|
||||
"class-transformer": "^0.5.1",
|
||||
"class-validator": "^0.14.1",
|
||||
"decimal.js": "^10.6.0",
|
||||
"firebase-admin": "^13.0.2",
|
||||
"google-libphonenumber": "^3.2.39",
|
||||
"handlebars": "^4.7.8",
|
||||
"handlebars-layouts": "^3.1.4",
|
||||
"jwk-to-pem": "^2.0.7",
|
||||
"lodash": "^4.17.21",
|
||||
"moment": "^2.30.1",
|
||||
"nestjs-i18n": "^10.4.9",
|
||||
"nestjs-pino": "^4.1.0",
|
||||
"nestjs-twilio": "^4.4.0",
|
||||
"nodemailer": "^6.9.16",
|
||||
"oci-common": "^2.99.0",
|
||||
"oci-sdk": "^2.99.0",
|
||||
"passport": "^0.7.0",
|
||||
"passport-jwt": "^4.0.1",
|
||||
"pg": "^8.13.1",
|
||||
"pino-http": "^10.3.0",
|
||||
"pino-pretty": "^13.0.0",
|
||||
"qrcode": "^1.5.4",
|
||||
"reflect-metadata": "^0.2.2",
|
||||
"rxjs": "^7.8.1",
|
||||
"typeorm": "^0.3.20",
|
||||
"typeorm-transactional": "^0.5.0"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@golevelup/ts-jest": "^0.6.0",
|
||||
"@nestjs/cli": "^10.0.0",
|
||||
"@nestjs/schematics": "^10.0.0",
|
||||
"@nestjs/testing": "^10.0.0",
|
||||
"@types/bcrypt": "^5.0.2",
|
||||
"@types/express": "^5.0.0",
|
||||
"@types/google-libphonenumber": "^7.4.30",
|
||||
"@types/jest": "^29.5.2",
|
||||
"@types/jwk-to-pem": "^2.0.3",
|
||||
"@types/lodash": "^4.17.13",
|
||||
"@types/multer": "^1.4.12",
|
||||
"@types/node": "^20.3.1",
|
||||
"@types/nodemailer": "^6.4.16",
|
||||
"@types/passport-jwt": "^4.0.1",
|
||||
"@types/qrcode": "^1.5.5",
|
||||
"@types/supertest": "^6.0.0",
|
||||
"@types/uuid": "^10.0.0",
|
||||
"@typescript-eslint/eslint-plugin": "^5.59.2",
|
||||
"@typescript-eslint/parser": "^5.59.2",
|
||||
"eslint": "^8.39.0",
|
||||
"eslint-config-prettier": "^8.8.0",
|
||||
"eslint-plugin-prettier": "^4.0.0",
|
||||
"eslint-plugin-security": "^1.7.1",
|
||||
"i": "^0.3.7",
|
||||
"jest": "^29.5.0",
|
||||
"lint-staged": "^13.2.2",
|
||||
"npm": "^10.9.2",
|
||||
"prettier": "^2.8.8",
|
||||
"source-map-support": "^0.5.21",
|
||||
"supertest": "^7.0.0",
|
||||
"ts-jest": "^29.1.0",
|
||||
"ts-loader": "^9.4.3",
|
||||
"ts-node": "^10.9.1",
|
||||
"tsconfig-paths": "^4.2.0",
|
||||
"typescript": "^5.1.3"
|
||||
},
|
||||
"lint-staged": {
|
||||
"*.{js,ts}": [
|
||||
"eslint --fix"
|
||||
],
|
||||
"*.{js,ts,json,md}": [
|
||||
"prettier --write"
|
||||
]
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,61 @@
|
||||
aliyun-python-sdk-core==2.13.36
|
||||
aliyun-python-sdk-dysmsapi==2.1.2
|
||||
amqp==5.1.1
|
||||
asgiref==3.7.2
|
||||
async-timeout==4.0.2
|
||||
billiard==4.1.0
|
||||
boto3==1.26.157
|
||||
botocore==1.29.157
|
||||
celery==5.3.1
|
||||
cffi==1.15.1
|
||||
channels==4.0.0
|
||||
channels-redis==4.1.0
|
||||
click==8.1.3
|
||||
click-didyoumean==0.3.0
|
||||
click-plugins==1.1.1
|
||||
click-repl==0.3.0
|
||||
cron-descriptor==1.4.0
|
||||
cryptography==41.0.1
|
||||
decouple==0.0.7
|
||||
Django==4.2.2
|
||||
django-celery-beat==2.5.0
|
||||
django-celery-results==2.5.1
|
||||
django-cors-headers==4.1.0
|
||||
django-dotenv==1.4.2
|
||||
django-extensions==3.2.3
|
||||
django-phonenumber-field==7.1.0
|
||||
django-render-block==0.9.2
|
||||
django-ses==3.5.0
|
||||
django-smtp-ssl==1.0
|
||||
django-storages==1.13.2
|
||||
django-templated-email==3.0.1
|
||||
django-timezone-field==5.1
|
||||
djangorestframework==3.14.0
|
||||
djangorestframework-simplejwt==5.2.2
|
||||
drf-yasg==1.21.6
|
||||
gunicorn==20.1.0
|
||||
inflection==0.5.1
|
||||
jmespath==0.10.0
|
||||
kombu==5.3.1
|
||||
msgpack==1.0.5
|
||||
packaging==23.1
|
||||
phonenumbers==8.13.15
|
||||
prompt-toolkit==3.0.38
|
||||
psycopg==3.1.9
|
||||
pycparser==2.21
|
||||
PyJWT==2.7.0
|
||||
python-crontab==2.7.1
|
||||
python-dateutil==2.8.2
|
||||
python-dotenv==1.0.0
|
||||
pytz==2023.3
|
||||
PyYAML==6.0
|
||||
redis==4.5.5
|
||||
s3transfer==0.6.1
|
||||
six==1.16.0
|
||||
sqlparse==0.4.4
|
||||
typing_extensions==4.6.3
|
||||
tzdata==2023.3
|
||||
uritemplate==4.1.1
|
||||
urllib3==1.26.16
|
||||
vine==5.0.0
|
||||
wcwidth==0.2.6
|
||||
@@ -1,22 +0,0 @@
|
||||
import { Module } from '@nestjs/common';
|
||||
import { TypeOrmModule } from '@nestjs/typeorm';
|
||||
import { CardModule } from '~/card/card.module';
|
||||
import { JuniorModule } from '~/junior/junior.module';
|
||||
import { AllowanceController } from './controllers';
|
||||
import { AllowanceCredit, AllowanceSchedule } from './entities';
|
||||
import { AllowanceCreditRepository, AllowanceScheduleRepository } from './repositories';
|
||||
import { AllowanceQueueService, AllowanceService, AllowanceWorkerService } from './services';
|
||||
|
||||
@Module({
|
||||
imports: [TypeOrmModule.forFeature([AllowanceSchedule, AllowanceCredit]), JuniorModule, CardModule],
|
||||
controllers: [AllowanceController],
|
||||
providers: [
|
||||
AllowanceService,
|
||||
AllowanceScheduleRepository,
|
||||
AllowanceCreditRepository,
|
||||
AllowanceQueueService,
|
||||
AllowanceWorkerService,
|
||||
],
|
||||
exports: [AllowanceScheduleRepository, AllowanceQueueService, AllowanceCreditRepository],
|
||||
})
|
||||
export class AllowanceModule {}
|
||||
@@ -1,5 +0,0 @@
|
||||
export const ALLOWANCE_QUEUE_NAME = 'allowance.schedule';
|
||||
export const ALLOWANCE_RETRY_QUEUE_NAME = 'allowance.schedule.retry';
|
||||
export const ALLOWANCE_DLQ_NAME = 'allowance.schedule.dlq';
|
||||
export const ALLOWANCE_RETRY_EXCHANGE = 'allowance.schedule.retry.exchange';
|
||||
export const ALLOWANCE_DLQ_EXCHANGE = 'allowance.schedule.dlq.exchange';
|
||||
@@ -1 +0,0 @@
|
||||
export * from './allowance-queue.constants';
|
||||
@@ -1,78 +0,0 @@
|
||||
import { Body, Controller, Delete, Get, HttpCode, HttpStatus, Param, Patch, Post, UseGuards } from '@nestjs/common';
|
||||
import { ApiBearerAuth, ApiOperation, ApiTags } from '@nestjs/swagger';
|
||||
import { Roles } from '~/auth/enums';
|
||||
import { IJwtPayload } from '~/auth/interfaces';
|
||||
import { AllowedRoles, AuthenticatedUser } from '~/common/decorators';
|
||||
import { AccessTokenGuard, RolesGuard } from '~/common/guards';
|
||||
import { ApiDataResponse, ApiLangRequestHeader } from '~/core/decorators';
|
||||
import { ResponseFactory } from '~/core/utils';
|
||||
import { CreateAllowanceScheduleRequestDto, UpdateAllowanceScheduleRequestDto } from '../dtos/request';
|
||||
import {
|
||||
AllowanceScheduleResponseDto,
|
||||
AllowanceSchedulesListResponseDto,
|
||||
AllowanceSummaryResponseDto,
|
||||
} from '../dtos/response';
|
||||
import { AllowanceService } from '../services';
|
||||
|
||||
@Controller('guardians/me/allowances')
|
||||
@ApiTags('Allowances')
|
||||
@ApiBearerAuth()
|
||||
@ApiLangRequestHeader()
|
||||
@UseGuards(AccessTokenGuard, RolesGuard)
|
||||
@AllowedRoles(Roles.GUARDIAN)
|
||||
export class AllowanceController {
|
||||
constructor(private readonly allowanceService: AllowanceService) {}
|
||||
|
||||
@Get()
|
||||
@ApiOperation({ summary: 'Get all allowance schedules for the authenticated guardian' })
|
||||
@ApiDataResponse(AllowanceSchedulesListResponseDto)
|
||||
async getSchedules(@AuthenticatedUser() { sub }: IJwtPayload) {
|
||||
const { withSchedule, withoutSchedule, monthlyTotal } =
|
||||
await this.allowanceService.getSchedulesByGuardian(sub);
|
||||
return ResponseFactory.data(
|
||||
new AllowanceSchedulesListResponseDto(withSchedule, withoutSchedule, monthlyTotal),
|
||||
);
|
||||
}
|
||||
|
||||
@Get('summary')
|
||||
@ApiOperation({ summary: 'Get allowance summary for home page (lightweight)' })
|
||||
@ApiDataResponse(AllowanceSummaryResponseDto)
|
||||
async getSummary(@AuthenticatedUser() { sub }: IJwtPayload) {
|
||||
const { nextPaymentAt, monthlyTotal } = await this.allowanceService.getSummary(sub);
|
||||
return ResponseFactory.data(new AllowanceSummaryResponseDto(nextPaymentAt, monthlyTotal));
|
||||
}
|
||||
|
||||
@Post(':juniorId')
|
||||
@ApiOperation({ summary: 'Create a new allowance schedule for a junior' })
|
||||
@ApiDataResponse(AllowanceScheduleResponseDto)
|
||||
async createSchedule(
|
||||
@AuthenticatedUser() { sub }: IJwtPayload,
|
||||
@Param('juniorId') juniorId: string,
|
||||
@Body() body: CreateAllowanceScheduleRequestDto,
|
||||
) {
|
||||
const schedule = await this.allowanceService.createSchedule(sub, juniorId, body);
|
||||
return ResponseFactory.data(new AllowanceScheduleResponseDto(schedule));
|
||||
}
|
||||
|
||||
@Patch(':scheduleId')
|
||||
@ApiOperation({ summary: 'Update an existing allowance schedule' })
|
||||
@ApiDataResponse(AllowanceScheduleResponseDto)
|
||||
async updateSchedule(
|
||||
@AuthenticatedUser() { sub }: IJwtPayload,
|
||||
@Param('scheduleId') scheduleId: string,
|
||||
@Body() body: UpdateAllowanceScheduleRequestDto,
|
||||
) {
|
||||
const schedule = await this.allowanceService.updateSchedule(sub, scheduleId, body);
|
||||
return ResponseFactory.data(new AllowanceScheduleResponseDto(schedule));
|
||||
}
|
||||
|
||||
@Delete(':scheduleId')
|
||||
@HttpCode(HttpStatus.NO_CONTENT)
|
||||
@ApiOperation({ summary: 'Delete an allowance schedule' })
|
||||
async deleteSchedule(
|
||||
@AuthenticatedUser() { sub }: IJwtPayload,
|
||||
@Param('scheduleId') scheduleId: string,
|
||||
) {
|
||||
await this.allowanceService.deleteSchedule(sub, scheduleId);
|
||||
}
|
||||
}
|
||||
@@ -1 +0,0 @@
|
||||
export * from './allowance.controller';
|
||||
@@ -1,38 +0,0 @@
|
||||
import { ApiProperty } from '@nestjs/swagger';
|
||||
import { IsEnum, IsNotEmpty, IsNumber, IsPositive } from 'class-validator';
|
||||
import { i18nValidationMessage as i18n } from 'nestjs-i18n';
|
||||
import { AllowanceFrequency, AllowanceScheduleStatus } from '~/allowance/enums';
|
||||
|
||||
export class CreateAllowanceScheduleRequestDto {
|
||||
@ApiProperty({ example: 400 })
|
||||
@IsNotEmpty({
|
||||
message: i18n('validation.IsNotEmpty', { path: 'general', property: 'allowance.amount' }),
|
||||
})
|
||||
@IsNumber(
|
||||
{ maxDecimalPlaces: 2 },
|
||||
{ message: i18n('validation.IsNumber', { path: 'general', property: 'allowance.amount' }) },
|
||||
)
|
||||
@IsPositive({
|
||||
message: i18n('validation.IsPositive', { path: 'general', property: 'allowance.amount' }),
|
||||
})
|
||||
amount!: number;
|
||||
|
||||
@ApiProperty({ enum: AllowanceFrequency, example: AllowanceFrequency.WEEKLY })
|
||||
@IsNotEmpty({
|
||||
message: i18n('validation.IsNotEmpty', { path: 'general', property: 'allowance.frequency' }),
|
||||
})
|
||||
@IsEnum(AllowanceFrequency, {
|
||||
message: i18n('validation.IsEnum', { path: 'general', property: 'allowance.frequency' }),
|
||||
})
|
||||
frequency!: AllowanceFrequency;
|
||||
|
||||
@ApiProperty({ enum: AllowanceScheduleStatus, example: AllowanceScheduleStatus.ON })
|
||||
@IsNotEmpty({
|
||||
message: i18n('validation.IsNotEmpty', { path: 'general', property: 'allowance.status' }),
|
||||
})
|
||||
@IsEnum(AllowanceScheduleStatus, {
|
||||
message: i18n('validation.IsEnum', { path: 'general', property: 'allowance.status' }),
|
||||
})
|
||||
status!: AllowanceScheduleStatus;
|
||||
|
||||
}
|
||||
@@ -1,2 +0,0 @@
|
||||
export * from './create-allowance-schedule.request.dto';
|
||||
export * from './update-allowance-schedule.request.dto';
|
||||
@@ -1,40 +0,0 @@
|
||||
import { ApiPropertyOptional } from '@nestjs/swagger';
|
||||
import { IsEnum, IsNotEmpty, IsNumber, IsOptional, IsPositive } from 'class-validator';
|
||||
import { i18nValidationMessage } from 'nestjs-i18n';
|
||||
import { AllowanceFrequency, AllowanceScheduleStatus } from '~/allowance/enums';
|
||||
|
||||
export class UpdateAllowanceScheduleRequestDto {
|
||||
@ApiPropertyOptional({ example: 150, description: 'Allowance amount' })
|
||||
@IsOptional()
|
||||
@IsNotEmpty({ message: i18nValidationMessage('validation.NOT_EMPTY') })
|
||||
@IsNumber(
|
||||
{ maxDecimalPlaces: 2 },
|
||||
{ message: i18nValidationMessage('validation.INVALID_NUMBER', { field: 'general.amount' }) },
|
||||
)
|
||||
@IsPositive({ message: i18nValidationMessage('validation.MUST_BE_POSITIVE', { field: 'general.amount' }) })
|
||||
amount?: number;
|
||||
|
||||
@ApiPropertyOptional({
|
||||
enum: AllowanceFrequency,
|
||||
example: AllowanceFrequency.WEEKLY,
|
||||
description: 'How often the allowance is paid',
|
||||
})
|
||||
@IsOptional()
|
||||
@IsNotEmpty({ message: i18nValidationMessage('validation.NOT_EMPTY') })
|
||||
@IsEnum(AllowanceFrequency, {
|
||||
message: i18nValidationMessage('validation.INVALID_ENUM', { field: 'general.allowance.frequency' }),
|
||||
})
|
||||
frequency?: AllowanceFrequency;
|
||||
|
||||
@ApiPropertyOptional({
|
||||
enum: AllowanceScheduleStatus,
|
||||
example: AllowanceScheduleStatus.ON,
|
||||
description: 'Whether the schedule is active or paused',
|
||||
})
|
||||
@IsOptional()
|
||||
@IsNotEmpty({ message: i18nValidationMessage('validation.NOT_EMPTY') })
|
||||
@IsEnum(AllowanceScheduleStatus, {
|
||||
message: i18nValidationMessage('validation.INVALID_ENUM', { field: 'general.allowance.status' }),
|
||||
})
|
||||
status?: AllowanceScheduleStatus;
|
||||
}
|
||||
@@ -1,48 +0,0 @@
|
||||
import { ApiProperty } from '@nestjs/swagger';
|
||||
import { AllowanceSchedule } from '~/allowance/entities/allowance-schedule.entity';
|
||||
import { AllowanceFrequency, AllowanceScheduleStatus } from '~/allowance/enums';
|
||||
|
||||
export class AllowanceScheduleResponseDto {
|
||||
@ApiProperty({ example: '123e4567-e89b-12d3-a456-426614174000' })
|
||||
id!: string;
|
||||
|
||||
@ApiProperty({ example: '123e4567-e89b-12d3-a456-426614174000' })
|
||||
guardianId!: string;
|
||||
|
||||
@ApiProperty({ example: '123e4567-e89b-12d3-a456-426614174000' })
|
||||
juniorId!: string;
|
||||
|
||||
@ApiProperty({ example: 400 })
|
||||
amount!: number;
|
||||
|
||||
@ApiProperty({ enum: AllowanceFrequency, example: AllowanceFrequency.WEEKLY })
|
||||
frequency!: AllowanceFrequency;
|
||||
|
||||
@ApiProperty({ enum: AllowanceScheduleStatus, example: AllowanceScheduleStatus.ON })
|
||||
status!: AllowanceScheduleStatus;
|
||||
|
||||
@ApiProperty({ example: '2026-01-01T00:00:00.000Z' })
|
||||
nextRunAt!: Date;
|
||||
|
||||
@ApiProperty({ example: null })
|
||||
lastRunAt!: Date | null;
|
||||
|
||||
@ApiProperty({ example: '2026-01-01T00:00:00.000Z' })
|
||||
createdAt!: Date;
|
||||
|
||||
@ApiProperty({ example: '2026-01-01T00:00:00.000Z' })
|
||||
updatedAt!: Date;
|
||||
|
||||
constructor(data: AllowanceSchedule) {
|
||||
this.id = data.id;
|
||||
this.guardianId = data.guardianId;
|
||||
this.juniorId = data.juniorId;
|
||||
this.amount = Number(data.amount);
|
||||
this.frequency = data.frequency;
|
||||
this.status = data.status;
|
||||
this.nextRunAt = data.nextRunAt;
|
||||
this.lastRunAt = data.lastRunAt;
|
||||
this.createdAt = data.createdAt;
|
||||
this.updatedAt = data.updatedAt;
|
||||
}
|
||||
}
|
||||
@@ -1,36 +0,0 @@
|
||||
import { ApiProperty } from '@nestjs/swagger';
|
||||
import { AllowanceSchedule } from '~/allowance/entities/allowance-schedule.entity';
|
||||
import { Junior } from '~/junior/entities';
|
||||
import { JuniorWithScheduleDto, JuniorWithoutScheduleDto } from './junior-allowance-info.response.dto';
|
||||
|
||||
export class AllowanceSchedulesListResponseDto {
|
||||
@ApiProperty({
|
||||
type: [JuniorWithScheduleDto],
|
||||
description: 'Children who have an allowance schedule configured',
|
||||
})
|
||||
withSchedule!: JuniorWithScheduleDto[];
|
||||
|
||||
@ApiProperty({
|
||||
type: [JuniorWithoutScheduleDto],
|
||||
description: 'Children who do not have an allowance schedule yet',
|
||||
})
|
||||
withoutSchedule!: JuniorWithoutScheduleDto[];
|
||||
|
||||
@ApiProperty({
|
||||
example: 1600,
|
||||
description: 'Total monthly equivalent amount for all active schedules',
|
||||
})
|
||||
monthlyTotal!: number;
|
||||
|
||||
constructor(
|
||||
juniorsWithSchedule: { junior: Junior; schedule: AllowanceSchedule }[],
|
||||
juniorsWithoutSchedule: Junior[],
|
||||
monthlyTotal: number,
|
||||
) {
|
||||
this.withSchedule = juniorsWithSchedule.map(
|
||||
({ junior, schedule }) => new JuniorWithScheduleDto(junior, schedule),
|
||||
);
|
||||
this.withoutSchedule = juniorsWithoutSchedule.map((j) => new JuniorWithoutScheduleDto(j));
|
||||
this.monthlyTotal = monthlyTotal;
|
||||
}
|
||||
}
|
||||
@@ -1,21 +0,0 @@
|
||||
import { ApiProperty, ApiPropertyOptional } from '@nestjs/swagger';
|
||||
|
||||
export class AllowanceSummaryResponseDto {
|
||||
@ApiPropertyOptional({
|
||||
example: '2026-02-01T00:00:00.000Z',
|
||||
description: 'The nearest upcoming payment date among all active schedules (null if no active schedules)',
|
||||
nullable: true,
|
||||
})
|
||||
nextPaymentAt!: Date | null;
|
||||
|
||||
@ApiProperty({
|
||||
example: 1600,
|
||||
description: 'Total monthly equivalent amount for all active schedules',
|
||||
})
|
||||
monthlyTotal!: number;
|
||||
|
||||
constructor(nextPaymentAt: Date | null, monthlyTotal: number) {
|
||||
this.nextPaymentAt = nextPaymentAt;
|
||||
this.monthlyTotal = monthlyTotal;
|
||||
}
|
||||
}
|
||||
@@ -1,4 +0,0 @@
|
||||
export * from './allowance-schedule.response.dto';
|
||||
export * from './allowance-schedules-list.response.dto';
|
||||
export * from './allowance-summary.response.dto';
|
||||
export * from './junior-allowance-info.response.dto';
|
||||
@@ -1,89 +0,0 @@
|
||||
import { ApiProperty } from '@nestjs/swagger';
|
||||
import { Junior } from '~/junior/entities';
|
||||
import { AllowanceSchedule } from '~/allowance/entities';
|
||||
import { AllowanceFrequency, AllowanceScheduleStatus } from '~/allowance/enums';
|
||||
|
||||
/**
|
||||
* Junior without an allowance schedule - basic info only
|
||||
*/
|
||||
export class JuniorWithoutScheduleDto {
|
||||
@ApiProperty({ example: '123e4567-e89b-12d3-a456-426614174000' })
|
||||
juniorId!: string;
|
||||
|
||||
@ApiProperty({ example: 'Ahmed' })
|
||||
firstName!: string;
|
||||
|
||||
@ApiProperty({ example: 'Al-Khair' })
|
||||
lastName!: string;
|
||||
|
||||
@ApiProperty({ example: 'https://example.com/profile.jpg', nullable: true })
|
||||
profilePictureUrl!: string | null;
|
||||
|
||||
constructor(junior: Junior) {
|
||||
this.juniorId = junior.id;
|
||||
this.firstName = junior.customer?.user?.firstName || '';
|
||||
this.lastName = junior.customer?.user?.lastName || '';
|
||||
this.profilePictureUrl = junior.customer?.user?.profilePicture?.url || null;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Junior with their allowance schedule - all data flattened into one object
|
||||
*/
|
||||
export class JuniorWithScheduleDto {
|
||||
// Junior info
|
||||
@ApiProperty({ example: '123e4567-e89b-12d3-a456-426614174000' })
|
||||
juniorId!: string;
|
||||
|
||||
@ApiProperty({ example: 'Ahmed' })
|
||||
firstName!: string;
|
||||
|
||||
@ApiProperty({ example: 'Al-Khair' })
|
||||
lastName!: string;
|
||||
|
||||
@ApiProperty({ example: 'https://example.com/profile.jpg', nullable: true })
|
||||
profilePictureUrl!: string | null;
|
||||
|
||||
// Schedule info
|
||||
@ApiProperty({ example: '123e4567-e89b-12d3-a456-426614174000' })
|
||||
scheduleId!: string;
|
||||
|
||||
@ApiProperty({ example: 100 })
|
||||
amount!: number;
|
||||
|
||||
@ApiProperty({ enum: AllowanceFrequency, example: AllowanceFrequency.WEEKLY })
|
||||
frequency!: AllowanceFrequency;
|
||||
|
||||
@ApiProperty({ enum: AllowanceScheduleStatus, example: AllowanceScheduleStatus.ON })
|
||||
status!: AllowanceScheduleStatus;
|
||||
|
||||
@ApiProperty({ example: '2026-02-05T00:00:00.000Z' })
|
||||
nextRunAt!: Date;
|
||||
|
||||
@ApiProperty({ example: null, nullable: true })
|
||||
lastRunAt!: Date | null;
|
||||
|
||||
@ApiProperty({ example: '2026-01-15T10:30:00.000Z' })
|
||||
createdAt!: Date;
|
||||
|
||||
@ApiProperty({ example: '2026-01-15T10:30:00.000Z' })
|
||||
updatedAt!: Date;
|
||||
|
||||
constructor(junior: Junior, schedule: AllowanceSchedule) {
|
||||
// Junior info
|
||||
this.juniorId = junior.id;
|
||||
this.firstName = junior.customer?.user?.firstName || '';
|
||||
this.lastName = junior.customer?.user?.lastName || '';
|
||||
this.profilePictureUrl = junior.customer?.user?.profilePicture?.url || null;
|
||||
|
||||
// Schedule info
|
||||
this.scheduleId = schedule.id;
|
||||
this.amount = Number(schedule.amount);
|
||||
this.frequency = schedule.frequency;
|
||||
this.status = schedule.status;
|
||||
this.nextRunAt = schedule.nextRunAt;
|
||||
this.lastRunAt = schedule.lastRunAt;
|
||||
this.createdAt = schedule.createdAt;
|
||||
this.updatedAt = schedule.updatedAt;
|
||||
}
|
||||
}
|
||||
@@ -1,42 +0,0 @@
|
||||
import {
|
||||
BaseEntity,
|
||||
Column,
|
||||
CreateDateColumn,
|
||||
Entity,
|
||||
JoinColumn,
|
||||
ManyToOne,
|
||||
PrimaryGeneratedColumn,
|
||||
} from 'typeorm';
|
||||
import { Transaction } from '~/card/entities/transaction.entity';
|
||||
import { AllowanceSchedule } from './allowance-schedule.entity';
|
||||
|
||||
@Entity('allowance_credits')
|
||||
export class AllowanceCredit extends BaseEntity {
|
||||
@PrimaryGeneratedColumn('uuid')
|
||||
id!: string;
|
||||
|
||||
@Column({ type: 'decimal', precision: 12, scale: 2, name: 'amount' })
|
||||
amount!: number;
|
||||
|
||||
@Column({ type: 'timestamp with time zone', name: 'run_at' })
|
||||
runAt!: Date;
|
||||
|
||||
@CreateDateColumn({ type: 'timestamp with time zone', default: () => 'CURRENT_TIMESTAMP', name: 'credited_at' })
|
||||
creditedAt!: Date;
|
||||
|
||||
@Column({ type: 'uuid', name: 'schedule_id' })
|
||||
scheduleId!: string;
|
||||
|
||||
|
||||
@ManyToOne(() => AllowanceSchedule, (schedule) => schedule.credits, { onDelete: 'CASCADE' })
|
||||
@JoinColumn({ name: 'schedule_id' })
|
||||
schedule!: AllowanceSchedule;
|
||||
|
||||
@Column({ type: 'uuid', name: 'transaction_id', nullable: true })
|
||||
transactionId!: string | null;
|
||||
|
||||
@ManyToOne(() => Transaction, { onDelete: 'SET NULL', nullable: true })
|
||||
@JoinColumn({ name: 'transaction_id' })
|
||||
transaction!: Transaction | null;
|
||||
|
||||
}
|
||||
@@ -1,60 +0,0 @@
|
||||
import {
|
||||
BaseEntity,
|
||||
Column,
|
||||
CreateDateColumn,
|
||||
Entity,
|
||||
JoinColumn,
|
||||
ManyToOne,
|
||||
OneToMany,
|
||||
PrimaryGeneratedColumn,
|
||||
UpdateDateColumn,
|
||||
} from 'typeorm';
|
||||
import { Guardian } from '~/guardian/entities/guradian.entity';
|
||||
import { Junior } from '~/junior/entities';
|
||||
import { AllowanceFrequency, AllowanceScheduleStatus } from '../enums';
|
||||
import { AllowanceCredit } from './allowance-credit.entity';
|
||||
|
||||
@Entity('allowance_schedules')
|
||||
export class AllowanceSchedule extends BaseEntity {
|
||||
@PrimaryGeneratedColumn('uuid')
|
||||
id!: string;
|
||||
|
||||
@Column({ type: 'decimal', precision: 12, scale: 2, name: 'amount' })
|
||||
amount!: number;
|
||||
|
||||
@Column({ type: 'varchar', name: 'frequency' })
|
||||
frequency!: AllowanceFrequency;
|
||||
|
||||
@Column({ type: 'varchar', name: 'status', default: AllowanceScheduleStatus.ON })
|
||||
status!: AllowanceScheduleStatus;
|
||||
|
||||
@Column({ type: 'timestamp with time zone', name: 'next_run_at' })
|
||||
nextRunAt!: Date;
|
||||
|
||||
@Column({ type: 'timestamp with time zone', name: 'last_run_at', nullable: true })
|
||||
lastRunAt!: Date | null;
|
||||
|
||||
@CreateDateColumn({ type: 'timestamp with time zone', default: () => 'CURRENT_TIMESTAMP', name: 'created_at' })
|
||||
createdAt!: Date;
|
||||
|
||||
@UpdateDateColumn({ type: 'timestamp with time zone', default: () => 'CURRENT_TIMESTAMP', name: 'updated_at' })
|
||||
updatedAt!: Date;
|
||||
|
||||
@Column({ type: 'uuid', name: 'guardian_id' })
|
||||
guardianId!: string;
|
||||
|
||||
@ManyToOne(() => Guardian, (guardian) => guardian.allowanceSchedules, { onDelete: 'CASCADE' })
|
||||
@JoinColumn({ name: 'guardian_id' })
|
||||
guardian!: Guardian;
|
||||
|
||||
@Column({ type: 'uuid', name: 'junior_id' })
|
||||
juniorId!: string;
|
||||
|
||||
@ManyToOne(() => Junior, (junior) => junior.allowanceSchedules, { onDelete: 'CASCADE' })
|
||||
@JoinColumn({ name: 'junior_id' })
|
||||
junior!: Junior;
|
||||
|
||||
@OneToMany(() => AllowanceCredit, (credit) => credit.schedule)
|
||||
credits!: AllowanceCredit[];
|
||||
|
||||
}
|
||||
@@ -1,2 +0,0 @@
|
||||
export * from './allowance-credit.entity';
|
||||
export * from './allowance-schedule.entity';
|
||||
@@ -1,5 +0,0 @@
|
||||
export enum AllowanceFrequency {
|
||||
DAILY = 'DAILY',
|
||||
WEEKLY = 'WEEKLY',
|
||||
MONTHLY = 'MONTHLY',
|
||||
}
|
||||
@@ -1,4 +0,0 @@
|
||||
export enum AllowanceScheduleStatus {
|
||||
ON = 'ON',
|
||||
OFF = 'OFF',
|
||||
}
|
||||
@@ -1,2 +0,0 @@
|
||||
export * from './allowance-frequency.enum';
|
||||
export * from './allowance-schedule-status.enum';
|
||||
@@ -1,13 +0,0 @@
|
||||
import { Junior } from '~/junior/entities';
|
||||
import { AllowanceSchedule } from '../entities/allowance-schedule.entity';
|
||||
|
||||
export interface AllowanceSchedulesGrouped {
|
||||
withSchedule: { junior: Junior; schedule: AllowanceSchedule }[];
|
||||
withoutSchedule: Junior[];
|
||||
monthlyTotal: number;
|
||||
}
|
||||
|
||||
export interface AllowanceSummary {
|
||||
nextPaymentAt: Date | null;
|
||||
monthlyTotal: number;
|
||||
}
|
||||
@@ -1 +0,0 @@
|
||||
export * from './allowance-schedules-grouped.interface';
|
||||
@@ -1,32 +0,0 @@
|
||||
import { Injectable } from '@nestjs/common';
|
||||
import { InjectRepository } from '@nestjs/typeorm';
|
||||
import { Repository } from 'typeorm';
|
||||
import { AllowanceCredit } from '~/allowance/entities';
|
||||
|
||||
@Injectable()
|
||||
export class AllowanceCreditRepository {
|
||||
constructor(
|
||||
@InjectRepository(AllowanceCredit)
|
||||
private readonly allowanceCreditRepository: Repository<AllowanceCredit>,
|
||||
) {}
|
||||
|
||||
createCredit(scheduleId: string, amount: number, runAt: Date): Promise<AllowanceCredit> {
|
||||
return this.allowanceCreditRepository.save(
|
||||
this.allowanceCreditRepository.create({
|
||||
scheduleId,
|
||||
amount,
|
||||
runAt,
|
||||
}),
|
||||
);
|
||||
}
|
||||
|
||||
findByScheduleAndRunAt(scheduleId: string, runAt: Date): Promise<AllowanceCredit | null> {
|
||||
return this.allowanceCreditRepository.findOne({
|
||||
where: { scheduleId, runAt },
|
||||
});
|
||||
}
|
||||
|
||||
deleteById(id: string): Promise<void> {
|
||||
return this.allowanceCreditRepository.delete({ id }).then(() => undefined);
|
||||
}
|
||||
}
|
||||
@@ -1,96 +0,0 @@
|
||||
import { Injectable } from '@nestjs/common';
|
||||
import { InjectRepository } from '@nestjs/typeorm';
|
||||
import { Repository } from 'typeorm';
|
||||
import { AllowanceSchedule } from '~/allowance/entities/allowance-schedule.entity';
|
||||
import { CreateAllowanceScheduleRequestDto } from '~/allowance/dtos/request';
|
||||
import { AllowanceScheduleStatus } from '~/allowance/enums';
|
||||
|
||||
@Injectable()
|
||||
export class AllowanceScheduleRepository {
|
||||
constructor(
|
||||
@InjectRepository(AllowanceSchedule)
|
||||
private readonly allowanceScheduleRepository: Repository<AllowanceSchedule>,
|
||||
) {}
|
||||
|
||||
findByGuardianAndJunior(guardianId: string, juniorId: string): Promise<AllowanceSchedule | null> {
|
||||
return this.allowanceScheduleRepository.findOne({
|
||||
where: { guardianId, juniorId },
|
||||
});
|
||||
}
|
||||
|
||||
findByGuardianId(guardianId: string): Promise<AllowanceSchedule[]> {
|
||||
return this.allowanceScheduleRepository.find({
|
||||
where: { guardianId },
|
||||
order: { createdAt: 'DESC' },
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Finds only active (ON) schedules for a guardian, ordered by nextRunAt (nearest first)
|
||||
*/
|
||||
findActiveByGuardianId(guardianId: string): Promise<AllowanceSchedule[]> {
|
||||
return this.allowanceScheduleRepository.find({
|
||||
where: { guardianId, status: AllowanceScheduleStatus.ON },
|
||||
order: { nextRunAt: 'ASC' },
|
||||
});
|
||||
}
|
||||
|
||||
createSchedule(guardianId: string, juniorId: string, body: CreateAllowanceScheduleRequestDto, nextRunAt: Date) {
|
||||
return this.allowanceScheduleRepository.save(
|
||||
this.allowanceScheduleRepository.create({
|
||||
guardianId,
|
||||
juniorId,
|
||||
amount: body.amount,
|
||||
frequency: body.frequency,
|
||||
status: body.status,
|
||||
nextRunAt,
|
||||
}),
|
||||
);
|
||||
}
|
||||
|
||||
findDueSchedulesBatch(
|
||||
limit: number,
|
||||
cursor?: { nextRunAt: Date; id: string },
|
||||
): Promise<AllowanceSchedule[]> {
|
||||
const query = this.allowanceScheduleRepository
|
||||
.createQueryBuilder('schedule')
|
||||
.where('schedule.status = :status', { status: AllowanceScheduleStatus.ON })
|
||||
.andWhere('schedule.nextRunAt <= :now', { now: new Date() });
|
||||
|
||||
if (cursor) {
|
||||
query.andWhere(
|
||||
'(schedule.nextRunAt > :cursorDate OR (schedule.nextRunAt = :cursorDate AND schedule.id > :cursorId))',
|
||||
{
|
||||
cursorDate: cursor.nextRunAt,
|
||||
cursorId: cursor.id,
|
||||
},
|
||||
);
|
||||
}
|
||||
|
||||
return query
|
||||
.orderBy('schedule.nextRunAt', 'ASC')
|
||||
.addOrderBy('schedule.id', 'ASC')
|
||||
.take(limit)
|
||||
.getMany();
|
||||
}
|
||||
|
||||
findById(id: string): Promise<AllowanceSchedule | null> {
|
||||
return this.allowanceScheduleRepository.findOne({ where: { id } });
|
||||
}
|
||||
|
||||
findByIdAndGuardian(id: string, guardianId: string): Promise<AllowanceSchedule | null> {
|
||||
return this.allowanceScheduleRepository.findOne({ where: { id, guardianId } });
|
||||
}
|
||||
|
||||
updateScheduleRun(id: string, lastRunAt: Date, nextRunAt: Date) {
|
||||
return this.allowanceScheduleRepository.update({ id }, { lastRunAt, nextRunAt });
|
||||
}
|
||||
|
||||
async updateSchedule(schedule: AllowanceSchedule): Promise<AllowanceSchedule> {
|
||||
return this.allowanceScheduleRepository.save(schedule);
|
||||
}
|
||||
|
||||
async deleteById(id: string): Promise<void> {
|
||||
await this.allowanceScheduleRepository.delete({ id });
|
||||
}
|
||||
}
|
||||
@@ -1,2 +0,0 @@
|
||||
export * from './allowance-credit.repository';
|
||||
export * from './allowance-schedule.repository';
|
||||
@@ -1,90 +0,0 @@
|
||||
import { Injectable, Logger, OnModuleDestroy } from '@nestjs/common';
|
||||
import { ConfigService } from '@nestjs/config';
|
||||
import { AmqpConnectionManager, ChannelWrapper, connect } from 'amqp-connection-manager';
|
||||
import {
|
||||
ALLOWANCE_DLQ_EXCHANGE,
|
||||
ALLOWANCE_DLQ_NAME,
|
||||
ALLOWANCE_QUEUE_NAME,
|
||||
ALLOWANCE_RETRY_EXCHANGE,
|
||||
ALLOWANCE_RETRY_QUEUE_NAME,
|
||||
} from '../constants';
|
||||
|
||||
@Injectable()
|
||||
export class AllowanceQueueService implements OnModuleDestroy {
|
||||
private readonly logger = new Logger(AllowanceQueueService.name);
|
||||
private connection?: AmqpConnectionManager;
|
||||
private channel?: ChannelWrapper;
|
||||
private readonly queueName: string;
|
||||
private readonly rabbitUrl?: string;
|
||||
private readonly retryDelayMs: number;
|
||||
|
||||
constructor(private readonly configService: ConfigService) {
|
||||
this.queueName = this.configService.get<string>('ALLOWANCE_QUEUE_NAME') || ALLOWANCE_QUEUE_NAME;
|
||||
this.rabbitUrl = this.configService.get<string>('RABBITMQ_URL');
|
||||
this.retryDelayMs = Number(this.configService.get<string>('ALLOWANCE_RETRY_DELAY_MS') || 10 * 60 * 1000);
|
||||
}
|
||||
|
||||
async enqueueSchedule(scheduleId: string, runAt: Date): Promise<void> {
|
||||
if (!this.rabbitUrl) {
|
||||
this.logger.warn('RABBITMQ_URL is not set; skipping allowance enqueue.');
|
||||
return;
|
||||
}
|
||||
|
||||
if (!this.connection || !this.channel) {
|
||||
this.connection = connect([this.rabbitUrl]);
|
||||
this.connection.on('connect', () => {
|
||||
this.logger.log('RabbitMQ connected (publisher).');
|
||||
});
|
||||
this.connection.on('disconnect', (params) => {
|
||||
this.logger.error(`RabbitMQ disconnected (publisher): ${params?.err?.message || 'unknown error'}`);
|
||||
});
|
||||
this.channel = this.connection.createChannel({
|
||||
setup: async (channel: any) => {
|
||||
await channel.assertExchange(ALLOWANCE_RETRY_EXCHANGE, 'direct', { durable: true });
|
||||
await channel.assertExchange(ALLOWANCE_DLQ_EXCHANGE, 'direct', { durable: true });
|
||||
|
||||
await channel.assertQueue(ALLOWANCE_RETRY_QUEUE_NAME, {
|
||||
durable: true,
|
||||
messageTtl: this.retryDelayMs,
|
||||
deadLetterExchange: '',
|
||||
deadLetterRoutingKey: this.queueName,
|
||||
});
|
||||
|
||||
await channel.assertQueue(ALLOWANCE_DLQ_NAME, {
|
||||
durable: true,
|
||||
});
|
||||
|
||||
await channel.bindQueue(ALLOWANCE_RETRY_QUEUE_NAME, ALLOWANCE_RETRY_EXCHANGE, this.queueName);
|
||||
await channel.bindQueue(ALLOWANCE_DLQ_NAME, ALLOWANCE_DLQ_EXCHANGE, this.queueName);
|
||||
|
||||
await channel.assertQueue(this.queueName, {
|
||||
durable: true,
|
||||
deadLetterExchange: ALLOWANCE_RETRY_EXCHANGE,
|
||||
deadLetterRoutingKey: this.queueName,
|
||||
});
|
||||
},
|
||||
});
|
||||
}
|
||||
|
||||
const payload = {
|
||||
scheduleId,
|
||||
runAt: runAt.toISOString(),
|
||||
};
|
||||
|
||||
const messageId = `allowance:${scheduleId}:${runAt.toISOString()}`;
|
||||
const options: any = {
|
||||
persistent: true,
|
||||
messageId,
|
||||
contentType: 'application/json',
|
||||
};
|
||||
|
||||
this.logger.log(`Enqueueing allowance job - scheduleId: ${scheduleId}, runAt: ${runAt.toISOString()}`);
|
||||
await this.channel.sendToQueue(this.queueName, Buffer.from(JSON.stringify(payload)), options);
|
||||
this.logger.log(`Allowance job enqueued successfully - messageId: ${messageId}`);
|
||||
}
|
||||
|
||||
async onModuleDestroy() {
|
||||
await this.channel?.close();
|
||||
await this.connection?.close();
|
||||
}
|
||||
}
|
||||
@@ -1,212 +0,0 @@
|
||||
import { Injectable, Logger, OnModuleDestroy, OnModuleInit } from '@nestjs/common';
|
||||
import { ConfigService } from '@nestjs/config';
|
||||
import { AmqpConnectionManager, ChannelWrapper, connect } from 'amqp-connection-manager';
|
||||
import moment from 'moment';
|
||||
import { CardService } from '~/card/services';
|
||||
import { AllowanceScheduleRepository } from '../repositories/allowance-schedule.repository';
|
||||
import { AllowanceCreditRepository } from '../repositories/allowance-credit.repository';
|
||||
import { ALLOWANCE_DLQ_EXCHANGE, ALLOWANCE_QUEUE_NAME, ALLOWANCE_RETRY_EXCHANGE } from '../constants';
|
||||
import { AllowanceFrequency, AllowanceScheduleStatus } from '../enums';
|
||||
|
||||
type AllowanceQueuePayload = {
|
||||
scheduleId: string;
|
||||
runAt: string;
|
||||
};
|
||||
|
||||
@Injectable()
|
||||
export class AllowanceWorkerService implements OnModuleInit, OnModuleDestroy {
|
||||
private readonly logger = new Logger(AllowanceWorkerService.name);
|
||||
private connection?: AmqpConnectionManager;
|
||||
private channel?: ChannelWrapper;
|
||||
private readonly queueName: string;
|
||||
private readonly rabbitUrl?: string;
|
||||
private readonly maxRetries: number;
|
||||
private readonly isTestMode: boolean;
|
||||
|
||||
constructor(
|
||||
private readonly configService: ConfigService,
|
||||
private readonly allowanceScheduleRepository: AllowanceScheduleRepository,
|
||||
private readonly allowanceCreditRepository: AllowanceCreditRepository,
|
||||
private readonly cardService: CardService,
|
||||
) {
|
||||
this.queueName = this.configService.get<string>('ALLOWANCE_QUEUE_NAME') || ALLOWANCE_QUEUE_NAME;
|
||||
this.rabbitUrl = this.configService.get<string>('RABBITMQ_URL');
|
||||
this.maxRetries = Number(this.configService.get<string>('ALLOWANCE_MAX_RETRIES') || 5);
|
||||
this.isTestMode = this.configService.get<string>('ALLOWANCE_TEST_MODE') === 'true';
|
||||
if (this.isTestMode) {
|
||||
this.logger.warn('ALLOWANCE_TEST_MODE is enabled - using short intervals (5/10/15 min)');
|
||||
}
|
||||
}
|
||||
|
||||
async onModuleInit() {
|
||||
if (!this.rabbitUrl) {
|
||||
this.logger.warn('RABBITMQ_URL is not set; allowance worker is disabled.');
|
||||
return;
|
||||
}
|
||||
|
||||
this.connection = connect([this.rabbitUrl]);
|
||||
this.connection.on('connect', () => {
|
||||
this.logger.log('RabbitMQ connected (worker).');
|
||||
});
|
||||
this.connection.on('disconnect', (params) => {
|
||||
this.logger.error(`RabbitMQ disconnected (worker): ${params?.err?.message || 'unknown error'}`);
|
||||
});
|
||||
this.channel = this.connection.createChannel({
|
||||
setup: async (channel: any) => {
|
||||
await channel.assertQueue(this.queueName, {
|
||||
durable: true,
|
||||
deadLetterExchange: ALLOWANCE_RETRY_EXCHANGE,
|
||||
deadLetterRoutingKey: this.queueName,
|
||||
});
|
||||
await channel.prefetch(10);
|
||||
await channel.consume(this.queueName, (msg: any) => this.handleMessage(channel, msg), {
|
||||
noAck: false,
|
||||
});
|
||||
},
|
||||
});
|
||||
}
|
||||
|
||||
async onModuleDestroy() {
|
||||
await this.channel?.close();
|
||||
await this.connection?.close();
|
||||
}
|
||||
|
||||
private async handleMessage(channel: any, msg: any) {
|
||||
if (!msg) {
|
||||
return;
|
||||
}
|
||||
|
||||
let payload: AllowanceQueuePayload;
|
||||
try {
|
||||
payload = JSON.parse(msg.content.toString()) as AllowanceQueuePayload;
|
||||
} catch (error) {
|
||||
const stack = error instanceof Error ? error.stack : undefined;
|
||||
this.logger.error('Invalid allowance queue payload', stack || error);
|
||||
channel.ack(msg);
|
||||
return;
|
||||
}
|
||||
|
||||
try {
|
||||
await this.processAllowanceJob(payload);
|
||||
channel.ack(msg);
|
||||
} catch (error) {
|
||||
const stack = error instanceof Error ? error.stack : undefined;
|
||||
this.logger.error(`Allowance job failed for schedule ${payload.scheduleId}`, stack || error);
|
||||
const retryCount = this.getRetryCount(msg);
|
||||
if (retryCount >= this.maxRetries) {
|
||||
this.logger.error(`Allowance job exceeded max retries (${this.maxRetries}). Sending to DLQ.`);
|
||||
channel.publish(ALLOWANCE_DLQ_EXCHANGE, this.queueName, msg.content, {
|
||||
contentType: msg.properties.contentType,
|
||||
messageId: msg.properties.messageId,
|
||||
headers: msg.properties.headers,
|
||||
persistent: true,
|
||||
});
|
||||
channel.ack(msg);
|
||||
return;
|
||||
}
|
||||
channel.nack(msg, false, false);
|
||||
}
|
||||
}
|
||||
|
||||
private async processAllowanceJob(payload: AllowanceQueuePayload): Promise<void> {
|
||||
const runAt = new Date(payload.runAt);
|
||||
if (!payload.scheduleId || Number.isNaN(runAt.getTime())) {
|
||||
this.logger.warn(`Invalid payload - scheduleId: ${payload.scheduleId}, runAt: ${payload.runAt}`);
|
||||
return;
|
||||
}
|
||||
|
||||
this.logger.log(`Processing allowance job - scheduleId: ${payload.scheduleId}, runAt: ${runAt.toISOString()}`);
|
||||
|
||||
const schedule = await this.allowanceScheduleRepository.findById(payload.scheduleId);
|
||||
if (!schedule) {
|
||||
this.logger.warn(`Schedule not found: ${payload.scheduleId}`);
|
||||
return;
|
||||
}
|
||||
|
||||
this.logger.debug(`Schedule found - juniorId: ${schedule.juniorId}, amount: ${schedule.amount}, status: ${schedule.status}, nextRunAt: ${schedule.nextRunAt}`);
|
||||
|
||||
if (schedule.status !== AllowanceScheduleStatus.ON) {
|
||||
this.logger.warn(`Schedule ${payload.scheduleId} is not ON (status: ${schedule.status}). Skipping.`);
|
||||
return;
|
||||
}
|
||||
|
||||
if (schedule.nextRunAt > runAt) {
|
||||
this.logger.warn(`Schedule ${payload.scheduleId} nextRunAt (${schedule.nextRunAt}) > runAt (${runAt}). Skipping.`);
|
||||
return;
|
||||
}
|
||||
|
||||
// Convert amount from decimal string to number
|
||||
const amount = Number(schedule.amount);
|
||||
if (isNaN(amount) || amount <= 0) {
|
||||
this.logger.error(`Invalid amount for schedule ${payload.scheduleId}: ${schedule.amount}`);
|
||||
return;
|
||||
}
|
||||
|
||||
this.logger.log(`Creating allowance credit - scheduleId: ${payload.scheduleId}, amount: ${amount}`);
|
||||
|
||||
let credit = null;
|
||||
try {
|
||||
credit = await this.allowanceCreditRepository.createCredit(schedule.id, amount, runAt);
|
||||
this.logger.log(`Credit created: ${credit.id}`);
|
||||
} catch (error: any) {
|
||||
if (error?.code === '23505') {
|
||||
this.logger.warn(`Credit already exists for schedule ${payload.scheduleId} at ${runAt.toISOString()} (idempotency check)`);
|
||||
return;
|
||||
}
|
||||
throw error;
|
||||
}
|
||||
|
||||
try {
|
||||
this.logger.log(`Transferring ${amount} to junior ${schedule.juniorId}`);
|
||||
await this.cardService.transferToChild(schedule.juniorId, amount);
|
||||
this.logger.log(`Transfer successful for junior ${schedule.juniorId}`);
|
||||
|
||||
const nextRunAt = this.computeNextRunAt(schedule.frequency);
|
||||
await this.allowanceScheduleRepository.updateScheduleRun(schedule.id, runAt, nextRunAt);
|
||||
this.logger.log(`Schedule ${payload.scheduleId} updated - lastRunAt: ${runAt.toISOString()}, nextRunAt: ${nextRunAt.toISOString()}`);
|
||||
} catch (error) {
|
||||
this.logger.error(`Transfer failed for schedule ${payload.scheduleId}: ${error instanceof Error ? error.message : error}`);
|
||||
if (credit) {
|
||||
await this.allowanceCreditRepository.deleteById(credit.id);
|
||||
this.logger.log(`Credit ${credit.id} deleted due to transfer failure`);
|
||||
}
|
||||
throw error;
|
||||
}
|
||||
}
|
||||
|
||||
private computeNextRunAt(frequency: AllowanceFrequency): Date {
|
||||
const base = moment();
|
||||
|
||||
if (this.isTestMode) {
|
||||
// Test mode: DAILY=5min, WEEKLY=10min, MONTHLY=15min
|
||||
switch (frequency) {
|
||||
case AllowanceFrequency.DAILY:
|
||||
return base.add(5, 'minutes').toDate();
|
||||
case AllowanceFrequency.WEEKLY:
|
||||
return base.add(10, 'minutes').toDate();
|
||||
case AllowanceFrequency.MONTHLY:
|
||||
return base.add(15, 'minutes').toDate();
|
||||
default:
|
||||
return base.toDate();
|
||||
}
|
||||
}
|
||||
|
||||
// Production mode: real intervals
|
||||
switch (frequency) {
|
||||
case AllowanceFrequency.DAILY:
|
||||
return base.add(1, 'day').toDate();
|
||||
case AllowanceFrequency.WEEKLY:
|
||||
return base.add(1, 'week').toDate();
|
||||
case AllowanceFrequency.MONTHLY:
|
||||
return base.add(1, 'month').toDate();
|
||||
default:
|
||||
return base.toDate();
|
||||
}
|
||||
}
|
||||
|
||||
private getRetryCount(msg: any): number {
|
||||
const deaths = (msg.properties.headers?.['x-death'] as Array<{ count?: number }> | undefined) || [];
|
||||
const retryDeath = deaths.find((death) => death?.count != null);
|
||||
return retryDeath?.count ?? 0;
|
||||
}
|
||||
}
|
||||
@@ -1,213 +0,0 @@
|
||||
import { BadRequestException, Injectable, Logger, NotFoundException } from '@nestjs/common';
|
||||
import { ConfigService } from '@nestjs/config';
|
||||
import moment from 'moment';
|
||||
import { Junior } from '~/junior/entities';
|
||||
import { JuniorService } from '~/junior/services';
|
||||
import { CreateAllowanceScheduleRequestDto, UpdateAllowanceScheduleRequestDto } from '../dtos/request';
|
||||
import { AllowanceSchedule } from '../entities/allowance-schedule.entity';
|
||||
import { AllowanceFrequency, AllowanceScheduleStatus } from '../enums';
|
||||
import { AllowanceSchedulesGrouped, AllowanceSummary } from '../interfaces';
|
||||
import { AllowanceScheduleRepository } from '../repositories';
|
||||
|
||||
@Injectable()
|
||||
export class AllowanceService {
|
||||
private readonly logger = new Logger(AllowanceService.name);
|
||||
private readonly isTestMode: boolean;
|
||||
|
||||
constructor(
|
||||
private readonly allowanceScheduleRepository: AllowanceScheduleRepository,
|
||||
private readonly juniorService: JuniorService,
|
||||
private readonly configService: ConfigService,
|
||||
) {
|
||||
this.isTestMode = this.configService.get<string>('ALLOWANCE_TEST_MODE') === 'true';
|
||||
if (this.isTestMode) {
|
||||
this.logger.warn('ALLOWANCE_TEST_MODE is enabled - using short intervals (5/10/15 min)');
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets all allowance schedules for a guardian, grouped by juniors with and without schedules.
|
||||
*/
|
||||
async getSchedulesByGuardian(guardianId: string): Promise<AllowanceSchedulesGrouped> {
|
||||
// Fetch all juniors for this guardian (with pagination workaround - large size)
|
||||
const [juniors] = await this.juniorService.findJuniorsByGuardianId(guardianId, {
|
||||
page: 1,
|
||||
size: 1000, // Assuming no guardian has more than 1000 children
|
||||
});
|
||||
|
||||
// Fetch all schedules for this guardian
|
||||
const schedules = await this.allowanceScheduleRepository.findByGuardianId(guardianId);
|
||||
|
||||
// Create a map of juniorId -> schedule for quick lookup
|
||||
const scheduleMap = new Map<string, AllowanceSchedule>();
|
||||
for (const schedule of schedules) {
|
||||
scheduleMap.set(schedule.juniorId, schedule);
|
||||
}
|
||||
|
||||
// Separate juniors into two groups
|
||||
const withSchedule: { junior: Junior; schedule: AllowanceSchedule }[] = [];
|
||||
const withoutSchedule: Junior[] = [];
|
||||
|
||||
for (const junior of juniors) {
|
||||
const schedule = scheduleMap.get(junior.id);
|
||||
if (schedule) {
|
||||
withSchedule.push({ junior, schedule });
|
||||
} else {
|
||||
withoutSchedule.push(junior);
|
||||
}
|
||||
}
|
||||
|
||||
const monthlyTotal = this.calculateMonthlyTotal(schedules);
|
||||
|
||||
return { withSchedule, withoutSchedule, monthlyTotal };
|
||||
}
|
||||
|
||||
/**
|
||||
* Calculates the monthly equivalent total for all active schedules.
|
||||
* - DAILY: amount * 30
|
||||
* - WEEKLY: amount * 4
|
||||
* - MONTHLY: amount * 1
|
||||
*/
|
||||
private calculateMonthlyTotal(schedules: AllowanceSchedule[]): number {
|
||||
return schedules
|
||||
.filter((s) => s.status === AllowanceScheduleStatus.ON)
|
||||
.reduce((total, schedule) => {
|
||||
const amount = Number(schedule.amount);
|
||||
switch (schedule.frequency) {
|
||||
case AllowanceFrequency.DAILY:
|
||||
return total + amount * 30;
|
||||
case AllowanceFrequency.WEEKLY:
|
||||
return total + amount * 4;
|
||||
case AllowanceFrequency.MONTHLY:
|
||||
return total + amount;
|
||||
default:
|
||||
return total;
|
||||
}
|
||||
}, 0);
|
||||
}
|
||||
|
||||
async createSchedule(
|
||||
guardianId: string,
|
||||
juniorId: string,
|
||||
body: CreateAllowanceScheduleRequestDto,
|
||||
): Promise<AllowanceSchedule> {
|
||||
const doesBelong = await this.juniorService.doesJuniorBelongToGuardian(guardianId, juniorId);
|
||||
if (!doesBelong) {
|
||||
this.logger.error(`Junior ${juniorId} does not belong to guardian ${guardianId}`);
|
||||
throw new BadRequestException('JUNIOR.NOT_BELONG_TO_GUARDIAN');
|
||||
}
|
||||
|
||||
const existingSchedule = await this.allowanceScheduleRepository.findByGuardianAndJunior(guardianId, juniorId);
|
||||
if (existingSchedule) {
|
||||
throw new BadRequestException('ALLOWANCE.ALREADY_EXISTS');
|
||||
}
|
||||
|
||||
const nextRunAt = this.computeNextRunAt(body.frequency, body.status);
|
||||
return this.allowanceScheduleRepository.createSchedule(guardianId, juniorId, body, nextRunAt);
|
||||
}
|
||||
|
||||
private computeNextRunAt(frequency: AllowanceFrequency, status: AllowanceScheduleStatus): Date {
|
||||
const base = moment();
|
||||
if (status === AllowanceScheduleStatus.OFF) {
|
||||
return base.toDate();
|
||||
}
|
||||
|
||||
if (this.isTestMode) {
|
||||
// Test mode: DAILY=5min, WEEKLY=10min, MONTHLY=15min
|
||||
switch (frequency) {
|
||||
case AllowanceFrequency.DAILY:
|
||||
return base.add(5, 'minutes').toDate();
|
||||
case AllowanceFrequency.WEEKLY:
|
||||
return base.add(10, 'minutes').toDate();
|
||||
case AllowanceFrequency.MONTHLY:
|
||||
return base.add(15, 'minutes').toDate();
|
||||
default:
|
||||
return base.toDate();
|
||||
}
|
||||
}
|
||||
|
||||
// Production mode: real intervals
|
||||
switch (frequency) {
|
||||
case AllowanceFrequency.DAILY:
|
||||
return base.add(1, 'day').toDate();
|
||||
case AllowanceFrequency.WEEKLY:
|
||||
return base.add(1, 'week').toDate();
|
||||
case AllowanceFrequency.MONTHLY:
|
||||
return base.add(1, 'month').toDate();
|
||||
default:
|
||||
return base.toDate();
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Updates an existing allowance schedule.
|
||||
* Recalculates nextRunAt if frequency or status changes.
|
||||
*/
|
||||
async updateSchedule(
|
||||
guardianId: string,
|
||||
scheduleId: string,
|
||||
body: UpdateAllowanceScheduleRequestDto,
|
||||
): Promise<AllowanceSchedule> {
|
||||
const schedule = await this.allowanceScheduleRepository.findByIdAndGuardian(scheduleId, guardianId);
|
||||
|
||||
if (!schedule) {
|
||||
this.logger.error(`Schedule ${scheduleId} not found for guardian ${guardianId}`);
|
||||
throw new NotFoundException('ALLOWANCE.NOT_FOUND');
|
||||
}
|
||||
|
||||
// Check if frequency or status is changing (need to recalculate nextRunAt)
|
||||
const frequencyChanged = body.frequency && body.frequency !== schedule.frequency;
|
||||
const statusChanged = body.status && body.status !== schedule.status;
|
||||
|
||||
// Update fields if provided
|
||||
if (body.amount !== undefined) {
|
||||
schedule.amount = body.amount;
|
||||
}
|
||||
if (body.frequency !== undefined) {
|
||||
schedule.frequency = body.frequency;
|
||||
}
|
||||
if (body.status !== undefined) {
|
||||
schedule.status = body.status;
|
||||
}
|
||||
|
||||
// Recalculate nextRunAt if frequency or status changed
|
||||
if (frequencyChanged || statusChanged) {
|
||||
schedule.nextRunAt = this.computeNextRunAt(schedule.frequency, schedule.status);
|
||||
}
|
||||
|
||||
this.logger.log(`Updating schedule ${scheduleId} for guardian ${guardianId}`);
|
||||
return this.allowanceScheduleRepository.updateSchedule(schedule);
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets a lightweight summary of allowances for the home page.
|
||||
* Only fetches active schedules for efficiency.
|
||||
*/
|
||||
async getSummary(guardianId: string): Promise<AllowanceSummary> {
|
||||
// Only fetch active schedules, ordered by nextRunAt (nearest first)
|
||||
const activeSchedules = await this.allowanceScheduleRepository.findActiveByGuardianId(guardianId);
|
||||
|
||||
// The first one is the nearest (already sorted by nextRunAt ASC)
|
||||
const nextPaymentAt = activeSchedules.length > 0 ? activeSchedules[0].nextRunAt : null;
|
||||
|
||||
// Calculate monthly total from active schedules
|
||||
const monthlyTotal = this.calculateMonthlyTotal(activeSchedules);
|
||||
|
||||
return { nextPaymentAt, monthlyTotal };
|
||||
}
|
||||
|
||||
/**
|
||||
* Deletes an allowance schedule.
|
||||
*/
|
||||
async deleteSchedule(guardianId: string, scheduleId: string): Promise<void> {
|
||||
const schedule = await this.allowanceScheduleRepository.findByIdAndGuardian(scheduleId, guardianId);
|
||||
|
||||
if (!schedule) {
|
||||
this.logger.error(`Schedule ${scheduleId} not found for guardian ${guardianId}`);
|
||||
throw new NotFoundException('ALLOWANCE.NOT_FOUND');
|
||||
}
|
||||
|
||||
this.logger.log(`Deleting schedule ${scheduleId} for guardian ${guardianId}`);
|
||||
await this.allowanceScheduleRepository.deleteById(scheduleId);
|
||||
}
|
||||
}
|
||||
@@ -1,3 +0,0 @@
|
||||
export * from './allowance-queue.service';
|
||||
export * from './allowance.service';
|
||||
export * from './allowance-worker.service';
|
||||
@@ -1,99 +0,0 @@
|
||||
import { MiddlewareConsumer, Module } from '@nestjs/common';
|
||||
import { ConfigModule, ConfigService } from '@nestjs/config';
|
||||
import { APP_FILTER, APP_PIPE } from '@nestjs/core';
|
||||
import { EventEmitterModule } from '@nestjs/event-emitter';
|
||||
import { ScheduleModule } from '@nestjs/schedule';
|
||||
import { TypeOrmModule } from '@nestjs/typeorm';
|
||||
import { I18nMiddleware, I18nModule } from 'nestjs-i18n';
|
||||
import { LoggerModule } from 'nestjs-pino';
|
||||
import { DataSource } from 'typeorm';
|
||||
import { addTransactionalDataSource } from 'typeorm-transactional';
|
||||
import { AuthModule } from './auth/auth.module';
|
||||
import { AllowanceModule } from './allowance/allowance.module';
|
||||
import { CardModule } from './card/card.module';
|
||||
import { CacheModule } from './common/modules/cache/cache.module';
|
||||
import { LookupModule } from './common/modules/lookup/lookup.module';
|
||||
import { NeoLeapModule } from './common/modules/neoleap/neoleap.module';
|
||||
import { NotificationModule } from './common/modules/notification/notification.module';
|
||||
import { OtpModule } from './common/modules/otp/otp.module';
|
||||
import { AllExceptionsFilter, buildI18nValidationExceptionFilter } from './core/filters';
|
||||
import { buildConfigOptions, buildLoggerOptions, buildTypeormOptions } from './core/module-options';
|
||||
import { buildI18nOptions } from './core/module-options/i18n-options';
|
||||
import { buildValidationPipe } from './core/pipes';
|
||||
import { CronModule } from './cron/cron.module';
|
||||
import { CustomerModule } from './customer/customer.module';
|
||||
import { migrations } from './db';
|
||||
import { DocumentModule } from './document/document.module';
|
||||
import { GuardianModule } from './guardian/guardian.module';
|
||||
import { HealthModule } from './health/health.module';
|
||||
import { JuniorModule } from './junior/junior.module';
|
||||
import { UserModule } from './user/user.module';
|
||||
import { WebhookModule } from './webhook/webhook.module';
|
||||
import { MoneyRequestModule } from './money-request/money-request.module';
|
||||
|
||||
@Module({
|
||||
controllers: [],
|
||||
imports: [
|
||||
ConfigModule.forRoot(buildConfigOptions()),
|
||||
TypeOrmModule.forRootAsync({
|
||||
imports: [],
|
||||
inject: [ConfigService],
|
||||
useFactory: (config: ConfigService) => {
|
||||
return buildTypeormOptions(config, migrations);
|
||||
},
|
||||
async dataSourceFactory(options) {
|
||||
if (!options) {
|
||||
throw new Error('Invalid options passed');
|
||||
}
|
||||
|
||||
return addTransactionalDataSource(new DataSource(options));
|
||||
},
|
||||
}),
|
||||
LoggerModule.forRootAsync({
|
||||
useFactory: (config: ConfigService) => buildLoggerOptions(config),
|
||||
inject: [ConfigService],
|
||||
}),
|
||||
I18nModule.forRoot(buildI18nOptions()),
|
||||
CacheModule,
|
||||
EventEmitterModule.forRoot(),
|
||||
ScheduleModule.forRoot(),
|
||||
// App modules
|
||||
AuthModule,
|
||||
AllowanceModule,
|
||||
UserModule,
|
||||
|
||||
CustomerModule,
|
||||
JuniorModule,
|
||||
GuardianModule,
|
||||
CardModule,
|
||||
|
||||
NotificationModule,
|
||||
OtpModule,
|
||||
DocumentModule,
|
||||
LookupModule,
|
||||
|
||||
HealthModule,
|
||||
|
||||
CronModule,
|
||||
NeoLeapModule,
|
||||
WebhookModule,
|
||||
MoneyRequestModule,
|
||||
],
|
||||
providers: [
|
||||
// Global Pipes
|
||||
{
|
||||
inject: [ConfigService],
|
||||
provide: APP_PIPE,
|
||||
useFactory: (config: ConfigService) => buildValidationPipe(config),
|
||||
},
|
||||
|
||||
// Global Filters (order matters)
|
||||
{ provide: APP_FILTER, useClass: AllExceptionsFilter },
|
||||
{ provide: APP_FILTER, useValue: buildI18nValidationExceptionFilter() },
|
||||
],
|
||||
})
|
||||
export class AppModule {
|
||||
configure(consumer: MiddlewareConsumer) {
|
||||
consumer.apply(I18nMiddleware).forRoutes('*');
|
||||
}
|
||||
}
|
||||
@@ -1,16 +0,0 @@
|
||||
import { HttpModule } from '@nestjs/axios';
|
||||
import { Module } from '@nestjs/common';
|
||||
import { JwtModule } from '@nestjs/jwt';
|
||||
import { JuniorModule } from '~/junior/junior.module';
|
||||
import { UserModule } from '~/user/user.module';
|
||||
import { AuthController } from './controllers';
|
||||
import { AuthService } from './services';
|
||||
import { AccessTokenStrategy } from './strategies';
|
||||
|
||||
@Module({
|
||||
imports: [JwtModule.register({}), UserModule, JuniorModule, HttpModule],
|
||||
providers: [AuthService, AccessTokenStrategy],
|
||||
controllers: [AuthController],
|
||||
exports: [],
|
||||
})
|
||||
export class AuthModule {}
|
||||
@@ -1 +0,0 @@
|
||||
export const COUNTRY_CODE_REGEX = /^\+\d{1,3}$/;
|
||||
@@ -1,3 +0,0 @@
|
||||
export * from './country-code-regex.constant.';
|
||||
export * from './passcode-regext.constant';
|
||||
export * from './password-regex.constant';
|
||||
@@ -1 +0,0 @@
|
||||
export const PASSCODE_REGEX = /^\d{6}$/;
|
||||
@@ -1 +0,0 @@
|
||||
export const PASSWORD_REGEX = /^(?=.*[A-Z])(?=.*[a-z])(?=.*\d)(?=.*[@$!%*?&#\-_])[A-Za-z\d@$!%*?&#\-_]{8,}$/;
|
||||
@@ -1,107 +0,0 @@
|
||||
import { Body, Controller, HttpCode, HttpStatus, Post, Req, UseGuards } from '@nestjs/common';
|
||||
import { ApiBearerAuth, ApiTags } from '@nestjs/swagger';
|
||||
import { Request } from 'express';
|
||||
import { AuthenticatedUser, Public } from '~/common/decorators';
|
||||
import { AccessTokenGuard } from '~/common/guards';
|
||||
import { ApiDataResponse, ApiLangRequestHeader } from '~/core/decorators';
|
||||
import { ResponseFactory } from '~/core/utils';
|
||||
import {
|
||||
ChangePasswordRequestDto,
|
||||
CreateUnverifiedUserRequestDto,
|
||||
ForgetPasswordRequestDto,
|
||||
JuniorLoginRequestDto,
|
||||
LoginRequestDto,
|
||||
RefreshTokenRequestDto,
|
||||
SendForgetPasswordOtpRequestDto,
|
||||
setJuniorPasswordRequestDto,
|
||||
VerifyForgetPasswordOtpRequestDto,
|
||||
VerifyUserRequestDto,
|
||||
} from '../dtos/request';
|
||||
import { SendForgetPasswordOtpResponseDto, SendRegisterOtpResponseDto } from '../dtos/response';
|
||||
import { LoginResponseDto } from '../dtos/response/login.response.dto';
|
||||
import { VerifyForgetPasswordOtpResponseDto } from '../dtos/response/verify-forget-password-otp.response.dto';
|
||||
import { IJwtPayload } from '../interfaces';
|
||||
import { AuthService } from '../services';
|
||||
|
||||
@Controller('auth')
|
||||
@ApiTags('Auth')
|
||||
@ApiBearerAuth()
|
||||
@ApiLangRequestHeader()
|
||||
export class AuthController {
|
||||
constructor(private readonly authService: AuthService) {}
|
||||
@Post('register/otp')
|
||||
async register(@Body() createUnverifiedUserDto: CreateUnverifiedUserRequestDto) {
|
||||
const phoneNumber = await this.authService.sendRegisterOtp(createUnverifiedUserDto);
|
||||
return ResponseFactory.data(new SendRegisterOtpResponseDto(phoneNumber));
|
||||
}
|
||||
|
||||
@Post('register/verify')
|
||||
async verifyUser(@Body() verifyUserDto: VerifyUserRequestDto) {
|
||||
const [res, user] = await this.authService.verifyUser(verifyUserDto);
|
||||
return ResponseFactory.data(new LoginResponseDto(res, user));
|
||||
}
|
||||
|
||||
@Post('login')
|
||||
async login(@Body() verifyUserDto: LoginRequestDto) {
|
||||
const [res, user] = await this.authService.loginWithPassword(verifyUserDto);
|
||||
return ResponseFactory.data(new LoginResponseDto(res, user));
|
||||
}
|
||||
|
||||
@Post('forget-password/otp')
|
||||
async forgetPassword(@Body() sendForgetPasswordOtpDto: SendForgetPasswordOtpRequestDto) {
|
||||
const maskedNumber = await this.authService.sendForgetPasswordOtp(sendForgetPasswordOtpDto);
|
||||
return ResponseFactory.data(new SendForgetPasswordOtpResponseDto(maskedNumber));
|
||||
}
|
||||
|
||||
@Post('forget-password/verify')
|
||||
@HttpCode(HttpStatus.OK)
|
||||
@ApiDataResponse(VerifyForgetPasswordOtpResponseDto)
|
||||
async verifyForgetPasswordOtp(@Body() forgetPasswordDto: VerifyForgetPasswordOtpRequestDto) {
|
||||
const { token, user } = await this.authService.verifyForgetPasswordOtp(forgetPasswordDto);
|
||||
|
||||
return ResponseFactory.data(new VerifyForgetPasswordOtpResponseDto(token, user));
|
||||
}
|
||||
|
||||
@Post('forget-password/reset')
|
||||
@HttpCode(HttpStatus.NO_CONTENT)
|
||||
resetPassword(@Body() forgetPasswordDto: ForgetPasswordRequestDto) {
|
||||
return this.authService.resetPassword(forgetPasswordDto);
|
||||
}
|
||||
|
||||
@Post('change-password')
|
||||
@HttpCode(HttpStatus.NO_CONTENT)
|
||||
@UseGuards(AccessTokenGuard)
|
||||
changePassword(@AuthenticatedUser() { sub }: IJwtPayload, @Body() forgetPasswordDto: ChangePasswordRequestDto) {
|
||||
return this.authService.changePassword(sub, forgetPasswordDto);
|
||||
}
|
||||
|
||||
@Post('junior/set-password')
|
||||
@HttpCode(HttpStatus.NO_CONTENT)
|
||||
@Public()
|
||||
setJuniorPasscode(@Body() setPassworddto: setJuniorPasswordRequestDto) {
|
||||
return this.authService.setJuniorPassword(setPassworddto);
|
||||
}
|
||||
|
||||
@Post('junior/login')
|
||||
@HttpCode(HttpStatus.OK)
|
||||
@ApiDataResponse(LoginResponseDto)
|
||||
async juniorLogin(@Body() juniorLoginDto: JuniorLoginRequestDto) {
|
||||
const [res, user] = await this.authService.juniorLogin(juniorLoginDto);
|
||||
|
||||
return ResponseFactory.data(new LoginResponseDto(res, user));
|
||||
}
|
||||
|
||||
@Post('refresh-token')
|
||||
@Public()
|
||||
async refreshToken(@Body() { refreshToken }: RefreshTokenRequestDto) {
|
||||
const [res, user] = await this.authService.refreshToken(refreshToken);
|
||||
return ResponseFactory.data(new LoginResponseDto(res, user));
|
||||
}
|
||||
|
||||
@Post('logout')
|
||||
@HttpCode(HttpStatus.NO_CONTENT)
|
||||
@UseGuards(AccessTokenGuard)
|
||||
async logout(@Req() request: Request) {
|
||||
await this.authService.logout(request);
|
||||
}
|
||||
}
|
||||
@@ -1 +0,0 @@
|
||||
export * from './auth.controller';
|
||||
@@ -1,23 +0,0 @@
|
||||
import { ApiProperty } from '@nestjs/swagger';
|
||||
import { IsNotEmpty, IsString, Matches } from 'class-validator';
|
||||
import { i18nValidationMessage as i18n } from 'nestjs-i18n';
|
||||
import { PASSWORD_REGEX } from '~/auth/constants';
|
||||
|
||||
export class ChangePasswordRequestDto {
|
||||
@ApiProperty({ example: 'currentPassword@123' })
|
||||
@IsString({ message: i18n('validation.IsString', { path: 'general', property: 'auth.currentPassword' }) })
|
||||
@IsNotEmpty({ message: i18n('validation.IsNotEmpty', { path: 'general', property: 'auth.currentPassword' }) })
|
||||
currentPassword!: string;
|
||||
|
||||
@ApiProperty({ example: 'Abcd1234@' })
|
||||
@Matches(PASSWORD_REGEX, {
|
||||
message: i18n('validation.Matches', { path: 'general', property: 'auth.newPassword' }),
|
||||
})
|
||||
newPassword!: string;
|
||||
|
||||
@ApiProperty({ example: 'Abcd1234@' })
|
||||
@Matches(PASSWORD_REGEX, {
|
||||
message: i18n('validation.Matches', { path: 'general', property: 'auth.confirmNewPassword' }),
|
||||
})
|
||||
confirmNewPassword!: string;
|
||||
}
|
||||
@@ -1,4 +0,0 @@
|
||||
import { OmitType } from '@nestjs/swagger';
|
||||
import { VerifyUserRequestDto } from './verify-user.request.dto';
|
||||
|
||||
export class CreateUnverifiedUserRequestDto extends OmitType(VerifyUserRequestDto, ['otp']) {}
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user