Initial commit: add base models for core eCommerce entities

Author: Yosef-AlSabbah

.gitignore

@@ -0,0 +1,2 @@
+.venv
+.idea

api/__init__.py

@@ -0,0 +1,3 @@
+from django.contrib import admin
+
+# Register your models here.

api/admin.py

@@ -0,0 +1,6 @@
+from django.apps import AppConfig
+
+
+class ApiConfig(AppConfig):
+    default_auto_field = 'django.db.models.BigAutoField'
+    name = 'api'

api/apps.py

@@ -0,0 +1,79 @@
+# Generated by Django 5.2 on 2025-04-12 12:41
+
+import api.utils
+import django.contrib.auth.models
+import django.contrib.auth.validators
+import django.db.models.deletion
+import django.utils.timezone
+from django.conf import settings
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    initial = True
+
+    dependencies = [
+        ('auth', '0012_alter_user_first_name_max_length'),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='Category',
+            fields=[
+                ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('name', models.CharField(max_length=255)),
+                ('slug', models.SlugField(max_length=255, unique=True)),
+            ],
+        ),
+        migrations.CreateModel(
+            name='User',
+            fields=[
+                ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('password', models.CharField(max_length=128, verbose_name='password')),
+                ('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')),
+                ('username', models.CharField(error_messages={'unique': 'A user with that username already exists.'}, help_text='Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.', max_length=150, unique=True, validators=[django.contrib.auth.validators.UnicodeUsernameValidator()], verbose_name='username')),
+                ('first_name', models.CharField(blank=True, max_length=150, verbose_name='first name')),
+                ('last_name', models.CharField(blank=True, max_length=150, verbose_name='last name')),
+                ('is_staff', models.BooleanField(default=False, help_text='Designates whether the user can log into this admin site.', verbose_name='staff status')),
+                ('is_active', models.BooleanField(default=True, help_text='Designates whether this user should be treated as active. Unselect this instead of deleting accounts.', verbose_name='active')),
+                ('date_joined', models.DateTimeField(default=django.utils.timezone.now, verbose_name='date joined')),
+                ('email', models.EmailField(max_length=254, unique=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='user_set', related_query_name='user', to='auth.group', verbose_name='groups')),
+                ('user_permissions', models.ManyToManyField(blank=True, help_text='Specific permissions for this user.', related_name='user_set', related_query_name='user', to='auth.permission', verbose_name='user permissions')),
+            ],
+            options={
+                'verbose_name': 'user',
+                'verbose_name_plural': 'users',
+                'abstract': False,
+            },
+            managers=[
+                ('objects', django.contrib.auth.models.UserManager()),
+            ],
+        ),
+        migrations.CreateModel(
+            name='Product',
+            fields=[
+                ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('name', models.CharField(max_length=255)),
+                ('slug', models.SlugField(max_length=255, unique=True)),
+                ('description', models.TextField()),
+                ('price', models.DecimalField(decimal_places=2, max_digits=10)),
+                ('stock', models.IntegerField()),
+                ('image', models.ImageField(blank=True, null=True, upload_to=api.utils.product_upload_to_unique)),
+                ('category', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='products', to='api.category')),
+            ],
+        ),
+        migrations.CreateModel(
+            name='Profile',
+            fields=[
+                ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('bio', models.TextField(blank=True)),
+                ('location', models.CharField(blank=True, max_length=100)),
+                ('birth_date', models.DateField(blank=True, null=True)),
+                ('picture_url', models.ImageField(blank=True, null=True, upload_to=api.utils.profile_upload_to_unique)),
+                ('user', models.OneToOneField(on_delete=django.db.models.deletion.CASCADE, to=settings.AUTH_USER_MODEL)),
+            ],
+        ),
+    ]

api/migrations/0001_initial.py

@@ -0,0 +1,23 @@
+# Generated by Django 5.2 on 2025-04-12 12:45
+
+import uuid
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('api', '0001_initial'),
+    ]
+
+    operations = [
+        migrations.RemoveField(
+            model_name='product',
+            name='id',
+        ),
+        migrations.AddField(
+            model_name='product',
+            name='product_id',
+            field=models.UUIDField(default=uuid.uuid4, editable=False, primary_key=True, serialize=False),
+        ),
+    ]

api/migrations/0002_remove_product_id_product_product_id.py

@@ -0,0 +1,18 @@
+# Generated by Django 5.2 on 2025-04-12 12:59
+
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('api', '0002_remove_product_id_product_product_id'),
+    ]
+
+    operations = [
+        migrations.RenameField(
+            model_name='profile',
+            old_name='picture_url',
+            new_name='picture',
+        ),
+    ]

api/migrations/0003_rename_picture_url_profile_picture.py

@@ -0,0 +1,62 @@
+import uuid
+
+from django.contrib.auth.models import AbstractUser
+from django.db import models
+from django.utils.text import slugify
+from taggit.managers import TaggableManager
+
+from .utils import product_upload_to_unique, profile_upload_to_unique
+
+
+class User(AbstractUser):
+    email = models.EmailField(unique=True)
+
+
+class Profile(models.Model):
+    user = models.OneToOneField(User, on_delete=models.CASCADE)
+    bio = models.TextField(blank=True)
+    location = models.CharField(max_length=100, blank=True)
+    birth_date = models.DateField(null=True, blank=True)
+    picture = models.ImageField(upload_to=profile_upload_to_unique, null=True, blank=True)
+
+    def __str__(self):
+        return f'{self.user.username} Profile'
+
+
+class Category(models.Model):
+    name = models.CharField(max_length=255)
+    slug = models.SlugField(max_length=255, unique=True)
+
+    def __str__(self):
+        return self.name
+
+
+class Product(models.Model):
+    product_id = models.UUIDField(primary_key=True, default=uuid.uuid4, editable=False)
+    name = models.CharField(max_length=255)
+    slug = models.SlugField(max_length=255, unique=True)
+    description = models.TextField()
+    price = models.DecimalField(max_digits=10, decimal_places=2)
+    stock = models.IntegerField()
+    image = models.ImageField(
+        null=True,
+        blank=True,
+        upload_to=product_upload_to_unique
+    )
+
+    category = models.ForeignKey(
+        Category,
+        related_name="products",
+        on_delete=models.CASCADE,
+
+    )
+
+    objects = models.Manager()
+    tags = TaggableManager
+
+    def save(self, *args, **kwargs):
+        self.slug = slugify(self.name)
+        super().save(*args, **kwargs)
+
+    def __str__(self):
+        return self.name

api/migrations/__init__.py

@@ -0,0 +1,73 @@
+from rest_framework import serializers
+
+from .models import Category, Product, User, Profile
+
+
+class UserSerializer(serializers.ModelSerializer):
+    class ProfileSerializer(serializers.ModelSerializer):
+        class Meta:
+            model = Profile
+            fields = ['bio', 'location', 'birth_date', 'picture']
+
+    profile = ProfileSerializer()
+
+    class Meta:
+        model = User
+        fields = ['username', 'profile', 'first_name', 'last_name']
+
+
+class CategorySerializer(serializers.ModelSerializer):
+    class Meta:
+        model = Category
+        fields = ['name', 'slug']
+        extra_kwargs = {'slug': {'read_only': True}}  # Make the slug field read-only
+
+
+class ProductSerializer(serializers.ModelSerializer):
+    category = CategorySerializer()
+
+    tags = serializers.ListField(
+        child=serializers.CharField(),
+        source='tags.names',
+        required=False,
+    )
+
+    def to_internal_value(self, data):
+        if self.instance is None and 'category' not in data:
+            raise serializers.ValidationError(
+                {'category': 'This field is required when creating a product.'}
+            )
+        return super().to_internal_value(data)
+
+    def create(self, validated_data):
+        # Custom create method to handle tags
+        instance = super().create(**validated_data)  # Create the Product instance
+        tags = validated_data.pop('tags', None)  # Extract tags from validated data
+        if tags:
+            instance.tags.set(*tags)  # Assign tags to the product
+        return instance
+
+    def update(self, instance, validated_data):
+        # Custom update method to handle tags
+        tags = validated_data.pop('tags', None)  # Extract tags from validated data
+        if tags:
+            instance.tags.clear()  # Clear existing tags
+            instance.tags.set(*tags)  # Assign new tags
+        else:
+            instance.tags.clear()  # Clear tags if none are provided
+
+        return super().update(instance, validated_data)
+
+    class Meta:
+        model = Product
+        fields = [
+            'product_id',
+            'name',
+            'slug',
+            'description',
+            'price',
+            'stock',
+            'image',
+            'category',
+            'tags'
+        ]