Merge branch 'master' into kh/compose-AU

Author: hiddewie

api/api.py

@@ -1,6 +1,7 @@
 import contextlib
 import os
 from typing import Annotated
+import sys
 
 import asyncpg
 from fastapi import FastAPI
@@ -14,6 +15,9 @@
 from openrailwaymap_api.replication_api import ReplicationAPI
 from openrailwaymap_api.wikidata_api import WikidataAPI
 
+DEFAULT_HTTP_HEADERS = {
+  'User-Agent': f'OpenRailwayMap API (https://openrailwaymap.app), httpx {httpx.__version__}, Python {sys.version}'
+}
 
 @contextlib.asynccontextmanager
 async def lifespan(app):
@@ -28,7 +32,7 @@ async def lifespan(app):
         print('Connected to database')
         app.state.database = pool
 
-        async with httpx.AsyncClient(timeout=3.0) as http_client:
+        async with httpx.AsyncClient(timeout=3.0, headers=DEFAULT_HTTP_HEADERS) as http_client:
             print('Created HTTP client')
             app.state.http_client = http_client
 
@@ -72,10 +76,11 @@ async def facility(
         name: Annotated[str | None, Query()] = None,
         ref: Annotated[str | None, Query()] = None,
         uic_ref: Annotated[str | None, Query()] = None,
+        lang: Annotated[str | None, Query()] = None,
         limit: Annotated[int, Query(ge=MIN_LIMIT, le=MAX_LIMIT)] = DEFAULT_FACILITY_LIMIT,
 ):
     api = FacilityAPI(app.state.database)
-    return await api(q=q, name=name, ref=ref, uic_ref=uic_ref, limit=limit)
+    return await api(q=q, name=name, ref=ref, uic_ref=uic_ref, limit=limit, language=lang)
 
 
 @app.get("/api/milestone")

api/openrailwaymap_api/facility_api.py

@@ -21,7 +21,7 @@ def eliminate_duplicates(self, data, limit):
 
         return results
 
-    async def __call__(self, *, q, name, ref, uic_ref, limit):
+    async def __call__(self, *, q, name, ref, uic_ref, language, limit):
         # Validate search arguments
         search_args_count = sum(1 for search_arg in [q, name, ref, uic_ref] if search_arg)
 
@@ -39,42 +39,42 @@ async def __call__(self, *, q, name, ref, uic_ref, limit):
             )
 
         if name:
-            return await self.search_by_name(name, limit)
+            return await self.search_by_name(name, language, limit)
         if ref:
-            return await self.search_by_ref(ref, limit)
+            return await self.search_by_ref(ref, language, limit)
         if uic_ref:
-            return await self.search_by_uic_ref(uic_ref, limit)
+            return await self.search_by_uic_ref(uic_ref, language, limit)
         if q:
-            return self.eliminate_duplicates((await self.search_by_name(q, limit)) + (await self.search_by_ref(q, limit)) + (await self.search_by_uic_ref(q, limit)), limit)
+            return self.eliminate_duplicates((await self.search_by_name(q, language, limit)) + (await self.search_by_ref(q, language, limit)) + (await self.search_by_uic_ref(q, language, limit)), limit)
 
     def query_has_no_wildcards(self, q):
         if '%' in q or '_' in q:
             return False
         return True
 
-    async def search_by_name(self, q, limit):
+    async def search_by_name(self, q, language, limit):
         if not self.query_has_no_wildcards(q):
             raise HTTPException(
                 HTTP_400_BAD_REQUEST,
                 {'type': 'wildcard_in_query', 'error': 'Wildcard in query.', 'detail': 'Query contains any of the wildcard characters: %_'}
             )
 
         sql_query = """
-          SELECT * FROM query_facilities_by_name($1, $2)
+          SELECT * FROM query_facilities_by_name($1, $2, $3)
         """
-        return await self.query_result(sql_query, (q, limit))
+        return await self.query_result(sql_query, (q, language, limit))
 
-    async def _search_by_ref(self, search_function, ref, limit):
+    async def _search_by_ref(self, search_function, ref, language, limit):
         sql_query = f"""
-          SELECT * FROM {search_function}($1, $2)
+          SELECT * FROM {search_function}($1, $2, $3)
         """
-        return await self.query_result(sql_query, (ref, limit))
+        return await self.query_result(sql_query, (ref, language, limit))
 
-    async def search_by_ref(self, ref, limit):
-        return await self._search_by_ref("query_facilities_by_ref", ref, limit)
+    async def search_by_ref(self, ref, language, limit):
+        return await self._search_by_ref("query_facilities_by_ref", ref, language, limit)
 
-    async def search_by_uic_ref(self, ref, limit):
-        return await self._search_by_ref("query_facilities_by_uic_ref", ref, limit)
+    async def search_by_uic_ref(self, ref, language, limit):
+        return await self._search_by_ref("query_facilities_by_uic_ref", ref, language, limit)
 
     async def query_result(self, sql_query, parameters):
         async with self.database.acquire() as connection:

api/test/api.hurl

@@ -19,21 +19,35 @@ jsonpath "$[1].name" == "S+U Hauptbahnhof"
 jsonpath "$[2].name" == "Hauptbahnhof"
 jsonpath "$[3].name" == "Berlin Hauptbahnhof"
 jsonpath "$[4].name" == "Berlin Südkreuz"
-jsonpath "$[5].name" == "Südkreuz (Nord-Süd)"
-jsonpath "$[6].name" == "Südkreuz (Ringbahn)"
-jsonpath "$[7].name" == "Berlin-Spandau"
-jsonpath "$[8].name" == "Spandau"
-jsonpath "$[9].name" == "Berlin Ostbahnhof"
-jsonpath "$[10].name" == "Ostbahnhof"
-jsonpath "$[11].name" == "Gesundbrunnen"
-jsonpath "$[12].name" == "Ostkreuz (Ringbahn)"
-jsonpath "$[13].name" == "Berlin Ostkreuz (Stadtbahn-F)"
-jsonpath "$[14].name" == "Berlin Ostkreuz (Ringbahn-F)"
-jsonpath "$[15].name" == "Ostkreuz"
-jsonpath "$[16].name" == "Berlin Gesundbrunnen"
-jsonpath "$[17].name" == "Berlin Ostkreuz (Ostbahn)"
-jsonpath "$[18].name" == "Alexanderplatz"
-jsonpath "$[19].name" == "Berlin Alexanderplatz"
+jsonpath "$[5].name" == "Südkreuz (Ringbahn)"
+jsonpath "$[6].name" == "Südkreuz (Nord-Süd)"
+jsonpath "$[7].name" == "Berlin Nordost"
+jsonpath "$[8].name" == "Berlin Greifswalder Straße"
+jsonpath "$[9].name" == "Berlin-Grünau"
+jsonpath "$[10].name" == "Berlin-Spandau"
+jsonpath "$[11].name" == "Berlin-Marienfelde Gbf"
+jsonpath "$[12].name" == "Spandau"
+jsonpath "$[13].name" == "Berlin-Tempelhof"
+jsonpath "$[14].name" == "Berlin-Schönholz"
+jsonpath "$[15].name" == "Berlin Ostbahnhof"
+jsonpath "$[16].name" == "Ostbahnhof"
+jsonpath "$[17].name" == "Gesundbrunnen"
+jsonpath "$[18].name" == "Berlin Gesundbrunnen"
+jsonpath "$[19].name" == "Berlin-Neukölln"
+
+# Facility request with language
+GET {{base_url}}/facility
+[QueryStringParams]
+name: Berlin Ostbahnhof
+lang: en
+HTTP 200
+Content-Type: application/json
+[Asserts]
+jsonpath "$" count == 2
+jsonpath "$[0].name" == "Ostbahnhof"
+jsonpath "$[0].localized_name" == "Ostbahnhof"
+jsonpath "$[1].name" == "Berlin Ostbahnhof"
+jsonpath "$[1].localized_name" == "Berlin Ostbahnhof railway station"
 
 # Facility request with limit
 GET {{base_url}}/facility
@@ -80,11 +94,11 @@ HTTP 200
 jsonpath "$" count == 7
 jsonpath "$[0].name" == "Berlin-Spandau"
 jsonpath "$[1].name" == "Spandau"
-jsonpath "$[2].name" == "Berlin-Spandau Gbf"
-jsonpath "$[3].name" == "Berlin-Spandau West"
-jsonpath "$[4].name" == "Berlin-Spandau Mitte"
-jsonpath "$[5].name" == "Berlin-Spandau Ost"
-jsonpath "$[6].name" == "Berlin-Spandau Johannesstift"
+jsonpath "$[2].name" == "Berlin-Spandau Johannesstift"
+jsonpath "$[3].name" == "Berlin-Spandau Gbf"
+jsonpath "$[4].name" == "Berlin-Spandau West"
+jsonpath "$[5].name" == "Berlin-Spandau Mitte"
+jsonpath "$[6].name" == "Berlin-Spandau Ost"
 
 # Facility request with space
 GET {{base_url}}/facility
@@ -95,11 +109,11 @@ HTTP 200
 jsonpath "$" count == 7
 jsonpath "$[0].name" == "Berlin-Spandau"
 jsonpath "$[1].name" == "Spandau"
-jsonpath "$[2].name" == "Berlin-Spandau Gbf"
-jsonpath "$[3].name" == "Berlin-Spandau West"
-jsonpath "$[4].name" == "Berlin-Spandau Mitte"
-jsonpath "$[5].name" == "Berlin-Spandau Ost"
-jsonpath "$[6].name" == "Berlin-Spandau Johannesstift"
+jsonpath "$[2].name" == "Berlin-Spandau Johannesstift"
+jsonpath "$[3].name" == "Berlin-Spandau Gbf"
+jsonpath "$[4].name" == "Berlin-Spandau West"
+jsonpath "$[5].name" == "Berlin-Spandau Mitte"
+jsonpath "$[6].name" == "Berlin-Spandau Ost"
 
 # Facility request for Spandau
 GET {{base_url}}/facility
@@ -110,13 +124,13 @@ HTTP 200
 jsonpath "$" count == 9
 jsonpath "$[0].name" == "Berlin-Spandau"
 jsonpath "$[1].name" == "Spandau"
-jsonpath "$[2].name" == "Altstadt Spandau"
-jsonpath "$[3].name" == "Rathaus Spandau"
-jsonpath "$[4].name" == "Berlin-Spandau Gbf"
-jsonpath "$[5].name" == "Berlin-Spandau West"
-jsonpath "$[6].name" == "Berlin-Spandau Mitte"
-jsonpath "$[7].name" == "Berlin-Spandau Ost"
-jsonpath "$[8].name" == "Berlin-Spandau Johannesstift"
+jsonpath "$[2].name" == "Berlin-Spandau Johannesstift"
+jsonpath "$[3].name" == "Berlin-Spandau Gbf"
+jsonpath "$[4].name" == "Rathaus Spandau"
+jsonpath "$[5].name" == "Altstadt Spandau"
+jsonpath "$[6].name" == "Berlin-Spandau West"
+jsonpath "$[7].name" == "Berlin-Spandau Mitte"
+jsonpath "$[8].name" == "Berlin-Spandau Ost"
 
 # Facility request with with diacritics
 GET {{base_url}}/facility
@@ -201,7 +215,7 @@ jsonpath "$" count == 3
 jsonpath "$[0].name" == "Landsberger Allee/Petersburger Straße"
 jsonpath "$[0].feature" == "tram_stop"
 jsonpath "$[0].state" == "present"
-jsonpath "$[0].rank" == 32
+jsonpath "$[0].rank" == 34
 jsonpath "$[0].osm_ids" count == 4
 jsonpath "$[0].osm_ids[0]" == 244129991
 jsonpath "$[0].osm_ids[1]" == 271777826