Merge pull request #71 from seratch/issue-66

Fix #66 by supporting current_app (LocalProxy)

Author: seratch

example/current_app/main.py

@@ -0,0 +1,49 @@
+# ------------------
+# Only for running this script here
+import sys
+from os.path import dirname
+sys.path.insert(1, f"{dirname(__file__)}/../..")
+# ------------------
+
+import os
+from slack import WebClient
+import logging
+logging.basicConfig(level=logging.DEBUG)
+
+from flask import Flask
+
+app = Flask(__name__)
+
+with app.app_context():
+    from test_module.slack_app import slack_events_adapter
+
+    slack_bot_token = os.environ["SLACK_BOT_TOKEN"]
+    slack_client = WebClient(slack_bot_token)
+
+
+    @slack_events_adapter.on("message")
+    def handle_message(event_data):
+        message = event_data["event"]
+        if message.get("subtype") is None and "hi" in message.get('text'):
+            channel = message["channel"]
+            message = "Hi <@%s>! :tada:" % message["user"]
+            slack_client.chat_postMessage(channel=channel, text=message)
+
+
+    @slack_events_adapter.on("error")
+    def error_handler(err):
+        print("ERROR: " + str(err))
+
+# (Terminal A)
+# source env/bin/activate
+# (env) $ export SLACK_BOT_TOKEN=xoxb-***
+# (env) $ export SLACK_SIGNING_SECRET=**
+# (env) $ cd example/current_app
+# (env) $ FLASK_APP=main.py FLASK_ENV=development flask run --port 3000
+
+# (Terminal B)
+# ngrok http 3000
+
+# in Slack
+# /invite @{your app's bot user}
+# post a message "hi" in the channel

example/current_app/test_module/__init__.py

@@ -0,0 +1,16 @@
+# ------------------
+# 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 flask import current_app as app
+from slackeventsapi import SlackEventAdapter
+import os
+
+slack_signing_secret = os.environ["SLACK_SIGNING_SECRET"]
+slack_events_adapter = SlackEventAdapter(slack_signing_secret, "/slack/events", app)

example/current_app/test_module/slack_app.py

@@ -1,10 +1,13 @@
-from flask import Flask, request, make_response, Blueprint
+import hashlib
+import hmac
 import json
 import platform
 import sys
-import hmac
-import hashlib
 from time import time
+
+from flask import Flask, request, make_response, Blueprint
+from werkzeug.local import LocalProxy
+
 from .version import __version__
 
 
@@ -18,10 +21,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) or isinstance(server, Blueprint):
+            if isinstance(server, (Flask, Blueprint, LocalProxy)):
                 self.bind_route(server)
             else:
-                raise TypeError("Server must be an instance of Flask or Blueprint")
+                raise TypeError("Server must be an instance of Flask, Blueprint, or LocalProxy")
         else:
             Flask.__init__(self, __name__)
             self.bind_route(self)

slackeventsapi/server.py

@@ -18,7 +18,7 @@ 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 or Blueprint'
+    assert e.value.args[0] == 'Server must be an instance of Flask, Blueprint, or LocalProxy'
 
 
 def test_blueprint_server():