Modify project to resemble RIVER

README.md

@@ -1,20 +1,26 @@
-# sensormap-bff
-The backend-for-frontend for sensormap
+# astroriver-bff
+The backend-for-frontend for astroriver
 
 
 ## Getting started
 
 The app requires the following environment variables:
 ```
-KEYCLOAK_CLIENT_ID
 KEYCLOAK_REALM
 KEYCLOAK_URL
+
+KEYCLOAK_CLIENT_ID   # The UI client ID
+
+KEYCLOAK_BFF_ID      # The BFF client ID
+KEYCLOAK_BFF_SECRET  # The BFF client's secret
 ```
 
 To start the app run:
 
 ```
 KEYCLOAK_CLIENT_ID=test \
+    KEYCLOAK_BFF_ID=test \
+    KEYCLOAK_BFF_SECRET=test \
     KEYCLOAK_REALM=realmtest \
     KEYCLOAK_URL=https://test.com \
     poetry run uvicorn app.main:app --reload
@@ -24,4 +30,4 @@ There will be a route available at"
 
 ```
 http://127.0.0.1:8000/config/keycloak
-```
+```

app/areas.py

@@ -19,7 +19,7 @@ async def get_area(
     """Get an area by id"""
 
     res = await client.get(
-        f"{config.SOIL_API_URL}/v1/areas/{area_id}",
+        f"{config.RIVER_API_URL}/v1/areas/{area_id}",
     )
 
     return res.json()
@@ -37,7 +37,7 @@ async def get_areas(
 ) -> Any:
     """Get all areas"""
     res = await client.get(
-        f"{config.SOIL_API_URL}/v1/areas",
+        f"{config.RIVER_API_URL}/v1/areas",
         params={"sort": sort, "range": range, "filter": filter},
     )
     response.headers["Access-Control-Expose-Headers"] = "Content-Range"
@@ -55,7 +55,7 @@ async def create_area(
     """Creates an area"""
 
     res = await client.post(
-        f"{config.SOIL_API_URL}/v1/areas",
+        f"{config.RIVER_API_URL}/v1/areas",
         json=area,
     )
 
@@ -72,7 +72,7 @@ async def update_area(
     """ "Updates an area by id"""
 
     res = await client.put(
-        f"{config.SOIL_API_URL}/v1/areas/{area_id}", json=area
+        f"{config.RIVER_API_URL}/v1/areas/{area_id}", json=area
     )
 
     return res.json()
@@ -86,6 +86,6 @@ async def delete_area(
 ) -> None:
     """Delete an area by id"""
 
-    res = await client.delete(f"{config.SOIL_API_URL}/v1/areas/{area_id}")
+    res = await client.delete(f"{config.RIVER_API_URL}/v1/areas/{area_id}")
 
     return res.json()

app/config.py

@@ -16,8 +16,8 @@ class Config(BaseSettings):
     # Keycloak UI settings
     KEYCLOAK_CLIENT_ID: str
 
-    # SOIL-API settings
-    SOIL_API_URL: str  # Full path to the Soil API (eg: http://soil-api-dev)
+    # RIVER-API settings
+    RIVER_API_URL: str  # Full path to the Soil API (eg: http://river-api-dev)
 
 
 @lru_cache()

app/sensordata.py

@@ -19,7 +19,7 @@ async def get_sensordata(
     """Get an individual sensordata record by id"""
 
     res = await client.get(
-        f"{config.SOIL_API_URL}/v1/sensors/data/{sensordata_id}",
+        f"{config.RIVER_API_URL}/v1/sensors/data/{sensordata_id}",
     )
 
     return res.json()
@@ -37,7 +37,7 @@ async def get_all_sensordata(
     """Get all sensordata"""
 
     res = await client.get(
-        f"{config.SOIL_API_URL}/v1/sensors/data",
+        f"{config.RIVER_API_URL}/v1/sensors/data",
         params={"sort": sort, "range": range, "filter": filter},
     )
     response.headers["Access-Control-Expose-Headers"] = "Content-Range"
@@ -55,7 +55,7 @@ async def create_sensordata(
     """Creates an sensordata record"""
 
     res = await client.post(
-        f"{config.SOIL_API_URL}/v1/sensors/data",
+        f"{config.RIVER_API_URL}/v1/sensors/data",
         json=sensordata,
     )
 
@@ -72,7 +72,7 @@ async def update_sensordata(
     """Updates an individual sensordata record by id"""
 
     res = await client.put(
-        f"{config.SOIL_API_URL}/v1/sensors/data/{sensordata_id}",
+        f"{config.RIVER_API_URL}/v1/sensors/data/{sensordata_id}",
         json=sensordata,
     )
 
@@ -88,7 +88,7 @@ async def delete_sensor(
     """Delete an individual sensordata record by id"""
 
     res = await client.delete(
-        f"{config.SOIL_API_URL}/v1/sensors/data/{sensordata_id}"
+        f"{config.RIVER_API_URL}/v1/sensors/data/{sensordata_id}"
     )
 
     return res.json()

app/sensors.py

@@ -19,7 +19,7 @@ async def get_sensor(
     """Get a sensor by id"""
 
     res = await client.get(
-        f"{config.SOIL_API_URL}/v1/sensors/{sensor_id}",
+        f"{config.RIVER_API_URL}/v1/sensors/{sensor_id}",
     )
 
     return res.json()
@@ -37,7 +37,7 @@ async def get_sensors(
     """Get all sensors"""
 
     res = await client.get(
-        f"{config.SOIL_API_URL}/v1/sensors",
+        f"{config.RIVER_API_URL}/v1/sensors",
         params={"sort": sort, "range": range, "filter": filter},
     )
     response.headers["Access-Control-Expose-Headers"] = "Content-Range"
@@ -55,7 +55,7 @@ async def create_sensor(
     """Creates an sensor"""
 
     res = await client.post(
-        f"{config.SOIL_API_URL}/v1/sensors",
+        f"{config.RIVER_API_URL}/v1/sensors",
         json=sensor,
     )
 
@@ -71,7 +71,7 @@ async def create_many_sensors(
     """Creates an sensor"""
 
     res = await client.post(
-        f"{config.SOIL_API_URL}/v1/sensors/many",
+        f"{config.RIVER_API_URL}/v1/sensors/many",
         json=sensor,
     )
 
@@ -88,7 +88,7 @@ async def update_sensor(
     """ "Updates an sensor by id"""
 
     res = await client.put(
-        f"{config.SOIL_API_URL}/v1/sensors/{sensor_id}", json=sensor
+        f"{config.RIVER_API_URL}/v1/sensors/{sensor_id}", json=sensor
     )
 
     return res.json()
@@ -102,6 +102,6 @@ async def delete_sensor(
 ) -> None:
     """Delete an sensor by id"""
 
-    res = await client.delete(f"{config.SOIL_API_URL}/v1/sensors/{sensor_id}")
+    res = await client.delete(f"{config.RIVER_API_URL}/v1/sensors/{sensor_id}")
 
     return res.json()

pyproject.toml

@@ -1,7 +1,7 @@
 [tool.poetry]
-name = "sensormap-bff"
+name = "astroriver-bff"
 version = "0.1.0"
-description = "The backend-for-frontend for sensormap"
+description = "The backend-for-frontend for the astroriver interface"
 authors = ["Evan Thomas <[email protected]>"]
 readme = "README.md"