Merge pull request #165 from adamspd/appointment-view-use-forms

use a form for available slots

Author: adamspd

appointment/forms.py

@@ -16,6 +16,12 @@
     WorkingHours
 )
 from .utils.db_helpers import get_user_model
+from .utils.validators import not_in_the_past
+
+
+class SlotForm(forms.Form):
+    selected_date = forms.DateField(validators=[not_in_the_past])
+    staff_member = forms.ModelChoiceField(StaffMember.objects.all(), error_messages={'invalid_choice': 'Staff member does not exist'})
 
 
 class AppointmentRequestForm(forms.ModelForm):
@@ -64,6 +70,11 @@ def __init__(self, *args, **kwargs):
             })
 
 
+class ClientDataForm(forms.Form):
+    name = forms.CharField(max_length=50, widget=forms.TextInput(attrs={'class': 'form-control'}))
+    email = forms.EmailField(widget=forms.EmailInput(attrs={'class': 'form-control'}))
+
+
 class PersonalInformationForm(forms.Form):
     # first_name, last_name, email
     first_name = forms.CharField(max_length=50, widget=forms.TextInput(attrs={'class': 'form-control'}))

appointment/static/js/appointments.js

@@ -158,7 +158,7 @@ function fetchNonWorkingDays(staffId, callback) {
         return;  // Exit the function early
     }
     let ajaxData = {
-        'staff_id': staffId,
+        'staff_member': staffId,
     };
 
     $.ajax({
@@ -231,7 +231,7 @@ function getAvailableSlots(selectedDate, staffId = null) {
 
     let ajaxData = {
         'selected_date': selectedDate,
-        'staff_id': staffId,
+        'staff_member': staffId,
     };
     fetchNonWorkingDays(staffId, function (nonWorkingDays) {
         // Check if nonWorkingDays is an array
@@ -325,7 +325,7 @@ function requestNextAvailableSlot(serviceId) {
         return;
     }
     let ajaxData = {
-        'staff_id': staffId,
+        'staff_member': staffId,
     };
     $.ajax({
         url: requestNextAvailableSlotURL,

appointment/templates/appointment/appointment_client_information.html

@@ -44,14 +44,11 @@ <h1 class="description-title">{% trans "Tell us a bit about yourself" %}</h1>
                                 </div>
                             </div>
                             <div class="name-email">
-                                <label for="name" class="name">{% trans "Full Name" %} *<br>
-                                    <input type="text" placeholder="John DOE" id="name" class="client-name"
-                                           maxlength="100" minlength="3" required name="name">
+                                <label for="{{ form.name.id_for_label }}" class="name">{% trans "Full Name" %} *<br>
+                                    {{ client_data_form.name }}
                                 </label>
-                                <label for="email" class="email">{% trans "Email" %} *<br>
-                                    <input type="email" placeholder="[email protected]" id="email"
-                                           class="client-email" name="email"
-                                           maxlength="100" required>
+                                <label for="{{ form.email.id_for_label }}" class="email">{% trans "Email" %} *<br>
+                                    {{ client_data_form.email }}
                                 </label>
                             </div>
                             <div class="receive-email">

appointment/tests/test_views.py

@@ -29,10 +29,7 @@
 from appointment.tests.base.base_test import BaseTest
 from appointment.utils.db_helpers import Service, WorkingHours, create_user_with_username
 from appointment.utils.error_codes import ErrorCode
-from appointment.views import (
-    create_appointment, get_appointment_data_from_post_request, get_client_data_from_post,
-    redirect_to_payment_or_thank_you_page, verify_user_and_login
-)
+from appointment.views import create_appointment, redirect_to_payment_or_thank_you_page, verify_user_and_login
 
 
 class SlotTestCase(BaseTest):
@@ -43,21 +40,23 @@ def setUp(self):
 
     def test_get_available_slots_ajax(self):
         """get_available_slots_ajax view should return a JSON response with available slots for the selected date."""
-        response = self.client.get(self.url, {'selected_date': date.today().isoformat()},
+        response = self.client.get(self.url, {'selected_date': date.today().isoformat(), 'staff_member': self.staff_member1.id},
                                    HTTP_X_REQUESTED_WITH='XMLHttpRequest')
-        self.assertEqual(response.status_code, 403)
         response_data = response.json()
         self.assertIn('date_chosen', response_data)
         self.assertIn('available_slots', response_data)
         self.assertFalse(response_data.get('error'))
 
-    def test_get_available_slots_ajax_past_date(self):
+    def test_get_available_slots_ajax_invalid_form(self):
         """get_available_slots_ajax view should return an error if the selected date is in the past."""
         past_date = (date.today() - timedelta(days=1)).isoformat()
         response = self.client.get(self.url, {'selected_date': past_date}, HTTP_X_REQUESTED_WITH='XMLHttpRequest')
-        self.assertEqual(response.status_code, 200)
         self.assertEqual(response.json()['error'], True)
         self.assertEqual(response.json()['message'], 'Date is in the past')
+        # invalid staff id
+        response = self.client.get(self.url, {'selected_date': date.today(), 'staff_member': 999}, HTTP_X_REQUESTED_WITH='XMLHttpRequest')
+        self.assertEqual(response.json()['error'], True)
+        self.assertEqual(response.json()['message'], 'Staff member does not exist')
 
 
 class AppointmentRequestTestCase(BaseTest):
@@ -1043,114 +1042,6 @@ def test_notify_admin_about_reschedule_called(self, mock_notify_admin):
         self.assertTrue(mock_notify_admin.called)
 
 
-class GetAppointmentDataFromPostRequestTests(BaseTest):
-    def setUp(self):
-        self.factory = RequestFactory()
-        self.post_data = {
-            'phone': '1234567890',
-            'want_reminder': 'on',
-            'address': '123 Test St, Test City',
-            'additional_info': 'Please ring the bell.'
-        }
-
-    def test_get_appointment_data_from_post_request_with_data(self):
-        """Test retrieving appointment data from a POST request with all data provided."""
-        request = self.factory.post('/fake-url/', self.post_data)
-
-        appointment_data = get_appointment_data_from_post_request(request)
-
-        self.assertEqual(appointment_data['phone'], self.post_data['phone'])
-        self.assertTrue(appointment_data['want_reminder'])
-        self.assertEqual(appointment_data['address'], self.post_data['address'])
-        self.assertEqual(appointment_data['additional_info'], self.post_data['additional_info'])
-
-    def test_get_appointment_data_from_post_request_partial_data(self):
-        """Test retrieving appointment data from a POST request with partial data provided."""
-        partial_post_data = {
-            'phone': '1234567890',
-            # 'want_reminder' omitted to simulate unchecked checkbox
-            'address': '123 Test St, Test City',
-            # 'additional_info' omitted to simulate empty field
-        }
-        request = self.factory.post('/fake-url/', partial_post_data)
-
-        appointment_data = get_appointment_data_from_post_request(request)
-
-        self.assertEqual(appointment_data['phone'], partial_post_data['phone'])
-        self.assertFalse(appointment_data['want_reminder'], "want_reminder should be False if not 'on'")
-        self.assertEqual(appointment_data['address'], partial_post_data['address'])
-        self.assertEqual(appointment_data['additional_info'], None, "additional_info should be None if not provided")
-
-    def test_get_appointment_data_from_post_request_missing_data(self):
-        """Test retrieving appointment data from a POST request with missing data."""
-        missing_data_post = {}
-        request = self.factory.post('/fake-url/', missing_data_post)
-
-        appointment_data = get_appointment_data_from_post_request(request)
-
-        self.assertEqual(appointment_data['phone'], None, "phone should be None if not provided")
-        self.assertFalse(appointment_data['want_reminder'], "want_reminder should be False if not provided")
-        self.assertEqual(appointment_data['address'], None, "address should be None if not provided")
-        self.assertEqual(appointment_data['additional_info'], None, "additional_info should be None if not provided")
-
-
-class GetClientDataFromPostTests(BaseTest):
-    def setUp(self):
-        self.factory = RequestFactory()
-
-    def test_get_client_data_with_full_data(self):
-        """Test retrieving client data from a POST request with all fields provided."""
-        post_data = {
-            'name': 'John Doe',
-            'email': '[email protected]',
-        }
-        request = self.factory.post('/fake-url/', post_data)
-
-        client_data = get_client_data_from_post(request)
-
-        self.assertEqual(client_data['name'], post_data['name'])
-        self.assertEqual(client_data['email'], post_data['email'])
-
-    def test_get_client_data_with_missing_name(self):
-        """Test retrieving client data from a POST request with the name missing."""
-        post_data = {
-            # 'name' is missing
-            'email': '[email protected]',
-        }
-        request = self.factory.post('/fake-url/', post_data)
-
-        client_data = get_client_data_from_post(request)
-
-        self.assertIsNone(client_data['name'], "name should be None if not provided")
-        self.assertEqual(client_data['email'], post_data['email'])
-
-    def test_get_client_data_with_missing_email(self):
-        """Test retrieving client data from a POST request with the email missing."""
-        post_data = {
-            'name': 'John Doe',
-            # 'email' is missing
-        }
-        request = self.factory.post('/fake-url/', post_data)
-
-        client_data = get_client_data_from_post(request)
-
-        self.assertEqual(client_data['name'], post_data['name'])
-        self.assertIsNone(client_data['email'], "email should be None if not provided")
-
-    def test_get_client_data_with_empty_fields(self):
-        """Test retrieving client data from a POST request with empty fields."""
-        post_data = {
-            'name': '',
-            'email': '',
-        }
-        request = self.factory.post('/fake-url/', post_data)
-
-        client_data = get_client_data_from_post(request)
-
-        self.assertEqual(client_data['name'], '', "name should be empty string if provided as such")
-        self.assertEqual(client_data['email'], '', "email should be empty string if provided as such")
-
-
 class RedirectToPaymentOrThankYouPageTests(BaseTest):
     def setUp(self):
         super().setUp()

appointment/utils/validators.py

@@ -0,0 +1,7 @@
+from django.core.exceptions import ValidationError
+from django.utils.translation import gettext_lazy as _
+
+
+def not_in_the_past(date):
+    if date < date.today():
+        raise ValidationError(_('Date is in the past'))

appointment/views.py

@@ -21,7 +21,7 @@
 from django.utils.timezone import get_current_timezone_name
 from django.utils.translation import gettext as _
 
-from appointment.forms import AppointmentForm, AppointmentRequestForm
+from appointment.forms import AppointmentForm, AppointmentRequestForm, SlotForm, ClientDataForm
 from appointment.logger_config import logger
 from appointment.models import (
     Appointment, AppointmentRequest, AppointmentRescheduleHistory, Config, DayOff, EmailVerificationCode,
@@ -57,28 +57,23 @@ def get_available_slots_ajax(request):
     :param request: The request instance.
     :return: A JSON response containing available slots, selected date, an error flag, and an optional error message.
     """
-    selected_date = convert_str_to_date(request.GET.get('selected_date'))
-    staff_id = request.GET.get('staff_id')
 
-    if selected_date < date.today():
+    slot_form = SlotForm(request.GET)
+    if not slot_form.is_valid():
         custom_data = {'error': True, 'available_slots': [], 'date_chosen': ''}
-        message = _('Date is in the past')
+        if 'selected_date' in slot_form.errors:
+            error_code = ErrorCode.PAST_DATE
+        elif 'staff_member' in slot_form.errors:
+            error_code = ErrorCode.STAFF_ID_REQUIRED
+        message = list(slot_form.errors.as_data().items())[0][1][0].messages[0]  # dirty way to keep existing behavior
         return json_response(message=message, custom_data=custom_data, success=False,
-                             error_code=ErrorCode.PAST_DATE)
+                             error_code=error_code)
 
+    selected_date = slot_form.cleaned_data['selected_date']
+    sm = slot_form.cleaned_data['staff_member']
     date_chosen = selected_date.strftime("%a, %B %d, %Y")
     custom_data = {'date_chosen': date_chosen}
 
-    # If no staff_id provided, return an empty list of slots
-    if not staff_id or staff_id == 'none':
-        custom_data['available_slots'] = []
-        custom_data['error'] = False
-        message = _('No staff member selected')
-        return json_response(message=message, custom_data=custom_data, success=False,
-                             error_code=ErrorCode.STAFF_ID_REQUIRED, status=403)
-
-    sm = get_object_or_404(StaffMember, pk=staff_id)
-    custom_data['staff_member'] = sm.get_staff_member_name()
     days_off_exist = check_day_off_for_staff(staff_member=sm, date=selected_date)
     if days_off_exist:
         message = _("Day off. Please select another date!")
@@ -87,6 +82,8 @@ def get_available_slots_ajax(request):
     # if selected_date is not a working day for the staff, return an empty list of slots and 'message' is Day Off
     weekday_num = get_weekday_num_from_date(selected_date)
     is_working_day_ = is_working_day(staff_member=sm, day=weekday_num)
+
+    custom_data['staff_member'] = sm.get_staff_member_name()
     if not is_working_day_:
         message = _("Not a working day for {staff_member}. Please select another date!").format(
             staff_member=sm.get_staff_member_first_name())
@@ -108,6 +105,7 @@ def get_available_slots_ajax(request):
     return json_response(message='Successfully retrieved available slots', custom_data=custom_data, success=True)
 
 
+# TODO: service id and staff id are not checked
 @require_ajax
 def get_next_available_date_ajax(request, service_id):
     """This view function handles AJAX requests to get the next available date for a service.
@@ -292,32 +290,6 @@ def create_appointment(request, appointment_request_obj, client_data, appointmen
     return redirect_to_payment_or_thank_you_page(appointment)
 
 
-def get_client_data_from_post(request):
-    """This function retrieves client data from the POST request.
-
-    :param request: The request instance.
-    :return: The client data.
-    """
-    return {
-        'name': request.POST.get('name'),
-        'email': request.POST.get('email'),
-    }
-
-
-def get_appointment_data_from_post_request(request):
-    """This function retrieves appointment data from the POST request.
-
-    :param request: The request instance.
-    :return: The appointment data.
-    """
-    return {
-        'phone': request.POST.get('phone'),
-        'want_reminder': request.POST.get('want_reminder') == 'on',
-        'address': request.POST.get('address'),
-        'additional_info': request.POST.get('additional_info'),
-    }
-
-
 def appointment_client_information(request, appointment_request_id, id_request):
     """This view function handles client information submission for an appointment.
 
@@ -333,10 +305,11 @@ def appointment_client_information(request, appointment_request_id, id_request):
 
     if request.method == 'POST':
         appointment_form = AppointmentForm(request.POST)
+        client_data_form = ClientDataForm(request.POST)
 
-        if appointment_form.is_valid():
+        if appointment_form.is_valid() and client_data_form.is_valid():
             appointment_data = appointment_form.cleaned_data
-            client_data = get_client_data_from_post(request)
+            client_data = client_data_form.cleaned_data
             payment_type = request.POST.get('payment_type')
             ar.payment_type = payment_type
             ar.save()
@@ -356,11 +329,13 @@ def appointment_client_information(request, appointment_request_id, id_request):
             return response
     else:
         appointment_form = AppointmentForm()
+        client_data_form = ClientDataForm()
 
     extra_context = {
         'ar': ar,
         'APPOINTMENT_PAYMENT_URL': APPOINTMENT_PAYMENT_URL,
         'form': appointment_form,
+        'client_data_form': client_data_form,
         'service_name': ar.service.name,
     }
     context = get_generic_context_with_extra(request, extra_context, admin=False)