Add challenge language endpoints

Pipfile

@@ -15,7 +15,7 @@ pytest-asyncio = "*"
 [packages]
 pyjwt = "*"
 postdb = "*"
-aiohttp = "*"
+aiohttp = "~=3.7"
 fastapi = "*"
 aioredis = "*"
 fakeredis = "*"

README.md

@@ -72,6 +72,8 @@ pipenv install --dev
 
 ### Environment variables
 
+#### Required
+
 Start by writing this in a file named `.env`:
 
 ```prolog
@@ -85,15 +87,22 @@ DISCORD_CLIENT_SECRET=
 And fill in the variables with the values below:
 
 - `REDIS_URI` is the Redis server URI.
-- `POSTGRES_URI` is the PostgreSQL database URI.
 - `SECRET_KEY` is the key used for JWT token encoding.
-- `TEST_REDIS_URU` is the Connection URI for Redis testing server.
-- `TEST_POSTGRES_URI` is the PostgreSQL database URI for tests.
+- `POSTGRES_URI` is the PostgreSQL database URI.
 - `DISCORD_CLIENT_ID` is the Discord application ID. Copy it from your Discord application page (see below).
 - `DISCORD_CLIENT_SECRET` is the Discord application secret. Copy it from your Discord application page (see below).
 
 ![Client ID and secret](https://cdn.discordapp.com/attachments/721750194797936823/794646777840140298/unknown.png)
 
+#### Optional
+
+For testing you need to add these environment variables:
+
+- `TEST_REDIS_URI` is the Connection URI for Redis testing server.
+- `TEST_POSTGRES_URI` is the PostgreSQL database URI for tests.
+
+If you are self hosting the Piston API, you need to set the `PISTON_URL` environment variable.
+
 ### Running
 
 Run the API and initialise the database:

api/services/http.py

@@ -2,6 +2,6 @@
 from typing import Optional
 
 
-session: Optional[ClientSession] = None
+__all__ = ("session",)
 
-__all__ = (session,)
+session: Optional[ClientSession] = None

api/services/piston.py

@@ -0,0 +1,68 @@
+import logging
+from typing import Any, Dict, List
+
+import config
+from api.services import http
+
+
+__all__ = ("get_runtimes", "get_runtimes_dict", "get_runtime", "Runtime")
+
+log = logging.getLogger()
+
+_base_url: str = (
+    config.piston_url().rstrip("/") + "/"
+)  # make sure there's a / at the end
+
+
+async def _make_request(method: str, endpoint: str, data: Any = None) -> Any:
+    async with http.session.request(
+        method,
+        _base_url + endpoint,
+        json=data,
+        raise_for_status=True,
+    ) as response:
+        return await response.json()
+
+
+async def get_runtimes() -> List["Runtime"]:
+    """Get a list of all available runtimes."""
+    runtimes = await _make_request("GET", "runtimes")
+    return [Runtime(runtime) for runtime in runtimes]
+
+
+async def get_runtimes_dict() -> Dict[str, List["Runtime"]]:
+    """Get a dictionary of language names and aliases mapped to a list of
+    all the runtimes with that name or alias.
+    """
+
+    runtimes = await get_runtimes()
+    runtimes_dict = {}
+
+    for runtime in runtimes:
+        if runtime.language in runtimes_dict:
+            runtimes_dict[runtime.language].append(runtime)
+        else:
+            runtimes_dict[runtime.language] = [runtime]
+
+        for alias in runtime.aliases:
+            if alias in runtimes_dict:
+                runtimes_dict[alias].append(runtime)
+            else:
+                runtimes_dict[alias] = [runtime]
+
+    return runtimes_dict
+
+
+async def get_runtime(language: str) -> List["Runtime"]:
+    """Get a runtime with a language or an alias."""
+
+    runtimes_dict = await get_runtimes_dict()
+    return runtimes_dict.get(language, [])
+
+
+class Runtime:
+    def __init__(self, data: dict):
+        self.language = data["language"]
+        self.version = data["version"]
+        self.aliases = data["aliases"]
+        self.runtime = data.get("runtime")

api/services/redis.py

@@ -6,6 +6,8 @@
 import json
 
 
+__all__ = ("pool",)
+
 log = logging.getLogger(__name__)
 
 
@@ -22,6 +24,3 @@ async def dispatch(channel: ChannelT, message: Union[EncodableT, list, dict]) ->
 
 
 pool: Optional[Union[FakeRedis, Redis]] = None
-
-
-__all__ = (pool,)

api/versions/v1/routers/challenges/__init__.py

@@ -0,0 +1,6 @@
+from . import languages
+from .routes import router
+
+router.include_router(languages.router)
+
+__all__ = (router,)

api/versions/v1/routers/challenges/languages/__init__.py

@@ -0,0 +1,3 @@
+from .routes import router
+
+__all__ = (router,)

api/versions/v1/routers/challenges/languages/helpers.py

@@ -0,0 +1,18 @@
+from fastapi import HTTPException
+
+from api.services import piston
+
+
+async def check_piston_language_version(language: str, version: str):
+    """Checks if a language and its version are installed on the Piston service.
+
+    Raises an :class:`fastapi.HTTPException` otherwise with a 404 status code.
+    """
+
+    runtimes = await piston.get_runtime(language)
+    if not runtimes:
+        raise HTTPException(404, "Piston language not found")
+
+    versions = [runtime.version for runtime in runtimes]
+    if version not in versions:
+        raise HTTPException(404, "Piston language version not found")

api/versions/v1/routers/challenges/languages/models.py

@@ -0,0 +1,28 @@
+from typing import Optional
+
+from pydantic import BaseModel, Field, HttpUrl
+
+
+class ChallengeLanguageResponse(BaseModel):
+    id: str
+    name: str
+    download_url: Optional[HttpUrl]
+    disabled: bool = False
+    piston_lang: str
+    piston_lang_ver: str
+
+
+class NewChallengeLanguageBody(BaseModel):
+    name: str = Field(..., min_length=4, max_length=32)
+    download_url: Optional[HttpUrl] = None
+    disabled: bool = False
+    piston_lang: str
+    piston_lang_ver: str
+
+
+class UpdateChallengeLanguageBody(BaseModel):
+    name: str = Field("", min_length=4, max_length=32)
+    download_url: Optional[HttpUrl] = None
+    disabled: bool = False
+    piston_lang: str = ""
+    piston_lang_ver: str = ""