new sandbox (#12)

* new sandbox

* linting

---------

Co-authored-by: Jim Alcock <[email protected]>

Author: nathanwall

azure/azure-release-pipeline.yml

@@ -57,8 +57,6 @@ extends:
     #       - template: ./templates/run-tests.yml
       - environment: sandbox
         proxy_path: sandbox
-        post_deploy:
-          - template: ./templates/run-tests.yml
     # # Enable int environment when ready by uncommenting:
     #   - environment: int
     #     depends_on:

ecs-proxies-deploy.yml

@@ -8,6 +8,8 @@ docker_service:
         value: "{{ 'debug' if APIGEE_ENVIRONMENT == 'internal-dev' else 'info' }}"
       - name: VERSION_INFO
         value: "{{ version_info | to_json }}"
+      - name: SERVICE_BASE_PATH
+        value: "{{ SERVICE_BASE_PATH }}"
     health_check:
       matcher: "200"
       path: "/_ping"

openapi.json

@@ -4,17 +4,28 @@
 import os
 from fastapi import FastAPI
 
-from fhir_api.routes import root
-from fhir_api.routes import endpoints
+from fhir_api.routes import (
+    root,
+    dynamodb,
+    status_endpoints,
+)
+
+from fhir_api.models.fhir_r4.common import Reference, Identifier
+
+Reference.update_forward_refs(identifier=Identifier)
 
 
 app = FastAPI(
     title=os.getenv('FASTAPI_TITLE', 'Immunization Fhir API'),
     description=os.getenv(
         'FASTAPI_DESC', 'API'),
-    version=os.getenv('VERSION', 'SANDBOX'))
+    version=os.getenv('VERSION', 'DEVELOPMENT'),
+    root_path=f'/{os.getenv("SERVICE_BASE_PATH")}/',
+    docs_url="/documentation",
+    redoc_url="/redocumentation")
 
 
 # ENDPOINT ROUTERS
 app.include_router(root.router)
-app.include_router(endpoints.router)
+app.include_router(dynamodb.router)
+app.include_router(status_endpoints.router)

sandbox/fhir_api/__init__.py

@@ -0,0 +1,76 @@
+""" Base Exceptions that can be used across all collections """
+
+
+# pylint: disable=W0231
+
+from typing import Type
+import fastapi
+from fastapi.responses import JSONResponse
+from fhir_api.models.errors import (
+    NotFoundError,
+    AlreadyExistsError,
+    WebSocketError,
+    BaseError,
+    BaseIdentifiedError
+)
+
+
+class BaseAPIException(Exception):
+    """ Base Error for custom API exceptions """
+    message = "Exception Occured"
+    code = fastapi.status.HTTP_500_INTERNAL_SERVER_ERROR
+    model = BaseError
+
+    def __init__(self, **kwargs):
+        kwargs.setdefault("message", self.message)
+        self.message = kwargs["message"]
+        self.data = self.model(**kwargs)
+
+    def response(self):
+        return JSONResponse(
+            content=self.data.dict(),
+            status_code=self.code
+        )
+
+    @classmethod
+    def response_model(cls):
+        return {cls.code: {"model": cls.model}}
+
+
+class BaseIdentifiedException(BaseAPIException):
+    """Base error for exceptions related with entities, uniquely identified"""
+    message = "Entity error"
+    code = fastapi.status.HTTP_500_INTERNAL_SERVER_ERROR
+    model = BaseIdentifiedError
+
+    def __init__(self, identifier, **kwargs):
+        super().__init__(identifier=identifier, **kwargs)
+
+
+class NotFoundException(BaseIdentifiedException):
+    """Base error for exceptions raised because an entity does not exist"""
+    message = "The entity does not exist"
+    code = fastapi.status.HTTP_404_NOT_FOUND
+    model = NotFoundError
+
+
+class AlreadyExistsException(BaseIdentifiedException):
+    """Base error for exceptions raised because an entity already exists"""
+    message = "The entity already exists"
+    code = fastapi.status.HTTP_409_CONFLICT
+    model = AlreadyExistsError
+
+
+class WebSocketException(BaseAPIException):
+    """ Base Error for websocket exceptions """
+    message = "Websocket encountered an error"
+    code = fastapi.status.HTTP_418_IM_A_TEAPOT
+    model = WebSocketError
+
+
+def get_exception_responses(*args: Type[BaseAPIException]) -> dict:
+    """ return a dict of responses used on FastAPI endpoint """
+    responses = {}
+    for cls in args:
+        responses.update(cls.response_model())
+    return responses

sandbox/fhir_api/exceptions/__init__.py

@@ -0,0 +1,19 @@
+''' Data input model for DynamoDB '''
+
+from typing import Optional
+from pydantic import (
+    BaseModel,
+)
+
+from fhir_api.models.fhir_r4.fhir_datatype_fields import FhirR4Fields
+
+
+class DataInput(BaseModel):
+    ''' Data input model '''
+    nhsNumber: str = FhirR4Fields.string
+    data: Optional[dict]
+
+
+class SuccessModel(BaseModel):
+    ''' SuccessModel for interacting with DynamoDB'''
+    success: bool = FhirR4Fields.boolean

sandbox/fhir_api/exceptions/base_exceptions.py

@@ -0,0 +1,29 @@
+''' Read Models for Dynamodb'''
+from typing import (
+    Union,
+    Literal,
+    Optional,
+)
+from pydantic import (
+    BaseModel,
+    Field,
+)
+
+from fhir_api.models.fhir_r4.fhir_datatype_fields import FhirR4Fields
+from fhir_api.models.fhir_r4.immunization import Immunization
+from fhir_api.models.fhir_r4.patient import Patient
+
+
+class Resource(BaseModel):
+    ''' Wrapper Model for returned resource '''
+    fullUrl: str = FhirR4Fields.uri
+    resource: Union[Immunization, Patient]
+    search: Optional[dict] = {"mode": "match"}  # This looks to be api specific
+
+
+class BatchImmunizationRead(BaseModel):
+    ''' Model for Multiple records '''
+    resourceType: Literal["Bundle"] = Field(default="Bundle")
+    type: str = FhirR4Fields.string
+    total: int = FhirR4Fields.integer
+    entry: list[Resource]

sandbox/fhir_api/models/dynamodb/__init__.py

@@ -0,0 +1,28 @@
+''' Models for interacting with tables '''
+
+from pydantic import (
+    BaseModel,
+    Field,
+)
+
+
+class KeySchema(BaseModel):
+    AttributeName: str = Field(description="Attribute Name for Key Schema", example="year")
+    KeyType: str = Field(description="Key Type for Key Schema", example="HASH")
+
+
+class AttributeDefinitions(BaseModel):
+    AttributeName: str = Field(description="Attribute Name for Attribute Definition", example="year")
+    AttributeType: str = Field(description="Attribute Type for Attribute Definition", example="N")
+
+
+class ProvisionedThroughput(BaseModel):
+    ReadCapacityUnits: int = Field(description="Read Capacity Units", example=10)
+    WriteCapacityUnits: int = Field(description="Write Capacity Units", example=10)
+
+
+class CreateTable(BaseModel):
+    table_name: str
+    key_schema: list[KeySchema]
+    attribute_definition: list[AttributeDefinitions]
+    provisioned_throughput: ProvisionedThroughput