Login with GitHub

.gitignore

@@ -166,3 +166,6 @@ cython_debug/
 
 # Django
 static/
+
+# 0Auth app
+.env

Pipfile

@@ -30,6 +30,7 @@ codeforlife = {ref = "v0.18.0", git = "https://github.com/ocadotechnology/codefo
 codeforlife = {ref = "v0.18.0", git = "https://github.com/ocadotechnology/codeforlife-package-python.git", extras = ["dev"]}
 # codeforlife = {file = "../codeforlife-package-python", editable = true, extras = ["dev"]}
 # 🚫 Don't add [dev-packages] below that are inherited from the CFL package.
+python-dotenv = "==1.0.1"
 
 [requires]
 python_version = "3.8"

api/migrations/0001_initial.py

@@ -1,4 +1,4 @@
-# Generated by Django 3.2.25 on 2024-07-22 14:17
+# Generated by Django 3.2.25 on 2024-07-23 13:03
 
 import django.core.validators
 from django.db import migrations, models
@@ -19,7 +19,7 @@ class Migration(migrations.Migration):
                 ('id', models.IntegerField(help_text="The contributor's GitHub user-ID.", primary_key=True, serialize=False)),
                 ('email', models.EmailField(max_length=254, verbose_name='email')),
                 ('name', models.TextField(verbose_name='name')),
-                ('location', models.TextField(verbose_name='location')),
+                ('location', models.TextField(null=True, verbose_name='location')),
                 ('html_url', models.TextField(verbose_name='html url')),
                 ('avatar_url', models.TextField(verbose_name='avatar url')),
             ],

api/models/contributor.py

@@ -23,7 +23,7 @@ class Contributor(models.Model):
     )
     email = models.EmailField(_("email"))
     name = models.TextField(_("name"))
-    location = models.TextField(_("location"))
+    location = models.TextField(_("location"), null=True)
     html_url = models.TextField(_("html url"))
     avatar_url = models.TextField(_("avatar url"))
 

api/serializers/agreement_signature.py

@@ -19,6 +19,8 @@
 # pylint: disable=missing-function-docstring
 # pylint: disable=too-many-ancestors
 
+# pylint: disable-next=missing-function-docstring,too-many-ancestors
+
 
 class AgreementSignatureSerializer(ModelSerializer[User, AgreementSignature]):
     class Meta:

api/views/contributor.py

@@ -3,17 +3,100 @@
 Created on 16/07/2024 at 11:03:09(+01:00).
 """
 
+import requests
 from codeforlife.permissions import AllowAny
+from codeforlife.request import Request
+from codeforlife.response import Response
 from codeforlife.user.models import User
-from codeforlife.views import ModelViewSet
+from codeforlife.views import ModelViewSet, action
+from rest_framework import status
+
+import settings
 
 from ..models import Contributor
 from ..serializers import ContributorSerializer
 
 
 # pylint: disable-next=missing-class-docstring,too-many-ancestors
 class ContributorViewSet(ModelViewSet[User, Contributor]):
-    http_method_names = ["get", "post"]
+    http_method_names = ["get", "post", "delete"]
     permission_classes = [AllowAny]
     serializer_class = ContributorSerializer
     queryset = Contributor.objects.all()
+
+    @action(detail=False, methods=["get"])
+    def log_into_github(self, request: Request):
+        """Users can login using their existing github account"""
+        # Get code from login request
+        if not request.GET.get("code"):
+            return Response(status=status.HTTP_500_INTERNAL_SERVER_ERROR)
+
+        # Get user access Token
+        access_token_request = requests.post(
+            url="https://github.com/login/oauth/access_token",
+            headers={"Accept": "application/json"},
+            params={
+                "client_id": settings.GITHUB_CLIENT_ID,
+                "client_secret": settings.GITHUB_CLIENT_SECRET,
+                "code": request.GET.get("code"),
+            },
+            timeout=5,
+        )
+
+        if not access_token_request.ok:
+            return Response(status=status.HTTP_500_INTERNAL_SERVER_ERROR)
+        auth_data = access_token_request.json()
+
+        # Code expired
+        if "access_token" not in auth_data:
+            return Response(
+                status=status.HTTP_451_UNAVAILABLE_FOR_LEGAL_REASONS
+            )
+
+        access_token = auth_data["access_token"]
+        token_type = auth_data["token_type"]
+
+        # Get user's information
+        user_data_request = requests.get(
+            url="https://api.github.com/user",
+            headers={
+                "Accept": "application/json",
+                "Authorization": f"{token_type} {access_token}",
+            },
+            timeout=5,
+        )
+
+        user_data = user_data_request.json()
+        if not user_data["email"]:
+            return Response(
+                data="Email null",
+                status=status.HTTP_451_UNAVAILABLE_FOR_LEGAL_REASONS,
+            )
+
+        # Check if user is already a contributor
+        gh_id = user_data["id"]
+        contributor_data = {
+            "id": gh_id,
+            "email": user_data["email"],
+            "name": user_data["name"],
+            "location": user_data["location"],
+            "html_url": user_data["html_url"],
+            "avatar_url": user_data["avatar_url"],
+        }
+
+        try:
+            # Update an existing contributor
+            contributor = Contributor.objects.get(pk=gh_id)
+            serializer = ContributorSerializer(
+                contributor, data=contributor_data
+            )
+        except Contributor.DoesNotExist:
+            # Create a new contributor
+            serializer = ContributorSerializer(data=contributor_data)
+
+        if serializer.is_valid():
+            serializer.save()
+            return Response(status=status.HTTP_200_OK)
+        return Response(
+            status=status.HTTP_451_UNAVAILABLE_FOR_LEGAL_REASONS,
+        )