Merge pull request #69 from seratch/pr-56

Update #56 - Accept usage of Flask Blueprints as app instance

Author: seratch

example/blueprint/example.py

@@ -0,0 +1,55 @@
+# ------------------
+# Only for running this script here
+import logging
+import sys
+from os.path import dirname
+
+sys.path.insert(1, f"{dirname(__file__)}/../..")
+logging.basicConfig(level=logging.DEBUG)
+# ------------------
+
+from slackeventsapi import SlackEventAdapter
+from slack import WebClient
+import os
+
+from flask import Flask, Blueprint
+slack_events = Blueprint('slack_events', __name__)
+
+# Our app's Slack Event Adapter for receiving actions via the Events API
+slack_signing_secret = os.environ["SLACK_SIGNING_SECRET"]
+slack_events_adapter = SlackEventAdapter(slack_signing_secret, "/slack/events", slack_events)
+
+# Create a SlackClient for your bot to use for Web API requests
+slack_bot_token = os.environ["SLACK_BOT_TOKEN"]
+slack_client = WebClient(slack_bot_token)
+
+# Example responder to greetings
+@slack_events_adapter.on("message")
+def handle_message(event_data):
+    message = event_data["event"]
+    # If the incoming message contains "hi", then respond with a "Hello" message
+    if message.get("subtype") is None and "hi" in message.get('text'):
+        channel = message["channel"]
+        message = "Hello <@%s>! :tada:" % message["user"]
+        slack_client.chat_postMessage(channel=channel, text=message)
+
+
+# Example reaction emoji echo
+@slack_events_adapter.on("reaction_added")
+def reaction_added(event_data):
+    event = event_data["event"]
+    emoji = event["reaction"]
+    channel = event["item"]["channel"]
+    text = ":%s:" % emoji
+    slack_client.chat_postMessage(channel=channel, text=text)
+
+# Error events
+@slack_events_adapter.on("error")
+def error_handler(err):
+    print("ERROR: " + str(err))
+
+
+app = Flask(__name__)
+app.register_blueprint(slack_events)
+
+# FLASK_APP=example.py FLASK_ENV=development flask run --port 3000

example/blueprint/requirements.txt

@@ -0,0 +1,3 @@
+slackclient>=2.7.1
+slackeventsapi>=2.1.0
+flask>=1

slackeventsapi/server.py

@@ -1,4 +1,4 @@
-from flask import Flask, request, make_response
+from flask import Flask, request, make_response, Blueprint
 import json
 import platform
 import sys
@@ -18,10 +18,10 @@ def __init__(self, signing_secret, endpoint, emitter, server):
         # If a server is passed in, bind the event handler routes to it,
         # otherwise create a new Flask instance.
         if server:
-            if isinstance(server, Flask):
+            if isinstance(server, Flask) or isinstance(server, Blueprint):
                 self.bind_route(server)
             else:
-                raise TypeError("Server must be an instance of Flask")
+                raise TypeError("Server must be an instance of Flask or Blueprint")
         else:
             Flask.__init__(self, __name__)
             self.bind_route(self)

tests/test_server.py

@@ -1,12 +1,11 @@
-import json
-from flask import Flask
-import pytest
-import sys
 import hmac
 import time
+
+import pytest
+from flask import Flask, Blueprint, make_response
+
 from slackeventsapi import SlackEventAdapter
 from slackeventsapi.server import SlackEventAdapterException
-from slackeventsapi.version import __version__
 
 
 def test_existing_flask():
@@ -19,9 +18,19 @@ def test_server_not_flask():
     with pytest.raises(TypeError) as e:
         invalid_flask = "I am not a Flask"
         SlackEventAdapter("SIGNING_SECRET", "/slack/events", invalid_flask)
-    assert e.value.args[0] == 'Server must be an instance of Flask'
+    assert e.value.args[0] == 'Server must be an instance of Flask or Blueprint'
 
 
+def test_blueprint_server():
+    simple_page = Blueprint('simple_page', __name__)
+    @simple_page.route('/', defaults={'page': 'index'})
+    @simple_page.route('/<page>')
+    def show(page):
+        return make_response("This is page " + page)
+
+    valid_adapter = SlackEventAdapter("SIGNING_SECRET", "/slack/events", simple_page)
+    assert isinstance(valid_adapter, SlackEventAdapter)
+
 def test_event_endpoint_get(client):
     # GET on '/slack/events' should 404
     res = client.get('/slack/events')
@@ -74,7 +83,7 @@ def test_invalid_request_timestamp(client):
     slack_adapter = SlackEventAdapter("SIGNING_SECRET")
 
     data = pytest.reaction_event_fixture
-    timestamp = int(time.time()+1000)
+    timestamp = int(time.time() + 1000)
     signature = "bad timestamp"
 
     with pytest.raises(SlackEventAdapterException) as excinfo:
@@ -100,7 +109,7 @@ def test_compare_digest_fallback(client, monkeypatch):
 
     data = pytest.reaction_event_fixture
     timestamp = int(time.time())
-    signature =pytest.create_signature(slack_adapter.signing_secret, timestamp, data)
+    signature = pytest.create_signature(slack_adapter.signing_secret, timestamp, data)
 
     res = client.post(
         '/slack/events',