Enable bot to ignore messages from specified senders (attzonko#29)

* fix incorrect test

If there are two plugin functions listening to the same regex pattern, only the latest funciton will be loaded in plugin manager. Details can be found in bot.listen_to(). So there sould not be test for loading two plugin functions listening to the same regex pattern.

* test for 1 to 1 function-regexp mapping

append test to ensure the latest loaded function replaces previous loaded function which listening to the same regexp statement.

* unit test for ignoring senders specified in settings.IGNORE_USERS

* enable dispatcher to ignore messages from specified senders

* move get_sender as static method

Author: seLain

docs/settings.rst

@@ -24,6 +24,8 @@ Settings
 
     # Ignore broadcast message
     IGNORE_NOTIFIES = ['@channel', '@all']
+    # Ignore message from specified senders (case-insensitive), ex: IGNORE_USERS = ['john', 'Mary']
+    IGNORE_USERS = []
 
     # Threads num
     WORKERS_NUM = 10

mmpy_bot/dispatcher.py

@@ -35,10 +35,22 @@ def start(self):
     def get_message(msg):
         return msg.get('data', {}).get('post', {}).get('message', '').strip()
 
+    @staticmethod
+    def get_sender(msg):
+        return msg.get('data', {}).get('sender_name', '').strip()
+
     def ignore(self, _msg):
+        return self._ignore_notifies(_msg) or self._ignore_sender(_msg)
+        
+    def _ignore_notifies(self, _msg):
+        # ignore message containing specified item, such as "@all"
         msg = self.get_message(_msg)
-        if any(item in msg for item in settings.IGNORE_NOTIFIES):
-            return True
+        return True if any(item in msg for item in settings.IGNORE_NOTIFIES) else False
+
+    def _ignore_sender(self, _msg):
+        # ignore message from senders specified in settings
+        sender_name = self.get_sender(_msg)
+        return True if sender_name.lower() in (name.lower() for name in settings.IGNORE_USERS) else False
 
     def is_mentioned(self, msg):
         mentions = msg.get('data', {}).get('mentions', [])

mmpy_bot/settings.py

@@ -18,6 +18,7 @@
 SSL_VERIFY = True
 
 IGNORE_NOTIFIES = ['@here', '@channel', '@all']
+IGNORE_USERS = []
 WORKERS_NUM = 10
 
 DEFAULT_REPLY_MODULE = None

tests/unit_tests/test_ignoremessage.py

@@ -0,0 +1,21 @@
+import logging
+from mmpy_bot.dispatcher import MessageDispatcher
+from mmpy_bot import settings
+
+#logging.basicConfig(stream=sys.stdout, level=logging.DEBUG)
+logger = logging.getLogger(__name__)
+
+def test_messagedispatcher__ignore_sender():
+	dispatcher = MessageDispatcher(None, None)
+	event = {'event': 'posted', 'data': {'sender_name': 'betty'}}
+	event2 = {'event': 'posted', 'data': {'sender_name': 'Carter'}}
+	# test by lowercase  / uppercase settings
+	# set as 'Betty'
+	settings.IGNORE_USERS = [] # clean up
+	settings.IGNORE_USERS.append('Betty')
+	if dispatcher._ignore_sender(event) is not True:
+		raise AssertionError()
+	# set as 'CARTER'
+	settings.IGNORE_USERS.append('CARTER')
+	if dispatcher._ignore_sender(event2) is not True:
+		raise AssertionError()