Merge pull request #44 from CodeForPhilly/ts/add-location-endpoints

Add location endpoints

Author: travissouthard

CHANGELOG.md

@@ -11,6 +11,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - 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)
+- Add location endpoints [#44](https://github.com/CodeForPhilly/third-places/pull/44)
 
 ### Changed
 

src/django/api/admin.py

@@ -1,4 +1,20 @@
 from django.contrib import admin
-from .models import ThirdPlaceUser
+from .models import BusinessHours, Location, LocationType, Tag, TagType, ThirdPlaceUser
 
 admin.site.register(ThirdPlaceUser)
+admin.site.register(BusinessHours)
+admin.site.register(LocationType)
+admin.site.register(Tag)
+admin.site.register(TagType)
+
+@admin.register(Location)
+class LocationAdmin(admin.ModelAdmin):
+    fields = (
+            'name',
+            'address',
+            'hours',
+            'location_type',
+            'price_category',
+            'tags',
+            'location'
+        )

src/django/api/migrations/0002_adjust_biz_hours_and_location_relation.py

@@ -0,0 +1,31 @@
+# Generated by Django 4.2 on 2023-05-09 14:41
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('api', '0001_initial'),
+    ]
+
+    operations = [
+        migrations.RemoveField(
+            model_name='tag',
+            name='locations',
+        ),
+        migrations.AddField(
+            model_name='location',
+            name='tags',
+            field=models.ManyToManyField(related_name='tags', to='api.tag'),
+        ),
+        migrations.RemoveField(
+            model_name='location',
+            name='hours',
+        ),
+        migrations.AddField(
+            model_name='location',
+            name='hours',
+            field=models.ManyToManyField(blank=True, related_name='locations', to='api.businesshours'),
+        ),
+    ]

src/django/api/models.py

@@ -46,31 +46,31 @@ def __str__(self):
         return self.code
 
 
-class Location(models.Model):
-    location = gis_models.PointField()
+class Tag(models.Model):
     name = models.TextField()
-    address = models.TextField()
-    hours = models.ForeignKey(BusinessHours, on_delete=models.CASCADE)
-    location_type = models.ForeignKey(LocationType, on_delete=models.CASCADE)
-    price_category = models.CharField(max_length=5)
+    tag_type = models.ForeignKey(TagType, on_delete=models.CASCADE)
+    value = models.DecimalField(decimal_places=1, max_digits=2)
     created_datetime = models.DateTimeField(auto_now_add=True)
     modified_datetime = models.DateTimeField(auto_now=True)
 
-    REQUIRED_FIELDS = ["location", "location_type", "created_datetime", "modified_datetime"]
+    REQUIRED_FIELDS = ["name", "tag_type", "value", "created_datetime", "modified_datetime"]
 
     def __str__(self):
         return self.name
 
 
-class Tag(models.Model):
+class Location(models.Model):
+    location = gis_models.PointField(srid=4326)
     name = models.TextField()
-    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)
+    address = models.TextField()
+    hours = models.ManyToManyField(BusinessHours, related_name='locations', blank=True)
+    location_type = models.ForeignKey(LocationType, on_delete=models.CASCADE)
+    tags = models.ManyToManyField(Tag, related_name='tags')
+    price_category = models.CharField(max_length=5)
     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"]
+    REQUIRED_FIELDS = ["location", "location_type", "created_datetime", "modified_datetime"]
 
     def __str__(self):
         return self.name

src/django/api/serializers.py

@@ -1,9 +1,106 @@
 import datetime
 
 from rest_framework import serializers
-from .models import ThirdPlaceUser
+from rest_framework_gis import serializers as gis_serializers
+from .models import BusinessHours, Location, LocationType, ThirdPlaceUser, Tag, TagType
 
 
+class BusinessHoursSerializer(serializers.ModelSerializer):
+    day = serializers.CharField()
+    open_time = serializers.TimeField(required=False)
+    close_time = serializers.TimeField(required=False)
+
+    class Meta:
+        model = BusinessHours
+        fields = (
+            "day",
+            "open_time",
+            "close_time"
+        )
+
+
+class LocationTypeSerializer(serializers.ModelSerializer):
+    code = serializers.CharField()
+    name = serializers.CharField()
+
+    class Meta:
+        model = LocationType
+        fields = (
+            "code",
+            "name"
+        )
+
+
+class TagTypeSerializer(serializers.ModelSerializer):
+    code = serializers.CharField()
+    name = serializers.CharField()
+
+    class Meta:
+        model = TagType
+        fields = (
+            "code",
+            "name"
+        )
+
+
+class TagSerializer(serializers.ModelSerializer):
+    name = serializers.CharField()
+    tag_type = TagTypeSerializer()
+    value = serializers.DecimalField(decimal_places=1, max_digits=2)
+    created_datetime = serializers.DateTimeField(read_only=True, initial=datetime.datetime)
+    modified_datetime = serializers.DateTimeField(read_only=True, initial=datetime.datetime)
+
+    class Meta:
+        model = Tag
+        fields = (
+            "name",
+            "tag_type",
+            "value",
+            "created_datetime",
+            "modified_datetime"
+            )
+    
+    def create(self, validated_data):
+        tag_type_data = validated_data.pop("tag_type")
+        tag_types = TagType.objects.create(**tag_type_data)
+        return Tag.objects.create(tag_types, **validated_data)
+
+
+class LocationSerializer(gis_serializers.GeoFeatureModelSerializer):
+    name = serializers.CharField()
+    address = serializers.CharField()
+    hours = BusinessHoursSerializer(many=True)
+    location_type = LocationTypeSerializer()
+    tags = TagSerializer(many=True)
+    created_datetime = serializers.DateTimeField(read_only=True, initial=datetime.datetime)
+    modified_datetime = serializers.DateTimeField(read_only=True, initial=datetime.datetime)
+
+    class Meta:
+        model = Location
+        geo_field="location"
+        fields = (
+            "name",
+            "address",
+            "hours",
+            "location_type",
+            "price_category",
+            "tags",
+            "created_datetime",
+            "modified_datetime"
+        )
+
+    def create(self, validated_data):
+        hours_data = validated_data.pop("hours")
+        location_type_data = validated_data.pop("location_type")
+        tags_data = validated_data.pop("tags")
+        location_type = LocationType.objects.create(**location_type_data)
+        location = Location.objects.create(location_type=location_type, **validated_data)
+        for hours_datum in hours_data:
+            BusinessHoursSerializer(hours_datum)
+        for tag_data in tags_data: 
+            TagSerializer(tag_data)
+        return location
+
 class ThirdPlaceUserSerializer(serializers.ModelSerializer):
     password = serializers.CharField(write_only=True)
     display_name = serializers.CharField(required=False)

src/django/api/urls.py

@@ -4,6 +4,8 @@
 
 urlpatterns = [
     path("", views.index, name="index"),
+    path("locations/", views.location_list),
+    path("locations/<int:pk>", views.location_detail),
     path("users/", views.third_place_user_list),
     path("users/<int:pk>", views.third_place_user_detail)
 ]

src/django/api/views.py

@@ -2,14 +2,34 @@
 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
+from .serializers import LocationSerializer, ThirdPlaceUserSerializer, ThirdPlaceUserPutSerializer
+from .models import Location, ThirdPlaceUser
 
 
 def index(request):
     return HttpResponse("Hello, world!")
 
 
+@api_view(['GET'])
+def location_list(request):
+    if request.method == 'GET':
+        locations = Location.objects.all()
+        serializer = LocationSerializer(locations, many=True)
+        return Response(serializer.data)
+
+
+@api_view(['GET'])
+def location_detail(request, pk):
+    try:
+        user = Location.objects.get(pk=pk)
+    except Location.DoesNotExist:
+        return Response(status=status.HTTP_404_NOT_FOUND)
+
+    if request.method == 'GET':
+        serializer = LocationSerializer(user)
+        return Response(serializer.data)
+
+
 @api_view(['GET', 'POST'])
 def third_place_user_list(request):
     if request.method == 'GET':

src/django/thirdplaces/settings.py

@@ -35,10 +35,12 @@
     "django.contrib.admin",
     "django.contrib.auth",
     "django.contrib.contenttypes",
+    "django.contrib.gis",
     "django.contrib.sessions",
     "django.contrib.messages",
     "django.contrib.staticfiles",
     "rest_framework",
+    "rest_framework_gis",
     "api"
 ]