WIP 2024-08-10
This commit is contained in:
@ -2,5 +2,5 @@ from django.apps import AppConfig
|
||||
|
||||
|
||||
class CoreConfig(AppConfig):
|
||||
default_auto_field = "django.db.models.BigAutoField"
|
||||
default_auto_field: str = "django.db.models.BigAutoField"
|
||||
name = "core"
|
||||
|
||||
0
core/management/__init__.py
Normal file
0
core/management/__init__.py
Normal file
0
core/management/commands/__init__.py
Normal file
0
core/management/commands/__init__.py
Normal file
621
core/management/commands/scrape_twitch.py
Normal file
621
core/management/commands/scrape_twitch.py
Normal file
@ -0,0 +1,621 @@
|
||||
import asyncio
|
||||
import json
|
||||
import logging
|
||||
import typing
|
||||
from datetime import datetime
|
||||
from pathlib import Path
|
||||
from typing import TYPE_CHECKING
|
||||
|
||||
from asgiref.sync import sync_to_async
|
||||
from django.core.management.base import BaseCommand
|
||||
from platformdirs import user_data_dir
|
||||
from playwright.async_api import Playwright, async_playwright
|
||||
from playwright.async_api._generated import Response
|
||||
|
||||
from core.models import (
|
||||
Allow,
|
||||
Benefit,
|
||||
BenefitEdge,
|
||||
Channel,
|
||||
DropCampaign,
|
||||
Game,
|
||||
Image,
|
||||
Owner,
|
||||
Reward,
|
||||
RewardCampaign,
|
||||
TimeBasedDrop,
|
||||
UnlockRequirements,
|
||||
)
|
||||
|
||||
if TYPE_CHECKING:
|
||||
from playwright.async_api._generated import BrowserContext, Page
|
||||
|
||||
|
||||
logger: logging.Logger = logging.getLogger(__name__)
|
||||
|
||||
|
||||
def get_data_dir() -> Path:
|
||||
"""Get the data directory.
|
||||
|
||||
Returns:
|
||||
Path: The data directory.
|
||||
"""
|
||||
return Path(
|
||||
user_data_dir(
|
||||
appname="TTVDrops",
|
||||
appauthor="TheLovinator",
|
||||
roaming=True,
|
||||
ensure_exists=True,
|
||||
),
|
||||
)
|
||||
|
||||
|
||||
async def add_or_get_game(json_data: dict | None) -> tuple[Game | None, bool]:
|
||||
"""Add or get Game from JSON data.
|
||||
|
||||
Args:
|
||||
json_data (dict): JSON data to add to the database.
|
||||
|
||||
Returns:
|
||||
tuple[Game | None, bool]: Game instance and whether it was created.
|
||||
"""
|
||||
if not json_data:
|
||||
logger.warning("Couldn't find game data, probably a reward campaign?")
|
||||
return None, False
|
||||
|
||||
game, created = await Game.objects.aupdate_or_create(
|
||||
id=json_data["id"],
|
||||
defaults={
|
||||
"slug": json_data.get("slug"),
|
||||
"display_name": json_data.get("displayName"),
|
||||
"typename": json_data.get("__typename"),
|
||||
"box_art_url": json_data.get("boxArtURL"), # Only for RewardCampaigns
|
||||
},
|
||||
)
|
||||
|
||||
if created:
|
||||
logger.info("Found new game: %s", game.display_name or "Unknown Game")
|
||||
|
||||
return game, created
|
||||
|
||||
|
||||
async def add_or_get_owner(json_data: dict | None) -> tuple[Owner | None, bool]:
|
||||
"""Add or get Owner from JSON data.
|
||||
|
||||
Args:
|
||||
json_data (dict): JSON data to add to the database.
|
||||
|
||||
Returns:
|
||||
Owner: Owner instance.
|
||||
"""
|
||||
if not json_data:
|
||||
logger.warning("No owner data provided")
|
||||
return None, False
|
||||
|
||||
owner, created = await Owner.objects.aupdate_or_create(
|
||||
id=json_data["id"],
|
||||
defaults={
|
||||
"display_name": json_data.get("name"),
|
||||
"typename": json_data.get("__typename"),
|
||||
},
|
||||
)
|
||||
|
||||
return owner, created
|
||||
|
||||
|
||||
async def add_or_get_allow(json_data: dict | None) -> tuple[Allow | None, bool]:
|
||||
"""Add or get Allow from JSON data.
|
||||
|
||||
Args:
|
||||
json_data (dict): JSON data to add to the database.
|
||||
|
||||
Returns:
|
||||
Allow: Allow instance.
|
||||
"""
|
||||
if not json_data:
|
||||
logger.warning("No allow data provided")
|
||||
return None, False
|
||||
|
||||
allow, created = await Allow.objects.aupdate_or_create(
|
||||
is_enabled=json_data.get("isEnabled"),
|
||||
typename=json_data.get("__typename"),
|
||||
)
|
||||
|
||||
return allow, created
|
||||
|
||||
|
||||
async def add_or_get_time_based_drops(
|
||||
time_based_drops_data: list[dict] | None,
|
||||
owner: Owner | None,
|
||||
game: Game | None,
|
||||
) -> list[TimeBasedDrop]:
|
||||
"""Handle TimeBasedDrops from JSON data.
|
||||
|
||||
Args:
|
||||
time_based_drops_data (list[dict]): Time based drops data from JSON.
|
||||
owner (Owner): Owner instance.
|
||||
game (Game): Game instance.
|
||||
|
||||
|
||||
Returns:
|
||||
list[TimeBasedDrop]: TimeBasedDrop instances.
|
||||
"""
|
||||
time_based_drops: list[TimeBasedDrop] = []
|
||||
|
||||
if not time_based_drops_data:
|
||||
logger.warning("No time based drops data provided")
|
||||
return time_based_drops
|
||||
|
||||
for time_based_drop_data in time_based_drops_data:
|
||||
time_based_drop, _ = await TimeBasedDrop.objects.aupdate_or_create(
|
||||
id=time_based_drop_data["id"],
|
||||
defaults={
|
||||
"created_at": time_based_drop_data.get("createdAt"),
|
||||
"entitlement_limit": time_based_drop_data.get("entitlementLimit"),
|
||||
"image_asset_url": time_based_drop_data.get("imageAssetURL"),
|
||||
"is_ios_available": time_based_drop_data.get("isIosAvailable"),
|
||||
"name": time_based_drop_data.get("name"),
|
||||
"owner_organization": owner,
|
||||
"game": game,
|
||||
"typename": time_based_drop_data.get("__typename"),
|
||||
},
|
||||
)
|
||||
|
||||
benefit_edges_data: list[dict] = time_based_drop_data.get("benefitEdges", [])
|
||||
for benefit_edge_data in benefit_edges_data:
|
||||
benefit_data: dict = benefit_edge_data.get("benefit", {})
|
||||
benefit, _ = await Benefit.objects.aupdate_or_create(
|
||||
id=benefit_data["id"],
|
||||
defaults={
|
||||
"created_at": benefit_data.get("createdAt"),
|
||||
"entitlement_limit": benefit_data.get("entitlementLimit"),
|
||||
"image_asset_url": benefit_data.get("imageAssetURL"),
|
||||
"is_ios_available": benefit_data.get("isIosAvailable"),
|
||||
"name": benefit_data.get("name"),
|
||||
"owner_organization": owner,
|
||||
"game": game,
|
||||
"typename": benefit_data.get("__typename"),
|
||||
},
|
||||
)
|
||||
|
||||
await BenefitEdge.objects.aupdate_or_create(
|
||||
benefit=benefit,
|
||||
defaults={
|
||||
"entitlement_limit": benefit_edge_data.get("entitlementLimit"),
|
||||
"typename": benefit_edge_data.get("__typename"),
|
||||
},
|
||||
)
|
||||
|
||||
time_based_drops.append(time_based_drop)
|
||||
|
||||
return time_based_drops
|
||||
|
||||
|
||||
async def add_or_get_drop_campaign(
|
||||
drop_campaign_data: dict | None,
|
||||
game: Game | None,
|
||||
owner: Owner | None,
|
||||
) -> tuple[DropCampaign | None, bool]:
|
||||
"""Handle DropCampaign from JSON data.
|
||||
|
||||
Args:
|
||||
drop_campaign_data (dict): Drop campaign data from JSON.
|
||||
game (Game): Game instance.
|
||||
owner (Owner): Owner instance.
|
||||
|
||||
|
||||
Returns:
|
||||
tuple[DropCampaign, bool]: DropCampaign instance and whether it was created.
|
||||
"""
|
||||
if not drop_campaign_data:
|
||||
logger.warning("No drop campaign data provided")
|
||||
return None, False
|
||||
|
||||
if drop_campaign_data.get("__typename") != "Game":
|
||||
logger.error("__typename is not 'Game' for %s", drop_campaign_data.get("name", "Unknown Drop Campaign"))
|
||||
|
||||
drop_campaign, _ = await DropCampaign.objects.aupdate_or_create(
|
||||
id=drop_campaign_data["id"],
|
||||
defaults={
|
||||
# "allow": allow, # We add this later
|
||||
"account_link_url": drop_campaign_data.get("accountLinkURL"),
|
||||
"description": drop_campaign_data.get("description"),
|
||||
"details_url": drop_campaign_data.get("detailsURL"),
|
||||
"ends_at": drop_campaign_data.get("endAt"),
|
||||
# event_based_drops = ???? # TODO(TheLovinator): Find out what this is # noqa: TD003
|
||||
"game": game,
|
||||
"image_url": drop_campaign_data.get("imageURL"),
|
||||
"name": drop_campaign_data.get("name"),
|
||||
"owner": owner,
|
||||
"starts_at": drop_campaign_data.get("startAt"),
|
||||
"status": drop_campaign_data.get("status"),
|
||||
# "time_based_drops": time_based_drops, # We add this later
|
||||
"typename": drop_campaign_data.get("__typename"),
|
||||
},
|
||||
)
|
||||
|
||||
return drop_campaign, True
|
||||
|
||||
|
||||
async def add_or_get_channel(json_data: dict | None) -> tuple[Channel | None, bool]:
|
||||
"""Add or get Channel from JSON data.
|
||||
|
||||
Args:
|
||||
json_data (dict): JSON data to add to the database.
|
||||
|
||||
|
||||
Returns:
|
||||
tuple[Channel | None, bool]: Channel instance and whether it was created.
|
||||
"""
|
||||
if not json_data:
|
||||
logger.warning("No channel data provided")
|
||||
return None, False
|
||||
|
||||
channel, created = await Channel.objects.aupdate_or_create(
|
||||
id=json_data["id"],
|
||||
defaults={
|
||||
"display_name": json_data.get("displayName"),
|
||||
"name": json_data.get("name"),
|
||||
"typename": json_data.get("__typename"),
|
||||
},
|
||||
)
|
||||
|
||||
return channel, created
|
||||
|
||||
|
||||
async def add_drop_campaign(json_data: dict | None) -> None:
|
||||
"""Add data from JSON to the database.
|
||||
|
||||
Args:
|
||||
json_data (dict): JSON data to add to the database.
|
||||
"""
|
||||
if not json_data:
|
||||
logger.warning("No JSON data provided")
|
||||
return
|
||||
|
||||
# Get the data from the JSON
|
||||
user_data: dict = json_data.get("data", {}).get("user", {})
|
||||
drop_campaign_data: dict = user_data.get("dropCampaign", {})
|
||||
|
||||
# Add or get Game
|
||||
game_data: dict = drop_campaign_data.get("game", {})
|
||||
game, _ = await add_or_get_game(json_data=game_data)
|
||||
|
||||
# Add or get Owner
|
||||
owner_data: dict = drop_campaign_data.get("owner", {})
|
||||
owner, _ = await add_or_get_owner(json_data=owner_data)
|
||||
|
||||
# Add or get Allow
|
||||
allow_data: dict = drop_campaign_data.get("allow", {})
|
||||
allow, _ = await add_or_get_allow(json_data=allow_data)
|
||||
|
||||
# Add channels to Allow
|
||||
if allow:
|
||||
channel_data: list[dict] = allow_data.get("channels", [])
|
||||
|
||||
if channel_data:
|
||||
for json_channel in channel_data:
|
||||
channel, _ = await add_or_get_channel(json_channel)
|
||||
if channel:
|
||||
await allow.channels.aadd(channel)
|
||||
|
||||
# Add or get TimeBasedDrops
|
||||
time_based_drops_data = drop_campaign_data.get("timeBasedDrops", [])
|
||||
time_based_drops: list[TimeBasedDrop] = await add_or_get_time_based_drops(time_based_drops_data, owner, game)
|
||||
|
||||
# Add or get DropCampaign
|
||||
drop_campaign, _ = await add_or_get_drop_campaign(
|
||||
drop_campaign_data=drop_campaign_data,
|
||||
game=game,
|
||||
owner=owner,
|
||||
)
|
||||
if drop_campaign:
|
||||
drop_campaign.allow = allow
|
||||
await drop_campaign.time_based_drops.aset(time_based_drops)
|
||||
await drop_campaign.asave()
|
||||
|
||||
logger.info("Added Drop Campaign: %s", drop_campaign.name or "Unknown Drop Campaign")
|
||||
|
||||
|
||||
async def add_or_get_image(json_data: dict | None) -> tuple[Image | None, bool]:
|
||||
"""Add or get Image from JSON data.
|
||||
|
||||
Args:
|
||||
json_data (dict): JSON data to add to the database.
|
||||
|
||||
Returns:
|
||||
tuple[Image | None, bool]: Image instance and whether it was created.
|
||||
"""
|
||||
# TODO(TheLovinator): We should download the image and store it locally # noqa: TD003
|
||||
if not json_data:
|
||||
logger.warning("Image data is missing")
|
||||
return None, False
|
||||
|
||||
if not json_data.get("image1xURL"):
|
||||
logger.warning("Image URL is missing")
|
||||
return None, False
|
||||
|
||||
image, created = await Image.objects.aupdate_or_create(
|
||||
image1_x_url=json_data.get("image1xURL"),
|
||||
defaults={
|
||||
"typename": json_data.get("__typename"),
|
||||
},
|
||||
)
|
||||
|
||||
return image, created
|
||||
|
||||
|
||||
async def add_or_get_rewards(json_data: dict | None) -> list[Reward]:
|
||||
"""Add or get Rewards from JSON data.
|
||||
|
||||
Args:
|
||||
json_data (dict): JSON data to add to the database.
|
||||
|
||||
Returns:
|
||||
list[Reward]: Reward instances
|
||||
"""
|
||||
rewards: list[Reward] = []
|
||||
|
||||
if not json_data:
|
||||
logger.warning("No rewards found")
|
||||
return []
|
||||
|
||||
if "rewards" not in json_data:
|
||||
logger.warning("No rewards found")
|
||||
return []
|
||||
|
||||
rewards_json: list[dict] = json_data.get("rewards", [])
|
||||
for reward_data in rewards_json:
|
||||
# Add or get bannerImage
|
||||
banner_image_data: dict = reward_data.get("bannerImage", {})
|
||||
if banner_image_data:
|
||||
banner_image, _ = await sync_to_async(Image.objects.get_or_create)(
|
||||
image1_x_url=banner_image_data["image1xURL"],
|
||||
defaults={"typename": banner_image_data["__typename"]},
|
||||
)
|
||||
|
||||
# Add or get thumbnailImage
|
||||
thumbnail_image_data = reward_data.get("thumbnailImage", {})
|
||||
if thumbnail_image_data:
|
||||
thumbnail_image, _ = await sync_to_async(Image.objects.get_or_create)(
|
||||
image1_x_url=thumbnail_image_data["image1xURL"],
|
||||
defaults={"typename": thumbnail_image_data["__typename"]},
|
||||
)
|
||||
|
||||
# Convert earnableUntil to a datetime object
|
||||
earnable_until: str | None = reward_data.get("earnableUntil")
|
||||
earnable_until_date: datetime | None = None
|
||||
if earnable_until:
|
||||
earnable_until_date = datetime.fromisoformat(earnable_until.replace("Z", "+00:00"))
|
||||
|
||||
reward, _ = await sync_to_async(Reward.objects.get_or_create)(
|
||||
id=reward_data["id"],
|
||||
defaults={
|
||||
"name": reward_data.get("name"),
|
||||
"banner_image": banner_image,
|
||||
"thumbnail_image": thumbnail_image,
|
||||
"earnable_until": earnable_until_date,
|
||||
"redemption_instructions": reward_data.get("redemptionInstructions"),
|
||||
"redemption_url": reward_data.get("redemptionURL"),
|
||||
"typename": reward_data.get("__typename"),
|
||||
},
|
||||
)
|
||||
rewards.append(reward)
|
||||
|
||||
return rewards
|
||||
|
||||
|
||||
async def add_or_get_unlock_requirements(json_data: dict | None) -> tuple[UnlockRequirements | None, bool]:
|
||||
"""Add or get UnlockRequirements from JSON data.
|
||||
|
||||
Args:
|
||||
json_data (dict): JSON data to add to the database.
|
||||
|
||||
|
||||
|
||||
Returns:
|
||||
tuple[UnlockRequirements | None, bool]: UnlockRequirements instance and whether it was created.
|
||||
"""
|
||||
if not json_data:
|
||||
logger.warning("No unlock requirements data provided")
|
||||
return None, False
|
||||
|
||||
unlock_requirements, created = await UnlockRequirements.objects.aget_or_create(
|
||||
subs_goal=json_data["subsGoal"],
|
||||
defaults={
|
||||
"minute_watched_goal": json_data["minuteWatchedGoal"],
|
||||
"typename": json_data["__typename"],
|
||||
},
|
||||
)
|
||||
|
||||
return unlock_requirements, created
|
||||
|
||||
|
||||
async def add_reward_campaign(json_data: dict | None) -> None:
|
||||
"""Add data from JSON to the database.
|
||||
|
||||
Args:
|
||||
json_data (dict): JSON data to add to the database.
|
||||
"""
|
||||
if not json_data:
|
||||
logger.warning("No JSON data provided")
|
||||
return
|
||||
|
||||
campaign_data: list[dict] = json_data["data"]["rewardCampaignsAvailableToUser"]
|
||||
for campaign in campaign_data:
|
||||
# Add or get Game
|
||||
game_data: dict = campaign.get("game", {})
|
||||
game, _ = await add_or_get_game(json_data=game_data)
|
||||
|
||||
# Add or get Image
|
||||
image_data: dict = campaign.get("image", {})
|
||||
image, _ = await add_or_get_image(json_data=image_data)
|
||||
|
||||
# Add or get Rewards
|
||||
rewards: list[Reward] = await add_or_get_rewards(campaign)
|
||||
|
||||
# Add or get Unlock Requirements
|
||||
unlock_requirements_data: dict = campaign["unlockRequirements"]
|
||||
unlock_requirements, _ = await add_or_get_unlock_requirements(unlock_requirements_data)
|
||||
|
||||
# Create Reward Campaign
|
||||
reward_campaign, _ = await RewardCampaign.objects.aget_or_create(
|
||||
id=campaign["id"],
|
||||
defaults={
|
||||
"name": campaign.get("name"),
|
||||
"brand": campaign.get("brand"),
|
||||
"starts_at": campaign.get("startsAt"),
|
||||
"ends_at": campaign.get("endsAt"),
|
||||
"status": campaign.get("status"),
|
||||
"summary": campaign.get("summary"),
|
||||
"instructions": campaign.get("instructions"),
|
||||
"external_url": campaign.get("externalURL"),
|
||||
"reward_value_url_param": campaign.get("rewardValueURLParam"),
|
||||
"about_url": campaign.get("aboutURL"),
|
||||
"is_sitewide": campaign.get("isSitewide"),
|
||||
"game": game,
|
||||
"unlock_requirements": unlock_requirements,
|
||||
"image": image,
|
||||
# "rewards": rewards, # We add this later
|
||||
"typename": campaign.get("__typename"),
|
||||
},
|
||||
)
|
||||
|
||||
# Add Rewards to the Campaign
|
||||
for reward in rewards:
|
||||
await reward_campaign.rewards.aadd(reward)
|
||||
|
||||
await reward_campaign.asave()
|
||||
|
||||
|
||||
def get_profile_dir() -> Path:
|
||||
"""Get the profile directory for the browser.
|
||||
|
||||
Returns:
|
||||
Path: The profile directory.
|
||||
"""
|
||||
profile_dir: Path = Path(get_data_dir() / "chrome-profile")
|
||||
profile_dir.mkdir(parents=True, exist_ok=True)
|
||||
logger.debug("Launching Chrome browser with user data directory: %s", profile_dir)
|
||||
return profile_dir
|
||||
|
||||
|
||||
def save_json(campaign: dict, dir_name: str) -> None:
|
||||
"""Save JSON data to a file.
|
||||
|
||||
Args:
|
||||
campaign (dict): The JSON data to save.
|
||||
dir_name (Path): The directory to save the JSON data to.
|
||||
"""
|
||||
save_dir: Path = Path(dir_name)
|
||||
save_dir.mkdir(parents=True, exist_ok=True)
|
||||
|
||||
# File name is the hash of the JSON data
|
||||
file_name: str = f"{hash(json.dumps(campaign))}.json"
|
||||
|
||||
with Path(save_dir / file_name).open(mode="w", encoding="utf-8") as f:
|
||||
json.dump(campaign, f, indent=4)
|
||||
|
||||
|
||||
async def process_json_data(num: int, campaign: dict | None, json_data: list[dict] | None) -> None:
|
||||
"""Process JSON data.
|
||||
|
||||
Args:
|
||||
num (int): The number of the JSON data.
|
||||
campaign (dict): The JSON data to process.
|
||||
json_data (list[dict]): The list of JSON
|
||||
"""
|
||||
if not json_data:
|
||||
logger.warning("No JSON data provided")
|
||||
return
|
||||
|
||||
logger.info("Processing JSON %d of %d", num, len(json_data))
|
||||
if not isinstance(campaign, dict):
|
||||
logger.warning("Campaign is not a dictionary")
|
||||
return
|
||||
|
||||
if "rewardCampaignsAvailableToUser" in campaign["data"]:
|
||||
save_json(campaign, "reward_campaigns")
|
||||
await add_reward_campaign(campaign)
|
||||
|
||||
if "dropCampaign" in campaign.get("data", {}).get("user", {}):
|
||||
if not campaign["data"]["user"]["dropCampaign"]:
|
||||
logger.warning("No drop campaign found")
|
||||
return
|
||||
|
||||
save_json(campaign, "drop_campaign")
|
||||
await add_drop_campaign(campaign)
|
||||
|
||||
if "dropCampaigns" in campaign.get("data", {}).get("user", {}):
|
||||
for drop_campaign in campaign["data"]["user"]["dropCampaigns"]:
|
||||
save_json(campaign, "drop_campaigns")
|
||||
await add_drop_campaign(drop_campaign)
|
||||
|
||||
|
||||
class Command(BaseCommand):
|
||||
help = "Scrape Twitch Drops Campaigns with login using Firefox"
|
||||
|
||||
@staticmethod
|
||||
async def run(playwright: Playwright) -> list[dict[str, typing.Any]]:
|
||||
profile_dir: Path = get_profile_dir()
|
||||
browser: BrowserContext = await playwright.chromium.launch_persistent_context(
|
||||
channel="chrome",
|
||||
user_data_dir=profile_dir,
|
||||
headless=False,
|
||||
args=["--disable-blink-features=AutomationControlled"],
|
||||
)
|
||||
logger.debug("Launched Chrome browser")
|
||||
|
||||
page: Page = await browser.new_page()
|
||||
json_data: list[dict] = []
|
||||
|
||||
async def handle_response(response: Response) -> None:
|
||||
if "https://gql.twitch.tv/gql" in response.url:
|
||||
try:
|
||||
body: typing.Any = await response.json()
|
||||
json_data.extend(body)
|
||||
except Exception:
|
||||
logger.exception(
|
||||
"Failed to parse JSON from %s",
|
||||
response.url,
|
||||
)
|
||||
|
||||
page.on("response", handle_response)
|
||||
await page.goto("https://www.twitch.tv/drops/campaigns")
|
||||
logger.debug("Navigated to Twitch drops campaigns page")
|
||||
|
||||
logged_in = False
|
||||
while not logged_in:
|
||||
try:
|
||||
await page.wait_for_selector(
|
||||
'div[data-a-target="top-nav-avatar"]',
|
||||
timeout=300000,
|
||||
)
|
||||
logged_in = True
|
||||
logger.info("Logged in to Twitch")
|
||||
except KeyboardInterrupt as e:
|
||||
raise KeyboardInterrupt from e
|
||||
except Exception: # noqa: BLE001
|
||||
await asyncio.sleep(5)
|
||||
logger.info("Waiting for login")
|
||||
|
||||
await page.wait_for_load_state("networkidle")
|
||||
logger.debug("Page loaded. Scraping data...")
|
||||
|
||||
await browser.close()
|
||||
|
||||
for num, campaign in enumerate(json_data, start=1):
|
||||
await process_json_data(num, campaign, json_data)
|
||||
|
||||
return json_data
|
||||
|
||||
def handle(self, *args, **kwargs) -> None: # noqa: ANN002, ARG002, ANN003
|
||||
asyncio.run(self.run_with_playwright())
|
||||
|
||||
async def run_with_playwright(self) -> None:
|
||||
async with async_playwright() as playwright:
|
||||
await self.run(playwright)
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
Command().handle()
|
||||
482
core/migrations/0001_initial.py
Normal file
482
core/migrations/0001_initial.py
Normal file
@ -0,0 +1,482 @@
|
||||
# Generated by Django 5.1 on 2024-08-09 02:49
|
||||
|
||||
import auto_prefetch
|
||||
import django.db.models.deletion
|
||||
import django.db.models.manager
|
||||
from django.db import migrations, models
|
||||
from django.db.migrations.operations.base import Operation
|
||||
|
||||
|
||||
class Migration(migrations.Migration):
|
||||
initial = True
|
||||
|
||||
dependencies: list[tuple[str, str]] = []
|
||||
|
||||
operations: list[Operation] = [
|
||||
migrations.CreateModel(
|
||||
name="Benefit",
|
||||
fields=[
|
||||
("id", models.TextField(primary_key=True, serialize=False)),
|
||||
("created_at", models.DateTimeField(null=True)),
|
||||
("entitlement_limit", models.TextField(null=True)),
|
||||
("image_asset_url", models.URLField(blank=True, null=True)),
|
||||
("is_ios_available", models.BooleanField(null=True)),
|
||||
("name", models.TextField(blank=True, null=True)),
|
||||
("typename", models.TextField(blank=True, null=True)),
|
||||
],
|
||||
options={
|
||||
"abstract": False,
|
||||
"base_manager_name": "prefetch_manager",
|
||||
},
|
||||
managers=[
|
||||
("objects", django.db.models.manager.Manager()),
|
||||
("prefetch_manager", django.db.models.manager.Manager()),
|
||||
],
|
||||
),
|
||||
migrations.CreateModel(
|
||||
name="Channel",
|
||||
fields=[
|
||||
("id", models.TextField(primary_key=True, serialize=False)),
|
||||
("display_name", models.TextField(blank=True, null=True)),
|
||||
("name", models.TextField(blank=True, null=True)),
|
||||
("typename", models.TextField(blank=True, null=True)),
|
||||
],
|
||||
options={
|
||||
"abstract": False,
|
||||
"base_manager_name": "prefetch_manager",
|
||||
},
|
||||
managers=[
|
||||
("objects", django.db.models.manager.Manager()),
|
||||
("prefetch_manager", django.db.models.manager.Manager()),
|
||||
],
|
||||
),
|
||||
migrations.CreateModel(
|
||||
name="FrontEndChannel",
|
||||
fields=[
|
||||
("id", models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name="ID")),
|
||||
("name", models.TextField(blank=True, null=True)),
|
||||
("twitch_url", models.URLField(blank=True, null=True)),
|
||||
("live", models.BooleanField(default=False)),
|
||||
],
|
||||
options={
|
||||
"abstract": False,
|
||||
"base_manager_name": "prefetch_manager",
|
||||
},
|
||||
managers=[
|
||||
("objects", django.db.models.manager.Manager()),
|
||||
("prefetch_manager", django.db.models.manager.Manager()),
|
||||
],
|
||||
),
|
||||
migrations.CreateModel(
|
||||
name="FrontEndGame",
|
||||
fields=[
|
||||
("twitch_id", models.TextField(primary_key=True, serialize=False)),
|
||||
("game_url", models.URLField(blank=True, null=True)),
|
||||
("display_name", models.TextField(blank=True, null=True)),
|
||||
],
|
||||
options={
|
||||
"abstract": False,
|
||||
"base_manager_name": "prefetch_manager",
|
||||
},
|
||||
managers=[
|
||||
("objects", django.db.models.manager.Manager()),
|
||||
("prefetch_manager", django.db.models.manager.Manager()),
|
||||
],
|
||||
),
|
||||
migrations.CreateModel(
|
||||
name="FrontEndOrg",
|
||||
fields=[
|
||||
("id", models.TextField(primary_key=True, serialize=False)),
|
||||
("name", models.TextField(blank=True, null=True)),
|
||||
("url", models.TextField(blank=True, null=True)),
|
||||
],
|
||||
options={
|
||||
"abstract": False,
|
||||
"base_manager_name": "prefetch_manager",
|
||||
},
|
||||
managers=[
|
||||
("objects", django.db.models.manager.Manager()),
|
||||
("prefetch_manager", django.db.models.manager.Manager()),
|
||||
],
|
||||
),
|
||||
migrations.CreateModel(
|
||||
name="Game",
|
||||
fields=[
|
||||
("id", models.AutoField(primary_key=True, serialize=False)),
|
||||
("slug", models.TextField(blank=True, null=True)),
|
||||
("display_name", models.TextField(blank=True, null=True)),
|
||||
("box_art_url", models.URLField(blank=True, null=True)),
|
||||
("typename", models.TextField(blank=True, null=True)),
|
||||
],
|
||||
options={
|
||||
"abstract": False,
|
||||
"base_manager_name": "prefetch_manager",
|
||||
},
|
||||
managers=[
|
||||
("objects", django.db.models.manager.Manager()),
|
||||
("prefetch_manager", django.db.models.manager.Manager()),
|
||||
],
|
||||
),
|
||||
migrations.CreateModel(
|
||||
name="Image",
|
||||
fields=[
|
||||
("id", models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name="ID")),
|
||||
("image1_x_url", models.URLField(blank=True, null=True)),
|
||||
("typename", models.TextField(blank=True, null=True)),
|
||||
],
|
||||
options={
|
||||
"abstract": False,
|
||||
"base_manager_name": "prefetch_manager",
|
||||
},
|
||||
managers=[
|
||||
("objects", django.db.models.manager.Manager()),
|
||||
("prefetch_manager", django.db.models.manager.Manager()),
|
||||
],
|
||||
),
|
||||
migrations.CreateModel(
|
||||
name="Owner",
|
||||
fields=[
|
||||
("id", models.TextField(primary_key=True, serialize=False)),
|
||||
("slug", models.TextField(blank=True, null=True)),
|
||||
("display_name", models.TextField(blank=True, null=True)),
|
||||
("typename", models.TextField(blank=True, null=True)),
|
||||
],
|
||||
options={
|
||||
"abstract": False,
|
||||
"base_manager_name": "prefetch_manager",
|
||||
},
|
||||
managers=[
|
||||
("objects", django.db.models.manager.Manager()),
|
||||
("prefetch_manager", django.db.models.manager.Manager()),
|
||||
],
|
||||
),
|
||||
migrations.CreateModel(
|
||||
name="UnlockRequirements",
|
||||
fields=[
|
||||
("id", models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name="ID")),
|
||||
("subs_goal", models.TextField(null=True)),
|
||||
("minute_watched_goal", models.TextField(null=True)),
|
||||
("typename", models.TextField(blank=True, null=True)),
|
||||
],
|
||||
options={
|
||||
"abstract": False,
|
||||
"base_manager_name": "prefetch_manager",
|
||||
},
|
||||
managers=[
|
||||
("objects", django.db.models.manager.Manager()),
|
||||
("prefetch_manager", django.db.models.manager.Manager()),
|
||||
],
|
||||
),
|
||||
migrations.CreateModel(
|
||||
name="BenefitEdge",
|
||||
fields=[
|
||||
("id", models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name="ID")),
|
||||
("entitlement_limit", models.TextField(null=True)),
|
||||
("typename", models.TextField(blank=True, null=True)),
|
||||
(
|
||||
"benefit",
|
||||
auto_prefetch.ForeignKey(
|
||||
null=True,
|
||||
on_delete=django.db.models.deletion.CASCADE,
|
||||
related_name="benefit_edges",
|
||||
to="core.benefit",
|
||||
),
|
||||
),
|
||||
],
|
||||
options={
|
||||
"abstract": False,
|
||||
"base_manager_name": "prefetch_manager",
|
||||
},
|
||||
managers=[
|
||||
("objects", django.db.models.manager.Manager()),
|
||||
("prefetch_manager", django.db.models.manager.Manager()),
|
||||
],
|
||||
),
|
||||
migrations.CreateModel(
|
||||
name="Allow",
|
||||
fields=[
|
||||
("id", models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name="ID")),
|
||||
("is_enabled", models.BooleanField(default=True)),
|
||||
("typename", models.TextField(blank=True, null=True)),
|
||||
("channels", models.ManyToManyField(related_name="allow", to="core.channel")),
|
||||
],
|
||||
options={
|
||||
"abstract": False,
|
||||
"base_manager_name": "prefetch_manager",
|
||||
},
|
||||
managers=[
|
||||
("objects", django.db.models.manager.Manager()),
|
||||
("prefetch_manager", django.db.models.manager.Manager()),
|
||||
],
|
||||
),
|
||||
migrations.CreateModel(
|
||||
name="FrontEndDropCampaign",
|
||||
fields=[
|
||||
("id", models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name="ID")),
|
||||
("account_link_url", models.URLField(blank=True, null=True)),
|
||||
("about_url", models.URLField(blank=True, null=True)),
|
||||
("ends_at", models.DateTimeField(null=True)),
|
||||
("starts_at", models.DateTimeField(null=True)),
|
||||
("channels", models.ManyToManyField(related_name="drop_campaigns", to="core.frontendchannel")),
|
||||
(
|
||||
"game",
|
||||
models.ForeignKey(
|
||||
null=True,
|
||||
on_delete=django.db.models.deletion.CASCADE,
|
||||
related_name="drop_campaigns",
|
||||
to="core.frontendgame",
|
||||
),
|
||||
),
|
||||
],
|
||||
options={
|
||||
"abstract": False,
|
||||
"base_manager_name": "prefetch_manager",
|
||||
},
|
||||
managers=[
|
||||
("objects", django.db.models.manager.Manager()),
|
||||
("prefetch_manager", django.db.models.manager.Manager()),
|
||||
],
|
||||
),
|
||||
migrations.CreateModel(
|
||||
name="FrontEndDrop",
|
||||
fields=[
|
||||
("id", models.TextField(primary_key=True, serialize=False)),
|
||||
("created_at", models.DateTimeField(null=True)),
|
||||
("name", models.TextField(blank=True, null=True)),
|
||||
("image_url", models.URLField(blank=True, null=True)),
|
||||
("limit", models.PositiveBigIntegerField(null=True)),
|
||||
("is_ios_available", models.BooleanField(null=True)),
|
||||
("minutes_watched", models.PositiveBigIntegerField(null=True)),
|
||||
(
|
||||
"drop_campaign",
|
||||
models.ForeignKey(
|
||||
null=True,
|
||||
on_delete=django.db.models.deletion.CASCADE,
|
||||
related_name="drops",
|
||||
to="core.frontenddropcampaign",
|
||||
),
|
||||
),
|
||||
],
|
||||
options={
|
||||
"abstract": False,
|
||||
"base_manager_name": "prefetch_manager",
|
||||
},
|
||||
managers=[
|
||||
("objects", django.db.models.manager.Manager()),
|
||||
("prefetch_manager", django.db.models.manager.Manager()),
|
||||
],
|
||||
),
|
||||
migrations.AddField(
|
||||
model_name="frontendgame",
|
||||
name="org",
|
||||
field=models.ForeignKey(
|
||||
null=True,
|
||||
on_delete=django.db.models.deletion.CASCADE,
|
||||
related_name="games",
|
||||
to="core.frontendorg",
|
||||
),
|
||||
),
|
||||
migrations.AddField(
|
||||
model_name="benefit",
|
||||
name="game",
|
||||
field=auto_prefetch.ForeignKey(
|
||||
null=True,
|
||||
on_delete=django.db.models.deletion.CASCADE,
|
||||
related_name="benefits",
|
||||
to="core.game",
|
||||
),
|
||||
),
|
||||
migrations.AddField(
|
||||
model_name="benefit",
|
||||
name="owner_organization",
|
||||
field=auto_prefetch.ForeignKey(
|
||||
null=True,
|
||||
on_delete=django.db.models.deletion.CASCADE,
|
||||
related_name="benefits",
|
||||
to="core.owner",
|
||||
),
|
||||
),
|
||||
migrations.CreateModel(
|
||||
name="Reward",
|
||||
fields=[
|
||||
("id", models.TextField(primary_key=True, serialize=False)),
|
||||
("name", models.TextField(blank=True, null=True)),
|
||||
("earnable_until", models.DateTimeField(null=True)),
|
||||
("redemption_instructions", models.TextField(blank=True, null=True)),
|
||||
("redemption_url", models.URLField(blank=True, null=True)),
|
||||
("typename", models.TextField(blank=True, null=True)),
|
||||
(
|
||||
"banner_image",
|
||||
auto_prefetch.ForeignKey(
|
||||
null=True,
|
||||
on_delete=django.db.models.deletion.CASCADE,
|
||||
related_name="banner_rewards",
|
||||
to="core.image",
|
||||
),
|
||||
),
|
||||
(
|
||||
"thumbnail_image",
|
||||
auto_prefetch.ForeignKey(
|
||||
null=True,
|
||||
on_delete=django.db.models.deletion.CASCADE,
|
||||
related_name="thumbnail_rewards",
|
||||
to="core.image",
|
||||
),
|
||||
),
|
||||
],
|
||||
options={
|
||||
"abstract": False,
|
||||
"base_manager_name": "prefetch_manager",
|
||||
},
|
||||
managers=[
|
||||
("objects", django.db.models.manager.Manager()),
|
||||
("prefetch_manager", django.db.models.manager.Manager()),
|
||||
],
|
||||
),
|
||||
migrations.CreateModel(
|
||||
name="TimeBasedDrop",
|
||||
fields=[
|
||||
("id", models.TextField(primary_key=True, serialize=False)),
|
||||
("created_at", models.DateTimeField(null=True)),
|
||||
("entitlement_limit", models.TextField(null=True)),
|
||||
("image_asset_url", models.URLField(blank=True, null=True)),
|
||||
("is_ios_available", models.BooleanField(null=True)),
|
||||
("name", models.TextField(blank=True, null=True)),
|
||||
("typename", models.TextField(blank=True, null=True)),
|
||||
(
|
||||
"game",
|
||||
auto_prefetch.ForeignKey(
|
||||
null=True,
|
||||
on_delete=django.db.models.deletion.CASCADE,
|
||||
related_name="time_based_drops",
|
||||
to="core.game",
|
||||
),
|
||||
),
|
||||
(
|
||||
"owner_organization",
|
||||
auto_prefetch.ForeignKey(
|
||||
null=True,
|
||||
on_delete=django.db.models.deletion.CASCADE,
|
||||
related_name="time_based_drops",
|
||||
to="core.owner",
|
||||
),
|
||||
),
|
||||
],
|
||||
options={
|
||||
"abstract": False,
|
||||
"base_manager_name": "prefetch_manager",
|
||||
},
|
||||
managers=[
|
||||
("objects", django.db.models.manager.Manager()),
|
||||
("prefetch_manager", django.db.models.manager.Manager()),
|
||||
],
|
||||
),
|
||||
migrations.CreateModel(
|
||||
name="DropCampaign",
|
||||
fields=[
|
||||
("id", models.TextField(primary_key=True, serialize=False)),
|
||||
("account_link_url", models.URLField(blank=True, null=True)),
|
||||
("description", models.TextField(blank=True, null=True)),
|
||||
("details_url", models.URLField(blank=True, null=True)),
|
||||
("ends_at", models.DateTimeField(null=True)),
|
||||
("image_url", models.URLField(blank=True, null=True)),
|
||||
("name", models.TextField(blank=True, null=True)),
|
||||
("starts_at", models.DateTimeField(null=True)),
|
||||
(
|
||||
"status",
|
||||
models.TextField(blank=True, choices=[("ACTIVE", "Active"), ("EXPIRED", "Expired")], null=True),
|
||||
),
|
||||
("typename", models.TextField(blank=True, null=True)),
|
||||
(
|
||||
"allow",
|
||||
auto_prefetch.ForeignKey(
|
||||
null=True,
|
||||
on_delete=django.db.models.deletion.CASCADE,
|
||||
related_name="drop_campaigns",
|
||||
to="core.allow",
|
||||
),
|
||||
),
|
||||
(
|
||||
"game",
|
||||
auto_prefetch.ForeignKey(
|
||||
null=True,
|
||||
on_delete=django.db.models.deletion.CASCADE,
|
||||
related_name="drop_campaigns",
|
||||
to="core.game",
|
||||
),
|
||||
),
|
||||
(
|
||||
"owner",
|
||||
auto_prefetch.ForeignKey(
|
||||
null=True,
|
||||
on_delete=django.db.models.deletion.CASCADE,
|
||||
related_name="drop_campaigns",
|
||||
to="core.owner",
|
||||
),
|
||||
),
|
||||
("time_based_drops", models.ManyToManyField(related_name="drop_campaigns", to="core.timebaseddrop")),
|
||||
],
|
||||
options={
|
||||
"abstract": False,
|
||||
"base_manager_name": "prefetch_manager",
|
||||
},
|
||||
managers=[
|
||||
("objects", django.db.models.manager.Manager()),
|
||||
("prefetch_manager", django.db.models.manager.Manager()),
|
||||
],
|
||||
),
|
||||
migrations.CreateModel(
|
||||
name="RewardCampaign",
|
||||
fields=[
|
||||
("id", models.TextField(primary_key=True, serialize=False)),
|
||||
("name", models.TextField(blank=True, null=True)),
|
||||
("brand", models.TextField(blank=True, null=True)),
|
||||
("starts_at", models.DateTimeField(null=True)),
|
||||
("ends_at", models.DateTimeField(null=True)),
|
||||
("status", models.TextField(blank=True, null=True)),
|
||||
("summary", models.TextField(blank=True, null=True)),
|
||||
("instructions", models.TextField(blank=True, null=True)),
|
||||
("external_url", models.URLField(blank=True, null=True)),
|
||||
("reward_value_url_param", models.TextField(blank=True, null=True)),
|
||||
("about_url", models.URLField(blank=True, null=True)),
|
||||
("is_sitewide", models.BooleanField(null=True)),
|
||||
("typename", models.TextField(blank=True, null=True)),
|
||||
(
|
||||
"game",
|
||||
auto_prefetch.ForeignKey(
|
||||
null=True,
|
||||
on_delete=django.db.models.deletion.CASCADE,
|
||||
related_name="reward_campaigns",
|
||||
to="core.game",
|
||||
),
|
||||
),
|
||||
(
|
||||
"image",
|
||||
auto_prefetch.ForeignKey(
|
||||
null=True,
|
||||
on_delete=django.db.models.deletion.CASCADE,
|
||||
related_name="reward_campaigns",
|
||||
to="core.image",
|
||||
),
|
||||
),
|
||||
("rewards", models.ManyToManyField(related_name="reward_campaigns", to="core.reward")),
|
||||
(
|
||||
"unlock_requirements",
|
||||
auto_prefetch.ForeignKey(
|
||||
null=True,
|
||||
on_delete=django.db.models.deletion.CASCADE,
|
||||
related_name="reward_campaigns",
|
||||
to="core.unlockrequirements",
|
||||
),
|
||||
),
|
||||
],
|
||||
options={
|
||||
"abstract": False,
|
||||
"base_manager_name": "prefetch_manager",
|
||||
},
|
||||
managers=[
|
||||
("objects", django.db.models.manager.Manager()),
|
||||
("prefetch_manager", django.db.models.manager.Manager()),
|
||||
],
|
||||
),
|
||||
]
|
||||
643
core/models.py
Normal file
643
core/models.py
Normal file
@ -0,0 +1,643 @@
|
||||
from __future__ import annotations
|
||||
|
||||
import logging
|
||||
import typing
|
||||
|
||||
import auto_prefetch
|
||||
from django.db import models
|
||||
|
||||
logger: logging.Logger = logging.getLogger(__name__)
|
||||
|
||||
|
||||
class Game(auto_prefetch.Model):
|
||||
"""The game that the reward is for.
|
||||
|
||||
Optional for reward campaigns. Required for drop campaigns.
|
||||
|
||||
Attributes:
|
||||
id (str): The primary key of the game.
|
||||
slug (str): The slug identifier of the game.
|
||||
display_name (str): The display name of the game.
|
||||
typename (str): The type name of the object, typically "Game".
|
||||
|
||||
Example JSON data:
|
||||
{
|
||||
"data": {
|
||||
"currentUser": {
|
||||
"dropCampaigns": [
|
||||
{
|
||||
"game": {
|
||||
"id": "263490",
|
||||
"slug": "rust",
|
||||
"displayName": "Rust",
|
||||
"__typename": "Game"
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
"""
|
||||
|
||||
id = models.TextField(primary_key=True, unique=True, help_text="The game ID.", verbose_name="Game ID")
|
||||
slug = models.TextField(null=True, blank=True, help_text="Slug used for building URL where all the streams are.")
|
||||
display_name = models.TextField(
|
||||
null=True,
|
||||
blank=True,
|
||||
help_text="Game name.",
|
||||
default="Unknown Game",
|
||||
verbose_name="Game Name",
|
||||
)
|
||||
typename = models.TextField(null=True, blank=True, help_text="Always 'Game'.", verbose_name="Type Name")
|
||||
|
||||
# Only used for reward campaigns?
|
||||
box_art_url = models.URLField(
|
||||
null=True,
|
||||
blank=True,
|
||||
help_text="URL to the box art of the game.",
|
||||
default="https://static-cdn.jtvnw.net/ttv-static/404_boxart.jpg",
|
||||
verbose_name="Box Art URL",
|
||||
)
|
||||
|
||||
def __str__(self) -> str:
|
||||
return self.display_name or "Unknown"
|
||||
|
||||
def get_twitch_url(self) -> str:
|
||||
if not self.slug:
|
||||
logger.error("Game %s has no slug", self.display_name)
|
||||
return "https://www.twitch.tv/"
|
||||
return f"https://www.twitch.tv/directory/game/{self.slug}"
|
||||
|
||||
|
||||
class Image(auto_prefetch.Model):
|
||||
"""An image model representing URLs and type.
|
||||
|
||||
Attributes:
|
||||
image1_x_url (str): URL to the image.
|
||||
typename (str): The type name of the object, typically "RewardCampaignImageSet".
|
||||
|
||||
JSON example:
|
||||
{
|
||||
"image1xURL": "https://static-cdn.jtvnw.net/twitch-quests-assets/CAMPAIGN/quests_xdefiant_q3_2024/campaign.png",
|
||||
"__typename": "RewardCampaignImageSet"
|
||||
}
|
||||
"""
|
||||
|
||||
image1_x_url = models.URLField(null=True, blank=True)
|
||||
typename = models.TextField(null=True, blank=True)
|
||||
|
||||
def __str__(self) -> str:
|
||||
return self.image1_x_url or "Unknown"
|
||||
|
||||
|
||||
class Reward(auto_prefetch.Model):
|
||||
"""The actual reward you get when you complete the requirements.
|
||||
|
||||
Attributes:
|
||||
id (str): The primary key of the reward.
|
||||
name (str): The name of the reward.
|
||||
banner_image (Image): The banner image associated with the reward.
|
||||
thumbnail_image (Image): The thumbnail image associated with the reward.
|
||||
earnable_until (datetime): The date and time until the reward can be earned.
|
||||
redemption_instructions (str): Instructions on how to redeem the reward.
|
||||
redemption_url (str): URL for redeeming the reward.
|
||||
typename (str): The type name of the object, typically "Reward".
|
||||
|
||||
JSON example:
|
||||
{
|
||||
"id": "374628c6-34b4-11ef-a468-62ece0f03426",
|
||||
"name": "Twitchy Character Skin",
|
||||
"bannerImage": {
|
||||
"image1xURL": "https://static-cdn.jtvnw.net/twitch-quests-assets/CAMPAIGN/quests_xdefiant_q3_2024/reward.png",
|
||||
"__typename": "RewardCampaignImageSet"
|
||||
},
|
||||
"thumbnailImage": {
|
||||
"image1xURL": "https://static-cdn.jtvnw.net/twitch-quests-assets/CAMPAIGN/quests_xdefiant_q3_2024/reward.png",
|
||||
"__typename": "RewardCampaignImageSet"
|
||||
},
|
||||
"earnableUntil": "2024-07-30T06:59:59Z",
|
||||
"redemptionInstructions": "",
|
||||
"redemptionURL": "https://redeem.ubisoft.com/xdefiant/",
|
||||
"__typename": "Reward"
|
||||
}
|
||||
"""
|
||||
|
||||
id = models.TextField(primary_key=True)
|
||||
name = models.TextField(null=True, blank=True)
|
||||
banner_image = auto_prefetch.ForeignKey(Image, related_name="banner_rewards", on_delete=models.CASCADE, null=True)
|
||||
thumbnail_image = auto_prefetch.ForeignKey(
|
||||
Image,
|
||||
related_name="thumbnail_rewards",
|
||||
on_delete=models.CASCADE,
|
||||
null=True,
|
||||
)
|
||||
earnable_until = models.DateTimeField(null=True)
|
||||
redemption_instructions = models.TextField(null=True, blank=True)
|
||||
redemption_url = models.URLField(null=True, blank=True)
|
||||
typename = models.TextField(null=True, blank=True)
|
||||
|
||||
def __str__(self) -> str:
|
||||
return self.name or "Unknown"
|
||||
|
||||
|
||||
class UnlockRequirements(auto_prefetch.Model):
|
||||
"""Requirements to unlock a reward.
|
||||
|
||||
Attributes:
|
||||
subs_goal (int): The number of subscriptions needed to unlock the reward.
|
||||
minute_watched_goal (int): The number of minutes watched needed to unlock the reward.
|
||||
typename (str): The type name of the object, typically "QuestRewardUnlockRequirements".
|
||||
|
||||
JSON example:
|
||||
{
|
||||
"subsGoal": 2,
|
||||
"minuteWatchedGoal": 0,
|
||||
"__typename": "QuestRewardUnlockRequirements"
|
||||
}
|
||||
"""
|
||||
|
||||
subs_goal = models.TextField(null=True)
|
||||
minute_watched_goal = models.TextField(null=True)
|
||||
typename = models.TextField(null=True, blank=True)
|
||||
|
||||
def __str__(self) -> str:
|
||||
return f"{self.subs_goal} subs and {self.minute_watched_goal} minutes watched"
|
||||
|
||||
|
||||
class RewardCampaign(auto_prefetch.Model):
|
||||
"""Represents a reward campaign.
|
||||
|
||||
Attributes:
|
||||
id (str): The primary key of the reward campaign.
|
||||
name (str): The name of the reward campaign.
|
||||
brand (str): The brand associated with the campaign.
|
||||
starts_at (datetime): The start date and time of the campaign.
|
||||
ends_at (datetime): The end date and time of the campaign.
|
||||
status (str): The status of the campaign.
|
||||
summary (str): A brief summary of the campaign.
|
||||
instructions (str): Instructions for the campaign.
|
||||
external_url (str): The external URL related to the campaign.
|
||||
reward_value_url_param (str): URL parameter for the reward value.
|
||||
about_url (str): URL with more information about the campaign.
|
||||
is_sitewide (bool): Indicates if the campaign is sitewide.
|
||||
game (Game): The game associated with the campaign.
|
||||
image (Image): The image associated with the campaign.
|
||||
rewards (ManyToManyField): The rewards available in the campaign.
|
||||
typename (str): The type name of the object, typically "RewardCampaign".
|
||||
|
||||
JSON example:
|
||||
{
|
||||
"id": "3757a2ae-34b4-11ef-a468-62ece0f03426",
|
||||
"name": "XDefiant Season 1 Launch",
|
||||
"brand": "Ubisoft",
|
||||
"startsAt": "2024-07-02T17:00:00Z",
|
||||
"endsAt": "2024-07-30T06:59:59Z",
|
||||
"status": "UNKNOWN",
|
||||
"summary": "Get a redeemable code for the Twitchy Character Skin in XDefiant for gifting or purchasing 2 subscriptions of any tier to participating channels.",
|
||||
"instructions": "",
|
||||
"externalURL": "https://redeem.ubisoft.com/xdefiant/",
|
||||
"rewardValueURLParam": "",
|
||||
"aboutURL": "https://xdefiant.com/S1-twitch-rewards",
|
||||
"isSitewide": false,
|
||||
"game": {
|
||||
"id": "780302568",
|
||||
"slug": "xdefiant",
|
||||
"displayName": "XDefiant",
|
||||
"__typename": "Game"
|
||||
},
|
||||
"unlockRequirements": {
|
||||
"subsGoal": 2,
|
||||
"minuteWatchedGoal": 0,
|
||||
"__typename": "QuestRewardUnlockRequirements"
|
||||
},
|
||||
"image": {
|
||||
"image1xURL": "https://static-cdn.jtvnw.net/twitch-quests-assets/CAMPAIGN/quests_xdefiant_q3_2024/campaign.png",
|
||||
"__typename": "RewardCampaignImageSet"
|
||||
},
|
||||
"rewards": [
|
||||
{
|
||||
"id": "374628c6-34b4-11ef-a468-62ece0f03426",
|
||||
"name": "Twitchy Character Skin",
|
||||
"bannerImage": {
|
||||
"image1xURL": "https://static-cdn.jtvnw.net/twitch-quests-assets/CAMPAIGN/quests_xdefiant_q3_2024/reward.png",
|
||||
"__typename": "RewardCampaignImageSet"
|
||||
},
|
||||
"thumbnailImage": {
|
||||
"image1xURL": "https://static-cdn.jtvnw.net/twitch-quests-assets/CAMPAIGN/quests_xdefiant_q3_2024/reward.png",
|
||||
"__typename": "RewardCampaignImageSet"
|
||||
},
|
||||
"earnableUntil": "2024-07-30T06:59:59Z",
|
||||
"redemptionInstructions": "",
|
||||
"redemptionURL": "https://redeem.ubisoft.com/xdefiant/",
|
||||
"__typename": "Reward"
|
||||
}
|
||||
],
|
||||
"__typename": "RewardCampaign"
|
||||
}
|
||||
""" # noqa: E501
|
||||
|
||||
id = models.TextField(primary_key=True)
|
||||
name = models.TextField(null=True, blank=True)
|
||||
brand = models.TextField(null=True, blank=True)
|
||||
starts_at = models.DateTimeField(null=True)
|
||||
ends_at = models.DateTimeField(null=True)
|
||||
status = models.TextField(null=True, blank=True)
|
||||
summary = models.TextField(null=True, blank=True)
|
||||
instructions = models.TextField(null=True, blank=True)
|
||||
external_url = models.URLField(null=True, blank=True)
|
||||
reward_value_url_param = models.TextField(null=True, blank=True)
|
||||
about_url = models.URLField(null=True, blank=True)
|
||||
is_sitewide = models.BooleanField(null=True)
|
||||
game = auto_prefetch.ForeignKey(Game, on_delete=models.CASCADE, related_name="reward_campaigns", null=True)
|
||||
unlock_requirements = auto_prefetch.ForeignKey(
|
||||
UnlockRequirements,
|
||||
on_delete=models.CASCADE,
|
||||
related_name="reward_campaigns",
|
||||
null=True,
|
||||
)
|
||||
image = auto_prefetch.ForeignKey(Image, on_delete=models.CASCADE, related_name="reward_campaigns", null=True)
|
||||
rewards = models.ManyToManyField(Reward, related_name="reward_campaigns")
|
||||
typename = models.TextField(null=True, blank=True)
|
||||
|
||||
def __str__(self) -> str:
|
||||
return self.name or "Unknown"
|
||||
|
||||
|
||||
class Channel(auto_prefetch.Model):
|
||||
"""Represents a Twitch channel.
|
||||
|
||||
Attributes:
|
||||
id (int): The primary key of the channel.
|
||||
display_name (str): The display name of the channel.
|
||||
name (str): The name of the channel.
|
||||
typename (str): The type name of the object, typically "Channel".
|
||||
|
||||
Example JSON data:
|
||||
{
|
||||
"data": {
|
||||
"user": {
|
||||
"dropCampaign": {
|
||||
"allow": {
|
||||
"channels": [
|
||||
{
|
||||
"id": "464161875",
|
||||
"displayName": "Valair",
|
||||
"name": "valair",
|
||||
"__typename": "Channel"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
"""
|
||||
|
||||
# Used in Drop Campaigns
|
||||
id = models.TextField(primary_key=True)
|
||||
display_name = models.TextField(null=True, blank=True)
|
||||
name = models.TextField(null=True, blank=True)
|
||||
typename = models.TextField(null=True, blank=True)
|
||||
|
||||
def __str__(self) -> str:
|
||||
return self.display_name or "Unknown Channel"
|
||||
|
||||
def get_twitch_url(self) -> str:
|
||||
# TODO(TheLovinator): Use a field instead # noqa: TD003
|
||||
return f"https://www.twitch.tv/{self.name}"
|
||||
|
||||
|
||||
class Allow(auto_prefetch.Model):
|
||||
"""List of channels that you can watch to earn rewards.
|
||||
|
||||
Attributes:
|
||||
channels (ManyToManyField): The channels that you can watch to earn rewards.
|
||||
is_enabled (bool): Indicates if the channel is enabled.
|
||||
typename (str): The type name of the object, typically "RewardCampaignChannelAllow".
|
||||
|
||||
Example JSON data:
|
||||
{
|
||||
"data": {
|
||||
"user": {
|
||||
"dropCampaign": {
|
||||
"allow": {
|
||||
"channels": [],
|
||||
"isEnabled": true,
|
||||
"__typename": "DropCampaignACL"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
"""
|
||||
|
||||
channels = models.ManyToManyField(Channel, related_name="allow")
|
||||
is_enabled = models.BooleanField(default=True)
|
||||
typename = models.TextField(null=True, blank=True)
|
||||
|
||||
def __str__(self) -> str:
|
||||
return f"{self.channels.count()} channels"
|
||||
|
||||
|
||||
class Owner(auto_prefetch.Model):
|
||||
"""Represents the owner of the reward campaign.
|
||||
|
||||
Used for:
|
||||
- Reward campaigns
|
||||
|
||||
Attributes:
|
||||
id (int): The primary key of the owner.
|
||||
slug (str): The slug identifier of the owner.
|
||||
display_name (str): The display name of the owner.
|
||||
typename (str): The type name of the object, typically "Organization".
|
||||
|
||||
JSON example:
|
||||
"owner": {
|
||||
"id": "a1a51d5a-233d-41c3-9acd-a03bdab35159",
|
||||
"name": "Out of the Park Developments",
|
||||
"__typename": "Organization"
|
||||
},
|
||||
"""
|
||||
|
||||
id = models.TextField(primary_key=True, unique=True, help_text="The owner ID.")
|
||||
name = models.TextField(null=True, blank=True, help_text="Owner name.")
|
||||
slug = models.TextField(null=True, blank=True, help_text="Slug used for building URL where all the streams are.")
|
||||
display_name = models.TextField(null=True, blank=True, help_text="Owner name.")
|
||||
typename = models.TextField(null=True, blank=True, help_text="Always 'Organization'.")
|
||||
|
||||
def __str__(self) -> str:
|
||||
return self.display_name or "Unknown"
|
||||
|
||||
def get_twitch_url(self) -> str:
|
||||
if not self.slug:
|
||||
logger.error("Owner %s has no slug", self.display_name)
|
||||
return "https://www.twitch.tv/"
|
||||
|
||||
return f"https://www.twitch.tv/{self.slug}"
|
||||
|
||||
|
||||
class Benefit(auto_prefetch.Model):
|
||||
"""Represents a benefit that you can earn.
|
||||
|
||||
Attributes:
|
||||
id (int): The primary key of the benefit.
|
||||
created_at (datetime): The date and time the benefit was created.
|
||||
entitlement_limit (int): The limit of entitlement.
|
||||
game (Game): The game associated with the benefit.
|
||||
image_asset_url (str): URL to the image asset.
|
||||
is_ios_available (bool): Indicates if the benefit is available on iOS.
|
||||
name (str): The name of the benefit.
|
||||
owner_organization (Owner): The owner organization of the benefit.
|
||||
typename (str): The type name of the object, typically "Benefit".
|
||||
|
||||
JSON example:
|
||||
"benefit": {
|
||||
"id": "6da09649-1fda-4446-a061-cacd8e21b886_CUSTOM_ID_S29_Torso008_01",
|
||||
"createdAt": "2024-07-09T12:57:31.072Z",
|
||||
"entitlementLimit": 1,
|
||||
"game": {
|
||||
"id": "491487",
|
||||
"name": "Dead by Daylight",
|
||||
"__typename": "Game"
|
||||
},
|
||||
"imageAssetURL": "https://static-cdn.jtvnw.net/twitch-quests-assets/REWARD/ed4a7829-cc2b-44d3-90a4-f73ef7d8d636.png",
|
||||
"isIosAvailable": false,
|
||||
"name": "Unwanted Attention",
|
||||
"ownerOrganization": {
|
||||
"id": "6da09649-1fda-4446-a061-cacd8e21b886",
|
||||
"name": "Behaviour Interactive Inc.",
|
||||
"__typename": "Organization"
|
||||
},
|
||||
"__typename": "DropBenefit"
|
||||
}
|
||||
"""
|
||||
|
||||
id = models.TextField(primary_key=True)
|
||||
created_at = models.DateTimeField(null=True)
|
||||
entitlement_limit = models.TextField(null=True)
|
||||
game = auto_prefetch.ForeignKey(Game, on_delete=models.CASCADE, related_name="benefits", null=True)
|
||||
image_asset_url = models.URLField(null=True, blank=True)
|
||||
is_ios_available = models.BooleanField(null=True)
|
||||
name = models.TextField(null=True, blank=True)
|
||||
owner_organization = auto_prefetch.ForeignKey(Owner, on_delete=models.CASCADE, related_name="benefits", null=True)
|
||||
typename = models.TextField(null=True, blank=True)
|
||||
|
||||
def __str__(self) -> str:
|
||||
return self.name or "Unknown"
|
||||
|
||||
|
||||
class BenefitEdge(auto_prefetch.Model):
|
||||
"""Represents a benefit edge.
|
||||
|
||||
Attributes:
|
||||
benefit (Benefit): The benefit associated with the edge.
|
||||
entitlement_limit (int): The limit of entitlement.
|
||||
typename (str): The type name of the object, typically "DropBenefitEdge".
|
||||
|
||||
|
||||
JSON example:
|
||||
"benefitEdges": [
|
||||
{
|
||||
"benefit": {
|
||||
"id": "6da09649-1fda-4446-a061-cacd8e21b886_CUSTOM_ID_S29_Torso008_01",
|
||||
"createdAt": "2024-07-09T12:57:31.072Z",
|
||||
"entitlementLimit": 1,
|
||||
"game": {
|
||||
"id": "491487",
|
||||
"name": "Dead by Daylight",
|
||||
"__typename": "Game"
|
||||
},
|
||||
"imageAssetURL": "https://static-cdn.jtvnw.net/twitch-quests-assets/REWARD/ed4a7829-cc2b-44d3-90a4-f73ef7d8d636.png",
|
||||
"isIosAvailable": false,
|
||||
"name": "Unwanted Attention",
|
||||
"ownerOrganization": {
|
||||
"id": "6da09649-1fda-4446-a061-cacd8e21b886",
|
||||
"name": "Behaviour Interactive Inc.",
|
||||
"__typename": "Organization"
|
||||
},
|
||||
"__typename": "DropBenefit"
|
||||
},
|
||||
"entitlementLimit": 1,
|
||||
"__typename": "DropBenefitEdge"
|
||||
}
|
||||
],
|
||||
"""
|
||||
|
||||
benefit = auto_prefetch.ForeignKey(Benefit, on_delete=models.CASCADE, related_name="benefit_edges", null=True)
|
||||
entitlement_limit = models.TextField(null=True)
|
||||
typename = models.TextField(null=True, blank=True)
|
||||
|
||||
def __str__(self) -> str:
|
||||
benefit_name: str | None = self.benefit.name if self.benefit else "Unknown"
|
||||
return f"{benefit_name} - {self.entitlement_limit}"
|
||||
|
||||
|
||||
class TimeBasedDrop(auto_prefetch.Model):
|
||||
"""Represents a time-based drop.
|
||||
|
||||
Attributes:
|
||||
id (int): The primary key of the time-based drop.
|
||||
name (str): The name of the time-based drop.
|
||||
starts_at (datetime): The start date and time of the drop.
|
||||
ends_at (datetime): The end date and time of the drop.
|
||||
typename (str): The type name of the object, typically "TimeBasedDrop".
|
||||
|
||||
JSON example:
|
||||
{
|
||||
"id": "0ebeff68-3df3-11ef-b15b-0a58a9feac02",
|
||||
"requiredSubs": 0,
|
||||
"benefitEdges": [
|
||||
{
|
||||
"benefit": {
|
||||
"id": "6da09649-1fda-4446-a061-cacd8e21b886_CUSTOM_ID_S29_Legs008_01",
|
||||
"createdAt": "2024-07-09T12:58:03.654Z",
|
||||
"entitlementLimit": 1,
|
||||
"game": {
|
||||
"id": "491487",
|
||||
"name": "Dead by Daylight",
|
||||
"__typename": "Game"
|
||||
},
|
||||
"imageAssetURL": "https://static-cdn.jtvnw.net/twitch-quests-assets/REWARD/f46acdf5-9515-41eb-805e-86956db0a9e9.png",
|
||||
"isIosAvailable": false,
|
||||
"name": "Back Home",
|
||||
"ownerOrganization": {
|
||||
"id": "6da09649-1fda-4446-a061-cacd8e21b886",
|
||||
"name": "Behaviour Interactive Inc.",
|
||||
"__typename": "Organization"
|
||||
},
|
||||
"__typename": "DropBenefit"
|
||||
},
|
||||
"entitlementLimit": 1,
|
||||
"__typename": "DropBenefitEdge"
|
||||
}
|
||||
],
|
||||
"endAt": "2024-07-30T14:59:59.999Z",
|
||||
"name": "Back Home",
|
||||
"preconditionDrops": null,
|
||||
"requiredMinutesWatched": 360,
|
||||
"startAt": "2024-07-16T15:00:00Z",
|
||||
"__typename": "TimeBasedDrop"
|
||||
},
|
||||
"""
|
||||
|
||||
id = models.TextField(primary_key=True)
|
||||
created_at = models.DateTimeField(null=True)
|
||||
entitlement_limit = models.TextField(null=True)
|
||||
game = auto_prefetch.ForeignKey(Game, on_delete=models.CASCADE, related_name="time_based_drops", null=True)
|
||||
image_asset_url = models.URLField(null=True, blank=True)
|
||||
is_ios_available = models.BooleanField(null=True)
|
||||
name = models.TextField(null=True, blank=True)
|
||||
owner_organization = auto_prefetch.ForeignKey(
|
||||
Owner,
|
||||
on_delete=models.CASCADE,
|
||||
related_name="time_based_drops",
|
||||
null=True,
|
||||
)
|
||||
typename = models.TextField(null=True, blank=True)
|
||||
|
||||
def __str__(self) -> str:
|
||||
return self.name or "Unknown"
|
||||
|
||||
|
||||
class DropCampaign(auto_prefetch.Model):
|
||||
"""Represents a drop campaign.
|
||||
|
||||
Attributes:
|
||||
id (int): The primary key of the drop campaign.
|
||||
allow (Allow): The channels that you can watch to earn rewards.
|
||||
account_link_url (str): URL to link your account.
|
||||
description (str): The description of the drop campaign.
|
||||
details_url (str): URL with more details about the drop campaign.
|
||||
ends_at (datetime): The end date and time of the drop campaign.
|
||||
game (Game): The game associated with the drop campaign.
|
||||
image_url (str): URL to the image associated with the drop campaign.
|
||||
name (str): The name of the drop campaign.
|
||||
owner (Owner): The owner of the drop campaign.
|
||||
starts_at (datetime): The start date and time of the drop campaign.
|
||||
status (str): The status of the drop campaign.
|
||||
time_based_drops (ManyToManyField): The time-based drops associated with the campaign.
|
||||
typename (str): The type name of the object, typically "DropCampaign".
|
||||
"""
|
||||
|
||||
STATUS_CHOICES: typing.ClassVar[list[tuple[str, str]]] = [
|
||||
("ACTIVE", "Active"),
|
||||
("EXPIRED", "Expired"),
|
||||
]
|
||||
|
||||
id = models.TextField(primary_key=True)
|
||||
allow = auto_prefetch.ForeignKey(Allow, on_delete=models.CASCADE, related_name="drop_campaigns", null=True)
|
||||
account_link_url = models.URLField(null=True, blank=True)
|
||||
description = models.TextField(null=True, blank=True)
|
||||
details_url = models.URLField(null=True, blank=True)
|
||||
ends_at = models.DateTimeField(null=True)
|
||||
# event_based_drops = ????
|
||||
game = auto_prefetch.ForeignKey(Game, on_delete=models.CASCADE, related_name="drop_campaigns", null=True)
|
||||
image_url = models.URLField(null=True, blank=True)
|
||||
name = models.TextField(null=True, blank=True)
|
||||
owner = auto_prefetch.ForeignKey(Owner, on_delete=models.CASCADE, related_name="drop_campaigns", null=True)
|
||||
starts_at = models.DateTimeField(null=True)
|
||||
status = models.TextField(choices=STATUS_CHOICES, null=True, blank=True)
|
||||
time_based_drops = models.ManyToManyField(TimeBasedDrop, related_name="drop_campaigns")
|
||||
typename = models.TextField(null=True, blank=True)
|
||||
|
||||
def __str__(self) -> str:
|
||||
return self.name or "Unknown"
|
||||
|
||||
|
||||
class FrontEndChannel(auto_prefetch.Model):
|
||||
"""This is the channel we will see on the front end."""
|
||||
|
||||
name = models.TextField(null=True, blank=True)
|
||||
twitch_url = models.URLField(null=True, blank=True)
|
||||
live = models.BooleanField(default=False)
|
||||
|
||||
|
||||
class FrontEndOrg(auto_prefetch.Model):
|
||||
"""Drops are group by organization -> by game -> by drop campaign."""
|
||||
|
||||
id = models.TextField(primary_key=True)
|
||||
name = models.TextField(null=True, blank=True)
|
||||
url = models.TextField(null=True, blank=True)
|
||||
|
||||
|
||||
class FrontEndGame(auto_prefetch.Model):
|
||||
"""This is the game we will see on the front end."""
|
||||
|
||||
twitch_id = models.TextField(primary_key=True)
|
||||
game_url = models.URLField(null=True, blank=True)
|
||||
display_name = models.TextField(null=True, blank=True)
|
||||
|
||||
org = models.ForeignKey(FrontEndOrg, on_delete=models.CASCADE, related_name="games", null=True)
|
||||
|
||||
def __str__(self) -> str:
|
||||
return self.display_name or "Unknown"
|
||||
|
||||
|
||||
class FrontEndDropCampaign(auto_prefetch.Model):
|
||||
"""This is the drop campaign we will see on the front end."""
|
||||
|
||||
account_link_url = models.URLField(null=True, blank=True)
|
||||
about_url = models.URLField(null=True, blank=True)
|
||||
|
||||
ends_at = models.DateTimeField(null=True)
|
||||
starts_at = models.DateTimeField(null=True)
|
||||
|
||||
game = models.ForeignKey(FrontEndGame, on_delete=models.CASCADE, related_name="drop_campaigns", null=True)
|
||||
|
||||
channels = models.ManyToManyField(FrontEndChannel, related_name="drop_campaigns")
|
||||
|
||||
|
||||
class FrontEndDrop(auto_prefetch.Model):
|
||||
"""This is the drop we will see on the front end."""
|
||||
|
||||
id = models.TextField(primary_key=True)
|
||||
created_at = models.DateTimeField(null=True)
|
||||
|
||||
name = models.TextField(null=True, blank=True)
|
||||
image_url = models.URLField(null=True, blank=True)
|
||||
|
||||
drop_campaign = models.ForeignKey(FrontEndDropCampaign, on_delete=models.CASCADE, related_name="drops", null=True)
|
||||
|
||||
limit = models.PositiveBigIntegerField(null=True)
|
||||
is_ios_available = models.BooleanField(null=True)
|
||||
minutes_watched = models.PositiveBigIntegerField(null=True)
|
||||
173
core/settings.py
Normal file
173
core/settings.py
Normal file
@ -0,0 +1,173 @@
|
||||
import os
|
||||
from pathlib import Path
|
||||
|
||||
import sentry_sdk
|
||||
from django.contrib import messages
|
||||
from dotenv import find_dotenv, load_dotenv
|
||||
from platformdirs import user_data_dir
|
||||
|
||||
load_dotenv(dotenv_path=find_dotenv(), verbose=True)
|
||||
|
||||
DATA_DIR = Path(
|
||||
user_data_dir(
|
||||
appname="TTVDrops",
|
||||
appauthor="TheLovinator",
|
||||
roaming=True,
|
||||
ensure_exists=True,
|
||||
),
|
||||
)
|
||||
|
||||
DEBUG: bool = os.getenv(key="DEBUG", default="True").lower() == "true"
|
||||
|
||||
if not DEBUG:
|
||||
sentry_sdk.init(
|
||||
dsn="https://35519536b56710e51cac49522b2cc29f@o4505228040339456.ingest.sentry.io/4506447308914688",
|
||||
environment="Production",
|
||||
send_default_pii=True,
|
||||
traces_sample_rate=0.2,
|
||||
profiles_sample_rate=0.2,
|
||||
)
|
||||
|
||||
BASE_DIR: Path = Path(__file__).resolve().parent.parent
|
||||
ADMINS: list[tuple[str, str]] = [("Joakim Hellsén", "tlovinator@gmail.com")]
|
||||
WSGI_APPLICATION = "core.wsgi.application"
|
||||
SECRET_KEY: str = os.getenv("DJANGO_SECRET_KEY", default="")
|
||||
TIME_ZONE = "Europe/Stockholm"
|
||||
USE_TZ = True
|
||||
LANGUAGE_CODE = "en-us"
|
||||
DECIMAL_SEPARATOR = ","
|
||||
THOUSAND_SEPARATOR = " "
|
||||
ROOT_URLCONF = "core.urls"
|
||||
STATIC_URL = "static/"
|
||||
DEFAULT_AUTO_FIELD = "django.db.models.BigAutoField"
|
||||
STATICFILES_DIRS: list[Path] = [BASE_DIR / "static"]
|
||||
STATIC_ROOT: Path = BASE_DIR / "staticfiles"
|
||||
STATIC_ROOT.mkdir(exist_ok=True)
|
||||
|
||||
if DEBUG:
|
||||
INTERNAL_IPS: list[str] = ["127.0.0.1"]
|
||||
|
||||
if not DEBUG:
|
||||
ALLOWED_HOSTS: list[str] = ["ttvdrops.lovinator.space", "localhost"]
|
||||
|
||||
EMAIL_HOST = "smtp.gmail.com"
|
||||
EMAIL_PORT = 587
|
||||
EMAIL_USE_TLS = True
|
||||
EMAIL_HOST_USER: str = os.getenv(key="EMAIL_HOST_USER", default="webmaster@localhost")
|
||||
EMAIL_HOST_PASSWORD: str = os.getenv(key="EMAIL_HOST_PASSWORD", default="")
|
||||
EMAIL_SUBJECT_PREFIX = "[TTVDrops] "
|
||||
EMAIL_USE_LOCALTIME = True
|
||||
EMAIL_TIMEOUT = 10
|
||||
DEFAULT_FROM_EMAIL: str = os.getenv(
|
||||
key="EMAIL_HOST_USER",
|
||||
default="webmaster@localhost",
|
||||
)
|
||||
SERVER_EMAIL: str = os.getenv(key="EMAIL_HOST_USER", default="webmaster@localhost")
|
||||
DISCORD_WEBHOOK_URL: str = os.getenv(key="DISCORD_WEBHOOK_URL", default="")
|
||||
|
||||
INSTALLED_APPS: list[str] = [
|
||||
"core.apps.CoreConfig",
|
||||
"whitenoise.runserver_nostatic",
|
||||
"django.contrib.contenttypes",
|
||||
"django.contrib.sessions",
|
||||
"django.contrib.messages",
|
||||
"django.contrib.staticfiles",
|
||||
"simple_history",
|
||||
"debug_toolbar",
|
||||
]
|
||||
|
||||
MIDDLEWARE: list[str] = [
|
||||
"django.middleware.gzip.GZipMiddleware",
|
||||
"debug_toolbar.middleware.DebugToolbarMiddleware",
|
||||
"whitenoise.middleware.WhiteNoiseMiddleware",
|
||||
"django.contrib.sessions.middleware.SessionMiddleware",
|
||||
"django.middleware.common.CommonMiddleware",
|
||||
"django.middleware.csrf.CsrfViewMiddleware",
|
||||
"django.contrib.messages.middleware.MessageMiddleware",
|
||||
"simple_history.middleware.HistoryRequestMiddleware",
|
||||
]
|
||||
|
||||
TEMPLATES = [
|
||||
{
|
||||
"BACKEND": "django.template.backends.django.DjangoTemplates",
|
||||
"DIRS": [BASE_DIR / "templates"],
|
||||
"OPTIONS": {
|
||||
"context_processors": [
|
||||
"django.template.context_processors.debug",
|
||||
"django.template.context_processors.request",
|
||||
"django.contrib.messages.context_processors.messages",
|
||||
],
|
||||
"loaders": [
|
||||
(
|
||||
"django.template.loaders.cached.Loader",
|
||||
[
|
||||
"django.template.loaders.filesystem.Loader",
|
||||
"django.template.loaders.app_directories.Loader",
|
||||
],
|
||||
),
|
||||
],
|
||||
},
|
||||
},
|
||||
]
|
||||
|
||||
# Don't cache templates in development
|
||||
if DEBUG:
|
||||
TEMPLATES[0]["OPTIONS"]["loaders"] = [
|
||||
"django.template.loaders.filesystem.Loader",
|
||||
"django.template.loaders.app_directories.Loader",
|
||||
]
|
||||
|
||||
DATABASES = {
|
||||
"default": {
|
||||
"ENGINE": "django.db.backends.sqlite3",
|
||||
"NAME": DATA_DIR / "ttvdrops.sqlite3",
|
||||
"OPTIONS": {
|
||||
# "init_command": "PRAGMA journal_mode=wal; PRAGMA synchronous=1; PRAGMA mmap_size=134217728; PRAGMA journal_size_limit=67108864; PRAGMA cache_size=2000;", # noqa: E501
|
||||
},
|
||||
},
|
||||
}
|
||||
|
||||
STORAGES: dict[str, dict[str, str]] = {
|
||||
"staticfiles": {
|
||||
"BACKEND": "whitenoise.storage.CompressedManifestStaticFilesStorage",
|
||||
},
|
||||
}
|
||||
|
||||
LOGGING = {
|
||||
"version": 1,
|
||||
"disable_existing_loggers": False,
|
||||
"handlers": {
|
||||
"console": {
|
||||
"level": "DEBUG",
|
||||
"class": "logging.StreamHandler",
|
||||
},
|
||||
},
|
||||
"loggers": {
|
||||
"": {
|
||||
"handlers": ["console"],
|
||||
"level": "DEBUG",
|
||||
"propagate": True,
|
||||
},
|
||||
"django.utils.autoreload": { # Remove spam
|
||||
"handlers": ["console"],
|
||||
"level": "INFO",
|
||||
"propagate": True,
|
||||
},
|
||||
},
|
||||
}
|
||||
|
||||
MESSAGE_TAGS: dict[int, str] = {
|
||||
messages.DEBUG: "alert-info",
|
||||
messages.INFO: "alert-info",
|
||||
messages.SUCCESS: "alert-success",
|
||||
messages.WARNING: "alert-warning",
|
||||
messages.ERROR: "alert-danger",
|
||||
}
|
||||
|
||||
CACHE_MIDDLEWARE_SECONDS = 60 * 60 * 24 # 1 day
|
||||
CACHES = {
|
||||
"default": {
|
||||
"BACKEND": "django.core.cache.backends.filebased.FileBasedCache",
|
||||
"LOCATION": DATA_DIR / "django_cache",
|
||||
},
|
||||
}
|
||||
@ -1,14 +1,14 @@
|
||||
<header class="d-flex justify-content-between align-items-center py-3 border-bottom">
|
||||
<h1 class="h2">
|
||||
<a href='{% url "core:index" %}' class="text-decoration-none nav-title">Twitch drops</a>
|
||||
<a href='{% url "index" %}' class="text-decoration-none nav-title">Twitch drops</a>
|
||||
</h1>
|
||||
<nav>
|
||||
<ul class="nav">
|
||||
<li class="nav-item">
|
||||
<a class="nav-link" href='{% url "core:games" %}'>Games</a>
|
||||
<a class="nav-link" href='{% url "games" %}'>Games</a>
|
||||
</li>
|
||||
<li>
|
||||
<a class="nav-link" href='{% url "core:reward_campaigns" %}'>Reward campaigns</a>
|
||||
<a class="nav-link" href='{% url "reward_campaigns" %}'>Reward campaigns</a>
|
||||
</li>
|
||||
<li class="nav-item">
|
||||
<a class="nav-link" href=''>API</a>
|
||||
|
||||
57
core/testboi.py
Normal file
57
core/testboi.py
Normal file
@ -0,0 +1,57 @@
|
||||
from dataclasses import dataclass
|
||||
from datetime import datetime
|
||||
from uuid import UUID
|
||||
|
||||
|
||||
@dataclass
|
||||
class Game:
|
||||
id: int
|
||||
slug: str
|
||||
display_name: str
|
||||
typename: str
|
||||
|
||||
|
||||
@dataclass
|
||||
class Image:
|
||||
image1_x_url: str
|
||||
typename: str
|
||||
|
||||
|
||||
@dataclass
|
||||
class Reward:
|
||||
id: UUID
|
||||
name: str
|
||||
banner_image: Image
|
||||
thumbnail_image: Image
|
||||
earnable_until: datetime
|
||||
redemption_instructions: str
|
||||
redemption_url: str
|
||||
typename: str
|
||||
|
||||
|
||||
@dataclass
|
||||
class UnlockRequirements:
|
||||
subs_goal: int
|
||||
minute_watched_goal: int
|
||||
typename: str
|
||||
|
||||
|
||||
@dataclass
|
||||
class RewardCampaign:
|
||||
id: UUID
|
||||
name: str
|
||||
brand: str
|
||||
starts_at: datetime
|
||||
ends_at: datetime
|
||||
status: str
|
||||
summary: str
|
||||
instructions: str
|
||||
external_url: str
|
||||
reward_value_url_param: str
|
||||
about_url: str
|
||||
is_sitewide: bool
|
||||
game: Game
|
||||
unlock_requirements: UnlockRequirements
|
||||
image: Image
|
||||
rewards: list[Reward]
|
||||
typename: str
|
||||
@ -1,19 +1,13 @@
|
||||
from typing import TYPE_CHECKING
|
||||
|
||||
import pytest
|
||||
from django.test import Client, RequestFactory
|
||||
from django.test import Client
|
||||
from django.urls import reverse
|
||||
|
||||
if TYPE_CHECKING:
|
||||
from django.http import HttpResponse
|
||||
|
||||
|
||||
@pytest.fixture
|
||||
def factory() -> RequestFactory:
|
||||
"""Factory for creating requests."""
|
||||
return RequestFactory()
|
||||
|
||||
|
||||
@pytest.mark.django_db
|
||||
def test_index_view(client: Client) -> None:
|
||||
"""Test index view."""
|
||||
|
||||
@ -1,5 +1,6 @@
|
||||
from __future__ import annotations
|
||||
|
||||
from debug_toolbar.toolbar import debug_toolbar_urls
|
||||
from django.urls import URLPattern, URLResolver, path
|
||||
|
||||
from core.views import game_view, index, reward_campaign_view
|
||||
@ -18,4 +19,5 @@ urlpatterns: list[URLPattern | URLResolver] = [
|
||||
view=reward_campaign_view,
|
||||
name="reward_campaigns",
|
||||
),
|
||||
*debug_toolbar_urls(),
|
||||
]
|
||||
|
||||
@ -4,60 +4,17 @@ import logging
|
||||
from dataclasses import dataclass
|
||||
from typing import TYPE_CHECKING
|
||||
|
||||
import hishel
|
||||
from django.conf import settings
|
||||
from django.db.models.manager import BaseManager
|
||||
from django.template.response import TemplateResponse
|
||||
|
||||
from core.data import WebhookData
|
||||
from twitch_app.models import Game, RewardCampaign
|
||||
from core.models import Game, RewardCampaign
|
||||
|
||||
if TYPE_CHECKING:
|
||||
from pathlib import Path
|
||||
|
||||
from django.db.models.manager import BaseManager
|
||||
from django.http import HttpRequest, HttpResponse
|
||||
from httpx import Response
|
||||
|
||||
logger: logging.Logger = logging.getLogger(__name__)
|
||||
|
||||
cache_dir: Path = settings.DATA_DIR / "cache"
|
||||
cache_dir.mkdir(exist_ok=True, parents=True)
|
||||
storage = hishel.FileStorage(base_path=cache_dir)
|
||||
controller = hishel.Controller(
|
||||
cacheable_status_codes=[200, 203, 204, 206, 300, 301, 308, 404, 405, 410, 414, 501],
|
||||
allow_stale=True,
|
||||
always_revalidate=True,
|
||||
)
|
||||
|
||||
|
||||
def get_webhooks(request: HttpRequest) -> list[str]:
|
||||
"""Get the webhooks from the cookie."""
|
||||
cookie: str = request.COOKIES.get("webhooks", "")
|
||||
return list(filter(None, cookie.split(",")))
|
||||
|
||||
|
||||
def get_avatar(webhook_response: Response) -> str:
|
||||
"""Get the avatar URL from the webhook response."""
|
||||
avatar: str = "https://cdn.discordapp.com/embed/avatars/0.png"
|
||||
if webhook_response.is_success and webhook_response.json().get("id") and webhook_response.json().get("avatar"):
|
||||
avatar = f'https://cdn.discordapp.com/avatars/{webhook_response.json().get("id")}/{webhook_response.json().get("avatar")}.png'
|
||||
return avatar
|
||||
|
||||
|
||||
def get_webhook_data(webhook: str) -> WebhookData:
|
||||
"""Get the webhook data."""
|
||||
with hishel.CacheClient(storage=storage, controller=controller) as client:
|
||||
webhook_response: Response = client.get(url=webhook, extensions={"cache_metadata": True})
|
||||
|
||||
return WebhookData(
|
||||
name=webhook_response.json().get("name") if webhook_response.is_success else "Unknown",
|
||||
url=webhook,
|
||||
avatar=get_avatar(webhook_response),
|
||||
status="Success" if webhook_response.is_success else "Failed",
|
||||
response=webhook_response.text,
|
||||
)
|
||||
|
||||
|
||||
@dataclass
|
||||
class TOCItem:
|
||||
@ -68,7 +25,14 @@ class TOCItem:
|
||||
|
||||
|
||||
def build_toc(list_of_things: list[TOCItem]) -> str:
|
||||
"""Build the table of contents."""
|
||||
"""Build the table of contents.
|
||||
|
||||
Args:
|
||||
list_of_things (list[TOCItem]): The list of table of contents items.
|
||||
|
||||
Returns:
|
||||
str: The HTML for the table of contents.
|
||||
"""
|
||||
html: str = """
|
||||
<div class="position-sticky d-none d-lg-block toc">
|
||||
<div class="card">
|
||||
@ -85,7 +49,14 @@ def build_toc(list_of_things: list[TOCItem]) -> str:
|
||||
|
||||
|
||||
def index(request: HttpRequest) -> HttpResponse:
|
||||
"""Render the index page."""
|
||||
"""Render the index page.
|
||||
|
||||
Args:
|
||||
request (HttpRequest): The request object.
|
||||
|
||||
Returns:
|
||||
HttpResponse: The response object
|
||||
"""
|
||||
reward_campaigns: BaseManager[RewardCampaign] = RewardCampaign.objects.all()
|
||||
|
||||
toc: str = build_toc([
|
||||
@ -98,7 +69,14 @@ def index(request: HttpRequest) -> HttpResponse:
|
||||
|
||||
|
||||
def game_view(request: HttpRequest) -> HttpResponse:
|
||||
"""Render the game view page."""
|
||||
"""Render the game view page.
|
||||
|
||||
Args:
|
||||
request (HttpRequest): The request object.
|
||||
|
||||
Returns:
|
||||
HttpResponse: The response object.
|
||||
"""
|
||||
games: BaseManager[Game] = Game.objects.all()
|
||||
|
||||
tocs: list[TOCItem] = [
|
||||
@ -111,7 +89,14 @@ def game_view(request: HttpRequest) -> HttpResponse:
|
||||
|
||||
|
||||
def reward_campaign_view(request: HttpRequest) -> HttpResponse:
|
||||
"""Render the reward campaign view page."""
|
||||
"""Render the reward campaign view page.
|
||||
|
||||
Args:
|
||||
request (HttpRequest): The request object.
|
||||
|
||||
Returns:
|
||||
HttpResponse: The response object.
|
||||
"""
|
||||
reward_campaigns: BaseManager[RewardCampaign] = RewardCampaign.objects.all()
|
||||
context: dict[str, BaseManager[RewardCampaign]] = {"reward_campaigns": reward_campaigns}
|
||||
return TemplateResponse(request=request, template="reward_campaigns.html", context=context)
|
||||
|
||||
8
core/wsgi.py
Normal file
8
core/wsgi.py
Normal file
@ -0,0 +1,8 @@
|
||||
import os
|
||||
|
||||
from django.core.handlers.wsgi import WSGIHandler
|
||||
from django.core.wsgi import get_wsgi_application
|
||||
|
||||
os.environ.setdefault(key="DJANGO_SETTINGS_MODULE", value="core.settings")
|
||||
|
||||
application: WSGIHandler = get_wsgi_application()
|
||||
Reference in New Issue
Block a user