List supported currencies in API under api/currencies (spiral-project…

…#961) * List supported currencies in API under api/currencies * Added test for /currencies route
TomRoussel · Dec 13, 2021 · 9f063a3 · 9f063a3
1 parent d3cf7dc
commit 9f063a3
Show file tree

Hide file tree

Showing 4 changed files with 35 additions and 0 deletions.
diff --git a/docs/api.md b/docs/api.md
@@ -242,3 +242,23 @@ You can get some project stats with a `GET` on
             "balance": -10.5
         }
     ]
+
+### Currencies
+
+You can get a list of supported currencies with a `GET` on
+`/api/currencies`:
+
+    $ curl --basic https://ihatemoney.org/api/currencies
+    [
+        "XXX",
+        "AED",
+        "AFN",
+        .
+        .
+        .
+        "ZAR",
+        "ZMW",
+        "ZWL"
+    ]
+
+
diff --git a/ihatemoney/api/common.py b/ihatemoney/api/common.py
@@ -5,6 +5,7 @@
 from werkzeug.security import check_password_hash
 from wtforms.fields.core import BooleanField
 
+from ihatemoney.currency_convertor import CurrencyConverter
 from ihatemoney.emails import send_creation_email
 from ihatemoney.forms import EditProjectForm, MemberForm, ProjectForm, get_billform_for
 from ihatemoney.models import Bill, Person, Project, db
@@ -49,6 +50,13 @@ def wrapper(*args, **kwargs):
     return wrapper
 
 
+class CurrenciesHandler(Resource):
+    currency_helper = CurrencyConverter()
+
+    def get(self):
+        return self.currency_helper.get_currencies()
+
+
 class ProjectsHandler(Resource):
     def post(self):
         form = ProjectForm(meta={"csrf": False})

diff --git a/ihatemoney/api/v1/resources.py b/ihatemoney/api/v1/resources.py
@@ -5,6 +5,7 @@
 from ihatemoney.api.common import (
     BillHandler,
     BillsHandler,
+    CurrenciesHandler,
     MemberHandler,
     MembersHandler,
     ProjectHandler,
@@ -17,6 +18,7 @@
 CORS(api)
 restful_api = Api(api)
 
+restful_api.add_resource(CurrenciesHandler, "/currencies")
 restful_api.add_resource(ProjectsHandler, "/projects")
 restful_api.add_resource(ProjectHandler, "/projects/<string:project_id>")
 restful_api.add_resource(TokenHandler, "/projects/<string:project_id>/token")

diff --git a/ihatemoney/tests/api_test.py b/ihatemoney/tests/api_test.py
@@ -576,6 +576,11 @@ def test_bills_with_calculation(self):
             self.assertStatus(400, req)
 
     def test_currencies(self):
+        # check /currencies for list of supported currencies
+        resp = self.client.get("/api/currencies")
+        self.assertTrue(201, resp.status_code)
+        self.assertIn("XXX", json.loads(resp.data.decode("utf-8")))
+
         # create project with a default currency
         resp = self.api_create("raclette", default_currency="EUR")
         self.assertTrue(201, resp.status_code)