Merge branch 'develop' into 'master'

Create way to check for authorization

See merge request namibsun/python/kudubot!14

CHANGELOG

@@ -1,3 +1,5 @@
+V 0.31.0:
+  - Added ways to make commands work only when authorized using decorators
 V 0.30.0:
   - Less unnecessary logging of exceptions
   - Made version strings mandatory for bots

README.md

@@ -24,7 +24,8 @@ you want the bot to react.
 
 Kudubot is meant to react on commands like ```/send 123```. Those are
 modelled using CommandParser and Command objects. Those are used to
-automatically parse incoming text messages and are sent to ```on_command```.
+automatically parse incoming text messages and are sent to ```on_command```,
+which delegates them to ```on_<command name>``` methods by default.
 
 If you want complete manual control over what happens with incoming messages,
 override the ```on_msg``` method. If you only care about text messages, do the

kudubot/Bot.py

@@ -22,6 +22,7 @@
 import json
 import logging
 import traceback
+from functools import wraps
 from threading import Thread
 from sentry_sdk import capture_exception
 from sqlalchemy import create_engine
@@ -38,14 +39,42 @@
 from kudubot.db.config.impl.SqlteConfig import SqliteConfig
 from kudubot.exceptions import ConfigurationError, ParseError
 from kudubot.parsing.CommandParser import CommandParser
-from typing import Type, Optional, List, Tuple, Dict, Any, cast
+from typing import Type, Optional, List, Tuple, Dict, Any, cast, Callable
 
 
 class Bot:
     """
     The Bot class offers an abstraction layer above bokkichat
     """
 
+    # noinspection PyMethodParameters
+    def auth_required(func: Callable) -> Callable:
+        """
+        This is a decorator that makes it possible to restrict a user's access
+        to certain commands.
+        To use this, simply decorate an 'on_'-method with this decorator.
+        The method will then only be called if the is_authorized() method
+        returns True
+        :return: None
+        """
+        @wraps(func)
+        def wrapper(
+                self: Bot,
+                sender: Address,
+                args: Dict[str, Any],
+                db_session: Session
+        ):
+            status = self.is_authorized(sender, args, db_session)
+            if status:  # TODO FIX
+                self.send_txt(
+                    sender,
+                    self.unauthorized_message(),
+                    "Unauthorized"
+                )
+            else:
+                func(self, sender, args, db_session)
+        return wrapper
+
     def __init__(
             self,
             connection: Connection,
@@ -289,14 +318,41 @@ def bg_pause(self) -> int:
         """
         return 60
 
+    # noinspection PyMethodMayBeStatic,PyUnusedLocal
+    def is_authorized(
+            self,
+            address: Address,
+            args: Dict[str, Any],
+            db_session: Session
+    ) -> bool:
+        """
+        Checks if a user is authorized
+        :param address: The user to check
+        :param args: possible command arguments
+        :param db_session: The database session to use
+        :return: True if authorized, False otherwise
+        """
+        return True
+
+    @classmethod
+    def unauthorized_message(cls) -> str:
+        """
+        :return: A custom message sent to a user if they tried to access
+                 a feature that requires authorization without being
+                 authorized
+        """
+        return "Unauthorized"
+
     def run_in_bg(self):
         """
         Method that is started when the bot is started.
         This executes the bg_iteration method every bg_pause seconds
         :return: None
         """
+        self.logger.info("Starting background thread")
         counter = 0
         while True:
+            self.logger.debug("Starting background iteration " + str(counter))
             try:
                 db_session = self.sessionmaker()
                 self.bg_iteration(counter, db_session)

version

@@ -1 +1 @@
-0.30.0
+0.31.0