changed start dev script to "pipenv run dev" and "pipenv run start" + renamed models + some cleanup

Author: ExpDev07

Pipfile

@@ -23,5 +23,5 @@ uvicorn = "*"
 python_version = "3.8"
 
 [scripts]
-dev_app = "uvicorn app.main:APP --reload"
-app = "uvicorn app.main:APP"
+dev = "uvicorn app.main:APP --reload"
+start = "uvicorn app.main:APP"

README.md

@@ -393,7 +393,7 @@ You will need the following things properly installed on your computer.
 
 ## Running / Development
 
-* `flask run`
+* `pipenv run dev`
 * Visit your app at [http://localhost:5000](http://localhost:5000).
 
 ### Running Tests

app/main.py

@@ -65,7 +65,7 @@ async def add_datasource(request: fastapi.Request, call_next):
     request.state.source = source
 
     # Move on...
-    LOGGER.info(f'source: {source.__class__.__name__}')
+    LOGGER.info(f'source provided: {source.__class__.__name__}')
     response = await call_next(request)
     return response
 
@@ -92,7 +92,7 @@ async def handle_validation_error(
 V2 = fastapi.APIRouter()
 
 
-@V2.get('/latest', response_model=models.Latest)
+@V2.get('/latest', response_model=models.LatestResponse)
 def get_latest(request: fastapi.Request, source: Sources = 'jhu'):
     """
     Getting latest amount of total confirmed cases, deaths, and recoveries.
@@ -101,20 +101,20 @@ def get_latest(request: fastapi.Request, source: Sources = 'jhu'):
     return {
         'latest': {
             'confirmed': sum(map(lambda location: location.confirmed, locations)),
-            'deaths': sum(map(lambda location: location.deaths, locations)),
+            'deaths'   : sum(map(lambda location: location.deaths, locations)),
             'recovered': sum(map(lambda location: location.recovered, locations)),
         }
     }
 
 
 @V2.get(
-    '/locations', response_model=models.Locations, response_model_exclude_unset=True
+    '/locations', response_model=models.LocationsResponse, response_model_exclude_unset=True
 )
 def get_locations(
     request: fastapi.Request,
+    source: Sources = 'jhu',
     country_code: str = None,
     timelines: bool = False,
-    source: Sources = 'jhu',
 ):
     """
     Getting the locations.
@@ -126,23 +126,23 @@ def get_locations(
     if country_code:
         locations = list(
             filter(
-                lambda location: location.country_code == country_code.upper(),
-                locations,
+                lambda location: location.country_code == country_code.upper(), locations,
             )
         )
-    # FIXME: timelines are not showing up
+
+    # Return final serialized data.
     return {
         'latest': {
             'confirmed': sum(map(lambda location: location.confirmed, locations)),
-            'deaths': sum(map(lambda location: location.deaths, locations)),
+            'deaths'   : sum(map(lambda location: location.deaths, locations)),
             'recovered': sum(map(lambda location: location.recovered, locations)),
         },
         'locations': [location.serialize(timelines) for location in locations],
     }
 
 
-@V2.get('/locations/{id}', response_model=models.Location)
-def get_location_by_id(request: fastapi.Request, id: int, timelines: bool = True):
+@V2.get('/locations/{id}', response_model=models.LocationResponse)
+def get_location_by_id(request: fastapi.Request, id: int, source: Sources = 'jhu', timelines: bool = True):
     """
     Getting specific location by id.
     """

app/models.py

@@ -6,43 +6,39 @@
 from pydantic import BaseModel
 from typing import Dict, List
 
-class Totals(BaseModel):
+class Latest(BaseModel):
     confirmed: int
     deaths: int
     recovered: int
 
+class LatestResponse(BaseModel):
+    latest: Latest
 
-class Latest(BaseModel):
-    latest: Totals
-
-
-class TimelineStats(BaseModel):
+class Timeline(BaseModel):
     latest: int
     timeline: Dict[str, int] = {}
 
+class Timelines(BaseModel):
+    confirmed: Timeline
+    deaths: Timeline
+    recovered: Timeline
 
-class TimelinedLocation(BaseModel):
-    confirmed: TimelineStats
-    deaths: TimelineStats
-    recovered: TimelineStats
-
-
-class Country(BaseModel):
+class Location(BaseModel):
     id: int
     country: str
     country_code: str
-    county: str = None
+    county: str = ''
     province: str = ''
     last_updated: str # TODO use datetime.datetime type.
     coordinates: Dict
-    latest: Totals
-    timelines: TimelinedLocation = {}
+    latest: Latest
+    timelines: Timelines = {}
 
 
-class Locations(BaseModel):
-    latest: Totals
-    locations: List[Country] = []
+class LocationsResponse(BaseModel):
+    latest: Latest
+    locations: List[Location] = []
 
 
-class Location(BaseModel):
-    location: Country
+class LocationResponse(BaseModel):
+    location: Location