add gitlab event plugin & make CI green (#2)

* add gitlab event plugin

* clean the CI

* change github action python version

* add daily plugin basic test to pass the CI

* update the package dependency

* update contrib version to 0.0.2

* add github webhook plugin

* refactor the wechaty-plugin-contrb

* fix daily plugin bot

* fix bad-return-type issue

* update github auto deploy

* update version & remove duplicate package

Author: wj-Mcat

.github/workflows/pypi.yml

@@ -16,37 +16,47 @@ jobs:
 
     steps:
     - uses: actions/checkout@v2
-    - name: Set up Python 3.8
+    - name: Set up Python 3.7
       uses: actions/setup-python@v2
       with:
-        python-version: 3.8
+        python-version: 3.7
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
         pip install flake8 pytest
         if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
         if [ -f requirements-dev.txt ]; then pip install -r requirements-dev.txt; fi
-        
+
     - name: run test
-      run: 
+      run:
         make test
-      
-  deploy:
 
+  deploy:
+    if: github.event_name == 'push' && (github.ref == 'refs/heads/master' || startsWith(github.ref, 'refs/heads/v'))
     runs-on: ubuntu-latest
     needs: [build]
 
     steps:
     - uses: actions/checkout@v2
+
     - name: Set up Python
       uses: actions/setup-python@v2
       with:
         python-version: '3.x'
+
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
         pip install setuptools wheel twine
+    - name: Check Branch
+      id: check-branch
+      run: |
+        if [[ ${{ github.ref }} =~ ^refs/heads/(master|v[0-9]+\.[0-9]+.*)$ ]]; then
+            echo ::set-output name=match::true
+        fi  # See: https://stackoverflow.com/a/58869470/1123955
+
     - name: Build and publish
+      if: steps.check-branch.outputs.match == 'true'
       env:
         TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }}
         TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}

Dockerfile

@@ -1 +1 @@
-0.0.1
+0.0.3

VERSION

@@ -1,11 +1,21 @@
 """daily plugin bot examples"""
 import asyncio
+from datetime import datetime
 
 from wechaty import Wechaty  # type: ignore
+from wechaty_puppet import RoomQueryFilter  # type: ignore
+
 from wechaty_plugin_contrib.daily_plugin import DailyPluginOptions, DailyPlugin
 from wechaty_plugin_contrib.ding_dong_plugin import DingDongPlugin
 
 
+async def say_hello(bot: Wechaty):
+    """say hello to the room"""
+    room = await bot.Room.find(query=RoomQueryFilter(topic='小群，小群1'))
+    if room:
+        await room.say(f'hello bupt ... {datetime.now()}')
+
+
 async def run():
     """async run method"""
     morning_plugin = DailyPlugin(DailyPluginOptions(
@@ -18,21 +28,11 @@ async def run():
         },
         msg='宝贝，早安，爱你哟～'
     ))
-
-    eating_plugin = DailyPlugin(DailyPluginOptions(
-        name='girl-friend-bot-eating',
-        contact_id='some-one-id',
-        trigger='cron',
-        kwargs={
-            'hour': 11,
-            'minute': 30
-        },
-        msg='中午要记得好好吃饭喔～'
-    ))
+    morning_plugin.add_interval_job(say_hello)
 
     ding_dong_plugin = DingDongPlugin()
 
-    bot = Wechaty().use(morning_plugin).use(eating_plugin).use(ding_dong_plugin)
+    bot = Wechaty().use(morning_plugin).use(ding_dong_plugin)
     await bot.start()
 
 asyncio.run(run())

examples/daily_plugin_bot.py

@@ -1,2 +1,3 @@
 wechaty>=0.5.dev1
 jieba
+aiohttp

requirements.txt

@@ -4,13 +4,20 @@
     DailyPluginOptions,
     DailyPlugin
 )
-from wechaty_plugin_contrib.messager_plugin import MessagerPlugin
+
+from wechaty_plugin_contrib.contrib import (
+    AutoReplyRule,
+    AutoReplyOptions,
+    AutoReplyPlugin
+)
 
 __all__ = [
     'DingDongPlugin',
 
     'DailyPluginOptions',
     'DailyPlugin',
 
-    'MessagerPlugin'
+    'AutoReplyRule',
+    'AutoReplyOptions',
+    'AutoReplyPlugin'
 ]

src/wechaty_plugin_contrib/__init__.py

@@ -0,0 +1,24 @@
+"""import basic config from wechaty-puppet"""
+
+from wechaty import (   # type: ignore
+    Room,
+    Contact,
+    Message,
+
+    Wechaty
+)
+
+from wechaty_puppet import get_logger   # type: ignore
+
+from .version import version
+
+__all__ = [
+    'get_logger',
+    'version',
+
+    'Room',
+    'Contact',
+    'Message',
+
+    'Wechaty'
+]

src/wechaty_plugin_contrib/config.py

@@ -0,0 +1,11 @@
+from .auto_reply_plugin import (
+    AutoReplyRule,
+    AutoReplyOptions,
+    AutoReplyPlugin
+)
+
+__all__ = [
+    'AutoReplyOptions',
+    'AutoReplyPlugin',
+    'AutoReplyRule'
+]

src/wechaty_plugin_contrib/contrib/__init__.py

@@ -0,0 +1,11 @@
+from .plugin import (
+    AutoReplyRule,
+    AutoReplyOptions,
+    AutoReplyPlugin
+)
+
+__all__ = [
+    'AutoReplyOptions',
+    'AutoReplyPlugin',
+    'AutoReplyRule'
+]

src/wechaty_plugin_contrib/contrib/auto_reply_plugin/__init__.py

@@ -0,0 +1,53 @@
+"""AutoReply to someone according to keywords"""
+from dataclasses import dataclass, field
+from typing import Union, List, Dict
+
+from wechaty import (   # type: ignore
+    WechatyPlugin,
+    WechatyPluginOptions,
+    FileBox,
+    Contact,
+    Message
+)
+
+from wechaty_puppet import (    # type: ignore
+    get_logger
+)
+
+
+@dataclass
+class AutoReplyRule:
+    keyword: str
+    reply_content: Union[str, FileBox, Contact]
+
+
+@dataclass
+class AutoReplyOptions(WechatyPluginOptions):
+    rules: List[AutoReplyRule] = field(default_factory=list)
+
+
+logger = get_logger('AutoReplyPlugin')
+
+
+class AutoReplyPlugin(WechatyPlugin):
+
+    def __init__(self, options: AutoReplyOptions):
+        super().__init__(options)
+
+        self.rule_map: Dict[str, AutoReplyRule] = {}
+        if options.rules:
+            self.rule_map = {rule.keyword: rule for rule in options.rules}
+
+    async def on_message(self, msg: Message):
+        """check the keyword and reply to talker"""
+        text = msg.text()
+
+        if text in self.rule_map:
+            room = msg.room()
+            if room:
+                await room.ready()
+                await room.say(self.rule_map[text])
+            else:
+                talker = msg.talker()
+                await talker.ready()
+                await talker.say(self.rule_map[text])

src/wechaty_plugin_contrib/contrib/auto_reply_plugin/plugin.py

@@ -1,9 +1,10 @@
 """daily plugin"""
 from __future__ import annotations
 from dataclasses import dataclass
-from typing import Optional, Union
+from typing import Optional, Union, List, Any
 
 from apscheduler.schedulers.asyncio import AsyncIOScheduler     # type: ignore
+from apscheduler.schedulers.base import BaseScheduler   # type: ignore
 
 from wechaty import Wechaty, get_logger, Room, Contact      # type: ignore
 from wechaty.plugin import WechatyPlugin, WechatyPluginOptions  # type: ignore
@@ -42,6 +43,8 @@ def __init__(self, options: DailyPluginOptions):
             raise Exception('msg should not be none')
 
         self.options: DailyPluginOptions = options
+        self.scheduler: BaseScheduler = AsyncIOScheduler()
+        self._scheduler_jobs: List[Any] = []
 
     @property
     def name(self) -> str:
@@ -67,8 +70,20 @@ async def tick(self, msg: str):
     async def init_plugin(self, wechaty: Wechaty):
         """init plugin"""
         await super().init_plugin(wechaty)
-        scheduler = AsyncIOScheduler()
-        scheduler.add_job(self.tick, self.options.trigger,
-                          kwargs={'msg': self.options.msg},
-                          **self.options.kwargs)
-        scheduler.start()
+        for job in self._scheduler_jobs:
+            job(wechaty)
+        self.scheduler.start()
+
+    def add_interval_job(self, func):
+        """add interval job"""
+
+        def add_job(bot: Wechaty):
+            self.scheduler.add_job(
+                func,
+                trigger='interval',
+                seconds=5,
+                kwargs={
+                    'bot': bot
+                }
+            )
+        self._scheduler_jobs.append(add_job)

src/wechaty_plugin_contrib/daily_plugin.py

@@ -1,6 +1,6 @@
 """basic ding-dong bot for the wechaty plugin"""
-from typing import Union, Optional, List
-from dataclasses import dataclass
+from typing import List, Union
+from dataclasses import dataclass, field
 from wechaty import Message, Contact, Room, get_logger  # type: ignore
 from wechaty.plugin import WechatyPlugin, WechatyPluginOptions  # type: ignore
 
@@ -15,13 +15,13 @@ class DingDongPluginOptions(WechatyPluginOptions):
 
     only one of [include_conversation_ids,exclude_conversation_ids] can be empty
     """
-    include_conversation_ids: Optional[List[str]] = None
-    exclude_conversation_ids: Optional[List[str]] = None
+    include_conversation_ids: List[str] = field(default_factory=list)
+    exclude_conversation_ids: List[str] = field(default_factory=list)
 
 
 class DingDongPlugin(WechatyPlugin):
     """basic ding-dong plugin"""
-    def __init__(self, options: Optional[DingDongPluginOptions] = None):
+    def __init__(self, options: DingDongPluginOptions = None):
         super().__init__(options)
 
         if options is not None:
@@ -59,8 +59,7 @@ async def on_message(self, msg: Message):
         text = msg.text()
         room = msg.room()
         if text == '#ding':
-            conversation: Union[
-                Room, Contact] = from_contact if room is None else room
+            conversation: Union[Room, Contact] = from_contact if room is None else room
             conversation_id = from_contact.contact_id if room is None \
                 else room.room_id
             if self.can_send_dong(conversation_id):

src/wechaty_plugin_contrib/ding_dong_plugin.py

@@ -0,0 +1,56 @@
+"""Message Finder to match the specific message"""
+import re
+from re import Pattern
+import inspect
+from typing import List
+
+from wechaty_plugin_contrib.config import (
+    get_logger,
+    Contact,
+    Wechaty
+)
+
+from .finder import Finder
+
+
+logger = get_logger("MessageFinder")
+
+
+class MessageFinder(Finder):
+    async def match(self, wechaty: Wechaty) -> List[Contact]:
+        """match the room"""
+        logger.info(f'MessageFinder match({Wechaty})')
+
+        contacts: List[Contact] = []
+
+        for option in self.options:
+            if isinstance(option, Pattern):
+
+                # search from all of the friends
+                re_pattern = re.compile(option)
+                # match the room with regex pattern
+                all_friends = await wechaty.Contact.find_all()
+                for friend in all_friends:
+                    alias = await friend.alias()
+                    if re.match(re_pattern, friend.name) or re.match(re_pattern, alias):
+                        contacts.append(friend)
+
+            elif isinstance(option, str):
+                contact = wechaty.Contact.load(option)
+                await contact.ready()
+                contacts.append(contact)
+            elif hasattr(option, '__call__'):
+                """check the type of the function
+                refer: https://stackoverflow.com/a/56240578/6894382
+                """
+                if inspect.iscoroutinefunction(option):
+                    # pytype: disable=bad-return-type
+                    targets = await option(wechaty)
+                else:
+                    targets = option(wechaty)
+
+                if isinstance(targets, List[Contact]):
+                    contacts.extend(targets)
+            else:
+                raise ValueError(f'unknown type option: {option}')
+        return contacts