Мой учебный проект-приложение FastAPI для благотворительного фонда поддержки кошачьих.
Фонд собирает пожертвования на различные целевые проекты: на медицинское обслуживание нуждающихся хвостатых, на обустройство кошачьей колонии в подвале, на корм оставшимся без попечения кошкам — на любые цели, связанные с поддержкой кошачьей популяции.
В Фонде QRKot может быть открыто несколько целевых проектов. У каждого проекта есть название, описание и сумма, которую планируется собрать. После того как нужная сумма собрана — проект закрывается.
Пожертвования в проекты поступают по принципу First In, First Out: все пожертвования идут в проект, открытый раньше других; когда этот проект набирает необходимую сумму и закрывается — пожертвования начинают поступать в следующий проект.
Каждый пользователь может сделать пожертвование и сопроводить его комментарием. Пожертвования не целевые: они вносятся в фонд, а не в конкретный проект. Каждое полученное пожертвование автоматически добавляется в первый открытый проект, который ещё не набрал нужную сумму. Если пожертвование больше нужной суммы или же в Фонде нет открытых проектов — оставшиеся деньги ждут открытия следующего проекта. При создании нового проекта все неинвестированные пожертвования автоматически вкладываются в новый проект.
Целевые проекты создаются администраторами сайта.
Любой пользователь может видеть список всех проектов, включая требуемые и уже внесенные суммы. Это касается всех проектов — и открытых, и закрытых.
Зарегистрированные пользователи могут отправлять пожертвования и просматривать список своих пожертвований.
В приложении существует 3 модели:
- Пользователи
- Проекты
- Пожертвования
Модель пользователей имеет следующие свойства:
- Использует встроенную библиотеку FastAPI Users
- Метод передачи токена (транспорт) - Bearer
- Стратегия авторизации JWT
- Базовая модель пользователя не изменялась
Модель проектов имеет следующие поля:
- id — первичный ключ
- name — уникальное название проекта, обязательное строковое поле; допустимая длина строки — от 1 до 100 символов включительно
- description — описание, обязательное поле, текст; не менее одного символа
- full_amount — требуемая сумма, целочисленное поле; больше 0
- invested_amount — внесённая сумма, целочисленное поле; значение по умолчанию — 0
- fully_invested — булево значение, указывающее на то, собрана ли нужная сумма для проекта (закрыт ли проект); значение по умолчанию — False
- create_date — дата создания проекта, тип DateTime, должно добавляться автоматически в момент создания проекта
- close_date — дата закрытия проекта, DateTime, проставляется автоматически в момент набора нужной суммы
Любой посетитель сайта (в том числе неавторизованный) может посмотреть список всех проектов.
Суперпользователь может:
- создавать проекты,
- удалять проекты, в которые не было внесено средств,
- изменять название и описание существующего проекта, устанавливать для него новую требуемую сумму (но не меньше уже внесённой).
Никто не может менять через API размер внесённых средств, удалять или модифицировать закрытые проекты, изменять даты создания и закрытия проектов.
Модель пожертвований имеет следующие поля:
- id — первичный ключ
- user_id — id пользователя, сделавшего пожертвование. Foreign Key на поле user.id из таблицы пользователей
- comment — необязательное текстовое поле
- full_amount — сумма пожертвования, целочисленное поле; больше 0
- invested_amount — сумма из пожертвования, которая распределена по проектам; значение по умолчанию равно 0
- fully_invested — булево значение, указывающее на то, все ли деньги из пожертвования были переведены в тот или иной проект; по умолчанию равно False
- create_date — дата пожертвования; тип DateTime; добавляется автоматически в момент поступления пожертвования
- close_date — дата, когда вся сумма пожертвования была распределена по проектам; тип DateTime; добавляется автоматически в момент выполнения условия
Любой зарегистрированный пользователь может сделать пожертвование.
Зарегистрированный пользователь может просматривать только свои пожертвования, при этом ему выводится только четыре поля:
- id
- comment
- full_amount
- create_date
Информация о том, инвестировано пожертвование в какой-то проект или нет, обычному пользователю недоступна.
Суперпользователь может просматривать список всех пожертвований, при этом ему выводятся все поля модели.
Редактировать или удалять пожертвования не может никто.
Сразу после создания нового проекта или пожертвования
запускается процесс «инвестирования»
(увеличение invested_amount как в пожертвованиях,
так и в проектах, установка значений fully_invested и close_date,
при необходимости).
Если создан новый проект, а в базе существуют «свободные» (не распределённые по проектам) суммы пожертвований — они автоматически инвестируются в новый проект, и в ответе API эти суммы учитываются. То же касается и создания пожертвований: если в момент пожертвования есть открытые проекты, эти пожертвования должны автоматически зачислиться на их счета.
Гарантирует, что все операции производятся за единую транзакцию, и никто из других пользователей не изменит состояние проектов или пожертвований, пока осуществляются подсчёты для инвестиции.
Подробности работы API можно посмотреть, открыв файл openapi.json
на сайте redoc.
Чтобы загрузить файл, нужно зайти на сайт и нажать
сверху на кнопку Upload a file, затем выбрать нужный документ.
Если нашли баги или недочеты, то можете написать на почту: lleb41@mail.ru
THAT'S ALL.