Fix: Expose endpoint with version/hash (#1434)

* fix: address issue #1432

* refactor: use viewsets

Co-authored-by: gabrnavarro <gabrnavarro@users.noreply.github.com>
Co-authored-by: Naramsim <igougi.ui@gmail.com>

Author: gabrnavarro

pokemon_v2/api.py

@@ -1,4 +1,5 @@
 import re
+import subprocess
 from rest_framework import viewsets
 from rest_framework.response import Response
 from rest_framework.views import APIView
@@ -1058,3 +1059,62 @@ def get(self, request, pokemon_id):
             )
 
         return Response(encounters_list)
+
+
+@extend_schema(
+    description="Returns metadata about the current deployed version of the API, including the git commit hash, deploy date, and tag (if any).",
+    tags=["utility"],
+    responses={
+        200: {
+            "type": "object",
+            "properties": {
+                "deploy_date": {"type": "string", "nullable": True},
+                "hash": {"type": "string", "nullable": True},
+                "tag": {"type": "string", "nullable": True},
+            },
+        }
+    },
+)
+class PokeapiMetaViewset(viewsets.ViewSet):
+    def list(self, request):
+        try:
+            git_hash = (
+                subprocess.check_output(
+                    ["git", "rev-parse", "HEAD"], stderr=subprocess.DEVNULL
+                )
+                .decode()
+                .strip()
+            )
+        except Exception:
+            git_hash = None
+
+        try:
+            deploy_date = (
+                subprocess.check_output(
+                    ["git", "log", "-1", "--format=%cI"], stderr=subprocess.DEVNULL
+                )
+                .decode()
+                .strip()
+            )
+        except Exception:
+            deploy_date = None
+
+        try:
+            tag_output = (
+                subprocess.check_output(
+                    ["git", "tag", "--points-at", "HEAD"], stderr=subprocess.DEVNULL
+                )
+                .decode()
+                .strip()
+            )
+            tag = tag_output if tag_output else None
+        except Exception:
+            tag = None
+
+        return Response(
+            {
+                "deploy_date": deploy_date,
+                "hash": git_hash,
+                "tag": tag,
+            }
+        )

pokemon_v2/tests.py

@@ -1,4 +1,5 @@
 import json
+from datetime import datetime
 from rest_framework import status
 from rest_framework.test import APITestCase
 from pokemon_v2.models import *
@@ -5855,3 +5856,12 @@ def test_case_insensitive_api(self):
         self.assertEqual(uppercase_response.status_code, status.HTTP_200_OK)
 
         self.assertEqual(lowercase_response.data, uppercase_response.data)
+
+    # Meta Tests
+    def test_meta_api(self):
+        response = self.client.get("{}/meta/".format(API_V2))
+        self.assertEqual(response.status_code, status.HTTP_200_OK)
+        self.assertTrue(datetime.fromisoformat(response.data["deploy_date"]))
+        self.assertEqual(25, len(response.data["deploy_date"]))
+        self.assertEqual(40, len(response.data["hash"]))
+        self.assertIn("tag", response.data)

pokemon_v2/urls.py

@@ -38,6 +38,7 @@
 router.register(r"location", LocationResource)
 router.register(r"location-area", LocationAreaResource)
 router.register(r"machine", MachineResource)
+router.register(r"meta", PokeapiMetaViewset, basename="meta")
 router.register(r"move", MoveResource)
 router.register(r"move-ailment", MoveMetaAilmentResource)
 router.register(r"move-battle-style", MoveBattleStyleResource)