Merge pull request #10 from rockstarr-programmerr/dev

Version 1.0.0

Author: rockstarr-programmerr

.gitignore

@@ -7,5 +7,6 @@ media/
 .coverage
 htmlcov/
 temp/
+temp.*
 *.pid
 *.log

README.md

@@ -33,7 +33,7 @@ python manage.py runserver
 
 ### Debug
 #### For Visual studio code
-Just press F5 (Config is inside `.vscode/`)
+Just press F5 (Config is inside `keep-learning.code-workspace`)
 
 #### For other editors
 Please contribute if you know how.
@@ -62,3 +62,37 @@ Go to this URL in your brower. (You may need to register new user and then login
 ```
 http://localhost:8000/
 ```
+
+### Setup background tasks
+**NOTE** This is only needed if you develop features involving background tasks, like sending email, .etc
+
+#### Rabbitmq
+##### Setup with docker
+```
+docker run -d --name rabbitmq -p 5672:5672 rabbitmq
+```
+
+##### Create user and vhost
+Exec into container
+```
+docker exec -it rabbitmq bash
+```
+
+Create user, vhost
+```
+rabbitmqctl add_user kl_user kl_password
+rabbitmqctl add_vhost kl_vhost
+rabbitmqctl set_permissions -p kl_vhost kl_user ".*" ".*" ".*"
+```
+
+#### Celery
+##### Start the worker process
+```
+celery --app keep_learning worker --loglevel INFO --pool solo
+```
+
+**NOTE** Every time you make changes to a task, celery worker should be restarted.
+
+### Sending emails
+In development, emails are not actually sent, but instead saved to `temp/sent_emails`.
+You can inspect this directory to test email sending features.

account/business/__init__.py

@@ -0,0 +1 @@
+from .teacher import register_teacher

account/business/reset_password.py

@@ -0,0 +1,57 @@
+from django.conf import settings
+from django.contrib.auth import get_user_model
+from django.contrib.auth.tokens import PasswordResetTokenGenerator
+from django.core.exceptions import ValidationError
+from django.utils.encoding import force_bytes
+from django.utils.http import urlsafe_base64_decode, urlsafe_base64_encode
+
+from account.serializers import EmailResetPasswordLinkTaskSerializer
+from account.tasks import send_email_reset_password_link_task
+from keep_learning.utils.url import update_url_params
+
+User = get_user_model()
+
+
+class ResetPasswordTokenInvalid(Exception):
+    pass
+
+
+class ResetPasswordBusiness:
+    token_generator = PasswordResetTokenGenerator()
+
+    def __init__(self, user):
+        self.user = user
+
+    def send_email(self):
+        url = self.get_link()
+        serializer = EmailResetPasswordLinkTaskSerializer(instance=self.user)
+        send_email_reset_password_link_task.delay(serializer.data, url)
+
+    def reset_password(self, password, token):
+        self.check_token(token)
+        self.user.set_password(password)
+        self.user.save()
+
+    def get_link(self):
+        token = self.token_generator.make_token(self.user)
+        uid = urlsafe_base64_encode(force_bytes(self.user.pk))
+        url = update_url_params(settings.WEB_RESET_PASSWORD_URL, {'token': token, 'uid': uid})
+        return url
+
+    def check_token(self, token):
+        is_valid = self.token_generator.check_token(self.user, token)
+        if not is_valid:
+            raise ResetPasswordTokenInvalid
+
+    @staticmethod
+    def get_user_by_email(email):
+        return User.objects.filter(email=email).first()
+
+    @staticmethod
+    def get_user_by_uid(uid):
+        try:
+            uid = urlsafe_base64_decode(uid).decode()
+            user = User.objects.get(pk=uid)
+        except (TypeError, ValueError, OverflowError, User.DoesNotExist, ValidationError):
+            user = None
+        return user

account/business/teacher.py

@@ -0,0 +1,10 @@
+from django.contrib.auth import get_user_model
+
+User = get_user_model()
+
+
+def register_teacher(data):
+    email = data.pop('email')
+    password = data.pop('password')
+    teacher = User.objects.create_teacher(email=email, password=password, **data)
+    return teacher

account/managers.py

@@ -0,0 +1,57 @@
+from django.contrib.auth.models import UserManager
+from django.db import models
+from django.utils.translation import gettext_lazy as _
+
+
+def get_first_part_of_email(email):
+    return email.split('@')[0]
+
+
+class UserTypes(models.TextChoices):
+    TEACHER = 'teacher', _('Teacher')
+    STUDENT = 'student', _('Student')
+    ADMIN = 'admin', _('Admin')
+
+
+class CustomUserManager(UserManager):
+    """
+    Customize to allow creating user with just email, no need username
+    """
+    def create_user(self, username=None, email=None, password=None, **extra_fields):
+        assert bool(email), 'Email is required for creating user.'
+        username = get_first_part_of_email(email)
+
+        if not 'name' in extra_fields:
+            extra_fields['name'] = get_first_part_of_email(email)
+
+        return super().create_user(username, email=email, password=password, **extra_fields)
+
+    def create_superuser(self, username=None, email=None, password=None, **extra_fields):
+        assert bool(email), 'Email is required for creating user.'
+        username = get_first_part_of_email(email)
+
+        if not 'name' in extra_fields:
+            extra_fields['name'] = get_first_part_of_email(email)
+        if not 'user_type' in extra_fields:
+            user_type = UserTypes.ADMIN
+            extra_fields['user_type'] = user_type
+
+        return super().create_superuser(username, email=email, password=password, **extra_fields)
+
+    def create_teacher(self, email=None, password=None, **extra_fields):
+        extra_fields['user_type'] = UserTypes.TEACHER
+        return self.create_user(email=email, password=password, **extra_fields)
+
+    def create_student(self, email=None, password=None, **extra_fields):
+        extra_fields['user_type'] = UserTypes.STUDENT
+        return self.create_user(email=email, password=password, **extra_fields)
+
+
+class TeacherManager(UserManager):
+    def get_queryset(self):
+        return super().get_queryset().filter(user_type=UserTypes.TEACHER)
+
+
+class StudentManager(UserManager):
+    def get_queryset(self):
+        return super().get_queryset().filter(user_type=UserTypes.STUDENT)

account/migrations/0001_initial.py

@@ -0,0 +1,48 @@
+# Generated by Django 3.2.7 on 2021-10-02 15:35
+
+import account.managers
+import django.core.validators
+from django.db import migrations, models
+import django.utils.timezone
+
+
+class Migration(migrations.Migration):
+
+    initial = True
+
+    dependencies = [
+        ('auth', '0012_alter_user_first_name_max_length'),
+    ]
+
+    operations = [
+        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')),
+                ('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(error_messages={'unique': 'A user with that email already exists.'}, max_length=254, unique=True)),
+                ('name', models.CharField(max_length=150)),
+                ('phone_number', models.CharField(blank=True, max_length=20)),
+                ('avatar', models.ImageField(blank=True, upload_to='users/avatar/%Y/%m', validators=[django.core.validators.validate_image_file_extension])),
+                ('avatar_thumbnail', models.ImageField(blank=True, upload_to='users/avatar_thumbnail/%Y/%m', validators=[django.core.validators.validate_image_file_extension])),
+                ('username', models.CharField(blank=True, max_length=150)),
+                ('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', account.managers.CustomUserManager()),
+            ],
+        ),
+    ]

account/migrations/0002_user_user_type.py

@@ -0,0 +1,19 @@
+# Generated by Django 3.2.7 on 2021-10-02 15:47
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('account', '0001_initial'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='user',
+            name='user_type',
+            field=models.CharField(choices=[('teacher', 'teacher'), ('student', 'student'), ('admin', 'admin')], default='admin', max_length=20),
+            preserve_default=False,
+        ),
+    ]

account/migrations/0003_auto_20211004_2117.py

@@ -0,0 +1,27 @@
+# Generated by Django 3.2.7 on 2021-10-04 14:17
+
+import account.managers
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('account', '0002_user_user_type'),
+    ]
+
+    operations = [
+        migrations.AlterModelManagers(
+            name='user',
+            managers=[
+                ('objects', account.managers.CustomUserManager()),
+                ('teachers', account.managers.TeacherManager()),
+                ('students', account.managers.StudentManager()),
+            ],
+        ),
+        migrations.AlterField(
+            model_name='user',
+            name='user_type',
+            field=models.CharField(choices=[('teacher', 'Teacher'), ('student', 'Student'), ('admin', 'Admin')], max_length=20),
+        ),
+    ]

account/models.py

@@ -1,3 +1,81 @@
+from django.contrib.auth.models import AbstractUser
+from django.core.validators import validate_image_file_extension
 from django.db import models
+from django.utils.translation import gettext_lazy as _
+from PIL import Image
 
-# Create your models here.
+from account.managers import (CustomUserManager, StudentManager,
+                              TeacherManager, UserTypes)
+
+AVATAR_WIDTH = 256
+AVATAR_HEIGHT = 256
+AVATAR_THUMBNAIL_WIDTH = 64
+AVATAR_THUMBNAIL_HEIGHT = 64
+
+
+class User(AbstractUser):
+    Types = UserTypes
+
+    email = models.EmailField(
+        unique=True,
+        error_messages={
+            'unique': _('A user with that email already exists.'),
+        },
+    )
+    name = models.CharField(
+        max_length=150,
+    )
+    phone_number = models.CharField(
+        max_length=20,
+        blank=True,
+    )
+    user_type = models.CharField(
+        max_length=20,
+        choices=Types.choices,
+    )
+    avatar = models.ImageField(
+        upload_to='users/avatar/%Y/%m',
+        blank=True,
+        validators=[validate_image_file_extension],
+    )
+    avatar_thumbnail = models.ImageField(
+        upload_to='users/avatar_thumbnail/%Y/%m',
+        blank=True,
+        validators=[validate_image_file_extension],
+    )
+    username = models.CharField(
+        max_length=150,
+        blank=True,
+    )
+
+    # NOTE: Order of managers is important, first manager is considered "default" by Django.
+    objects = CustomUserManager()
+    teachers = TeacherManager()
+    students = StudentManager()
+
+    USERNAME_FIELD = 'email'
+    REQUIRED_FIELDS = []
+
+    def __str__(self):
+        return f'{self.name} ({self.email}) - {self.get_user_type_display()}'
+
+    def save(self, *args, **kwargs):
+        super().save(*args, **kwargs)
+        self._make_thumbnail(self.avatar, AVATAR_WIDTH, AVATAR_HEIGHT)
+        self._make_thumbnail(self.avatar_thumbnail, AVATAR_THUMBNAIL_WIDTH, AVATAR_THUMBNAIL_HEIGHT)
+
+    @staticmethod
+    def _make_thumbnail(image, width, height):
+        if image and (
+            image.width > width or
+            image.height > height
+        ):
+            with Image.open(image.path) as f:
+                f.thumbnail((width, height))
+                f.save(image.path)
+
+    def is_teacher(self):
+        return self.user_type == self.Types.TEACHER
+
+    def is_student(self):
+        return self.user_type == self.Types.STUDENT