Merge pull request #17 from green-api/dev

v0.7.0

Author: Amele9

README.md

@@ -46,6 +46,12 @@ bot = GreenAPIBot(
 )
 ```
 
+### How to set up an instance
+
+To start receiving incoming notifications, you need to set up an instance. Open the personal cabinet page at
+the [link](https://console.green-api.com/). Select an instance from the list and click on it. Click **Change**. In the *
+*Notifications** category, enable all notifications that you want to receive.
+
 ### How to start receiving and answering messages
 
 To start receiving messages, you must create a handler function with one parameter (`notification`). The `notification`
@@ -60,6 +66,8 @@ brackets.
 
 To start the bot, call the `bot.run_forever` function. You can stop the bot with the key combination Ctrl + C.
 
+In this example, the bot will only answer the `message` message.
+
 Link to example: [base.py](https://github.com/green-api/whatsapp-chatbot-python/blob/master/examples/base.py).
 
 ```
@@ -82,6 +90,8 @@ You can receive not only incoming messages but also outgoing messages. You can a
 The body of the notification is in `notification.event`. In this example, we get the message type from the notification
 body.
 
+In this example, the bot receives all incoming messages.
+
 Link to example: [event.py](https://github.com/green-api/whatsapp-chatbot-python/blob/master/examples/event.py).
 
 ```
@@ -163,6 +173,8 @@ command = ("help", "!/")
 
 #### Example
 
+In this example, the bot will send a photo in response to the `rates` command.
+
 Link to example: [filters.py](https://github.com/green-api/whatsapp-chatbot-python/blob/master/examples/filters.py).
 
 ```
@@ -316,6 +328,8 @@ To send a text message, you have to use the `notification.answer` method.
 To send a location, you have to use the `sending.sendLocation` method from `notification.api`.
 To send a message with a file, you have to use the `notification.answer_with_file` method.
 
+In this example, the bot only responds to commands from the list above.
+
 Link to example: [full.py](https://github.com/green-api/whatsapp-chatbot-python/blob/master/examples/full.py).
 
 ```python

docs/README.md

@@ -45,6 +45,12 @@ bot = GreenAPIBot(
 )
 ```
 
+### Как настроить инстанс
+
+Чтобы начать получать входящие уведомления, нужно настроить инстанс. Открываем страницу личного кабинета
+по [ссылке](https://console.green-api.com/). Выбираем инстанс из списка и кликаем на него. Нажимаем **Изменить**. В
+категории **Уведомления** включаем все что необходимо получать.
+
 ### Как начать получать сообщения и отвечать на них
 
 Чтобы начать получать сообщения, вам нужно создать функцию-обработчик с одним параметром (`notification`).
@@ -59,6 +65,8 @@ bot = GreenAPIBot(
 Чтобы запустить бота, нужно вызвать функцию `bot.run_forever`.
 Остановить бота можно с помощью сочетания клавиш Ctrl + C.
 
+В этом примере бот ответит только на сообщение `message`.
+
 Ссылка на пример: [base.py](../examples/base.py).
 
 ```
@@ -80,6 +88,8 @@ bot.run_forever()
 
 Тело уведомления находится в `notification.event`. В этом примере мы отправляем в консоль тело нового уведомления.
 
+В этом примере бот получает все входящие сообщения.
+
 Ссылка на пример: [event.py](../examples/event.py).
 
 ```
@@ -162,6 +172,8 @@ command = ("help", "!/")
 
 #### Пример
 
+В этом примере бот отправит фотографию в ответ на команду `rates`.
+
 Ссылка на пример: [filters.py](../examples/filters.py).
 
 ```
@@ -315,6 +327,8 @@ bot.run_forever()
 Чтобы отправить место (локацию), нужно использовать метод `sending.sendLocation` из `notification.api`.
 Чтобы отправить сообщение с файлом, нужно использовать метод `notification.answer_with_file`.
 
+В этом примере бот отвечает только на комманды из списка выше.
+
 Ссылка на пример: [full.py](../examples/full.py).
 
 ```python

setup.py

@@ -5,7 +5,7 @@
 
 setup(
     name="whatsapp-chatbot-python",
-    version="0.6.0",
+    version="0.7.0",
     description=(
         "This library helps you easily create"
         " a Python chatbot with WhatsApp API."

whatsapp_chatbot_python/bot.py

@@ -1,6 +1,6 @@
 from typing import NoReturn, Optional
 
-from whatsapp_api_client_python.API import GreenApi
+from whatsapp_api_client_python.API import GreenApi, Response
 
 from .manager.router import Router
 
@@ -18,7 +18,7 @@ def __init__(
         if not settings:
             self._update_settings()
         else:
-            self.api.account.setSettings(settings)
+            self.__validate_response(self.api.account.setSettings(settings))
 
         if delete_notifications_at_startup:
             self._delete_notifications_at_startup()
@@ -29,23 +29,27 @@ def run_forever(self) -> Optional[NoReturn]:
         while True:
             try:
                 response = self.api.receiving.receiveNotification()
-                if response.error:
-                    raise GreenAPIError(response.error)
+
+                self.__validate_response(response)
 
                 if not response.data:
                     continue
                 response = response.data
 
                 self.router.route_event(response["body"])
 
-                self.api.receiving.deleteNotification(response["receiptId"])
+                self.__validate_response(
+                    self.api.receiving.deleteNotification(
+                        response["receiptId"]
+                    )
+                )
             except KeyboardInterrupt:
                 break
 
     def _update_settings(self) -> Optional[NoReturn]:
         settings = self.api.account.getSettings()
-        if settings.error:
-            raise GreenAPIError(settings.error)
+
+        self.__validate_response(settings)
 
         response = settings.data
 
@@ -57,22 +61,37 @@ def _update_settings(self) -> Optional[NoReturn]:
                 and outgoing_message_webhook == "no"
                 and outgoing_api_message_webhook == "no"
         ):
-            self.api.account.setSettings({
-                "incomingWebhook": "yes",
-                "outgoingMessageWebhook": "yes",
-                "outgoingAPIMessageWebhook": "yes"
-            })
+            self.__validate_response(
+                self.api.account.setSettings({
+                    "incomingWebhook": "yes",
+                    "outgoingMessageWebhook": "yes",
+                    "outgoingAPIMessageWebhook": "yes"
+                })
+            )
 
     def _delete_notifications_at_startup(self) -> Optional[NoReturn]:
         while True:
             response = self.api.receiving.receiveNotification()
-            if response.error:
-                raise GreenAPIError(response.error)
+
+            self.__validate_response(response)
 
             if not response.data:
                 break
 
-            self.api.receiving.deleteNotification(response.data["receiptId"])
+            self.__validate_response(
+                self.api.receiving.deleteNotification(
+                    response.data["receiptId"]
+                )
+            )
+
+    @staticmethod
+    def __validate_response(response: Response) -> Optional[NoReturn]:
+        if response.code != 200:
+            if response.error:
+                raise GreenAPIError(response.error)
+            raise GreenAPIError(
+                f"GreenAPI error occurred with status code {response.code}"
+            )
 
 
 class GreenAPI(GreenApi):

whatsapp_chatbot_python/filters.py

@@ -1,5 +1,5 @@
 from abc import ABC, abstractmethod
-from re import fullmatch
+from re import RegexFlag, fullmatch
 from typing import Dict, List, Optional, TYPE_CHECKING, Type, Union
 
 if TYPE_CHECKING:
@@ -75,15 +75,20 @@ def check_event(self, notification: "Notification") -> bool:
 
 
 class RegExpFilter(AbstractFilter):
-    def __init__(self, pattern: str):
-        self.pattern = pattern
+    def __init__(self, pattern: str, flags: Union[RegexFlag, int] = 0):
+        if isinstance(pattern, str):
+            self.pattern = pattern
+            self.flags = flags
+        elif isinstance(pattern, tuple):
+            if len(pattern) == 2:
+                self.pattern, self.flags = pattern
 
     def check_event(self, notification: "Notification") -> bool:
         text_message = notification.message_text
         if text_message is None:
             return False
 
-        if fullmatch(self.pattern, text_message):
+        if fullmatch(self.pattern, text_message, self.flags):
             return True
         return False