cleanup configs

Author: AllenAnthes

docker/example.env

@@ -1,24 +1,23 @@
 # --------------------------- #
 ### pybot.env ###
 
-# TOKEN=
-# BOT_OATH_TOKEN=
-# SLACK_BOT_SIGNING_SECRET=
-# VERIFICATION_TOKEN=
-# SLACK_BOT_ID=
-# SLACK_BOT_USER_ID=
+# BOT_OAUTH_TOKEN=<Bot User OAuth Access Token>
+# SLACK_BOT_SIGNING_SECRET=<Client Secret>
+# VERIFICATION_TOKEN=<Verification Token>
+# SLACK_BOT_ID=<Not necessary in many cases, see the below warning>
 
-# PYBACK_PORT=
-# PYBACK_HOST=
+##~~  "`SLACK_BOT_USER_ID` not set. It is required for `on mention` routing and discarding "
+##~~                "message coming from Sir Bot-a-lot to avoid loops."
 
+
+#~~ These are only needed if you want to override the default channel names ~~#
 # COMMUNITY_CHANNEL=
 # MENTOR_CHANNEL=
 # TICKET_CHANNEL=
 
 # AIRTABLE_API_KEY=
 # AIRTABLE_BASE_KEY=
 
-# PYBACK_TOKEN=
 
 # --------------------------- #
 ### ngrok.env ###

pybot/__main__.py

@@ -42,7 +42,9 @@
     bot.load_plugin(slack)
 
     admin_configs = dict(**slack_configs)
-    admin_configs["token"] = os.environ.get("APP_ADMIN_OAUTH_TOKEN")
+    admin_token = os.environ.get("APP_ADMIN_OAUTH_TOKEN")
+    if admin_token:
+        admin_configs["token"] = admin_token
     admin_slack = SlackPlugin(**admin_configs)
     bot.load_plugin(admin_slack, name="admin_slack")
 

pybot/endpoints/slack/utils/__init__.py

@@ -4,11 +4,7 @@
 COMMUNITY_CHANNEL = os.environ.get("COMMUNITY_CHANNEL") or "greetings"
 MODERATOR_CHANNEL = os.environ.get("MODERATOR_CHANNEL") or "moderators"
 TICKET_CHANNEL = os.environ.get("TICKET_CHANNEL") or "oc-project-leads"
-APP_TOKEN = os.environ.get("APP_TOKEN") or "123"
 YELP_TOKEN = os.environ.get("YELP_TOKEN") or "token"
-PYBACK_HOST = os.environ.get("PYBACK_HOST") or "pyback"
-PYBACK_PORT = os.environ.get("PYBACK_PORT") or 8000
-PYBACK_TOKEN = os.environ.get("PYBACK_TOKEN") or "token"
 PORT = os.environ.get("SIRBOT_PORT", 5000)
 HOST = os.environ.get("SIRBOT_ADDR", "0.0.0.0")
 PYBOT_ENV = os.environ.get("PYBOT_ENV", "dev")
@@ -19,7 +15,10 @@
 BOT_URL = "https://github.com/OperationCode/operationcode-pybot"
 
 slack_configs = {
-    "token": os.environ.get("BOT_OATH_TOKEN"),
+    "token": os.environ.get(
+        "BOT_OAUTH_TOKEN",
+        os.environ.get('BOT_OATH_TOKEN')  # fallback using old typo value
+    ),
     "signing_secret": os.environ.get("SLACK_BOT_SIGNING_SECRET"),
     "verify": os.environ.get("VERIFICATION_TOKEN"),
     "bot_id": os.environ.get("SLACK_BOT_ID"),