restructuring

Author: jacklowrie

piazza_icon.png renamed to assets/piazza_icon.png

@@ -0,0 +1,50 @@
+from piazzabot.piazzabot import app_handler, logger, dbengine, cache
+from piazzabot.database import Course
+
+from fastapi import FastAPI, Request, status
+from sqlalchemy.orm import Session
+
+api = FastAPI()
+
+
+@api.on_event("startup")
+async def startup_event():
+    with Session(dbengine) as session:
+        courses = session.query(Course)
+        for course in courses:
+            cache[course.workspace] = course.forum
+
+    logger.info("cache built:")
+    logger.info(cache)
+
+
+@api.post("/slack/events")
+async def endpoint(req: Request):
+    return await app_handler.handle(req)
+
+
+@api.get("/slack/install")
+async def install(req: Request):
+    return await app_handler.handle(req)
+
+
+@api.get("/slack/oauth_redirect")
+async def oauth_redirect(req: Request):
+    return await app_handler.handle(req)
+
+
+@api.on_event("shutdown")
+def shutdown_event():
+    logger.info("Shutting down PiazzaBot...")
+    with Session(dbengine) as session:
+        for workspace in cache:
+            course = Course(workspace=workspace, forum=cache[workspace])
+            session.merge(course)
+        session.commit()
+
+    logger.info("goodbye!")
+
+
+@api.get('/healthcheck', status_code=status.HTTP_200_OK)
+def perform_healthcheck():
+    return {'healthcheck': 'Everything OK!'}

main.py

@@ -0,0 +1,23 @@
+import os
+from urllib import parse
+
+CLIENT_ID, CLIENT_SECRET, SIGNING_SECRET = (
+    os.environ["SLACK_CLIENT_ID"],
+    os.environ["SLACK_CLIENT_SECRET"],
+    os.environ["SLACK_SIGNING_SECRET"],
+)
+
+DB_HOST, DB_USER, DB_PASS, DB_NAME = (
+    os.environ.get("DB_HOST"),
+    os.environ.get("DB_USER"),
+    parse.quote_plus(os.environ.get("DB_PASS")),
+    os.environ.get("DB_NAME")
+)
+
+BASE_URL = "https://piazza.com/class/"
+
+ERROR_NO_FORUM_ID = "Sorry, the forum id hasn't been set! "
+ERROR_NO_FORUM_ID += "You can set it via slash command:\n"
+ERROR_NO_FORUM_ID += "`/piazza-update-id [course_id]`\n"
+ERROR_NO_FORUM_ID += "You can find the course id in any url on your piazza forum. "
+ERROR_NO_FORUM_ID += "it'll be the long alphanumeric string."

piazzabot/__init__.py

@@ -0,0 +1,22 @@
+from constants import DB_HOST, DB_USER, DB_PASS, DB_NAME
+
+import sqlalchemy
+from sqlalchemy.engine import Engine
+from sqlalchemy import Column, String
+from sqlalchemy.ext.declarative import declarative_base
+
+
+connection = f"mysql+pymysql://{DB_USER}:{DB_PASS}@{DB_HOST}/{DB_NAME}"
+dbengine: Engine = sqlalchemy.create_engine(connection, pool_pre_ping=True)
+Base = declarative_base()
+
+
+class Course(Base):
+    __tablename__ = 'courses'
+    __table_args__ = {'schema': DB_NAME}
+
+    workspace = Column("workspace", String(32), nullable=False, primary_key=True)
+    forum = Column("forum", String(32), nullable=False)
+
+    def __repr__(self):
+        return "Course({0}, {1})".format(self.workspace, self.forum)

piazzabot/constants.py

@@ -1,89 +1,50 @@
+import logging
 import os
-
-from signal import signal, SIGINT
-from sys import exit
+import re
 
 from slack_bolt import App
 from slack_bolt.adapter.fastapi import SlackRequestHandler
-
 from slack_bolt.oauth.oauth_settings import OAuthSettings
 from slack_sdk.oauth.installation_store.sqlalchemy import SQLAlchemyInstallationStore
 from slack_sdk.oauth.state_store.sqlalchemy import SQLAlchemyOAuthStateStore
 
-import sqlalchemy
-from sqlalchemy.engine import Engine
-from sqlalchemy.ext.declarative import declarative_base
-from sqlalchemy import Column, String
 from sqlalchemy.orm import Session
-from sqlalchemy import select
-from urllib import parse
 
-import re
-
-import logging
+from piazzabot.database import Base, Course, dbengine
+from piazzabot.constants import CLIENT_ID, CLIENT_SECRET, SIGNING_SECRET, ERROR_NO_FORUM_ID, BASE_URL
 
 logging.basicConfig(level=logging.INFO)
-
 logger = logging.getLogger(__name__)
-
-# Set up DB
-db_host, db_user, db_pass, db_name = (
-    os.environ.get("DB_HOST"),
-    os.environ.get("DB_USER"),
-    parse.quote_plus(os.environ.get("DB_PASS")),
-    os.environ.get("DB_NAME")
-)
-client_id, client_secret, signing_secret = (
-    os.environ["SLACK_CLIENT_ID"],
-    os.environ["SLACK_CLIENT_SECRET"],
-    os.environ["SLACK_SIGNING_SECRET"],
-)
-connection = f"mysql+pymysql://{db_user}:{db_pass}@{db_host}/{db_name}"
-engine: Engine = sqlalchemy.create_engine(connection, pool_pre_ping=True)
+cache = {}
 
 # Set up Oauth backend
 installation_store = SQLAlchemyInstallationStore(
-    client_id=client_id,
-    engine=engine,
+    client_id=CLIENT_ID,
+    engine=dbengine,
     logger=logger
 )
 oauth_state_store = SQLAlchemyOAuthStateStore(
     expiration_seconds=120,
-    engine=engine,
+    engine=dbengine,
     logger=logger
 )
 
 try:
-    engine.execute("select count(*) from slack_bots")
+    dbengine.execute("select count(*) from slack_bots")
 except Exception as e:
-    installation_store.metadata.create_all(engine)
-    oauth_state_store.metadata.create_all(engine)
-
-# Set up custom table
-Base = declarative_base()
-
-
-class Course(Base):
-    __tablename__ = 'courses'
-    __table_args__ = {'schema': db_name}
-
-    workspace = Column("workspace", String(32), nullable=False, primary_key=True)
-    forum = Column("forum", String(32), nullable=False)
+    installation_store.metadata.create_all(dbengine)
+    oauth_state_store.metadata.create_all(dbengine)
 
-    def __repr__(self):
-        return "Course({0}, {1})".format(self.workspace, self.forum)
-
-
-Base.metadata.create_all(engine)
+Base.metadata.create_all(dbengine)
 
 # Set up app
 app = App(
     token=os.environ.get("SLACK_BOT_TOKEN"),
-    signing_secret=signing_secret,
+    signing_secret=SIGNING_SECRET,
     installation_store=installation_store,
     oauth_settings=OAuthSettings(
-        client_id=client_id,
-        client_secret=client_secret,
+        client_id=CLIENT_ID,
+        client_secret=CLIENT_SECRET,
         state_store=oauth_state_store,
         scopes=[
             "chat:write.public",
@@ -99,16 +60,6 @@ def __repr__(self):
 app_handler = SlackRequestHandler(app)
 
 
-error = "Sorry, the forum id hasn't been set! "
-error += "You can set it via slash command:\n"
-error += "`/piazza-update-id [course_id]`\n"
-error += "You can find the course id in any url on your piazza forum. "
-error += "it'll be the long alphanumeric string."
-
-cache = {}
-base_url = "https://piazza.com/class/"
-
-
 # Provides a means of setting the forum ID from a running app.
 @app.command("/piazza-update-id")
 def update_forum_id(ack, respond, command, context):
@@ -123,11 +74,10 @@ def update_forum_id(ack, respond, command, context):
     cache[workspace_id] = forum_id
     logging.info(f"after cache insert. cache[{workspace_id}] should be {forum_id}, is {cache[workspace_id]}")
     c = Course(workspace=workspace_id, forum=forum_id)
-    with Session(engine) as session:
-        logging.info(f"in session thing. course is: {c}")
+
+    with Session(dbengine) as session:
         session.merge(c)
         session.commit()
-        logging.info("after commit")
 
     respond(f"Updated forum! new id is {forum_id}", )
 
@@ -148,13 +98,13 @@ def regex_message_match(say, context, event, client, logger, body):
         first_match = context["matches"][0]
         logger.warning(f"Forum not set. First ID is: {first_match}")
         client.chat_postEphemeral(
-            text=error,
+            text=ERROR_NO_FORUM_ID,
             channel=context["channel_id"],
             user=context["user_id"]
         )
         return
 
-    posts_url = base_url + forum_id + "/post/"
+    posts_url = BASE_URL + forum_id + "/post/"
     # build message contents
     text = ""
     for match in context['matches']:
@@ -175,52 +125,3 @@ def regex_message_match(say, context, event, client, logger, body):
             text=text.strip("\n"),
             thread_ts=thread_ts
         )
-
-
-# exit handler
-def cleanup():
-    logging.info("Shutting down PiazzaBot...")
-
-    global cache
-    global engine
-    with Session(engine) as session:
-        for workspace in cache:
-            course = Course(workspace=workspace, forum=cache[workspace])
-            session.merge(course)
-        session.commit()
-
-    logging.info("goodbye!")
-
-
-
-from fastapi import FastAPI, Request
-
-api = FastAPI()
-
-@api.on_event("startup")
-async def startup_event():
-    with Session(engine) as session:
-        courses = session.query(Course)
-        for course in courses:
-            cache[course.workspace] = course.forum
-
-    logger.info("cache built:")
-    logger.info(cache)
-
-@api.post("/slack/events")
-async def endpoint(req: Request):
-    return await app_handler.handle(req)
-
-
-@api.get("/slack/install")
-async def install(req: Request):
-    return await app_handler.handle(req)
-
-
-@api.get("/slack/oauth_redirect")
-async def oauth_redirect(req: Request):
-    return await app_handler.handle(req)
-
-@api.on_event("shutdown")
-def shutdown_event():
-    cleanup()