Enode API Changes

pv_site_api/_db_helpers.py

@@ -13,17 +13,26 @@
 
 import sqlalchemy as sa
 import structlog
+from fastapi import Depends
 from pvsite_datamodel.read.generation import get_pv_generation_by_sites
-from pvsite_datamodel.sqlmodels import ForecastSQL, ForecastValueSQL, SiteSQL
+from pvsite_datamodel.sqlmodels import (
+    ClientSQL,
+    ForecastSQL,
+    ForecastValueSQL,
+    InverterSQL,
+    SiteSQL,
+)
 from sqlalchemy.orm import Session, aliased
 
 from .pydantic_models import (
     Forecast,
     MultiplePVActual,
     PVActualValue,
+    PVClientMetadata,
     PVSiteMetadata,
     SiteForecastValues,
 )
+from .session import get_session
 
 logger = structlog.stdlib.get_logger()
 
@@ -229,9 +238,32 @@ def site_to_pydantic(site: SiteSQL) -> PVSiteMetadata:
     return pv_site
 
 
+def client_to_pydantic(client: ClientSQL) -> PVClientMetadata:
+    """Converts a ClientSQL object into a PVClientMetadata object."""
+    pv_client = PVClientMetadata(
+        client_uuid=str(client.client_uuid), client_name=client.client_name
+    )
+    return pv_client
+
+
 def does_site_exist(session: Session, site_uuid: str) -> bool:
     """Checks if a site exists."""
     return (
         session.execute(sa.select(SiteSQL).where(SiteSQL.site_uuid == site_uuid)).one_or_none()
         is not None
     )
+
+
+def get_inverters_for_site(
+    site_uuid: str, session: Session = Depends(get_session)
+) -> list[Row] | None:
+    """Path dependency to get a list of inverters for a site, or None if the site doesn't exist"""
+    if not does_site_exist(session, site_uuid):
+        return None
+
+    query = session.query(InverterSQL).filter(InverterSQL.site_uuid == site_uuid)
+    inverters = query.all()
+
+    logger.info(f"Found {len(inverters)} inverters for site {site_uuid}")
+
+    return inverters

pv_site_api/auth.py

@@ -1,6 +1,10 @@
 import jwt
 from fastapi import Depends, HTTPException
 from fastapi.security import HTTPAuthorizationCredentials, HTTPBearer
+from pvsite_datamodel.sqlmodels import ClientSQL
+from sqlalchemy.orm import Session
+
+from .session import get_session
 
 token_auth_scheme = HTTPBearer()
 
@@ -15,7 +19,11 @@ def __init__(self, domain: str, api_audience: str, algorithm: str):
 
         self._jwks_client = jwt.PyJWKClient(f"https://{domain}/.well-known/jwks.json")
 
-    def __call__(self, auth_credentials: HTTPAuthorizationCredentials = Depends(token_auth_scheme)):
+    def __call__(
+        self,
+        auth_credentials: HTTPAuthorizationCredentials = Depends(token_auth_scheme),
+        session: Session = Depends(get_session),
+    ):
         token = auth_credentials.credentials
 
         try:
@@ -24,7 +32,7 @@ def __call__(self, auth_credentials: HTTPAuthorizationCredentials = Depends(toke
             raise HTTPException(status_code=401, detail=str(e))
 
         try:
-            payload = jwt.decode(
+            jwt.decode(
                 token,
                 signing_key,
                 algorithms=self._algorithm,
@@ -34,4 +42,11 @@ def __call__(self, auth_credentials: HTTPAuthorizationCredentials = Depends(toke
         except Exception as e:
             raise HTTPException(status_code=401, detail=str(e))
 
-        return payload
+        if session is None:
+            return None
+
+        # @TODO: get client corresponding to auth
+        # See: https://github.com/openclimatefix/pv-site-api/issues/90
+        client = session.query(ClientSQL).first()
+        assert client is not None
+        return client

pv_site_api/cache.py

@@ -6,6 +6,8 @@
 
 import structlog
 
+from ._db_helpers import client_to_pydantic
+
 logger = structlog.stdlib.get_logger()
 
 CACHE_TIME_SECONDS = 120
@@ -43,6 +45,11 @@ def wrapper(*args, **kwargs):  # noqa
             if var in route_variables:
                 route_variables.pop(var)
 
+        # translate authenticated client to serializable type
+        route_variables["auth"] = (
+            route_variables["auth"] and client_to_pydantic(route_variables["auth"]).json()
+        )
+
         # make into string
         route_variables = json.dumps(route_variables)
         args_as_json = json.dumps(args)

pv_site_api/fake.py

@@ -6,6 +6,11 @@
 
 from .pydantic_models import (
     Forecast,
+    InverterInformation,
+    InverterLocation,
+    InverterProductionState,
+    Inverters,
+    InverterValues,
     MultiplePVActual,
     PVActualValue,
     PVSiteAPIStatus,
@@ -19,6 +24,35 @@
 fake_client_uuid = "c97f68cd-50e0-49bb-a850-108d4a9f7b7e"
 
 
+def make_fake_inverters() -> Inverters:
+    """Make fake inverters"""
+    inverter = InverterValues(
+        id="string",
+        vendor="EMA",
+        chargingLocationId="8d90101b-3f2f-462a-bbb4-1ed320d33bbe",
+        lastSeen="2020-04-07T17:04:26Z",
+        isReachable=True,
+        productionState=InverterProductionState(
+            productionRate=0,
+            isProducing=True,
+            totalLifetimeProduction=100152.56,
+            lastUpdated="2020-04-07T17:04:26Z",
+        ),
+        information=InverterInformation(
+            id="string",
+            brand="EMA",
+            model="Sunny Boy",
+            siteName="Sunny Plant",
+            installationDate="2020-04-07T17:04:26Z",
+        ),
+        location=InverterLocation(latitude=10.7197486, longitude=59.9173985),
+    )
+    inverters_list = Inverters(
+        inverters=[inverter],
+    )
+    return inverters_list
+
+
 def make_fake_site() -> PVSites:
     """Make a fake site"""
     pv_site = PVSiteMetadata(
@@ -87,3 +121,8 @@ def make_fake_status() -> PVSiteAPIStatus:
         message="The API is up and running",
     )
     return pv_api_status
+
+
+def make_fake_enode_link_url() -> str:
+    """Make fake Enode link URL"""
+    return "https://enode.com"