Develop

.github/workflows/main.yml

@@ -62,6 +62,27 @@ jobs:
           push: true
           tags: ${{ secrets.DOCKER_USERNAME }}/${{ secrets.PROJECT_NAME }}_backend:latest
 
+
+  build_gateway_and_push_to_docker_hub:
+    name: Push gateway Docker image to DockerHub
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out the repo
+        uses: actions/checkout@v3
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v2
+      - name: Login to Docker
+        uses: docker/login-action@v2
+        with:
+          username: ${{ secrets.DOCKER_USERNAME }}
+          password: ${{ secrets.DOCKER_PASSWORD }}
+      - name: Push to DockerHub
+        uses: docker/build-push-action@v4
+        with:
+          context: ./gateway/
+          push: true
+          tags: ${{ secrets.DOCKER_USERNAME }}/${{ secrets.PROJECT_NAME }}_gateway:latest
+
   deploy:
     runs-on: ubuntu-latest
     needs:
@@ -74,24 +95,23 @@ jobs:
         with:
           host: ${{ secrets.HOST }}
           username: ${{ secrets.USER }}
-          key: ${{ secrets.SSH_KEY }}
-          passphrase: ${{ secrets.SSH_PASSPHRASE }}
+          password: ${{ secrets.PASSWORD}}
           source: "docker-compose.production.yml"
           target: "documents_templates"
       - name: Executing remote ssh commands to deploy
         uses: appleboy/ssh-action@master
         with:
           host: ${{ secrets.HOST }}
           username: ${{ secrets.USER }}
-          key: ${{ secrets.SSH_KEY }}
-          passphrase: ${{ secrets.SSH_PASSPHRASE }}
+          password: ${{ secrets.PASSWORD }}
           script: |
             cd documents_templates
             sudo docker compose -f docker-compose.production.yml pull
             sudo docker compose -f docker-compose.production.yml down
             sudo docker compose -f docker-compose.production.yml up -d
             sudo docker system prune -af
-
+
+
   send_message:
     runs-on: ubuntu-latest
     needs: deploy

README.md

@@ -8,6 +8,25 @@
 многих областях, включая бизнес, юриспруденцию, образование и другие.
 
 
+
+## Основная логика
+В основе логики шаблонизатора лежит создание готовых word документов на основе шаблона. Шаблон создается по определенным правилам и хранится на сервере в виде docx файлов. В шаблонах предусмотрены возможности дополнительных обработок вводимых пользователем данных (склонения по падежам, доп форматирование и др), более подробно об этом можно глянуть в инструкции([ссылка](https://github.com/document-template-engine/demo-repository/files/13055545/_._._.docx)). На данном этабе шаблон и его поля создаются администратором. Система регистрации и авторизации построена на основе djoser, с некоторыми модификациями
+
+Невторизированный пользователь имеет возможность:
+  - просмотреть список всех доступных шаблонов базы /api/templates/
+  - скачать шаблон документа /api/templates/{id}/download_draft/
+  - сформировать превью документа на основе шаблона и предоставляемых данных полей и скачать его (без сохранения на сервере)  /api/templates/{id}/download_preview/
+
+Авторизованный пользователь имеет возможность:
+  - формировать документы на основании выбранного шаблона и предоставленных данных и сохранять документы на сервере
+  - скачивать сохраненные документы в формате docx /api/documents/{id}/download_dpcument/
+  - добавлять шаблоны или документы в избранное
+  - доступ к документам и данным отдельных документов имеет только администратор или автор документа
+
+Администратор имеет возможность:
+  - загрузить информацию о новом шаблоне (наименование, описание полей) POST /api/templates/
+  - обновить docx файл шаблона PUT(PATCH) /api/templates/{id}/upload_template/
+
 ### Технологии
 - **Python - 3.9**
 - **Django - 3.2**
@@ -17,7 +36,6 @@
 
 ### Авторы
 - [Nikki Nikonor](https://github.com/Paymir121)
-- [Дубинин Николай](https://github.com/dubininnik)
 - [Тимченко Александр](https://github.com/ASTimch)
 - [Скуридин Андрей](https://github.com/andrzej-skuridin)
 - [Николай Петров](https://github.com/NikolayPetrow23)
@@ -30,116 +48,121 @@
 Клонируете репозиторий:
 
 ```bash
-git clone  git@github.com:document-template-engine/backend.git
+    git clone  git@github.com:document-template-engine/backend.git
 ```
 
-### Cоздать и активировать виртуальное окружение:
+### Cоздать  виртуальное окружение:
+```
+    python -m venv venv
+```
+# активировать виртуальное окружение, Если у вас Linux/macOS
 ```
-python -m venv venv
-
-# Если у вас Linux/macOS
-
     source venv/bin/activate
-
-# Если у вас windows
-
+```
+# Активировать виртуальное окружение, Если у вас windows
+```
     source venv/scripts/activate
-
 ```
+
 ### Установить зависимости из файла requirements.txt:
 ```
-cd backend
-python -m pip install --upgrade pip
-pip install -r requirements.txt
+    cd backend
+    python -m pip install --upgrade pip
+    pip install -r requirements.txt
 ```
 
 
 ### Выполнить миграции:
 ```
-cd backend
-python manage.py makemigrations
-python manage.py migrate
+    python manage.py makemigrations
+    python manage.py migrate
 ```
 
 ### Запустить проект:
 ```
-cd backend
-python manage.py runserver
+    python manage.py runserver
 ```
 
 ### Создать суперпользователя:
 ```
-cd backend
-python manage.py createsuperuser
+    python manage.py createsuperuser
 ```
 
 ### Добавить темлейтов в базу:
 ```
-cd backend
-python manage.py init_templates
+    python manage.py init_field_types
+    python manage.py init_templates
+
 ```
 
 ## Запуск докер контейнеров на локальной машине:
 
 ### Билдим проект и запускаем:
 ```
-docker compose up --build
+    docker compose up --build
 ```
 
 ### Выполнить миграции:
 ```
-docker compose exec backend python manage.py migrate
+    docker compose exec backend python manage.py migrate
 ```
 
 ### Выполнить создание суперпользователя:
 ```
-docker compose exec backend python manage.py createsuperuser
+    docker compose exec backend python manage.py createsuperuser
 ```
 
 ### Выполнить Собрать статику Django:
 ```
-docker compose exec backend python manage.py collectstatic
-sudo docker compose -f docker-compose.production.yml exec backend cp -r /app/collected_static/. /app/static/
+    sudo docker compose  exec backend python manage.py collectstatic
+    sudo docker compose  exec backend cp -r /app/collected_static/. /app/static/
 ```
 
 ## Запуск докер контейнеров на удаленной машине:
 
 ### Выполнить обновление apt:
 ```
-sudo apt update
+    sudo apt update
 ```
 
 ### Билдим проект и запускаем:
 ```
-sudo docker compose -f docker-compose.production.yml up --build
+    sudo docker compose -f docker-compose.production.yml up --build
 ```
 
 ### Выполнить миграции:
 ```
-docker compose -f docker-compose.production.yml exec backend python manage.py migrate
+    sudo docker compose -f docker-compose.production.yml exec backend python manage.py migrate
 ```
 
 ### Выполнить миграции:
 ```
-docker compose -f docker-compose.production.yml exec backend python manage.py createsuperuser
+    docker compose -f docker-compose.production.yml exec backend python manage.py createsuperuser
+```
+
+### Выполнить Собрать статику Django:
+```
+    sudo docker compose -f docker-compose.production.yml exec backend python manage.py collectstatic
+    sudo docker compose -f docker-compose.production.yml exec backend cp -r /app/collected_static/. /app/static/
 ```
 
 ### Выполнить миграции:
 ```
-sudo docker compose -f docker-compose.production.yml exec backend python manage.py init_templates
+    sudo docker compose -f docker-compose.production.yml exec backend python manage.py init_field_types
+    sudo docker compose -f docker-compose.production.yml exec backend python manage.py init_templates
 ```
 
 ### Настройки nginx:
 ```
-sudo nano /etc/nginx/sites-enabled/default
+    sudo nano /etc/nginx/sites-enabled/default
 ```
 
 ## Примеры запросов и ответов к API
 
 ### Регистрация
 #### Endpoint
 ```
-POST  api/v1/users/
+    POST  api/v1/users/
 ```
 #### Пример запроса
 ```
@@ -159,7 +182,7 @@ POST  api/v1/users/
 ### Аутентификация
 #### Endpoint
 ```
-POST  api/v1/auth/token/login/
+    POST  api/v1/auth/token/login/
 ```
 
 #### Пример запроса 
@@ -180,7 +203,7 @@ POST  api/v1/auth/token/login/
 ### Узнать свои данные
 #### Endpoint.
 ```
-GET  api/v1/users/me/
+    GET  api/v1/users/me/
 ```
 
 #### Пример ответа
@@ -194,7 +217,7 @@ GET  api/v1/users/me/
 ### Просмотр списка пользователей
 #### Endpoint
 ```
-GET  api/v1/users/
+    GET  api/v1/users/
 ```
 
 #### Пример ответа.
@@ -215,17 +238,3 @@ GET  api/v1/users/
     ]
 }
 ```
-
-## Основная логика
-В основе логики шаблонизатора лежит создание готовых word документов на основе шаблона. Шаблон создается по определенным правилам и хранится на сервере в виде docx файлов. В шаблонах предусмотрены возможности дополнительных обработок вводимых пользователем данных (склонения по падежам, доп форматирование и др), более подробно об этом можно глянуть в инструкции([ссылка](https://github.com/document-template-engine/demo-repository/files/13055545/_._._.docx)). На данном этабе шаблон и его поля создаются администратором. Система регистрации и авторизации построена на основе djoser, с некоторыми модификациями
-
-Невторизированный пользователь имеет возможность:
-  - просмотреть список всех доступных шаблонов базы /api/templates/
-  - скачать шаблон документа /api/templates/{id}/download_draft/
-  - сформировать превью документа на основе шаблона и предоставляемых данных полей и скачать его (без сохранения на сервере)  /api/templates/{id}/download_preview/
-Авторизованный пользователь имеет возможность:
-  - формировать документы на основании выбранного шаблона и предоставленных данных и сохранять документы на сервере
-  - скачивать сохраненные документы в формате docx /api/documents/{id}/download_dpcument/
-  - добавлять шаблоны или документы в избранное
-  - доступ к документам и данным отдельных документов имеет только администратор или автор документа
-

backend/Dockerfile

@@ -1,22 +1,15 @@
-FROM python:3.9-bullseye
+FROM python:3.9
 
-ENV DOTNET_SYSTEM_GLOBALIZATION_INVARIANT=1
-RUN apt-get update \
-    && apt-get install -y --no-install-recommends \
-    libc6 \
-    libgcc1 \
-    libgssapi-krb5-2 \
-    libicu67 \
-    libssl1.1 \
-    libstdc++6 \
-    zlib1g
+RUN echo "deb http://deb.debian.org/debian bookworm main contrib" | tee /etc/apt/sources.list
+RUN  apt-get update
+RUN apt-get install -y --no-install-recommends libreoffice-writer
+RUN apt-get install -y libreoffice-java-common
+RUN apt-get install -y ttf-mscorefonts-installer
 
 WORKDIR /app
 
 COPY requirements.txt .
-
 RUN pip install -r requirements.txt --no-cache-dir
 
 COPY . .
-
-RUN chmod a+x commands/app.sh
+CMD ["gunicorn", "--bind", "0.0.0.0:9000", "backend.wsgi"]

backend/api/urls.py

@@ -5,7 +5,8 @@
 from django.conf.urls import url
 
 urlpatterns = [
-    path("", include("api.v1.urls")),
+    # path("v1/", include("api.v1.urls")),
+    path("v2/", include("api.v2.urls")),
 ]
 
 

backend/api/v1/permissions.py

@@ -29,9 +29,30 @@ def has_object_permission(self, request, view, obj):
         return obj.owner == request.user or request.user.is_superuser
 
 
+class IsAdminOrReadOnly(permissions.BasePermission):
+    """Доступ: Админ или только для чтения"""
+
+    def has_permission(self, request, view):
+        """Видеть список могут все, добавлять только администратор."""
+
+        return request.method in permissions.SAFE_METHODS or (
+            request.user.is_authenticated and request.user.is_superuser
+        )
+
+    def has_object_permission(self, request, view, obj):
+        return (
+            request.method in permissions.SAFE_METHODS
+            or request.user.is_superuser
+        )
+
+
 class IsOwner(permissions.BasePermission):
     """Доступ: только владелец."""
 
+    def has_permission(self, request, view):
+        """Видеть список может только владелец."""
+        return request.user.is_authenticated
+
     def has_object_permission(self, request, view, obj):
         """Под объектом подразумевается Document."""
         return request.user.is_authenticated and obj.owner == request.user