Currency model implementation

Author: Jeeziorny

src/hope/admin/currency.py

@@ -0,0 +1,12 @@
+from django.contrib import admin
+
+from hope.admin.utils import HOPEModelAdminBase
+from hope.models import Currency
+
+
+@admin.register(Currency)
+class CurrencyAdmin(HOPEModelAdminBase):
+    list_display = ("code", "name", "is_crypto")
+    list_filter = ("is_crypto",)
+    search_fields = ("code", "name")
+    ordering = ("code",)

src/hope/admin/payment_plan.py

@@ -90,7 +90,7 @@ class PaymentPlanAdmin(HOPEModelAdminBase, PaymentPlanCeleryTasksMixin):
         ("business_area", AutoCompleteFilter),
         ("program_cycle__program", AutoCompleteFilter),
         ("program_cycle__program__id", ValueFilter),
-        ("currency", AutoCompleteFilter),
+        ("currency__code", AutoCompleteFilter),
         ("status", ChoicesFieldComboFilter),
         ("background_action_status", ChoicesFieldComboFilter),
         ("build_status", ChoicesFieldComboFilter),

src/hope/apps/core/api/views.py

@@ -26,7 +26,6 @@
     GetKoboAssetListSerializer,
     KoboAssetObjectSerializer,
 )
-from hope.apps.core.currencies import CURRENCY_CHOICES
 from hope.apps.core.field_attributes.fields_types import TYPE_STRING
 from hope.apps.core.languages import Languages
 from hope.apps.core.utils import (
@@ -146,7 +145,10 @@ class ChoicesViewSet(ViewSet):
     @extend_schema(responses={200: ChoiceSerializer(many=True)})
     @action(detail=False, methods=["get"], url_path="currencies")
     def currencies(self, request: Request) -> Response:
-        resp = ChoiceSerializer(to_choice_object([c for c in CURRENCY_CHOICES if c[0] != ""]), many=True).data
+        from hope.models.currency import Currency
+
+        choices = Currency.objects.values_list("code", "name").order_by("code")
+        resp = ChoiceSerializer(to_choice_object(list(choices)), many=True).data
         return Response(resp)
 
     @extend_schema(responses={200: ChoiceSerializer(many=True)})

src/hope/apps/core/field_attributes/core_fields_attributes.py

@@ -31,7 +31,6 @@
     registration_data_import_query,
 )
 from hope.apps.core.countries import Countries
-from hope.apps.core.currencies import CURRENCY_CHOICES
 from hope.apps.core.field_attributes.fields_types import (
     _HOUSEHOLD,
     _INDIVIDUAL,
@@ -74,7 +73,6 @@
 )
 from hope.apps.core.languages import Languages
 from hope.apps.household.const import (
-    BLANK,
     DATA_SHARING_CHOICES,
     DISABILITY_CHOICES,
     MARITAL_STATUS_CHOICE,
@@ -89,6 +87,7 @@
     WORK_STATUS_CHOICE,
 )
 from hope.models import Area, Country
+from hope.models.currency import Currency
 from hope.models.registration_data_import import RegistrationDataImport
 
 logger = logging.getLogger(__name__)
@@ -722,10 +721,9 @@
         "required": False,
         "label": {"English(EN)": "Which currency will be used for financial questions?"},
         "hint": "",
-        "choices": [
-            {"label": {"English(EN)": currency_name}, "value": code}
-            for code, currency_name in CURRENCY_CHOICES
-            if code != BLANK
+        "choices": [],
+        "_choices": lambda *args, **kwargs: [
+            {"label": {"English(EN)": c.name}, "value": c.code} for c in Currency.objects.all().order_by("code")
         ],
         "associated_with": _HOUSEHOLD,
         "xlsx_field": "currency_h_c",

src/hope/apps/core/management/commands/initdemo.py

@@ -48,12 +48,14 @@
 """
 
 from argparse import ArgumentParser
+import importlib
 import logging
 import os
 import time
 from typing import Any
 
 from constance import config
+from django.apps import apps
 from django.conf import settings
 from django.core.management import BaseCommand, call_command
 from django.db import Error, OperationalError, connections
@@ -131,6 +133,9 @@ def _wait_for_database(self) -> None:
 
     def _setup_base_fixtures(self) -> User:
         self.stdout.write("Loading fixtures...")
+        self.stdout.write("Seeding currencies...")
+        migration = importlib.import_module("hope.apps.core.migrations.0018_migration")
+        migration.seed_currencies(apps, None)
         call_command("generateroles")
         generate_unicef_partners()
         call_command("loadcountries")

src/hope/apps/core/migrations/0018_migration.py

@@ -0,0 +1,204 @@
+from django.db import migrations, models
+
+CURRENCIES = [
+    ("AED", "United Arab Emirates dirham", False),
+    ("AFN", "Afghan afghani", False),
+    ("ALL", "Albanian lek", False),
+    ("AMD", "Armenian dram", False),
+    ("ANG", "Netherlands Antillean guilder", False),
+    ("AOA", "Angolan kwanza", False),
+    ("ARS", "Argentine peso", False),
+    ("AUD", "Australian dollar", False),
+    ("AWG", "Aruban florin", False),
+    ("AZN", "Azerbaijani manat", False),
+    ("BAM", "Bosnia and Herzegovina convertible mark", False),
+    ("BBD", "Barbados dollar", False),
+    ("BDT", "Bangladeshi taka", False),
+    ("BGN", "Bulgarian lev", False),
+    ("BHD", "Bahraini dinar", False),
+    ("BIF", "Burundian franc", False),
+    ("BMD", "Bermudian dollar", False),
+    ("BND", "Brunei dollar", False),
+    ("BOB", "Boliviano", False),
+    ("BOV", "Bolivian Mvdol (funds code)", False),
+    ("BRL", "Brazilian real", False),
+    ("BSD", "Bahamian dollar", False),
+    ("BTN", "Bhutanese ngultrum", False),
+    ("BWP", "Botswana pula", False),
+    ("BYN", "Belarusian ruble", False),
+    ("BZD", "Belize dollar", False),
+    ("CAD", "Canadian dollar", False),
+    ("CDF", "Congolese franc", False),
+    ("CHF", "Swiss franc", False),
+    ("CLP", "Chilean peso", False),
+    ("CNY", "Chinese yuan", False),
+    ("COP", "Colombian peso", False),
+    ("CRC", "Costa Rican colon", False),
+    ("CUC", "Cuban convertible peso", False),
+    ("CUP", "Cuban peso", False),
+    ("CVE", "Cape Verdean escudo", False),
+    ("CZK", "Czech koruna", False),
+    ("DJF", "Djiboutian franc", False),
+    ("DKK", "Danish krone", False),
+    ("DOP", "Dominican peso", False),
+    ("DZD", "Algerian dinar", False),
+    ("EGP", "Egyptian pound", False),
+    ("ERN", "Eritrean nakfa", False),
+    ("ETB", "Ethiopian birr", False),
+    ("EUR", "Euro", False),
+    ("FJD", "Fiji dollar", False),
+    ("FKP", "Falkland Islands pound", False),
+    ("GBP", "Pound sterling", False),
+    ("GEL", "Georgian lari", False),
+    ("GHS", "Ghanaian cedi", False),
+    ("GIP", "Gibraltar pound", False),
+    ("GMD", "Gambian dalasi", False),
+    ("GNF", "Guinean franc", False),
+    ("GTQ", "Guatemalan quetzal", False),
+    ("GYD", "Guyanese dollar", False),
+    ("HKD", "Hong Kong dollar", False),
+    ("HNL", "Honduran lempira", False),
+    ("HRK", "Croatian kuna", False),
+    ("HTG", "Haitian gourde", False),
+    ("HUF", "Hungarian forint", False),
+    ("IDR", "Indonesian rupiah", False),
+    ("ILS", "Israeli new shekel", False),
+    ("INR", "Indian rupee", False),
+    ("IQD", "Iraqi dinar", False),
+    ("IRR", "Iranian rial", False),
+    ("ISK", "Icelandic króna", False),
+    ("JMD", "Jamaican dollar", False),
+    ("JOD", "Jordanian dinar", False),
+    ("JPY", "Japanese yen", False),
+    ("KES", "Kenyan shilling", False),
+    ("KGS", "Kyrgyzstani som", False),
+    ("KHR", "Cambodian riel", False),
+    ("KMF", "Comoro franc", False),
+    ("KPW", "North Korean won", False),
+    ("KRW", "South Korean won", False),
+    ("KWD", "Kuwaiti dinar", False),
+    ("KYD", "Cayman Islands dollar", False),
+    ("KZT", "Kazakhstani tenge", False),
+    ("LAK", "Lao kip", False),
+    ("LBP", "Lebanese pound", False),
+    ("LKR", "Sri Lankan rupee", False),
+    ("LRD", "Liberian dollar", False),
+    ("LSL", "Lesotho loti", False),
+    ("LYD", "Libyan dinar", False),
+    ("MAD", "Moroccan dirham", False),
+    ("MDL", "Moldovan leu", False),
+    ("MGA", "Malagasy ariary", False),
+    ("MKD", "Macedonian denar", False),
+    ("MMK", "Myanmar kyat", False),
+    ("MNT", "Mongolian tögrög", False),
+    ("MOP", "Macanese pataca", False),
+    ("MRU", "Mauritanian ouguiya", False),
+    ("MUR", "Mauritian rupee", False),
+    ("MVR", "Maldivian rufiyaa", False),
+    ("MWK", "Malawian kwacha", False),
+    ("MXN", "Mexican peso", False),
+    ("MYR", "Malaysian ringgit", False),
+    ("MZN", "Mozambican metical", False),
+    ("NAD", "Namibian dollar", False),
+    ("NGN", "Nigerian naira", False),
+    ("NIO", "Nicaraguan córdoba", False),
+    ("NOK", "Norwegian krone", False),
+    ("NPR", "Nepalese rupee", False),
+    ("NZD", "New Zealand dollar", False),
+    ("OMR", "Omani rial", False),
+    ("PAB", "Panamanian balboa", False),
+    ("PEN", "Peruvian sol", False),
+    ("PGK", "Papua New Guinean kina", False),
+    ("PHP", "Philippine peso", False),
+    ("PKR", "Pakistani rupee", False),
+    ("PLN", "Polish złoty", False),
+    ("PYG", "Paraguayan guaraní", False),
+    ("QAR", "Qatari riyal", False),
+    ("RON", "Romanian leu", False),
+    ("RSD", "Serbian dinar", False),
+    ("RUB", "Russian ruble", False),
+    ("RWF", "Rwandan franc", False),
+    ("SAR", "Saudi riyal", False),
+    ("SBD", "Solomon Islands dollar", False),
+    ("SCR", "Seychelles rupee", False),
+    ("SDG", "Sudanese pound", False),
+    ("SEK", "Swedish krona/kronor", False),
+    ("SGD", "Singapore dollar", False),
+    ("SHP", "Saint Helena pound", False),
+    ("SLE", "Sierra Leonean leone", False),
+    ("SOS", "Somali shilling", False),
+    ("SRD", "Surinamese dollar", False),
+    ("SSP", "South Sudanese pound", False),
+    ("STN", "São Tomé and Príncipe dobra", False),
+    ("SVC", "Salvadoran colón", False),
+    ("SYP", "Syrian pound Old", False),
+    ("SYP01", "Syrian pound", False),
+    ("SZL", "Swazi lilangeni", False),
+    ("THB", "Thai baht", False),
+    ("TJS", "Tajikistani somoni", False),
+    ("TMT", "Turkmenistan manat", False),
+    ("TND", "Tunisian dinar", False),
+    ("TOP", "Tongan paʻanga", False),
+    ("TRY", "Turkish lira", False),
+    ("TTD", "Trinidad and Tobago dollar", False),
+    ("TWD", "New Taiwan dollar", False),
+    ("TZS", "Tanzanian shilling", False),
+    ("UAH", "Ukrainian hryvnia", False),
+    ("UGX", "Ugandan shilling", False),
+    ("USD", "United States dollar", False),
+    ("USDC", "USD Coin", True),
+    ("UYU", "Uruguayan peso", False),
+    ("UYW", "Unidad previsional[14]", False),
+    ("UZS", "Uzbekistan som", False),
+    ("VES", "Venezuelan bolívar soberano", False),
+    ("VND", "Vietnamese đồng", False),
+    ("VUV", "Vanuatu vatu", False),
+    ("WST", "Samoan tala", False),
+    ("XAF", "CFA franc BEAC", False),
+    ("XAG", "Silver (one troy ounce)", False),
+    ("XAU", "Gold (one troy ounce)", False),
+    ("XCD", "East Caribbean dollar", False),
+    ("XOF", "CFA franc BCEAO", False),
+    ("XPF", "CFP franc (franc Pacifique)", False),
+    ("YER", "Yemeni rial", False),
+    ("ZAR", "South African rand", False),
+    ("ZMW", "Zambian kwacha", False),
+    ("ZWL", "Zimbabwean dollar", False),
+]
+
+
+def seed_currencies(apps, schema_editor):
+    Currency = apps.get_model("core", "Currency")
+    currencies = [Currency(code=code, name=name, is_crypto=is_crypto) for code, name, is_crypto in CURRENCIES]
+    Currency.objects.bulk_create(currencies)
+
+
+def reverse_seed(apps, schema_editor):
+    Currency = apps.get_model("core", "Currency")
+    Currency.objects.all().delete()
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("core", "0017_migration"),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name="Currency",
+            fields=[
+                ("id", models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name="ID")),
+                ("code", models.CharField(db_index=True, max_length=5, unique=True)),
+                ("name", models.CharField(max_length=255)),
+                (
+                    "is_crypto",
+                    models.BooleanField(default=False, help_text="Whether this is a cryptocurrency (e.g. USDC)"),
+                ),
+            ],
+            options={
+                "ordering": ["code"],
+                "verbose_name_plural": "currencies",
+            },
+        ),
+        migrations.RunPython(seed_currencies, reverse_seed),
+    ]

src/hope/apps/core/models.py

@@ -1 +1,2 @@
+from hope.models.currency import Currency  # noqa
 from hope.models.custom_model_entry import CustomDatabaseScheduler  # noqa

src/hope/apps/dashboard/services.py

@@ -243,7 +243,7 @@ def _get_payment_data(cls, base_queryset: models.QuerySet) -> models.QuerySet:
             month=ExtractMonth(date_field),
             business_area_name=Coalesce(F("business_area__name"), Value("Unknown Country")),
             region_name=Coalesce(F("business_area__region_name"), Value("Unknown Region")),
-            currency_code=Coalesce(F("currency"), Value("UNK")),
+            currency_code=Coalesce(F("currency__code"), Value("UNK")),
             admin1_name=Coalesce(F("household__admin1__name"), Value("Unknown Admin1")),
             program_name=Coalesce(
                 F("program__name"),
@@ -338,7 +338,7 @@ def _get_payment_plan_counts(
             "month": ExtractMonth(date_field),
             "business_area_name": Coalesce(F("business_area__name"), Value("Unknown Country")),
             "region_name": Coalesce(F("business_area__region_name"), Value("Unknown Region")),
-            "currency_code": Coalesce(F("currency"), Value("UNK")),
+            "currency_code": Coalesce(F("currency__code"), Value("UNK")),
             "admin1_name": Coalesce(F("household__admin1__name"), Value("Unknown Admin1")),
             "program_name": Coalesce(
                 F("program__name"),

src/hope/apps/grievance/services/data_change/individual_data_update_service.py

@@ -46,6 +46,7 @@
 from hope.apps.household.services.household_recalculate_data import recalculate_data
 from hope.apps.utils.phone import is_valid_phone_number
 from hope.models import Account, Area, Country, Document, Household, Individual, IndividualIdentity, log_create
+from hope.models.currency import Currency
 
 
 @dataclasses.dataclass
@@ -292,6 +293,8 @@ def _update_household_fields(self, household: Household, only_approved_data: dic
                 hh_approved_data["country_origin"] = Country.objects.filter(iso_code3=hh_country_origin).first()
             if hh_country := hh_approved_data.get("country"):
                 hh_approved_data["country"] = Country.objects.filter(iso_code3=hh_country).first()
+            if hh_currency := hh_approved_data.get("currency"):
+                hh_approved_data["currency"] = Currency.objects.filter(code=hh_currency).first()
             admin_area_title = hh_approved_data.pop("admin_area_title", None)
             Household.objects.filter(id=household.id).update(**hh_approved_data, updated_at=timezone.now())
             updated_household = Household.objects.get(id=household.id)

src/hope/apps/household/api/serializers/household.py

@@ -58,6 +58,7 @@ class HouseholdListSerializer(serializers.ModelSerializer):
     program_name = serializers.CharField(source="program.name")
     program_code = serializers.CharField(source="program.code")
     facility_name = serializers.CharField(source="facility.name", read_only=True)
+    currency = serializers.SlugRelatedField(slug_field="code", read_only=True, allow_null=True)
 
     class Meta:
         model = Household
@@ -230,6 +231,7 @@ class HouseholdDetailSerializer(AdminUrlSerializerMixin, serializers.ModelSerial
     program = serializers.CharField(source="program.name")
     country = serializers.CharField(source="country.name", default="")
     country_origin = serializers.CharField(source="country_origin.name", default="")
+    currency = serializers.SlugRelatedField(slug_field="code", read_only=True, allow_null=True)
     total_cash_received = serializers.DecimalField(max_digits=64, decimal_places=2)
     total_cash_received_usd = serializers.DecimalField(max_digits=64, decimal_places=2)
     has_duplicates = serializers.SerializerMethodField()