Scaffolding of a FLASK app for WhatsApp analytics

.env.example

@@ -0,0 +1,5 @@
+DB_USER=
+DB_PASSWORD=
+DB_NAME=
+DB_HOST=
+DB_PORT=

.github/workflows/pre-commit.yml

@@ -0,0 +1,16 @@
+name: pre-commit
+
+on:
+  pull_request:
+  push:
+    branches: [main]
+
+jobs:
+  pre-commit:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - uses: actions/setup-python@v2
+      with:
+        python-version: '3.9'
+    - uses: pre-commit/[email protected]

.gitignore

@@ -0,0 +1,8 @@
+*.pyc
+__pycache__/
+
+# Environments
+.env
+.venv
+env/
+venv/

.pre-commit-config.yaml

@@ -0,0 +1,14 @@
+repos:
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v3.2.0
+    hooks:
+    -   id: trailing-whitespace
+    -   id: end-of-file-fixer
+    -   id: check-json
+    -   id: check-yaml
+    -   id: check-merge-conflict
+    -   id: check-added-large-files
+-   repo: https://github.com/psf/black
+    rev: 22.3.0
+    hooks:
+    -   id: black

README.md

@@ -1,3 +1,41 @@
-### WhatsApp Webhook Analytics 
+### WhatsApp Webhook Analytics
 
-Handling and processing Incoming webhook request configured at Glific.
+Handling and processing Incoming webhook request configured at Glific.
+
+## Installation
+
+### Prerequisite
+1. pyenv
+2. python 3.12
+
+### Steps
+1. Clone the repository
+    ```sh
+    git clone https://github.com/DostEducation/whatsapp-webhook-analytics.git
+    ```
+2. Switch to project folder and setup the vertual environment
+    ```sh
+    cd whatsapp-webhook-analytics
+    python -m venv venv
+    ```
+3. Activate the virtual environment
+    ```sh
+    source ./venv/bin/activate
+    ```
+4. Install the dependencies:
+    ```sh
+    pip install -r requirements-dev.txt
+    ```
+5. Set up your .env file by copying .env.example
+    ```sh
+    cp .env.example .env
+    ```
+6. Add/update variables in your `.env` file for your environment.
+7. Run the following command to get started with pre-commit
+    ```sh
+    pre-commit install
+    ```
+8. Start the server by following command
+    ```sh
+    functions_framework --target=handle_payload --debug
+    ```

app/__init__.py

@@ -0,0 +1 @@
+from app.mixins import *

app/helpers/__init__.py

@@ -0,0 +1 @@
+from app.helpers.db_helper import *

app/helpers/db_helper.py

@@ -0,0 +1,9 @@
+from sqlalchemy import create_engine
+from sqlalchemy.ext.declarative import declarative_base
+from sqlalchemy.orm import sessionmaker
+from config import SQLALCHEMY_DATABASE_URL
+
+engine = create_engine(SQLALCHEMY_DATABASE_URL)
+SessionLocal = sessionmaker(autocommit=False, autoflush=False, bind=engine)
+Base = declarative_base()
+db = SessionLocal()

app/mixins.py

@@ -0,0 +1,10 @@
+from pydantic import BaseModel, Field
+from datetime import datetime
+
+
+class TimestampMixin(BaseModel):
+    created_on: datetime = Field(default_factory=datetime.now)
+    updated_on: datetime = Field(default_factory=datetime.now)
+
+    class Config:
+        orm_mode = True

app/models/__init__.py

@@ -0,0 +1 @@
+from app.models.webhook_transaction_log import *

app/models/webhook_transaction_log.py

@@ -0,0 +1,25 @@
+from app import TimestampMixin
+from pydantic import BaseModel
+from sqlalchemy import Column, Integer, Text, Boolean
+from sqlalchemy.orm import declarative_base
+
+Base = declarative_base()
+
+
+class WebhookTransactionLog(Base):
+    __tablename__ = "webhook_transaction_log"
+
+    id = Column(Integer, primary_key=True)
+    payload = Column(Text)
+    processed = Column(Boolean, nullable=False)
+    attempts = Column(Integer, nullable=False, default=0)
+
+
+class WebhookTransactionLogSchema(BaseModel):
+    payload: str
+    processed: bool
+    attempts: int
+    timestamps: TimestampMixin
+
+    class Config:
+        orm_mode = True

app/services/__init__.py

@@ -0,0 +1 @@
+from app.services.webhook_transaction_log_service import *

app/services/webhook_transaction_log_service.py

@@ -0,0 +1,33 @@
+import json
+from app.helpers import db
+from app import models
+
+
+class WebhookTransactionLogService:
+    def create_new_webhook_log(self, jsonData):
+        try:
+            data = json.dumps(jsonData)
+            new_webhook_log = models.WebhookTransactionLog(
+                payload=data,
+                processed=False,
+                attempts=0,
+            )
+            db.add(new_webhook_log)
+            db.commit()
+            return new_webhook_log
+        except Exception as e:
+            print(
+                f"Error while creating new webhook log. Webhook: {jsonData}. Error message: {e}"
+            )
+        finally:
+            db.close()
+
+    def mark_webhook_log_as_processed(self, webhook_log):
+        try:
+            webhook_log.processed = True
+            db.add(webhook_log)
+            db.commit()
+        except Exception as e:
+            print(f"Error while marking webhook log as processed. Error message: {e}")
+        finally:
+            db.close()

config.py

@@ -0,0 +1,14 @@
+import os
+
+# Database configuration
+POSTGRES = {
+    "user": os.environ.get("DB_USER"),
+    "password": os.environ.get("DB_PASSWORD"),
+    "database": os.environ.get("DB_NAME"),
+    "host": os.environ.get("DB_HOST"),
+    "port": os.environ.get("DB_PORT"),
+}
+
+SQLALCHEMY_DATABASE_URL = (
+    "postgresql://%(user)s:%(password)s@%(host)s:%(port)s/%(database)s" % POSTGRES
+)

main.py

@@ -0,0 +1,27 @@
+from fastapi import FastAPI
+from agraffe import Agraffe
+from app.services import WebhookTransactionLogService
+
+app = FastAPI()
+
+
+def handle_payload(request):
+    if request.method == "POST":
+        try:
+            jsonData = request.get_json()
+            if jsonData:
+                handle_webhook(jsonData)
+        except Exception as e:
+            print(f"Error: {e}")
+        return jsonData
+    else:
+        return "System does not accepts GET request"
+
+
+def handle_webhook(jsonData):
+    transaction_log_service = WebhookTransactionLogService()
+    webhook_log = transaction_log_service.create_new_webhook_log(jsonData)
+    transaction_log_service.mark_webhook_log_as_processed(webhook_log)
+
+
+handler = Agraffe.entry_point(app)

requirements-dev.txt

@@ -0,0 +1,4 @@
+# Includes dev dependencies on top of requirements.txt
+-r requirements.txt
+functions-framework==3.5.0
+pre-commit==3.5.0

requirements.txt

@@ -0,0 +1,7 @@
+agraffe==0.7.0
+fastapi==0.70.0
+psycopg2-binary==2.9.1
+pydantic==1.9.0
+sqlalchemy==1.4.26
+uvicorn==0.15.0
+setuptools==69.2.0