Release

.env.dev

@@ -5,6 +5,7 @@ MAIL_PORT=587
 MAIL_USE_TLS=True
 MAIL_USERNAME=
 MAIL_DEFAULT_SENDER=
+URL_PROCHARITY=
 EMAIL_PROCHARRITY=
 HOST_NAME=
 ACCESS_TOKEN_FOR_PROCHARITY=

.env.example

@@ -5,6 +5,7 @@ MAIL_PORT=
 MAIL_USE_TLS=
 MAIL_USERNAME=
 MAIL_DEFAULT_SENDER=
+URL_PROCHARITY=
 EMAIL_PROCHARRITY=
 DATABASE_URL=
 HOST_NAME=

.env.prod

@@ -5,6 +5,7 @@ MAIL_PORT=
 MAIL_USE_TLS=
 MAIL_USERNAME=
 MAIL_DEFAULT_SENDER=
+URL_PROCHARITY=
 EMAIL_PROCHARRITY=
 DATABASE_URL=
 HOST_NAME=

.github/workflows/develop_bot_ci.yml

@@ -100,6 +100,7 @@ jobs:
             echo MAIL_USE_TLS=${{ secrets.MAIL_USE_TLS }} >> .env
             echo MAIL_USERNAME=${{ secrets.MAIL_USERNAME }} >> .env
             echo MAIL_DEFAULT_SENDER=${{ secrets.MAIL_DEFAULT_SENDER }} >> .env
+            echo URL_PROCHARITY=${{ secrets.URL_PROCHARITY }} >> .env
             echo EMAIL_PROCHARRITY=${{ secrets.EMAIL_PROCHARRITY }} >> .env
             echo HOST_NAME=${{ secrets.HOST_NAME }} >> .env
             echo ACCESS_TOKEN_FOR_PROCHARITY=${{ secrets.ACCESS_TOKEN_FOR_PROCHARITY }} >> .env

.github/workflows/master_bot_ci.yml

@@ -100,6 +100,7 @@ jobs:
             echo MAIL_USE_TLS=${{ secrets.MAIL_USE_TLS }} >> .env
             echo MAIL_USERNAME=${{ secrets.MAIL_USERNAME }} >> .env
             echo MAIL_DEFAULT_SENDER=${{ secrets.MAIL_DEFAULT_SENDER }} >> .env
+            echo URL_PROCHARITY=${{ secrets.URL_PROCHARITY }} >> .env
             echo EMAIL_PROCHARRITY=${{ secrets.EMAIL_PROCHARRITY }} >> .env
             echo HOST_NAME=${{ secrets.HOST_NAME_PROD }} >> .env
             echo ACCESS_TOKEN_FOR_PROCHARITY=${{ secrets.ACCESS_TOKEN_FOR_PROCHARITY_PROD }} >> .env

app/__init__.py

@@ -9,6 +9,7 @@
 from app import config
 from app.config import TELEGRAM_TOKEN
 
+
 jwt = JWTManager()
 mail = Mail()
 cors = CORS()
@@ -26,12 +27,14 @@ def create_app():
     from app.webhooks import swagger_webhooks
 
     from app.auth import auth_bp
+    from app.error_handlers import invalid_api_usage, InvalidAPIUsage
     from app.front import front_bp
     from app.webhooks import webhooks_bp
 
     app.register_blueprint(webhooks_bp)
     app.register_blueprint(auth_bp)
     app.register_blueprint(front_bp)
+    app.register_error_handler(InvalidAPIUsage, invalid_api_usage)
 
     jwt.init_app(app)
     mail.init_app(app)

app/auth/external_users_registration.py

@@ -32,15 +32,15 @@ class ExternalUserRegistration(MethodResource, Resource):
                     }
          )
     @use_kwargs(
-        {'id': fields.Int(required=True),
+        {'user_id': fields.Int(required=True),
          'id_hash': fields.Str(description='md5 hash of external_id', required=True),
          'first_name': fields.Str(required=True),
          'last_name': fields.Str(required=True),
          'email': fields.Str(required=True),
          'specializations': fields.Str(required=True)}
     )
     def post(self, **kwargs):
-        external_id = kwargs.get('id')
+        external_id = kwargs.get('user_id')
 
         user = ExternalSiteUser.query.options(load_only('external_id')).filter_by(external_id=external_id).first()
         if user:
@@ -63,7 +63,7 @@ def post(self, **kwargs):
         categories = []
 
         for specialization in specializations:
-            user.categories.append(specialization.name)
+            categories.append(specialization.name)
 
         try:
             db_session.commit()

app/config.py

@@ -29,6 +29,8 @@
     'lowercase': 1,
     'max_length': 32,
 }
+
+URL_PROCHARITY = os.getenv('URL_PROCHARITY')
 # procharity send email settings
 PROCHARRITY_TEMPLATE = 'email_templates/send_question.html'
 

app/error_handlers.py

@@ -0,0 +1,20 @@
+class InvalidAPIUsage(Exception):
+    """
+    Special class for custom Exceptions raised where it is necessary.
+    If Exception is not explicitly defined raises HTTP 400 Bad Request.
+    Error Message is required to clarify erroneous program behavior.
+    """
+    status_code = 400
+
+    def __init__(self, message, status_code=None):
+        super().__init__()
+        self.message = message
+        if status_code is not None:
+            self.status_code = status_code
+
+
+def invalid_api_usage(error):
+    """
+    InvalidAPIUsage handler function.
+    """
+    return error.message, error.status_code

app/front/__init__.py

@@ -7,12 +7,15 @@
 
 from . import analytics
 from . import send_tg_notification
+from . import send_tg_message_to_user
 from . import users
 from . import download_log_files
 
 front_api.add_resource(analytics.Analytics, '/api/v1/analytics/')
 front_api.add_resource(send_tg_notification.SendTelegramNotification,
-                       '/api/v1/send_telegram_notification/')
+                       '/api/v1/messages/')
+front_api.add_resource(send_tg_message_to_user.SendTelegramMessage,
+                       '/api/v1/messages/<int:telegram_id>/')
 front_api.add_resource(users.UsersList, '/api/v1/users/')
 front_api.add_resource(users.UserItem, '/api/v1/users/<int:telegram_id>/')
 front_api.add_resource(download_log_files.DownloadLogs, '/api/v1/download_logs/')

app/front/send_tg_message_to_user.py

@@ -0,0 +1,97 @@
+import datetime
+
+from flask import jsonify, make_response
+from flask_apispec import doc, use_kwargs
+from flask_apispec.views import MethodResource
+from flask_restful import Resource
+from marshmallow import Schema, fields
+from sqlalchemy.exc import SQLAlchemyError
+
+from app.database import db_session
+from app.error_handlers import InvalidAPIUsage
+from app.logger import app_logger as logger
+from app.models import Notification
+from app.webhooks.check_webhooks_token import check_webhooks_token
+from bot.messages import TelegramMessage
+
+
+class TelegramMessageSchema(Schema):
+    message = fields.String(required=True)
+
+
+class SendTelegramMessage(Resource, MethodResource):
+    method_decorators = {'post': [check_webhooks_token]}
+
+    @doc(description='Sends message to the telegram user.'
+                     'Requires "message" and "telegram_id" parameters.',
+         summary='Send telegram messages to the bot chat',
+         tags=['Messages'],
+         responses={
+             200: {'description': 'The message has been sent'},
+             400: {'description': 'The message can not be empty'},
+         },
+         params={
+             'message': {
+                 'description': 'Message to user. Max len 4096',
+                 'in': 'query',
+                 'type': 'string'
+             },
+             'telegram_id': {
+                 'description': (
+                    'Sending notification to user with this telegram id'
+                  ),
+                 'in': 'path',
+                 'type': 'integer',
+                 'required': True
+             },
+             'token': {
+                 'description': 'webhooks token',
+                 'in': 'header',
+                 'type': 'string',
+                 'required': True
+             }
+         })
+    @use_kwargs(TelegramMessageSchema)
+    def post(self, telegram_id, **kwargs):
+        message = kwargs.get('message').replace(' ', '')
+
+        if not message:
+            logger.info(
+                'Messages: The <message> parameter have not been passed'
+                )
+            return make_response(
+                jsonify(
+                    result=(
+                        'Необходимо указать параметр <message>.'
+                    )
+                ), 400
+                )
+
+        message = Notification(message=message)
+        db_session.add(message)
+        try:
+            db_session.commit()
+            mes = TelegramMessage(telegram_id)
+            mes.send_message(message=message.message)
+            message.was_sent = True
+            message.sent_date = datetime.datetime.now()
+            db_session.commit()
+        except InvalidAPIUsage as ex:
+            db_session.rollback()
+            return make_response(
+                jsonify(result=ex.message), ex.status_code
+            )
+        except SQLAlchemyError as ex:
+            logger.error(f'Messages: Database commit error "{str(ex)}"')
+            db_session.rollback()
+            return make_response(
+                jsonify(message=f'Bad request: {str(ex)}'), 400
+            )
+
+        logger.info(f'Messages: The message "{message.message}" '
+                    'has been successfully sent to user')
+        return make_response(
+            jsonify(
+                result="Сообщение успешно отправлено пользователю."
+            ), 200
+        )

app/front/send_tg_notification.py

@@ -16,17 +16,18 @@
 from bot.messages import TelegramNotification
 
 
-
 class TelegramNotificationSchema(Schema):
     message = fields.String(required=True)
-    has_mailing = fields.String(required=True)
+    mode = fields.String(required=True)
 
 
 class SendTelegramNotification(Resource, MethodResource):
 
-    @doc(description='Sends message to the Telegram chat. Requires "message" parameter.'
-                     ' Messages can be sent either to subscribed users or not.To do this,'
-                     ' specify the "has_mailing" parameter.Default value "True".',
+    @doc(description=(
+            'Sends message to the Telegram chat. Requires "message" parameter.'
+            ' Messages can be sent either to subscribed users or not.To do '
+            'this, specify the "mode" parameter.Default value "subscribed".'
+        ),
          summary='Send messages to the bot chat',
          tags=['Messages'],
          responses={
@@ -40,39 +41,57 @@ class SendTelegramNotification(Resource, MethodResource):
                  'type': 'string',
                  'required': True
              },
-             'has_mailing': {
-                 'description': ('Sending notifications to users by the type of permission to mailing.'
+             'mode': {
+                 'description': ('Sending notifications to users by the type '
+                                 'of permission to mailing.'
                                  'subscribed - user has enabled a mailing.'
                                  'unsubscribed - user has disabled a mailing.'
                                  'all - send to all users'),
                  'in': 'query',
                  'type': 'string',
                  'required': True
              },
-             'Authorization': config.PARAM_HEADER_AUTH,  # Only if request requires authorization
+             # Only if request requires authorization
+             'Authorization': config.PARAM_HEADER_AUTH,
          }
          )
     @use_kwargs(TelegramNotificationSchema)
     @jwt_required()
     def post(self, **kwargs):
         message = kwargs.get('message').replace(' ', '')
-        has_mailing = kwargs.get('has_mailing')
+        mode = kwargs.get('mode')
 
-        if not message or not has_mailing:
-            logger.info("Messages: The <message> and  <has_mailing> parameters have not been passed")
-            return make_response(jsonify(result="Необходимо указать параметры <message> и <has_mailing>."), 400)
+        if not message or not mode:
+            logger.info(
+                'Messages: The <message> and  <mode> '
+                'parameters have not been passed'
+                )
+            return make_response(
+                jsonify(
+                    result='Необходимо указать параметры <message> и <mode>.'
+                ),
+                400
+            )
 
         authorized_user = get_jwt_identity()
         message = Notification(message=message, sent_by=authorized_user)
         db_session.add(message)
         try:
             db_session.commit()
-            job_queue = TelegramNotification(has_mailing)
+            job_queue = TelegramNotification(mode)
 
             if not job_queue.send_notification(message=message.message):
-                logger.info(f"Messages: Passed invalid <has_mailing> parameter. Passed: {has_mailing}")
-                return make_response(jsonify(result=f"Неверно указан параметр <has_mailing>. "
-                                                    f"Сообщение не отправлено."), 400)
+                logger.info(
+                    'Messages: Passed invalid <mode> parameter. '
+                    f'Passed: {mode}'
+                )
+                return make_response(
+                    jsonify(
+                        result=('Неверно указан параметр <mode>. '
+                                'Сообщение не отправлено.')
+                    ),
+                    400
+                )
 
             message.was_sent = True
             message.sent_date = datetime.datetime.now()
@@ -81,8 +100,15 @@ def post(self, **kwargs):
         except SQLAlchemyError as ex:
             logger.error(f'Messages: Database commit error "{str(ex)}"')
             db_session.rollback()
-            return make_response(jsonify(message=f'Bad request: {str(ex)}'), 400)
+            return make_response(
+                jsonify(message=f'Bad request: {str(ex)}'), 400
+            )
 
-        logger.info(f"Messages: The message '{message.message[0:30]}...' "
-                    f"has been successfully added to the mailing list.")
-        return make_response(jsonify(result=f"Сообщение успешно добавлено в очередь рассылки."), 200)
+        logger.info(f'Messages: The message "{message.message[0:30]}..." '
+                    f'has been successfully added to the mailing list.')
+        return make_response(
+            jsonify(
+                result='Сообщение успешно добавлено в очередь рассылки.'
+            ),
+            200
+        )

app/front/swagger_front.py

@@ -3,10 +3,12 @@
 from app.front.download_log_files import DownloadLogs, GetListLogFiles
 from app.front.users import UsersList, UserItem
 from app.front.send_tg_notification import SendTelegramNotification
+from app.front.send_tg_message_to_user import SendTelegramMessage
 
 
 docs.register(Analytics, blueprint='front_bp')
 docs.register(SendTelegramNotification, blueprint='front_bp')
+docs.register(SendTelegramMessage, blueprint='front_bp')
 docs.register(UsersList, blueprint='front_bp')
 docs.register(UserItem, blueprint='front_bp')
 docs.register(DownloadLogs, blueprint='front_bp')

app/logger.py

@@ -32,7 +32,7 @@ def add_handler(path_name):
 
 def app_logging():
     module_logger = logging.getLogger('app')
-    module_logger.setLevel(logging.INFO)
+    module_logger.setLevel(logging.DEBUG)
     app_handler = add_handler('app_logs.txt')
     app_loggers = [
         module_logger,
@@ -47,7 +47,7 @@ def app_logging():
 
 def bot_logging():
     bot_logger = logging.getLogger("telegram")
-    bot_logger.setLevel(logging.INFO)
+    bot_logger.setLevel(logging.DEBUG)
     bot_handler = add_handler('bot_logs.txt')
     bot_logger.addHandler(bot_handler)
     app_loggers = [
@@ -63,7 +63,7 @@ def bot_logging():
 
 def webhooks_logging():
     webhooks_logger = logging.getLogger("webhooks")
-    webhooks_logger.setLevel(logging.INFO)
+    webhooks_logger.setLevel(logging.DEBUG)
     webhooks_handler = add_handler('webhooks_logs.txt')
     webhooks_logger.addHandler(webhooks_handler)
 

app/models.py

@@ -122,7 +122,7 @@ class Notification(Base):
     message = Column(String(4096), nullable=False)
     was_sent = Column(Boolean, default=False)
     sent_date = Column(TIMESTAMP)
-    sent_by = Column(String(48), nullable=False)
+    sent_by = Column(String(48), nullable=True)
 
     def __repr__(self):
         return f'<Notification {self.message[0:10]}>'