-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathserializers.py
More file actions
412 lines (340 loc) · 12.5 KB
/
serializers.py
File metadata and controls
412 lines (340 loc) · 12.5 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
from django.contrib.auth import get_user_model
from django.core.exceptions import ValidationError as ModelValidationError
from profanity_check import predict
from rest_framework.serializers import (
BooleanField,
DateTimeField,
ImageField,
ModelSerializer,
SerializerMethodField,
SlugRelatedField,
URLField,
ValidationError,
)
from market.mixins import ListingTypeMixin
from market.models import Category, Item, Listing, ListingImage, Offer, Sublet, Tag
User = get_user_model()
class UserSerializer(ModelSerializer):
class Meta:
model = User
fields = [
"id",
"username",
"first_name",
"last_name",
"email",
"phone_number",
"phone_verified",
]
read_only_fields = fields
class TagSerializer(ModelSerializer):
class Meta:
model = Tag
fields = ["name"]
read_only_fields = fields
class OfferSerializer(ModelSerializer):
user = UserSerializer(read_only=True)
class Meta:
model = Offer
fields = [
"id",
"user",
"listing",
"offered_price",
"message",
"created_at",
]
read_only_fields = ["id", "created_at", "user"]
def create(self, validated_data):
validated_data["user"] = self.context["request"].user
return super().create(validated_data)
# Create/Update Image Serializer
class ListingImageSerializer(ModelSerializer):
image = ImageField(write_only=True, required=False, allow_null=True)
class Meta:
model = ListingImage
fields = "__all__"
# Browse images
class ListingImageURLSerializer(ModelSerializer):
image_url = SerializerMethodField()
def get_image_url(self, obj):
image = obj.image
if not image:
return None
if image.url.startswith("http"):
return image.url
elif "request" in self.context:
return self.context["request"].build_absolute_uri(image.url)
else:
return image.url
class Meta:
model = ListingImage
fields = "__all__"
read_only_fields = [field.name for field in model._meta.fields]
class ItemDataSerializer(ModelSerializer):
category = SlugRelatedField(slug_field="name", read_only=True)
condition = SerializerMethodField()
class Meta:
model = Item
fields = ["condition", "category"]
def get_condition(self, obj):
return obj.get_condition_display()
class SubletDataSerializer(ModelSerializer):
class Meta:
model = Sublet
fields = ["street_address", "beds", "baths", "start_date", "end_date"]
# Unified serializer for all listing types (Items and Sublets); used for CRUD operations
class ListingSerializer(ListingTypeMixin, ModelSerializer):
LISTING_TYPE_CONFIG = {
"item": {
"required_fields": ["condition", "category"],
"model": Item,
},
"sublet": {
"required_fields": [
"street_address",
"beds",
"baths",
"start_date",
"end_date",
],
"model": Sublet,
},
}
images = ListingImageSerializer(many=True, required=False, read_only=True)
tags = SlugRelatedField(
many=True,
slug_field="name",
queryset=Tag.objects.all(),
required=False,
allow_empty=True,
)
seller = UserSerializer(read_only=True)
listing_type = SerializerMethodField()
additional_data = SerializerMethodField()
is_favorited = SerializerMethodField()
external_link = URLField(required=False, allow_blank=True, allow_null=True)
negotiable = BooleanField(required=False, default=True)
expires_at = DateTimeField(required=False, allow_null=True)
class Meta:
model = Listing
fields = [
"id",
"seller",
"buyers",
"tags",
"favorites",
"title",
"description",
"external_link",
"price",
"negotiable",
"created_at",
"expires_at",
"images",
"listing_type",
"additional_data",
"is_favorited",
]
read_only_fields = [
"id",
"created_at",
"seller",
"buyers",
"images",
"favorites",
]
def validate(self, attrs):
if not self.instance:
listing_type = self.initial_data.get("listing_type")
additional_data = self.initial_data.get("additional_data", {})
if not listing_type:
raise ValidationError(
{"listing_type": "This field is required for creating a listing."}
)
if listing_type not in self.LISTING_TYPE_CONFIG:
valid_types = ", ".join(self.LISTING_TYPE_CONFIG.keys())
raise ValidationError(
{"listing_type": f"Must be one of: {valid_types}"}
)
config = self.LISTING_TYPE_CONFIG[listing_type]
required_fields = config["required_fields"]
missing_fields = [f for f in required_fields if f not in additional_data]
if missing_fields:
raise ValidationError(
{
"additional_data": dict.fromkeys(
missing_fields, f"This field is required for {listing_type}"
)
}
)
return super().validate(attrs)
def get_is_favorited(self, obj):
request = self.context.get("request")
if not request or not request.user or not request.user.is_authenticated:
return False
return request.user.listings_favorited.filter(id=obj.id).exists()
def validate_title(self, value):
if self.contains_profanity(value):
raise ValidationError("The title contains inappropriate language.")
return value
def validate_description(self, value):
if self.contains_profanity(value):
raise ValidationError("The description contains inappropriate language.")
return value
def contains_profanity(self, text):
return predict([text])[0]
def create(self, validated_data):
validated_data["seller"] = self.context["request"].user
listing_type = self.initial_data.get("listing_type")
additional_data = self.initial_data.get("additional_data", {})
create_method_name = f"_create_{listing_type}"
create_method = getattr(self, create_method_name, None)
if not create_method:
valid_types = ", ".join(self.LISTING_TYPE_CONFIG.keys())
raise ValidationError({"listing_type": f"Must be one of: {valid_types}"})
try:
return create_method(validated_data, additional_data)
except ModelValidationError as e:
raise ValidationError(
e.message_dict if hasattr(e, "message_dict") else e.messages
) from e
def _create_item(self, validated_data, additional_data):
category_name = additional_data.get("category")
category = Category.objects.filter(name=category_name).first()
if not category:
raise ValidationError(
{
"additional_data": {
"category": f"Category '{category_name}' does not exist."
}
}
)
tags = validated_data.pop("tags", None)
item = Item.objects.create(
condition=additional_data.get("condition"),
category=category,
**validated_data,
)
if tags:
item.tags.set(tags)
return item
def _create_sublet(self, validated_data, additional_data):
tags = validated_data.pop("tags", None)
sublet = Sublet.objects.create(
street_address=additional_data.get("street_address"),
beds=additional_data.get("beds"),
baths=additional_data.get("baths"),
start_date=additional_data.get("start_date"),
end_date=additional_data.get("end_date"),
**validated_data,
)
if tags:
sublet.tags.set(tags)
return sublet
def update(self, instance, validated_data):
listing_type = self.initial_data.get("listing_type")
additional_data = self.initial_data.get("additional_data", {})
try:
tags = validated_data.pop("tags", None)
for attr, value in validated_data.items():
setattr(instance, attr, value)
if tags:
instance.tags.set(tags)
if listing_type and listing_type != self.get_listing_type(instance):
raise ValidationError(
{"listing_type": "Cannot change listing type on update."}
)
if additional_data:
if self.get_listing_type(instance) == "item":
self._update_item(instance, additional_data)
elif self.get_listing_type(instance) == "sublet":
self._update_sublet(instance, additional_data)
instance.save()
return instance
except ModelValidationError as e:
raise ValidationError(
e.message_dict if hasattr(e, "message_dict") else e.messages
) from e
def _update_item(self, instance, additional_data):
item = instance.item
if "condition" in additional_data:
item.condition = additional_data["condition"]
if "category" in additional_data:
category = Category.objects.filter(name=additional_data["category"]).first()
if category:
item.category = category
item.full_clean()
item.save()
def _update_sublet(self, instance, additional_data):
sublet = instance.sublet
sublet_fields = ["street_address", "beds", "baths", "start_date", "end_date"]
for field in sublet_fields:
if field in additional_data:
setattr(sublet, field, additional_data[field])
sublet.full_clean()
sublet.save()
# Read-only serializer for use when reading a single listing
class ListingSerializerPublic(ListingTypeMixin, ModelSerializer):
buyer_count = SerializerMethodField()
favorite_count = SerializerMethodField()
is_favorited = SerializerMethodField()
tags = SlugRelatedField(many=True, slug_field="name", queryset=Tag.objects.all())
images = ListingImageURLSerializer(many=True)
seller = UserSerializer(read_only=True)
listing_type = SerializerMethodField()
additional_data = SerializerMethodField()
class Meta:
model = Listing
fields = [
"id",
"seller",
"buyer_count",
"tags",
"title",
"description",
"external_link",
"price",
"negotiable",
"expires_at",
"images",
"favorite_count",
"listing_type",
"additional_data",
"is_favorited",
]
read_only_fields = fields
def get_buyer_count(self, obj):
return obj.buyers.count()
def get_favorite_count(self, obj):
return obj.favorites.count()
def get_is_favorited(self, obj):
request = self.context.get("request")
if not request or not request.user or not request.user.is_authenticated:
return False
return request.user.listings_favorited.filter(id=obj.id).exists()
# Read-only serializer for use when pulling all listings /etc
class ListingSerializerList(ListingTypeMixin, ModelSerializer):
favorite_count = SerializerMethodField()
tags = SlugRelatedField(many=True, slug_field="name", queryset=Tag.objects.all())
images = ListingImageURLSerializer(many=True)
seller = UserSerializer(read_only=True)
listing_type = SerializerMethodField()
additional_data = SerializerMethodField()
class Meta:
model = Listing
fields = [
"id",
"seller",
"tags",
"title",
"price",
"expires_at",
"images",
"favorite_count",
"listing_type",
"additional_data",
]
read_only_fields = fields
def get_favorite_count(self, obj):
return obj.favorites.count()