flask_slackbot 0.2.1
Deal with slack outgoing webhook
License: MIT

|Build Status| |Coverage Status| |PyPI Version| |PyPI Downloads|

Flask-SlackBot
===================

Flask-SlackBot is a Flask extension which helps you deal with slack's outgoing webhook.

Installation
------------
::

    $ pip install flask-slackbot


Usage
-----

.. code-block:: python

    # coding=utf-8
    from flask import Flask

    from flask_slackbot import SlackBot


    app = Flask(__name__)
    app.config['SLACK_TOKEN'] = 'Your token here'
    # if you need to use slacker you should give a slack chat token
    app.config['SLACK_CHAT_TOKEN'] = 'Your slack chat token'
    app.config['SLACK_CALLBACK'] = '/slack_callback'
    app.debug = True
    slackbot = SlackBot(app)

    '''
    The parameter of the callback function is a dict returns from the slack's outgoing api.
    Here is the detail:
    kwargs
    {
        'token': token,
        'team_id': team_id,
        'team_domain': team_domain,
        'channel_id': channel_id,
        'channel_name': channel_name,
        'timestamp': timestamp,
        'user_id': user_id,
        'user_name': user_name,
        'text': text,
        'trigger_word': trigger_word
    }'''
    def fn1(kwargs):
        '''
        This function shows response the slack post directly without an extra post.
        In this case, you need to return a dict.'''
        return {'text': '!' + kwargs['text']} # Note the '!' character here is an user defined flag to tell the slack, this message is sent from the bot.


    def fn4(kwargs):
        '''
        This function looks like upper one. But a little different, this will only response to the sender.
        In this case, you need to return a dict with an extra key private setted as True.
        And if you need this function, you should given the slack chat token in config.'''
        return {'text': '!' + kwargs['text'], 'private': True} # Note the '!' character here is an user defined flag to tell the slack, this message is sent from the bot.


    def fn2(kwargs):
        '''
        This function shows response the slack post indirectly with an extra post.
        In this case, you need to return None.
        Now the slack will ignore the response from this request, and if you need do some complex task you can use the built-in slacker.
        For more information, see https://github.com/os/slacker'''
        slackbot.slack.chat.post_message('#general', 'hello from slacker handler')
        return None


    def fn3(text):
        '''
        This function is a filter, which makes our bot ignore the text sent from itself.'''
        return text.startswith('!')

    slackbot.set_handler(fn1)
    slackbot.filter_outgoing(fn3)


    if __name__ == "__main__":
        app.run()


Trap
------------
If you have not set a trigger word, and your callback server return some text to slack, there would be a callback hell. You know like ping pong, and then turn into an infinite loop.

.. |Build Status| image:: https://travis-ci.org/python-cn/flask-slackbot.svg?branch=master
   :target: https://travis-ci.org/python-cn/flask-slackbot
   :alt: Build Status
.. |PyPI Version| image:: https://img.shields.io/pypi/v/Flask-Slackbot.svg
   :target: https://pypi.python.org/pypi/Flask-SlackBot
   :alt: PyPI Version
.. |PyPI Downloads| image:: https://img.shields.io/pypi/dm/Flask-SlackBot.svg
   :target: https://pypi.python.org/pypi/Flask-SlackBot
   :alt: Downloads
.. |Coverage Status| image:: https://img.shields.io/coveralls/python-cn/flask-slackbot.svg
   :target: https://coveralls.io/r/python-cn/flask-slackbot
   :alt: Coverage Status