fixed error seen from testing

Author: adamspd

MANIFEST.in

@@ -8,3 +8,5 @@ recursive-include appointment/static/js *.js
 recursive-include appointment/email_sender *.py
 recursive-include appointment *.py
 recursive-include docs *
+include logger_config.py
+exclude appointment/__pycache__

appointment/logger_config.py

@@ -10,4 +10,4 @@
 logging.basicConfig(format='%(asctime)s - %(name)s - %(levelname)s - %(message)s',
                     datefmt='%m/%d/%Y %I:%M:%S %p',
                     level=logging.DEBUG,
-                    handlers=[logging.StreamHandler(sys.stdout)])
+                    handlers=[logging.StreamHandler(sys.stdout)])

appointment/migrations/0001_initial.py

@@ -1,4 +1,4 @@
-# Generated by Django 4.2 on 2023-07-27 13:21
+# Generated by Django 4.2.3 on 2023-08-02 20:06
 
 from django.conf import settings
 import django.core.validators
@@ -126,12 +126,34 @@ class Migration(migrations.Migration):
                 ("name", models.CharField(max_length=100)),
                 ("description", models.TextField(blank=True, null=True)),
                 ("duration", models.DurationField()),
-                ("price", models.DecimalField(decimal_places=2, max_digits=6)),
+                (
+                    "price",
+                    models.DecimalField(
+                        decimal_places=2,
+                        max_digits=6,
+                        validators=[django.core.validators.MinValueValidator(0)],
+                    ),
+                ),
                 (
                     "down_payment",
-                    models.DecimalField(decimal_places=2, default=0, max_digits=6),
+                    models.DecimalField(
+                        decimal_places=2,
+                        default=0,
+                        max_digits=6,
+                        validators=[django.core.validators.MinValueValidator(0)],
+                    ),
+                ),
+                (
+                    "currency",
+                    models.CharField(
+                        default="USD",
+                        max_length=3,
+                        validators=[
+                            django.core.validators.MaxLengthValidator(3),
+                            django.core.validators.MinLengthValidator(3),
+                        ],
+                    ),
                 ),
-                ("currency", models.CharField(default="USD", max_length=3)),
                 (
                     "image",
                     models.ImageField(blank=True, null=True, upload_to="services/"),

appointment/models.py

@@ -3,7 +3,7 @@
 import string
 
 from django.core.exceptions import ValidationError
-from django.core.validators import RegexValidator
+from django.core.validators import RegexValidator, MinValueValidator, MinLengthValidator, MaxLengthValidator
 from django.db import models
 from django.utils.translation import gettext_lazy as _
 
@@ -22,12 +22,19 @@
 
 
 class Service(models.Model):
+    """
+    Represents a service provided by the appointment system.
+
+    Author: Adams Pierre David
+    Version: 1.1.0
+    Since: 1.0.0
+    """
     name = models.CharField(max_length=100)
     description = models.TextField(blank=True, null=True)
     duration = models.DurationField()
-    price = models.DecimalField(max_digits=6, decimal_places=2)
-    down_payment = models.DecimalField(max_digits=6, decimal_places=2, default=0)
-    currency = models.CharField(max_length=3, default='USD')
+    price = models.DecimalField(max_digits=6, decimal_places=2, validators=[MinValueValidator(0)])
+    down_payment = models.DecimalField(max_digits=6, decimal_places=2, default=0, validators=[MinValueValidator(0)])
+    currency = models.CharField(max_length=3, default='USD', validators=[MaxLengthValidator(3), MinLengthValidator(3)])
     image = models.ImageField(upload_to='services/', blank=True, null=True)
 
     # meta data
@@ -43,21 +50,33 @@ def get_name(self):
     def get_description(self):
         return self.description
 
+    def get_duration_parts(self):
+        total_seconds = int(self.duration.total_seconds())
+        days = total_seconds // 86400
+        hours = (total_seconds % 86400) // 3600
+        minutes = (total_seconds % 3600) // 60
+        seconds = total_seconds % 60
+        return days, hours, minutes, seconds
+
     def get_duration(self):
-        total_seconds = self.duration.total_seconds()
-        if total_seconds >= 86400:  # 1 day = 86400 seconds
-            days = total_seconds // 86400
-            return f"{days} day{'s' if days > 1 else ''}"
-        elif total_seconds >= 3600:  # 1 hour = 3600 seconds
-            hours = total_seconds // 3600
-            return f"{hours} hour{'s' if hours > 1 else ''}"
-        elif total_seconds >= 60:  # 1 minute = 60 seconds
-            minutes = total_seconds // 60
-            return f"{minutes} minute{'s' if minutes > 1 else ''}"
-        else:
-            return f"{total_seconds} second{'s' if total_seconds > 1 else ''}"
+        days, hours, minutes, seconds = self.get_duration_parts()
+        parts = []
+
+        if days:
+            parts.append(f"{days} day{'s' if days > 1 else ''}")
+        if hours:
+            parts.append(f"{hours} hour{'s' if hours > 1 else ''}")
+        if minutes:
+            parts.append(f"{minutes} minute{'s' if minutes > 1 else ''}")
+        if seconds:
+            parts.append(f"{seconds} second{'s' if seconds > 1 else ''}")
+
+        return ' '.join(parts)
 
     def get_price(self):
+        return self.price
+
+    def get_price_text(self):
         if self.price == 0:
             return "Free"
         else:
@@ -89,6 +108,13 @@ def accepts_down_payment(self):
 
 
 class AppointmentRequest(models.Model):
+    """
+    Represents an appointment request made by a client.
+
+    Author: Adams Pierre David
+    Version: 1.1.0
+    Since: 1.0.0
+    """
     date = models.DateField()
     start_time = models.TimeField()
     end_time = models.TimeField()
@@ -103,6 +129,11 @@ class AppointmentRequest(models.Model):
     def __str__(self):
         return f"{self.date} - {self.start_time} to {self.end_time} - {self.service.name}"
 
+    def clean(self):
+        if self.start_time is not None and self.end_time is not None:
+            if self.start_time >= self.end_time:
+                raise ValueError("Start time must be before end time")
+
     def save(self, *args, **kwargs):
         if self.id_request is None:
             self.id_request = f"{Utility.get_timestamp()}{self.service.id}{Utility.generate_random_id()}"
@@ -161,6 +192,13 @@ def get_updated_at(self):
 
 
 class Appointment(models.Model):
+    """
+    Represents an appointment made by a client. It is created when the client confirms the appointment request.
+
+    Author: Adams Pierre David
+    Version: 1.1.0
+    Since: 1.0.0
+    """
     client = models.ForeignKey(APPOINTMENT_CLIENT_MODEL, on_delete=models.CASCADE)
     appointment_request = models.OneToOneField(AppointmentRequest, on_delete=models.CASCADE)
     phone = models.CharField(validators=[phone_regex], max_length=10, blank=True, null=True, default="",
@@ -262,6 +300,14 @@ def set_appointment_paid_status(self, status: bool):
 
 
 class Config(models.Model):
+    """
+    Represents configuration settings for the appointment system. There can only be one Config object in the database.
+    If you want to change the settings, you must edit the existing Config object.
+
+    Author: Adams Pierre David
+    Version: 1.1.0
+    Since: 1.1.0
+    """
     slot_duration = models.PositiveIntegerField(
         null=True,
         help_text=_("Minimum time for an appointment in minutes, recommended 30."),
@@ -274,7 +320,7 @@ class Config(models.Model):
         null=True,
         help_text=_("Time when we stop working."),
     )
-    appointment_buffer_time = models.DurationField(
+    appointment_buffer_time = models.FloatField(
         null=True,
         help_text=_("Time between now and the first available slot for the current day (doesn't affect tomorrow)."),
     )
@@ -287,6 +333,9 @@ class Config(models.Model):
     def clean(self):
         if Config.objects.exists() and not self.pk:
             raise ValidationError(_("You can only create one Config object"))
+        if self.lead_time is not None and self.finish_time is not None:
+            if self.lead_time >= self.finish_time:
+                raise ValidationError(_("Lead time must be before finish time"))
 
     def save(self, *args, **kwargs):
         self.clean()
@@ -298,6 +347,13 @@ def __str__(self):
 
 
 class PaymentInfo(models.Model):
+    """
+    Represents payment information for an appointment.
+
+    Author: Adams Pierre David
+    Version: 1.1.0
+    Since: 1.0.0
+    """
     appointment = models.ForeignKey(Appointment, on_delete=models.CASCADE)
 
     # meta data
@@ -333,6 +389,13 @@ def get_user_email(self):
 
 
 class EmailVerificationCode(models.Model):
+    """
+    Represents an email verification code for a user when the email already exists in the database.
+
+    Author: Adams Pierre David
+    Version: 1.1.0
+    Since: 1.1.0
+    """
     user = models.ForeignKey(APPOINTMENT_CLIENT_MODEL, on_delete=models.CASCADE)
     code = models.CharField(max_length=6)
 
@@ -348,4 +411,4 @@ def generate_code(cls, user):
         code = ''.join(random.choices(string.ascii_uppercase + string.digits, k=6))
         verification_code = cls(user=user, code=code)
         verification_code.save()
-        return code
+        return code

appointment/operations/database_operations.py

@@ -1,18 +1,36 @@
 # appointment/operations/database_operations.py
 
-from django.apps import apps
 from django.contrib.auth.hashers import make_password
 from django.urls import reverse
 
+from appointment.logger_config import logger
 from appointment.models import Appointment, PaymentInfo
-from logger_config import logger
-from appointment.settings import APPOINTMENT_CLIENT_MODEL, APPOINTMENT_PAYMENT_URL
+from appointment.settings import APPOINTMENT_PAYMENT_URL
 from appointment.utils import Utility
 
-CLIENT_MODEL = apps.get_model(APPOINTMENT_CLIENT_MODEL)
+CLIENT_MODEL = Utility.get_user_model()
 
 
 def get_appointments_and_slots(date_, service=None):
+    """
+    Get appointments and available slots for a given date and service.
+
+    If a service is provided, the function retrieves appointments for that service on the given date.
+    Otherwise, it retrieves all appointments for the given date.
+
+    Args:
+        date_ (datetime.date): The date for which to retrieve appointments and available slots.
+        service (Service, optional): The service for which to retrieve appointments.
+
+    Returns:
+        tuple: A tuple containing two elements:
+            - A queryset of appointments for the given date and service (if provided).
+            - A list of available time slots on the given date, excluding booked appointments.
+
+    Author: Adams Pierre David
+    Version: 1.1.0
+    Since: 1.1.0
+    """
     if service:
         appointments = Appointment.objects.filter(appointment_request__service=service,
                                                   appointment_request__date=date_)
@@ -22,11 +40,37 @@ def get_appointments_and_slots(date_, service=None):
     return appointments, available_slots
 
 
-def get_user_by_email(email):
+def get_user_by_email(email: str):
+    """
+    Get a user by their email address.
+
+    Args:
+        email (str): The email address of the user.
+
+    Returns:
+        AppointmentClientModel: The user with the specified email address, if found; otherwise, None.
+
+    Author: Adams Pierre David
+    Version: 1.1.0
+    Since: 1.1.0
+    """
     return CLIENT_MODEL.objects.filter(email=email).first()
 
 
 def create_new_user(client_data):
+    """
+    Create a new user and save it to the database.
+
+    Args:
+        client_data (dict): The data of the new user, including name and email.
+
+    Returns:
+        AppointmentClientModel: The newly created user.
+
+    Author: Adams Pierre David
+    Version: 1.1.0
+    Since: 1.1.0
+    """
     username = client_data['email'].split('@')[0]
     user = CLIENT_MODEL.objects.create_user(first_name=client_data['name'], email=client_data['email'],
                                             username=username)
@@ -37,6 +81,21 @@ def create_new_user(client_data):
 
 
 def create_and_save_appointment(ar, client_data, appointment_data):
+    """
+    Create and save a new appointment based on the provided appointment request and client data.
+
+    Args:
+        ar (AppointmentRequest): The appointment request associated with the new appointment.
+        client_data (dict): The data of the client making the appointment.
+        appointment_data (dict): Additional data for the appointment, including phone number, address, etc.
+
+    Returns:
+        Appointment: The newly created appointment.
+
+    Author: Adams Pierre David
+    Version: 1.1.0
+    Since: 1.1.0
+    """
     user = get_user_by_email(client_data['email'])
     appointment = Appointment.objects.create(
         client=user, appointment_request=ar,
@@ -48,6 +107,19 @@ def create_and_save_appointment(ar, client_data, appointment_data):
 
 
 def create_payment_info_and_get_url(appointment):
+    """
+    Create a new payment information entry for the appointment and return the payment URL.
+
+    Args:
+        appointment (Appointment): The appointment for which to create payment information.
+
+    Returns:
+        str: The payment URL for the appointment.
+
+    Author: Adams Pierre David
+    Version: 1.1.0
+    Since: 1.1.0
+    """
     payment_info = PaymentInfo(appointment=appointment)
     payment_info.save()
     payment_url = reverse(