Merge pull request #132 from TreyWW/enhance/api-for-changing-currency

Added api for changing currency + tests

Author: TreyWW

backend/api/settings/currency.py

@@ -0,0 +1,32 @@
+from django.http import HttpResponse
+from django.shortcuts import redirect, render
+from django.contrib import messages
+from django.views.decorators.http import require_http_methods
+
+from backend.models import UserSettings  # Replace with your actual model
+
+
+@require_http_methods(["POST"])
+def update_currency_view(request):
+    currency = request.POST.get("currency", None)
+    usersettings, created = UserSettings.objects.get_or_create(user=request.user)
+
+    htmx_return = "partials/base/toasts.html"
+
+    if not request.htmx and not currency:
+        return HttpResponse("Invalid Request", status=400)
+    elif not currency or currency not in usersettings.CURRENCIES:
+        messages.error(request, "Invalid Currency")
+        return render(request, htmx_return)
+
+    if usersettings.currency == currency:
+        messages.warning(
+            request, "You are already using this currency, no change was made"
+        )
+        return render(request, htmx_return)
+
+    usersettings.currency = currency
+    usersettings.save()
+    messages.success(request, "Successfully updated currency")
+
+    return render(request, htmx_return)

backend/api/settings/urls.py

@@ -0,0 +1,12 @@
+from django.urls import path
+from . import currency
+
+urlpatterns = [
+    path(
+        "change_currency/",
+        currency.update_currency_view,
+        name="change_currency",
+    ),
+]
+
+app_name = "settings"

backend/api/urls.py

@@ -6,6 +6,7 @@
     path("receipts/", include("backend.api.receipts.urls")),
     path("invoices/", include("backend.api.invoices.urls")),
     path("clients/", include("backend.api.clients.urls")),
+    path("settings/", include("backend.api.settings.urls")),
 ]
 
 app_name = "api"

backend/views/core/settings/view.py

@@ -26,25 +26,9 @@ def settings_page(request: HttpRequest):
     )
 
     if request.method == "POST" and request.htmx:
-        currency = request.POST.get("currency")
         section = request.POST.get("section")
         profile_picture = request.FILES.get("profile_image")
 
-        if section == "account_preferences":
-            if currency in usersettings.CURRENCIES:
-                usersettings.currency = currency
-                usersettings.save()
-                messages.success(request, "Successfully updated currency")
-            else:
-                messages.error(request, "Invalid currency")
-
-            context.update(
-                {
-                    "post_return": "currency",
-                    "currency": usersettings.currency,
-                    "user_settings": usersettings,
-                }
-            )
         if section == "profile_picture":
             if profile_picture:
                 try:

frontend/templates/pages/settings/settings/preferences.html

@@ -24,8 +24,8 @@
                 <div class="flex items-center justify-between py-4">
                     <div class="flex flex-col flex-grow">
                         <div class="text-lg font-semibold text-gray-900 dark:text-white">Currency</div>
-                        <div class="text-base font-normal text-gray-500 dark:text-gray-400 whitespace-nowrap">This will change the
-                                                                                                              default currency
+                        <div class="text-base font-normal text-gray-500 dark:text-gray-400 whitespace-nowrap">
+                            This will change the default currency for your account
                         </div>
                     </div>
                     <select name="currency" class="select select-bordered w-[25%]">
@@ -40,7 +40,7 @@
             </div>
             <button class="btn btn-primary mb-2 loading-htmx"
                     name="section" value="account_preferences"
-                    hx-post="{% url 'user settings' %}"
+                    hx-post="{% url 'api:settings:change_currency' %}"
                     hx-swap="none"
                     hx-trigger="click">
                 <span class="loading-htmx-text">Save</span>

tests/api/test_account_settings.py

@@ -0,0 +1,70 @@
+from django.urls import reverse, resolve
+from backend.models import UserSettings
+from tests.handler import ViewTestCase, assert_url_matches_view
+
+
+class CurrencyAPIChange(ViewTestCase):
+    # Setting up common data for tests
+    def setUp(self):
+        super().setUp()
+        self.url_path = "/api/settings/change_currency/"
+        self.url_name = "api:settings:change_currency"
+        self.view_function_path = "backend.api.settings.currency.update_currency_view"
+
+    # Test that the URL resolves to the correct view function
+    def test_url_matches_api(self):
+        assert_url_matches_view(self.url_path, self.url_name, self.view_function_path)
+
+    # Test that the view returns a 405 Method Not Allowed for GET requests
+    def test_405_for_get_requests(self):
+        self.login_user()
+        response = self.make_request(method="get", with_htmx=False)
+        self.assertEqual(response.status_code, 405)
+        self.assertEqual(response.content.decode("utf-8"), "")
+
+    # Test that the view returns a 400 Bad Request for POST requests without HTMX
+    def test_400_for_all_normal_get_requests(self):
+        self.login_user()
+        response = self.make_request(method="post", with_htmx=False)
+        self.assertEqual(response.status_code, 400)
+        self.assertEqual(response.content.decode("utf-8"), "Invalid Request")
+
+    # Test that non-authenticated users are redirected to the login page for GET requests
+    def test_302_for_non_authenticated_users(self):
+        response = self.client.get(reverse(self.url_name))
+        self.assertRedirects(response, f"/login/?next={self.url_path}", 302)
+
+    # Test that an error message is displayed when no currency is provided in the POST request
+    def test_no_currency_provided(self):
+        self.login_user()
+        response = self.make_request(method="post", with_htmx=True)
+        self.assertEqual(response.status_code, 200)
+        messages = self.get_all_messages(response)
+        self.assertEqual(len(messages), 1)
+        self.assertEqual(str(messages[0]), "Invalid Currency")
+
+    # Test that users receive a message when trying to update to their current currency
+    def test_currency_is_already_that(self):
+        self.login_user()
+        response = self.make_request(
+            method="post", data={"currency": "GBP"}, with_htmx=True
+        )
+        self.assertEqual(response.status_code, 200)
+        messages = self.get_all_messages(response)
+        self.assertEqual(len(messages), 1)
+        self.assertEqual(
+            str(messages[0]), "You are already using this currency, no change was made"
+        )
+
+    # Test that the user's currency is updated successfully
+    def test_currency_is_updated(self):
+        self.login_user()
+        response = self.make_request(
+            method="post", data={"currency": "EUR"}, with_htmx=True
+        )
+        self.assertEqual(response.status_code, 200)
+        messages = self.get_all_messages(response)
+        self.assertEqual(len(messages), 1)
+        self.assertEqual(str(messages[0]), "Successfully updated currency")
+        user_settings = UserSettings.objects.get(user=self.log_in_user)
+        self.assertEqual(user_settings.currency, "EUR")

tests/handler.py

@@ -1,3 +1,4 @@
+from django.contrib.messages import get_messages
 from django.urls import reverse
 from django.test import TestCase
 from backend.models import User, Receipt, UserSettings
@@ -73,9 +74,18 @@ def call_index(self):
     def login_user(self):
         self.client.login(username="user@example.com", password="user")
 
-    def make_request(self, with_htmx=True):
+    def make_request(self, method="get", data={}, with_htmx=True):
         """
         Makes request to self.url_name, defaults "with htmx"
         """
         headers = self.htmx_headers if with_htmx else {}
-        return self.client.get(reverse(self.url_name), **headers)
+        if method == "post":
+            return self.client.post(reverse(self.url_name), data, **headers)
+        else:
+            return self.client.get(reverse(self.url_name), **headers)
+
+    def get_all_messages(self, response):
+        try:
+            return list(get_messages(response.wsgi_request))
+        except:
+            return []