Backend + Telegram: изменена структура проекта, добавлен эндпоинт для регистрации на бэкенде

README.md

@@ -1,13 +1,19 @@
 # TextSouls
 
-### Запуск бэкенда
-Из корня:
+### Бэкенд
+Все действия производить из папки backend!
+
+###### Создание/подготовка БД
 ```
-backend/scripts/runserver.sh
+scripts/updatedb.sh
+```
+###### Запуск
+```
+scripts/runserver.sh
 ```
 
 ### Запуск Telegram
-Из корня:
+Из папки Telegram:
 ```
 python telegram/main.py
 ```

backend/main.py

@@ -1,8 +0,0 @@
-from flask import Blueprint
-
-main = Blueprint("main", __name__)
-
-
-@main.route("/")
-def index():
-    return "Nice!", 200

backend/migrations/README

@@ -0,0 +1 @@
+Single-database configuration for Flask.

backend/migrations/alembic.ini

@@ -0,0 +1,50 @@
+# A generic, single database configuration.
+
+[alembic]
+# template used to generate migration files
+# file_template = %%(rev)s_%%(slug)s
+
+# set to 'true' to run the environment during
+# the 'revision' command, regardless of autogenerate
+# revision_environment = false
+
+
+# Logging configuration
+[loggers]
+keys = root,sqlalchemy,alembic,flask_migrate
+
+[handlers]
+keys = console
+
+[formatters]
+keys = generic
+
+[logger_root]
+level = WARN
+handlers = console
+qualname =
+
+[logger_sqlalchemy]
+level = WARN
+handlers =
+qualname = sqlalchemy.engine
+
+[logger_alembic]
+level = INFO
+handlers =
+qualname = alembic
+
+[logger_flask_migrate]
+level = INFO
+handlers =
+qualname = flask_migrate
+
+[handler_console]
+class = StreamHandler
+args = (sys.stderr,)
+level = NOTSET
+formatter = generic
+
+[formatter_generic]
+format = %(levelname)-5.5s [%(name)s] %(message)s
+datefmt = %H:%M:%S

backend/migrations/env.py

@@ -0,0 +1,97 @@
+from __future__ import with_statement
+
+import logging
+from logging.config import fileConfig
+
+from flask import current_app
+
+from alembic import context
+
+# this is the Alembic Config object, which provides
+# access to the values within the .ini file in use.
+config = context.config
+
+# Interpret the config file for Python logging.
+# This line sets up loggers basically.
+fileConfig(config.config_file_name)
+logger = logging.getLogger('alembic.env')
+
+# add your model's MetaData object here
+# for 'autogenerate' support
+# from myapp import mymodel
+# target_metadata = mymodel.Base.metadata
+config.set_main_option(
+    'sqlalchemy.url',
+    str(current_app.extensions['migrate'].db.get_engine().url).replace(
+        '%', '%%'))
+target_db = current_app.extensions['migrate'].db
+
+# other values from the config, defined by the needs of env.py,
+# can be acquired:
+# my_important_option = config.get_main_option("my_important_option")
+# ... etc.
+
+
+def get_metadata():
+    if hasattr(target_db, 'metadatas'):
+        return target_db.metadatas[None]
+    return target_db.metadata
+
+
+def run_migrations_offline():
+    """Run migrations in 'offline' mode.
+
+    This configures the context with just a URL
+    and not an Engine, though an Engine is acceptable
+    here as well.  By skipping the Engine creation
+    we don't even need a DBAPI to be available.
+
+    Calls to context.execute() here emit the given string to the
+    script output.
+
+    """
+    url = config.get_main_option("sqlalchemy.url")
+    context.configure(
+        url=url, target_metadata=get_metadata(), literal_binds=True
+    )
+
+    with context.begin_transaction():
+        context.run_migrations()
+
+
+def run_migrations_online():
+    """Run migrations in 'online' mode.
+
+    In this scenario we need to create an Engine
+    and associate a connection with the context.
+
+    """
+
+    # this callback is used to prevent an auto-migration from being generated
+    # when there are no changes to the schema
+    # reference: http://alembic.zzzcomputing.com/en/latest/cookbook.html
+    def process_revision_directives(context, revision, directives):
+        if getattr(config.cmd_opts, 'autogenerate', False):
+            script = directives[0]
+            if script.upgrade_ops.is_empty():
+                directives[:] = []
+                logger.info('No changes in schema detected.')
+
+    connectable = current_app.extensions['migrate'].db.get_engine()
+
+    with connectable.connect() as connection:
+        context.configure(
+            connection=connection,
+            target_metadata=get_metadata(),
+            process_revision_directives=process_revision_directives,
+            **current_app.extensions['migrate'].configure_args
+        )
+
+        with context.begin_transaction():
+            context.run_migrations()
+
+
+if context.is_offline_mode():
+    run_migrations_offline()
+else:
+    run_migrations_online()

backend/migrations/script.py.mako

@@ -0,0 +1,24 @@
+"""${message}
+
+Revision ID: ${up_revision}
+Revises: ${down_revision | comma,n}
+Create Date: ${create_date}
+
+"""
+from alembic import op
+import sqlalchemy as sa
+${imports if imports else ""}
+
+# revision identifiers, used by Alembic.
+revision = ${repr(up_revision)}
+down_revision = ${repr(down_revision)}
+branch_labels = ${repr(branch_labels)}
+depends_on = ${repr(depends_on)}
+
+
+def upgrade():
+    ${upgrades if upgrades else "pass"}
+
+
+def downgrade():
+    ${downgrades if downgrades else "pass"}

backend/migrations/versions/226bb7e77b6b_.py

@@ -0,0 +1,38 @@
+"""empty message
+
+Revision ID: 226bb7e77b6b
+Revises: 
+Create Date: 2022-11-17 22:55:34.747233
+
+"""
+from alembic import op
+import sqlalchemy as sa
+
+
+# revision identifiers, used by Alembic.
+revision = '226bb7e77b6b'
+down_revision = None
+branch_labels = None
+depends_on = None
+
+
+def upgrade():
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.create_table('users',
+    sa.Column('id', sa.Integer(), nullable=False),
+    sa.Column('tg_id', sa.Integer(), nullable=False),
+    sa.Column('first_name', sa.String(length=255), nullable=True),
+    sa.Column('last_name', sa.String(length=255), nullable=True),
+    sa.Column('username', sa.String(length=255), nullable=False),
+    sa.Column('registered_on', sa.DateTime(), nullable=False),
+    sa.Column('is_admin', sa.Boolean(), nullable=False),
+    sa.PrimaryKeyConstraint('id'),
+    sa.UniqueConstraint('tg_id')
+    )
+    # ### end Alembic commands ###
+
+
+def downgrade():
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.drop_table('users')
+    # ### end Alembic commands ###

backend/requirements.txt

@@ -1,5 +1,7 @@
 alembic==1.8.1
+cffi==1.15.1
 click==8.1.3
+cryptography==38.0.3
 Flask==2.2.2
 Flask-Migrate==4.0.0
 Flask-SQLAlchemy==3.0.2
@@ -10,6 +12,7 @@ itsdangerous==2.1.2
 Jinja2==3.1.2
 Mako==1.2.4
 MarkupSafe==2.1.1
+pycparser==2.21
 PyMySQL==1.0.2
 SQLAlchemy==1.4.44
 Werkzeug==2.2.2

backend/scripts/runserver.sh

@@ -2,7 +2,7 @@
 
 set echo off
 
-export FLASK_APP=backend
+export FLASK_APP=textsouls
 export FLASK_DEBUG=true
 
 flask run

backend/scripts/updatedb.sh

@@ -0,0 +1,7 @@
+set echo off
+
+export FLASK_APP=textsouls
+
+flask db init
+flask db migrate
+flask db upgrade

backend/textsouls/__init__.py

@@ -1,16 +1,17 @@
 import json
 
 from flask import Flask
-from flask_sqlalchemy import SQLAlchemy
 from flask_migrate import Migrate
 
+from textsouls.models import db
+
 app = Flask(
     "__name__",
 )
-db = SQLAlchemy()
+
 migrate = Migrate(app, db)
 
-with open("backend/config.json") as config_file:
+with open("textsouls/config.json") as config_file:
     config_data = json.load(config_file)
 
 main_settings = config_data["main_settings"]

backend/textsouls/main.py

@@ -0,0 +1,34 @@
+from flask import Blueprint
+from flask import request
+
+from . import db
+from textsouls.models import User
+
+main = Blueprint("main", __name__)
+
+
+@main.route("/")
+def index():
+    return "Nice!", 200
+
+
+@main.route("/registration", methods=["POST"])
+def registration():
+    data = request.get_json()
+
+    tg_id = data.get("tg_id")
+    first_name = data.get("first_name")
+    last_name = data.get("last_name")
+    username = data.get("username")
+
+    new_user = User(
+        tg_id=tg_id,
+        first_name=first_name,
+        last_name=last_name,
+        username=username,
+    )
+
+    db.session.add(new_user)
+    db.session.commit()
+
+    return "Nice!", 200

backend/textsouls/models.py

@@ -0,0 +1,33 @@
+import datetime
+
+from flask_sqlalchemy import SQLAlchemy
+
+db = SQLAlchemy()
+
+
+class User(db.Model):
+
+    __tablename__ = "users"
+
+    id = db.Column(db.Integer, primary_key=True)
+    tg_id = db.Column(db.Integer, unique=True, nullable=False)
+    first_name = db.Column(db.String(255), nullable=True)
+    last_name = db.Column(db.String(255), nullable=True)
+    username = db.Column(db.String(255), nullable=False)
+    registered_on = db.Column(db.DateTime, nullable=False)
+    is_admin = db.Column(db.Boolean, nullable=False, default=False)
+
+    def __init__(
+        self,
+        tg_id,
+        first_name,
+        last_name,
+        username,
+        is_admin=False,
+    ):
+        self.tg_id = tg_id
+        self.first_name = first_name
+        self.last_name = last_name
+        self.username = username
+        self.registered_on = datetime.datetime.now()
+        self.is_admin = is_admin