Add GitHub Pydantic Schemas (#321)

Add Pydantic schemas for Github objects (PRs, Users, Branches, etc.)

app/__init__.py

@@ -1,4 +1,5 @@
 """Initialize API."""
+
 from fastapi import FastAPI
 from fastapi.middleware.cors import CORSMiddleware
 

app/accounts/__init__.py

@@ -1,4 +1,5 @@
 """User account management & functionality."""
+
 from fastapi import APIRouter, HTTPException
 
 from config import settings

app/analytics/__init__.py

@@ -1,4 +1,5 @@
 """Fetch site traffic & search query analytics."""
+
 from fastapi import APIRouter
 
 from app.analytics.plausible import top_visited_pages_by_timeframe

app/analytics/algolia.py

@@ -1,4 +1,5 @@
 """Helper functions to fetch search query activity from Algolia."""
+
 from typing import Any, Dict, List, Optional
 
 import requests
@@ -32,7 +33,7 @@ def persist_algolia_searches(time_period: str) -> List[Optional[dict]]:
             "direction": "desc",
             "startDate": get_start_date_range(time_period),
         }
-        resp = requests.get(settings.ALGOLIA_SEARCHES_ENDPOINT, headers=headers, params=params)
+        resp = requests.get(settings.ALGOLIA_SEARCHES_ENDPOINT, headers=headers, params=params, timeout=30)
         if resp.status_code == 200 and resp.json().get("searches") is not None:
             search_queries = resp.json().get("searches")
             search_queries = filter_search_queries(search_queries)

app/analytics/migrate.py

@@ -1,4 +1,5 @@
 """Import site analytics from data warehouse to application."""
+
 from typing import Any, Dict, List
 
 from clients import gbq
@@ -14,7 +15,7 @@ def import_site_analytics(timeframe: str) -> Dict[str, List[Any]]:
 
     :returns: Dict[str, List[Any]]
     """
-    sql_query = open(f"{settings.BASE_DIR}/database/queries/analytics/{timeframe}.sql").read()
+    sql_query = open(f"{settings.BASE_DIR}/database/queries/analytics/{timeframe}.sql", encoding="utf-8").read()
     sql_table = f"{timeframe}_stats"
     query_job = gbq.query(sql_query)
     result = query_job.result()

app/analytics/plausible.py

@@ -1,4 +1,5 @@
 """Fetch site analytics via Plausible API."""
+
 from typing import List, Optional
 
 import requests

app/analytics/tests/test_plausible_urls.py

@@ -1,4 +1,5 @@
 """Test Plausible API's integration to associate views per page"""
+
 from app.analytics.plausible import enrich_url_with_post_data, fetch_top_visited_pages
 
 

app/authors/__init__.py

@@ -1,4 +1,5 @@
 """Author management."""
+
 from fastapi import APIRouter, HTTPException
 from fastapi.responses import JSONResponse
 
@@ -55,7 +56,7 @@ async def author_post_created(post_update: PostUpdate) -> JSONResponse:
         msg = f"{author_name} just created a post: `{title}`."
         sms.send_message(msg)
         return JSONResponse(content=msg, status_code=200)
-    elif primary_author_id == settings.GHOST_ADMIN_USER_ID and len(authors) > 1:
+    if primary_author_id == settings.GHOST_ADMIN_USER_ID and len(authors) > 1:
         msg = f"{author_name} just updated one of your posts: `{title}`."
         sms.send_message(msg)
         return JSONResponse(content=msg, status_code=200)

app/donations/__init__.py

@@ -1,4 +1,5 @@
 """Accept and persist `BuyMeACoffee` donations."""
+
 from fastapi import APIRouter, Depends, HTTPException
 from sqlalchemy.orm import Session
 

app/donations/parse.py

@@ -1,4 +1,5 @@
 """Parse Donation into JSON response."""
+
 from database.models import Donation
 
 

app/github/__init__.py

@@ -1,4 +1,5 @@
 """Notify upon Github activity."""
+
 from fastapi import APIRouter, Request
 from fastapi.responses import JSONResponse
 

app/images/__init__.py

@@ -1,4 +1,5 @@
 """Generate optimized images to be served from Google Cloud CDN."""
+
 from typing import Optional
 
 from fastapi import APIRouter, Query

app/moment.py

@@ -1,4 +1,5 @@
 """Calculate situational time or dates."""
+
 from datetime import datetime, timedelta
 
 import pytz

app/newsletter/mixpanel.py

@@ -1,4 +1,5 @@
 """Mixpanel user analytics."""
+
 from typing import Optional
 
 from mixpanel import Mixpanel, MixpanelException

app/newsletter/newsletter.py

@@ -1,4 +1,5 @@
 """Welcome newsletter subscribers ."""
+
 from typing import Optional
 
 from clients import mailgun

app/posts/__init__.py

@@ -1,4 +1,5 @@
 """Enrich post metadata."""
+
 from datetime import datetime, timedelta
 from time import sleep
 

app/posts/metadata.py

@@ -1,4 +1,5 @@
 """Execute SQL to ensure posts have properly optimized metadata."""
+
 from typing import Tuple
 
 from app.posts.update import bulk_update_post_metadata

app/posts/test_posts/conftest.py

@@ -1,4 +1,5 @@
 """Set up integration tests for Ghost post modifications directly via SQL."""
+
 import pytest
 
 from config import settings

app/posts/test_posts/test_read.py

@@ -1,4 +1,5 @@
 """Test reading data directly form SQL databases."""
+
 from database.read_sql import collect_sql_queries, fetch_sql_files, parse_sql_batch
 from database.sql_db import Database
 from log import LOGGER

app/posts/update.py

@@ -1,4 +1,5 @@
 """Methods for updating Ghost post content or metadata."""
+
 from typing import List, Optional, Tuple
 
 from fastapi import HTTPException

app/tags/__init__.py

@@ -1,4 +1,5 @@
 """Enrich tag metadata."""
+
 from fastapi import APIRouter
 from fastapi.responses import JSONResponse
 

asgi.py

@@ -1,4 +1,5 @@
 """Application entry point."""
+
 from app import create_app
 
 api = create_app()

clients/__init__.py

@@ -1,4 +1,5 @@
 """Initialize clients and third-party SDKs."""
+
 from github import Github
 from google.cloud import bigquery
 

clients/gcs.py

@@ -1,4 +1,5 @@
 """Google Cloud Storage client and image transformer."""
+
 import re
 from typing import Iterator, Tuple
 

clients/ghost.py

@@ -1,4 +1,5 @@
 """Ghost admin client."""
+
 from datetime import datetime as date
 from typing import List, Optional, Tuple
 

clients/img.py

@@ -1,4 +1,5 @@
 """Image transformer for remote images on GCS."""
+
 from io import BytesIO
 from typing import List, Optional
 

clients/mail.py

@@ -1,4 +1,5 @@
 """Create Mailgun client."""
+
 from typing import List
 
 import requests

clients/sms.py

@@ -1,4 +1,5 @@
 """Create Twilio SMS client."""
+
 from twilio.rest import Client
 from twilio.rest.api.v2010.account.message import MessageInstance
 

clients/tests/conftest.py

@@ -1,4 +1,5 @@
 """Pytest fixtures for clients."""
+
 import pytest
 from google.cloud.bigquery import Client as gbqClient
 

clients/tests/test_bigquery.py

@@ -1,4 +1,5 @@
 """Test BigQuery client."""
+
 from google.cloud import bigquery
 from google.cloud.bigquery.table import RowIterator
 

config.py

@@ -1,4 +1,5 @@
 """FastAPI configuration."""
+
 import datetime
 from os import getenv, path
 

database/__init__.py

@@ -1,4 +1,5 @@
 """Initialize custom Database clients for direct read/write access."""
+
 from config import Settings
 
 from .sql_db import Database

database/models.py

@@ -1,4 +1,5 @@
 """Data models."""
+
 from sqlalchemy import Column, DateTime, Integer, String, Text
 from sqlalchemy.ext.declarative import declarative_base
 from sqlalchemy.sql import func

database/orm.py

@@ -1,4 +1,5 @@
 """Initialize database session."""
+
 from sqlalchemy import create_engine
 from sqlalchemy.ext.declarative import declarative_base
 from sqlalchemy.orm import sessionmaker

database/read_sql.py

@@ -1,4 +1,5 @@
 """Read analytics from local SQL files."""
+
 from os import listdir
 from os.path import isfile, join
 from typing import List, Optional