Add support for receiving channel posts

Author: Marco

botogram/bot.py

@@ -71,6 +71,10 @@ def __init__(self, api_connection):
         self.register_update_processor("message", messages.process_message)
         self.register_update_processor("edited_message",
                                        messages.process_edited_message)
+        self.register_update_processor("channel_post",
+                                       messages.process_channel_post)
+        self.register_update_processor("edited_channel_post",
+                                       messages.process_channel_post_edited)
 
         self._bot_id = str(uuid.uuid4())
 
@@ -144,6 +148,16 @@ def message_edited(self, func):
         self._main_component.add_message_edited_hook(func)
         return func
 
+    def channel_post(self, func):
+        """Add a channel post hook"""
+        self._main_component.add_channel_post_hook(func)
+        return func
+
+    def channel_post_edited(self, func):
+        """Add a edited channel post hook"""
+        self._main_component.add_channel_post_edited_hook(func)
+        return func
+
     def command(self, name, hidden=False, order=0):
         """Register a new command"""
         def __(func):

botogram/components.py

@@ -32,6 +32,8 @@ def __new__(cls, *args, **kwargs):
         self.__timers = []
         self.__chat_unavailable_hooks = []
         self.__messages_edited_hooks = []
+        self.__channel_post_hooks = []
+        self.__channel_post_edited_hooks = []
 
         self._component_id = str(uuid.uuid4())
 
@@ -158,6 +160,22 @@ def add_message_edited_hook(self, func):
         hook = hooks.MessageEditedHook(func, self)
         self.__messages_edited_hooks.append(hook)
 
+    def add_channel_post_hook(self, func):
+        """Add a channel post hook"""
+        if not callable(func):
+            raise ValueError("A channel post hook must be callable")
+
+        hook = hooks.ChannelPostHook(func, self)
+        self.__channel_post_hooks.append(hook)
+
+    def add_channel_post_edited_hook(self, func):
+        """Add an edited channel post hook"""
+        if not callable(func):
+            raise ValueError("A edited channel post hook must be callable")
+
+        hook = hooks.EditedChannelPostHook(func, self)
+        self.__channel_post_edited_hooks.append(hook)
+
     def _add_no_commands_hook(self, func):
         """Register an hook which will be executed when no commands matches"""
         if not callable(func):
@@ -181,6 +199,8 @@ def _get_chains(self):
             "tasks": [self.__timers],
             "chat_unavalable_hooks": [self.__chat_unavailable_hooks],
             "messages_edited": [self.__messages_edited_hooks],
+            "channel_post": [self.__channel_post_hooks],
+            "channel_post_edited": [self.__channel_post_edited_hooks]
         }
 
     def _get_commands(self):

botogram/hooks.py

@@ -212,6 +212,24 @@ def _call(self, bot, update):
                          message=message)
 
 
+class ChannelPostHook(Hook):
+    """Underlying hook for @bot.channel_post"""
+
+    def _call(self, bot, update):
+        message = update.channel_post
+        return bot._call(self.func, self.component_id, chat=message.chat,
+                         message=message)
+
+
+class EditedChannelPostHook(Hook):
+    """Underlying hook for @bot.channel_post_edited"""
+
+    def _call(self, bot, update):
+        message = update.edited_channel_post
+        return bot._call(self.func, self.component_id, chat=message.chat,
+                         message=message)
+
+
 class TimerHook(Hook):
     """Underlying hook for a timer"""
 

botogram/messages.py

@@ -37,3 +37,35 @@ def process_edited_message(bot, chains, update):
 
     bot.logger.debug("No hook actually processed the #%s update." %
                      update.update_id)
+
+
+def process_channel_post(bot, chains, update):
+    """Process a channel post"""
+    for hook in chains["channel_post"]:
+        bot.logger.debug("Processing channel post in update #%s with the "
+                         "hook %s..." % (update.update_id, hook.name))
+
+        result = hook.call(bot, update)
+        if result is True:
+            bot.logger.debug("Update %s was just processed by the %s hook." %
+                             (update.update_id, hook.name))
+            return
+
+    bot.logger.debug("No hook actually processed the #%s update." %
+                     update.update_id)
+
+
+def process_channel_post_edited(bot, chains, update):
+    """Process an edited channel post"""
+    for hook in chains["channel_post_edited"]:
+        bot.logger.debug("Processing edited channel post in update #%s with"
+                         "the hook %s..." % (update.update_id, hook.name))
+
+        result = hook.call(bot, update)
+        if result is True:
+            bot.logger.debug("Update %s was just processed by the %s hook." %
+                             (update.update_id, hook.name))
+            return
+
+    bot.logger.debug("No hook actually processed the #%s update." %
+                     update.update_id)

botogram/objects/updates.py

@@ -23,6 +23,8 @@ class Update(BaseObject):
     optional = {
         "message": Message,
         "edited_message": Message,
+        "channel_post": Message,
+        "edited_channel_post": Message
     }
     _check_equality_ = "update_id"
 

docs/api/bot.rst

@@ -194,6 +194,51 @@ components.
 
       .. versionadded:: 0.3
 
+   .. py:decoratormethod:: channel_post
+
+      Functions decorated with this decorator will receive all the messages
+      posted to channels the bot is a member of. This allows you to act when
+      certain messages are received, as an example.
+
+      You can :ref:`request the following arguments <bot-structure-hooks-args>`
+      in the decorated functions:
+
+      * **chat**: the chat in which the channel post was originally sent
+        (instance of :py:class:`~botogram.Chat`)
+
+      * **message**: the message (instance of :py:class:`~botogram.Message`)
+
+      .. code-block:: python
+
+         @bot.channel_post
+         def channel_post(chat, message):
+             message.reply("I read this post!")
+
+      .. versionadded:: 0.4
+
+   .. py:decoratormethod:: channel_post_edited
+
+      Functions decorated with this decorator will receive all the messages
+      edited in channels the bot is a member of. This allows you to act when
+      certain messages are changed, as an example.
+
+      You can :ref:`request the following arguments <bot-structure-hooks-args>`
+      in the decorated functions:
+
+      * **chat**: the chat in which the channel post was originally sent
+        (instance of :py:class:`~botogram.Chat`)
+
+      * **message**: the (new) edited message (instance of
+        :py:class:`~botogram.Message`)
+
+      .. code-block:: python
+
+         @bot.channel_post_edited
+         def channel_post_edited(chat, message):
+             message.reply("This post is changed!")
+
+      .. versionadded:: 0.4
+
    .. py:decoratormethod:: command(name, [hidden=False, order=0])
 
       This decorator register a new command, and calls the decorated function

docs/api/components.rst

@@ -158,6 +158,64 @@ about how to create them in the ":ref:`custom-components`" chapter.
 
       .. versionadded:: 0.3
 
+   .. py:method:: add_channel_post_hook(func)
+
+      All the functions provided to this method will receive all the messages
+      posted to channels the bot is a member of. This allows you to act when
+      certain messages are received, as an example.
+
+      You can :ref:`request the following arguments <bot-structure-hooks-args>`
+      in the provided functions:
+
+      * **chat**: the chat in which the channel post was originally sent
+        (instance of :py:class:`~botogram.Chat`)
+
+      * **message**: the message (instance of :py:class:`~botogram.Message`)
+
+      .. code-block:: python
+
+         class ChannelAckComponent(botogram.Component):
+             component_name = "channel-ack"
+
+             def __init__(self):
+                 self.add_channel_post_hook(self.reply)
+
+            def reply(self, chat, message):
+                message.reply("I read this post!")
+
+      :param callable func: The function you want to use.
+
+      .. versionadded:: 0.4
+
+   .. py:method:: add_channel_post_edited_hook(func)
+
+      All the functions provided to this method will receive all the messages
+      edited in channels the bot is a member of. This allows you to act when
+      certain messages are changed, as an example.
+
+      You can :ref:`request the following arguments <bot-structure-hooks-args>`
+      in the provided functions:
+
+      * **chat**: the chat in which the channel post was originally sent
+        (instance of :py:class:`~botogram.Chat`)
+
+      * **message**: the (new) edited message (instance of :py:class:`~botogram.Message`)
+
+      .. code-block:: python
+
+         class ChannelAlertComponent(botogram.Component):
+             component_name = "channel-alert"
+
+             def __init__(self):
+                 self.add_channel_post_edited_hook(self.reply)
+
+            def reply(self, chat, message):
+                message.reply("This post is changed!")
+
+      :param callable func: The function you want to use.
+
+      .. versionadded:: 0.4
+
    .. py:method:: add_command(name, func, [hidden=False, order=0])
 
       This function registers a new command, and calls the provided function

docs/changelog/0.4.rst

@@ -19,6 +19,13 @@ Release description not yet written.
 New features
 ------------
 
+* Added support for receiving messages sent to channels
+
+  * New decorator :py:meth:`botogram.Bot.channel_post`
+  * New decorator :py:meth:`botogram.Bot.channel_post_edited`
+  * New method :py:meth:`botogram.Component.add_channel_post_hook`
+  * New method :py:meth:`botogram.Component.add_channel_post_edited_hook`
+
 * Added ability to disable the link preview in ``/help``.
 
   * New parameter :py:attr:`botogram.Bot.link_preview_in_help`