Allow posting strings to translations endpoint (#313)

* Allow JWT in query string for reports

* Allow posting strings to translation endpoint

Author: DavidMStraub

gramps_webapi/api/resources/translations.py

@@ -21,7 +21,7 @@
 """Translate API Resource."""
 
 import json
-from typing import Dict, Union
+from typing import Dict, List, Union
 
 from flask import Response, abort
 from gramps.gen.const import GRAMPS_LOCALE
@@ -72,7 +72,18 @@ def get(self, args: Dict, language: str) -> Response:
             strings = json.loads(args["strings"])
         except json.JSONDecodeError:
             abort(400)
+        return self._get_or_post(strings=strings, language=language)
 
+    @use_args(
+        {"strings": fields.List(fields.Str, required=True)},
+        location="json",
+    )
+    def post(self, args: Dict, language: str) -> Response:
+        """Get translation for posted strings."""
+        return self._get_or_post(strings=args["strings"], language=language)
+
+    def _get_or_post(self, strings: List[str], language: str) -> Response:
+        """Get translation."""
         catalog = GRAMPS_LOCALE.get_language_dict()
         for entry in catalog:
             if catalog[entry] == language:

gramps_webapi/api/util.py

@@ -28,7 +28,7 @@
 from http import HTTPStatus
 from typing import BinaryIO, Optional, Sequence
 
-from flask import abort, current_app, g, request
+from flask import abort, current_app, g, jsonify, make_response, request
 from gramps.gen.const import GRAMPS_LOCALE
 from gramps.gen.db.base import DbReadBase
 from gramps.gen.errors import HandleError
@@ -48,6 +48,16 @@ class Parser(FlaskParser):
     # raise in case of unknown query arguments
     DEFAULT_UNKNOWN_BY_LOCATION = {"query": RAISE}
 
+    def handle_error(self, error, req, schema, *, error_status_code, error_headers):
+        status_code = error_status_code or self.DEFAULT_VALIDATION_STATUS
+        abort(
+            make_response(jsonify(error.messages), status_code),
+            exc=error,
+            messages=error.messages,
+            schema=schema,
+            headers=error_headers,
+        )
+
 
 parser = Parser()
 use_args = parser.use_args

gramps_webapi/data/apispec.yaml

@@ -4972,7 +4972,39 @@ paths:
           description: "Not Found: Language code was not found."
         422:
           description: "Unprocessable Entity: Invalid or bad parameter provided."
-
+    post:
+      tags:
+      - translations
+      summary: "Get a translation in a specific language."
+      operationId: getTranslation
+      security:
+        - Bearer: []
+      parameters:
+      - name: language
+        in: path
+        required: true
+        type: string
+        description: "The language code or identifier."
+      - name: strings
+        in: body
+        required: true
+        type: string
+        description: "The list of strings to be translated. These must be provided in JSON format."
+      responses:
+        200:
+          description: "OK: Successful operation."
+          schema:
+            type: array
+            items:
+              $ref: "#/definitions/Translation"
+        400:
+          description: "Bad Request: Malformed request could not be parsed."
+        401:
+          description: "Unauthorized: Missing authorization header."
+        404:
+          description: "Not Found: Language code was not found."
+        422:
+          description: "Unprocessable Entity: Invalid or bad parameter provided."
 
 ##############################################################################
 # Endpoint - Relations

tests/test_endpoints/test_translations.py

@@ -22,6 +22,8 @@
 
 import unittest
 
+from gramps_webapi.auth.const import ROLE_OWNER
+
 from . import BASE_URL, get_test_client
 from .checks import (
     check_conforms_to_schema,
@@ -31,6 +33,7 @@
     check_resource_missing,
     check_success,
 )
+from .util import fetch_header
 
 TEST_URL = BASE_URL + "/translations/"
 
@@ -57,7 +60,7 @@ def test_get_translations_conforms_to_schema(self):
 
 
 class TestTranslationsLanguage(unittest.TestCase):
-    """Test cases for the /api/translations/{language} endpoint."""
+    """Test cases for the /api/translations/{language} endpoint using GET."""
 
     @classmethod
     def setUpClass(cls):
@@ -93,3 +96,33 @@ def test_get_translations_language_expected_result_multiple_values(self):
         self.assertEqual(len(rv), 2)
         self.assertEqual(rv[0], {"original": "Birth", "translation": "Naissance"})
         self.assertEqual(rv[1], {"original": "Death", "translation": "Décès"})
+
+
+class TestTranslationsLanguagePost(unittest.TestCase):
+    """Test cases for the /api/translations/{language} endpoint using POST."""
+
+    @classmethod
+    def setUpClass(cls):
+        """Test class setup."""
+        cls.client = get_test_client()
+
+    def test_get_translations_language_expected_result_single_value(self):
+        """Test response for single translation."""
+        header = fetch_header(self.client, role=ROLE_OWNER)
+        data = {"strings": ["Birth"]}
+        rv = self.client.post(TEST_URL + "fr", headers=header, json=data)
+        self.assertEqual(rv.status_code, 200)
+        rv = rv.json
+        self.assertEqual(len(rv), 1)
+        self.assertEqual(rv[0], {"original": "Birth", "translation": "Naissance"})
+
+    def test_get_translations_language_expected_result_multiple_values(self):
+        """Test response for multiple translations."""
+        header = fetch_header(self.client, role=ROLE_OWNER)
+        data = {"strings": ["Birth", "Death"]}
+        rv = self.client.post(TEST_URL + "fr", headers=header, json=data)
+        self.assertEqual(rv.status_code, 200)
+        rv = rv.json
+        self.assertEqual(len(rv), 2)
+        self.assertEqual(rv[0], {"original": "Birth", "translation": "Naissance"})
+        self.assertEqual(rv[1], {"original": "Death", "translation": "Décès"})