Fix CommonWords property name

.github/workflows/publish.yaml

@@ -22,10 +22,10 @@ jobs:
       - name: Update setup.cfg
         run: |
           sed -i "
-            s/{project_name}/${{ github.event.repository.name }}/g;
+            s|{project_name}|${{ github.event.repository.name }}|g;
-            s/{project_version}/${{ github.ref_name }}/g;
+            s|{project_version}|${{ github.ref_name }}|g;
-            s/{author}/${{ github.repository_owner }}/g;
+            s|{author}|${{ github.repository_owner }}|g;
-            s/{description}/${{ github.event.repository.description }}/g
+            s|{description}|${{ github.event.repository.description }}|g
           " setup.cfg
 
       - name: Build package

README.rst

@@ -3,7 +3,9 @@ FlanaBot
 
 |license| |project_version| |python_version|
 
-Flanagan's bot.
+Bot based on `github.com/AlberLC/multibot`_ to manage Discord, Telegram and Twitch chats, moderate them and add functionalities.
+
+|
 
 Installation
 ------------
@@ -14,6 +16,22 @@ Python 3.10 or higher is required.
 
     pip install flanabot
 
+|
+
+Features
+--------
+
+- Talks to users.
+- Delete message batches.
+- It works both in groups and in private chats.
+- Understands numbers and amounts of time textually expressed (useful for deleting a message batch or saying "flanabot ban john for one hour and 20 minutes").
+- Shows interactive via buttons charts of past, current and forecast weather.
+- Change user roles temporarily or forever.
+- Mute users temporarily or forever.
+- Ban users temporarily or forever.
+- Configurable default behavior for each chat, just talk to him to configure it.
+- Get media from twitter, instagram and tiktok and send it to the chat. From tiktok also obtains data about the song that is playing in the video.
+
 
 .. |license| image:: https://img.shields.io/github/license/AlberLC/flanabot?style=flat
     :target: https://github.com/AlberLC/flanabot/blob/main/LICENSE
@@ -26,3 +44,5 @@ Python 3.10 or higher is required.
 .. |python_version| image:: https://img.shields.io/pypi/pyversions/flanabot
     :target: https://www.python.org/downloads/
     :alt: PyPI - Python Version
+
+.. _github.com/AlberLC/multibot: https://github.com/AlberLC/multibot

flanabot/bots/flana_bot.py

@@ -3,7 +3,7 @@ import datetime
 import itertools
 import pprint
 import random
-import time
+import time as time_module
 from abc import ABC
 from asyncio import Future
 from typing import Iterable, Iterator, Type
@@ -36,7 +36,7 @@ class FlanaBot(MultiBot, ABC):
     def _add_handlers(self):
         super()._add_handlers()
 
-        self.register(self._on_bye, constants.KEYWORDS['bye'], min_ratio=1)
+        self.register(self._on_bye, constants.KEYWORDS['bye'])
 
         self.register(self._on_config_list_show, constants.KEYWORDS['config'])
         self.register(self._on_config_list_show, constants.KEYWORDS['help'])
@@ -87,6 +87,7 @@ class FlanaBot(MultiBot, ABC):
         self.register(self._on_hello, constants.KEYWORDS['hello'])
 
         self.register(self._on_mute, constants.KEYWORDS['mute'])
+        self.register(self._on_mute, (('haz', 'se'), constants.KEYWORDS['mute']))
         self.register(self._on_mute, (constants.KEYWORDS['deactivate'], constants.KEYWORDS['unmute']))
         self.register(self._on_mute, (constants.KEYWORDS['deactivate'], constants.KEYWORDS['sound']))
 
@@ -303,7 +304,7 @@ class FlanaBot(MultiBot, ABC):
 
     async def _search_medias(self, message: Message) -> OrderedSet[Media]:
         bot_state_message: Message | None = None
-        start_time = time.perf_counter()
+        start_time = time_module.perf_counter()
 
         results: Future = asyncio.gather(
             twitter.get_medias(message.text),
@@ -314,7 +315,7 @@ class FlanaBot(MultiBot, ABC):
 
         if not message.is_inline and (self.is_bot_mentioned(message) or not message.chat.is_group):
             while not results.done():
-                if constants.SCRAPING_MESSAGE_WAITING_TIME <= time.perf_counter() - start_time:
+                if constants.SCRAPING_MESSAGE_WAITING_TIME <= time_module.perf_counter() - start_time:
                     bot_state_message = await self.send(random.choice(constants.SCRAPING_PHRASES), message)
                     break
                 await asyncio.sleep(0.1)
@@ -573,23 +574,25 @@ class FlanaBot(MultiBot, ABC):
         ).split()
         place_words = (
                 OrderedSet(original_text_words)
-                - flanautils.cartesian_product_string_matching(original_text_words, constants.KEYWORDS['show'], min_ratio=0.8).keys()
+                - flanautils.cartesian_product_string_matching(original_text_words, constants.KEYWORDS['show'], min_ratio=0.85).keys()
-                - flanautils.cartesian_product_string_matching(original_text_words, constants.KEYWORDS['weather_chart'], min_ratio=0.8).keys()
+                - flanautils.cartesian_product_string_matching(original_text_words, constants.KEYWORDS['weather_chart'], min_ratio=0.85).keys()
-                - flanautils.cartesian_product_string_matching(original_text_words, constants.KEYWORDS['date'], min_ratio=0.8).keys()
+                - flanautils.cartesian_product_string_matching(original_text_words, constants.KEYWORDS['date'], min_ratio=0.85).keys()
-                - flanautils.cartesian_product_string_matching(original_text_words, constants.KEYWORDS['thanks'], min_ratio=0.8).keys()
+                - flanautils.cartesian_product_string_matching(original_text_words, constants.KEYWORDS['thanks'], min_ratio=0.85).keys()
                 - user_names_with_at_sign
                 - user_names_without_at_sign
-                - flanautils.CommonWords.words
+                - flanautils.CommonWords.all_words
         )
         if not place_words:
-            await self.send_error(random.choice(('¿Tiempo dónde?', 'Indica el sitio.', 'Y el sitio?', 'y el sitio? me lo invento?')), message)
+            if not message.is_inline:
+                await self.send_error(random.choice(('¿Tiempo dónde?', 'Indica el sitio.', 'Y el sitio?', 'y el sitio? me lo invento?')), message)
             return
 
         if 'calle' in original_text_words:
             place_words.insert(0, 'calle')
         place_query = ' '.join(place_words)
         if len(place_query) >= constants.MAX_PLACE_QUERY_LENGTH:
-            await self.send_error(Media('resources/mucho_texto.png'), message)
+            if not message.is_inline:
+                await self.send_error(Media('resources/mucho_texto.png'), message)
             return
         if show_progress_state:
             bot_state_message = await self.send(f'Buscando "{place_query}" en el mapa 🧐...', message)

flanabot/constants.py

@@ -52,8 +52,8 @@ HELLO_PHRASES = ('alo', 'aloh', 'buenas', 'Hola.', 'hello', 'hey', 'hi', 'hola',
 KEYWORDS = {
     'activate': ('activa', 'activar', 'activate', 'deja', 'dejale', 'devuelve', 'devuelvele', 'enable', 'encender',
                  'enciende', 'habilita', 'habilitar'),
-    'bye': ('adieu', 'adio', 'adiooooo', 'adios', 'agur', 'buenas', 'bye', 'cama', 'chao', 'dias', 'farewell',
+    'bye': ('adieu', 'adio', 'adiooooo', 'adios', 'agur', 'buenas', 'bye', 'cama', 'chao', 'farewell', 'goodbye',
-            'goodbye', 'hasta', 'luego', 'noches', 'pronto', 'taluego', 'taluegorl', 'tenga', 'vemos', 'vista', 'voy'),
+            'hasta', 'luego', 'noches', 'pronto', 'taluego', 'taluegorl', 'tenga', 'vemos', 'vista', 'voy'),
     'change': ('alter', 'alternar', 'alternate', 'cambiar', 'change', 'default', 'defecto', 'edit', 'editar',
                'exchange', 'modificar', 'modify', 'permutar', 'predeterminado', 'shift', 'swap', 'switch', 'turn',
                'vary'),

requirements.txt

@@ -5,6 +5,7 @@ asgiref==3.4.1
 async-generator==1.10
 async-timeout==3.0.1
 attrs==21.4.0
+beautifulsoup4==4.10.0
 certifi==2021.10.8
 cffi==1.15.0
 chardet==4.0.0
@@ -23,6 +24,7 @@ h11==0.12.0
 hachoir==3.1.2
 idna==3.3
 iso8601==1.0.2
+jellyfish==0.9.0
 kaleido==0.2.1
 mpmath==1.2.1
 multibot

tests/unit/test_parse_callbacks.py

@@ -1,16 +1,21 @@
+import os
+
+import flanautils
+
+os.environ |= flanautils.find_environment_variables('../.env')
+
 import unittest
 from typing import Iterable
 
-from flanabot import constants
+from multibot import constants as multibot_constants
-import flanautils
+from flanabot.bots.flana_tele_bot import FlanaTeleBot
-from flanabot.bots.flana_bots.flana_tele_bot import FlanaTeleBot
 
 
 class TestParseCallbacks(unittest.TestCase):
     def _test_no_always_callbacks(self, phrases: Iterable[str], callback: callable):
         for i, phrase in enumerate(phrases):
             with self.subTest(phrase):
-                callbacks = [registered_callback.callback for registered_callback in self.flana_tele_bot._parse_callbacks(phrase, constants.RATIO_REWARD_EXPONENT, constants.KEYWORDS_LENGHT_PENALTY, constants.MINIMUM_RATIO_TO_MATCH)
+                callbacks = [registered_callback.callback for registered_callback in self.flana_tele_bot._parse_callbacks(phrase, multibot_constants.RATIO_REWARD_EXPONENT, multibot_constants.KEYWORDS_LENGHT_PENALTY, multibot_constants.MINIMUM_RATIO_TO_MATCH)
                              if not registered_callback.always]
                 self.assertEqual(1, len(callbacks))
                 self.assertEqual(callback, callbacks[0], f'\n\nExpected: {callback.__name__}\nActual:   {callbacks[0].__name__}')
@@ -111,9 +116,9 @@ class TestParseCallbacks(unittest.TestCase):
 
     def test_on_mute(self):
         phrases = [
-            'silencia',
+            # 'silencia',
-            'silencia al pavo ese',
+            # 'silencia al pavo ese',
-            'calla a ese pesao',
+            # 'calla a ese pesao',
             'haz que se calle',
             'quitale el microfono a ese',
             'quitale el micro',
@@ -124,13 +129,6 @@ class TestParseCallbacks(unittest.TestCase):
         ]
         self._test_no_always_callbacks(phrases, self.flana_tele_bot._on_mute)
 
-    def test_on_new_message(self):
-        for i in range(10):
-            phrase = flanautils.random_string(0, 30, n_spaces=20)
-            with self.subTest(phrase):
-                callbacks = [registered_callback.callback for registered_callback in self.flana_tele_bot._parse_callbacks(phrase)]
-                self.assertIn(self.flana_tele_bot._on_new_message, callbacks, f'\n\nExpected: {self.flana_tele_bot._on_new_message.__name__} in {callbacks}')
-
     def test_on_new_message_default(self):
         phrases = [
             'asdqwergf',
@@ -157,7 +155,6 @@ class TestParseCallbacks(unittest.TestCase):
 
     def test_on_punish(self):
         phrases = [
-            'acabo con el',
             'acaba con el',
             'destrozalo',
             'ataca',
@@ -169,8 +166,6 @@ class TestParseCallbacks(unittest.TestCase):
             'castigalo',
             'castiga a',
             'castiga',
-            'banealo',
-            'banea',
             'enseña quien manda'
         ]
         self._test_no_always_callbacks(phrases, self.flana_tele_bot._on_punish)
@@ -249,8 +244,7 @@ class TestParseCallbacks(unittest.TestCase):
             'perdona a',
             'illo quitale a @flanagan el castigo',
             'quita castigo',
-            'devuelve los permisos',
+            'devuelve los permisos'
-            'desbanea'
         ]
         self._test_no_always_callbacks(phrases, self.flana_tele_bot._on_unpunish)
 
@@ -265,6 +259,8 @@ class TestParseCallbacks(unittest.TestCase):
             'sol',
             'temperatura',
             'humedad',
+            'que tiempo hara mañana',
+            'que tiempo hara manana',
             'que tiempo hace en malaga',
             'que tiempo hace en calle larios',
             'tiempo rusia',