Merge pull request #23 from CodeForPhilly/third-places-12

Add initial user endpoints

Author: zimurgh

CHANGELOG.md

@@ -13,6 +13,7 @@ and this project adheres to release number versioning.
 - Added Docker containers with docker-compose [#10](https://github.com/CodeForPhilly/third-places/pull/10)
 - Set up Leaflet React component and boiletplate homepage[#7](https://github.com/CodeForPhilly/third-places/issues/7)
 - Added initial Django models & migration [#21](https://github.com/CodeForPhilly/third-places/pull/21)
+- Added initial REST endpoints for Users [#23](https://github.com/CodeForPhilly/third-places/pull/23)
 - Added buttons at bottom of Map [#40](https://github.com/CodeForPhilly/third-places/pull/40)
 
 ### Changed

README.md

@@ -67,4 +67,6 @@ Access the following ports from localhost to access their respective services
 
 ### Api Reference
 
-`/api/`: Hello world!
+- `/api/`: Hello world!
+- `/users/`: `GET`, `POST` users
+- `/users/{id}`: `GET`, `PUT` specific user details

src/django/api/admin.py

@@ -1,3 +1,4 @@
 from django.contrib import admin
+from .models import ThirdPlaceUser
 
-# Register your models here.
+admin.site.register(ThirdPlaceUser)

src/django/api/migrations/0001_initial.py

@@ -1,4 +1,4 @@
-# Generated by Django 4.2 on 2023-05-03 04:05
+# Generated by Django 4.2 on 2023-05-05 01:40
 
 import django.contrib.gis.db.models.fields
 from django.db import migrations, models
@@ -31,8 +31,8 @@ class Migration(migrations.Migration):
                 ('name', models.TextField()),
                 ('address', models.TextField()),
                 ('price_category', models.CharField(max_length=5)),
-                ('created_datetime', models.DateTimeField()),
-                ('modified_datetime', models.DateTimeField()),
+                ('created_datetime', models.DateTimeField(auto_now_add=True)),
+                ('modified_datetime', models.DateTimeField(auto_now=True)),
                 ('hours', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to='api.businesshours')),
             ],
         ),
@@ -60,9 +60,10 @@ class Migration(migrations.Migration):
                 ('last_login', models.DateTimeField(blank=True, null=True, verbose_name='last login')),
                 ('is_superuser', models.BooleanField(default=False, help_text='Designates that this user has all permissions without explicitly assigning them.', verbose_name='superuser status')),
                 ('email', models.EmailField(max_length=254, unique=True)),
+                ('username', models.CharField(max_length=150, unique=True)),
                 ('display_name', models.TextField()),
-                ('created_datetime', models.DateTimeField()),
-                ('modified_datetime', models.DateTimeField()),
+                ('created_datetime', models.DateTimeField(auto_now_add=True)),
+                ('modified_datetime', models.DateTimeField(auto_now=True)),
                 ('groups', models.ManyToManyField(blank=True, help_text='The groups this user belongs to. A user will get all permissions granted to each of their groups.', related_name='thirdplaceuser_groups', related_query_name='thirdplaceuser', to='auth.group', verbose_name='groups')),
                 ('user_permissions', models.ManyToManyField(blank=True, help_text='Specific permissions for this user.', related_name='thirdplaceuser_user_permissions', related_query_name='thirdplaceuser', to='auth.permission', verbose_name='user permissions')),
             ],
@@ -76,8 +77,8 @@ class Migration(migrations.Migration):
                 ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
                 ('name', models.TextField()),
                 ('value', models.DecimalField(decimal_places=1, max_digits=2)),
-                ('created_datetime', models.DateTimeField()),
-                ('modified_datetime', models.DateTimeField()),
+                ('created_datetime', models.DateTimeField(auto_now_add=True)),
+                ('modified_datetime', models.DateTimeField(auto_now=True)),
                 ('locations', models.ManyToManyField(related_name='tags', to='api.location')),
                 ('tag_type', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to='api.tagtype')),
             ],

src/django/api/models.py

@@ -53,8 +53,8 @@ class Location(models.Model):
     hours = models.ForeignKey(BusinessHours, on_delete=models.CASCADE)
     location_type = models.ForeignKey(LocationType, on_delete=models.CASCADE)
     price_category = models.CharField(max_length=5)
-    created_datetime = models.DateTimeField()
-    modified_datetime = models.DateTimeField()
+    created_datetime = models.DateTimeField(auto_now_add=True)
+    modified_datetime = models.DateTimeField(auto_now=True)
 
     REQUIRED_FIELDS = ["location", "location_type", "created_datetime", "modified_datetime"]
 
@@ -67,8 +67,8 @@ class Tag(models.Model):
     locations = models.ManyToManyField(Location, related_name='tags')
     tag_type = models.ForeignKey(TagType, on_delete=models.CASCADE)
     value = models.DecimalField(decimal_places=1, max_digits=2)
-    created_datetime = models.DateTimeField()
-    modified_datetime = models.DateTimeField()
+    created_datetime = models.DateTimeField(auto_now_add=True)
+    modified_datetime = models.DateTimeField(auto_now=True)
 
     REQUIRED_FIELDS = ["name", "tag_type", "value", "created_datetime", "modified_datetime"]
 
@@ -78,9 +78,10 @@ def __str__(self):
 
 class ThirdPlaceUser(AbstractBaseUser, PermissionsMixin):
     email = models.EmailField(unique=True)
+    username = models.CharField(max_length=150, unique=True)
     display_name = models.TextField()
-    created_datetime = models.DateTimeField()
-    modified_datetime = models.DateTimeField()
+    created_datetime = models.DateTimeField(auto_now_add=True)
+    modified_datetime = models.DateTimeField(auto_now=True)
 
     groups = models.ManyToManyField(
         Group,

src/django/api/serializers.py

@@ -0,0 +1,39 @@
+import datetime
+
+from rest_framework import serializers
+from .models import ThirdPlaceUser
+
+
+class ThirdPlaceUserSerializer(serializers.ModelSerializer):
+    password = serializers.CharField(write_only=True)
+    display_name = serializers.CharField(required=False)
+    created_datetime = serializers.DateTimeField(read_only=True, initial=datetime.datetime)
+    modified_datetime = serializers.DateTimeField(read_only=True, initial=datetime.datetime)
+
+    class Meta:
+        model = ThirdPlaceUser
+        fields = (
+            "username",
+            "email",
+            "password",
+            "display_name",
+            "created_datetime",
+            "modified_datetime"
+        )
+
+
+
+class ThirdPlaceUserPutSerializer(serializers.ModelSerializer):
+    username = serializers.CharField(required=False)
+    email = serializers.EmailField(required=False)
+    password = serializers.CharField(write_only=True, required=False)
+    display_name = serializers.CharField(required=False)
+
+    class Meta:
+        model = ThirdPlaceUser
+        fields = (
+            "username",
+            "email",
+            "password",
+            "display_name",
+        )

src/django/api/urls.py

@@ -1,7 +1,11 @@
 from django.urls import path
-
+from rest_framework.urlpatterns import format_suffix_patterns
 from . import views
 
 urlpatterns = [
     path("", views.index, name="index"),
+    path("users/", views.third_place_user_list),
+    path("users/<int:pk>", views.third_place_user_detail)
 ]
+
+urlpatterns = format_suffix_patterns(urlpatterns)

src/django/api/views.py

@@ -1,5 +1,45 @@
 from django.http import HttpResponse
+from rest_framework import status
+from rest_framework.decorators import api_view
+from rest_framework.response import Response
+from .serializers import ThirdPlaceUserSerializer, ThirdPlaceUserPutSerializer
+from .models import ThirdPlaceUser
 
 
 def index(request):
     return HttpResponse("Hello, world!")
+
+
+@api_view(['GET', 'POST'])
+def third_place_user_list(request):
+    if request.method == 'GET':
+        users = ThirdPlaceUser.objects.all()
+        serializer = ThirdPlaceUserSerializer(users, many=True)
+        return Response(serializer.data)
+
+    elif request.method == 'POST':
+        serializer = ThirdPlaceUserSerializer(data=request.data)
+        if serializer.is_valid():
+            serializer.save()
+            return Response(serializer.data, status=status.HTTP_201_CREATED)
+        return Response(serializer.errors, status=status.HTTP_400_BAD_REQUEST)
+
+
+@api_view(['GET', 'PUT'])
+def third_place_user_detail(request, pk):
+    try:
+        user = ThirdPlaceUser.objects.get(pk=pk)
+    except ThirdPlaceUser.DoesNotExist:
+        return Response(status=status.HTTP_404_NOT_FOUND)
+
+    if request.method == 'GET':
+        serializer = ThirdPlaceUserSerializer(user)
+        return Response(serializer.data)
+
+    elif request.method == 'PUT':
+        serializer = ThirdPlaceUserPutSerializer(user, data=request.data)
+        if serializer.is_valid():
+            serializer.save()
+            return Response(serializer.data)
+        return Response(serializer.errors, status=status.HTTP_400_BAD_REQUEST)
+

src/django/thirdplaces/settings.py

@@ -38,6 +38,7 @@
     "django.contrib.sessions",
     "django.contrib.messages",
     "django.contrib.staticfiles",
+    "rest_framework",
     "api"
 ]