Merge pull request #1 from tofran/2022-updates

Added looping feature, better dependency management and continuous delivery

Author: tofran

.github/workflows/build.yaml

@@ -0,0 +1,69 @@
+name: Build and push
+
+on:
+  push:
+    branches:
+      - main
+    tags:
+  pull_request:
+  release:
+    types:
+      - published
+  workflow_dispatch:
+
+jobs:
+  build:
+    name: Build and publish image
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Login to Docker Hub
+        uses: docker/login-action@v2
+        with:
+          username: ${{ github.actor }}
+          password: ${{ secrets.DOCKER_HUB_PASSWORD }}
+
+      - name: Login to GitHub container registry
+        uses: docker/login-action@v2
+        with:
+          registry: ghcr.io
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v2
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v2
+
+      - name: Docker metadata
+        id: docker_metadata
+        uses: docker/metadata-action@v4
+        with:
+          images: |
+            name=ghcr.io/${{ github.repository }}
+            name=${{ github.repository }},enable=${{ github.event_name != 'pull_request' }}
+          tags: |
+            type=sha
+            type=ref,event=branch
+            type=ref,event=pr
+            type=semver,pattern={{version}}
+            type=semver,pattern={{major}}.{{minor}}
+            type=semver,pattern={{major}}
+
+      - name: Build and push
+        id: docker_build
+        uses: docker/build-push-action@v3
+        with:
+          context: ./
+          file: ./Dockerfile
+          platforms: linux/amd64, linux/arm64, linux/386
+          push: true
+          tags: ${{ steps.docker_metadata.outputs.tags }}
+          labels: ${{ steps.docker_metadata.outputs.labels }}
+          cache-from: type=gha
+          cache-to: type=gha,mode=max

Dockerfile

@@ -1,7 +1,11 @@
-FROM python:alpine
+FROM python:3.11-alpine
 
-RUN pip install --upgrade pip && pip install requests
+ENV PYTHONUNBUFFERED=1
 
-COPY ./advent_of_code_notify.py ./advent_of_code_notify.py
+WORKDIR /app
+
+COPY ./requirements.txt ./
+RUN pip install --upgrade pip && pip install -r requirements.txt
 
-CMD ["/advent_of_code_notify.py"]
+COPY ./advent_of_code_notify.py ./advent_of_code_notify.py
+CMD "./advent_of_code_notify.py"

README.md

@@ -8,26 +8,32 @@ I'm using this to track the progress of a group of friends on Discord.
 
 ## Usage
 
-Just run this image periodically (at a minimum interval of 15 min):
+Just run this image whenever you want to check for updates:
 
 ```sh
 $ docker run \
   -e WEBHOOK_URL="your webhook url" \
   -e ADVENT_OF_CODE_SESSION_ID="your advent of code session id" \
   -e ADVENT_OF_CODE_LEADERBOARD_ID="numeric leaderboard id" \
-  -e CACHE_FILE=/cache/cache.json \
+  -e CACHE_FILE="/cache/cache.json" \
+  # (Optional) -e LOOP_SLEEP_SECONDS="900" \
   -v "$(pwd)/cache/:/cache/" \
   ghcr.io/tofran/advent-of-code-leaderboard-notifier
 ```
 
+It should exit successfully. Run it periodically (at a minimum interval of 15 min),
+or pass the `LOOP_SLEEP_SECONDS` env var to make the script loop.
+
 ### Configuration
 
  - `ADVENT_OF_CODE_LEADERBOARD_ID`: The unique ID of the leaderboard. It's an integer you can get from the end of leaderboard url or the prefix of the invite code.
  - `ADVENT_OF_CODE_SESSION_ID`: Your advent of code session id.  
-    To retrieve it, go visit adventofcode.com, open developer tools > storage > cookies > copy the value of your `session` cookie.
- - `WEBHOOK_URL`: Where to send the webhook. Can be for example a discord webhook.
+    To retrieve it, visit adventofcode.com, open developer tools > storage > cookies > copy the value of your `session` cookie.
+ - `WEBHOOK_URL`: Where to send the webhook. For example a Discord webhook URL.
  - `ADVENT_OF_CODE_YEAR`: Optional, defaults to the current year if already in december, otherwise the previous one.
  - `CACHE_FILE`: Optional, defaults to `./cache.json`
+ - `LOOP_SLEEP_SECONDS`: Optional, defaults to `0`, meaning it only runs once and terminates the process. Otherwise set it to how many seconds to sleep between runs. It is recommended a value greater than `900` (15 min).
+ - `WEBHOOK_MAX_CONTENT_LENGTH`: Optional, the maximum number of characters that can be sent to the webhook. Defaults to `2000`.
 
 
 ## License

advent_of_code_notify.py

@@ -7,10 +7,12 @@
 # tofran, dec 2020
 # https://github.com/tofran/advent-of-code-leaderboard-notifier
 
-import os
-import requests
 import json
+import os
 from datetime import date
+from time import sleep
+
+import requests
 
 LEADERBOARD_ENDPOINT_TEMPLATE = (
     "https://adventofcode.com/"
@@ -27,20 +29,19 @@ def get_default_year():
     return today.year - 1
 
 
-ADVENT_OF_CODE_YEAR = int(os.getenv("ADVENT_OF_CODE_YEAR", get_default_year()))
 ADVENT_OF_CODE_LEADERBOARD_ID = os.getenv("ADVENT_OF_CODE_LEADERBOARD_ID")
 ADVENT_OF_CODE_SESSION_ID = os.getenv("ADVENT_OF_CODE_SESSION_ID")
-
+ADVENT_OF_CODE_YEAR = int(os.getenv("ADVENT_OF_CODE_YEAR", get_default_year()))
+LOOP_SLEEP_SECONDS = int(os.getenv("LOOP_SLEEP_SECONDS", "0"))
+WEBHOOK_MAX_CONTENT_LENGTH = int(os.getenv("WEBHOOK_MAX_CONTENT_LENGTH", "2000"))
 WEBHOOK_URL = os.getenv("WEBHOOK_URL")
 
 assert ADVENT_OF_CODE_LEADERBOARD_ID, "ADVENT_OF_CODE_LEADERBOARD_ID missing"
 assert ADVENT_OF_CODE_SESSION_ID, "ADVENT_OF_CODE_SESSION_ID missing"
 assert WEBHOOK_URL, "WEBHOOK_URL missing"
 
-WEBHOOK_MAX_CONTENT_LENGTH = int(os.getenv("WEBHOOK_MAX_CONTENT_LENGTH", "2000"))
-
 
-def get_leaderboard_enpoint(as_json_api=True):
+def get_leaderboard_endpoint(as_json_api=True):
     return LEADERBOARD_ENDPOINT_TEMPLATE.format(
         year=ADVENT_OF_CODE_YEAR,
         leaderboard_id=ADVENT_OF_CODE_LEADERBOARD_ID,
@@ -67,7 +68,7 @@ def save_cached_leaderboard(data):
 
 def fetch_leaderboard():
     response = requests.get(
-        get_leaderboard_enpoint(as_json_api=True),
+        get_leaderboard_endpoint(as_json_api=True),
         cookies={
             "session": ADVENT_OF_CODE_SESSION_ID
         }
@@ -93,8 +94,8 @@ def get_name(leaderboard, member_id):
 
 def send_webhook_notification(content):
     if len(content) > WEBHOOK_MAX_CONTENT_LENGTH:
-        content = "The diff is too big, check the leaderbord: {}".format(
-            get_leaderboard_enpoint(as_json_api=False)
+        content = "The diff is too big, check the leaderboard: {}".format(
+            get_leaderboard_endpoint(as_json_api=False)
         )
 
     requests.post(
@@ -113,13 +114,14 @@ def get_leaderboard_diff(old_leaderboard, new_leaderboard):
     )
 
 
-def main():
+def run():
     old_leaderboard = get_cached_leaderboard()
     new_leaderboard = fetch_leaderboard()
 
     diff = get_leaderboard_diff(old_leaderboard, new_leaderboard)
 
     if not diff:
+        print("No changes detected.")
         return
 
     messages = [
@@ -131,12 +133,23 @@ def main():
         for member_id, day, part in diff
     ]
 
-    print("Leaderboard chnaged:", messages)
+    print("Leaderboard changed:", messages)
 
     send_webhook_notification("\n".join(messages))
 
     save_cached_leaderboard(new_leaderboard)
 
 
+def main():
+    if LOOP_SLEEP_SECONDS <= 0:
+        run()
+        return
+    
+    while True:
+        run()
+        print(f"Sleeping {LOOP_SLEEP_SECONDS}s")
+        sleep(LOOP_SLEEP_SECONDS)
+
+
 if __name__ == "__main__":
     main()

requirements.txt

@@ -0,0 +1 @@
+requests==2.*