DannyJamesHidalgo
commented
4 months ago
"""View module for handling requests about customer profiles"""
import datetime
from django.http import HttpResponseServerError
from django.contrib.auth import get_user_model
from rest_framework import serializers, status
from rest_framework.decorators import action
from rest_framework.permissions import IsAuthenticatedOrReadOnly
from rest_framework.response import Response
from rest_framework.viewsets import ViewSet
from bangazonapi.models import Customer
from bangazonapi.models import OrderProduct, Favorite, Product, Store
from bangazonapi.models import Recommendation
from .product import ProductSerializer
from .order import OrderSerializer, Order
from django.contrib.auth.models import User
from .cart import Cart
class Profile(ViewSet):
"""Request handlers for user profile info in the Bangazon Platform"""
permission_classes = (IsAuthenticatedOrReadOnly,)
def list(self, request):
"""
@api {GET} /profile GET user profile info
@apiName GetProfile
@apiGroup UserProfile
@apiHeader {String} Authorization Auth token
@apiHeaderExample {String} Authorization
Token 9ba45f09651c5b0c404f37a2d2572c026c146611
@apiSuccess (200) {Number} id Profile id
@apiSuccess (200) {String} url URI of customer profile
@apiSuccess (200) {Object} user Related user object
@apiSuccess (200) {String} user.first_name Customer first name
@apiSuccess (200) {String} user.last_name Customer last name
@apiSuccess (200) {String} user.email Customer email
@apiSuccess (200) {String} phone_number Customer phone number
@apiSuccess (200) {String} address Customer address
@apiSuccess (200) {Object[]} payment_types Array of user's payment types
@apiSuccess (200) {Object[]} recommends Array of recommendations made by the user
@apiSuccessExample {json} Success
HTTP/1.1 200 OK
{
"id": 7,
"url": "http://localhost:8000/customers/7",
"user": {
"first_name": "Brenda",
"last_name": "Long",
"email": "brenda@brendalong.com"
},
"phone_number": "555-1212",
"address": "100 Indefatiguable Way",
"payment_types": [
{
"url": "http://localhost:8000/paymenttypes/3",
"deleted": null,
"merchant_name": "Visa",
"account_number": "fj0398fjw0g89434",
"expiration_date": "2020-03-01",
"create_date": "2019-03-11",
"customer": "http://localhost:8000/customers/7"
}
],
"recommends": [
{
"product": {
"id": 32,
"name": "DB9"
},
"customer": {
"id": 5,
"user": {
"first_name": "Joe",
"last_name": "Shepherd",
"email": "joe@joeshepherd.com"
}
}
}
]
}
"""
try:
# Retrieve the authenticated user
user = get_user_model().objects.get(id=request.user.id)
# Cast the User instance to a Customer instance
current_user = Customer.objects.get(user=user)
# Now, current_user is a Customer instance and can be used for operations requiring a Customer
# Assuming you want to filter recommendations by the current user
current_user.recommends = Recommendation.objects.filter(
recommender=current_user
)
recommendations_received = Recommendation.objects.filter(customer=current_user)
recommended_products = RecommenderSerializer(
recommendations_received,
many=True,
context={"request": request}).data
profile_serializer = ProfileSerializer(current_user, many=False, context={"request": request})
profile_data = profile_serializer.data
profile_data['recommended'] = recommended_products
return Response(profile_data)
except Exception as ex:
return HttpResponseServerError(ex)
@action(methods=["get", "post", "delete"], detail=False)
def cart(self, request):
"""Shopping cart manipulation"""
current_user = Customer.objects.get(user=request.auth.user)
if request.method == "DELETE":
"""
@api {DELETE} /profile/cart DELETE all line items in cart
@apiName DeleteCart
@apiGroup UserProfile
@apiHeader {String} Authorization Auth token
@apiHeaderExample {String} Authorization
Token 9ba45f09651c5b0c404f37a2d2572c026c146611
@apiSuccessExample {json} Success
HTTP/1.1 204 No Content
@apiError (404) {String} message Not found message.
"""
try:
open_order = Order.objects.get(customer=current_user, payment_type=None)
lineitems = OrderProduct.objects.filter(order=open_order)
lineitems.delete()
open_order.delete()
cart_viewset = Cart() # Get access to cart methods
cart_viewset.request = request # gives cart the same request data the DELETE has
cart_viewset.create_empty_order(request)
except Order.DoesNotExist as ex:
return Response(
{"message": ex.args[0]}, status=status.HTTP_404_NOT_FOUND
)
return Response({}, status=status.HTTP_204_NO_CONTENT)
if request.method == "GET":
"""
@api {GET} /profile/cart GET line items in cart
@apiName GetCart
@apiGroup UserProfile
@apiHeader {String} Authorization Auth token
@apiHeaderExample {String} Authorization
Token 9ba45f09651c5b0c404f37a2d2572c026c146611
@apiSuccess (200) {Number} id Order cart
@apiSuccess (200) {String} url URL of order
@apiSuccess (200) {String} created_date Date created
@apiSuccess (200) {Object} payment_type Payment Id used to complete order
@apiSuccess (200) {String} customer URI for customer
@apiSuccess (200) {Number} size Number of items in cart
@apiSuccess (200) {Object[]} lineitems Line items in cart
@apiSuccess (200) {Number} lineitems.id Line item id
@apiSuccess (200) {Object} lineitems.product Product in cart
@apiSuccessExample {json} Success
{
"id": 2,
"url": "http://localhost:8000/orders/2",
"created_date": "2019-04-12",
"payment_type": null,
"customer": "http://localhost:8000/customers/7",
"lineitems": [
{
"id": 4,
"product": {
"id": 52,
"url": "http://localhost:8000/products/52",
"name": "900",
"price": 1296.98,
"number_sold": 0,
"description": "1987 Saab",
"quantity": 2,
"created_date": "2019-03-19",
"location": "Vratsa",
"image_path": null,
"average_rating": 0,
"category": {
"url": "http://localhost:8000/productcategories/2",
"name": "Auto"
}
}
}
],
"size": 1
}
@apiError (404) {String} message Not found message
"""
try:
open_order = Order.objects.get(customer=current_user, payment_type=None)
lineitems = OrderProduct.objects.filter(order=open_order)
lineitems = LineItemSerializer(
lineitems, many=True, context={"request": request}
)
cart = {}
cart["order"] = OrderSerializer(
open_order, many=False, context={"request": request}
).data
cart["order"]["lineitems"] = lineitems.data
cart["order"]["size"] = len(lineitems.data)
except Order.DoesNotExist as ex:
return Response(
{"message": ex.args[0]}, status=status.HTTP_404_NOT_FOUND
)
return Response(cart["order"])
if request.method == "POST":
"""
@api {POST} /profile/cart POST new product to cart
@apiName AddToCart
@apiGroup UserProfile
@apiHeader {String} Authorization Auth token
@apiHeaderExample {String} Authorization
Token 9ba45f09651c5b0c404f37a2d2572c026c146611
@apiSuccess (200) {Object} line_item Line items in cart
@apiSuccess (200) {Number} line_item.id Line item id
@apiSuccess (200) {Object} line_item.product Product in cart
@apiSuccess (200) {Object} line_item.order Open order for cart
@apiSuccessExample {json} Success
{
"id": 14,
"product": {
"url": "http://localhost:8000/products/52",
"deleted": null,
"name": "900",
"price": 1296.98,
"description": "1987 Saab",
"quantity": 2,
"created_date": "2019-03-19",
"location": "Vratsa",
"image_path": null,
"customer": "http://localhost:8000/customers/7",
"category": "http://localhost:8000/productcategories/2"
},
"order": {
"url": "http://localhost:8000/orders/2",
"created_date": "2019-04-12",
"customer": "http://localhost:8000/customers/7",
"payment_type": null
}
}
@apiError (404) {String} message Not found message
"""
try:
open_order = Order.objects.get(customer=current_user, payment_type=None)
except Order.DoesNotExist as ex:
open_order = Order()
open_order.created_date = datetime.datetime.now()
open_order.customer = current_user
open_order.save()
line_item = OrderProduct()
line_item.product = Product.objects.get(pk=request.data["product_id"])
line_item.order = open_order
line_item.save()
line_item_json = LineItemSerializer(
line_item, many=False, context={"request": request}
)
return Response(line_item_json.data)
return Response({}, status=status.HTTP_405_METHOD_NOT_ALLOWED)
@action(methods=["get"], detail=False)
def favoritesellers(self, request):
"""
@api {GET} /profile/favoritesellers GET favorite sellers
@apiName GetFavoriteSellers
@apiGroup UserProfile
@apiHeader {String} Authorization Auth token
@apiHeaderExample {String} Authorization
Token 9ba45f09651c5b0c404f37a2d2572c026c146611
@apiSuccess (200) {id} id Favorite id
@apiSuccess (200) {Object} seller Favorited seller
@apiSuccess (200) {String} seller.url Seller URI
@apiSuccess (200) {String} seller.phone_number Seller phone number
@apiSuccess (200) {String} seller.address Seller address
@apiSuccess (200) {String} seller.user Seller user profile URI
@apiSuccessExample {json} Success
[
{
"id": 1,
"seller": {
"url": "http://localhost:8000/customers/5",
"phone_number": "555-1212",
"address": "100 Endless Way",
"user": "http://localhost:8000/users/6"
}
},
{
"id": 2,
"seller": {
"url": "http://localhost:8000/customers/6",
"phone_number": "555-1212",
"address": "100 Dauntless Way",
"user": "http://localhost:8000/users/7"
}
},
{
"id": 3,
"seller": {
"url": "http://localhost:8000/customers/7",
"phone_number": "555-1212",
"address": "100 Indefatiguable Way",
"user": "http://localhost:8000/users/8"
}
}
]
"""
customer = Customer.objects.get(user=request.auth.user)
favorites = Favorite.objects.filter(customer=customer)
serializer = FavoriteSerializer(
favorites, many=True, context={"request": request}
)
return Response(serializer.data)
class LineItemSerializer(serializers.HyperlinkedModelSerializer):
"""JSON serializer for products
Arguments:
serializers
"""
product = ProductSerializer(many=False)
class Meta:
model = OrderProduct
fields = ("id", "product")
depth = 1
class UserSerializer(serializers.HyperlinkedModelSerializer):
"""JSON serializer for customer profile
Arguments:
serializers
"""
class Meta:
model = User
fields = ("first_name", "last_name", "email")
depth = 1
class CustomerSerializer(serializers.ModelSerializer):
"""JSON serializer for recommendation customers"""
user = UserSerializer()
class Meta:
model = Customer
fields = (
"id",
"user",
)
class ProfileProductSerializer(serializers.ModelSerializer):
"""JSON serializer for products"""
class Meta:
model = Product
fields = (
"id",
"name",
"description",
"price",
"image_path"
)
class RecommenderSerializer(serializers.ModelSerializer):
"""JSON serializer for recommendations"""
customer = CustomerSerializer()
product = ProfileProductSerializer()
recommender = CustomerSerializer()
class Meta:
model = Recommendation
fields = (
"product",
"customer",
"recommender"
)
class StoreSerializer(serializers.ModelSerializer):
customer = CustomerSerializer()
class Meta:
model = Store
fields = ['id', 'name', 'description', 'customer_id', 'products', 'customer']
class ProfileSerializer(serializers.ModelSerializer):
"""JSON serializer for customer profile
Arguments:
serializers
"""
store_owned = StoreSerializer(read_only=True)
user = UserSerializer(many=False)
recommends = RecommenderSerializer(
many=True
)
favorites = serializers.SerializerMethodField(method_name='get_favorites')
def get_favorites(self, obj):
# Assuming `obj` is a Customer instance
favorite_stores = obj.favorites
# Serialize each favorite store using StoreSerializer or a custom serializer for favorites
return StoreSerializer(favorite_stores, many=True).data
class Meta:
model = Customer
fields = (
"id",
"url",
"user",
"phone_number",
"address",
"payment_types",
"recommends",
"store_owned",
"favorites" # Include the favorites property
)
class FavoriteUserSerializer(serializers.HyperlinkedModelSerializer):
"""JSON serializer for favorite sellers user
Arguments:
serializers
"""
class Meta:
model = User
fields = ("first_name", "last_name", "username")
depth = 1
class FavoriteSellerSerializer(serializers.HyperlinkedModelSerializer):
"""JSON serializer for favorite sellers
Arguments:
serializers
"""
user = FavoriteUserSerializer(many=False)
class Meta:
model = Customer
fields = (
"id",
"url",
"user",
)
depth = 1
class FavoriteSerializer(serializers.HyperlinkedModelSerializer):
"""JSON serializer for favorites
Arguments:
serializers
"""
store = StoreSerializer(many=False)
class Meta:
model = Favorite
fields = ("id", "store")
depth = 2
use code below to help structure