Create an api router for v2 endpoints. #98

backend/app/app/core/config.py

@@ -7,6 +7,7 @@
 
 class Settings(BaseSettings):
     API_V1_STR: str = "/api/v1"
+    API_V2_STR: str = "/api/v2"
 
     SECRET_KEY: str = secrets.token_urlsafe(32)
 

backend/app/app/main.py

@@ -4,7 +4,7 @@
 from starlette.middleware.cors import CORSMiddleware
 from starlette.requests import Request
 
-from app.api.api_v1.api import api_router
+from app.routers import api_v1, api_v2
 from app.core.config import settings
 
 # Configure logging. Change INFO to DEBUG for development logging.
@@ -27,4 +27,5 @@
         allow_headers=["*"],
     ),
 
-app.include_router(api_router, prefix=settings.API_V1_STR)
+app.include_router(api_v1.router, prefix=settings.API_V1_STR)
+app.include_router(api_v2.router, prefix=settings.API_V2_STR)

backend/app/app/routers/api_v1/__init__.py

@@ -0,0 +1 @@
+from .api import router

backend/app/app/api/api_v1/api.py → backend/app/app/routers/api_v1/api.py

@@ -2,65 +2,65 @@
 
 from fastapi import APIRouter, Depends, Security
 
-from app.api.api_v1.endpoints import login, users, utils, api_key
-from app.api.api_v1.endpoints.farms import farms, info, logs, assets, terms, areas
-from app.api.utils.security import get_farm_access, get_current_active_superuser
+from app.routers.api_v1.endpoints import login, users, utils, api_key
+from app.routers.api_v1.endpoints.farms import farms, info, logs, assets, terms, areas
+from app.routers.utils.security import get_farm_access, get_current_active_superuser
 
 logger = logging.getLogger(__name__)
 
-api_router = APIRouter()
-api_router.include_router(login.router, tags=["login"])
-api_router.include_router(users.router, prefix="/users", tags=["users"])
-api_router.include_router(utils.router, prefix="/utils", tags=["utils"])
+router = APIRouter()
+router.include_router(login.router, tags=["login"])
+router.include_router(users.router, prefix="/users", tags=["users"])
+router.include_router(utils.router, prefix="/utils", tags=["utils"])
 
 # Include /api-keys endpoint, require superuser to access.
-api_router.include_router(
+router.include_router(
     api_key.router,
     prefix="/api-keys",
     tags=["api keys"],
     dependencies=[Security(get_current_active_superuser)]
 )
 
 # Include /farms endpoints.
-api_router.include_router(
+router.include_router(
     farms.router,
     prefix="/farms",
     tags=["farms"],
 )
 
 # Include /farms/info endpoint.
-api_router.include_router(
+router.include_router(
     info.router,
     prefix="/farms/info",
     tags=["farm info"],
 )
 
 # Include /farms/logs endpoints.
-api_router.include_router(
+router.include_router(
     logs.router,
     prefix="/farms/logs",
     tags=["farm logs"],
     dependencies=[Security(get_farm_access, scopes=['farm:read', 'farm.logs'])]
 )
 
 # Include /farms/assets endpoints.
-api_router.include_router(
+router.include_router(
     assets.router,
     prefix="/farms/assets",
     tags=["farm assets"],
     dependencies=[Security(get_farm_access, scopes=['farm:read', 'farm.assets'])]
 )
 
 # Include /farms/terms endpoints.
-api_router.include_router(
+router.include_router(
     terms.router,
     prefix="/farms/terms",
     tags=["farm terms"],
     dependencies=[Security(get_farm_access, scopes=['farm:read', 'farm.terms'])]
 )
 
 # Include /farms/areas endpoints.
-api_router.include_router(
+router.include_router(
     areas.router,
     prefix="/farms/areas",
     tags=["farm areas"],

backend/app/app/api/api_v1/endpoints/api_key.py → backend/app/app/routers/api_v1/endpoints/api_key.py

@@ -6,7 +6,7 @@
 from sqlalchemy.orm import Session
 
 from app import crud
-from app.api.utils.db import get_db
+from app.routers.utils.db import get_db
 from app.schemas.api_key import ApiKey, ApiKeyCreate, ApiKeyUpdate
 
 logger = logging.getLogger(__name__)

backend/app/app/api/api_v1/endpoints/farms/areas.py → backend/app/app/routers/api_v1/endpoints/farms/areas.py

@@ -5,8 +5,8 @@
 from pydantic import BaseModel
 from sqlalchemy.orm import Session
 
-from app.api.utils.db import get_db
-from app.api.utils.farms import get_active_farms_url_or_list, get_farm_client, ClientError
+from app.routers.utils.db import get_db
+from app.routers.utils.farms import get_active_farms_url_or_list, get_farm_client, ClientError
 from app.schemas.farm import Farm
 
 router = APIRouter()

backend/app/app/api/api_v1/endpoints/farms/assets.py → backend/app/app/routers/api_v1/endpoints/farms/assets.py

@@ -5,8 +5,8 @@
 from pydantic import BaseModel
 from sqlalchemy.orm import Session
 
-from app.api.utils.db import get_db
-from app.api.utils.farms import get_active_farms_url_or_list, get_farm_client, ClientError
+from app.routers.utils.db import get_db
+from app.routers.utils.farms import get_active_farms_url_or_list, get_farm_client, ClientError
 from app.schemas.farm import Farm
 
 router = APIRouter()

backend/app/app/api/api_v1/endpoints/farms/farms.py → backend/app/app/routers/api_v1/endpoints/farms/farms.py

@@ -6,9 +6,9 @@
 
 from app import crud
 from app.utils import get_settings
-from app.api.utils.db import get_db
-from app.api.utils.farms import get_farms_url_or_list, get_farm_by_id, admin_alert_email
-from app.api.utils.security import get_farm_access, get_farm_access_allow_public
+from app.routers.utils.db import get_db
+from app.routers.utils.farms import get_farms_url_or_list, get_farm_by_id, admin_alert_email
+from app.routers.utils.security import get_farm_access, get_farm_access_allow_public
 from app.schemas.farm import Farm, AllFarmInfo, FarmCreate, FarmUpdate
 
 router = APIRouter()

backend/app/app/api/api_v1/endpoints/farms/info.py → backend/app/app/routers/api_v1/endpoints/farms/info.py

@@ -5,9 +5,9 @@
 
 
 from app import crud
-from app.api.utils.db import get_db
-from app.api.utils.farms import get_farm_client, ClientError, get_farms_url_or_list
-from app.api.utils.security import get_farm_access
+from app.routers.utils.db import get_db
+from app.routers.utils.farms import get_farm_client, ClientError, get_farms_url_or_list
+from app.routers.utils.security import get_farm_access
 from app.schemas.farm import Farm
 from app.schemas.farm_info import FarmInfo
 

backend/app/app/api/api_v1/endpoints/farms/logs.py → backend/app/app/routers/api_v1/endpoints/farms/logs.py

@@ -6,8 +6,8 @@
 from pydantic import BaseModel
 from sqlalchemy.orm import Session
 
-from app.api.utils.db import get_db
-from app.api.utils.farms import get_active_farms_url_or_list, get_farm_client, ClientError
+from app.routers.utils.db import get_db
+from app.routers.utils.farms import get_active_farms_url_or_list, get_farm_client, ClientError
 from app.schemas.farm import Farm
 
 router = APIRouter()

backend/app/app/api/api_v1/endpoints/farms/terms.py → backend/app/app/routers/api_v1/endpoints/farms/terms.py

@@ -5,8 +5,8 @@
 from pydantic import BaseModel
 from sqlalchemy.orm import Session
 
-from app.api.utils.db import get_db
-from app.api.utils.farms import get_active_farms_url_or_list, get_farm_client, ClientError
+from app.routers.utils.db import get_db
+from app.routers.utils.farms import get_active_farms_url_or_list, get_farm_client, ClientError
 from app.schemas.farm import Farm
 
 router = APIRouter()

backend/app/app/api/api_v1/endpoints/login.py → backend/app/app/routers/api_v1/endpoints/login.py

@@ -6,8 +6,8 @@
 from sqlalchemy.orm import Session
 
 from app import crud
-from app.api.utils.db import get_db
-from app.api.utils.security import get_current_user
+from app.routers.utils.db import get_db
+from app.routers.utils.security import get_current_user
 from app.core.jwt import create_access_token
 from app.core.security import get_password_hash
 from app.models.user import User as DBUser

backend/app/app/api/api_v1/endpoints/users.py → backend/app/app/routers/api_v1/endpoints/users.py

@@ -6,8 +6,8 @@
 from sqlalchemy.orm import Session
 
 from app import crud
-from app.api.utils.db import get_db
-from app.api.utils.security import get_current_active_superuser, get_current_active_user
+from app.routers.utils.db import get_db
+from app.routers.utils.security import get_current_active_superuser, get_current_active_user
 from app.models.user import User as DBUser
 from app.schemas.user import User, UserCreate, UserInDB, UserUpdate
 from app.utils import get_settings, send_new_account_email

backend/app/app/api/api_v1/endpoints/utils.py → backend/app/app/routers/api_v1/endpoints/utils.py

@@ -8,12 +8,12 @@
 from farmOS import farmOS
 
 from app import crud
-from app.api.utils.db import get_db
+from app.routers.utils.db import get_db
 from app.schemas.msg import Msg
 from app.schemas.farm import Farm
 from app.schemas.farm_token import FarmTokenCreate, FarmAuthorizationParams
-from app.api.utils.farms import get_farm_by_id, get_oauth_token, get_farm_client, handle_ping_farms
-from app.api.utils.security import get_farm_access, get_farm_access_allow_public
+from app.routers.utils.farms import get_farm_by_id, get_oauth_token, get_farm_client, handle_ping_farms
+from app.routers.utils.security import get_farm_access, get_farm_access_allow_public
 from app.utils import (
     get_settings,
     generate_farm_registration_link,

backend/app/app/routers/api_v2/__init__.py

@@ -0,0 +1 @@
+from .api import router

backend/app/app/routers/api_v2/api.py

@@ -0,0 +1,21 @@
+import logging
+
+from fastapi import APIRouter, Security
+
+from app.routers.api_v1.endpoints import login, users, utils, api_key
+from app.routers.utils.security import get_current_active_superuser
+
+logger = logging.getLogger(__name__)
+
+router = APIRouter()
+router.include_router(login.router, tags=["login"])
+router.include_router(users.router, prefix="/users", tags=["users"])
+router.include_router(utils.router, prefix="/utils", tags=["utils"])
+
+# Include /api-keys endpoint, require superuser to access.
+router.include_router(
+    api_key.router,
+    prefix="/api-keys",
+    tags=["api keys"],
+    dependencies=[Security(get_current_active_superuser)]
+)

backend/app/app/api/utils/farms.py → backend/app/app/routers/utils/farms.py

@@ -14,12 +14,12 @@
 from farmOS.config import ClientConfig
 
 from app import crud
-from app.api.utils.db import get_db
+from app.routers.utils.db import get_db
 from app.schemas.farm_token import FarmTokenBase, FarmTokenCreate
 from app.crud.farm_token import create_farm_token, update_farm_token
 from app.schemas.farm import Farm, FarmUpdate
 from app.schemas.token import FarmAccess
-from app.api.utils.security import get_farm_access
+from app.routers.utils.security import get_farm_access
 from app.utils import get_settings, send_admin_alert_email
 
 

backend/app/app/api/utils/security.py → backend/app/app/routers/utils/security.py

@@ -9,7 +9,7 @@
 
 from app import crud
 from app.utils import get_settings
-from app.api.utils.db import get_db
+from app.routers.utils.db import get_db
 from app.core.jwt import ALGORITHM
 from app.models.user import User
 from app.schemas.token import TokenData, FarmAccess

backend/app/app/tests/api/api_v1/test_farm_authorize.py

@@ -6,7 +6,7 @@
 from app.core.config import settings
 from app.schemas.farm_token import FarmAuthorizationParams
 from app.tests.utils.utils import random_lower_string, get_scope_token_headers
-from app.api.utils.security import _validate_token
+from app.routers.utils.security import _validate_token
 
 
 @pytest.fixture

backend/app/app/tests/crud/test_api_token.py

@@ -1,5 +1,5 @@
 from app.core.jwt import create_farm_api_token
-from app.api.utils.security import _validate_token
+from app.routers.utils.security import _validate_token
 
 
 def test_create_api_token():