АПИ для креш-курса на python

.flake8

@@ -0,0 +1,12 @@
+[flake8]
+inline-quotes = "
+max-line-length = 88
+max-cognitive-complexity = 7
+enable-extensions = G
+exclude =
+    .git,
+    __pycache__,
+    venv,
+    migrations,
+    settings.py
+ignore = VNE001, B009, I201, I100, VNE003, A003, B008, I202, E731, W504

.gitignore

@@ -0,0 +1,125 @@
+# Editors
+.vscode/
+.idea/
+
+# Vagrant
+.vagrant/
+
+# Mac/OSX
+.DS_Store
+
+# Windows
+Thumbs.db
+
+# Source for the following rules: https://raw.githubusercontent.com/github/gitignore/master/Python.gitignore
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# celery beat schedule file
+celerybeat-schedule
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json

README.md

@@ -1,2 +1,69 @@
-# python-web-course
-Практический курс по построению Web API на python
+# Практический курс по построению Web API на python
+
+## Подготовка в работе
+1. Клонировать репозиторий `https://github.com/kontur-web-courses/python-web-course`
+2. Развернуть виртуальное окружение и установить зависимости из `requirements.txt`. 
+C помощью IDE (например PyCharm) или командной строки:  
+```shell
+$ python3 -m venv venv # создание виртуального окрущения
+
+$ venv\Scripts\activate.bat # активация виртуального окружения для Windows
+$ source venv/bin/activate # активация виртуального окружения для Linux и MacOS
+
+(venv)$ pip3 install -r requirements.txt # установка зависимостей
+
+(venv)$ deactivate # выход из виртуального окружения, после завершения работы над проектом
+```
+
+
+## Генерация тестовых данных
+Для регенерации тестовых данных можно зайти в админку под суперпользователем и на
+вкладке "Ключи" нажать "Перегенерировать все данные" выполнится функция ```srvices.data.
+regenerate()``` после ее
+выполнения БД будет очищена и наполнена тестовыми данными, будет создано три
+организации и 19 сотрудников. В каждой из организаций будет добавлено по 4 сотрудника
+1 админ, 2 пользователя и 1 утверждающий(approver). Остальные сотрудники останутся 
+без привязки к организации, трое из них будет с флагом ```deleted=True``` 
+Каждая роль(Roles) имеет свои операции(Operations)
+Также будет перегенерирован ключ для доступа к апи, он будет годен 24 часа, при 
+запросах в апи его необходимо включать в заголовки ```headers={"Token": api_token}```
+
+## Модели
+
+### Organization - организации
+
+- В организации можно добавлять несколько сотрудников, только с флагом 
+  ```deleted=False```
+- У организации есть реквизиты Requisites
+
+### Requisites - реквизиты организации
+
+- Реквизиты привязываются к организации и выбираются из списка RequisitesName
+
+### Employee - сотрудники
+
+- Сотрудники это User с флагом ```is_superuser = False```
+- Сотрудник может быть помечен как удаленный ```deleted=False```
+- У сотрудника назначаются в организации определенные роли(RoleOperations)
+
+### RoleOperations - операции для роли
+
+- Список операции(Operations) привязанных к роли(Roles)
+
+
+## АПИ
+
+Для работы с апи необходимо использовать апи-ключ, он генерируется и доступен в админке
+
+### Сотрудники
+- Получение списка сотрудников
+- Получение одного сотрудника по portal_user_id
+- Создание сотрудника
+- Обновление сотрудника
+
+### Организации
+- Получение списка организаций
+- Получение одной организации по id
+- Создание организации
+- Обновление организации
+- Добавление сотрудника в организацию

api/permissions.py

@@ -0,0 +1,28 @@
+from datetime import datetime
+
+import jwt
+from django.conf import settings
+from django.utils import timezone
+from rest_framework.permissions import BasePermission
+
+from tokens.models import Token
+
+
+class KeyPermissions(BasePermission):
+    def has_permission(self, request, view) -> bool:
+        if "Token" in request.headers:
+            token_request = request.headers.get("Token")
+            token_db = Token.objects.first()
+            try:
+                payload = jwt.decode(
+                    token_request, token_db.secret, algorithms=[settings.JWT_ALGORITHM]
+                )
+            except Exception:
+                return False
+            expired: int = payload.get("exp", 0)
+            if datetime.fromtimestamp(expired, tz=timezone.utc) > datetime.now(
+                tz=timezone.utc
+            ):
+                return True
+
+        return False

api/serializers/__init__.py

@@ -0,0 +1,21 @@
+from api.serializers.employees import (
+    CreateEmployeeSerializer,
+    ListEmployeeSerializer,
+    UpdateEmployeeSerializer,
+)
+from api.serializers.organizations import (
+    CreateOrganizationSerializer,
+    ListOrganizationSerializer,
+    OrganizationAddEmployeeSerializer,
+    UpdateOrganizationSerializer,
+)
+
+__all__ = (
+    "ListEmployeeSerializer",
+    "CreateEmployeeSerializer",
+    "UpdateEmployeeSerializer",
+    "OrganizationAddEmployeeSerializer",
+    "CreateOrganizationSerializer",
+    "ListOrganizationSerializer",
+    "UpdateOrganizationSerializer",
+)

api/serializers/employees.py

@@ -0,0 +1,57 @@
+from django.contrib.auth import get_user_model
+from rest_framework.fields import SerializerMethodField
+from rest_framework.serializers import ModelSerializer
+
+from users.models import RoleOperations
+
+User = get_user_model()
+
+
+class ListEmployeeSerializer(ModelSerializer):
+    operations = SerializerMethodField()
+
+    class Meta:
+        model = User
+        fields = (
+            "portal_user_id",
+            "email",
+            "phone",
+            "role",
+            "operations",
+            "deleted",
+            "created_at",
+            "updated_at",
+        )
+
+    @staticmethod
+    def get_operations(obj):
+        return RoleOperations.objects.filter(role__in=obj.role).values_list(
+            "operations", flat=True
+        )
+
+
+class CreateEmployeeSerializer(ModelSerializer):
+    class Meta:
+        model = User
+        fields = (
+            "portal_user_id",
+            "email",
+            "phone",
+            "role",
+        )
+        extra_kwargs = {
+            "portal_user_id": {"required": True},
+            "email": {"required": True},
+            "role": {"required": True},
+            "phone": {"required": False},
+        }
+
+
+class UpdateEmployeeSerializer(ModelSerializer):
+    class Meta:
+        model = User
+        fields = (
+            "phone",
+            "role",
+            "deleted",
+        )

api/serializers/organizations.py

@@ -0,0 +1,72 @@
+from django.contrib.auth import get_user_model
+from rest_framework.fields import CharField, ListField
+from rest_framework.serializers import ModelSerializer
+
+from api.serializers.employees import ListEmployeeSerializer
+from api.validations import ValidateEmployeeMixin
+from organizations.models import Organization, Requisites
+
+User = get_user_model()
+
+
+class RequisitesSerializer(ModelSerializer):
+    class Meta:
+        model = Requisites
+        fields = ("name", "value")
+
+
+class ListOrganizationSerializer(ModelSerializer):
+    employees = ListEmployeeSerializer(many=True, required=False)
+    requisites = RequisitesSerializer(many=True)
+
+    class Meta:
+        model = Organization
+        fields = (
+            "id",
+            "product_name",
+            "requisites",
+            "employees",
+            "created_at",
+            "updated_at",
+        )
+        extra_kwargs = {
+            "id": {"required": False, "read_only": True},
+            "created_at": {"read_only": True},
+            "updated_at": {"read_only": True},
+        }
+
+
+class UpdateOrganizationSerializer(ModelSerializer):
+    requisites = RequisitesSerializer(many=True)
+
+    class Meta:
+        model = Organization
+        fields = ("requisites",)
+
+
+class OrganizationAddEmployeeSerializer(ModelSerializer, ValidateEmployeeMixin):
+    employees = ListField(
+        child=CharField(),
+        required=False,
+    )
+
+    class Meta:
+        model = Organization
+        fields = ("employees",)
+
+
+class CreateOrganizationSerializer(ModelSerializer, ValidateEmployeeMixin):
+    requisites = RequisitesSerializer(many=True)
+    employees = ListField(
+        child=CharField(),
+        required=False,
+    )
+
+    class Meta:
+        model = Organization
+        fields = (
+            "product_name",
+            "requisites",
+            "employees",
+        )
+        extra_kwargs = {"employees": {"required": False}}