Better logging & some updates

Author: yilbegan

README.md

@@ -4,23 +4,23 @@
 * [Примеры использования](./examples) (python3)
 ## Hello world
 ```python
+# Можно использовать другие обертки для API.
+# Например vk_api.
 import vk_requests
 
 from vbio import VkBot
-from vbio.servers import FlaskServer
-
+from vbio.servers import LongPoolClient
+    
 api = vk_requests.create_api(service_token='<токен группы>')
-bot = VkBot(secret='<секретный ключ>', 
-            confirmation='<строка, которую должен вернуть сервер>',
-            api=api)
-server = FlaskServer(bot, port=80)
-
-
+bot = VkBot(api)
+server = LongPoolClient(bot)
+    
+    
 @bot.callback_message_handler()
 def hello_world(m):
     m.answer(message='Привет мир!')
-
-
+    
+    
 if __name__ == '__main__':
     server.run()
 ```

docs/index.rst

@@ -21,26 +21,27 @@ Hello world!
 
 .. code-block:: python
 
-   import vk_requests  # Можно использовать другие обертки для API,
-		       # например vk_api.
+   # Можно использовать другие обертки для API.
+   # Например vk_api.
+   import vk_requests
+
    from vbio import VkBot
-   from vbio.servers import FlaskServer
+   from vbio.servers import LongPoolClient
 
    api = vk_requests.create_api(service_token='<токен группы>')
-   bot = VkBot(secret='<секретный ключ>', 
-               confirmation='<строка, которую должен вернуть сервер>',
-               api=api)
-   server = FlaskServer(bot, port=80)
+   bot = VkBot(api)
+   server = LongPoolClient(bot)
 
 
    @bot.callback_message_handler()
    def hello_world(m):
-      m.answer(message='Привет мир!')
+       m.answer(message='Привет мир!')
 
 
    if __name__ == '__main__':
        server.run()
 
+
 .. toctree::
    :maxdepth: 2
    :caption: Содержание:

examples/README.md

@@ -7,4 +7,4 @@
 * [Структура вложения](./attachment.py)
 * [Клавиатуры ботов](./keyboard.py)
 * [Получение сообщений и фильтры](./filters.py)
-* [Работа c Bots LongPool](./longpool.py)
+* [Работа c Callback](./callback.py)

examples/attachment.py

@@ -3,13 +3,11 @@
 import vk_requests
 
 from vbio import VkBot
-from vbio.servers import FlaskServer
+from vbio.servers import LongPoolClient
 
 api = vk_requests.create_api(service_token='<токен группы>')
-bot = VkBot(secret='<секретный ключ>',
-            confirmation='<строка, которую должен вернуть сервер>',
-            api=api)
-server = FlaskServer(bot, port=80)
+bot = VkBot(api=api)
+server = LongPoolClient(bot)
 
 
 @bot.callback_message_handler()

examples/longpool.py examples/callback.py

@@ -3,13 +3,12 @@
 import vk_requests
 
 from vbio import VkBot
-from vbio.servers import LongPoolClient
+from vbio.servers import FlaskServer
 
-# Токен должен иметь доступ к управлению группой!
 api = vk_requests.create_api(service_token='<токен группы>')
-
 bot = VkBot(api=api)
-long_pool = LongPoolClient(bot)
+server = FlaskServer(bot, secret='<секретный ключ>',
+                     confirmation='<строка, которую должен вернуть сервер>')
 
 
 @bot.callback_message_handler()
@@ -18,4 +17,4 @@ def hello_world(m):
 
 
 if __name__ == '__main__':
-    long_pool.run()
+    server.run(port=80)

examples/filters.py

@@ -3,13 +3,11 @@
 import vk_requests
 
 from vbio import VkBot
-from vbio.servers import FlaskServer
+from vbio.servers import LongPoolClient
 
 api = vk_requests.create_api(service_token='<токен группы>')
-bot = VkBot(secret='<секретный ключ>',
-            confirmation='<строка, которую должен вернуть сервер>',
-            api=api)
-server = FlaskServer(bot, port=80)
+bot = VkBot(api=api)
+server = LongPoolClient(bot)
 
 
 # Будет вызываться только если текст сообщения подходит

examples/hello_world.py

@@ -5,17 +5,15 @@
 import vk_requests
 
 from vbio import VkBot
-from vbio.servers import FlaskServer
+from vbio.servers import LongPoolClient
 
 # Получаем обертку на API
 api = vk_requests.create_api(service_token='<токен группы>')
 
-bot = VkBot(secret='<секретный ключ>',
-            confirmation='<строка, которую должен вернуть сервер>',
-            api=api)
+bot = VkBot(api=api)
 
-# Сервер, который будет обрабатывать запросы
-server = FlaskServer(bot, port=80)
+# LongPool клиент
+server = LongPoolClient(bot)
 
 
 # Задаем функцию которая будет получать сообщения.

examples/keyboard.py

@@ -3,14 +3,12 @@
 import vk_requests
 
 from vbio import VkBot
-from vbio.servers import FlaskServer
+from vbio.servers import LongPoolClient
 from vbio.types import VkKeyboardMarkup, VkKeyboardButton, VkColor
 
 api = vk_requests.create_api(service_token='<токен группы>')
-bot = VkBot(secret='<секретный ключ>',
-            confirmation='<строка, которую должен вернуть сервер>',
-            api=api)
-server = FlaskServer(bot, port=80)
+bot = VkBot(api=api)
+server = LongPoolClient(bot)
 
 
 @bot.callback_message_handler()

examples/message.py

@@ -3,13 +3,11 @@
 import vk_requests
 
 from vbio import VkBot
-from vbio.servers import FlaskServer
+from vbio.servers import LongPoolClient
 
 api = vk_requests.create_api(service_token='<токен группы>')
-bot = VkBot(secret='<секретный ключ>',
-            confirmation='<строка, которую должен вернуть сервер>',
-            api=api)
-server = FlaskServer(bot, port=80)
+bot = VkBot(api=api)
+server = LongPoolClient(bot)
 
 
 @bot.callback_message_handler()
@@ -65,5 +63,6 @@ def new_message(m):
                                         )
     )
 
+
 if __name__ == '__main__':
     server.run()

requirements.txt

@@ -1,3 +1 @@
-Flask
-CherryPy
 requests

setup.py

@@ -23,11 +23,10 @@
     packages=['vbio', 'vbio.servers'],
     install_requires=['requests'],
     extras_require={
-        'flask_webhook': ['flask'],
-        'cherrypy_webhook': ['cherrypy'],
+        'webhook': ['Flask'],
+        'color': ['colorama']
     },
 
-
     classifiers=[
         'License :: OSI Approved :: Apache Software License',
         'Operating System :: OS Independent',

vbio/__init__.py

@@ -1,5 +1,6 @@
 # -*- coding: utf-8 -*-
 
+from vbio.logging import *
 from vbio.bot import *
 from vbio.types import *
 from vbio.servers import *

vbio/bot.py

@@ -4,18 +4,15 @@
 import re
 
 from vbio.types import CONTENT_TYPES, VkMessage, VkCallbackRequest
+from vbio.logging import init_logger
 from typing import Callable
 
 __all__ = ('VkBot',)
 
 
 class VkBot:
 
-    def __init__(self, api, secret: str = None, confirmation: str = None,
-                 ignore_errors: bool = True, logger: logging.Logger = None):
-
-        self.secret = secret
-        self.confirmation = confirmation
+    def __init__(self, api, ignore_errors: bool = True):
         self.ignore_errors = ignore_errors
         self.api = api
 
@@ -24,7 +21,7 @@ def __init__(self, api, secret: str = None, confirmation: str = None,
 
         self.message_register_next_step = {}
 
-        self.logger = logger
+        self.logger = init_logger()
 
     @staticmethod
     def _build_handler_dict(f: Callable, **filters) -> dict:

vbio/servers/__init__.py

@@ -1,7 +1,7 @@
 # -*- encoding: utf-8 -*-
 
-from vbio.servers.flask import FlaskServer
-from vbio.servers.cherrypy import CherryPyServer
 from vbio.servers.longpool import LongPoolClient
-
-__all__ = ('FlaskServer', 'CherryPyServer', 'LongPoolClient')
+try:
+    from vbio.servers.flask import FlaskServer
+except ImportError:
+    pass

vbio/servers/flask.py

@@ -1,75 +1,61 @@
 # -*- encoding: utf-8 -*-
 
-import traceback
+import sys
+import logging
 
 from flask import Flask, request, abort
 from vbio.bot import VkBot
 from vbio.types import VkBotServer
-from datetime import datetime
 
 __all__ = ('FlaskServer',)
 
 
 class FlaskServer(VkBotServer):
 
-    def __init__(self, bot: VkBot, host: str = '0.0.0.0', port: int = 5000):
+    def __init__(self, bot: VkBot, secret: str, confirmation: str, app: Flask = None):
+
         self.bot = bot
-        self.host = host
-        self.port = port
-        self.app = None
+        self.secret = secret
+        self.confirmation = confirmation
 
-    def run(self):
-        self.app = Flask(__name__)
+        self.app = app or Flask(__name__)
 
-        @self.app.route('/', methods=['POST'])
-        def message_handler():
-            data = request.json
+    def message_handler(self):
+        data = request.json
 
-            if data is None:
-                return abort(400)
+        if data is None:
+            return abort(400)
 
-            if data.get('secret', '') != self.bot.secret:
-                return abort(403)
+        if data.get('secret', '') != self.secret:
+            self.bot.logger.warning('Invalid secret passed!')
+            return abort(403)
 
-            if data.get('type') == 'confirmation':
-                return self.bot.confirmation
+        if data.get('type') == 'confirmation':
+            self.bot.logger.info('Confirmation sent')
+            return self.confirmation
 
-            elif data.get('type') == 'message_new':
-                try:
-                    self.bot.process_message(data['object'])
+        try:
+            if data.get('type') == 'message_new':
+                self.bot.process_message(data['object'])
+                self.bot.logger.info('Processed message from {}: {}'.format(data['object'].get('from_id'),
+                                                                            data['object'].get('text')[:40]))
 
-                except Exception as e:
-                    if self.bot.logger is not None:
-                        self.bot.logger.error(
-                            '[X] {} Error \n{}\ncaused during handling request: '
-                            '\n{}\n-------------'.format(
-                                datetime.now().strftime("%d/%m/%y %H:%M:%S"),
-                                traceback.format_exc(),
-                                data
-                            )
-                        )
+            else:
+                self.bot.process_request(data)
+                self.bot.logger.info('Processed request: {}'.format(data.get('type')))
 
-                    if not self.bot.ignore_errors:
-                        raise e
+        except Exception as ex:
+            self.bot.logger.error('From {}'.format(data.get('type')), exc_info=sys.exc_info())
+            if not self.bot.ignore_errors:
+                raise ex
 
-            else:
-                try:
-                    self.bot.process_request(data)
-
-                except Exception as e:
-                    if self.bot.logger is not None:
-                        self.bot.logger.error(
-                            '[X] {} Error \n{}\ncaused during handling request: '
-                            '\n{}\n-------------'.format(
-                                datetime.now().strftime("%d/%m/%y %H:%M:%S"),
-                                traceback.format_exc(),
-                                data
-                            )
-                        )
-
-                    if not self.bot.ignore_errors:
-                        raise e
-
-            return 'ok'
-
-        self.app.run(self.host, self.port, debug=False)
+        return 'ok'
+
+    def run(self, path: str = '/', *args, **kwargs):
+        self.app.route(path, methods=['POST'])(
+            self.message_handler
+        )
+
+        logging.getLogger('werkzeug').setLevel(logging.FATAL)
+        self.bot.logger.info('starting webhook')
+        self.app.run(*args, **kwargs)