feat: short link back end

Author: arcstur

infographics/urls.py

@@ -22,6 +22,7 @@
 
 from web import urls as web_urls
 from api import urls as api_urls
+from shortlink import urls as shortlink_urls
 
 redirect_to_infographics = RedirectView.as_view(url="/web/infographics/")
 
@@ -30,4 +31,6 @@
     path("", redirect_to_infographics),
     path("web/", include(web_urls)),
     path("api/", include(api_urls)),
+    path("api2/", include(api_urls)),
+    path("s/", include(shortlink_urls)),
 ]

shortlink/admin.py

@@ -1,7 +1,15 @@
 from django.contrib import admin
+from django.utils.html import format_html
+
 
 from shortlink.models import ShortLink
 
+
 @admin.register(ShortLink)
 class ShortLinkAdmin(admin.ModelAdmin):
-    list_display = ["id", "query"]
+    list_display = ["id", "url", "query"]
+
+    def url(self, obj):
+        encoded = obj.encoded_id()
+        link = f"/s/{encoded}/"
+        return format_html(f'<a href="{link}">{link}/</a>')

shortlink/models.py

@@ -17,6 +17,12 @@ def encoded_id_from_query(self, query):
         return self.encode(short_link.id)
 
     def query_from_encoded_id(self, encoded):
+        """
+        Can raise
+
+        - ShortLink.DoesNotExist
+        - IndexError
+        """
         id = self.decode(encoded)
         return self.get(id=id).query
 
@@ -25,3 +31,6 @@ class ShortLink(models.Model):
     query = models.TextField()
 
     objects = ShortLinkManager()
+
+    def encoded_id(self):
+        return ShortLink.objects.encode(self.id)

shortlink/tests.py

@@ -32,3 +32,31 @@ def test_existant_query(self):
             ShortLink.objects.decode(encoded),
             ShortLink.objects.decode(encoded2),
         )
+
+    def test_url(self):
+        encoded = ShortLink.objects.encoded_id_from_query("abc def\nghi")
+        res = self.client.get(f"/s/{encoded}/")
+        self.assertEqual(res.status_code, 302)
+        self.assertEqual(
+            res.headers["Location"],
+            "/web/infographics/?query=abc%20def%0Aghi",
+        )
+        res = self.client.get("/s/abc/")
+        self.assertEqual(res.status_code, 404)
+        ShortLink.objects.all().delete()
+        res = self.client.get(f"/s/{encoded}/")
+        self.assertEqual(res.status_code, 404)
+
+    def test_generate(self):
+        query = "SELECT\n?abc"
+        res = self.client.post("/s/generate/", {"query": query})
+        self.assertEqual(res.status_code, 201)
+        encoded = ShortLink.objects.encoded_id_from_query(query)
+        url = f"/s/{encoded}/"
+        self.assertEqual(res.json(), {"url": url})
+        res = self.client.get(url)
+        self.assertEqual(res.status_code, 302)
+        self.assertEqual(
+            res.headers["Location"],
+            "/web/infographics/?query=SELECT%0A?abc",
+        )

shortlink/urls.py

@@ -0,0 +1,9 @@
+from django.urls import path
+
+from .views import redirect_to_query
+from .views import get_short_link
+
+urlpatterns = [
+    path("generate/", get_short_link, name="get_short_link"),
+    path("<str:encoded_id>/", redirect_to_query, name="shortlink"),
+]

shortlink/views.py

@@ -1,3 +1,27 @@
-from django.shortcuts import render
+from django.shortcuts import redirect
+from django.shortcuts import reverse
+from django.http import HttpResponse
+from django.http import JsonResponse
+from django.views.decorators.http import require_POST
+from django.views.decorators.http import require_safe
+from django.views.decorators.csrf import csrf_exempt
 
-# Create your views here.
+from shortlink.models import ShortLink
+
+@require_safe
+def redirect_to_query(request, encoded_id: str):
+    try:
+        query = ShortLink.objects.query_from_encoded_id(encoded_id)
+    except (ShortLink.DoesNotExist, IndexError):
+        return HttpResponse(status=404)
+    url = reverse("main")
+    return redirect(url + f"?query={query}")
+
+
+@csrf_exempt
+@require_POST
+def get_short_link(request):
+    query = request.POST["query"]
+    encoded = ShortLink.objects.encoded_id_from_query(query)
+    url = reverse("shortlink", kwargs={"encoded_id": encoded})
+    return JsonResponse({"url": url}, status=201)

web/urls.py

@@ -4,5 +4,5 @@
 
 urlpatterns = [
     path("", render_react_index),
-    path("infographics/", render_react_index),
+    path("infographics/", render_react_index, name="main"),
 ]